@jaypie/testkit 1.0.20 → 1.0.21

package/README.md

@@ -12,21 +12,33 @@ npm install --save-dev @jaypie/testkit
 
 ### Example
 
+#### Mocking Jaypie
+
+The testkit provides a complete mock for Jaypie including:
+
+* Log spying (`expect(log.warn).toHaveBeenCalled()`)
+* Default responses for runtime-only functions (`connect`, `sendMessage`, `submitMetric`)
+* No automatic error handling for handlers (which is good in production but obfuscates tests)
+* Most non-utility functions are mocked to allow simple testing
+
+```javascript
+vi.mock("jaypie", vi.importActual("@jaypie/testkit"));
+```
+
 #### Log Spying
 
 ```javascript
-import { restoreLog, spyLog } from "@jaypie/testkit";
-import { log } from "@jaypie/core";
+import { log } from "jaypie";
+
+vi.mock("jaypie", vi.importActual("@jaypie/testkit"));
 
-beforeEach(() => {
-  spyLog(log);
-});
 afterEach(() => {
-  restoreLog(log);
   vi.clearAllMocks();
 });
 
 test("log", () => {
+  expect(vi.isMockFunction(log.warn)).toBe(true);
+  expect(log.warn).not.toHaveBeenCalled();
   log.warn("Danger");
   expect(log.warn).toHaveBeenCalled();
   expect(log.error).not.toHaveBeenCalled();
@@ -256,7 +268,7 @@ Restores the `log` provided by `@jaypie/core`, commonly performed `afterEach` wi
 
 ### `spyLog(log)`
 
-Spies on the `log` provided by `@jaypie/core`, commonly performed `beforeEach` with `restoreLog` in `afterEach`.
+Spies on the `log` provided by `@jaypie/core`, commonly performed `beforeEach` with `restoreLog` in `afterEach`. Not necessary when mocking the entire Jaypie module.
 
 ```javascript
 import { restoreLog, spyLog } from "@jaypie/testkit";
@@ -303,6 +315,7 @@ const event = sqsTestRecords(
 
 | Date       | Version | Summary        |
 | ---------- | ------- | -------------- |
+|  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   |
 |  3/15/2024 |   0.1.0 | Initial deploy |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/testkit",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -21,6 +21,7 @@
     "test": "vitest",
     "test:spec:constants": "vitest run ./src/__tests__/constants.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",
@@ -33,6 +34,7 @@
   },
   "dependencies": {
     "@jaypie/core": "^1.0.33",
+    "jaypie": "^1.0.44",
     "jest-json-schema": "^6.1.0",
     "lodash.isequal": "^4.5.0",
     "uuid": "^9.0.1"

package/src/index.js

@@ -1,9 +1,12 @@
+import * as mockingJay from "./jaypie.mock.js";
+
 //
 //
 // Constants
 //
 
 export { LOG } from "./constants.js";
+
 //
 //
 // Export
@@ -13,3 +16,5 @@ export { jsonApiErrorSchema, jsonApiSchema } from "./jsonApiSchema.module.js";
 export { default as matchers } from "./matchers.module.js";
 export { mockLogFactory, restoreLog, spyLog } from "./mockLog.module.js";
 export { default as sqsTestRecords } from "./sqsTestRecords.function.js";
+
+export default mockingJay;

package/src/jaypie.mock.js

@@ -0,0 +1,206 @@
+import { getMessages as originalGetMessages } from "@jaypie/aws";
+import { force, uuid as originalUuid } from "@jaypie/core";
+import { BadRequestError, JAYPIE, log, UnavailableError } from "@jaypie/core";
+import { beforeAll, vi } from "vitest";
+
+import { spyLog } from "./mockLog.module.js";
+
+//
+//
+// Setup
+//
+
+const TAG = JAYPIE.LIB.TESTKIT;
+
+// Export all the modules from Jaypie packages:
+
+export * from "@jaypie/aws";
+export * from "@jaypie/core";
+export * from "@jaypie/express";
+export * from "@jaypie/datadog";
+export * from "@jaypie/lambda";
+export * from "@jaypie/mongoose";
+
+// Spy on log:
+
+beforeAll(() => {
+  spyLog(log);
+});
+
+// afterEach(() => {
+// This is not necessary because the log isn't being used outside tests:
+// restoreLog(log);
+// The is the client's responsibility:
+// vi.clearAllMocks();
+// });
+
+//
+//
+// Mock Functions
+//
+
+// @jaypie/aws
+
+export const getMessages = vi.fn((...params) => originalGetMessages(...params));
+
+export const getSecret = vi.fn(() => {
+  return `_MOCK_SECRET_[${TAG}]`;
+});
+
+export const sendBatchMessages = vi.fn(() => {
+  // TODO: better default value
+  return { value: `_MOCK_BATCH_MESSAGES_[${TAG}]` };
+});
+
+export const sendMessage = vi.fn(() => {
+  // TODO: better default value
+  return { value: `_MOCK_MESSAGE_[${TAG}]` };
+});
+
+// @jaypie/core Functions
+
+export const envBoolean = vi.fn(() => {
+  return true;
+});
+
+export const jaypieHandler = vi.fn(
+  (
+    handler,
+    {
+      setup = [],
+      teardown = [],
+      unavailable = force.boolean(process.env.PROJECT_UNAVAILABLE),
+      validate = [],
+    } = {},
+  ) => {
+    return async (...args) => {
+      let result;
+      let thrownError;
+      if (unavailable) throw new UnavailableError();
+      for (const validator of validate) {
+        if (typeof validator === "function") {
+          const valid = await validator(...args);
+          if (valid === false) {
+            throw new BadRequestError();
+          }
+        }
+      }
+      try {
+        for (const setupFunction of setup) {
+          if (typeof setupFunction === "function") {
+            await setupFunction(...args);
+          }
+        }
+        result = handler(...args);
+      } catch (error) {
+        thrownError = error;
+      }
+      for (const teardownFunction of teardown) {
+        if (typeof teardownFunction === "function") {
+          try {
+            await teardownFunction(...args);
+          } catch (error) {
+            // eslint-disable-next-line no-console
+            console.error(error);
+          }
+        }
+      }
+      if (thrownError) {
+        throw thrownError;
+      }
+      return result;
+    };
+  },
+);
+
+export const sleep = vi.fn(() => {
+  return true;
+});
+
+export const uuid = vi.fn(originalUuid);
+
+// @jaypie/datadog
+
+export const submitMetric = vi.fn(() => {
+  return true;
+});
+
+export const submitMetricSet = vi.fn(() => {
+  return true;
+});
+
+// @jaypie/express
+
+export const expressHandler = vi.fn((handler, props = {}) => {
+  if (typeof handler !== "function") {
+    throw new BadRequestError("handler must be a function");
+  }
+  if (!props) {
+    props = {};
+  }
+  props.setup = force.array(props.setup); // allows a single item
+  props.teardown = force.array(props.teardown); // allows a single item
+  if (!Array.isArray(props.setup)) {
+    props.setup = [];
+  }
+  if (props.locals === null) {
+    throw new BadRequestError("locals cannot be null");
+  }
+  if (props.locals) {
+    if (typeof props.locals !== "object" || Array.isArray(props.locals)) {
+      throw new BadRequestError("locals must be an object");
+    }
+    // Locals
+    const keys = Object.keys(props.locals);
+    if (keys.length > 0) {
+      props.setup.push((req = {}) => {
+        if (typeof req !== "object") {
+          throw new BadRequestError("req must be an object");
+        }
+        // Set req.locals if it doesn't exist
+        if (!req.locals) req.locals = {};
+        if (typeof req.locals !== "object" || Array.isArray(req.locals)) {
+          throw new BadRequestError("req.locals must be an object");
+        }
+        if (!req.locals._jaypie) req.locals._jaypie = {};
+      });
+      const localsSetup = async (localsReq, localsRes) => {
+        for (let i = 0; i < keys.length; i += 1) {
+          const key = keys[i];
+          if (typeof props.locals[key] === "function") {
+            // eslint-disable-next-line no-await-in-loop
+            localsReq.locals[key] = await props.locals[key](
+              localsReq,
+              localsRes,
+            );
+          } else {
+            localsReq.locals[key] = props.locals[key];
+          }
+        }
+      };
+      props.setup.push(localsSetup);
+    }
+  }
+  return jaypieHandler(handler, props);
+});
+
+// @jaypie/lambda
+
+// For testing, this is the same as the jaypieHandler
+export const lambdaHandler = vi.fn((handler, props = {}) => {
+  return jaypieHandler(handler, props);
+});
+
+// @jaypie/mongoose
+
+export const connect = vi.fn(() => {
+  return true;
+});
+
+export const connectFromSecretEnv = vi.fn(() => {
+  return true;
+});
+
+export const disconnect = vi.fn(() => {
+  return true;
+});