fix: misc bug fixes

Author: restfulhead

packages/ajv-openapi-request-response-validator/src/ajv-openapi-request-response-validator.ts

@@ -63,11 +63,20 @@ function mapValidatorErrors(validatorErrors: ErrorObject[] | null | undefined, s
         title: ajvErr.message ?? ET_VALIDATION,
       }
 
-      if (ajvErr.schemaPath) {
-        mappedErr.source = {
-          pointer: ajvErr.schemaPath,
+      if (ajvErr.schemaPath || ajvErr.params) {
+        mappedErr.source = {}
+
+        if (ajvErr.schemaPath) {
+          mappedErr.source.pointer = ajvErr.schemaPath
+        }
+        if (ajvErr.params) {
+          const filteredParams = Object.entries(ajvErr.params).filter(([key]) => key === 'additionalProperty' || key === 'missingProperty')
+          if (filteredParams.length > 0) {
+            mappedErr.source.parameter = Object.values(ajvErr.params).join(', ')
+          }
         }
       }
+
       mapped.push(mappedErr)
     })
     return mapped

packages/ajv-openapi-request-response-validator/src/openapi-validator.ts

@@ -143,7 +143,7 @@ export function unserializeParameters(parameters: Record<string, Primitive>): Re
       const lastKeyIndex = splitKey.length - 1
 
       splitKey.forEach((part, index) => {
-        const cleanPart = part.replace(']', '')
+        const cleanPart = part.replace(/]/g, '') // part.replace(']', '')
 
         if (index === lastKeyIndex) {
           target[cleanPart] = value
@@ -156,6 +156,7 @@ export function unserializeParameters(parameters: Record<string, Primitive>): Re
       })
     }
   }
+
   return result
 }
 

packages/ajv-openapi-request-response-validator/test/.eslintrc.js

@@ -7,6 +7,9 @@ module.exports = {
     },
     extends: ["../.eslintrc.js"],
     rules: {
+      "@typescript-eslint/no-magic-numbers": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-console": "off",
       "@typescript-eslint/naming-convention": "off",
       "@typescript-eslint/no-non-null-assertion": "off",
     }

packages/ajv-openapi-request-response-validator/test/fixtures/example-api.yaml

@@ -76,6 +76,16 @@ paths:
               schema:
                 $ref: '#/components/schemas/OneOfExample'
 
+  '/one-of-example-list':
+    get:
+      responses:
+        '200':
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OneOfExampleList'
+
   '/all-of-example':
     post:
       requestBody:
@@ -126,7 +136,8 @@ paths:
             schema:
               type: object
               additionalProperties: true
-  /users/{uid}/state/{sid}:
+
+  '/users/{uid}/state/{sid}':
     put:
       operationId: put-user-state
       summary: Upserts a user state
@@ -151,6 +162,47 @@ paths:
       responses:
         '200':
           description: OK
+    patch:
+      operationId: patch-user-state
+      summary: Patch a user state
+      parameters:
+        - name: uid
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: sid
+          in: path
+          description: The state id or key
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/PatchUserStateValue'
+
+  /webhooks/mytest/{provision}:
+    post:
+      parameters:
+        - name: provision
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MyTestProvisionResponse'
+        required: true
+      responses:
+        '200':
+          description: OK
+
 components:
   responses:
     ResponseError:
@@ -347,6 +399,14 @@ components:
       discriminator:
         propertyName: objType
 
+    OneOfExampleList:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/OneOfExample'
+
     AllOfExample:
       type: object
       description: Example using allOf
@@ -358,11 +418,13 @@ components:
             status:
               type: string
               enum: [pending, approved, rejected]
+              
     UserStateValue:
       type: "object"
       oneOf:
         - $ref: '#/components/schemas/UserStateCoffeeCx'
         - $ref: '#/components/schemas/UserUploads'
+        - $ref: '#/components/schemas/UserStateWidgets'
       discriminator:
         propertyName: type
     UserStateCoffeeCx:
@@ -376,7 +438,10 @@ components:
           enum: [coffeeCx]
         enabled:
           type: boolean
-          description: Whether a certain flag, feature, etc. is enabled or not   
+          description: Whether a certain flag, feature, etc. is enabled or not
+        nullableTest:
+          type: string
+          nullable: true
     UserUploads:
       type: object
       required:
@@ -428,4 +493,86 @@ components:
       description: >-
         A valid path that matches any sequence of characters except if it
         contains '../', '//' (to avoid directory traversal attacks)
-      maxLength: 255
+      maxLength: 255
+    UserStateWidgets:
+      type: object
+      required:
+        - type
+        - widgets
+      properties:
+        type:
+          type: string
+          enum:
+            - widgets
+        widgets:
+          type: array
+          items:
+            type: string
+          oneOf:
+            - minItems: 4
+              maxItems: 4
+            - minItems: 3
+              maxItems: 3
+            - minItems: 2
+              maxItems: 2
+    AnyValue:
+      description: Accepts any valid JSON value
+      additionalProperties: true
+      oneOf:
+        - type: string
+        - type: number
+        - type: integer
+        - type: boolean
+        - type: array
+          items:
+            $ref: '#/components/schemas/AnyValue'
+        - type: object
+          additionalProperties: true
+    PatchUserStateValue:
+      type: object
+      required:
+        - op
+        - path
+        - value
+      properties:
+        op:
+          type: string
+          enum:
+            - replace
+            - add
+            - remove
+        path:
+          type: string
+        value:
+          $ref: '#/components/schemas/AnyValue'
+    MyTestProvisionResponse:
+      type: object
+      required:
+        - taskId
+      properties:
+        taskId:
+          type: string
+        stateBag:
+          type: object
+          required:
+            - contentEntryId
+          properties:
+            contentEntryId:
+              type: string
+            guestUserUid:
+              type: string
+        siteInfo:
+          type: object
+          required:
+            - url
+          properties:
+            url:
+              type: string
+            teamId:
+              type: string
+            groupId:
+              type: string
+        errorMessage:
+          description: Reason why the job failed.
+          type: string
+    

packages/ajv-openapi-request-response-validator/test/fixtures/fail-requestBody-allof-with-schema.js.txt

@@ -109,6 +109,7 @@ module.exports = {
     {
       "code": "Validation-additionalProperties",
       "source": {
+        "parameter": "bark",
         "pointer": "#/components/schemas/Cat/additionalProperties",
       },
       "status": 400,

packages/ajv-openapi-request-response-validator/test/fixtures/fail-requestBody-anyof-with-schema.js.txt

@@ -76,6 +76,7 @@ module.exports = {
       {
          "code": "Validation-required",
          "source": {
+           "parameter": "age",
            "pointer": "#/components/schemas/PetByAge/required",
          },
          "status": 400,
@@ -84,6 +85,7 @@ module.exports = {
        {
          "code": "Validation-required",
          "source": {
+           "parameter": "pet_type",
            "pointer": "#/components/schemas/PetByType/required",
          },
          "status": 400,

packages/ajv-openapi-request-response-validator/test/fixtures/fail-requestBody-oneof-with-schema.js.txt

@@ -66,6 +66,6 @@ module.exports = {
     },
   },
   expectedErrors: [
-    {"code": "Validation-additionalProperties", "source": {"pointer": "#/components/schemas/Cat/additionalProperties"}, "status": 400, "title": "must NOT have additional properties"}, {"code": "Validation-additionalProperties", "source": {"pointer": "#/components/schemas/Dog/additionalProperties"}, "status": 400, "title": "must NOT have additional properties"}, {"code": "Validation-oneOf", "source": {"pointer": "#/oneOf"}, "status": 400, "title": "must match exactly one schema in oneOf"}
+    {"code": "Validation-additionalProperties", "source": {"pointer": "#/components/schemas/Cat/additionalProperties", "parameter": "breed",}, "status": 400, "title": "must NOT have additional properties"}, {"code": "Validation-additionalProperties", "source": {"pointer": "#/components/schemas/Dog/additionalProperties", "parameter": "age"}, "status": 400, "title": "must NOT have additional properties"}, {"code": "Validation-oneOf", "source": {"pointer": "#/oneOf"}, "status": 400, "title": "must match exactly one schema in oneOf"}
   ]
 };

packages/ajv-openapi-request-response-validator/test/fixtures/fail-requestBody-with-components-default.js.txt

@@ -31,7 +31,8 @@ module.exports = {
   expectedErrors: [
         { 
             code: 'Validation-additionalProperties', 
-            source: { 
+            source: {
+                "parameter": "something-else",
                 pointer: '#/components/schemas/Test1/additionalProperties'
             }, 
             status: 400, 

packages/ajv-openapi-request-response-validator/test/fixtures/fail-requestBody-with-components-ref.js.txt

@@ -28,7 +28,8 @@ module.exports = {
     expectedErrors: [
         { 
             code: 'Validation-required', 
-            source: { 
+            source: {
+                "parameter": "foo",
                 pointer: '#/components/schemas/Test1/required'
             }, 
             status: 400, 

packages/ajv-openapi-request-response-validator/test/unit/ajv-validator-api.spec.ts

@@ -1,6 +1,5 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import * as fs from 'fs'
-import * as path from 'path'
+import * as nodepath from 'path'
 import { OpenAPIV3 } from 'openapi-types'
 import copy from 'fast-copy'
 import { createAjvInstance } from '../../src/ajv-factory'
@@ -64,8 +63,8 @@ const files = fs.readdirSync(fixtureDir)
 const testCases: { [key: string]: TestFixture } = {}
 for (const file of files) {
   if (file.endsWith('.js.txt')) {
-    const testName = path.basename(file, '.js.txt').replace(/-/g, ' ')
-    const fixtureContent = fs.readFileSync(path.resolve(fixtureDir, file), { encoding: 'utf-8' })
+    const testName = nodepath.basename(file, '.js.txt').replace(/-/g, ' ')
+    const fixtureContent = fs.readFileSync(nodepath.resolve(fixtureDir, file), { encoding: 'utf-8' })
     try {
       // eslint-disable-next-line no-eval
       const fixture: TestFixture = eval(fixtureContent)
@@ -116,14 +115,14 @@ describe('The api validator', () => {
 
     if (fixture.validateArgs.paths) {
       const params = fixture.request.query ? fixture.request.query : {}
-      for (const [methodPath, method] of Object.entries(fixture.validateArgs.paths)) {
+      for (const [path, method] of Object.entries(fixture.validateArgs.paths)) {
         if (method) {
           for (const [methodName, methodDef] of Object.entries(method)) {
             if (Object.values(OpenAPIV3.HttpMethods).includes(methodName as OpenAPIV3.HttpMethods)) {
               const operation: OpenAPIV3.OperationObject<object> = methodDef
               if (operation.parameters) {
                 const result = validator.validateQueryParams(
-                  methodPath,
+                  path,
                   methodName,
                   params,
                   fixture.requestOpts?.strictQueryParamValidation ?? true
@@ -136,7 +135,7 @@ describe('The api validator', () => {
               }
               if (operation.requestBody && fixture.request.body) {
                 const result = validator.validateRequestBody(
-                  methodPath,
+                  path,
                   methodName,
                   fixture.request.body,
                   fixture.requestOpts?.strictRequestBodyValidation ?? true