Skip to content

perf(linter/plugins): inline binary search functions into call sites#20312

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

perf(linter/plugins): inline binary search functions into call sites#20312
graphite-app[bot] merged 1 commit intomainfrom
om/03-12-perf_linter_plugins_inline_binary_search_functions_into_call_sites

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Mar 13, 2026

#20310 and #20311 reduce code size and complexity by moving binary search routine which is used in all tokens and comments methods into a shared function firstTokenAtOrAfter.

However, as noted in #20310, the downside of that change is a perf hit due to the cost of function calls.

This PR fixes that regression by adding a TSDown plugin to the build which inlines the body of firstTokenAtOrAfter into all the call sites in tokens and comments methods. The net result is that the final code in bundled output is almost identical to before #20310, but the source code is much shorter and easier to understand.

This unlocks a large optimization which will follow in a future PR (see #20310 for more details).

Copy link
Member Author

overlookmotel commented Mar 13, 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-cli Area - CLI A-linter-plugins Area - Linter JS plugins C-performance Category - Solution not expected to change functional behavior, only performance labels Mar 13, 2026
@overlookmotel overlookmotel marked this pull request as ready for review March 13, 2026 00:15
@overlookmotel overlookmotel requested a review from camc314 as a code owner March 13, 2026 00:15
Copilot AI review requested due to automatic review settings March 13, 2026 00:15
@overlookmotel overlookmotel self-assigned this Mar 13, 2026
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 addresses the performance regression introduced by factoring token/comment binary search logic into a shared helper by adding a TSDown build plugin that inlines firstTokenAtOrAfter back into its call sites at bundle-time.

Changes:

  • Add a new TSDown/Rolldown transform plugin that finds firstTokenAtOrAfter(...) call sites in specific files and replaces them with the helper’s binary-search body.
  • Register the new inlining plugin in apps/oxlint/tsdown.config.ts so it runs during the build.
  • Document the inlining constraints/assumptions on firstTokenAtOrAfter in tokens_methods.ts.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
apps/oxlint/tsdown_plugins/inline_search.ts New TSDown plugin that inlines firstTokenAtOrAfter into token/comment method call sites.
apps/oxlint/tsdown.config.ts Adds the inlining plugin to the build pipeline before existing transforms.
apps/oxlint/src-js/plugins/tokens_methods.ts Adds documentation describing the build-time inlining contract for firstTokenAtOrAfter.

@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Mar 13, 2026
Copy link
Member Author

overlookmotel commented Mar 13, 2026

Merge activity

…20312)

#20310 and #20311 reduce code size and complexity by moving binary search routine which is used in all tokens and comments methods into a shared function `firstTokenAtOrAfter`.

However, as noted in #20310, the downside of that change is a perf hit due to the cost of function calls.

This PR fixes that regression by adding a TSDown plugin to the build which inlines the body of `firstTokenAtOrAfter` into all the call sites in tokens and comments methods. The net result is that the final code in bundled output is almost identical to before #20310, but the source code is much shorter and easier to understand.

This unlocks a large optimization which will follow in a future PR (see #20310 for more details).
graphite-app bot pushed a commit that referenced this pull request Mar 13, 2026
…s methods (#20310)

All tokens methods contain binary searches through `tokens` array. The code is repeated inline in every method to avoid the cost of function calls, but the downside is that it makes the code verbose and hard to understand.

Break out the binary search logic into a function which is used in every method.

This is a perf regression due to the extra cost of function calls, but that is fixed in #20312 by a TSDown plugin which inlines `firstTokenAtOrAfter` into all call sites, producing code in final build that is almost identical to before this PR.

This change makes the code shorter and easier to understand, but main motivation is to enable switching in a future PR to performing the binary searches reading directly from the buffer, without touching token objects. This means that tokens can be deserialized lazily, instead of having to deserialize the entire tokens array eagerly as we do now. This will be a large perf gain, but would be impractically complex if the convoluted buffer-search logic had to be repeated in 20+ places.
@graphite-app graphite-app bot force-pushed the om/03-12-refactor_linter_plugins_reuse_shared_binary_search_function_for_comments_methods branch from 93760a7 to 6c24a84 Compare March 13, 2026 00:26
@graphite-app graphite-app bot force-pushed the om/03-12-perf_linter_plugins_inline_binary_search_functions_into_call_sites branch from 372fbb5 to f04e850 Compare March 13, 2026 00:26
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 13, 2026
Base automatically changed from om/03-12-refactor_linter_plugins_reuse_shared_binary_search_function_for_comments_methods to main March 13, 2026 00:38
@graphite-app graphite-app bot merged commit f04e850 into main Mar 13, 2026
20 checks passed
@graphite-app graphite-app bot deleted the om/03-12-perf_linter_plugins_inline_binary_search_functions_into_call_sites branch March 13, 2026 00:39
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-cli Area - CLI A-linter Area - Linter A-linter-plugins Area - Linter JS plugins 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