Merge remote-tracking branch 'origin/develop' into feat/core/json-rul…

…eset-validation
stoplightio · Apr 14, 2022 · 49be390 · 49be390
2 parents e08ba8b + 4ececf0
commit 49be390
Show file tree

Hide file tree

Showing 25 changed files with 149 additions and 31 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,2 @@
+* @stoplightio/oss-spectral
+/packages/rulesets/src/asyncapi @magicmatatjahu @smoya @jonaslagoni
diff --git a/docs/getting-started/3-rulesets.md b/docs/getting-started/3-rulesets.md
@@ -75,7 +75,11 @@ The `extends` keyword can be combined with extra rules in order to extend and ov
 
 Formats are an optional way to specify which API description formats a rule, or ruleset, is applicable to. Currently Spectral supports these formats:
 
-- `asyncapi2` (AsyncAPI v2.0)
+- `aas2` (AsyncAPI v2.x)
+- `aas2_0` (AsyncAPI v2.0.0)
+- `aas2_1` (AsyncAPI v2.1.0)
+- `aas2_2` (AsyncAPI v2.2.0)
+- `aas2_3` (AsyncAPI v2.3.0)
 - `oas2` (OpenAPI v2.0)
 - `oas3` (OpenAPI v3.x)
 - `oas3.0` (OpenAPI v3.0.x)

diff --git a/docs/reference/asyncapi-rules.md b/docs/reference/asyncapi-rules.md
@@ -369,3 +369,15 @@ that acts as a library (a container storing reusable objects, leveraged by other
 specifications that reference those objects).
 
 **Recommended:** Yes
+
+### asyncapi-unused-components-server
+
+Potential unused reusable `server` entry has been detected.
+
+<!-- theme: warning -->
+
+_Warning:_ This rule may identify false positives when linting a specification
+that acts as a library (a container storing reusable objects, leveraged by other
+specifications that reference those objects).
+
+**Recommended:** Yes
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@stoplight/spectral-core-v1.11.1](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-core-v1.11.0...@stoplight/spectral-core-v1.11.1) (2022-03-16)
+
+
+### Bug Fixes
+
+* **core:** bump nimma from 0.1.8 to 0.2.0 ([#2088](https://github.com/stoplightio/spectral/issues/2088)) ([36ec40e](https://github.com/stoplightio/spectral/commit/36ec40e92abb6fe0ffbc104722599147dda555fb))
+
 # [@stoplight/spectral-core-v1.11.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-core-v1.10.2...@stoplight/spectral-core-v1.11.0) (2022-03-03)
 
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/spectral-core",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "sideEffects": false,
   "homepage": "https://github.com/stoplightio/spectral",
   "bugs": "https://github.com/stoplightio/spectral/issues",
@@ -50,7 +50,7 @@
     "lodash": "~4.17.21",
     "lodash.topath": "^4.5.2",
     "minimatch": "3.0.4",
-    "nimma": "0.1.8",
+    "nimma": "0.2.0",
     "pony-cause": "^1.0.0",
     "simple-eval": "1.0.0",
     "tslib": "^2.3.0"

diff --git a/packages/core/src/runner/runner.ts b/packages/core/src/runner/runner.ts
@@ -99,6 +99,7 @@ function execute(input: unknown, callbacks: Record<string, Callback[]>, jsonPath
     fallback: jsonPathPlus,
     unsafe: false,
     output: 'auto',
+    customShorthands: {},
   });
 
   nimma.query(

diff --git a/packages/functions/CHANGELOG.md b/packages/functions/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@stoplight/spectral-functions-v1.6.1](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-functions-v1.6.0...@stoplight/spectral-functions-v1.6.1) (2022-03-08)
+
+
+### Bug Fixes
+
+* **functions:** reset RegExp.lastIndex to zero when using cached RegExp objects ([#2079](https://github.com/stoplightio/spectral/issues/2079)) ([4839527](https://github.com/stoplightio/spectral/commit/48395273d28fc58ab450277681956b1b50f3f8ee))
+
 # [@stoplight/spectral-functions-v1.6.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-functions-v1.5.2...@stoplight/spectral-functions-v1.6.0) (2022-03-03)
 
 

diff --git a/packages/functions/package.json b/packages/functions/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/spectral-functions",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "sideEffects": false,
   "homepage": "https://github.com/stoplightio/spectral",
   "bugs": "https://github.com/stoplightio/spectral/issues",

diff --git a/packages/functions/src/__tests__/pattern.test.ts b/packages/functions/src/__tests__/pattern.test.ts
@@ -18,6 +18,12 @@ describe('Core Functions / Pattern', () => {
       expect(await runPattern('aBc', { match: '/[abc]+/im' })).toEqual([]);
     });
 
+    it('should return same results when given a global (g) marker (pattern cache usecase)', async () => {
+      expect(await runPattern('abc', { match: '/[abc]+/gi' })).toEqual([]);
+      expect(await runPattern('abc', { match: '/[abc]+/gi' })).toEqual([]);
+      expect(await runPattern('abc', { match: '/[abc]+/gi' })).toEqual([]);
+    });
+
     it('given string regex containing invalid flags, should throw an exception', async () => {
       await expect(runPattern('aBc', { match: '/[abc]+/invalid' })).rejects.toThrow(
         "Invalid flags supplied to RegExp constructor 'invalid'",

diff --git a/packages/functions/src/pattern.ts b/packages/functions/src/pattern.ts
@@ -27,6 +27,7 @@ const cache = new Map<string, RegExp>();
 function getFromCache(pattern: string): RegExp {
   const existingPattern = cache.get(pattern);
   if (existingPattern !== void 0) {
+    existingPattern.lastIndex = 0;
     return existingPattern;
   }
 

diff --git a/packages/ruleset-migrator/CHANGELOG.md b/packages/ruleset-migrator/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@stoplight/spectral-ruleset-migrator-v1.7.3](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-ruleset-migrator-v1.7.2...@stoplight/spectral-ruleset-migrator-v1.7.3) (2022-03-10)
+
+
+### Bug Fixes
+
+* **ruleset-migrator:** validate aliases correctly ([#2085](https://github.com/stoplightio/spectral/issues/2085)) ([1f4ab20](https://github.com/stoplightio/spectral/commit/1f4ab208c21c7a1d1263dfd50cc6da658568e871))
+
 # [@stoplight/spectral-ruleset-migrator-v1.7.2](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-ruleset-migrator-v1.7.1...@stoplight/spectral-ruleset-migrator-v1.7.2) (2022-01-26)
 
 ### Bug Fixes

diff --git a/packages/ruleset-migrator/package.json b/packages/ruleset-migrator/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/spectral-ruleset-migrator",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "homepage": "https://github.com/stoplightio/spectral",
   "bugs": "https://github.com/stoplightio/spectral/issues",
   "author": "Stoplight <support@stoplight.io>",

diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.cjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.cjs
@@ -1,7 +1,7 @@
 module.exports = {
   aliases: {
-    PathItem: '$.paths[*][*]',
-    Description: '$..description',
-    Name: '$..name',
+    PathItem: ['$.paths[*][*]'],
+    Description: ['$..description'],
+    Name: ['$..name'],
   },
 };
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.mjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.mjs
@@ -1,7 +1,7 @@
 export default {
   aliases: {
-    PathItem: '$.paths[*][*]',
-    Description: '$..description',
-    Name: '$..name',
+    PathItem: ['$.paths[*][*]'],
+    Description: ['$..description'],
+    Name: ['$..name'],
   },
 };
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/ruleset.yaml b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/ruleset.yaml
@@ -1,4 +1,7 @@
 aliases:
-  PathItem: $.paths[*][*]
-  Description: $..description
-  Name: $..name
+  PathItem:
+    - $.paths[*][*]
+  Description:
+    - $..description
+  Name:
+    - $..name
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.cjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.cjs
@@ -6,11 +6,11 @@ module.exports = {
       targets: [
         {
           formats: [oas2],
-          given: '$.definitions[*]',
+          given: ['$.definitions[*]'],
         },
         {
           formats: [oas3_0, oas3_1],
-          given: '$.components.schemas[*]',
+          given: ['$.components.schemas[*]'],
         },
       ],
     },

diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.mjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.mjs
@@ -6,11 +6,11 @@ export default {
       targets: [
         {
           formats: [oas2],
-          given: '$.definitions[*]',
+          given: ['$.definitions[*]'],
         },
         {
           formats: [oas3_0, oas3_1],
-          given: '$.components.schemas[*]',
+          given: ['$.components.schemas[*]'],
         },
       ],
     },

diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/ruleset.yaml b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/ruleset.yaml
@@ -4,8 +4,10 @@ aliases:
     targets:
       - formats:
           - oas2
-        given: $.definitions[*]
+        given:
+          - $.definitions[*]
       - formats:
           - oas3.0
           - oas3.1
-        given: $.components.schemas[*]
+        given:
+          - $.components.schemas[*]
diff --git a/packages/ruleset-migrator/src/validation/schema.ts b/packages/ruleset-migrator/src/validation/schema.ts
@@ -9,7 +9,10 @@ const schema = {
       additionalProperties: {
         oneOf: [
           {
-            type: 'string',
+            type: 'array',
+            items: {
+              type: 'string',
+            },
           },
           {
             type: 'object',
@@ -27,7 +30,10 @@ const schema = {
                       $ref: '#/properties/formats',
                     },
                     given: {
-                      type: 'string',
+                      type: 'array',
+                      items: {
+                        type: 'string',
+                      },
                     },
                   },
                   required: ['formats', 'given'],

diff --git a/packages/ruleset-migrator/src/validation/types.ts b/packages/ruleset-migrator/src/validation/types.ts
@@ -3,7 +3,7 @@
 export interface Ruleset {
   aliases?: {
     [k: string]:
-      | string
+      | string[]
       | {
           description?: string;
           targets: [
@@ -42,7 +42,7 @@ export interface Ruleset {
                   | 'json-schema-2020-12'
                 )[]
               ];
-              given: string;
+              given: string[];
               [k: string]: unknown;
             },
             ...{
@@ -80,7 +80,7 @@ export interface Ruleset {
                   | 'json-schema-2020-12'
                 )[]
               ];
-              given: string;
+              given: string[];
               [k: string]: unknown;
             }[]
           ];

diff --git a/packages/rulesets/CHANGELOG.md b/packages/rulesets/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@stoplight/spectral-rulesets-v1.7.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-rulesets-v1.6.0...@stoplight/spectral-rulesets-v1.7.0) (2022-03-24)
+
+
+### Features
+
+* **rulesets:** add unused components server rule ([#2097](https://github.com/stoplightio/spectral/issues/2097)) ([71b312e](https://github.com/stoplightio/spectral/commit/71b312e34c85d8b4255832757b4b5afa8c5062a5))
+
 # [@stoplight/spectral-rulesets-v1.6.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-rulesets-v1.5.2...@stoplight/spectral-rulesets-v1.6.0) (2022-03-03)
 
 

diff --git a/packages/rulesets/package.json b/packages/rulesets/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/spectral-rulesets",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "homepage": "https://github.com/stoplightio/spectral",
   "bugs": "https://github.com/stoplightio/spectral/issues",
   "author": "Stoplight <support@stoplight.io>",

diff --git a/packages/rulesets/src/asyncapi/__tests__/asyncapi-unused-components-server.test.ts b/packages/rulesets/src/asyncapi/__tests__/asyncapi-unused-components-server.test.ts
@@ -0,0 +1,40 @@
+import { DiagnosticSeverity } from '@stoplight/types';
+import produce from 'immer';
+import testRule from './__helpers__/tester';
+
+const document = {
+  asyncapi: '2.0.0',
+  servers: {
+    test: {
+      $ref: '#/components/servers/externallyDefinedServer',
+    },
+  },
+  channels: {},
+  components: {
+    servers: {
+      externallyDefinedServer: {},
+    },
+  },
+};
+
+testRule('asyncapi-unused-components-server', [
+  {
+    name: 'valid case',
+    document,
+    errors: [],
+  },
+
+  {
+    name: 'components.servers contains unreferenced objects',
+    document: produce(document, (draft: any) => {
+      delete draft.servers['test'];
+    }),
+    errors: [
+      {
+        message: 'Potentially unused components server has been detected.',
+        path: ['components', 'servers', 'externallyDefinedServer'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+]);
diff --git a/packages/rulesets/src/asyncapi/index.ts b/packages/rulesets/src/asyncapi/index.ts
@@ -381,5 +381,18 @@ export default {
         },
       },
     },
+    'asyncapi-unused-components-server': {
+      description: 'Potentially unused components server has been detected.',
+      recommended: true,
+      type: 'style',
+      resolved: false,
+      given: '$.components.servers',
+      then: {
+        function: unreferencedReusableObject,
+        functionOptions: {
+          reusableObjectsLocation: '#/components/servers',
+        },
+      },
+    },
   },
 };
diff --git a/yarn.lock b/yarn.lock
@@ -2403,7 +2403,7 @@ __metadata:
     lodash: ~4.17.21
     lodash.topath: ^4.5.2
     minimatch: 3.0.4
-    nimma: 0.1.8
+    nimma: 0.2.0
     nock: ^13.1.0
     pony-cause: ^1.0.0
     simple-eval: 1.0.0
@@ -9337,9 +9337,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"nimma@npm:0.1.8":
-  version: 0.1.8
-  resolution: "nimma@npm:0.1.8"
+"nimma@npm:0.2.0":
+  version: 0.2.0
+  resolution: "nimma@npm:0.2.0"
   dependencies:
     "@jsep-plugin/regex": ^1.0.1
     "@jsep-plugin/ternary": ^1.0.2
@@ -9352,7 +9352,7 @@ __metadata:
       optional: true
     lodash.topath:
       optional: true
-  checksum: 0e2f832b20f7c4cc4497c82fef1bd1fee6512db5251eb59223445f9ea7749c3baa981389ef5008b46efd0aa4e11472b62e81118b5933aeafd6f234d87dd49df7
+  checksum: ed404ab3aca227a51e924e2b8d7d9ae75695c6c3fbdbaffee9990b42b5491f3c240ef3cdbbaffd1b9c3564bf062c936cb8b921de6b21ce8aa22733a00597fd2d
   languageName: node
   linkType: hard