@reventlessdev/reventless-gwt 1.0.0-alpha.74

package/tests/DiscoveryTest.res

@@ -0,0 +1,42 @@
+// Unit test for the `.gwtignore` subtree prune in `Discovery.discover`. Builds a
+// throwaway tree under the OS temp dir: a `keep/` directory with a GWT test, and
+// a `skip/` directory carrying a `.gwtignore` sentinel alongside its own GWT
+// test. Discovery must return the former and prune the latter — the guarantee
+// the codegen golden fixtures rely on (they ship compiled `*_GWT.res.mjs` on
+// disk that must never surface as live tests).
+
+open JestGlobals
+
+@module("node:os") external tmpdir: unit => string = "tmpdir"
+@module("node:path") external join: (string, string) => string = "join"
+
+type mkdirOpts = {recursive: bool}
+@module("node:fs/promises") external mkdir: (string, mkdirOpts) => promise<Nullable.t<string>> = "mkdir"
+@module("node:fs/promises") external writeFile: (string, string) => promise<unit> = "writeFile"
+
+type rmOpts = {recursive: bool, force: bool}
+@module("node:fs/promises") external rm: (string, rmOpts) => promise<unit> = "rm"
+
+let endsWith = (paths: array<string>, suffix: string) =>
+  paths->Array.some(p => String.endsWith(p, suffix))
+
+describe("Discovery .gwtignore prune", () => {
+  testPromise("keeps sibling GWT tests but prunes a subtree carrying .gwtignore", async () => {
+    let root = join(tmpdir(), "reventless-gwt-gwtignore-test")
+    let _ = await rm(root, {recursive: true, force: true})
+    let keep = join(root, "keep")
+    let skip = join(root, "skip")
+    let _ = await mkdir(keep, {recursive: true})
+    let _ = await mkdir(skip, {recursive: true})
+    let _ = await writeFile(join(keep, "Keep_GWT.res.mjs"), "")
+    let _ = await writeFile(join(skip, "Skip_GWT.res.mjs"), "")
+    let _ = await writeFile(join(skip, ".gwtignore"), "")
+
+    let found = await Discovery.discover([root])
+
+    expect(found->endsWith("keep/Keep_GWT.res.mjs"))->toBe(true)
+    expect(found->endsWith("skip/Skip_GWT.res.mjs"))->toBe(false)
+
+    let _ = await rm(root, {recursive: true, force: true})
+  })
+})

package/tests/DiscoveryTest.res.mjs

@@ -0,0 +1,43 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Nodeos from "node:os";
+import * as Nodepath from "node:path";
+import * as Promises from "node:fs/promises";
+import * as Discovery$ReventlessGwt from "../src/Discovery.res.mjs";
+
+function endsWith(paths, suffix) {
+  return paths.some(p => p.endsWith(suffix));
+}
+
+globalThis.describe("Discovery .gwtignore prune", () => {
+  globalThis.test("keeps sibling GWT tests but prunes a subtree carrying .gwtignore", async () => {
+    let root = Nodepath.join(Nodeos.tmpdir(), "reventless-gwt-gwtignore-test");
+    await Promises.rm(root, {
+      recursive: true,
+      force: true
+    });
+    let keep = Nodepath.join(root, "keep");
+    let skip = Nodepath.join(root, "skip");
+    await Promises.mkdir(keep, {
+      recursive: true
+    });
+    await Promises.mkdir(skip, {
+      recursive: true
+    });
+    await Promises.writeFile(Nodepath.join(keep, "Keep_GWT.res.mjs"), "");
+    await Promises.writeFile(Nodepath.join(skip, "Skip_GWT.res.mjs"), "");
+    await Promises.writeFile(Nodepath.join(skip, ".gwtignore"), "");
+    let found = await Discovery$ReventlessGwt.discover([root]);
+    globalThis.expect(endsWith(found, "keep/Keep_GWT.res.mjs")).toBe(true);
+    globalThis.expect(endsWith(found, "skip/Skip_GWT.res.mjs")).toBe(false);
+    await Promises.rm(root, {
+      recursive: true,
+      force: true
+    });
+  });
+});
+
+export {
+  endsWith,
+}
+/*  Not a pure module */

package/tests/DomainDeadCodeTest.res

@@ -0,0 +1,116 @@
+// Unit tests for DomainDeadCode.analyze — orphan-event reachability over synthetic
+// pluginStructures. Pure (no reventless-local import), so it runs under Jest. The
+// real end-to-end pass over the example plugins is exercised by the LocalHost
+// integration test; here we drive the analysis with hand-built fixtures to pin the
+// orphan / not-orphan boundary precisely.
+
+open JestGlobals
+
+// ── terse builders for the verbose pluginStructure sub-records ──
+let writable = (~name, ~produces=[], ~consumes=[], ~linkedViews=[]): Reventless.Plugin.writableDef => {
+  name,
+  commands: [],
+  producedEventTypes: produces,
+  consumedEventTypes: consumes,
+  linkedViews,
+  consistencyRead: None,
+  events: [],
+}
+
+let queryable = (~name, ~consumes=[]): Reventless.Plugin.queryableDef => {
+  name,
+  queryField: "",
+  schema: "",
+  consumedEventTypes: consumes,
+  linkedWriteSide: [],
+  labelField: "id",
+  searchableFields: [],
+  statusField: None,
+  visibility: None,
+}
+
+let automation = (~name, ~consumes=[]): Reventless.Plugin.automationSliceDef => {
+  name,
+  consumedEventTypes: consumes,
+  producedCommandTypes: [],
+  targetName: "",
+}
+
+let structure = (
+  ~aggregates=[],
+  ~readModels=[],
+  ~stateViewSlices=[],
+  ~stateChangeSlices=[],
+  ~automationSlices=[],
+  ~outboundTranslationSlices=[],
+  ~extensions=[],
+): Reventless.Plugin.pluginStructure => {
+  readModels,
+  stateViewSlices,
+  stateChangeSlices,
+  aggregates,
+  automationSlices,
+  outboundTranslationSlices,
+  inboundTranslationSlices: [],
+  extensions,
+  extensionPoints: None,
+}
+
+describe("DomainDeadCode.analyze — orphan events", () => {
+  testPromise("flags a produced event no component consumes", async () => {
+    let shop = structure(
+      ~aggregates=[writable(~name="Order", ~produces=["Shop.Placed", "Shop.Archived"])],
+      ~readModels=[queryable(~name="Orders", ~consumes=["Shop.Placed"])],
+    )
+    let findings = DomainDeadCode.analyze(~structures=[("Shop", shop)])
+    expect(findings->Array.map(f => f.detail))->toEqual(["Shop.Archived"])
+    let f = findings->Array.getUnsafe(0)
+    expect((f.kind, f.pluginName, f.componentName))->toEqual(("OrphanEvent", "Shop", "Order"))
+  })
+
+  testPromise("a consumer in ANY plugin clears the orphan (cross-plugin)", async () => {
+    let shop = structure(~aggregates=[writable(~name="Order", ~produces=["Shop.Placed"])])
+    let analytics = structure(~automationSlices=[automation(~name="OnPlaced", ~consumes=["Shop.Placed"])])
+    let findings = DomainDeadCode.analyze(
+      ~structures=[("Shop", shop), ("Analytics", analytics)]
+    )
+    expect(findings->Array.length)->toBe(0)
+  })
+
+  testPromise("consumption via a state-view slice and a state-change DCB read both count", async () => {
+    let s = structure(
+      ~aggregates=[writable(~name="Order", ~produces=["Shop.Placed", "Shop.Shipped"])],
+      ~stateViewSlices=[queryable(~name="OrderView", ~consumes=["Shop.Placed"])],
+      ~stateChangeSlices=[writable(~name="Ship", ~consumes=["Shop.Shipped"])],
+    )
+    let findings = DomainDeadCode.analyze(~structures=[("Shop", s)])
+    expect(findings->Array.length)->toBe(0)
+  })
+
+  testPromise("a linked classic read model clears all the aggregate's events (rule 2)", async () => {
+    // Classic aggregate → read-model link lives on the producer (`linkedViews`); the
+    // read model's consumedEventTypes is empty. The aggregate must not be flagged.
+    let shop = structure(
+      ~aggregates=[
+        writable(~name="Order", ~produces=["Shop.Placed", "Shop.Archived"], ~linkedViews=["Orders"]),
+      ],
+      ~readModels=[queryable(~name="Orders")],
+    )
+    let findings = DomainDeadCode.analyze(~structures=[("Shop", shop)])
+    expect(findings->Array.length)->toBe(0)
+  })
+
+  testPromise("an aggregate with no view and no consumer is fully orphaned", async () => {
+    let shop = structure(~aggregates=[writable(~name="Audit", ~produces=["Shop.Logged"])])
+    let findings = DomainDeadCode.analyze(~structures=[("Shop", shop)])
+    expect(findings->Array.map(f => f.detail))->toEqual(["Shop.Logged"])
+  })
+
+  testPromise("state-change slices are scanned as producers too", async () => {
+    let s = structure(
+      ~stateChangeSlices=[writable(~name="Reserve", ~produces=["Shop.Reserved"])],
+    )
+    let findings = DomainDeadCode.analyze(~structures=[("Shop", s)])
+    expect(findings->Array.map(f => (f.componentName, f.detail)))->toEqual([("Reserve", "Shop.Reserved")])
+  })
+})

package/tests/DomainDeadCodeTest.res.mjs

@@ -0,0 +1,155 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as DomainDeadCode$ReventlessGwt from "../src/DomainDeadCode.res.mjs";
+
+function writable(name, producesOpt, consumesOpt, linkedViewsOpt) {
+  let produces = producesOpt !== undefined ? producesOpt : [];
+  let consumes = consumesOpt !== undefined ? consumesOpt : [];
+  let linkedViews = linkedViewsOpt !== undefined ? linkedViewsOpt : [];
+  return {
+    name: name,
+    commands: [],
+    producedEventTypes: produces,
+    consumedEventTypes: consumes,
+    linkedViews: linkedViews,
+    consistencyRead: undefined,
+    events: []
+  };
+}
+
+function queryable(name, consumesOpt) {
+  let consumes = consumesOpt !== undefined ? consumesOpt : [];
+  return {
+    name: name,
+    queryField: "",
+    schema: "",
+    consumedEventTypes: consumes,
+    linkedWriteSide: [],
+    labelField: "id",
+    searchableFields: [],
+    statusField: undefined,
+    visibility: undefined
+  };
+}
+
+function automation(name, consumesOpt) {
+  let consumes = consumesOpt !== undefined ? consumesOpt : [];
+  return {
+    name: name,
+    consumedEventTypes: consumes,
+    producedCommandTypes: [],
+    targetName: ""
+  };
+}
+
+function structure(aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChangeSlicesOpt, automationSlicesOpt, outboundTranslationSlicesOpt, extensionsOpt) {
+  let aggregates = aggregatesOpt !== undefined ? aggregatesOpt : [];
+  let readModels = readModelsOpt !== undefined ? readModelsOpt : [];
+  let stateViewSlices = stateViewSlicesOpt !== undefined ? stateViewSlicesOpt : [];
+  let stateChangeSlices = stateChangeSlicesOpt !== undefined ? stateChangeSlicesOpt : [];
+  let automationSlices = automationSlicesOpt !== undefined ? automationSlicesOpt : [];
+  let outboundTranslationSlices = outboundTranslationSlicesOpt !== undefined ? outboundTranslationSlicesOpt : [];
+  let extensions = extensionsOpt !== undefined ? extensionsOpt : [];
+  return {
+    readModels: readModels,
+    stateViewSlices: stateViewSlices,
+    stateChangeSlices: stateChangeSlices,
+    aggregates: aggregates,
+    automationSlices: automationSlices,
+    outboundTranslationSlices: outboundTranslationSlices,
+    inboundTranslationSlices: [],
+    extensions: extensions,
+    extensionPoints: undefined
+  };
+}
+
+globalThis.describe("DomainDeadCode.analyze — orphan events", () => {
+  globalThis.test("flags a produced event no component consumes", async () => {
+    let shop = structure([writable("Order", [
+        "Shop.Placed",
+        "Shop.Archived"
+      ], undefined, undefined)], [queryable("Orders", ["Shop.Placed"])], undefined, undefined, undefined, undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([[
+        "Shop",
+        shop
+      ]]);
+    globalThis.expect(findings.map(f => f.detail)).toEqual(["Shop.Archived"]);
+    let f = findings[0];
+    globalThis.expect([
+      f.kind,
+      f.pluginName,
+      f.componentName
+    ]).toEqual([
+      "OrphanEvent",
+      "Shop",
+      "Order"
+    ]);
+  });
+  globalThis.test("a consumer in ANY plugin clears the orphan (cross-plugin)", async () => {
+    let shop = structure([writable("Order", ["Shop.Placed"], undefined, undefined)], undefined, undefined, undefined, undefined, undefined, undefined);
+    let analytics = structure(undefined, undefined, undefined, undefined, [automation("OnPlaced", ["Shop.Placed"])], undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([
+      [
+        "Shop",
+        shop
+      ],
+      [
+        "Analytics",
+        analytics
+      ]
+    ]);
+    globalThis.expect(findings.length).toBe(0);
+  });
+  globalThis.test("consumption via a state-view slice and a state-change DCB read both count", async () => {
+    let s = structure([writable("Order", [
+        "Shop.Placed",
+        "Shop.Shipped"
+      ], undefined, undefined)], undefined, [queryable("OrderView", ["Shop.Placed"])], [writable("Ship", undefined, ["Shop.Shipped"], undefined)], undefined, undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([[
+        "Shop",
+        s
+      ]]);
+    globalThis.expect(findings.length).toBe(0);
+  });
+  globalThis.test("a linked classic read model clears all the aggregate's events (rule 2)", async () => {
+    let shop = structure([writable("Order", [
+        "Shop.Placed",
+        "Shop.Archived"
+      ], undefined, ["Orders"])], [queryable("Orders", undefined)], undefined, undefined, undefined, undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([[
+        "Shop",
+        shop
+      ]]);
+    globalThis.expect(findings.length).toBe(0);
+  });
+  globalThis.test("an aggregate with no view and no consumer is fully orphaned", async () => {
+    let shop = structure([writable("Audit", ["Shop.Logged"], undefined, undefined)], undefined, undefined, undefined, undefined, undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([[
+        "Shop",
+        shop
+      ]]);
+    globalThis.expect(findings.map(f => f.detail)).toEqual(["Shop.Logged"]);
+  });
+  globalThis.test("state-change slices are scanned as producers too", async () => {
+    let s = structure(undefined, undefined, undefined, [writable("Reserve", ["Shop.Reserved"], undefined, undefined)], undefined, undefined, undefined);
+    let findings = DomainDeadCode$ReventlessGwt.analyze([[
+        "Shop",
+        s
+      ]]);
+    globalThis.expect(findings.map(f => [
+      f.componentName,
+      f.detail
+    ])).toEqual([[
+        "Reserve",
+        "Shop.Reserved"
+      ]]);
+  });
+});
+
+export {
+  writable,
+  queryable,
+  automation,
+  structure,
+}
+/*  Not a pure module */