feat: add cleaning cache for plugin files by kanoru3101 · Pull Request #2732 · Redocly/redocly-cli

kanoru3101 · 2026-04-09T11:23:21Z

What/Why/How?

In VSCE, we have a problem with clean cache for plugin files. This PR adds cleaning the general cache for plugin files, cjs files, and esm files.

Moved all logic with plugin caches to separate files and covered by tests
Cleaning cache for ESM and СJS files, cover cases with nested imports.
Removed __webpack_require__

Reference

Issue Redocly/redocly-vs-code#10
VSCE Part https://github.com/Redocly/redocly/pull/22293

Testing

Tested in VSCE part

Screenshots (optional)

Check yourself

This PR follows the contributing guide
All new/updated code is covered by tests
Core code changed? - Tested with other Redocly products (internal contributions only)
New package installed? - Tested in different environments (browser/node)
Documentation update has been considered

Security

The security impact of the change has been considered
Code follows company security practices and guidelines

Note

Medium Risk
Changes plugin loading and caching behavior, including new cache eviction logic and Node loader-hook usage for ESM reloads, which could affect plugin resolution/reload semantics across Node versions.

Overview
Adds a dedicated plugin cache layer with clearPluginsCache() and getPluginCacheVersion() to support reloading plugin code within a running process.

resolvePlugins now delegates all plugin module loading/caching to plugins-cache.ts, removing the legacy __webpack_require__ path and enabling targeted CJS require.cache eviction plus ESM cache-busting via a versioned file: URL (with a Node >=22.15 loader-hook warning when unavailable).

Updates and adds tests/fixtures to validate cache stability, explicit cache clearing for both CJS/ESM, and that eviction does not remove unrelated modules.

^{Reviewed by Cursor Bugbot for commit cd8b914. Bugbot is set up for automated code reviews on this repo. Configure here.}

changeset-bot · 2026-04-09T11:23:31Z

🦋 Changeset detected

Latest commit: cd8b914

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

This PR includes changesets to release 3 packages

Name	Type
@redocly/openapi-core	Minor
@redocly/cli	Minor
@redocly/respect-core	Minor

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 · 2026-04-09T11:23:46Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1775733825 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1775733825
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1775733825
# or
npm install @redocly/respect-core@0.0.0-snapshot.1775733825

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-09T11:25:32Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	79.99% (🎯 80%)	7233 / 9042
🔵	Statements	79.29% (🎯 79%)	7518 / 9481
🔵	Functions	83.22% (🎯 83%)	1449 / 1741
🔵	Branches	71.72% (🎯 71%)	4884 / 6809

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/config/config-resolvers.ts	76.54%	61.45%	94.11%	77.35%	73, 101-104, 154, 193, 201, 257, 268, 277, 290, 300, 303-307, 312-321, 344-346, 356, 359, 362, 365, 368, 381-383, 387, 393, 396, 399-402, 405-408, 411-414, 428-430, 437, 440, 443, 446, 449, 452, 477-479, 484-490
packages/core/src/config/plugin-import-tree.ts	11.22%	4%	14.28%	10.58%	36-139, 150-151, 160-175
packages/core/src/config/plugins-cache.ts	74.6%	45%	100%	79.62%	26, 31-38, 47-51, 78, 82-86

Generated in workflow #9772 for commit cd8b914 by the Vitest Coverage Report Action

github-actions · 2026-04-09T11:25:37Z

CLI Version	Mean Time ± Std Dev (s)	Relative Performance (Lower is Faster)
cli-latest	1.939s ± 0.019s	▓ 1.00x (Fastest)
cli-next	1.975s ± 0.032s	▓ 1.02x

github-actions · 2026-04-09T13:05:04Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1775739903 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1775739903
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1775739903
# or
npm install @redocly/respect-core@0.0.0-snapshot.1775739903

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-10T09:45:16Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1775814315 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1775814315
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1775814315
# or
npm install @redocly/respect-core@0.0.0-snapshot.1775814315

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-10T11:09:32Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1775819371 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1775819371
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1775819371
# or
npm install @redocly/respect-core@0.0.0-snapshot.1775819371

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-13T12:13:11Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1776082389 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1776082389
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1776082389
# or
npm install @redocly/respect-core@0.0.0-snapshot.1776082389

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-13T13:07:37Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1776085657 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1776085657
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1776085657
# or
npm install @redocly/respect-core@0.0.0-snapshot.1776085657

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-13T13:39:35Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1776087574 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1776087574
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1776087574
# or
npm install @redocly/respect-core@0.0.0-snapshot.1776087574

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-29T14:20:34Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1777472433 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1777472433
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1777472433
# or
npm install @redocly/respect-core@0.0.0-snapshot.1777472433

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-04-29T14:57:42Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1777474661 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1777474661
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1777474661
# or
npm install @redocly/respect-core@0.0.0-snapshot.1777474661

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-08T10:55:32Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778237731 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778237731
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778237731
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778237731

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-08T14:27:04Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778250423 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778250423
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778250423
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778250423

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-08T15:24:13Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778253852 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778253852
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778253852
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778253852

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-09T11:51:19Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778327478 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778327478
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778327478
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778327478

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-09T14:04:20Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778335458 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778335458
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778335458
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778335458

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-11T12:14:59Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778501698 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778501698
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778501698
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778501698

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-05-11T13:31:54Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1778506313 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1778506313
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1778506313
# or
npm install @redocly/respect-core@0.0.0-snapshot.1778506313

⚠️ Note: This is a development build and may contain unstable features.

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit cd8b914. Configure here.}

cursor · 2026-05-11T13:53:40Z

+export async function loadPluginModule(
+  absolutePluginPath: string
+): Promise<Record<string, unknown>> {
+  ensureEsmCacheBustHook();


Misleading warning emitted on every first plugin load

Medium Severity

loadPluginModule calls ensureEsmCacheBustHook() on every first plugin load. On Node < 22.15, this emits a warning about ESM plugin reload not working — even for CLI users who never call clearPluginsCache, and for CJS-only plugin setups where cache clearing works fine without the hook. The hook is only needed after clearPluginsCache is called, since initial loads (with ?v=0) don't require version propagation to children. Moving the call exclusively to clearPluginsCache would avoid the spurious warning.

Additional Locations (1)

packages/core/src/config/plugins-cache.ts#L41-L55

^{Reviewed by Cursor Bugbot for commit cd8b914. Configure here.}

chore: test clean cache

85b3f51

kanoru3101 added the snapshot Create experimental release PR label Apr 9, 2026

chore: update

651b0b3

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 9, 2026

chore: update

8724ba2

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 10, 2026

chore: update

3bf3fb5

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 10, 2026

chore: update

548bc6b

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 13, 2026

chore: update

a7af2d7

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 13, 2026

chore: update

eef235e

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 13, 2026

fix: add more logs

1a23922

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 29, 2026

kanoru3101 and others added 2 commits April 29, 2026 17:56

fix: add more logs

e762597

Merge branch 'main' into chore/add-clean-cache

3a22259

kanoru3101 added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Apr 29, 2026

kanoru3101 added 2 commits May 8, 2026 13:54

fix: new version

b229cde

Merge remote-tracking branch 'origin/main' into chore/add-clean-cache

7e44cfe

cursor Bot reviewed May 8, 2026

View reviewed changes

Comment thread packages/core/src/config/plugins-cache.ts Outdated

fix: new version

1c61961

fix: new version

1155164

fix: new version

6494446

cursor Bot reviewed May 9, 2026

View reviewed changes

Comment thread packages/core/src/config/plugins-cache.ts Outdated

fix: add more logs

2f506c3

kanoru3101 added 2 commits May 11, 2026 15:13

fix: add getPluginCacheVersion

b7ec9ed

Merge remote-tracking branch 'origin/main' into chore/add-clean-cache

202c54e

fix: change debug tree

461ef0a

cursor Bot reviewed May 11, 2026

View reviewed changes

Comment thread packages/core/src/config/plugin-import-tree.ts Outdated

Comment thread packages/core/src/config/plugin-import-tree.ts

fix: disable logger

cd8b914

cursor Bot reviewed May 11, 2026

View reviewed changes

Conversation

kanoru3101 commented Apr 9, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

Uh oh!

changeset-bot Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Apr 9, 2026

Uh oh!

github-actions Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

github-actions Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 9, 2026

Uh oh!

github-actions Bot commented Apr 10, 2026

Uh oh!

github-actions Bot commented Apr 10, 2026

Uh oh!

github-actions Bot commented Apr 13, 2026

Uh oh!

github-actions Bot commented Apr 13, 2026

Uh oh!

github-actions Bot commented Apr 13, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

Uh oh!

github-actions Bot commented May 9, 2026

Uh oh!

github-actions Bot commented May 9, 2026

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot May 11, 2026

Choose a reason for hiding this comment

Misleading warning emitted on every first plugin load

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kanoru3101 commented Apr 9, 2026 •

edited by cursor Bot

Loading

changeset-bot Bot commented Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 9, 2026 •

edited

Loading