Skip to content

fix(linter/plugins): ensure after hooks always run#20167

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/03-09-fix_linter_plugins_ensure_after_hooks_always_run
Mar 10, 2026
Merged

fix(linter/plugins): ensure after hooks always run#20167
graphite-app[bot] merged 1 commit intomainfrom
om/03-09-fix_linter_plugins_ensure_after_hooks_always_run

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Mar 10, 2026

The createOnce API allows defining before and after hooks which run before / after each file. These can be used to track state.

It is therefore important that if the before hook is called, then the after hook is too.

It is possible for this invariant to be broken if an error is thrown during AST visitation. Because all rules run together in a single AST pass, an error in one rule can affect another. Previously in such cases, the after hook could fail to be called.

Fix this by calling after hooks in the try / catch which wraps the whole linting process.

The PR adds a comprehensive test fixture which tests behavior is correct in all circumstances, with errors being thrown at various stages, in the rule with the after hook, or in another rule.

Remove the old lint_before_hook_error and lint_after_hook_error test fixtures as the new fixture covers the same ground.

Copy link
Member Author

overlookmotel commented Mar 10, 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-bug Category - Bug labels Mar 10, 2026
@overlookmotel overlookmotel marked this pull request as ready for review March 10, 2026 01:07
@overlookmotel overlookmotel requested a review from camc314 as a code owner March 10, 2026 01:07
Copilot AI review requested due to automatic review settings March 10, 2026 01:07
@overlookmotel overlookmotel self-assigned this Mar 10, 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 fixes a bug where after hooks in createOnce rules could fail to run if an error was thrown during linting (e.g., in a later rule's before hook or during AST walk). Since after hooks are used to maintain state between files, it's critical they always run when their corresponding before hook has run. The fix extracts after-hook execution into a runAfterHooks helper that is called both at the end of normal linting and from resetStateAfterError. The helper also continues running all remaining after hooks even if one throws, capturing only the first error to re-throw.

Changes:

  • Extracted after-hook execution into runAfterHooks(shouldThrowIfError) in lint.ts, which runs all hooks and suppresses or re-throws errors based on the flag.
  • Added runAfterHooks(false) call in resetStateAfterError so that after hooks run even when an error is thrown during a before hook or AST walk.
  • Replaced the narrow lint_before_hook_error and lint_after_hook_error fixtures with a comprehensive createOnce_hook_errors fixture that covers all error scenarios across multiple files.

Reviewed changes

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

Show a summary per file
File Description
apps/oxlint/src-js/plugins/lint.ts Core fix: new runAfterHooks helper ensures after hooks always run; called from both the normal path and resetStateAfterError
apps/oxlint/test/fixtures/createOnce_hook_errors/plugin.ts New comprehensive test plugin covering throw-in-before, throw-in-after, and throw-in-visit scenarios
apps/oxlint/test/fixtures/createOnce_hook_errors/output.snap.md Expected output snapshot for the new fixture
apps/oxlint/test/fixtures/createOnce_hook_errors/.oxlintrc.json Config enabling specific rules per subdirectory for each scenario
apps/oxlint/test/fixtures/createOnce_hook_errors/options.json Single-thread option to ensure deterministic file ordering
apps/oxlint/test/fixtures/createOnce_hook_errors/files/*/ JS test files (1.js triggers error, 2.js verifies state resets properly)
apps/oxlint/test/fixtures/lint_before_hook_error/* Removed: superseded by the new comprehensive fixture
apps/oxlint/test/fixtures/lint_after_hook_error/* Removed: superseded by the new comprehensive fixture

@overlookmotel overlookmotel force-pushed the om/03-09-fix_linter_plugins_reset_visitor_compilation_state_if_error_during_compilation branch from 69d2c89 to 02cc349 Compare March 10, 2026 01:16
@overlookmotel overlookmotel force-pushed the om/03-09-fix_linter_plugins_ensure_after_hooks_always_run branch from e2b9045 to d867fd8 Compare March 10, 2026 01:16
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Mar 10, 2026
Copy link
Member Author

overlookmotel commented Mar 10, 2026

Merge activity

The `createOnce` API allows defining `before` and `after` hooks which run before / after each file. These can be used to track state.

It is therefore important that if the `before` hook is called, then the `after` hook is too.

It is possible for this invariant to be broken if an error is thrown during AST visitation. Because all rules run together in a single AST pass, an error in one rule can affect another. Previously in such cases, the `after` hook could fail to be called.

Fix this by calling `after` hooks in the `try` / `catch` which wraps the whole linting process.

The PR adds a comprehensive test fixture which tests behavior is correct in all circumstances, with errors being thrown at various stages, in the rule with the `after` hook, or in another rule.

Remove the old `lint_before_hook_error` and `lint_after_hook_error` test fixtures as the new fixture covers the same ground.
graphite-app bot pushed a commit that referenced this pull request Mar 10, 2026
In tests, run rules in a predictable order (the order they're defined in config).

This makes it possible to control in tests with multiple rules in what order they run, which makes the tests in next 2 PRs (#20166, #20167) feasible.
@graphite-app graphite-app bot force-pushed the om/03-09-fix_linter_plugins_reset_visitor_compilation_state_if_error_during_compilation branch from 02cc349 to c4812ec Compare March 10, 2026 01:47
@graphite-app graphite-app bot force-pushed the om/03-09-fix_linter_plugins_ensure_after_hooks_always_run branch from d867fd8 to 1340307 Compare March 10, 2026 01:48
Base automatically changed from om/03-09-fix_linter_plugins_reset_visitor_compilation_state_if_error_during_compilation to main March 10, 2026 01:59
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 10, 2026
@graphite-app graphite-app bot merged commit 1340307 into main Mar 10, 2026
20 checks passed
@graphite-app graphite-app bot deleted the om/03-09-fix_linter_plugins_ensure_after_hooks_always_run branch March 10, 2026 01:59
leaysgur added a commit that referenced this pull request Mar 11, 2026
# Oxlint
### 🚀 Features

- 04a5ce0 oxlint: Support `vite.config.ts` `.lint` field (#20214)
(leaysgur)
- 1735215 linter: Implement `react/no-clone-element` rule. (#20129)
(connorshea)
- 68e6f6f linter: Implement `react/no-react-children` rule. (#20104)
(connorshea)
- fe3b32e linter/plugins: Add `oxlint-plugin-eslint` package (#20009)
(overlookmotel)

### 🐛 Bug Fixes

- 05f6a09 linter/no-inline-comments: Deserialize rule options with serde
(#20207) (camc314)
- c7eb09d linter/default-case: Deserialize rule options with serde
(#20206) (camc314)
- f85e16c linter/plugins: Fix types for visitor compilation (#20203)
(overlookmotel)
- 44e24e0 linter/exhaustive-deps: Ignore type-only typeof deps (#20201)
(camc314)
- 0b04998 linter/no-fallthrough: Deserialize rule options with serde
(#20192) (camc314)
- a1031cb linter/new-cap: Deserialize rule options with serde (#20161)
(camc314)
- ad27fd6 linter: Add help messages to import plugin diagnostics
(#20158) (John Costa)
- 1340307 linter/plugins: Ensure `after` hooks always run (#20167)
(overlookmotel)
- c4812ec linter/plugins: Reset visitor compilation state if error
during compilation (#20166) (overlookmotel)
- 887eecc linter/plugins: Add license notice to `oxlint-plugin-eslint`
package (#20164) (overlookmotel)
- e1713a4 linter/plugins: Include common chunks in
`oxlint-plugin-eslint` package (#20163) (overlookmotel)
- a9acb2b linter: Check `globals` entry for `no-undef`, only check
es2026 globals for `no-extend-native` and
`no-constant-binary-expression` (#20089) (Sysix)
- 5559f0d linter/no-unused-vars: `reportUsedIgnorePattern` should not
report used rest siblings (#20108) (Don Isaac)
- de7c0e2 linter/plugins: Correct error message for `markVariableAsUsed`
(#20152) (overlookmotel)

### ⚡ Performance

- 3a86427 linter/plugins: Pre-populate cache of `EnterExit` objects at
startup (#20194) (overlookmotel)
- d243391 linter/plugins: Replace arrays with `Uint8Array`s (#20190)
(overlookmotel)
- 8742f8b linter/plugins: Pre-populate cache of `VisitProp` objects
(#20189) (overlookmotel)
- 3061acb linter/plugins: Pre-populate cache of `EnterExit` objects
(#20187) (overlookmotel)
- c73912b linter/plugins: Free visit functions earlier (#20186)
(overlookmotel)
- d9f8ff4 linter/plugins: Faster reset of visitor state (#20185)
(overlookmotel)
- 42aff15 oxlint/lsp: Avoid computing diagnostics for non invoked code
actions requests (#20080) (Sysix)

### 📚 Documentation

- a080650 linter/plugins: Fix documentation of visitor compilation
(#20202) (overlookmotel)
- 542a04a linter: Add a link to the cyclomatic complexity Wikipedia
article in `eslint/complexity` (#20174) (connorshea)
# Oxfmt
### 🚀 Features

- 95943aa oxfmt: Support `vite.config.*` `.fmt` field (#20197)
(leaysgur)
- 172fc07 oxfmt: .js/.ts config file support (#20135) (leaysgur)

### 🐛 Bug Fixes

- e483569 oxfmt: Avoid double-escaping in css-in-js (#20211) (leaysgur)

Co-authored-by: leaysgur <6259812+leaysgur@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-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants