Skip to content

perf(linter/plugins): recycle comment objects#20362

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/03-13-perf_linter_plugins_recycle_comment_objects
Mar 14, 2026
Merged

perf(linter/plugins): recycle comment objects#20362
graphite-app[bot] merged 1 commit intomainfrom
om/03-13-perf_linter_plugins_recycle_comment_objects

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Mar 14, 2026

Apply the same optimization as #19978 to comments - hold a pool of Comment objects, and re-use those objects rather than creating new objects each time.

Same as with Tokens, loc property is a getter which calculates loc lazily, and caches it in a private property.

Copy link
Member Author

overlookmotel commented Mar 14, 2026


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 changes, fast-track this PR to the front of the merge queue

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-linter Area - Linter A-parser Area - Parser A-cli Area - CLI A-ast Area - AST A-ast-tools Area - AST tools A-linter-plugins Area - Linter JS plugins labels Mar 14, 2026
@github-actions github-actions bot added the C-performance Category - Solution not expected to change functional behavior, only performance label Mar 14, 2026
@overlookmotel overlookmotel marked this pull request as ready for review March 14, 2026 01:39
@overlookmotel overlookmotel requested a review from camc314 as a code owner March 14, 2026 01:39
Copilot AI review requested due to automatic review settings March 14, 2026 01:39
@codspeed-hq
Copy link

codspeed-hq bot commented Mar 14, 2026

Merging this PR will not alter performance

✅ 53 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing om/03-13-perf_linter_plugins_recycle_comment_objects (9a256b8) with main (6eb5b01)2

Open in CodSpeed

Footnotes

  1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. No successful run was found on om/03-13-refactor_ast_tools_remove_comments_variant_modifier_from_raw_transfer_codegen (f2c54e7) during the generation of this report, so main (6eb5b01) was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR extends the existing token object-reuse optimization to comments in the oxlint JS plugin runtime, shifting comment deserialization to a pooled Comment class with lazy loc computation and adding raw-transfer constants needed to read comments directly from the buffer.

Changes:

  • Add pooled comment deserialization (initComments/resetComments) with a Comment class that lazily computes and caches loc.
  • Update the raw-transfer generator and generated artifacts to provide comment buffer offsets/sizes/kind discriminants.
  • Move the public Comment type to plugins/comments.ts and update imports/exports accordingly.

Reviewed changes

Copilot reviewed 9 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tasks/ast_tools/src/generators/typescript.rs Adjust generated type exports/imports to reference plugins/comments.ts and use type-only exports.
tasks/ast_tools/src/generators/raw_transfer.rs Generate comment-related constants and import comments/initComments into the linter deserializer.
napi/parser/src-js/generated/constants.js Add generated constants for comment offsets/size/kind discriminant.
crates/oxc_ast/src/serialize/mod.rs Update Program’s comments getter to use pooled initComments() path.
apps/oxlint/src-js/plugins/types.ts Source plugin Comment type from plugins/comments.ts (removing inline interface).
apps/oxlint/src-js/plugins/tokens.ts Ensure comment initialization goes through initComments(); remove local comment caching.
apps/oxlint/src-js/plugins/source_code.ts Reset pooled comments between files via resetComments().
apps/oxlint/src-js/plugins/location.ts Narrow getNodeLoc to nodes only and update comments on loc-caching behavior.
apps/oxlint/src-js/plugins/comments.ts Implement pooled Comment class, comment deserialization from buffer, and reset logic.
apps/oxlint/src-js/plugins.ts Re-export Comment type from plugins/comments.ts.
apps/oxlint/src-js/generated/types.d.ts Update generated type imports/exports to reference plugins/comments.ts.
apps/oxlint/src-js/generated/deserialize.js Remove per-comment deserialization helpers; delegate to initComments().
apps/oxlint/src-js/generated/deserialize.d.ts Update GetLoc type to no longer accept Comment.
apps/oxlint/src-js/generated/constants.ts Add generated constants for comment offsets/size/kind discriminant.

@overlookmotel overlookmotel self-assigned this Mar 14, 2026
@graphite-app graphite-app bot added the 0-merge Merge with Graphite Merge Queue label Mar 14, 2026
@graphite-app
Copy link
Contributor

graphite-app bot commented Mar 14, 2026

Merge activity

@graphite-app graphite-app bot force-pushed the om/03-13-refactor_ast_tools_remove_comments_variant_modifier_from_raw_transfer_codegen branch from f2c54e7 to 4240164 Compare March 14, 2026 12:16
graphite-app bot pushed a commit that referenced this pull request Mar 14, 2026
Apply the same optimization as #19978 to comments - hold a pool of `Comment` objects, and re-use those objects rather than creating new objects each time.

Same as with `Token`s, `loc` property is a getter which calculates `loc` lazily, and caches it in a private property.
@graphite-app graphite-app bot force-pushed the om/03-13-perf_linter_plugins_recycle_comment_objects branch from 9a256b8 to 53acd73 Compare March 14, 2026 12:16
Apply the same optimization as #19978 to comments - hold a pool of `Comment` objects, and re-use those objects rather than creating new objects each time.

Same as with `Token`s, `loc` property is a getter which calculates `loc` lazily, and caches it in a private property.
@graphite-app graphite-app bot force-pushed the om/03-13-refactor_ast_tools_remove_comments_variant_modifier_from_raw_transfer_codegen branch from 4240164 to b9f09fc Compare March 14, 2026 12:19
@graphite-app graphite-app bot force-pushed the om/03-13-perf_linter_plugins_recycle_comment_objects branch from 53acd73 to 9cd612f Compare March 14, 2026 12:20
Base automatically changed from om/03-13-refactor_ast_tools_remove_comments_variant_modifier_from_raw_transfer_codegen to main March 14, 2026 12:30
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 14, 2026
@graphite-app graphite-app bot merged commit 9cd612f into main Mar 14, 2026
22 checks passed
@graphite-app graphite-app bot deleted the om/03-13-perf_linter_plugins_recycle_comment_objects branch March 14, 2026 12:31
camc314 pushed a commit that referenced this pull request Mar 16, 2026
### 🐛 Bug Fixes

- edb8677 ecmascript: Treat collection constructor with variable arg as side-effectful (#20383) (Dunqing)
- 1f65c3f transformer: Emit design:paramtypes when class has static anonymous class expression (#20382) (bab)
- fa70d5c transformer: Use implementation signature for design:paramtypes when constructor is overloaded (#20394) (bab)
- ed5a7fb parser: Report syntax error for `new super()` (#20384) (Boshen)
- e62524d minifier: Treat object spread of getters as having side effects (#20380) (Boshen)
- f8fbd6e linter/plugins: Remove `hashbang` property from AST (#20365) (overlookmotel)

### ⚡ Performance

- 30a2b0f minifier: Use atom_from_strs_array for template literal concat (#20386) (Boshen)
- 690ce17 minifier: Use Vec::with_capacity for inline template expressions (#20389) (Boshen)
- 9cd612f linter/plugins: Recycle comment objects (#20362) (overlookmotel)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
camc314 pushed a commit that referenced this pull request Mar 16, 2026
# Oxlint
### 🚀 Features

- c95951f linter/plugins: Implement `sourceCode.markVariableAsUsed` (#20357) (overlookmotel)
- 7a2a7d0 linter: Implement `n/handle-callback-err` rule (#19616) (Mikhail Baev)

### 🐛 Bug Fixes

- f8fbd6e linter/plugins: Remove `hashbang` property from AST (#20365) (overlookmotel)
- 6eb5b01 linter/prefer-await-to-then: Ignore Promise static methods (#20347) (camc314)
- a4b61f7 linter: Remove `defineConfig` check (#20308) (camc314)
- 3ad7f53 linter/explicit-module-boundary-types: False positive with satisfies expr (#20309) (camc314)
- f547401 linter/no-unused-private-class-members: Treat switch discriminants as read (#20307) (camc314)
- 1c07b3b diagnostics: Handle `WouldBlock` in stdout writes to prevent panic (#20295) (Boshen)

### ⚡ Performance

- e4f7248 linter: Remove unnecessary clone of owned String in drain loop (#20388) (Boshen)
- 4a67f1d linter: Eliminate Vec allocation in disable directive matching (#20387) (Boshen)
- 618a598 linter/plugins: Add fast path for files with no comments (#20366) (overlookmotel)
- b0125c5 linter/plugins: Deserialize comments without AST (#20364) (overlookmotel)
- 9cd612f linter/plugins: Recycle comment objects (#20362) (overlookmotel)
- bf442f8 linter/plugins: Cheaper `Token` creation (#20360) (overlookmotel)
- 5474d0a semantic: V8-style walk-up reference resolution (#20292) (Boshen)
- 7946eba linter/plugins: Avoid arguments spread and temp array when merging (#20318) (overlookmotel)
- fc7cf8a linter/plugins: Pre-define less CFG merger functions (#20317) (overlookmotel)
- 3b9eb28 linter/plugins: Streamline getting/creating visit fn mergers (#20319) (overlookmotel)
- f04e850 linter/plugins: Inline binary search functions into call sites (#20312) (overlookmotel)
- fe24afe linter/plugins: Apply replace globals TSDown plugin to JS files (#20305) (overlookmotel)
- 77cdacc linter/plugins: Use array buffer views for tokens (#20301) (overlookmotel)
- 910c941 linter/plugins: Reorder branches in `getTokenByRangeStart` (#20296) (overlookmotel)
- af7674c linter/tokens: Avoid extra token value allocation (#20013) (camc314)

### 📚 Documentation

- 24490b5 linter: Improve formatting for 80ish rules' docs. (#20411) (connorshea)
- 3383523 linter: Improve `--tsconfig` flag docs (#20342) (camc314)
# Oxfmt
### 🚀 Features

- d22c443 oxfmt: Export `OxfmtConfig` type (#20275) (leaysgur)
- a11ecff oxfmt/lsp: Respect `angular` language id as `.component.html` file (#20242) (Sysix)

### 🐛 Bug Fixes

- ce65099 formatter: Preserve parentheses around as expression before private field access (#20419) (bab)
- f908742 oxfmt: Revert #20326 partially (#20413) (leaysgur)
- 4ef93ea formatter: Honor trailing ignore comments after list separators (#19925) (Andreas Lubbe)
- 68fb0d0 oxfmt: Skip vite.config.ts which fails to import (#20326) (leaysgur)
- 88ee826 oxfmt: Handle literalline for script-in-vue (#20130) (leaysgur)
- 1c07b3b diagnostics: Handle `WouldBlock` in stdout writes to prevent panic (#20295) (Boshen)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ast Area - AST A-ast-tools Area - AST tools A-cli Area - CLI A-linter Area - Linter A-linter-plugins Area - Linter JS plugins A-parser Area - Parser 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