feat: add cleaning cache for plugin files

.changeset/funny-ghosts-heal.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": minor
+---
+
+Added support for clearing the plugins cache.

packages/core/src/config/__tests__/config-resolvers.test.ts

@@ -1,5 +1,4 @@
 import path from 'node:path';
-import { after } from 'node:test';
 import { fileURLToPath } from 'node:url';
 import util from 'node:util';
 
@@ -10,13 +9,24 @@ import { Config } from '../config.js';
 import recommended from '../recommended.js';
 import type { RawUniversalConfig, RawGovernanceConfig } from '../types.js';
 
-vi.mock('node:module', () => ({
-  default: {
-    createRequire: () => ({
-      resolve: (path: string) => `/mock/path/${path}`,
-    }),
-  },
-}));
+const resolveOverrides = new Map<string, string>();
+
+vi.mock('node:module', async (importOriginal) => {
+  const nodeModule = (await importOriginal<Record<string, any>>()).default;
+  return {
+    default: {
+      ...nodeModule,
+      createRequire(baseUrl: string) {
+        const req = nodeModule.createRequire(baseUrl);
+        return Object.assign((id: string) => req(id), req, {
+          resolve: (id: string, opts?: any) => {
+            return resolveOverrides.get(id) ?? req.resolve(id, opts);
+          },
+        }) as typeof req;
+      },
+    },
+  };
+});
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -42,6 +52,10 @@ function makeDocument(rawConfig: RawUniversalConfig, configPath: string = '') {
   };
 }
 
+afterEach(() => {
+  resolveOverrides.clear();
+});
+
 describe('resolveConfig', () => {
   it('should return the config with no recommended', async () => {
     const { resolvedConfig, plugins } = await resolveConfig({
@@ -638,20 +652,10 @@ describe('resolveApis', () => {
   });
 
   it('should work with npm dependencies', async () => {
-    after(() => {
-      (globalThis as any).__webpack_require__ = undefined;
-      (globalThis as any).__non_webpack_require__ = undefined;
-    });
-
-    (globalThis as any).__webpack_require__ = () => {};
-    (globalThis as any).__non_webpack_require__ = (p: string) =>
-      p === '/mock/path/test-plugin'
-        ? {
-            id: 'npm-test-plugin',
-          }
-        : {
-            id: 'local-test-plugin',
-          };
+    const fixturesDir = path.join(__dirname, 'fixtures/resolve-config');
+    const pluginPath = path.join(fixturesDir, 'plugin.js');
+    resolveOverrides.set('test-plugin', pluginPath);
+    resolveOverrides.set('fixtures/plugin.cjs', pluginPath);
 
     const { resolvedConfig } = await resolveConfig({
       rawConfigDocument: makeDocument(

packages/core/src/config/__tests__/fixtures/resolve-config/local-config-with-plugin-init.yaml

@@ -1,2 +1,2 @@
 plugins:
-  - plugin-with-init-logic.js
+  - plugin-with-init-logic.cjs

packages/core/src/config/__tests__/fixtures/resolve-config/local-config-with-realm-plugin.yaml

@@ -1,2 +1,2 @@
 plugins:
-  - realm-plugin.js
+  - realm-plugin.cjs

packages/core/src/config/config-resolvers.ts

@@ -40,6 +40,12 @@ import {
 
 // Cache instantiated plugins during a single execution
 const pluginsCache: Map<string, Plugin[]> = new Map();
+let pluginsCacheVersion = 0;
+
+export const clearPluginsCache = (): void => {
+  pluginsCache.clear();
+  pluginsCacheVersion++;
+};
 
 export type PluginResolveInfo = {
   absolutePath: string;
@@ -191,6 +197,32 @@ export const preResolvePluginPath = (
   }
 };
 
+async function loadPluginModule(
+  absolutePluginPath: string,
+  pluginsCacheVersion: number
+): Promise<Record<string, unknown>> {
+  // CJS: drop this plugin's subtree from `require.cache` so `require()` does not reuse a stale graph.
+  if (absolutePluginPath.endsWith('.cjs')) {
+    const nodeRequire = module.createRequire(absolutePluginPath);
+    if (pluginsCacheVersion) {
+      const pluginDir = path.dirname(absolutePluginPath) + path.sep;
+      for (const cachedPath of Object.keys(nodeRequire.cache)) {
+        if (cachedPath.startsWith(pluginDir)) {
+          delete nodeRequire.cache[cachedPath];
+        }
+      }
+    }
+    return nodeRequire(absolutePluginPath);
+  }
+
+  // ESM: the loader keys modules by URL; a distinct `?v=` makes dynamic `import()` bypass the prior cache entry.
+  const pluginUrl = url.pathToFileURL(absolutePluginPath);
+  if (pluginsCacheVersion) {
+    pluginUrl.searchParams.set('v', String(pluginsCacheVersion));
+  }
+  return import(pluginUrl.href);
+}
+
 export async function resolvePlugins(
   plugins: (string | Plugin)[],
   configDir: string
@@ -215,18 +247,8 @@ export async function resolvePlugins(
           ).absolutePath;
 
       if (!pluginsCache.has(absolutePluginPath)) {
-        let requiredPlugin: ImportedPlugin | undefined;
-
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore FIXME: investigate if we still need this (2.0)
-        if (typeof __webpack_require__ === 'function') {
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-ignore FIXME: investigate if we still need this (2.0)
-          requiredPlugin = __non_webpack_require__(absolutePluginPath);
-        } else {
-          const mod = await import(url.pathToFileURL(absolutePluginPath).pathname);
-          requiredPlugin = mod.default || mod;
-        }
+        const mod = await loadPluginModule(absolutePluginPath, pluginsCacheVersion);
+        const requiredPlugin: ImportedPlugin | undefined = mod.default || mod;
 
         const pluginCreatorOptions = { contentDir: configDir };
 

packages/core/src/index.ts

@@ -31,6 +31,7 @@ export {
   createConfig,
   findConfig,
   resolvePlugins,
+  clearPluginsCache,
   ConfigValidationError,
   Config, // FIXME: export it as a type
   type RawUniversalConfig,