fix(generator): fix a bug where generated validator names collided

Author: maxdev1

src/generator/validator-artifacts.ts

@@ -37,9 +37,17 @@ type ParameterSchemaGroup = {
  * collisions from overwriting earlier validators in the generated module.
  */
 export function createUniqueName(candidate: string, seen: Map<string, number>): string {
-  const count = seen.get(candidate) ?? 0
+  let count = seen.get(candidate) ?? 0
+  let uniqueName = count === 0 ? candidate : `${candidate}${count + 1}`
+
+  while (seen.has(uniqueName)) {
+    count += 1
+    uniqueName = `${candidate}${count + 1}`
+  }
+
   seen.set(candidate, count + 1)
-  return count === 0 ? candidate : `${candidate}${count + 1}`
+  seen.set(uniqueName, 1)
+  return uniqueName
 }
 
 /**
@@ -344,6 +352,9 @@ function registerRequestSchemasAndCollectValidators(spec: OpenAPIV3.Document): V
   const componentSchemas = ensureComponentsSchemas(spec)
   const validators: ValidatorExports = {}
   const seenOperationNames = new Map<string, number>()
+  const seenSchemaNames = new Map<string, number>(
+    Object.keys(componentSchemas).map((schemaName) => [schemaName, 1]),
+  )
 
   for (const [pathKey, rawPathItem] of Object.entries(spec.paths ?? {})) {
     const pathItem = resolvePathItem(
@@ -367,7 +378,7 @@ function registerRequestSchemasAndCollectValidators(spec: OpenAPIV3.Document): V
         continue
       }
 
-      const schemaName = `${baseName}Request`
+      const schemaName = createUniqueName(`${baseName}Request`, seenSchemaNames)
       componentSchemas[schemaName] = requestSchema
       validators[`validate${baseName}Request`] = `Spec#/components/schemas/${schemaName}`
     }

test/fixtures/schema-name-collision-api.yaml

@@ -0,0 +1,30 @@
+openapi: 3.0.3
+info:
+  title: Schema Name Collision API
+  version: 1.0.0
+paths:
+  /items:
+    post:
+      operationId: createItem
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateItemRequest"
+      responses:
+        "201":
+          description: Created
+components:
+  schemas:
+    CreateItemRequest:
+      type: object
+      properties:
+        code:
+          type: string
+        value:
+          type: integer
+      required:
+        - code
+        - value
+      additionalProperties: false

test/schema-name-collision.test.ts

@@ -0,0 +1,29 @@
+import {loadGeneratedValidators} from "./helpers/load-generated-validator"
+import {validateApiGatewayEvent} from "../src"
+
+describe("generated request schema name collisions", () => {
+  let cleanup: () => void = () => {
+  }
+  let validateCreateItemREquest: (value: unknown) => boolean
+
+  beforeAll(async () => {
+    const loaded = await loadGeneratedValidators({fixtureName: "schema-name-collision-api.yaml"})
+    cleanup = loaded.cleanup
+    validateCreateItemREquest = loaded.getValidator("validateCreateItemRequest")
+  })
+
+  afterAll(() => {
+    cleanup()
+  })
+
+  test("keeps component request body schemas distinct from synthesized request wrapper schemas", () => {
+    expect(() =>
+      validateApiGatewayEvent(validateCreateItemREquest, {
+        body: JSON.stringify({
+          code: "example",
+          value: 25
+        }),
+      }),
+    ).not.toThrow()
+  })
+})