Skip to content

fix(openapi): preserve JSON.rawJSON in cached specs - #7250

Open
xianjianlf2 wants to merge 2 commits into
Effect-TS:mainfrom
xianjianlf2:fix/openapi-raw-json-cache
Open

fix(openapi): preserve JSON.rawJSON in cached specs#7250
xianjianlf2 wants to merge 2 commits into
Effect-TS:mainfrom
xianjianlf2:fix/openapi-raw-json-cache

Conversation

@xianjianlf2

Copy link
Copy Markdown
Contributor

Summary

  • preserve JSON.rawJSON values when cloning cached OpenAPI specs
  • add a regression test covering repeated OpenApi.fromApi calls with a raw JSON extension value
  • add a patch changeset for effect

Details

JSON.rawJSON objects carry internal JSON serialization behavior. The cached spec clone added in #6550 recursively copied enumerable object keys, which turned a raw JSON object into a plain { rawJSON: ... } object on cache hits. The clone now detects raw JSON values with JSON.isRawJSON and keeps them intact.

Tests

  • pnpm test packages/effect/test/unstable/httpapi/OpenApi.test.ts
  • pnpm --dir packages/effect check
  • pnpm exec oxlint packages/effect/src/unstable/httpapi/OpenApi.ts packages/effect/test/unstable/httpapi/OpenApi.test.ts
  • pnpm exec dprint check .changeset/preserve-openapi-raw-json.md packages/effect/src/unstable/httpapi/OpenApi.ts packages/effect/test/unstable/httpapi/OpenApi.test.ts
  • git diff --check

Fixes #7239

@changeset-bot

changeset-bot Bot commented Aug 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: c4045ce

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 30 packages
Name Type
effect Patch
@effect/ai-anthropic Patch
@effect/ai-openai Patch
@effect/ai-openai-compat Patch
@effect/ai-openrouter Patch
@effect/atom-react Patch
@effect/atom-solid Patch
@effect/atom-vue Patch
@effect/docgen Patch
@effect/doctest Patch
@effect/openapi-generator Patch
@effect/opentelemetry Patch
@effect/platform-browser Patch
@effect/platform-bun Patch
@effect/platform-deno Patch
@effect/platform-node Patch
@effect/platform-node-shared Patch
@effect/sql-clickhouse Patch
@effect/sql-d1 Patch
@effect/sql-libsql Patch
@effect/sql-mssql Patch
@effect/sql-mysql2 Patch
@effect/sql-pg Patch
@effect/sql-pglite Patch
@effect/sql-sqlite-bun Patch
@effect/sql-sqlite-do Patch
@effect/sql-sqlite-node Patch
@effect/sql-sqlite-react-native Patch
@effect/sql-sqlite-wasm Patch
@effect/vitest Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Bundle Size Analysis

Generated from PR build output; treat the content below as untrusted.

File Name Current Size Previous Size Difference
basic.ts 6.98 KB 6.98 KB 0.00 KB (0.00%)
batching.ts 9.78 KB 9.78 KB 0.00 KB (0.00%)
brand.ts 6.57 KB 6.57 KB 0.00 KB (0.00%)
cache.ts 10.69 KB 10.69 KB 0.00 KB (0.00%)
config.ts 21.11 KB 21.11 KB 0.00 KB (0.00%)
differ.ts 20.05 KB 20.05 KB 0.00 KB (0.00%)
http-client.ts 21.68 KB 21.68 KB 0.00 KB (0.00%)
logger.ts 10.93 KB 10.93 KB 0.00 KB (0.00%)
metric.ts 8.90 KB 8.90 KB 0.00 KB (0.00%)
optic.ts 6.73 KB 6.73 KB 0.00 KB (0.00%)
pubsub.ts 14.96 KB 14.96 KB 0.00 KB (0.00%)
queue.ts 11.63 KB 11.63 KB 0.00 KB (0.00%)
schedule.ts 10.79 KB 10.79 KB 0.00 KB (0.00%)
schema-class.ts 19.68 KB 19.68 KB 0.00 KB (0.00%)
schema-fromJsonSchemaDocument.ts 29.63 KB 29.63 KB 0.00 KB (0.00%)
schema-representation-roundtrip.ts 25.86 KB 25.86 KB 0.00 KB (0.00%)
schema-string-transformation.ts 13.55 KB 13.55 KB 0.00 KB (0.00%)
schema-string.ts 11.04 KB 11.04 KB 0.00 KB (0.00%)
schema-template-literal.ts 15.36 KB 15.36 KB 0.00 KB (0.00%)
schema-toArbitrary.ts 21.80 KB 21.80 KB 0.00 KB (0.00%)
schema-toCodeDocument.ts 24.23 KB 24.23 KB 0.00 KB (0.00%)
schema-toCodecJson.ts 19.02 KB 19.02 KB 0.00 KB (0.00%)
schema-toEquivalence.ts 18.84 KB 18.84 KB 0.00 KB (0.00%)
schema-toFormatter.ts 18.71 KB 18.71 KB 0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts 22.87 KB 22.87 KB 0.00 KB (0.00%)
schema-toRepresentation.ts 19.35 KB 19.35 KB 0.00 KB (0.00%)
schema.ts 18.93 KB 18.93 KB 0.00 KB (0.00%)
stm.ts 12.71 KB 12.71 KB 0.00 KB (0.00%)
stream.ts 9.72 KB 9.72 KB 0.00 KB (0.00%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.0 bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenApi.fromApi corrupts JSON.rawJSON on cache hits

1 participant