joist-test-utils 1.32.2 → 1.33.0

package/build/context.d.ts

@@ -0,0 +1,4 @@
+import { EntityManager } from "joist-orm";
+export declare type Context = {
+    em: EntityManager;
+};

package/build/context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.js.map

package/build/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":""}

package/build/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="jest" />
 import { MatchedEntity } from "./toMatchEntity";
+export { run, runEach } from "./run";
 export { toMatchEntity } from "./toMatchEntity";
 declare global {
     namespace jest {

package/build/index.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toMatchEntity = void 0;
+exports.toMatchEntity = exports.runEach = exports.run = void 0;
+var run_1 = require("./run");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return run_1.run; } });
+Object.defineProperty(exports, "runEach", { enumerable: true, get: function () { return run_1.runEach; } });
 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

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

package/build/run.d.ts

@@ -0,0 +1,7 @@
+import { Context } from "./context";
+declare type MaybePromise<T> = T | Promise<T>;
+/** Runs the `fn` in a dedicated / non-test Unit of Work . */
+export declare function run<C extends Context, T>(ctx: C, fn: (ctx: C) => MaybePromise<T>): Promise<T>;
+/** Runs the `fn` in a dedicated / non-test Unit of Work for each value in `values */
+export declare function runEach<C extends Context, T, U>(ctx: C, valuesFn: () => U[], fn: (ctx: C, value: U) => MaybePromise<T>): Promise<T[]>;
+export {};

package/build/run.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEach = exports.run = void 0;
+const joist_orm_1 = require("joist-orm");
+/** Runs the `fn` in a dedicated / non-test Unit of Work . */
+async function run(ctx, fn) {
+    const { em } = ctx;
+    // Ensure any test data we've setup is flushed
+    await em.flush();
+    const result = await runWithNewCtx(ctx, fn);
+    // We expect `fn` (i.e. a resolver) to do its own UoW management, so don't flush.
+    await em.refresh({ deepLoad: true });
+    return mapResultToOriginalEm(em, result);
+}
+exports.run = run;
+/** Runs the `fn` in a dedicated / non-test Unit of Work for each value in `values */
+async function runEach(ctx, valuesFn, fn) {
+    const { em } = ctx;
+    // Ensure any test data we've setup is flushed
+    await em.flush();
+    const results = await Promise.all(valuesFn().map((value) => runWithNewCtx(ctx, (ctx) => fn(ctx, value))));
+    // We expect `fn` (i.e. a resolver) to do its own UoW management, so don't flush.
+    await em.refresh({ deepLoad: true });
+    return mapResultToOriginalEm(em, results);
+}
+exports.runEach = runEach;
+/** Runs the `fn` in a dedicated / non-test Unit of Work. */
+async function runWithNewCtx(ctx, fn) {
+    const { em } = ctx;
+    const newCtx = { ...ctx };
+    const newEm = new joist_orm_1.EntityManager(newCtx, em.driver);
+    return fn(newCtx);
+}
+function gatherEntities(result) {
+    if ((0, joist_orm_1.isEntity)(result)) {
+        return [result];
+    }
+    else if (Array.isArray(result)) {
+        return result.flatMap(gatherEntities);
+    }
+    else if (result !== null && typeof result === "object") {
+        return Object.values(result).flatMap(gatherEntities);
+    }
+    else {
+        return [];
+    }
+}
+async function mapResultToOriginalEm(em, result) {
+    const newEmEntities = gatherEntities(result);
+    // load any entities that don't exist in the original em
+    await Promise.all(newEmEntities.filter((e) => !em.findExistingInstance(e.idOrFail)).map((e) => em.load(e.idOrFail)));
+    // generate a cache of id -> entity in original em
+    const cache = Object.fromEntries(newEmEntities.map((e) => [e.idOrFail, em.findExistingInstance(e.idOrFail)]));
+    function doMap(value) {
+        if ((0, joist_orm_1.isEntity)(value)) {
+            return cache[value.idOrFail];
+        }
+        else if (Array.isArray(value)) {
+            return value.map(doMap);
+        }
+        else if (typeof value === "object" && value?.constructor === Object) {
+            return Object.fromEntries(Object.entries(value).map(([key, value]) => [key, doMap(value)]));
+        }
+        else {
+            return value;
+        }
+    }
+    return doMap(result);
+}
+//# sourceMappingURL=run.js.map

package/build/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":";;;AAAA,yCAA4D;AAK5D,6DAA6D;AACtD,KAAK,UAAU,GAAG,CAAuB,GAAM,EAAE,EAA+B;IACrF,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC;IACnB,8CAA8C;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;IACjB,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5C,iFAAiF;IACjF,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC;AARD,kBAQC;AAED,qFAAqF;AAC9E,KAAK,UAAU,OAAO,CAC3B,GAAM,EACN,QAAmB,EACnB,EAAyC;IAEzC,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC;IACnB,8CAA8C;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;IACjB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1G,iFAAiF;IACjF,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,OAAO,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAZD,0BAYC;AAED,4DAA4D;AAC5D,KAAK,UAAU,aAAa,CAAuB,GAAM,EAAE,EAA+B;IACxF,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC;IACnB,MAAM,MAAM,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,yBAAa,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,cAAc,CAAC,MAAW;IACjC,IAAI,IAAA,oBAAQ,EAAC,MAAM,CAAC,EAAE;QACpB,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAChC,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;KACvC;SAAM,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QACxD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;KACtD;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAI,EAAiB,EAAE,MAAS;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7C,wDAAwD;IACxD,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrH,kDAAkD;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAC9B,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,QAAQ,CAAW,CAAC,CAAC,CACtF,CAAC;IACF,SAAS,KAAK,CAAC,KAAU;QACvB,IAAI,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE;YACnB,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SAC9B;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAQ,CAAC;SAChC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,WAAW,KAAK,MAAM,EAAE;YACrE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAgB,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5G;aAAM;YACL,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC;AACvB,CAAC"}

package/build/toMatchEntity.d.ts

@@ -7,7 +7,10 @@ export declare function toMatchEntity<T>(actual: Entity, expected: MatchedEntity
  *
  * I.e. so that you can `toMatchEntity({ otherEntity: { name: "foo" } })` even though
  * `otherEntity` is technically a joist `Reference` or `Collection`.
+ *
+ * We allow `| null` so that `toMatchEntity` can work against optional fields
+ * that are returned from GraphQL object resolvers.
  */
 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] extends AsyncProperty<any, infer V> ? V : T[K];
+    [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] extends AsyncProperty<any, infer V> ? V : T[K] | null;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joist-test-utils",
-  "version": "1.32.2",
+  "version": "1.33.0",
   "license": "MIT",
   "main": "build/index.js",
   "types": "build/index.d.ts",