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
Touches plugin loading/caching and Node module resolution (including module.registerHooks for ESM cache-busting), which can affect runtime behavior across environments. Tests cover core scenarios, but the process-wide hook and cache eviction logic could have edge-case compatibility risks.

Overview
Adds a centralized plugin cache implementation (plugins-cache.ts) and a new public clearPluginsCache API (exported from config/index.ts and core/index.ts) to force reloading plugin modules.

Updates resolvePlugins to use the new cache + loadPluginModule (mtime-based cache busting for ESM, targeted require.cache eviction for CJS) and removes the legacy __webpack_require__ path. Adds dedicated tests for cache reuse/clearing behavior and updates fixtures to cover both ESM and CJS plugin init cases.

Also introduces a temporary plugin-import-tree.ts debug logger wired into plugin loading to print plugin import graphs to stderr.

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

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

🦋 Changeset detected

Latest commit: 1155164

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	80.15% (🎯 80%)	7247 / 9041
🔵	Statements	79.49% (🎯 79%)	7536 / 9480
🔵	Functions	83.66% (🎯 83%)	1455 / 1739
🔵	Branches	71.61% (🎯 71%)	4882 / 6817

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/config/config-resolvers.ts	76.68%	61.45%	94.11%	77.5%	76, 104-107, 157, 196, 204, 263, 274, 283, 296, 306, 309-313, 318-327, 350-352, 362, 365, 368, 371, 374, 387-389, 393, 399, 402, 405-408, 411-414, 417-420, 434-436, 443, 446, 449, 452, 455, 458, 483-485, 490-496
packages/core/src/config/plugin-import-tree.ts	86.58%	71.42%	90.9%	91.54%	31, 34, 37-43, 61, 76, 89-90, 96, 115
packages/core/src/config/plugins-cache.ts	72.36%	59.37%	100%	76.92%	22, 28, 31-43, 65, 75, 99, 120, 124-128

Generated in workflow #9747 for commit 1155164 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	2.033s ± 0.029s	▓ 1.00x (Fastest)
cli-next	2.053s ± 0.053s	▓ 1.01x

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-28T18:07:01Z

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

Install with NPM:

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

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

github-actions · 2026-04-29T13:42:10Z

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

Install with NPM:

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

⚠️ 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.

cursor

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

There are 2 total unresolved issues (including 1 from previous review).

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

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

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.

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

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

cursor Bot reviewed Apr 28, 2026

View reviewed changes

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

kanoru3101 added 6 commits April 29, 2026 10:36

fix: rename plugin functions

6e58348

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

a395773

fix: revert tests

8b72a5a

fix: revert tests in right place

8a511af

fix: add logs

b933df0

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

6976c07

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

cursor Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread packages/core/src/config/config-resolvers.ts Outdated

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

fix: new version

1c61961

fix: new version

1155164

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 28, 2026

Uh oh!

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

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!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

github-actions Bot commented May 8, 2026

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