Merge branch 'main' into fix-slow-test

Author: RomanHotsiy

.changeset/eight-onions-visit.md

@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": patch
+"@redocly/cli": patch
+---
+
+Fixed plugins validation in config files referenced in the `extends` section.

.changeset/modern-fishes-float.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": patch
+---
+
+Fixed an issue where the config resolver grouped assertions instead of returning unchanged rules.

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

@@ -536,38 +536,34 @@ exports[`resolveConfig > should resolve extends with local file config which con
   },
   "preprocessors": {},
   "rules": {
-    "assertions": [
-      {
-        "assertionId": "rule/path-item-get-defined",
-        "assertions": {
-          "defined": true,
-        },
-        "message": "Every path item must have a GET operation.",
-        "subject": {
-          "property": "get",
-          "type": "PathItem",
-        },
-      },
-      {
-        "assertionId": "rule/tag-description",
-        "assertions": {
-          "minLength": 13,
-          "pattern": "/\\.$/",
-        },
-        "message": "Tag description must be at least 13 characters and end with a full stop.",
-        "severity": "error",
-        "subject": {
-          "property": "description",
-          "type": "Tag",
-        },
-      },
-    ],
     "boolean-parameter-prefixes": "error",
     "local/operation-id-not-test": "error",
     "no-invalid-media-type-examples": "warn",
     "no-unresolved-refs": "error",
     "operation-2xx-response": "error",
     "operation-4xx-response": "off",
+    "rule/path-item-get-defined": {
+      "assertions": {
+        "defined": true,
+      },
+      "message": "Every path item must have a GET operation.",
+      "subject": {
+        "property": "get",
+        "type": "PathItem",
+      },
+    },
+    "rule/tag-description": {
+      "assertions": {
+        "minLength": 13,
+        "pattern": "/\\.$/",
+      },
+      "message": "Tag description must be at least 13 characters and end with a full stop.",
+      "severity": "error",
+      "subject": {
+        "property": "description",
+        "type": "Tag",
+      },
+    },
     "struct": "error",
   },
 }

packages/core/src/config/__tests__/__snapshots__/load.test.ts.snap

@@ -62,21 +62,18 @@ Config {
         "preprocessors": {},
         "root": "resources/pets.yaml",
         "rules": {
-          "assertions": [
-            {
-              "assertionId": "rule/test",
-              "assertions": {
-                "defined": true,
-              },
-              "severity": "warn",
-              "subject": {
-                "property": "x-test",
-                "type": "Operation",
-              },
-            },
-          ],
           "no-empty-servers": "error",
           "operation-summary": "warn",
+          "rule/test": {
+            "assertions": {
+              "defined": true,
+            },
+            "severity": "warn",
+            "subject": {
+              "property": "x-test",
+              "type": "Operation",
+            },
+          },
         },
       },
     },
@@ -87,20 +84,17 @@ Config {
       },
     },
     "rules": {
-      "assertions": [
-        {
-          "assertionId": "rule/test",
-          "assertions": {
-            "defined": true,
-          },
-          "subject": {
-            "property": "x-test",
-            "type": "Operation",
-          },
-        },
-      ],
       "no-empty-servers": "error",
       "operation-summary": "error",
+      "rule/test": {
+        "assertions": {
+          "defined": true,
+        },
+        "subject": {
+          "property": "x-test",
+          "type": "Operation",
+        },
+      },
     },
     "telemetry": "on",
   },

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

@@ -8,6 +8,8 @@ import path from 'node:path';
 
 import type { RawUniversalConfig, RawGovernanceConfig } from '../types.js';
 import { Source } from '../../resolve.js';
+import { Config } from '../config.js';
+import { SpecVersion } from '../../oas-types.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -259,11 +261,14 @@ describe('resolveConfig', () => {
     const rootOrApiRawConfig = {
       extends: ['local-config-with-custom-function.yaml'],
     };
-    const { plugins } = await resolveConfig({
+    const { plugins, resolvedConfig } = await resolveConfig({
       rawConfigDocument: makeDocument(rootOrApiRawConfig, configPath),
       configPath,
     });
 
+    // instantiate the config to register custom assertions
+    new Config(resolvedConfig, { plugins });
+
     expect(plugins).toBeDefined();
     expect(plugins?.length).toBe(2);
     expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
@@ -274,33 +279,34 @@ describe('resolveConfig', () => {
       extends: ['local-config-with-wrong-custom-function.yaml'],
     };
     try {
-      await resolveConfig({
+      const config = await resolveConfig({
         rawConfigDocument: makeDocument(rootOrApiRawConfig, configPath),
         configPath,
       });
+      new Config(config.resolvedConfig, { plugins: config.plugins });
     } catch (e) {
       expect(e.message.toString()).toContain(
         `Plugin ${colorize.red(
           'test-plugin'
         )} doesn't export assertions function with name ${colorize.red('checkWordsCount2')}.`
       );
     }
-
-    expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
   });
 
   it('should correctly merge assertions from nested config', async () => {
     const rootOrApiRawConfig = {
       extends: ['local-config-with-file.yaml'],
     };
 
-    const { resolvedConfig, plugins } = await resolveConfig({
+    const { resolvedConfig } = await resolveConfig({
       rawConfigDocument: makeDocument(rootOrApiRawConfig, configPath),
       configPath,
     });
 
-    expect(Array.isArray(resolvedConfig.rules?.assertions)).toEqual(true);
-    expect(resolvedConfig.rules?.assertions).toMatchObject([
+    const config = new Config(resolvedConfig, { plugins: [] });
+
+    expect(Array.isArray(config.rules[SpecVersion.OAS3_1].assertions)).toEqual(true);
+    expect(config.rules[SpecVersion.OAS3_1].assertions).toMatchObject([
       {
         subject: { type: 'PathItem', property: 'get' },
         message: 'Every path item must have a GET operation.',
@@ -342,7 +348,7 @@ describe('resolveConfig', () => {
   it('should resolve `recommended-strict` ruleset correctly', async () => {
     const expectedStrict = JSON.parse(JSON.stringify(recommended)) as Omit<
       RawGovernanceConfig,
-      'extends'
+      'extends' | 'plugins'
     >;
     for (const section of Object.values(expectedStrict)) {
       for (let ruleName in section) {

packages/core/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml

@@ -2,12 +2,14 @@ rules:
   no-invalid-media-type-examples: warn
   operation-4xx-response: off
   rule/tag-description:
-    subject: Tag
-    property: description
+    subject:
+      type: Tag
+      property: description
     message: Tag description must have at least 3 words.
     severity: error
-    test-plugin/checkWordsCount2:
-      min: 3
+    assertions:
+      test-plugin/checkWordsCount2:
+        min: 3
 plugins:
   - plugin.js
 extends:

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

@@ -101,23 +101,13 @@ export async function resolveConfig({
     bundledConfig.apis = Object.fromEntries(
       Object.entries(bundledConfig.apis).map(([key, apiConfig]) => {
         const mergedConfig = mergeExtends([bundledConfig, apiConfig]);
-        return [
-          key,
-          {
-            ...apiConfig,
-            ...mergedConfig,
-            rules: groupAssertionRules(mergedConfig, resolvedPlugins),
-          },
-        ];
+        return [key, { ...apiConfig, ...mergedConfig }];
       })
     );
   }
 
   return {
-    resolvedConfig: {
-      ...bundledConfig,
-      rules: groupAssertionRules(bundledConfig, resolvedPlugins),
-    },
+    resolvedConfig: bundledConfig,
     resolvedRefMap,
     plugins: resolvedPlugins,
   };
@@ -448,7 +438,7 @@ export function resolvePreset(presetName: string, plugins: Plugin[]): RawGoverna
   return preset;
 }
 
-function groupAssertionRules(
+export function groupAssertionRules(
   config: RawGovernanceConfig,
   plugins: Plugin[]
 ): Record<string, RuleConfig> {

packages/core/src/config/config.ts

@@ -7,6 +7,7 @@ import { isBrowser } from '../env.js';
 import { getResolveConfig } from './utils.js';
 import { isAbsoluteUrl } from '../ref-utils.js';
 import { type Document, type ResolvedRefMap } from '../resolve.js';
+import { groupAssertionRules } from './config-resolvers.js';
 
 import type { NormalizedProblem } from '../walk.js';
 import type {
@@ -81,14 +82,18 @@ export class Config {
     this.plugins = opts.plugins || [];
     this.doNotResolveExamples = !!resolvedConfig.resolve?.doNotResolveExamples;
 
+    const group = (rules: Record<string, RuleConfig>) => {
+      return groupAssertionRules({ rules }, this.plugins);
+    };
+
     this.rules = {
-      [SpecVersion.OAS2]: { ...resolvedConfig.rules, ...resolvedConfig.oas2Rules },
-      [SpecVersion.OAS3_0]: { ...resolvedConfig.rules, ...resolvedConfig.oas3_0Rules },
-      [SpecVersion.OAS3_1]: { ...resolvedConfig.rules, ...resolvedConfig.oas3_1Rules },
-      [SpecVersion.Async2]: { ...resolvedConfig.rules, ...resolvedConfig.async2Rules },
-      [SpecVersion.Async3]: { ...resolvedConfig.rules, ...resolvedConfig.async3Rules },
-      [SpecVersion.Arazzo1]: { ...resolvedConfig.rules, ...resolvedConfig.arazzo1Rules },
-      [SpecVersion.Overlay1]: { ...resolvedConfig.rules, ...resolvedConfig.overlay1Rules },
+      [SpecVersion.OAS2]: group({ ...resolvedConfig.rules, ...resolvedConfig.oas2Rules }),
+      [SpecVersion.OAS3_0]: group({ ...resolvedConfig.rules, ...resolvedConfig.oas3_0Rules }),
+      [SpecVersion.OAS3_1]: group({ ...resolvedConfig.rules, ...resolvedConfig.oas3_1Rules }),
+      [SpecVersion.Async2]: group({ ...resolvedConfig.rules, ...resolvedConfig.async2Rules }),
+      [SpecVersion.Async3]: group({ ...resolvedConfig.rules, ...resolvedConfig.async3Rules }),
+      [SpecVersion.Arazzo1]: group({ ...resolvedConfig.rules, ...resolvedConfig.arazzo1Rules }),
+      [SpecVersion.Overlay1]: group({ ...resolvedConfig.rules, ...resolvedConfig.overlay1Rules }),
     };
 
     this.preprocessors = {

packages/core/src/config/types.ts

@@ -55,6 +55,7 @@ export type DecoratorConfig = PreprocessorConfig;
 
 export type RawGovernanceConfig<T extends 'built-in' | undefined = undefined> = {
   extends?: string[];
+  plugins?: (string | Plugin)[];
 
   rules?: RuleMap<BuiltInCommonRuleId, RuleConfig, T>;
   oas2Rules?: RuleMap<BuiltInOAS2RuleId, RuleConfig, T>;
@@ -84,7 +85,7 @@ export type RawGovernanceConfig<T extends 'built-in' | undefined = undefined> =
   overlay1Decorators?: Record<string, DecoratorConfig>;
 };
 
-export type ResolvedGovernanceConfig = Omit<RawGovernanceConfig, 'extends'>;
+export type ResolvedGovernanceConfig = Omit<RawGovernanceConfig, 'extends' | 'plugins'>;
 
 export type PreprocessorsConfig = {
   oas3?: Oas3PreprocessorsSet;

packages/core/src/types/redocly-yaml.ts

@@ -2,7 +2,7 @@ import path from 'node:path';
 import { rootRedoclyConfigSchema } from '@redocly/config';
 import { listOf } from './index.js';
 import { SpecVersion, getTypes } from '../oas-types.js';
-import { isCustomRuleId } from '../utils.js';
+import { isCustomRuleId, omit } from '../utils.js';
 import { getNodeTypesFromJSONSchema } from './json-schema-adapter.js';
 import { normalizeTypes } from '../types/index.js';
 import { isAbsoluteUrl } from '../ref-utils.js';
@@ -212,6 +212,7 @@ const configGovernanceProperties: Record<
       } as PropType;
     },
   } as PropType,
+  plugins: { type: 'array', items: { type: 'string' } },
 
   rules: 'Rules',
   oas2Rules: 'Rules',
@@ -268,7 +269,7 @@ const createConfigApisProperties = (nodeTypes: Record<string, NodeType>): NodeTy
   ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties'],
   properties: {
     ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']?.properties,
-    ...ConfigGovernance.properties,
+    ...omit(ConfigGovernance.properties, ['plugins']), // plugins are not allowed in apis
   },
 });