@reventlessdev/reventless-gwt 1.0.0-alpha.247 → 1.0.0-alpha.249

package/src/ScenarioRecorder.res.mjs

@@ -0,0 +1,287 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Nodefs from "node:fs";
+import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Primitive_object from "@rescript/runtime/lib/es6/Primitive_object.js";
+
+function enabled() {
+  let match = process.env["REVENTLESS_EMIT_SIDECAR"];
+  if (match === undefined) {
+    return false;
+  }
+  switch (match) {
+    case "1" :
+    case "TRUE" :
+    case "true" :
+      return true;
+    default:
+      return false;
+  }
+}
+
+let current = {
+  contents: undefined
+};
+
+let fileOverride = {
+  contents: undefined
+};
+
+function setFile(path) {
+  fileOverride.contents = path;
+}
+
+let jestTestPath = (function () {
+  try {
+    const state = globalThis.expect && globalThis.expect.getState && globalThis.expect.getState();
+    return state && typeof state.testPath === "string" ? state.testPath : undefined;
+  } catch (_) { return undefined; }
+});
+
+function testFile() {
+  let f = fileOverride.contents;
+  if (f !== undefined) {
+    return f;
+  } else {
+    return jestTestPath();
+  }
+}
+
+let recorded = new Map();
+
+let specsOf = new Map();
+
+let foreign = new Set();
+
+function baseOf(file) {
+  return Stdlib_Array.reduce([
+    ".res.mjs",
+    ".res.js",
+    ".res",
+    ".mjs",
+    ".js"
+  ], file, (f, ext) => {
+    if (f.endsWith(ext)) {
+      return f.slice(0, f.length - ext.length | 0);
+    } else {
+      return f;
+    }
+  });
+}
+
+function sidecarFor(file, spec) {
+  let specs = Stdlib_Option.getOr(specsOf.get(file), []);
+  if (!specs.includes(spec)) {
+    specs.push(spec);
+    specsOf.set(file, specs);
+  }
+  if (specs.indexOf(spec) === 0) {
+    return baseOf(file) + `.gwt.json`;
+  } else {
+    return baseOf(file) + `.` + spec + `.gwt.json`;
+  }
+}
+
+function writtenByPpx(path) {
+  if (!Nodefs.existsSync(path)) {
+    return false;
+  }
+  let d;
+  try {
+    d = JSON.parse(Nodefs.readFileSync(path, "utf8"));
+  } catch (exn) {
+    return true;
+  }
+  if (typeof d === "object" && d !== null && !Array.isArray(d)) {
+    return Primitive_object.notequal(d["recorded"], true);
+  } else {
+    return true;
+  }
+}
+
+function entryJson(e) {
+  return Object.fromEntries([
+    [
+      "kind",
+      e.kind
+    ],
+    [
+      "element",
+      e.element
+    ],
+    [
+      "values",
+      []
+    ]
+  ]);
+}
+
+function write(path, file, spec, scenarios) {
+  let json = Object.fromEntries([
+    [
+      "specName",
+      spec + ` (recorded)`
+    ],
+    [
+      "stem",
+      spec
+    ],
+    [
+      "file",
+      file
+    ],
+    [
+      "componentKind",
+      "Decision"
+    ],
+    [
+      "recorded",
+      true
+    ],
+    [
+      "scenarios",
+      scenarios.map(s => (Object.fromEntries([
+        [
+          "title",
+          s.title
+        ],
+        [
+          "given",
+          s.given.map(entryJson)
+        ],
+        [
+          "when",
+          s.when_.map(entryJson)
+        ],
+        [
+          "then",
+          s.then_.map(entryJson)
+        ]
+      ])))
+    ]
+  ]);
+  Nodefs.writeFileSync(path, Stdlib_Option.getOr(JSON.stringify(json, undefined, 2), "{}") + "\n", "utf8");
+}
+
+function around(spec, title, body) {
+  if (!enabled()) {
+    return body();
+  }
+  current.contents = {
+    title: title,
+    given: [],
+    when_: [],
+    then_: []
+  };
+  let finish = () => {
+    let scenario = current.contents;
+    current.contents = undefined;
+    let match = testFile();
+    if (scenario === undefined) {
+      return;
+    }
+    if (match === undefined) {
+      return;
+    }
+    let path = sidecarFor(match, spec);
+    if (!foreign.has(path) && !recorded.has(path) && writtenByPpx(path)) {
+      foreign.add(path);
+    }
+    if (foreign.has(path)) {
+      return;
+    }
+    let match$1 = Stdlib_Option.getOr(recorded.get(path), [
+      spec,
+      []
+    ]);
+    let scenarios = match$1[1].filter(o => o.title !== scenario.title).concat([scenario]);
+    recorded.set(path, [
+      spec,
+      scenarios
+    ]);
+    write(path, match, spec, scenarios);
+  };
+  let outcome;
+  try {
+    outcome = body();
+  } catch (e) {
+    finish();
+    throw e;
+  }
+  finish();
+  return outcome;
+}
+
+function recording() {
+  return Stdlib_Option.isSome(current.contents);
+}
+
+function push(pick, entries) {
+  Stdlib_Option.forEach(current.contents, s => {
+    entries.forEach(e => {
+      pick(s).push(e);
+    });
+  });
+}
+
+function given(names) {
+  push(s => s.given, names.map(element => ({
+    kind: "event",
+    element: element
+  })));
+}
+
+function whenCommand(name) {
+  push(s => s.when_, [{
+      kind: "command",
+      element: name
+    }]);
+}
+
+function thenEvents(names) {
+  push(s => s.then_, names.map(element => ({
+    kind: "event",
+    element: element
+  })));
+}
+
+function thenError(name) {
+  push(s => s.then_, [{
+      kind: "error",
+      element: name
+    }]);
+}
+
+function thenNoEvent() {
+  push(s => s.then_, [{
+      kind: "noEvent",
+      element: ""
+    }]);
+}
+
+export {
+  enabled,
+  current,
+  fileOverride,
+  setFile,
+  jestTestPath,
+  testFile,
+  recorded,
+  specsOf,
+  foreign,
+  baseOf,
+  sidecarFor,
+  writtenByPpx,
+  entryJson,
+  write,
+  around,
+  recording,
+  push,
+  given,
+  whenCommand,
+  thenEvents,
+  thenError,
+  thenNoEvent,
+}
+/* recorded Not a pure module */

package/src/StateChange/ExternalAddCategorySlice.res

@@ -4,7 +4,7 @@
 // on command + event, payload-less consumed events.
 //
 // Spec half (Plan 02 Phase 6) — types, schemas, name. The matching impl
-// half lives in [ExternalAddCategorySlice_Behavior.res].
+// half lives in [ExternalAddCategorySlice_Decision.res].
 
 let name = "ExternalAddCategory"
 

package/src/StateChange/WithFixtures.res

@@ -2,7 +2,7 @@
 // tests at [tests/StateChange/WithFixtures_GWT.res] and
 // [tests/StateChange/WithManualOpen_GWT.res].
 //
-// Spec half — pairs with [WithFixtures_Behavior.res].
+// Spec half — pairs with [WithFixtures_Decision.res].
 
 let name = "WithFixtures"
 

package/src/StateChange/WithManualOpen.res

@@ -3,7 +3,7 @@
 // [WithFixtures]; named differently so it gets its own companion
 // [<Stem>_Fixtures] sibling that the PPX considers for auto-open.
 //
-// Spec half — pairs with [WithManualOpen_Behavior.res].
+// Spec half — pairs with [WithManualOpen_Decision.res].
 
 let name = "WithManualOpen"
 

package/tests/CallerTest.res

@@ -13,23 +13,23 @@ module Roles = {
 
 describe("Caller.owner", () => {
   testSync("takes a typed id as the user id it stands for", () =>
-    expect(Behavior_GWT.Caller.owner(CustomerId.makeFromString("c1")).claim)->toEqual(
+    expect(Decision_GWT.Caller.owner(CustomerId.makeFromString("c1")).claim)->toEqual(
       Reventless.Message.CallerClaim.Owned({userId: "c1"}),
     )
   )
 
   testSync("takes a plain string too", () =>
-    expect(Behavior_GWT.Caller.owner("c1").claim)->toEqual(
+    expect(Decision_GWT.Caller.owner("c1").claim)->toEqual(
       Reventless.Message.CallerClaim.Owned({userId: "c1"}),
     )
   )
 
   testSync("holds no role unless given some", () =>
-    expect(Behavior_GWT.Caller.owner("c1").roles)->toEqual([])
+    expect(Decision_GWT.Caller.owner("c1").roles)->toEqual([])
   )
 
   testSync("holds the roles it is given, by name", () =>
-    expect(Behavior_GWT.Caller.owner("c1", ~roles=[Roles.Merchandiser]).roles)->toEqual([
+    expect(Decision_GWT.Caller.owner("c1", ~roles=[Roles.Merchandiser]).roles)->toEqual([
       "Merchandiser",
     ])
   )
@@ -38,7 +38,7 @@ describe("Caller.owner", () => {
   // with a recorded owner would only ever refuse — a silent wrong answer.
   testSync("refuses a value that is not an id", () =>
     expect(
-      switch Behavior_GWT.Caller.owner(42) {
+      switch Decision_GWT.Caller.owner(42) {
       | _ => false
       | exception _ => true
       },
@@ -48,13 +48,13 @@ describe("Caller.owner", () => {
 
 describe("Caller.inRoles", () => {
   testSync("is signed in, holds the roles, and owns nothing in particular", () => {
-    let caller = Behavior_GWT.Caller.inRoles([Roles.Merchandiser])
+    let caller = Decision_GWT.Caller.inRoles([Roles.Merchandiser])
     expect((caller.signedIn, caller.roles))->toEqual((true, ["Merchandiser"]))
   })
 
   testSync("refuses a role that is not a payload-less case", () =>
     expect(
-      switch Behavior_GWT.Caller.inRoles([42]) {
+      switch Decision_GWT.Caller.inRoles([42]) {
       | _ => false
       | exception _ => true
       },

package/tests/CallerTest.res.mjs

@@ -1,7 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
 import * as Id$Reventless from "@reventlessdev/reventless-spec/src/types/Id.res.mjs";
-import * as Behavior_GWT$ReventlessGwt from "../src/Behavior_GWT.res.mjs";
+import * as Decision_GWT$ReventlessGwt from "../src/Decision_GWT.res.mjs";
 
 let CustomerId = Id$Reventless.Make({
   key: "customerId"
@@ -11,27 +11,27 @@ let Roles = {};
 
 globalThis.describe("Caller.owner", () => {
   globalThis.test("takes a typed id as the user id it stands for", () => {
-    globalThis.expect(Behavior_GWT$ReventlessGwt.Caller.owner(CustomerId.makeFromString("c1"), undefined).claim).toEqual({
+    globalThis.expect(Decision_GWT$ReventlessGwt.Caller.owner(CustomerId.makeFromString("c1"), undefined).claim).toEqual({
       TAG: "Owned",
       userId: "c1"
     });
   });
   globalThis.test("takes a plain string too", () => {
-    globalThis.expect(Behavior_GWT$ReventlessGwt.Caller.owner("c1", undefined).claim).toEqual({
+    globalThis.expect(Decision_GWT$ReventlessGwt.Caller.owner("c1", undefined).claim).toEqual({
       TAG: "Owned",
       userId: "c1"
     });
   });
   globalThis.test("holds no role unless given some", () => {
-    globalThis.expect(Behavior_GWT$ReventlessGwt.Caller.owner("c1", undefined).roles).toEqual([]);
+    globalThis.expect(Decision_GWT$ReventlessGwt.Caller.owner("c1", undefined).roles).toEqual([]);
   });
   globalThis.test("holds the roles it is given, by name", () => {
-    globalThis.expect(Behavior_GWT$ReventlessGwt.Caller.owner("c1", ["Merchandiser"]).roles).toEqual(["Merchandiser"]);
+    globalThis.expect(Decision_GWT$ReventlessGwt.Caller.owner("c1", ["Merchandiser"]).roles).toEqual(["Merchandiser"]);
   });
   globalThis.test("refuses a value that is not an id", () => {
     let tmp;
     try {
-      Behavior_GWT$ReventlessGwt.Caller.owner(42, undefined);
+      Decision_GWT$ReventlessGwt.Caller.owner(42, undefined);
       tmp = false;
     } catch (exn) {
       tmp = true;
@@ -42,7 +42,7 @@ globalThis.describe("Caller.owner", () => {
 
 globalThis.describe("Caller.inRoles", () => {
   globalThis.test("is signed in, holds the roles, and owns nothing in particular", () => {
-    let caller = Behavior_GWT$ReventlessGwt.Caller.inRoles(["Merchandiser"]);
+    let caller = Decision_GWT$ReventlessGwt.Caller.inRoles(["Merchandiser"]);
     globalThis.expect([
       caller.signedIn,
       caller.roles
@@ -54,7 +54,7 @@ globalThis.describe("Caller.inRoles", () => {
   globalThis.test("refuses a role that is not a payload-less case", () => {
     let tmp;
     try {
-      Behavior_GWT$ReventlessGwt.Caller.inRoles([42]);
+      Decision_GWT$ReventlessGwt.Caller.inRoles([42]);
       tmp = false;
     } catch (exn) {
       tmp = true;

package/tests/FlowAggregateGwtTest.res

@@ -24,7 +24,7 @@ module CatalogProductAggregate = {
   type error = AlreadySynced
 }
 
-module CatalogProductBehavior = {
+module CatalogProductDecision = {
   module Spec = CatalogProductAggregate
 
   type state = NotSynced | Synced
@@ -44,7 +44,7 @@ module CatalogProductBehavior = {
     | (Synced, _) => Error(CatalogProductAggregate.AlreadySynced)
     }
 
-  let moduleUrl = "test://CatalogProductBehavior"
+  let moduleUrl = "test://CatalogProductDecision"
 }
 
 // -- Aggregate: Order ---------------------------------------------------------
@@ -68,7 +68,7 @@ module OrderAggregate = {
     | NotPlaced
 }
 
-module OrderBehavior = {
+module OrderDecision = {
   module Spec = OrderAggregate
 
   type state = {placed: bool, shipped: bool}
@@ -98,13 +98,13 @@ module OrderBehavior = {
       }
     }
 
-  let moduleUrl = "test://OrderBehavior"
+  let moduleUrl = "test://OrderDecision"
 }
 
 // -- Step modules -------------------------------------------------------------
 
-module Sync = AggregateCommandStep(CatalogProductAggregate, CatalogProductBehavior)
-module Place = AggregateCommandStep(OrderAggregate, OrderBehavior)
+module Sync = AggregateCommandStep(CatalogProductAggregate, CatalogProductDecision)
+module Place = AggregateCommandStep(OrderAggregate, OrderDecision)
 
 // -- Flows --------------------------------------------------------------------
 

package/tests/FlowAggregateGwtTest.res.mjs

@@ -59,9 +59,9 @@ function decide(state, command) {
   }
 }
 
-let moduleUrl = "test://CatalogProductBehavior";
+let moduleUrl = "test://CatalogProductDecision";
 
-let CatalogProductBehavior = {
+let CatalogProductDecision = {
   Spec: undefined,
   initialState: "NotSynced",
   snapshot: undefined,
@@ -169,9 +169,9 @@ function decide$1(state, command) {
   }
 }
 
-let moduleUrl$1 = "test://OrderBehavior";
+let moduleUrl$1 = "test://OrderDecision";
 
-let OrderBehavior = {
+let OrderDecision = {
   Spec: undefined,
   initialState: initialState,
   snapshot: undefined,
@@ -278,9 +278,9 @@ Flow_GWT$ReventlessGwt.describe("Aggregate flow (single plugin)", () => {
 
 export {
   CatalogProductAggregate,
-  CatalogProductBehavior,
+  CatalogProductDecision,
   OrderAggregate,
-  OrderBehavior,
+  OrderDecision,
   Sync,
   Place,
 }

package/tests/FlowCrossPluginGwtTest.res

@@ -46,7 +46,7 @@ module AddProductSlice = {
       })
 }
 
-module AddProductBehavior = {
+module AddProductDecision = {
   module Spec = AddProductSlice
   type state = {added: bool}
   let initialState = {added: false}
@@ -164,7 +164,7 @@ module RecordDemandSlice = {
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
 
-module RecordDemandBehavior = {
+module RecordDemandDecision = {
   module Spec = RecordDemandSlice
   type state = {count: int}
   let initialState = {count: 0}
@@ -225,7 +225,7 @@ module SyncProductSlice = {
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
 
-module SyncProductBehavior = {
+module SyncProductDecision = {
   module Spec = SyncProductSlice
   type state = {synced: bool}
   let initialState = {synced: false}
@@ -278,7 +278,7 @@ module PlaceOrderSlice = {
       })
 }
 
-module PlaceOrderBehavior = {
+module PlaceOrderDecision = {
   module Spec = PlaceOrderSlice
   type state = {placed: array<string>, available: array<string>}
   let initialState = {placed: [], available: []}
@@ -308,14 +308,14 @@ module PlaceOrderBehavior = {
 // Step modules
 // ===========================================================================
 
-module AddProduct = CommandStep(AddProductSlice, AddProductBehavior)
+module AddProduct = CommandStep(AddProductSlice, AddProductDecision)
 module ProductsEp = ExtensionPointStep(ProductsEpMapping)
 module ProductsExt = ExtensionStep(ProductsExtMapping)
-module Sync = CommandStep(SyncProductSlice, SyncProductBehavior)
-module Place = CommandStep(PlaceOrderSlice, PlaceOrderBehavior)
+module Sync = CommandStep(SyncProductSlice, SyncProductDecision)
+module Place = CommandStep(PlaceOrderSlice, PlaceOrderDecision)
 module OrdersEp = ExtensionPointStep(OrdersEpMapping)
 module OrdersExt = ExtensionStep(OrdersExtMapping)
-module Demand = CommandStep(RecordDemandSlice, RecordDemandBehavior)
+module Demand = CommandStep(RecordDemandSlice, RecordDemandDecision)
 
 // ===========================================================================
 // Flows

package/tests/FlowCrossPluginGwtTest.res.mjs

@@ -77,7 +77,7 @@ function decide(state, command) {
   }
 }
 
-let AddProductBehavior = {
+let AddProductDecision = {
   Spec: undefined,
   initialState: initialState,
   evolve: evolve,
@@ -362,7 +362,7 @@ function decide$1(_state, command) {
   };
 }
 
-let RecordDemandBehavior = {
+let RecordDemandDecision = {
   Spec: undefined,
   initialState: initialState$1,
   evolve: evolve$1,
@@ -473,7 +473,7 @@ function decide$2(_state, command) {
   };
 }
 
-let SyncProductBehavior = {
+let SyncProductDecision = {
   Spec: undefined,
   initialState: initialState$2,
   evolve: evolve$2,
@@ -620,7 +620,7 @@ function decide$3(state, command) {
   }
 }
 
-let PlaceOrderBehavior = {
+let PlaceOrderDecision = {
   Spec: undefined,
   initialState: initialState$3,
   evolve: evolve$3,
@@ -887,7 +887,7 @@ export {
   EPM,
   EM,
   AddProductSlice,
-  AddProductBehavior,
+  AddProductDecision,
   ProductsEpSpec,
   ProductDelegate,
   ProductsEpMapping,
@@ -895,13 +895,13 @@ export {
   OrderDelegate,
   OrdersEpMapping,
   RecordDemandSlice,
-  RecordDemandBehavior,
+  RecordDemandDecision,
   OrdersExtMapping,
   SyncProductSlice,
-  SyncProductBehavior,
+  SyncProductDecision,
   ProductsExtMapping,
   PlaceOrderSlice,
-  PlaceOrderBehavior,
+  PlaceOrderDecision,
   AddProduct,
   ProductsEp,
   ProductsExt,

package/tests/FlowGwtTest.res

@@ -28,7 +28,7 @@ module PlaceOrderSlice = {
   type event = OrderPlaced({orderId: @s.matches(Reventless.DcbTag.string) string, item: string})
 }
 
-module PlaceOrderBehavior = {
+module PlaceOrderDecision = {
   module Spec = PlaceOrderSlice
   type state = {placed: bool}
   let initialState = {placed: false}
@@ -95,7 +95,7 @@ module ShipOrderSlice = {
   type event = OrderShipped({orderId: @s.matches(Reventless.DcbTag.string) string})
 }
 
-module ShipOrderBehavior = {
+module ShipOrderDecision = {
   module Spec = ShipOrderSlice
   type state = {placed: bool, shipped: bool}
   let initialState = {placed: false, shipped: false}
@@ -167,9 +167,9 @@ module ConfirmSlice = {
 
 // -- Step modules ------------------------------------------------------------
 
-module Place = CommandStep(PlaceOrderSlice, PlaceOrderBehavior)
+module Place = CommandStep(PlaceOrderSlice, PlaceOrderDecision)
 module Auto = AutomationStep(AutoShipSlice)
-module Ship = CommandStep(ShipOrderSlice, ShipOrderBehavior)
+module Ship = CommandStep(ShipOrderSlice, ShipOrderDecision)
 module View = ViewStep(OrdersViewSlice, OrdersViewProjection)
 module Confirm = OutboundStep(ConfirmSlice)
 

package/tests/FlowGwtTest.res.mjs

@@ -74,7 +74,7 @@ function decide(state, command) {
   }
 }
 
-let PlaceOrderBehavior = {
+let PlaceOrderDecision = {
   Spec: undefined,
   initialState: initialState,
   evolve: evolve,
@@ -248,7 +248,7 @@ function decide$1(state, command) {
   }
 }
 
-let ShipOrderBehavior = {
+let ShipOrderDecision = {
   Spec: undefined,
   initialState: initialState$1,
   evolve: evolve$1,
@@ -463,10 +463,10 @@ Flow_GWT$ReventlessGwt.describe("Order flow (single plugin)", () => {
 
 export {
   PlaceOrderSlice,
-  PlaceOrderBehavior,
+  PlaceOrderDecision,
   AutoShipSlice,
   ShipOrderSlice,
-  ShipOrderBehavior,
+  ShipOrderDecision,
   OrdersViewSlice,
   OrdersViewProjection,
   ConfirmSlice,