@redocly/openapi-core 1.19.0 → 1.20.0

package/src/__tests__/walk.test.ts

@@ -53,7 +53,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(testRuleSet.test).toBeCalledTimes(1);
@@ -100,12 +100,12 @@ describe('walk order', () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
-        servers: 
+        servers:
         - url: http://{test}.url
           variables:
             test: test
-        paths: 
-          /test-path: 
+        paths:
+          /test-path:
             get:
               responses:
                 200:
@@ -121,7 +121,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(testRuleSet.test).toBeCalledTimes(1);
@@ -184,7 +184,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -264,7 +264,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet, undefined, 'oas2'),
+      config: await makeConfigForRuleset(testRuleSet, undefined, 'oas2'),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -345,7 +345,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -417,7 +417,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -489,7 +489,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -556,7 +556,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -610,7 +610,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -666,7 +666,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -708,7 +708,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -763,7 +763,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -849,7 +849,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -928,7 +928,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -1000,7 +1000,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -1044,7 +1044,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -1109,7 +1109,7 @@ describe('walk order', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`
@@ -1197,7 +1197,7 @@ describe('context.report', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(results).toHaveLength(3);
@@ -1277,7 +1277,7 @@ describe('context.report', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(results).toHaveLength(4);
@@ -1385,7 +1385,7 @@ describe('context.resolve', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
   });
 });
@@ -1434,7 +1434,7 @@ describe('type extensions', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet, {
+      config: await makeConfigForRuleset(testRuleSet, {
         typeExtension: {
           oas3(types, version) {
             expect(version).toEqual(oas);
@@ -1528,7 +1528,7 @@ describe('ignoreNextRules', () => {
     await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfigForRuleset(testRuleSet),
+      config: await makeConfigForRuleset(testRuleSet),
     });
 
     expect(calls).toMatchInlineSnapshot(`

package/src/benchmark/benches/lint-with-many-rules.bench.ts

@@ -4,6 +4,8 @@ import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
 
+import type { StyleguideConfig } from '../../config';
+
 export const name = 'Validate with 50 top-level rules';
 export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
@@ -25,7 +27,11 @@ for (let i = 0; i < 50; i++) {
   };
 }
 
-const config = makeConfigForRuleset(ruleset);
+let config: StyleguideConfig;
+export async function setupAsync() {
+  config = await makeConfigForRuleset(ruleset);
+}
+
 export function measureAsync() {
   return lintDocument({
     externalRefResolver: new BaseResolver(),

package/src/benchmark/benches/lint-with-nested-rule.bench.ts

@@ -4,6 +4,8 @@ import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
 
+import type { StyleguideConfig } from '../../config';
+
 export const name = 'Validate with single nested rule';
 export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
@@ -29,7 +31,11 @@ const visitor = {
     };
   },
 };
-const config = makeConfigForRuleset(visitor);
+let config: StyleguideConfig;
+export async function setupAsync() {
+  config = await makeConfigForRuleset(visitor);
+}
+
 export function measureAsync() {
   return lintDocument({
     externalRefResolver: new BaseResolver(),

package/src/benchmark/benches/lint-with-no-rules.bench.ts

@@ -3,6 +3,9 @@ import { join as pathJoin, resolve as pathResolve } from 'path';
 import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
+
+import type { StyleguideConfig } from '../../config';
+
 export const name = 'Validate with no rules';
 export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
@@ -10,7 +13,11 @@ const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
   rebillyDefinitionRef
 );
-const config = makeConfigForRuleset({});
+
+let config: StyleguideConfig;
+export async function setupAsync() {
+  config = await makeConfigForRuleset({});
+}
 export function measureAsync() {
   return lintDocument({
     externalRefResolver: new BaseResolver(),

package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts

@@ -4,6 +4,8 @@ import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
 
+import type { StyleguideConfig } from '../../config';
+
 export const name = 'Validate with single top-level rule and report';
 export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
@@ -12,19 +14,22 @@ const rebillyDocument = parseYamlToDocument(
   rebillyDefinitionRef
 );
 
-const config = makeConfigForRuleset({
-  test: () => {
-    return {
-      Schema(schema, ctx) {
-        if (schema.type === 'number') {
-          ctx.report({
-            message: 'type number is not allowed',
-          });
-        }
-      },
-    };
-  },
-});
+let config: StyleguideConfig;
+export async function setupAsync() {
+  config = await makeConfigForRuleset({
+    test: () => {
+      return {
+        Schema(schema, ctx) {
+          if (schema.type === 'number') {
+            ctx.report({
+              message: 'type number is not allowed',
+            });
+          }
+        },
+      };
+    },
+  });
+}
 
 export function measureAsync() {
   return lintDocument({

package/src/benchmark/benches/lint-with-top-level-rule.bench.ts

@@ -3,6 +3,9 @@ import { join as pathJoin, resolve as pathResolve } from 'path';
 import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
+
+import type { StyleguideConfig } from '../../config';
+
 export const name = 'Validate with single top-level rule';
 export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
@@ -11,17 +14,20 @@ const rebillyDocument = parseYamlToDocument(
   rebillyDefinitionRef
 );
 
-const config = makeConfigForRuleset({
-  test: () => {
-    let count = 0;
-    return {
-      Schema() {
-        count++;
-        if (count === -1) throw new Error('Disable optimization');
-      },
-    };
-  },
-});
+let config: StyleguideConfig;
+export async function setupAsync() {
+  config = await makeConfigForRuleset({
+    test: () => {
+      let count = 0;
+      return {
+        Schema() {
+          count++;
+          if (count === -1) throw new Error('Disable optimization');
+        },
+      };
+    },
+  });
+}
 
 export function measureAsync() {
   return lintDocument({

package/src/benchmark/fork.js

@@ -26,6 +26,10 @@ if (require.main === module) {
   assert(process.send);
   const module = require(modulePath);
 
+  if (module.setupAsync) {
+    await module.setupAsync();
+  }
+
   if (module.measureAsync) {
     async function run() {
       await clockAsync(7, module.measureAsync); // warm up

package/src/benchmark/utils.ts

@@ -1,8 +1,9 @@
 import { parseYaml } from '../js-yaml';
-import { Document, Source } from '../resolve';
-import { Oas3RuleSet } from '../oas-types';
+import { Source } from '../resolve';
 import { StyleguideConfig, mergeExtends, resolvePlugins } from '../config';
 
+import type { Document } from '../resolve';
+import type { Oas3RuleSet } from '../oas-types';
 import type { RuleConfig, Plugin, ResolvedStyleguideConfig } from '../config/types';
 
 export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
@@ -12,20 +13,20 @@ export function parseYamlToDocument(body: string, absoluteRef: string = ''): Doc
   };
 }
 
-export function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>) {
+export async function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>) {
   const rulesConf: Record<string, RuleConfig> = {};
   const ruleId = 'test';
   Object.keys(rules).forEach((name) => {
     rulesConf[`${ruleId}/${name}`] = 'error';
   });
   const extendConfigs = [
-    resolvePlugins([
+    (await resolvePlugins([
       {
         ...plugin,
         id: ruleId,
         rules: { oas3: rules },
       },
-    ]) as ResolvedStyleguideConfig,
+    ])) as ResolvedStyleguideConfig,
   ];
   if (rules) {
     extendConfigs.push({ rules });

package/src/bundle.ts

@@ -9,7 +9,7 @@ import {
   SpecMajorVersion,
   SpecVersion,
 } from './oas-types';
-import { isAbsoluteUrl, isRef, Location, refBaseName } from './ref-utils';
+import { isAbsoluteUrl, isRef, refBaseName } from './ref-utils';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { dequal, isPlainObject, isTruthy } from './utils';
@@ -18,6 +18,7 @@ import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './decorato
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './decorators/oas3/remove-unused-components';
 import { ConfigTypes } from './types/redocly-yaml';
 
+import type { Location } from './ref-utils';
 import type { Oas3Visitor, Oas2Visitor } from './visitors';
 import type { NormalizedNodeType, NodeType } from './types';
 import type { WalkContext, UserContext, ResolveResult, NormalizedProblem } from './walk';

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -5,6 +5,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "parameters-no-body-inside-in": "off",
     "spec": "error",
   },
   "async2Decorators": {},
@@ -12,6 +13,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "async2Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -23,6 +25,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "async3Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -85,7 +88,8 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
-    "info-license-url": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
     "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
     "no-enum-type-mismatch": "error",
@@ -133,6 +137,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "parameters-no-body-inside-in": "off",
     "spec": "error",
   },
   "async2Decorators": {},
@@ -140,6 +145,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "async2Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -151,6 +157,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "async3Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -231,7 +238,8 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
-    "info-license-url": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
     "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
     "no-enum-type-mismatch": "error",

package/src/config/__tests__/config-resolvers.test.ts

@@ -91,6 +91,88 @@ describe('resolveStyleguideConfig', () => {
     });
   });
 
+  it('should resolve local file config with esm plugin', async () => {
+    const config = {
+      ...baseStyleguideConfig,
+      extends: ['local-config-with-esm.yaml'],
+    };
+
+    const { plugins, ...styleguide } = await resolveStyleguideConfig({
+      styleguideConfig: config,
+      configPath,
+    });
+
+    expect(styleguide?.rules?.['operation-2xx-response']).toEqual('warn');
+    expect(plugins).toBeDefined();
+    expect(plugins?.length).toBe(2);
+
+    const localPlugin = plugins?.find((p) => p.id === 'test-plugin');
+    expect(localPlugin).toBeDefined();
+
+    expect(localPlugin).toMatchObject({
+      id: 'test-plugin',
+      rules: {
+        oas3: {
+          'test-plugin/oas3-rule-name': 'oas3-rule-stub',
+        },
+      },
+    });
+
+    expect(styleguide.extendPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/redocly.yaml',
+      'resolve-config/local-config-with-esm.yaml',
+      'resolve-config/redocly.yaml',
+    ]);
+    expect(styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/plugin-esm.mjs',
+    ]);
+
+    expect(styleguide.rules).toEqual({
+      'operation-2xx-response': 'warn',
+    });
+  });
+
+  it('should resolve local file config with commonjs plugin with a default export function', async () => {
+    const config = {
+      ...baseStyleguideConfig,
+      extends: ['local-config-with-commonjs-export-function.yaml'],
+    };
+
+    const { plugins, ...styleguide } = await resolveStyleguideConfig({
+      styleguideConfig: config,
+      configPath,
+    });
+
+    expect(styleguide?.rules?.['operation-2xx-response']).toEqual('warn');
+    expect(plugins).toBeDefined();
+    expect(plugins?.length).toBe(2);
+
+    const localPlugin = plugins?.find((p) => p.id === 'test-plugin');
+    expect(localPlugin).toBeDefined();
+
+    expect(localPlugin).toMatchObject({
+      id: 'test-plugin',
+      rules: {
+        oas3: {
+          'test-plugin/oas3-rule-name': 'oas3-rule-stub',
+        },
+      },
+    });
+
+    expect(styleguide.extendPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/redocly.yaml',
+      'resolve-config/local-config-with-commonjs-export-function.yaml',
+      'resolve-config/redocly.yaml',
+    ]);
+    expect(styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/plugin-with-export-function.cjs',
+    ]);
+
+    expect(styleguide.rules).toEqual({
+      'operation-2xx-response': 'warn',
+    });
+  });
+
   // TODO: fix circular test
   it.skip('should throw circular error', () => {
     const config = {

package/src/config/__tests__/fixtures/resolve-config/local-config-with-commonjs-export-function.yaml

@@ -0,0 +1,2 @@
+plugins:
+  - plugin-with-export-function.cjs

package/src/config/__tests__/fixtures/resolve-config/local-config-with-esm.yaml

@@ -0,0 +1,2 @@
+plugins:
+  - plugin-esm.mjs

package/src/config/__tests__/fixtures/resolve-config/plugin-esm.mjs

@@ -0,0 +1,10 @@
+export default async function () {
+  return {
+    id: 'test-plugin',
+    rules: {
+      oas3: {
+        'oas3-rule-name': 'oas3-rule-stub',
+      },
+    },
+  };
+}

package/src/config/__tests__/fixtures/resolve-config/plugin-with-export-function.cjs

@@ -0,0 +1,10 @@
+module.exports = async function () {
+  return {
+    id: 'test-plugin',
+    rules: {
+      oas3: {
+        'oas3-rule-name': 'oas3-rule-stub',
+      },
+    },
+  };
+};

package/src/config/__tests__/resolve-plugins.test.ts

@@ -1,7 +1,10 @@
 import * as path from 'path';
 import { loadConfig } from '../load';
 
-describe('resolving a plugin', () => {
+// FIXME: skipping due to the 'Test environment has been torn down' Jest error.
+// Covered the below in the `miscellaneous/resolve-plugins` e2e tests.
+// Unskip when Jest gets this fixed.
+describe.skip('resolving a plugin', () => {
   const configPath = path.join(__dirname, 'fixtures/plugin-config.yaml');
 
   it('should prefix rule names with the plugin id', async () => {

package/src/config/all.ts

@@ -5,6 +5,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'info-contact': 'error',
     'info-license': 'error',
     'info-license-url': 'error',
+    'info-license-strict': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
     'parameter-description': 'error',
@@ -108,6 +109,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
   async2Rules: {
     spec: 'error',
     'info-contact': 'error',
+    'info-license-strict': 'error',
     'operation-operationId': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
@@ -117,13 +119,14 @@ const all: PluginStyleguideConfig<'built-in'> = {
   async3Rules: {
     spec: 'error',
     'info-contact': 'error',
+    'info-license-strict': 'error',
     'operation-operationId': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
     'channels-kebab-case': 'error',
     'no-channel-trailing-slash': 'error',
   },
-  arazzoRules: { spec: 'error' },
+  arazzoRules: { spec: 'error', 'parameters-no-body-inside-in': 'off' },
 };
 
 export default all;