fix: enforce group prefix validation

Author: b41ex

src/strategies/prefix-groups-changelog.strategy.ts

@@ -22,6 +22,10 @@ export class PrefixGroupsChangelogStrategy implements BuilderStrategy {
     const { packageId, version } = config
     const { compareContext } = contexts
 
+    // Validate groups
+    this.validateGroup(config.currentGroup, 'currentGroup')
+    this.validateGroup(config.previousGroup, 'previousGroup')
+
     buildResult.comparisons = await compareVersions(
       [version, packageId],
       [version, packageId],
@@ -30,4 +34,18 @@ export class PrefixGroupsChangelogStrategy implements BuilderStrategy {
 
     return buildResult
   }
+
+  private validateGroup(group: unknown, paramName: string): void {
+    if (group === undefined) {
+      return
+    }
+
+    if (typeof group !== 'string') {
+      throw new Error(`${paramName} must be a string, received: ${typeof group}`)
+    }
+
+    if (group.length < 3 || !group.startsWith('/') || !group.endsWith('/')) {
+      throw new Error(`${paramName} must begin and end with a "/" character and contain at least one meaningful character, received: "${group}"`)
+    }
+  }
 }

test/helpers/utils.ts

@@ -163,8 +163,8 @@ export async function buildPrefixGroupChangelogPackage(options: {
     packageId,
     config: {
       files = [{ fileId: 'spec.yaml' }],
-      currentGroup = '/api/v2',
-      previousGroup = 'api/v1',
+      currentGroup = '/api/v2/',
+      previousGroup = '/api/v1/',
     } = {},
   } = options ?? {}
 

test/prefix-groups.test.ts

@@ -263,8 +263,8 @@ describe('Prefix Groups test', () => {
     const result = await buildPrefixGroupChangelogPackage({
       packageId: 'prefix-groups/different-prefix-length',
       config: {
-        previousGroup: '/api/v10',
-        currentGroup: 'api/v1000/',
+        previousGroup: '/api/v10/',
+        currentGroup: '/api/v1000/',
       },
     })
 
@@ -280,5 +280,37 @@ describe('Prefix Groups test', () => {
     ]))
   })
 
+  describe('Validation of incorrect group prefixes', () => {
+    test('should throw error for invalid currentGroup - missing ending slash', async () => {
+      await expect(buildPrefixGroupChangelogPackage({
+        packageId: 'prefix-groups/different-prefix-length',
+        config: {
+          previousGroup: '/api/v10/',
+          currentGroup: '/api/v1000',
+        },
+      })).rejects.toThrow('currentGroup must begin and end with a "/" character and contain at least one meaningful character, received: "/api/v1000"')
+    })
+
+    test('should throw error for invalid previousGroup - missing starting slash', async () => {
+      await expect(buildPrefixGroupChangelogPackage({
+        packageId: 'prefix-groups/different-prefix-length',
+        config: {
+          previousGroup: 'api/v10/',
+          currentGroup: '/api/v1000/',
+        },
+      })).rejects.toThrow('previousGroup must begin and end with a "/" character and contain at least one meaningful character, received: "api/v10/"')
+    })
+
+    test('should throw error for group that is too short', async () => {
+      await expect(buildPrefixGroupChangelogPackage({
+        packageId: 'prefix-groups/different-prefix-length',
+        config: {
+          previousGroup: '//',
+          currentGroup: '/api/v1000/',
+        },
+      })).rejects.toThrow('previousGroup must begin and end with a "/" character and contain at least one meaningful character, received: "//"')
+    })
+  })
+
   // todo add case when api/v1 in servers and api/v2 in some paths?
 })