@jaypie/testkit 1.0.25 → 1.0.27

package/README.md

@@ -22,7 +22,7 @@ The testkit provides a complete mock for Jaypie including:
 * Most non-utility functions are mocked to allow simple testing
 
 ```javascript
-vi.mock("jaypie", vi.importActual("@jaypie/testkit"));
+vi.mock("jaypie", async () => vi.importActual("@jaypie/testkit/mock"));
 ```
 
 #### Log Spying
@@ -30,7 +30,7 @@ vi.mock("jaypie", vi.importActual("@jaypie/testkit"));
 ```javascript
 import { log } from "jaypie";
 
-vi.mock("jaypie", vi.importActual("@jaypie/testkit"));
+vi.mock("jaypie", async () => vi.importActual("@jaypie/testkit/mock"));
 
 afterEach(() => {
   vi.clearAllMocks();
@@ -59,6 +59,8 @@ describe("Observability", () => {
     // Act
     await myNewFunction(); // TODO: add any "happy path" parameters
     // Assert
+    expect(log).not.toBeCalledAboveTrace();
+    // or individually:
     expect(log.debug).not.toHaveBeenCalled();
     expect(log.info).not.toHaveBeenCalled();
     expect(log.warn).not.toHaveBeenCalled();
@@ -131,6 +133,7 @@ A [JSON Schema](https://json-schema.org/) validator for the [JSON:API](https://j
 
 ```javascript
 export default {
+  toBeCalledAboveTrace,
   toBeCalledWithInitialParams,
   toBeClass,
   toBeJaypieError,
@@ -164,6 +167,18 @@ expect.extend(extendedMatchers);
 expect.extend(jaypieMatchers);
 ```
 
+#### `expect(subject).toBeCalledAboveTrace()`
+
+```javascript
+import { log } from "@jaypie/core";
+
+log.trace("Hello, World!");
+expect(log).not.toBeCalledAboveTrace();
+
+log.warn("Look out, World!");
+expect(log).toBeCalledAboveTrace();
+```
+
 #### `expect(subject).toBeJaypieError()`
 
 Validates instance objects:
@@ -315,6 +330,7 @@ const event = sqsTestRecords(
 
 | Date       | Version | Summary        |
 | ---------- | ------- | -------------- |
+|  9/13/2024 |  1.0.27 | Matcher `toBeCalledAboveTrace` |
 |  7/16/2024 |  1.0.21 | Export Jaypie mock as default |
 |  3/20/2024 |   1.0.2 | Export `LOG`   |
 |  3/16/2024 |   1.0.0 | Artists ship   |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/testkit",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "author": "Finlayson Studio",
   "type": "module",
   "exports": {
@@ -24,12 +24,14 @@
     "new:test": "hygen jaypie vitest",
     "test": "vitest",
     "test:spec:constants": "vitest run ./src/__tests__/constants.spec.js",
+    "test:spec:expressHandler.mock": "vitest run ./src/__tests__/expressHandler-supertest.mock.spec.js",
     "test:spec:index": "vitest run ./src/__tests__/index.spec.js",
     "test:spec:jaypie.mock": "vitest run ./src/__tests__/jaypie.mock.spec.js",
     "test:spec:jsonApiSchema.module": "vitest run ./src/__tests__/jsonApiSchema.module.spec.js",
     "test:spec:matchers.module": "vitest run ./src/__tests__/matchers.module.spec.js",
     "test:spec:mockLog.module": "vitest run ./src/__tests__/mockLog.module.spec.js",
     "test:spec:sqsTestRecords.function": "vitest run ./src/__tests__/sqsTestRecords.function.spec.js",
+    "test:spec:toBeCalledAboveTrace.matcher": "vitest run ./src/matchers/__tests__/toBeCalledAboveTrace.matcher.spec.js",
     "test:spec:toBeCalledWithInitialParams.matcher": "vitest run ./src/matchers/__tests__/toBeCalledWithInitialParams.matcher.spec.js",
     "test:spec:toBeClass.matcher": "vitest run ./src/matchers/__tests__/toBeClass.matcher.spec.js",
     "test:spec:toBeJaypieError.matcher": "vitest run ./src/matchers/__tests__/toBeJaypieError.matcher.spec.js",
@@ -46,10 +48,12 @@
   "devDependencies": {
     "eslint": "^8.57.0",
     "eslint-config-jaypie": "^1.0.7",
+    "express": "^4.19.2",
     "hygen": "^6.2.11",
     "jest-extended": "^4.0.2",
     "prettier": "^3.2.5",
     "sort-package-json": "^2.8.0",
+    "supertest": "^7.0.0",
     "vitest": "^1.4.0"
   }
 }

package/src/jaypie.mock.js

@@ -6,6 +6,7 @@ import {
   JAYPIE,
   log,
   UnavailableError,
+  UnhandledError,
 } from "@jaypie/core";
 import { beforeAll, vi } from "vitest";
 
@@ -138,6 +139,12 @@ export const submitMetricSet = vi.fn(() => {
 // @jaypie/express
 
 export const expressHandler = vi.fn((handler, props = {}) => {
+  // If handler is an object and options is a function, swap them
+  if (typeof handler === "object" && typeof props === "function") {
+    const temp = handler;
+    handler = props;
+    props = temp;
+  }
   if (typeof handler !== "function") {
     throw new BadRequestError("handler must be a function");
   }
@@ -190,47 +197,65 @@ export const expressHandler = vi.fn((handler, props = {}) => {
   const jaypieFunction = jaypieHandler(handler, props);
   return async (req = {}, res = {}, ...extra) => {
     const status = HTTP.CODE.OK;
-    if (res && typeof res.status === "function") {
-      res.status(200);
+    let response;
+    let supertestMode = false;
+    if (
+      res &&
+      typeof res.socket === "object" &&
+      res.constructor.name === "ServerResponse"
+    ) {
+      // Use the response object in supertest mode
+      supertestMode = true;
     }
-    const response = await jaypieFunction(req, res, ...extra);
-    if (response) {
-      if (typeof response === "object") {
-        if (typeof response.json === "function") {
-          if (res && typeof res.json === "function") {
-            res.json(response.json());
-          }
+    try {
+      response = await jaypieFunction(req, res, ...extra);
+    } catch (error) {
+      // In the mock context, if status is a function we are in a "supertest"
+      if (supertestMode) {
+        // In theory jaypieFunction has handled all errors
+        const errorStatus = error.status || HTTP.CODE.INTERNAL_SERVER_ERROR;
+        let errorResponse;
+        if (typeof error.json === "function") {
+          errorResponse = error.json();
         } else {
-          if (res && typeof res.status === "function") {
+          // This should never happen
+          errorResponse = new UnhandledError().json();
+        }
+        res.status(errorStatus).json(errorResponse);
+        return;
+      } else {
+        // else, res.status is not a function, throw the error
+        throw error;
+      }
+    }
+    if (supertestMode) {
+      if (response) {
+        // res.status(200);
+        if (typeof response === "object") {
+          if (typeof response.json === "function") {
+            res.json(response.json());
+          } else {
             res.status(status).json(response);
           }
-        }
-      } else if (typeof response === "string") {
-        try {
-          if (res && typeof res.status === "function") {
+        } else if (typeof response === "string") {
+          try {
             res.status(status).json(JSON.parse(response));
+          } catch (error) {
+            if (supertestMode) {
+              res.status(status).send(response);
+            }
           }
-        } catch (error) {
-          if (res && typeof res.status === "function") {
-            res.status(status).send(response);
-          }
-        }
-      } else if (response === true) {
-        if (res && typeof res.status === "function") {
+        } else if (response === true) {
           res.status(HTTP.CODE.CREATED).send();
-        }
-      } else {
-        if (res && typeof res.status === "function") {
+        } else {
           res.status(status).send(response);
         }
-      }
-    } else {
-      // No response
-      if (res && typeof res.status === "function") {
+      } else {
         res.status(HTTP.CODE.NO_CONTENT).send();
       }
+    } else {
+      return response;
     }
-    return response;
   };
 });
 

package/src/matchers/toBeCalledAboveTrace.matcher.js

@@ -0,0 +1,47 @@
+//
+//
+// Constants
+//
+
+//
+//
+// Helper Functions
+//
+
+//
+//
+// Main
+//
+
+const calledAboveTrace = (log) => {
+  // TODO: what if log is not an object?
+
+  try {
+    if (
+      log.debug.mock.calls.length > 0 ||
+      log.info.mock.calls.length > 0 ||
+      log.warn.mock.calls.length > 0 ||
+      log.error.mock.calls.length > 0 ||
+      log.fatal.mock.calls.length > 0
+    ) {
+      return {
+        message: () => `expected log not to have been called above trace`,
+        pass: true,
+      };
+    }
+  } catch (error) {
+    throw Error(`[calledAboveTrace] log is not a mock object`);
+  }
+
+  return {
+    message: () => `expected log not to have been called above trace`,
+    pass: false,
+  };
+};
+
+//
+//
+// Export
+//
+
+export default calledAboveTrace;

package/src/matchers/toBeJaypieError.matcher.js

@@ -1,11 +1,6 @@
 import { matchers as jsonSchemaMatchers } from "jest-json-schema";
 import { jsonApiErrorSchema } from "../jsonApiSchema.module.js";
 
-//
-//
-// Constants
-//
-
 //
 //
 // Helper Functions

package/src/matchers.module.js

@@ -1,5 +1,6 @@
 import { matchers as jsonSchemaMatchers } from "jest-json-schema";
 
+import toBeCalledAboveTrace from "./matchers/toBeCalledAboveTrace.matcher.js";
 import toBeCalledWithInitialParams from "./matchers/toBeCalledWithInitialParams.matcher.js";
 import toBeClass from "./matchers/toBeClass.matcher.js";
 import toBeJaypieError from "./matchers/toBeJaypieError.matcher.js";
@@ -28,6 +29,7 @@ import {
 //
 
 export default {
+  toBeCalledAboveTrace,
   toBeCalledWithInitialParams,
   toBeClass,
   toBeJaypieError,