@jaypie/testkit 1.0.26 → 1.0.28

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,
@@ -143,13 +146,16 @@ export default {
   toMatchUuid4,
   toMatchUuid5,
   toMatchUuid,
+  toThrowBadGatewayError,
   toThrowBadRequestError,
   toThrowConfigurationError,
   toThrowForbiddenError,
+  toThrowGatewayTimeoutError,
   toThrowInternalError,
   toThrowJaypieError,
   toThrowNotFoundError,
   toThrowUnauthorizedError,
+  toThrowUnavailableError,
 };
 ```
 
@@ -164,6 +170,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 +333,8 @@ const event = sqsTestRecords(
 
 | Date       | Version | Summary        |
 | ---------- | ------- | -------------- |
+|  9/14/2024 |  1.0.28 | Matchers `toThrowBadGatewayError`, `toThrowGatewayTimeoutError`, `toThrowUnavailableError` |
+|  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.26",
+  "version": "1.0.28",
   "author": "Finlayson Studio",
   "type": "module",
   "exports": {
@@ -24,13 +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:expressHandler.mock": "vitest run ./src/__tests__/expressHandler-supertest.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",

package/src/jaypie.mock.js

@@ -139,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");
   }
@@ -192,7 +198,6 @@ export const expressHandler = vi.fn((handler, props = {}) => {
   return async (req = {}, res = {}, ...extra) => {
     const status = HTTP.CODE.OK;
     let response;
-    let responseError;
     let supertestMode = false;
     if (
       res &&
@@ -223,19 +228,9 @@ export const expressHandler = vi.fn((handler, props = {}) => {
         throw error;
       }
     }
-    if (responseError) {
-      if (supertestMode) {
-        res.status(responseError.status || HTTP.CODE.INTERNAL_SERVER_ERROR);
-      } else {
-        throw responseError;
-      }
-      // response = response
-    }
     if (supertestMode) {
       if (response) {
-        // if (res && typeof res.status === "function") {
-        //   res.status(200);
-        // }
+        // res.status(200);
         if (typeof response === "object") {
           if (typeof response.json === "function") {
             res.json(response.json());

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/toThrowJaypieError.matcher.js

@@ -1,11 +1,14 @@
 import {
+  BadGatewayError,
   BadRequestError,
   ConfigurationError,
   ForbiddenError,
+  GatewayTimeoutError,
   InternalError,
   isJaypieError,
   NotFoundError,
   UnauthorizedError,
+  UnavailableError,
 } from "@jaypie/core";
 
 //
@@ -69,18 +72,24 @@ const toThrowJaypieError = async (received, expected) => {
 // Convenience Methods
 //
 
+const toThrowBadGatewayError = (received) =>
+  toThrowJaypieError(received, BadGatewayError);
 const toThrowBadRequestError = (received) =>
   toThrowJaypieError(received, BadRequestError);
 const toThrowConfigurationError = (received) =>
   toThrowJaypieError(received, ConfigurationError);
 const toThrowForbiddenError = (received) =>
   toThrowJaypieError(received, ForbiddenError);
+const toThrowGatewayTimeoutError = (received) =>
+  toThrowJaypieError(received, GatewayTimeoutError);
 const toThrowInternalError = (received) =>
   toThrowJaypieError(received, InternalError);
 const toThrowNotFoundError = (received) =>
   toThrowJaypieError(received, NotFoundError);
 const toThrowUnauthorizedError = (received) =>
   toThrowJaypieError(received, UnauthorizedError);
+const toThrowUnavailableError = (received) =>
+  toThrowJaypieError(received, UnavailableError);
 
 //
 //
@@ -90,10 +99,13 @@ const toThrowUnauthorizedError = (received) =>
 export default toThrowJaypieError;
 
 export {
+  toThrowBadGatewayError,
   toThrowBadRequestError,
   toThrowConfigurationError,
   toThrowForbiddenError,
+  toThrowGatewayTimeoutError,
   toThrowInternalError,
   toThrowNotFoundError,
   toThrowUnauthorizedError,
+  toThrowUnavailableError,
 };

package/src/matchers.module.js

@@ -1,15 +1,19 @@
 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";
 import toThrowJaypieError, {
+  toThrowBadGatewayError,
   toThrowBadRequestError,
   toThrowConfigurationError,
   toThrowForbiddenError,
+  toThrowGatewayTimeoutError,
   toThrowInternalError,
   toThrowNotFoundError,
   toThrowUnauthorizedError,
+  toThrowUnavailableError,
 } from "./matchers/toThrowJaypieError.matcher.js";
 
 import {
@@ -28,6 +32,7 @@ import {
 //
 
 export default {
+  toBeCalledAboveTrace,
   toBeCalledWithInitialParams,
   toBeClass,
   toBeJaypieError,
@@ -40,11 +45,14 @@ export default {
   toMatchUuid4,
   toMatchUuid5,
   toMatchUuid,
+  toThrowBadGatewayError,
   toThrowBadRequestError,
   toThrowConfigurationError,
   toThrowForbiddenError,
+  toThrowGatewayTimeoutError,
   toThrowInternalError,
   toThrowJaypieError,
   toThrowNotFoundError,
   toThrowUnauthorizedError,
+  toThrowUnavailableError,
 };