joist-test-utils 1.0.0

package/build/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="jest" />
+import { MatchedEntity } from "./toMatchEntity";
+export { toMatchEntity } from "./toMatchEntity";
+declare global {
+    namespace jest {
+        interface Matchers<R, T = {}> {
+            toMatchEntity(expected: MatchedEntity<T>): Promise<CustomMatcherResult>;
+        }
+    }
+}

package/build/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMatchEntity = void 0;
+var toMatchEntity_1 = require("./toMatchEntity");
+Object.defineProperty(exports, "toMatchEntity", { enumerable: true, get: function () { return toMatchEntity_1.toMatchEntity; } });
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,iDAAgD;AAAvC,8GAAA,aAAa,OAAA"}

package/build/toMatchEntity.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="jest" />
+import CustomMatcherResult = jest.CustomMatcherResult;
+import { Collection, Entity, Reference } from "joist-orm";
+export declare function toMatchEntity<T>(actual: Entity, expected: MatchedEntity<T>): Promise<CustomMatcherResult>;
+/**
+ * Given a Joist entity `T`, "flattens out" the Reference/Collections.
+ *
+ * I.e. so that you can `toMatchEntity({ otherEntity: { name: "foo" } })` even though
+ * `otherEntity` is technically a joist `Reference` or `Collection`.
+ */
+export declare type MatchedEntity<T> = {
+    [K in keyof T]?: T[K] extends Reference<any, infer U, any> ? MatchedEntity<U> | U : T[K] extends Collection<any, infer U> ? Array<MatchedEntity<U> | U> : T[K];
+};

package/build/toMatchEntity.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMatchEntity = void 0;
+const joist_orm_1 = require("joist-orm");
+async function toMatchEntity(actual, expected) {
+    // Because the `actual` entity has lots of __orm, Reference, Collection, etc cruft in it,
+    // we make a simplified copy of it, where we use the keys in `expected` to pull out/eval a
+    // subset of the complex keys in an entity to be "dumb data" versions of themselves.
+    const clean = {};
+    const { em } = actual;
+    // Because we might assert again `expect(entity).toMatchEntity({ children: [{ name: "p1" }])`, we keep
+    // a queue of entities/copies to make, and work through it as we recurse through the expected/actual pair.
+    const queue = [[actual, expected, clean]];
+    while (queue.length > 0) {
+        const [actual, expected, clean] = queue.pop();
+        const keys = Object.keys(expected);
+        for (const key of keys) {
+            const value = actual[key];
+            if (value && ((0, joist_orm_1.isReference)(value) || (0, joist_orm_1.isCollection)(value))) {
+                // If something has a `.load` it could be a Reference.load or a Collection.load, either way lazy load it
+                const loaded = await value.load();
+                if (loaded instanceof Array) {
+                    const actualList = loaded;
+                    const expectedList = expected[key];
+                    const cleanList = [];
+                    // Do a hacky zip of each actual/expected pair
+                    for (let i = 0; i < Math.max(actualList.length, expectedList.length); i++) {
+                        const actualI = actualList[i];
+                        const expectedI = expectedList[i];
+                        // If actual is a list of entities (and expected is not), make a copy of each
+                        // so that we can recurse into their `{ title: ... }` properties.
+                        if ((0, joist_orm_1.isEntity)(actualI) && !(0, joist_orm_1.isEntity)(expectedI) && expectedI) {
+                            const cleanI = {};
+                            queue.push([actualI, expectedI, cleanI]);
+                            cleanList.push(cleanI);
+                        }
+                        else {
+                            // Given we're stopping here, make sure neither side is an entity
+                            if (i < expectedList.length) {
+                                expectedList[i] = maybeTestId(em, expectedI);
+                            }
+                            if (i < actualList.length) {
+                                cleanList.push(maybeTestId(em, actualI));
+                            }
+                        }
+                    }
+                    clean[key] = cleanList;
+                }
+                else {
+                    // If the `.load` result wasn't a list, assume it's an entity that we'll copy
+                    if ((0, joist_orm_1.isEntity)(loaded) && !(0, joist_orm_1.isEntity)(expected[key])) {
+                        const loadedClean = {};
+                        queue.push([loaded, expected[key], loadedClean]);
+                        clean[key] = loadedClean;
+                    }
+                    else {
+                        expected[key] = maybeTestId(em, expected[key]);
+                        clean[key] = maybeTestId(em, loaded);
+                    }
+                }
+            }
+            else {
+                // Otherwise assume it's regular data. Probably need to handle getters/promises?
+                clean[key] = value;
+            }
+        }
+    }
+    // Blatantly grab `toMatchObject` from the guts of expect
+    const { getMatchers } = require("expect/build/jestMatchersObject");
+    // @ts-ignore
+    return getMatchers().toMatchObject.call(this, clean, expected);
+}
+exports.toMatchEntity = toMatchEntity;
+function maybeTestId(em, maybeEntity) {
+    return (0, joist_orm_1.isEntity)(maybeEntity) ? getTestId(em, maybeEntity) : maybeEntity;
+}
+/** Returns either the persisted id or `tag#<offset-in-EntityManager>`. */
+function getTestId(em, entity) {
+    if (entity.id) {
+        return entity.id;
+    }
+    const meta = (0, joist_orm_1.getMetadata)(entity);
+    const sameType = em.entities.filter((e) => e instanceof meta.cstr);
+    return `${meta.tagName}#${sameType.indexOf(entity) + 1}`;
+}
+//# sourceMappingURL=toMatchEntity.js.map

package/build/toMatchEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toMatchEntity.js","sourceRoot":"","sources":["../src/toMatchEntity.ts"],"names":[],"mappings":";;;AACA,yCASmB;AAEZ,KAAK,UAAU,aAAa,CAAI,MAAc,EAAE,QAA0B;IAC/E,yFAAyF;IACzF,0FAA0F;IAC1F,oFAAoF;IACpF,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;IAEtB,sGAAsG;IACtG,0GAA0G;IAC1G,MAAM,KAAK,GAAsB,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7D,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,KAAK,IAAI,CAAC,IAAA,uBAAW,EAAC,KAAK,CAAC,IAAI,IAAA,wBAAY,EAAC,KAAK,CAAC,CAAC,EAAE;gBACxD,wGAAwG;gBACxG,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;gBAClC,IAAI,MAAM,YAAY,KAAK,EAAE;oBAC3B,MAAM,UAAU,GAAG,MAAM,CAAC;oBAC1B,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACnC,MAAM,SAAS,GAAG,EAAE,CAAC;oBACrB,8CAA8C;oBAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE;wBACzE,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;wBAC9B,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;wBAClC,6EAA6E;wBAC7E,iEAAiE;wBACjE,IAAI,IAAA,oBAAQ,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,oBAAQ,EAAC,SAAS,CAAC,IAAI,SAAS,EAAE;4BAC1D,MAAM,MAAM,GAAG,EAAE,CAAC;4BAClB,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;4BACzC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;yBACxB;6BAAM;4BACL,iEAAiE;4BACjE,IAAI,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE;gCAC3B,YAAY,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;6BAC9C;4BACD,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE;gCACzB,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;6BAC1C;yBACF;qBACF;oBACD,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;iBACxB;qBAAM;oBACL,6EAA6E;oBAC7E,IAAI,IAAA,oBAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,oBAAQ,EAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE;wBAChD,MAAM,WAAW,GAAG,EAAE,CAAC;wBACvB,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;wBACjD,KAAK,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;qBAC1B;yBAAM;wBACL,QAAQ,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;wBAC/C,KAAK,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;qBACtC;iBACF;aACF;iBAAM;gBACL,gFAAgF;gBAChF,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACpB;SACF;KACF;IAED,yDAAyD;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;IACnE,aAAa;IACb,OAAO,WAAW,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACjE,CAAC;AAjED,sCAiEC;AAED,SAAS,WAAW,CAAC,EAAiB,EAAE,WAAgB;IACtD,OAAO,IAAA,oBAAQ,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AAC1E,CAAC;AAED,0EAA0E;AAC1E,SAAS,SAAS,CAAC,EAAiB,EAAE,MAAc;IAClD,IAAI,MAAM,CAAC,EAAE,EAAE;QACb,OAAO,MAAM,CAAC,EAAE,CAAC;KAClB;IACD,MAAM,IAAI,GAAG,IAAA,uBAAW,EAAC,MAAM,CAAC,CAAC;IACjC,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,CAAC;IACnE,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;AAC3D,CAAC"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "joist-test-utils",
+  "version": "1.0.0",
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "format": "prettier --write '{schema,migrations,src}/**/*.{ts,js,tsx,jsx,graphql}'"
+  },
+  "files": [
+    "build"
+  ],
+  "devDependencies": {
+    "@swc/core": "^1.2.124",
+    "@swc/jest": "^0.2.16",
+    "@types/jest": "^26.0.24",
+    "jest": "^27.0.6",
+    "prettier": "^2.5.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "ts-node-dev": "^1.1.8",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.5.2"
+  }
+}