feat: create rule asyncapi3-channel-no-query-nor-fragment for v3 co…

…re ruleset (#1051)
asyncapi · Sep 10, 2024 · bebbd39 · bebbd39
1 parent 0d33904
commit bebbd39
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 14 deletions.
diff --git a/.changeset/strong-garlics-think.md b/.changeset/strong-garlics-think.md
@@ -0,0 +1,5 @@
+---
+"@asyncapi/parser": minor
+---
+
+feat: create rule `asyncapi3-channel-no-query-nor-fragment` for v3 core ruleset
diff --git a/packages/parser/src/ruleset/v2/ruleset.ts b/packages/parser/src/ruleset/v2/ruleset.ts
@@ -49,19 +49,6 @@ export const v2CoreRuleset = {
         function: serverVariables,
       },
     },
-    'asyncapi2-channel-no-query-nor-fragment': {
-      description: 'Channel address should not include query ("?") or fragment ("#") delimiter.',
-      severity: 'error',
-      recommended: true,
-      given: '$.channels',
-      then: {
-        field: '@key',
-        function: pattern,
-        functionOptions: {
-          notMatch: '[\\?#]',
-        },
-      },
-    },
 
     /**
      * Channel Object rules
@@ -86,6 +73,19 @@ export const v2CoreRuleset = {
         function: channelServers,
       },
     },
+    'asyncapi2-channel-no-query-nor-fragment': {
+      description: 'Channel address should not include query ("?") or fragment ("#") delimiter.',
+      severity: 'error',
+      recommended: true,
+      given: '$.channels',
+      then: {
+        field: '@key',
+        function: pattern,
+        functionOptions: {
+          notMatch: '[\\?#]',
+        },
+      },
+    },
 
     /**
      * Operation Object rules

diff --git a/packages/parser/src/ruleset/v3/ruleset.ts b/packages/parser/src/ruleset/v3/ruleset.ts
@@ -56,6 +56,19 @@ export const v3CoreRuleset = {
           match: '#\\/servers\\/', // If doesn't match, rule fails.
         },
       },
-    }
+    },
+    'asyncapi3-channel-no-query-nor-fragment': {
+      description: 'Channel address should not include query ("?") or fragment ("#") delimiter.',
+      severity: 'error',
+      recommended: true,
+      given: '$.channels',
+      then: {
+        field: '@key',
+        function: pattern,
+        functionOptions: {
+          notMatch: '[\\?#]',
+        },
+      },
+    },
   },
 };
diff --git a/packages/parser/test/ruleset/rules/v3/asyncapi3-channel-no-query-nor-fragment.spec.ts b/packages/parser/test/ruleset/rules/v3/asyncapi3-channel-no-query-nor-fragment.spec.ts
@@ -0,0 +1,50 @@
+import { testRule, DiagnosticSeverity } from '../../tester';
+
+testRule('asyncapi3-channel-no-query-nor-fragment', [
+  {
+    name: 'valid case',
+    document: {
+      asyncapi: '3.0.0',
+      channels: {
+        'users/{userId}/signedUp': {},
+      },
+    },
+    errors: [],
+  },
+
+  {
+    name: 'channels.{channel} contains a query delimiter',
+    document: {
+      asyncapi: '3.0.0',
+      channels: {
+        'users/{userId}/signedUp': {},
+        'users/{userId}/signedOut?byMistake={didFatFingerTheSignOutButton}': {},
+      },
+    },
+    errors: [
+      {
+        message: 'Channel address should not include query ("?") or fragment ("#") delimiter.',
+        path: ['channels', 'users/{userId}/signedOut?byMistake={didFatFingerTheSignOutButton}'],
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+
+  {
+    name: 'channels.{channel} contains a fragment delimiter',
+    document: {
+      asyncapi: '3.0.0',
+      channels: {
+        'users/{userId}/signedUp': {},
+        'users/{userId}/signedOut#onPurpose': {},
+      },
+    },
+    errors: [
+      {
+        message: 'Channel address should not include query ("?") or fragment ("#") delimiter.',
+        path: ['channels', 'users/{userId}/signedOut#onPurpose'],
+        severity: DiagnosticSeverity.Error,
+      },
+    ],
+  },
+]);