test: refactor tests and use new matchers

supergoodsystems · Dec 12, 2023 · cb20877 · cb20877
1 parent 0a883a2
commit cb20877
Show file tree

Hide file tree

Showing 9 changed files with 1,019 additions and 1,040 deletions.
diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "test:e2e": "node ./test/mock-server & jest -c test/jest.e2e.config.js",
     "posttest:e2e": "kill -9 $(lsof -t -i:3001)",
     "clean": "rm -rf dist/ && rm -rf supergood-*.log",
-    "build": "yarn run clean && tsc"
+    "build": "yarn run clean && tsc -p ./tsconfig.lib.json"
   },
   "dependencies": {
     "headers-polyfill": "^4.0.2",
@@ -64,6 +64,7 @@
     "eslint-plugin-jest": "^27.1.3",
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.2.1",
+    "jest-extended": "^4.0.2",
     "json-server": "^0.17.0",
     "openai": "^4.10.0",
     "postgres": "^3.3.4",

diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,5 @@
 import NodeCache from 'node-cache';
+import { serialize } from 'v8';
 import {
   getHeaderOptions,
   logger,
@@ -138,7 +139,7 @@ const Supergood = () => {
               config: supergoodConfig,
               metadata: {
                 requestUrl: request.url.toString(),
-                payloadSize: new Blob([request as any]).size,
+                payloadSize: serialize(request).length,
                 ...supergoodMetadata
               }
             },
@@ -183,9 +184,7 @@ const Supergood = () => {
               metadata: {
                 ...supergoodMetadata,
                 requestUrl: requestData.url,
-                payloadSize: responseData
-                  ? new Blob([responseData as BlobPart]).size
-                  : 0
+                payloadSize: responseData ? serialize(responseData).length : 0
               }
             },
             e as Error
@@ -275,7 +274,7 @@ const Supergood = () => {
             config: supergoodConfig,
             metadata: {
               numberOfEvents: data.length,
-              payloadSize: new Blob([(data || {}) as any]).size,
+              payloadSize: serialize(data).length,
               requestUrls: data.map((event) => event?.request?.url),
               ...supergoodMetadata
             }

diff --git a/test/e2e/core.e2e.test.ts b/test/e2e/core.e2e.test.ts
@@ -38,9 +38,10 @@ describe('core functionality', () => {
         await axios.get(`${MOCK_DATA_SERVER}/posts`);
       }
       await Supergood.close();
+      // checking that all events were posted
       expect(postEventsMock).toHaveBeenCalledWith(
         expect.any(String),
-        Array(numberOfHttpCalls).fill(expect.anything()),
+        expect.toBeArrayOfSize(numberOfHttpCalls),
         expect.any(Object)
       );
       expect(postEventsMock).toHaveBeenCalledWith(
@@ -69,21 +70,32 @@ describe('core functionality', () => {
         },
         SUPERGOOD_SERVER
       );
-      for (let i = 0; i < httpErrorCodes.length; i++) {
+      for (const code of httpErrorCodes) {
         try {
-          await axios.get(`${MOCK_DATA_SERVER}/${httpErrorCodes[i]}`);
+          await axios.get(`${MOCK_DATA_SERVER}/${code}`);
         } catch (e) {
           // ignore
         }
       }
       await Supergood.close();
-      const eventsPosted = getEvents(postEventsMock);
-      expect(eventsPosted.length).toEqual(httpErrorCodes.length);
-      expect(
-        eventsPosted.every((event) =>
-          httpErrorCodes.includes(event.response.status)
-        )
-      ).toBeTruthy();
+
+      // checking that all events were posted
+      expect(postEventsMock).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.toBeArrayOfSize(httpErrorCodes.length),
+        expect.any(Object)
+      );
+      expect(postEventsMock).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.arrayContaining([
+          expect.objectContaining({
+            response: expect.objectContaining({
+              status: expect.toBeOneOf(httpErrorCodes)
+            })
+          })
+        ]),
+        expect.any(Object)
+      );
     });
   });
 
@@ -100,16 +112,29 @@ describe('core functionality', () => {
       axios.get(`${MOCK_DATA_SERVER}/200?sleep=2000`);
       await sleep(1000);
       await Supergood.close();
-      const eventsPosted = getEvents(postEventsMock);
-      const firstEvent = eventsPosted[0];
-      expect(eventsPosted.length).toEqual(1);
-      expect(firstEvent.request.requestedAt).toBeTruthy();
-      expect(firstEvent?.response?.respondedAt).toBeFalsy();
-    });
+
+      // checking that all events were posted
+      expect(postEventsMock).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.toBeArrayOfSize(1),
+        expect.any(Object)
+      );
+      expect(postEventsMock).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.arrayContaining([
+          expect.objectContaining({
+            request: expect.objectContaining({
+              requestedAt: expect.any(Date)
+            })
+          })
+        ]),
+        expect.any(Object)
+      );
+    }, 10000);
 
     // Causes the github actions to hang for some reason
-    test.skip('posting errors', async () => {
-      postEventsMock.mockImplementation(() => {
+    test('posting errors', async () => {
+      postEventsMock.mockImplementationOnce(() => {
         throw new Error();
       });
       await Supergood.init(

diff --git a/test/jest.e2e.config.js b/test/jest.e2e.config.js
@@ -6,7 +6,7 @@ module.exports = {
   clearMocks: true,
   roots: ['<rootDir>/e2e'],
   transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest',
+    '^.+\\.(ts|tsx)$': ['ts-jest', { tsconfig: './test/tsconfig.test.json' }],
     '^.+\\.(js)$': 'babel-jest'
   },
   transformIgnorePatterns: [],

diff --git a/test/setupTests.ts b/test/setupTests.ts
@@ -0,0 +1,3 @@
+// add all jest-extended matchers
+import * as matchers from 'jest-extended';
+expect.extend(matchers);
diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": ["jest", "node"]
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,5 @@
 {
   "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./dist",
     "allowJs": true,
     "removeComments": true,
     "target": "es2016",
@@ -15,7 +13,5 @@
     "moduleResolution": "node",
     "sourceMap": true,
     "allowSyntheticDefaultImports": true
-  },
-  "include": ["./src"],
-  "exclude": ["node_modules", "**/*.test.ts"]
+  }
 }
diff --git a/tsconfig.lib.json b/tsconfig.lib.json
@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./dist"
+  },
+  "include": ["./src"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}