@redocly/openapi-core 1.0.0-beta.49 → 1.0.0-beta.53

package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('no-invalid-media-type-examples', () => {
@@ -34,7 +34,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-invalid-media-type-examples': 'error' } }),
+      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -51,7 +51,7 @@ describe('no-invalid-media-type-examples', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Example value must conform to the schema: \`a\` property type should be string.",
+          "message": "Example value must conform to the schema: \`a\` property type must be string.",
           "ruleId": "no-invalid-media-type-examples",
           "severity": "error",
           "suggest": Array [],
@@ -68,7 +68,7 @@ describe('no-invalid-media-type-examples', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Example value must conform to the schema: \`b\` property type should be number.",
+          "message": "Example value must conform to the schema: \`b\` property type must be number.",
           "ruleId": "no-invalid-media-type-examples",
           "severity": "error",
           "suggest": Array [],
@@ -107,13 +107,10 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'no-invalid-media-type-examples': {
-            severity: 'error',
-            disallowAdditionalProperties: true,
-          },
+      config: makeConfig({
+        'no-invalid-media-type-examples': {
+          severity: 'error',
+          disallowAdditionalProperties: true,
         },
       }),
     });
@@ -132,7 +129,7 @@ describe('no-invalid-media-type-examples', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Example value must conform to the schema: should NOT have additional properties \`c\`.",
+          "message": "Example value must conform to the schema: must NOT have additional properties \`c\`.",
           "ruleId": "no-invalid-media-type-examples",
           "severity": "error",
           "suggest": Array [],
@@ -170,13 +167,10 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'no-invalid-media-type-examples': {
-            severity: 'error',
-            disallowAdditionalProperties: true,
-          },
+      config: makeConfig({
+        'no-invalid-media-type-examples': {
+          severity: 'error',
+          disallowAdditionalProperties: true,
         },
       }),
     });
@@ -223,13 +217,10 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({
-        extends: [],
-        rules: {
-          'no-invalid-media-type-examples': {
-            severity: 'error',
-            disallowAdditionalProperties: true,
-          },
+      config: makeConfig({
+        'no-invalid-media-type-examples': {
+          severity: 'error',
+          disallowAdditionalProperties: true,
         },
       }),
     });
@@ -248,7 +239,7 @@ describe('no-invalid-media-type-examples', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Example value must conform to the schema: \`a\` property type should be string.",
+          "message": "Example value must conform to the schema: \`a\` property type must be string.",
           "ruleId": "no-invalid-media-type-examples",
           "severity": "error",
           "suggest": Array [],
@@ -279,7 +270,7 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-invalid-media-type-examples': 'error' } }),
+      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
@@ -311,9 +302,92 @@ describe('no-invalid-media-type-examples', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-invalid-media-type-examples': 'error' } }),
+      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
+
+  it('should work with cross-file $ref', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        components:
+          schemas:
+            C:
+              $ref: './fixtures/common.yaml#/components/schemas/A'
+        paths:
+          /pet:
+            get:
+              responses:
+                200:
+                  content:
+                    application/json:
+                      example: {
+                        "a": "test",
+                        "b": "test"
+                      }
+                      schema:
+                        $ref: '#/components/schemas/C'
+
+      `,
+      __dirname + '/foobar.yaml',
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not throw for ajv throw', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            get:
+              responses:
+                200:
+                  content:
+                    application/json:
+                      example: {}
+                      schema:
+                        nullable: true
+
+      `,
+      'foobar.yaml',
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": Object {
+            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
+            "source": "foobar.yaml",
+          },
+          "location": Array [
+            Object {
+              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/schema",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example validation errored: \\"nullable\\" cannot be used without \\"type\\".",
+          "ruleId": "no-invalid-media-type-examples",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
 });

package/src/rules/oas3/__tests__/no-server-example.com.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 oas3-no-server-example.com', () => {
@@ -18,7 +18,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-server-example.com': 'error' } }),
+      config: makeConfig({ 'no-server-example.com': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -53,7 +53,7 @@ describe('Oas3 oas3-no-server-example.com', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-server-example.com': 'error' } }),
+      config: makeConfig({ 'no-server-example.com': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 oas3-no-server-trailing-slash', () => {
@@ -18,7 +18,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-server-trailing-slash': 'error' } }),
+      config: makeConfig({ 'no-server-trailing-slash': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -53,7 +53,7 @@ describe('Oas3 oas3-no-server-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-server-trailing-slash': 'error' } }),
+      config: makeConfig({ 'no-server-trailing-slash': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/rules/oas3/__tests__/no-unused-components.test.ts

@@ -1,7 +1,7 @@
 import { outdent } from 'outdent';
-import { LintConfig } from '../../../config/config';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { makeConfig } from '../../__tests__/config';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 no-unused-components', () => {
@@ -43,7 +43,7 @@ describe('Oas3 no-unused-components', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: new LintConfig({ extends: [], rules: { 'no-unused-components': 'error' } }),
+      config: makeConfig({ 'no-unused-components': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -2,9 +2,11 @@ import { outdent } from 'outdent';
 import { lintDocument } from '../../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
 import { LintConfig } from '../../../../config/config';
+import { defaultPlugin } from '../../../../config/builtIn';
+
 import { BaseResolver } from '../../../../resolve';
 
-const allConfig = new LintConfig({ extends: ['all'] });
+const allConfig = new LintConfig({ plugins: [defaultPlugin], extends: ['all'] });
 
 describe('Oas3 Structural visitor basic', () => {
   it('should report wrong types', async () => {

package/src/rules/oas3/__tests__/spec/utils.ts

@@ -2,6 +2,7 @@ import { LintConfig, RuleConfig } from '../../../../config/config';
 import { parseYamlToDocument } from '../../../../../__tests__/utils';
 import { lintDocument } from '../../../../lint';
 import { BaseResolver } from '../../../../resolve';
+import { defaultPlugin } from '../../../../config/builtIn';
 
 export async function validateDoc(
   source: string,
@@ -13,6 +14,7 @@ export async function validateDoc(
     externalRefResolver: new BaseResolver(),
     document,
     config: new LintConfig({
+      plugins: [defaultPlugin],
       extends: [],
       rules,
     }),

package/src/rules/oas3/index.ts

@@ -1,5 +1,4 @@
-import { Oas3RuleSet } from '../../lint';
-
+import { Oas3RuleSet } from '../../oas-types';
 import { OasSpec } from '../common/spec';
 import { Operation2xxResponse } from '../common/operation-2xx-response';
 import { OperationIdUnique } from '../common/operation-operationId-unique';
@@ -42,6 +41,7 @@ import { NoEmptyEnumServers } from './no-servers-empty-enum';
 import { Oas3Decorator } from '../../visitors';
 
 export const rules = {
+  spec: OasSpec,
   'info-description': InfoDescription,
   'info-contact': InfoContact,
   'info-license': InfoLicense,
@@ -78,8 +78,7 @@ export const rules = {
   'no-identical-paths': NoIdenticalPaths,
   'no-ambiguous-paths': NoAmbiguousPaths,
   'no-undefined-server-variable': NoUndefinedServerVariable,
-  'no-servers-empty-enum': NoEmptyEnumServers,
-  spec: OasSpec,
+  'no-servers-empty-enum': NoEmptyEnumServers
 } as Oas3RuleSet;
 
 export const preprocessors = {};

package/src/rules/oas3/no-invalid-media-type-examples.ts

@@ -29,26 +29,34 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
         }
 
         function validateExample(example: any, dataLoc: Location) {
-          const { valid, errors } = validateJsonSchema(
-            example,
-            mediaType.schema!,
-            location.child('schema'),
-            dataLoc.pointer,
-            resolve,
-            disallowAdditionalProperties,
-          );
-          if (!valid) {
-            for (let error of errors) {
-              report({
-                message: `Example value must conform to the schema: ${error.message}.`,
-                location: {
-                  ...new Location(dataLoc.source, error.dataPath),
-                  reportOnKey: error.keyword === 'additionalProperties',
-                },
-                from: location,
-                suggest: error.suggest,
-              });
+          try {
+            const { valid, errors } = validateJsonSchema(
+              example,
+              mediaType.schema!,
+              location.child('schema'),
+              dataLoc.pointer,
+              resolve,
+              disallowAdditionalProperties,
+            );
+            if (!valid) {
+              for (let error of errors) {
+                report({
+                  message: `Example value must conform to the schema: ${error.message}.`,
+                  location: {
+                    ...new Location(dataLoc.source, error.instancePath),
+                    reportOnKey: error.keyword === 'additionalProperties',
+                  },
+                  from: location,
+                  suggest: error.suggest,
+                });
+              }
             }
+          } catch(e) {
+            report({
+              message: `Example validation errored: ${e.message}.`,
+              location: location.child('schema'),
+              from: location
+            });
           }
         }
       },

package/src/visitors.ts

@@ -49,7 +49,12 @@ import { NormalizedNodeType } from './types';
 import { Stack } from './utils';
 import { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import { Location } from './ref-utils';
-export type VisitFunction<T> = (node: T, ctx: UserContext, parents?: any) => void;
+export type VisitFunction<T> = (
+  node: T,
+  ctx: UserContext & { ignoreNextVisitorsOnNode: () => void },
+  parents?: any,
+  context?: any,
+) => void;
 
 type VisitRefFunction = (node: OasRef, ctx: UserContext, resolved: ResolveResult<any>) => void;
 
@@ -86,7 +91,6 @@ export type VisitorLevelContext = {
   isSkippedLevel: false;
   type: NormalizedNodeType;
   parent: VisitorLevelContext | null;
-
   activatedOn: Stack<{
     node?: any;
     withParentNode?: any;
@@ -264,6 +268,11 @@ export function normalizeVisitors<T extends BaseVisitor>(
 ): NormalizedOasVisitors<T> {
   const normalizedVisitors: NormalizedOasVisitors<T> = {} as any;
 
+  normalizedVisitors.any = {
+    enter: [],
+    leave: [],
+  };
+
   for (const typeName of Object.keys(types) as Array<keyof T>) {
     normalizedVisitors[typeName] = {
       enter: [],
@@ -271,11 +280,6 @@ export function normalizeVisitors<T extends BaseVisitor>(
     } as any;
   }
 
-  normalizedVisitors.any = {
-    enter: [],
-    leave: [],
-  };
-
   normalizedVisitors.ref = {
     enter: [],
     leave: [],
@@ -376,7 +380,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
     }
 
     for (const typeName of visitorKeys as Array<keyof T>) {
-      const typeVisitor = (visitor[typeName] as any) as NestedVisitObject<any, T>;
+      const typeVisitor = visitor[typeName] as any as NestedVisitObject<any, T>;
       const normalizedTypeVisitor = normalizedVisitors[typeName]!;
 
       if (!typeVisitor) continue;

package/src/walk.ts

@@ -1,6 +1,5 @@
 import { Referenced } from './typings/openapi';
 import { Location, isRef } from './ref-utils';
-
 import {
   VisitorLevelContext,
   NormalizedOasVisitors,
@@ -10,9 +9,8 @@ import {
 
 import { ResolvedRefMap, Document, ResolveError, YamlParseError, Source } from './resolve';
 import { pushStack, popStack } from './utils';
-import { OasVersion } from './lint';
+import { OasVersion } from './oas-types';
 import { NormalizedNodeType, isNamedType } from './types';
-
 type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 
 export type ResolveResult<T extends NonUndefined> =
@@ -109,7 +107,6 @@ export function walkDocument<T>(opts: {
   ctx: WalkContext;
 }) {
   const { document, rootType, normalizedVisitors, resolvedRefMap, ctx } = opts;
-
   const seenNodesPerType: Record<string, Set<any>> = {};
   const seenRefs = new Set<any>();
 
@@ -124,7 +121,6 @@ export function walkDocument<T>(opts: {
   ) {
     let currentLocation = location;
     const { node: resolvedNode, location: resolvedLocation, error } = resolve(node);
-
     const enteredContexts: Set<VisitorLevelContext> = new Set();
 
     if (isRef(node)) {
@@ -209,7 +205,16 @@ export function walkDocument<T>(opts: {
             if (!activatedOn.skipped) {
               visitedBySome = true;
               enteredContexts.add(context);
-              visitWithContext(visit, resolvedNode, context, ruleId, severity);
+              const ignoreNextVisitorsOnNode = visitWithContext(
+                visit,
+                resolvedNode,
+                context,
+                ruleId,
+                severity,
+              );
+              if (ignoreNextVisitorsOnNode) {
+                break;
+              }
             }
           }
         }
@@ -234,15 +239,16 @@ export function walkDocument<T>(opts: {
           }
 
           if (isRef(node)) {
-            props.push(...Object.keys(node).filter((k) => k!== '$ref' && !props.includes(k))); // properties on the same level as $ref
+            props.push(...Object.keys(node).filter((k) => k !== '$ref' && !props.includes(k))); // properties on the same level as $ref
           }
 
           for (const propName of props) {
             let value = resolvedNode[propName];
+
             let loc = resolvedLocation;
 
             if (value === undefined) {
-              value =  node[propName];
+              value = node[propName];
               loc = location; // properties on the same level as $ref should resolve against original location, not target
             }
 
@@ -322,6 +328,7 @@ export function walkDocument<T>(opts: {
       }
     }
 
+    // returns true ignores all the next visitors on the specific node
     function visitWithContext(
       visit: VisitFunction<any>,
       node: any,
@@ -330,6 +337,8 @@ export function walkDocument<T>(opts: {
       severity: ProblemSeverity,
     ) {
       const report = reportFn.bind(undefined, ruleId, severity);
+      let ignoreNextVisitorsOnNode = false;
+
       visit(
         node,
         {
@@ -341,9 +350,15 @@ export function walkDocument<T>(opts: {
           key,
           parentLocations: collectParentsLocations(context),
           oasVersion: ctx.oasVersion,
+          ignoreNextVisitorsOnNode: () => {
+            ignoreNextVisitorsOnNode = true;
+          },
         },
         collectParents(context),
+        context,
       );
+
+      return ignoreNextVisitorsOnNode;
     }
 
     function resolve<T>(
@@ -354,6 +369,7 @@ export function walkDocument<T>(opts: {
       const refId = from + '::' + ref.$ref;
 
       const resolvedRef = resolvedRefMap.get(refId);
+
       if (!resolvedRef) {
         return {
           location: undefined,