@redocly/openapi-core 1.23.1 → 1.25.0

package/src/config/config-resolvers.ts

@@ -43,6 +43,9 @@ const DEFAULT_PROJECT_PLUGIN_PATHS = ['@theme/plugin.js', '@theme/plugin.cjs', '
 // Workaround for dynamic imports being transpiled to require by Typescript: https://github.com/microsoft/TypeScript/issues/43329#issuecomment-811606238
 const _importDynamic = new Function('modulePath', 'return import(modulePath)');
 
+// Cache instantiated plugins during a single execution
+const pluginsCache: Map<string, Plugin> = new Map();
+
 export async function resolveConfigFileAndRefs({
   configPath,
   externalRefResolver = new BaseResolver(),
@@ -111,9 +114,9 @@ export async function resolveConfig({
   );
 }
 
-function getDefaultPluginPath(configPath: string): string | undefined {
+function getDefaultPluginPath(configDir: string): string | undefined {
   for (const pluginPath of DEFAULT_PROJECT_PLUGIN_PATHS) {
-    const absolutePluginPath = path.resolve(path.dirname(configPath), pluginPath);
+    const absolutePluginPath = path.resolve(configDir, pluginPath);
     if (existsSync(absolutePluginPath)) {
       return pluginPath;
     }
@@ -123,32 +126,58 @@ function getDefaultPluginPath(configPath: string): string | undefined {
 
 export async function resolvePlugins(
   plugins: (string | Plugin)[] | null,
-  configPath: string = ''
+  configDir: string = ''
 ): Promise<Plugin[]> {
   if (!plugins) return [];
 
   // TODO: implement or reuse Resolver approach so it will work in node and browser envs
-  const requireFunc = async (plugin: string | Plugin): Promise<ImportedPlugin | undefined> => {
+  const requireFunc = async (plugin: string | Plugin): Promise<Plugin | undefined> => {
     if (isString(plugin)) {
       try {
-        const maybeAbsolutePluginPath = path.resolve(path.dirname(configPath), plugin);
+        const maybeAbsolutePluginPath = path.resolve(configDir, plugin);
 
         const absolutePluginPath = existsSync(maybeAbsolutePluginPath)
           ? maybeAbsolutePluginPath
           : // For plugins imported from packages specifically
             require.resolve(plugin);
 
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        if (typeof __webpack_require__ === 'function') {
+        if (!pluginsCache.has(absolutePluginPath)) {
+          let requiredPlugin: ImportedPlugin | undefined;
+
           // eslint-disable-next-line @typescript-eslint/ban-ts-comment
           // @ts-ignore
-          return __non_webpack_require__(absolutePluginPath);
-        } else {
-          // you can import both cjs and mjs
-          const mod = await _importDynamic(pathToFileURL(absolutePluginPath).href);
-          return mod.default || mod;
+          if (typeof __webpack_require__ === 'function') {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            requiredPlugin = __non_webpack_require__(absolutePluginPath);
+          } else {
+            // you can import both cjs and mjs
+            const mod = await _importDynamic(pathToFileURL(absolutePluginPath).href);
+            requiredPlugin = mod.default || mod;
+          }
+
+          const pluginCreatorOptions = { contentDir: configDir };
+
+          const pluginModule = isDeprecatedPluginFormat(requiredPlugin)
+            ? requiredPlugin
+            : isCommonJsPlugin(requiredPlugin)
+            ? await requiredPlugin(pluginCreatorOptions)
+            : await requiredPlugin?.default?.(pluginCreatorOptions);
+
+          if (pluginModule?.id && isDeprecatedPluginFormat(requiredPlugin)) {
+            logger.info(`Deprecated plugin format detected: ${pluginModule.id}\n`);
+          }
+
+          if (pluginModule) {
+            pluginsCache.set(absolutePluginPath, {
+              ...pluginModule,
+              path: plugin,
+              absolutePath: absolutePluginPath,
+            });
+          }
         }
+
+        return pluginsCache.get(absolutePluginPath);
       } catch (e) {
         throw new Error(`Failed to load plugin "${plugin}": ${e.message}\n\n${e.stack}`);
       }
@@ -162,7 +191,7 @@ export async function resolvePlugins(
   /**
    * Include the default plugin automatically if it's not in configuration
    */
-  const defaultPluginPath = getDefaultPluginPath(configPath);
+  const defaultPluginPath = getDefaultPluginPath(configDir);
   if (defaultPluginPath) {
     plugins.push(defaultPluginPath);
   }
@@ -182,24 +211,12 @@ export async function resolvePlugins(
         resolvedPlugins.add(p);
       }
 
-      const requiredPlugin: ImportedPlugin | undefined = await requireFunc(p);
-
-      const pluginCreatorOptions = { contentDir: path.dirname(configPath) };
-
-      const pluginModule = isDeprecatedPluginFormat(requiredPlugin)
-        ? requiredPlugin
-        : isCommonJsPlugin(requiredPlugin)
-        ? await requiredPlugin(pluginCreatorOptions)
-        : await requiredPlugin?.default?.(pluginCreatorOptions);
+      const pluginModule: Plugin | undefined = await requireFunc(p);
 
       if (!pluginModule) {
         return;
       }
 
-      if (isString(p) && pluginModule.id && isDeprecatedPluginFormat(requiredPlugin)) {
-        logger.info(`Deprecated plugin format detected: ${pluginModule.id}\n`);
-      }
-
       const id = pluginModule.id;
       if (typeof id !== 'string') {
         throw new Error(
@@ -313,7 +330,10 @@ export async function resolvePlugins(
         plugin.assertions = pluginModule.assertions;
       }
 
-      return plugin;
+      return {
+        ...pluginModule,
+        ...plugin,
+      };
     })
   );
 
@@ -371,7 +391,10 @@ async function resolveAndMergeNestedStyleguideConfig(
     ? // In browser, we don't support plugins from config file yet
       [defaultPlugin]
     : getUniquePlugins(
-        await resolvePlugins([...(styleguideConfig?.plugins || []), defaultPlugin], configPath)
+        await resolvePlugins(
+          [...(styleguideConfig?.plugins || []), defaultPlugin],
+          path.dirname(configPath)
+        )
       );
   const pluginPaths = styleguideConfig?.plugins
     ?.filter(isString)

package/src/config/config.ts

@@ -73,7 +73,10 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
       [SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
       [SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
-      [SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
+      [SpecVersion.Arazzo]: {
+        ...rawConfig.arazzoRules,
+        ...(rawConfig.rules?.assertions ? { assertions: rawConfig.rules.assertions } : {}),
+      },
     };
 
     this.preprocessors = {

package/src/config/minimal.ts

@@ -121,6 +121,9 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'off',
     'step-onFailure-unique': 'off',
     'requestBody-replacements-unique': 'off',
+    'no-criteria-xpath': 'off',
+    'no-actions-type-end': 'off',
+    'criteria-unique': 'off',
   },
 };
 

package/src/config/recommended-strict.ts

@@ -121,6 +121,9 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'error',
     'step-onFailure-unique': 'error',
     'requestBody-replacements-unique': 'error',
+    'no-criteria-xpath': 'error',
+    'no-actions-type-end': 'error',
+    'criteria-unique': 'error',
   },
 };
 

package/src/config/recommended.ts

@@ -121,6 +121,9 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'warn',
     'step-onFailure-unique': 'warn',
     'requestBody-replacements-unique': 'warn',
+    'no-criteria-xpath': 'warn',
+    'no-actions-type-end': 'warn',
+    'criteria-unique': 'warn',
   },
 };
 

package/src/config/types.ts

@@ -30,6 +30,7 @@ import type {
   BuiltInOAS3RuleId,
   BuiltInArazzoRuleId,
 } from '../types/redocly-yaml';
+import type { JSONSchema } from 'json-schema-to-ts';
 
 export type RuleSeverity = ProblemSeverity | 'off';
 
@@ -136,12 +137,27 @@ export type AssertionsConfig = Record<string, CustomFunction>;
 
 export type Plugin = {
   id: string;
+
   configs?: Record<string, PluginStyleguideConfig>;
   rules?: CustomRulesConfig;
   preprocessors?: PreprocessorsConfig;
   decorators?: DecoratorsConfig;
   typeExtension?: TypeExtensionsConfig;
   assertions?: AssertionsConfig;
+
+  // Realm properties
+  path?: string;
+  absolutePath?: string;
+  processContent?: (actions: any, content: any) => Promise<void> | void;
+  afterRoutesCreated?: (actions: any, content: any) => Promise<void> | void;
+  loaders?: Record<
+    string,
+    (path: string, context: any, reportError: (error: Error) => void) => Promise<unknown>
+  >;
+  requiredEntitlements?: string[];
+  ssoConfigSchema?: JSONSchema;
+  redoclyConfigSchema?: JSONSchema;
+  ejectIgnore?: string[];
 };
 
 type PluginCreatorOptions = {

package/src/rules/arazzo/__tests__/criteria-unique.test.ts

@@ -0,0 +1,161 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo criteria-unique', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: create-event
+              description: >-
+                Create a new special event.
+              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
+              requestBody:
+                payload:
+                  name: 'Mermaid Treasure Identification and Analysis'
+                  location: 'Under the seaaa 🦀 🎶 🌊.'
+                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
+                  dates:
+                    - '2023-09-05'
+                    - '2023-09-08'
+                  price: 0
+              successCriteria:
+                - condition: $statusCode == 200
+                - condition: $statusCode == 200
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type: jsonpath
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type: jsonpath
+              onSuccess:
+                - name: 'onSuccessActionName'
+                  type: 'goto'
+                  stepId: 'buy-ticket'
+                  criteria:
+                    - condition: $response.body.open == true
+                    - condition: $response.body.open == true
+              onFailure:
+                - name: 'onFailureActionName'
+                  type: 'goto'
+                  stepId: 'buy-ticket'
+                  criteria:
+                    - condition: $response.body.open == true
+                    - condition: $response.body.open == true
+              outputs:
+                createdEventId: $response.body.eventId
+                name: $response.body.name
+        - workflowId: get-museum-hours-2
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should report when the duplicated criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'criteria-unique': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The Step SuccessCriteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/3",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The Step SuccessCriteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onSuccess/0/criteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The SuccessAction criteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onFailure/0/criteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The FailureAction criteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the duplicated criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});

package/src/rules/arazzo/__tests__/no-actions-type-end.test.ts

@@ -0,0 +1,122 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo no-actions-type-end', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: create-event
+              description: >-
+                Create a new special event.
+              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
+              requestBody:
+                payload:
+                  name: 'Mermaid Treasure Identification and Analysis'
+                  location: 'Under the seaaa 🦀 🎶 🌊.'
+                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
+                  dates:
+                    - '2023-09-05'
+                    - '2023-09-08'
+                  price: 0
+              successCriteria:
+                - condition: $statusCode == 201
+              onSuccess:
+                - name: 'onSuccessActionName'
+                  type: 'end'
+                  stepId: 'buy-ticket'
+              onFailure:
+                - name: 'onFailureActionName'
+                  type: 'end'
+                  stepId: 'buy-ticket'
+              outputs:
+                createdEventId: $response.body.eventId
+                name: $response.body.name
+        - workflowId: get-museum-hours-2
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should report when the type `end` action exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'no-actions-type-end': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onSuccess/0/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`end\` type action is not supported by Spot.",
+          "ruleId": "no-actions-type-end",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onFailure/0/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`end\` type action is not supported by Spot.",
+          "ruleId": "no-actions-type-end",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the type `end` action exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});

package/src/rules/arazzo/__tests__/no-criteria-xpath.test.ts

@@ -0,0 +1,127 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo no-criteria-xpath', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: create-event
+              description: >-
+                Create a new special event.
+              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
+              requestBody:
+                payload:
+                  name: 'Mermaid Treasure Identification and Analysis'
+                  location: 'Under the seaaa 🦀 🎶 🌊.'
+                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
+                  dates:
+                    - '2023-09-05'
+                    - '2023-09-08'
+                  price: 0
+              successCriteria:
+                - condition: $statusCode == 201
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type:
+                    type: jsonpath
+                    version: draft-goessner-dispatch-jsonpath-00
+                - context: $response.body
+                  condition: $.name == 'Orca Identification and Analysis'
+                  type: xpath
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type:
+                    type: xpath
+                    version: xpath-30
+              outputs:
+                createdEventId: $response.body.eventId
+                name: $response.body.name
+        - workflowId: get-museum-hours-2
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should report when the `xpath` criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'no-criteria-xpath': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/2/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`xpath\` type criteria is not supported by Spot.",
+          "ruleId": "no-criteria-xpath",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/3/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`xpath\` type criteria is not supported by Spot.",
+          "ruleId": "no-criteria-xpath",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the `xpath` criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});