@redocly/openapi-core 1.18.1 → 1.20.0

package/src/__tests__/bundle.test.ts

@@ -164,7 +164,7 @@ describe('bundle', () => {
       ''
     );
 
-    const config = await makeConfig({}, { 'registry-dependencies': 'on' });
+    const config = await makeConfig({ rules: {}, decorators: { 'registry-dependencies': 'on' } });
 
     const {
       bundle: result,
@@ -205,7 +205,7 @@ describe('bundle', () => {
       ''
     );
 
-    const config = await makeConfig({});
+    const config = await makeConfig({ rules: {} });
 
     const {
       bundle: { parsed },
@@ -274,3 +274,145 @@ describe('bundleFromString', () => {
     expect(rest.source.body).toEqual(stringDocument);
   });
 });
+
+describe('bundle async', () => {
+  it('should bundle async of version 2.x', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: '2.6.0'
+        info:
+          title: Account Service
+          version: 1.0.0
+          description: This service is in charge of processing user signups
+        channels:
+          user/signedup:
+            subscribe:
+              message:
+                $ref: '#/components/messages/UserSignedUp'
+        components:
+          schemas:
+            UserSignedUp:
+              type: object
+              properties:
+                displayName:
+                  type: string
+                  description: Name of the user
+          messages:
+            UserSignedUp:
+              payload:
+                $ref: '#/components/schemas/UserSignedUp'
+      `,
+      ''
+    );
+
+    const config = await makeConfig({ rules: {} });
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+      dereference: true,
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      asyncapi: 2.6.0
+      info:
+        title: Account Service
+        version: 1.0.0
+        description: This service is in charge of processing user signups
+      channels:
+        user/signedup:
+          subscribe:
+            message:
+              payload: &ref_1
+                type: object
+                properties: &ref_0
+                  displayName:
+                    type: string
+                    description: Name of the user
+      components:
+        schemas:
+          UserSignedUp:
+            type: object
+            properties: *ref_0
+        messages:
+          UserSignedUp:
+            payload: *ref_1
+
+    `);
+  });
+
+  it('should bundle async of version 3.0', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: 3.0.0
+        info:
+          title: Account Service
+          version: 1.0.0
+          description: This service is in charge of processing user signups
+        operations:
+          sendUserSignedup:
+            action: send
+            messages:
+              - $ref: '#/components/messages/UserSignedUp'
+        components:
+          schemas:
+            UserSignedUp:
+              type: object
+              properties:
+                displayName:
+                  type: string
+                  description: Name of the user
+          messages:
+            UserSignedUp:
+              payload:
+                $ref: '#/components/schemas/UserSignedUp'
+      `,
+      ''
+    );
+
+    const config = await makeConfig({ rules: {} });
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+      dereference: true,
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      asyncapi: 3.0.0
+      info:
+        title: Account Service
+        version: 1.0.0
+        description: This service is in charge of processing user signups
+      operations:
+        sendUserSignedup:
+          action: send
+          messages:
+            - payload: &ref_1
+                type: object
+                properties: &ref_0
+                  displayName:
+                    type: string
+                    description: Name of the user
+      components:
+        schemas:
+          UserSignedUp:
+            type: object
+            properties: *ref_0
+        messages:
+          UserSignedUp:
+            payload: *ref_1
+
+    `);
+  });
+});

package/src/__tests__/lint.test.ts

@@ -127,7 +127,7 @@ const testPortalConfig = parseYamlToDocument(
             # serviceAccountPrivateKey: Must be reported as a missing required prop
             serviceAccountEmail: 789 # Must be a string
 
-    i18n:
+    l10n:
       defaultLocale: en-US
       locales:
         - code: 123 # Must be a string
@@ -201,18 +201,14 @@ const testPortalConfig = parseYamlToDocument(
       graphql:
         pagination: section
         menu:
-          {
-            initialLoadState: 'default',
-            requireExactGroups: false,
-            groups:
-              [
-                {
-                  name: 'GraphQL custom group',
-                  directives: { includeByName: ['cacheControl', 'typeDirective'] },
-                },
-              ],
-            otherItemsGroupName: 'Other',
-          }
+          requireExactGroups: false
+          groups:
+            - name: 'GraphQL custom group'
+              directives:
+                includeByName:
+                  - cacheControl
+                  - typeDirective
+          otherItemsGroupName: 'Other'
       sidebar:
         separatorLine: true
         linePosition: top
@@ -1048,7 +1044,7 @@ describe('lint', () => {
           "from": undefined,
           "location": [
             {
-              "pointer": "#/i18n/locales/0/code",
+              "pointer": "#/l10n/locales/0/code",
               "reportOnKey": false,
               "source": "",
             },
@@ -1252,12 +1248,12 @@ describe('lint', () => {
           "from": undefined,
           "location": [
             {
-              "pointer": "#/i18n",
+              "pointer": "#/l10n",
               "reportOnKey": true,
               "source": "",
             },
           ],
-          "message": "Property \`i18n\` is not expected here.",
+          "message": "Property \`l10n\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
           "suggest": [],
@@ -1413,7 +1409,7 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ spec: 'error' }),
+      config: await makeConfig({ rules: { spec: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -1492,7 +1488,7 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ spec: 'error' }),
+      config: await makeConfig({ rules: { spec: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -1528,7 +1524,11 @@ describe('lint', () => {
     const result = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'operation-operationId': 'error' }, undefined, configFilePath),
+      config: await makeConfig({
+        rules: { 'operation-operationId': 'error' },
+        decorators: undefined,
+        configPath: configFilePath,
+      }),
     });
     expect(result).toHaveLength(1);
     expect(result).toMatchObject([
@@ -1590,7 +1590,11 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ spec: 'error' }, undefined, configFilePath),
+      config: await makeConfig({
+        rules: { spec: 'error' },
+        decorators: undefined,
+        configPath: configFilePath,
+      }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -1662,7 +1666,11 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ spec: 'error' }, undefined, configFilePath),
+      config: await makeConfig({
+        rules: { spec: 'error' },
+        decorators: undefined,
+        configPath: configFilePath,
+      }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

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 });