feat: upgrade to ajv v8 (#132)

* feat: upgrade to ajv v8 * fix: tests and linting * feat: remove deprecated method * chore: linting
atlassian · Aug 30, 2023 · b90c88c · b90c88c
1 parent af9de89
commit b90c88c
Show file tree

Hide file tree

Showing 21 changed files with 644 additions and 2,563 deletions.
diff --git a/.changeset/shiny-swans-suffer.md b/.changeset/shiny-swans-suffer.md
@@ -0,0 +1,9 @@
+---
+'oas3-chow-chow': major
+---
+
+Upgrade ajv to version 8.
+
+The main BREAKING CHANGE is that the support for JSON-Schema draft-04 is removed from version 8.
+Some properties of Ajv.Options has also changed its shape.
+More details: https://ajv.js.org/v6-to-v8-migration.html
diff --git a/__test__/__snapshots__/pet-store.spec.ts.snap b/__test__/__snapshots__/pet-store.spec.ts.snap
@@ -1,13 +1,13 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Pet Store RequestBody It returns defined body content type 1`] = `
-Array [
+[
   "application/json",
 ]
 `;
 
-exports[`Pet Store RequestBody It returns empty array for defined body content type if method is undefined 1`] = `Array []`;
+exports[`Pet Store RequestBody It returns empty array for defined body content type if method is undefined 1`] = `[]`;
 
-exports[`Pet Store RequestBody It returns empty array for defined body content type if path is undefined 1`] = `Array []`;
+exports[`Pet Store RequestBody It returns empty array for defined body content type if path is undefined 1`] = `[]`;
 
-exports[`Pet Store RequestBody It returns empty array for defined body content type if requestBody is not defined 1`] = `Array []`;
+exports[`Pet Store RequestBody It returns empty array for defined body content type if requestBody is not defined 1`] = `[]`;
diff --git a/__test__/chow-error.spec.ts b/__test__/chow-error.spec.ts
@@ -4,28 +4,28 @@ describe('ChowError', () => {
   it('should be able to initialize a ChowError', () => {
     const chowError = new ChowError('An error', { in: 'test' });
     expect(chowError.toJSON()).toMatchInlineSnapshot(`
-Object {
-  "code": 400,
-  "location": Object {
-    "in": "test",
-  },
-  "message": "An error",
-  "suggestions": Array [],
-}
-`);
+      {
+        "code": 400,
+        "location": {
+          "in": "test",
+        },
+        "message": "An error",
+        "suggestions": [],
+      }
+    `);
   });
 
   it('should be able to output JSON format of the error', () => {
     const chowError = new ChowError('An error', { in: 'test' });
     expect(chowError.toJSON()).toMatchInlineSnapshot(`
-Object {
-  "code": 400,
-  "location": Object {
-    "in": "test",
-  },
-  "message": "An error",
-  "suggestions": Array [],
-}
-`);
+      {
+        "code": 400,
+        "location": {
+          "in": "test",
+        },
+        "message": "An error",
+        "suggestions": [],
+      }
+    `);
   });
 });
diff --git a/__test__/fixtures/option-unknown-fmt.json b/__test__/fixtures/option-unknown-fmt.json
@@ -47,6 +47,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": ["id", "name"],
         "properties": {
           "id": {

diff --git a/__test__/fixtures/parameter-in-both-operation-and-path-level.json b/__test__/fixtures/parameter-in-both-operation-and-path-level.json
@@ -70,6 +70,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": [
           "id",
           "name"
@@ -94,6 +95,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": [
           "code",
           "message"

diff --git a/__test__/fixtures/parameter-in-path-level.json b/__test__/fixtures/parameter-in-path-level.json
@@ -59,6 +59,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": [
           "id",
           "name"
@@ -83,6 +84,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": [
           "code",
           "message"

diff --git a/__test__/fixtures/path.json b/__test__/fixtures/path.json
@@ -102,6 +102,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": [
           "id",
           "name"
@@ -126,6 +127,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": [
           "code",
           "message"

diff --git a/__test__/fixtures/pet-store.json b/__test__/fixtures/pet-store.json
@@ -436,6 +436,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": [
           "id",
           "name"
@@ -476,6 +477,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": [
           "code",
           "message"

diff --git a/__test__/fixtures/query.json b/__test__/fixtures/query.json
@@ -72,6 +72,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": [
           "id",
           "name"
@@ -96,6 +97,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": [
           "code",
           "message"

diff --git a/__test__/fixtures/response.json b/__test__/fixtures/response.json
@@ -127,6 +127,7 @@
   "components": {
     "schemas": {
       "Pet": {
+        "type": "object",
         "required": ["id", "name"],
         "properties": {
           "id": {
@@ -165,6 +166,7 @@
         }
       },
       "Error": {
+        "type": "object",
         "required": ["code", "message"],
         "properties": {
           "code": {

diff --git a/__test__/option.spec.ts b/__test__/option.spec.ts
@@ -7,7 +7,7 @@ describe('Option Body', () => {
     expect(() => {
       new ChowChow(fixture);
     }).toThrow(
-      'unknown format "pet-name" is used in schema at path "#/properties/name"'
+      'unknown format "pet-name" ignored in schema at path "#/properties/name"'
     );
   });
 
@@ -16,7 +16,11 @@ describe('Option Body', () => {
 
     expect(() => {
       new ChowChow(fixture, {
-        responseBodyAjvOptions: { unknownFormats: 'ignore' },
+        responseBodyAjvOptions: {
+          formats: {
+            'pet-name': true,
+          },
+        },
       });
     }).not.toThrow();
   });

diff --git a/__test__/path.spec.ts b/__test__/path.spec.ts
@@ -13,10 +13,10 @@ describe('Path', () => {
     });
 
     it('should validate the path parameters and coerce to the correct type', () => {
-      const pathMeta = {
-        method: 'get',
-      };
-      expect(chowchow.validateRequest('/pets/123', pathMeta)).toEqual(
+      const pathMeta = {};
+      expect(
+        chowchow.validateRequestByPath('/pets/123', 'get', pathMeta)
+      ).toEqual(
         expect.objectContaining({
           path: {
             petId: 123,
@@ -27,9 +27,7 @@ describe('Path', () => {
 
     it('should throw error if path parameter fails schema check', () => {
       expect(() => {
-        chowchow.validateRequest('/pets/abc', {
-          method: 'get',
-        });
+        chowchow.validateRequestByPath('/pets/abc', 'get', {});
       }).toThrowError(ChowError);
     });
   });
@@ -42,10 +40,10 @@ describe('Path', () => {
     });
 
     it('should validate the path parameters and coerce to the correct type', () => {
-      const pathMeta = {
-        method: 'get',
-      };
-      expect(chowchow.validateRequest('/pets/123', pathMeta)).toEqual(
+      const pathMeta = {};
+      expect(
+        chowchow.validateRequestByPath('/pets/123', 'get', pathMeta)
+      ).toEqual(
         expect.objectContaining({
           path: {
             petId: 123,
@@ -56,9 +54,7 @@ describe('Path', () => {
 
     it('should throw error if path parameter fails schema check', () => {
       expect(() => {
-        chowchow.validateRequest('/pets/abc', {
-          method: 'get',
-        });
+        chowchow.validateRequestByPath('/pets/abc', 'get', {});
       }).toThrowError(ChowError);
     });
   });
@@ -71,10 +67,10 @@ describe('Path', () => {
     });
 
     it('should validate the path parameters and coerce to the correct type', () => {
-      const pathMeta = {
-        method: 'get',
-      };
-      expect(chowchow.validateRequest('/pets/123', pathMeta)).toEqual(
+      const pathMeta = {};
+      expect(
+        chowchow.validateRequestByPath('/pets/123', 'get', pathMeta)
+      ).toEqual(
         expect.objectContaining({
           path: {
             petId: 123,
@@ -85,9 +81,7 @@ describe('Path', () => {
 
     it('should throw error if path parameter fails schema check', () => {
       expect(() => {
-        chowchow.validateRequest('/pets/abc', {
-          method: 'get',
-        });
+        chowchow.validateRequestByPath('/pets/abc', 'get', {});
       }).toThrowError(ChowError);
     });
   });