fix: fix plugins in resolvedConfig (#2213)

* fix: fix the plugins in resovledConfig

* chore: fix tests + fix npm

* chore: minor improvement

* chore: minor improvement

* chore: remove unused import

Author: RomanHotsiy

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

@@ -534,6 +534,11 @@ exports[`resolveConfig > should resolve extends with local file config which con
   "overlay1Rules": {
     "info-contact": "off",
   },
+  "plugins": [
+    "api/plugin.js",
+    "plugin.js",
+    "api/plugin.js",
+  ],
   "preprocessors": {},
   "rules": {
     "boolean-parameter-prefixes": "error",

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

@@ -5,11 +5,21 @@ import { resolveConfig } from '../config-resolvers.js';
 import recommended from '../recommended.js';
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
+import { createRequire } from 'node:module';
 
 import type { RawUniversalConfig, RawGovernanceConfig } from '../types.js';
 import { Source } from '../../resolve.js';
 import { Config } from '../config.js';
 import { SpecVersion } from '../../oas-types.js';
+import { after } from 'node:test';
+
+vi.mock('node:module', () => ({
+  default: {
+    createRequire: () => ({
+      resolve: (path: string) => `/mock/path/${path}`,
+    }),
+  },
+}));
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -500,7 +510,9 @@ describe('resolveApis', () => {
         configPath
       ),
     });
-    const { resolvedConfig: mergedGovernancePresetResolved } = mergedGovernancePreset;
+    const {
+      resolvedConfig: { plugins, ...mergedGovernancePresetResolved },
+    } = mergedGovernancePreset;
     const rawConfig: RawUniversalConfig = {
       apis: {
         petstore: {
@@ -597,4 +609,29 @@ describe('resolveApis', () => {
     expect(plugins?.length).toEqual(2);
     expect(rules?.['operation-2xx-response']).toEqual('warn');
   });
+
+  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 { resolvedConfig } = await resolveConfig({
+      rawConfigDocument: makeDocument(
+        { plugins: ['test-plugin', 'fixtures/plugin.cjs'] },
+        configPath
+      ),
+    });
+    expect(resolvedConfig.plugins).toEqual(['test-plugin', 'fixtures/plugin.cjs']);
+  });
 });

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

@@ -43,6 +43,12 @@ const DEFAULT_PROJECT_PLUGIN_PATHS = ['@theme/plugin.js', '@theme/plugin.cjs', '
 // Cache instantiated plugins during a single execution
 const pluginsCache: Map<string, Plugin[]> = new Map();
 
+export type PluginResolveInfo = {
+  absolutePath: string;
+  rawPath: string;
+  isModule: boolean;
+};
+
 export type ConfigOptions = {
   rawConfigDocument?: Document<RawUniversalConfig>;
   configPath?: string;
@@ -80,14 +86,19 @@ export async function resolveConfig({
     externalRefResolver: externalRefResolver ?? new BaseResolver(getResolveConfig(config?.resolve)),
   });
 
+  let pluginsOrPaths: (Plugin | PluginResolveInfo)[] = [];
   let resolvedPlugins: Plugin[];
+  let rootConfigDir: string = '';
   if (isBrowser) {
     // In browser, we don't support plugins from config file yet
     resolvedPlugins = [defaultPlugin];
   } else {
-    const rootConfigDir = path.dirname(configPath ?? '');
-    const pluginsOrPaths = collectConfigPlugins(rootDocument, resolvedRefMap, rootConfigDir);
-    const plugins = await resolvePlugins(pluginsOrPaths, rootConfigDir);
+    rootConfigDir = path.dirname(configPath ?? '');
+    pluginsOrPaths = collectConfigPlugins(rootDocument, resolvedRefMap, rootConfigDir);
+    const plugins = await resolvePlugins(
+      pluginsOrPaths.map((p) => (isPluginResolveInfo(p) ? p.absolutePath : p)),
+      rootConfigDir
+    );
     resolvedPlugins = [...plugins, defaultPlugin];
   }
 
@@ -106,8 +117,21 @@ export async function resolveConfig({
     );
   }
 
+  const pluginPaths = pluginsOrPaths.length
+    ? pluginsOrPaths
+        .map((p) =>
+          isPluginResolveInfo(p) && p.isModule
+            ? p.rawPath
+            : p.absolutePath && path.relative(rootConfigDir, p.absolutePath)
+        )
+        .filter(isDefined)
+    : undefined;
+
   return {
-    resolvedConfig: bundledConfig,
+    resolvedConfig: {
+      ...bundledConfig,
+      plugins: pluginPaths,
+    },
     resolvedRefMap,
     plugins: resolvedPlugins,
   };
@@ -123,28 +147,35 @@ function getDefaultPluginPath(configDir: string): string | undefined {
   return;
 }
 
+function isPluginResolveInfo(plugin: Plugin | PluginResolveInfo): plugin is PluginResolveInfo {
+  return 'isModule' in plugin;
+}
+
 export const preResolvePluginPath = (
   plugin: string | Plugin,
   base: string,
   rootConfigDir: string
-) => {
+): Plugin | PluginResolveInfo => {
   if (!isString(plugin)) {
     return plugin;
   }
 
   const maybeAbsolutePluginPath = path.resolve(path.dirname(base), plugin);
 
   return fs.existsSync(maybeAbsolutePluginPath)
-    ? maybeAbsolutePluginPath
-    : // For plugins imported from packages specifically
-      module.createRequire(import.meta.url ?? __dirname).resolve(plugin, {
-        paths: [
-          // Plugins imported from the node_modules in the project directory
-          rootConfigDir,
-          // Plugins imported from the node_modules in the package install directory (for example, npx cache directory)
-          import.meta.url ? path.dirname(url.fileURLToPath(import.meta.url)) : __dirname,
-        ],
-      });
+    ? { absolutePath: maybeAbsolutePluginPath, rawPath: plugin, isModule: false }
+    : {
+        absolutePath: module.createRequire(import.meta.url ?? __dirname).resolve(plugin, {
+          paths: [
+            // Plugins imported from the node_modules in the project directory
+            rootConfigDir,
+            // Plugins imported from the node_modules in the package install directory (for example, npx cache directory)
+            import.meta.url ? path.dirname(url.fileURLToPath(import.meta.url)) : __dirname,
+          ],
+        }),
+        isModule: true,
+        rawPath: plugin,
+      };
 };
 
 export async function resolvePlugins(
@@ -162,11 +193,13 @@ export async function resolvePlugins(
     try {
       const absolutePluginPath = path.isAbsolute(plugin)
         ? plugin
-        : (preResolvePluginPath(
-            plugin,
-            path.join(configDir, CONFIG_FILE_NAME),
-            configDir
-          ) as string);
+        : (
+            preResolvePluginPath(
+              plugin,
+              path.join(configDir, CONFIG_FILE_NAME),
+              configDir
+            ) as PluginResolveInfo
+          ).absolutePath;
 
       if (!pluginsCache.has(absolutePluginPath)) {
         let requiredPlugin: ImportedPlugin | undefined;

packages/core/src/config/types.ts

@@ -225,6 +225,7 @@ export type RawUniversalConfig = Omit<Partial<RedoclyConfig>, 'apis' | 'plugins'
 export type ResolvedConfig = Omit<RawUniversalConfig, 'apis' | 'plugins'> &
   ResolvedGovernanceConfig & {
     apis?: Record<string, ResolvedApiConfig>;
+    plugins?: string[];
   };
 
 export type ThemeConfig = {

packages/core/src/config/visitors.ts

@@ -4,12 +4,13 @@ import { replaceRef } from '../ref-utils.js';
 import { bundleExtends } from './bundle-extends.js';
 import { preResolvePluginPath } from './config-resolvers.js';
 
+import type { PluginResolveInfo } from './config-resolvers.js';
 import type { OasRef } from '../typings/openapi.js';
 import type { Plugin } from './types.js';
 import type { ResolveResult, UserContext } from '../walk.js';
 
 export type PluginsCollectorVisitorData = {
-  plugins: (string | Plugin)[];
+  plugins: (PluginResolveInfo | Plugin)[];
   rootConfigDir: string;
 };