@redocly/openapi-core 1.10.5 → 1.11.0

package/src/decorators/oas3/__tests__/remove-unused-components.test.ts

@@ -168,4 +168,146 @@ describe('oas3 remove-unused-components', () => {
       },
     });
   });
+
+  it('should remove transitively unused components', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: "3.0.0"
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              parameters:
+                - $ref: '#/components/parameters/used'
+        components:
+          parameters:
+            used:
+              name: used
+            unused:
+              name: unused
+          schemas:
+            Unused:
+              type: integer
+              enum:
+                - 1
+                - 2
+            Transitive:
+              type: object
+              properties:
+                link:
+                  $ref: '#/components/schemas/Unused'
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await bundleDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({}),
+      removeUnusedComponents: true,
+    });
+
+    expect(results.bundle.parsed).toEqual({
+      openapi: '3.0.0',
+      paths: {
+        '/pets': {
+          get: {
+            summary: 'List all pets',
+            operationId: 'listPets',
+            parameters: [
+              {
+                $ref: '#/components/parameters/used',
+              },
+            ],
+          },
+        },
+      },
+      components: {
+        parameters: {
+          used: {
+            name: 'used',
+          },
+        },
+      },
+    });
+  });
+
+  it('should remove transitively unused components with colliding paths', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: "3.0.0"
+        paths:
+          /pets:
+            get:
+              responses: 
+                200:
+                  content: 
+                    application/json: 
+                      schema: 
+                        $ref: "#/components/schemas/Transitive2"
+        components:
+          schemas:
+            Unused: # <-- this will be removed correctly
+              type: integer
+            Transitive: # <-- this will be removed correctly
+              type: object
+              properties:
+                link:
+                  $ref: '#/components/schemas/Unused'
+            Used:
+              type: integer
+            Transitive2:
+              type: object
+              properties:
+                link:
+                  $ref: '#/components/schemas/Used'
+        `,
+
+      'foobar.yaml'
+    );
+
+    const results = await bundleDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({}),
+      removeUnusedComponents: true,
+    });
+
+    expect(results.bundle.parsed).toEqual({
+      openapi: '3.0.0',
+      paths: {
+        '/pets': {
+          get: {
+            responses: {
+              200: {
+                content: {
+                  'application/json': {
+                    schema: {
+                      $ref: '#/components/schemas/Transitive2',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      components: {
+        schemas: {
+          Transitive2: {
+            type: 'object',
+            properties: {
+              link: {
+                $ref: '#/components/schemas/Used',
+              },
+            },
+          },
+          Used: {
+            type: 'integer',
+          },
+        },
+      },
+    });
+  });
 });

package/src/decorators/oas3/remove-unused-components.ts

@@ -2,12 +2,12 @@ import { Location } from '../../ref-utils';
 import { isEmptyObject } from '../../utils';
 
 import type { Oas3Decorator } from '../../visitors';
-import type { Oas3Components } from '../../typings/openapi';
+import type { Oas3Components, Oas3Definition } from '../../typings/openapi';
 
 export const RemoveUnusedComponents: Oas3Decorator = () => {
   const components = new Map<
     string,
-    { used: boolean; componentType?: keyof Oas3Components; name: string }
+    { usedIn: Location[]; componentType?: keyof Oas3Components; name: string }
   >();
 
   function registerComponent(
@@ -16,15 +16,45 @@ export const RemoveUnusedComponents: Oas3Decorator = () => {
     name: string
   ): void {
     components.set(location.absolutePointer, {
-      used: components.get(location.absolutePointer)?.used || false,
+      usedIn: components.get(location.absolutePointer)?.usedIn ?? [],
       componentType,
       name,
     });
   }
 
+  function removeUnusedComponents(root: Oas3Definition, removedPaths: string[]): number {
+    const removedLengthStart = removedPaths.length;
+
+    for (const [path, { usedIn, name, componentType }] of components) {
+      const used = usedIn.some(
+        (location) =>
+          !removedPaths.some(
+            (removed) =>
+              location.absolutePointer.startsWith(removed) &&
+              (location.absolutePointer.length === removed.length ||
+                location.absolutePointer[removed.length] === '/')
+          )
+      );
+
+      if (!used && componentType && root.components) {
+        removedPaths.push(path);
+        const componentChild = root.components[componentType];
+        delete componentChild![name];
+        components.delete(path);
+        if (isEmptyObject(componentChild)) {
+          delete root.components[componentType];
+        }
+      }
+    }
+
+    return removedPaths.length > removedLengthStart
+      ? removeUnusedComponents(root, removedPaths)
+      : removedPaths.length;
+  }
+
   return {
     ref: {
-      leave(ref, { type, resolve, key }) {
+      leave(ref, { location, type, resolve, key }) {
         if (
           ['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(
             type.name
@@ -37,29 +67,24 @@ export const RemoveUnusedComponents: Oas3Decorator = () => {
           const componentLevelLocalPointer = localPointer.split('/').slice(0, 4).join('/');
           const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
 
-          components.set(pointer, {
-            used: true,
-            name: key.toString(),
-          });
+          const registered = components.get(pointer);
+
+          if (registered) {
+            registered.usedIn.push(location);
+          } else {
+            components.set(pointer, {
+              usedIn: [location],
+              name: key.toString(),
+            });
+          }
         }
       },
     },
     Root: {
       leave(root, ctx) {
         const data = ctx.getVisitorData() as { removedCount: number };
-        data.removedCount = 0;
+        data.removedCount = removeUnusedComponents(root, []);
 
-        components.forEach((usageInfo) => {
-          const { used, componentType, name } = usageInfo;
-          if (!used && componentType && root.components) {
-            const componentChild = root.components[componentType];
-            delete componentChild![name];
-            data.removedCount++;
-            if (isEmptyObject(componentChild)) {
-              delete root.components[componentType];
-            }
-          }
-        });
         if (isEmptyObject(root.components)) {
           delete root.components;
         }

package/src/format/format.ts

@@ -51,7 +51,8 @@ export type OutputFormat =
   | 'json'
   | 'checkstyle'
   | 'codeclimate'
-  | 'summary';
+  | 'summary'
+  | 'github-actions';
 
 export function getTotals(problems: (NormalizedProblem & { ignored?: boolean })[]): Totals {
   let errors = 0;
@@ -155,6 +156,8 @@ export function formatProblems(
     case 'summary':
       formatSummary(problems);
       break;
+    case 'github-actions':
+      outputForGithubActions(problems, cwd);
   }
 
   if (totalProblems - ignoredProblems > maxProblems) {
@@ -373,3 +376,60 @@ function xmlEscape(s: string): string {
     }
   });
 }
+
+function outputForGithubActions(problems: NormalizedProblem[], cwd: string): void {
+  for (const problem of problems) {
+    for (const location of problem.location.map(getLineColLocation)) {
+      let command;
+      switch (problem.severity) {
+        case 'error':
+          command = 'error';
+          break;
+        case 'warn':
+          command = 'warning';
+          break;
+      }
+      const suggest = formatDidYouMean(problem);
+      const message = suggest !== '' ? problem.message + '\n\n' + suggest : problem.message;
+      const properties = {
+        title: problem.ruleId,
+        file: isAbsoluteUrl(location.source.absoluteRef)
+          ? location.source.absoluteRef
+          : path.relative(cwd, location.source.absoluteRef),
+        line: location.start.line,
+        col: location.start.col,
+        endLine: location.end?.line,
+        endColumn: location.end?.col,
+      };
+      output.write(`::${command} ${formatProperties(properties)}::${escapeMessage(message)}\n`);
+    }
+  }
+
+  function formatProperties(props: Record<string, any>): string {
+    return Object.entries(props)
+      .filter(([, v]) => v !== null && v !== undefined)
+      .map(([k, v]) => `${k}=${escapeProperty(v)}`)
+      .join(',');
+  }
+
+  function toString(v: any): string {
+    if (v === null || v === undefined) {
+      return '';
+    } else if (typeof v === 'string' || v instanceof String) {
+      return v as string;
+    }
+    return JSON.stringify(v);
+  }
+
+  function escapeMessage(v: any): string {
+    return toString(v).replace(/%/g, '%25').replace(/\r/g, '%0D').replace(/\n/g, '%0A');
+  }
+  function escapeProperty(v: any): string {
+    return toString(v)
+      .replace(/%/g, '%25')
+      .replace(/\r/g, '%0D')
+      .replace(/\n/g, '%0A')
+      .replace(/:/g, '%3A')
+      .replace(/,/g, '%2C');
+  }
+}

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

@@ -470,4 +470,149 @@ describe('no-invalid-media-type-examples', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
+
+  it('should not report if only externalValue is set', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            get:
+              responses:
+                '200':
+                  content:
+                    application/json:
+                      schema:
+                        type: object
+                        properties:
+                          a:
+                            type: string
+                          b:
+                            type: number
+                      examples:
+                        first:
+                          externalValue: "https://example.com/example.json"
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+
+  it('should not report if value is valid and externalValue is also set', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            get:
+              responses:
+                '200':
+                  content:
+                    application/json:
+                      schema:
+                        type: object
+                        properties:
+                          a:
+                            type: string
+                          b:
+                            type: number
+                      examples:
+                        first:
+                          externalValue: "https://example.com/example.json"
+                          value:
+                            a: "A"
+                            b: 0
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+
+  it('should report invalid value when externalValue is also set', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            get:
+              responses:
+                '200':
+                  content:
+                    application/json:
+                      schema:
+                        type: object
+                        properties:
+                          a:
+                            type: string
+                          b:
+                            type: number
+                      examples:
+                        first:
+                          externalValue: "https://example.com/example.json"
+                          value:
+                            a: 0
+                            b: "0"
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-invalid-media-type-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": {
+            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
+            "source": "foobar.yaml",
+          },
+          "location": [
+            {
+              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/examples/first/value/a",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example value must conform to the schema: \`a\` property type must be string.",
+          "ruleId": "no-invalid-media-type-examples",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "from": {
+            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
+            "source": "foobar.yaml",
+          },
+          "location": [
+            {
+              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/examples/first/value/b",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example value must conform to the schema: \`b\` property type must be number.",
+          "ruleId": "no-invalid-media-type-examples",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
 });

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

@@ -35,6 +35,9 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
             location = isMultiple ? resolved.location.child('value') : resolved.location;
             example = resolved.node;
           }
+          if (isMultiple && typeof example.value === 'undefined') {
+            return;
+          }
           validateExample(
             isMultiple ? example.value : example,
             mediaType.schema!,

package/src/types/redocly-yaml.ts

@@ -353,6 +353,12 @@ const ObjectRule: NodeType = {
   required: ['severity'],
 };
 
+// TODO: add better type tree for this
+const Schema: NodeType = {
+  properties: {},
+  additionalProperties: {},
+};
+
 const AssertionDefinitionSubject: NodeType = {
   properties: {
     type: {
@@ -1120,6 +1126,7 @@ const CoreConfigTypes: Record<string, NodeType> = {
   ButtonOverrides,
   Overrides,
   ObjectRule,
+  Schema,
   RightPanel,
   Rules,
   Shape,