Skip to content

Comments

perf(ast/estree): reduce overhead serializing static strings#9396

Merged
graphite-app[bot] merged 1 commit intomainfrom
02-26-perf_ast_estree_reduce_overhead_serializing_static_strings
Feb 26, 2025
Merged

perf(ast/estree): reduce overhead serializing static strings#9396
graphite-app[bot] merged 1 commit intomainfrom
02-26-perf_ast_estree_reduce_overhead_serializing_static_strings

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Feb 26, 2025

By default, strings have to be processed to ensure they contain no characters which need to be escaped in JSON, and escape those characters when they do. This is quite slow. But many strings the codegen produces are statically known not to require escaping e.g. "IdentifierReference" in {"type":"IdentifierReference",...}.

Introduce JsonSafeString type. Wrapping a string in this type asserts that the string definitely doesn't need to be escaped, and serializer can skip checks.

In codegen for ESTree impls, check if static strings need escaping, and wrap them in JsonSafeString if they don't.

Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added A-ast Area - AST A-ast-tools Area - AST tools C-performance Category - Solution not expected to change functional behavior, only performance labels Feb 26, 2025
@codspeed-hq
Copy link

codspeed-hq bot commented Feb 26, 2025

CodSpeed Performance Report

Merging #9396 will improve performances by 15.2%

Comparing 02-26-perf_ast_estree_reduce_overhead_serializing_static_strings (b0a0a82) with main (9b7017c)

Summary

⚡ 1 improvements
✅ 32 untouched benchmarks

Benchmarks breakdown

Benchmark BASE HEAD Change
estree[checker.ts] 112.6 ms 97.8 ms +15.2%

@overlookmotel overlookmotel marked this pull request as ready for review February 26, 2025 14:03
@Boshen Boshen added the 0-merge Merge with Graphite Merge Queue label Feb 26, 2025
@Boshen
Copy link
Member

Boshen commented Feb 26, 2025

Smart!

Copy link
Member

Boshen commented Feb 26, 2025

Merge activity

  • Feb 26, 9:06 AM EST: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 26, 9:06 AM EST: A user added this pull request to the Graphite merge queue.
  • Feb 26, 9:12 AM EST: A user merged this pull request with the Graphite merge queue.

By default, strings have to be processed to ensure they contain no characters which need to be escaped in JSON, and escape those characters when they do. This is quite slow. But many strings the codegen produces are statically known not to require escaping e.g. `"IdentifierReference"` in `{"type":"IdentifierReference",...}`.

Introduce `JsonSafeString` type. Wrapping a string in this type asserts that the string definitely doesn't need to be escaped, and serializer can skip checks.

In codegen for `ESTree` impls, check if static strings need escaping, and wrap them in `JsonSafeString` if they don't.
@graphite-app graphite-app bot force-pushed the 02-26-perf_ast_estree_reduce_overhead_serializing_static_strings branch from 0e7fc8d to b0a0a82 Compare February 26, 2025 14:07
@graphite-app graphite-app bot merged commit b0a0a82 into main Feb 26, 2025
25 checks passed
@graphite-app graphite-app bot deleted the 02-26-perf_ast_estree_reduce_overhead_serializing_static_strings branch February 26, 2025 14:12
graphite-app bot pushed a commit that referenced this pull request Feb 26, 2025
Similar to #9396. JS identifiers cannot contain any of the characters which require escaping in JSON (whitespace, control characters, `"`, `\`).

Mark struct fields containing a JS identifier name with `#[estree(json_safe)]` to cause codegen to wrap them in `JsonSafeString` before serializing. This removes the work of escaping identifiers during serialization.

Note: Identifiers *can* contain `\` in source text as start of an escape sequence. But such escape sequences are unescaped in parser, so the `Atom` in AST representing identifier name cannot contain `\`.
This was referenced Mar 3, 2025
Boshen added a commit that referenced this pull request Mar 4, 2025
## [0.54.0] - 2025-03-04

- 098f652 codegen: [**BREAKING**] Add `CommentAnnotation` to avoid
parsing comments again (#9506) (Boshen)

- a8d1d48 parser,codegen: [**BREAKING**] Parse and
print`#__NO_SIDE_EFFECTS__` (#9496) (Boshen)

- 355a4db napi/parser: [**BREAKING**] Remove `parse_without_return` API
(#9455) (Boshen)

- a5cde10 visit_ast: [**BREAKING**] Add `oxc_visit_ast` crate (#9428)
(Boshen)

- abb15e0 ast: [**BREAKING**] Add `pure` field to `Function`,
`CallExpression`, and `NewExpression` (#9207) (overlookmotel)

### Features

- a9f0d2b ast_tools: Generate field offset assertions for more types
(#9449) (overlookmotel)
- 64f4a82 ecmascript: Handle pure call expression in chain expressions
(#9480) (sapphi-red)
- 32139d2 ecmascript: Support `/* @__PURE__ */` in may_have_side_effects
(#9409) (sapphi-red)
- f5453f6 minifier: Flatten spread args in new expressions (#9512)
(sapphi-red)
- f8073f3 minifier: Support if with side effects in dead code
elimination (#9502) (sapphi-red)
- 10eb8f7 minifier: Use `remove_unused_expression` in
`try_fold_sequence_expression` in `remove_dead_code` (#9467)
(sapphi-red)
- 70916db minifier: Remove unused expression in for init and update
(#9466) (sapphi-red)
- 26fde56 minifier: Inline simple IIFEs in `remove_unused_expression`
(#9465) (sapphi-red)
- ec2193e minifier: Support extracting arguments in pure calls in
`remove_unused_expression` (#9463) (sapphi-red)
- 007051c minifier: Compress `a != null && a.b()` to `a?.b()` in
`remove_unused_expression` (#9459) (sapphi-red)
- 50fce20 minifier: Support binary expression in
`remove_unused_expression` (#9456) (sapphi-red)
- ed9ede3 minifier: Support conditional expression in
`remove_unused_expression` (#9432) (sapphi-red)
- 3520538 minifier: Support object expression in
`remove_unused_expression` (#9430) (sapphi-red)
- fb8a93d minifier: Improve array expression handling in
`remove_unused_expression` (#9427) (sapphi-red)
- ff477cd minifier: Support template literals in
`remove_unused_expression` (#9426) (sapphi-red)
- 0d26113 minifier: Compress `/* @__PURE__ */ a() ? b : b` to `b`
(#9410) (sapphi-red)
- 68c77c8 napi/parser: Return semantic errors (#9460) (Boshen)
- 7d7f16c parser: Apply pure to rhs of binary expression (#9492)
(Boshen)
- 2a08b14 parser: Support V8 intrinsics (#9379) (injuly)
- 9b7017c parser,codegen: Pure annotations (#9351) (Boshen)
- aa06932 transformer: Support `ModuleRunnerTransform` (#9371) (Dunqing)

### Bug Fixes

- 75f06ad codegen: Do not print comments when only `annotation_comments`
is enabled (#9518) (Dunqing)
- f5bbd5d ecmascript: Fix toString for negative numbers (#9508)
(sapphi-red)
- d2cd975 ecmascript: Fix may_have_side_effects for `${a() === b}`
(#9478) (sapphi-red)
- 584d847 ecmascript: Objects passed to template literals may have side
effects (#9425) (sapphi-red)
- b371fdc estree/ast: Camel-case `typeAnnotation` field (#9420)
(overlookmotel)
- 1fff993 minifier: Correctly remove dead code in `try` with `finally`
(#9503) (sapphi-red)
- 0b96ebe minifier: Don't inline IIFE with parameters (#9477)
(sapphi-red)
- 071c84c minifier: Skip `try_fold_stmt_in_boolean_context` on
`ExpressionStatement` (#9458) (sapphi-red)
- 306284d minifier: Call mark_current_function_as_changed in
remove_unused_expression (#9457) (sapphi-red)
- 9c6ae9f parser: `@__NO_SIDE_EFFECTS` only affects const variable decl
(#9517) (Boshen)
- b7d5513 parser: Parse `@__NO_SIDE_EFFECTS__` between `export default`
and `async function` (#9514) (Boshen)
- 01de74c parser: Correctly fail parsing when parsing `foo.bar?.`
(#9499) (camc314)
- 58defe3 parser: Mark expression as pure in chain expression (#9479)
(sapphi-red)
- 2a03689 parser: Mark expressions on the left side of logical and
conditional expressions as pure (#9414) (sapphi-red)
- 7fde233 transformer/legacy-decorator: Incorrect check for potentially
non-existent ident (#9491) (Dunqing)
- b4f050c transformer/legacy-decorator: Metadata incorrectly wrapped by
decorateParam (#9490) (Dunqing)
- 5f67fa9 transformer/optional-chaning: Keep `this` when transforming
`this.f?.()` (#9505) (camc314)

### Performance

- 10e4431 ast/estree: Skip escaping identifiers (#9398) (overlookmotel)
- b0a0a82 ast/estree: Reduce overhead serializing static strings (#9396)
(overlookmotel)
- 27a8e50 isolated_declarations: Reserve sufficient capacity in
statements `Vec` (#9394) (overlookmotel)

### Refactor

- 8916335 ast/estree: Convert enums with converters on variants (#9438)
(overlookmotel)
- dcff40c ast_tools: Generate layout assertions in multiple crates
(#9448) (overlookmotel)
- 19c4835 codegen: Simplify printing comments between arguments in
call-like expressions (#9501) (Dunqing)
- c880481 isolated_declarations: Rename var (#9390) (overlookmotel)
- 37e41f0 isolated_declarations: Use aliases `ArenaBox` / `ArenaVec`
(#9389) (overlookmotel)
- bbb450c minifier: Move `a != null && b` -> `a ?? b` compression to
`remove_unused_expression` (#9468) (sapphi-red)
- b93774c minifier: Move `try_fold_iife` to `remove_unused_expression`
(#9464) (sapphi-red)
- 96a9719 minifier: Use `may_have_side_effects` in
`remove_unused_expression` (#9413) (sapphi-red)

### Testing

- c187b11 ecmascript: Add comments and tests for cases where
`ToPropertyKey` throws an error (#9429) (sapphi-red)
- d129055 napi: Add tests for worker threads (#9408) (Boshen)
- 48d51e3 napi: Add tests for `hashbang` field (#9386) (overlookmotel)

Co-authored-by: Boshen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

0-merge Merge with Graphite Merge Queue A-ast Area - AST A-ast-tools Area - AST tools C-performance Category - Solution not expected to change functional behavior, only performance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants