refactor: reuse group prefix validation function

Author: b41ex

src/apitypes/rest/rest.changes.ts

@@ -61,6 +61,7 @@ import {
   extractRootSecurityDiffs,
   extractRootServersDiffs,
   getOperationBasePath,
+  validateGroupPrefix,
 } from './rest.utils'
 import { createOperationChange, getOperationTags, OperationsMap } from '../../components'
 
@@ -277,7 +278,7 @@ export function createCopyWithEmptyPathItems(template: RestOperationData): RestO
   }
 }
 
-export function createCopyWithCurrentGroupOperationsOnly(template: RestOperationData, group: string): RestOperationData {
+  validateGroupPrefix(groupPrefix, 'groupPrefix')
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { paths, servers: rootServers, ...rest } = template
   const groupWithoutEdgeSlashes = trimSlashes(group)
@@ -307,7 +308,7 @@ export function createCopyWithCurrentGroupOperationsOnly(template: RestOperation
             return [fullPath, pathItemWithoutServers] as const
           })
           .filter(([key]) => removeFirstSlash(key as string).startsWith(`${groupWithoutEdgeSlashes}/`)) // note that 'api/v10' is a substring of 'api/v1000'
-          // remove prefix group for correct path mapping in apiDiff
+          // remove group prefix for correct path mapping in apiDiff
           .map(([key, value]) => [removeFirstSlash(key as string).substring(groupWithoutEdgeSlashes.length), value]),
       ),
     },

src/apitypes/rest/rest.utils.ts

@@ -116,3 +116,17 @@ export const extractRootSecurityDiffs = (doc: OpenAPIV3.Document): Diff[] => {
     ...componentsSecuritySchemesDiffs,
   ]
 }
+
+export function validateGroupPrefix(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}"`)
+  }
+}

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

@@ -16,15 +16,16 @@
 
 import { BuildConfig, BuilderStrategy, BuildResult, BuildTypeContexts } from '../types'
 import { compareVersions } from '../components/compare'
+import { validateGroupPrefix } from '../apitypes/rest/rest.utils'
 
 export class PrefixGroupsChangelogStrategy implements BuilderStrategy {
   async execute(config: BuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
     const { packageId, version } = config
     const { compareContext } = contexts
 
     // Validate groups
-    this.validateGroup(config.currentGroup, 'currentGroup')
-    this.validateGroup(config.previousGroup, 'previousGroup')
+    validateGroupPrefix(config.currentGroup, 'currentGroup')
+    validateGroupPrefix(config.previousGroup, 'previousGroup')
 
     buildResult.comparisons = await compareVersions(
       [version, packageId],
@@ -34,18 +35,4 @@ 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}"`)
-    }
-  }
 }