@reventlessdev/reventless-gwt 1.0.0-alpha.231 → 1.0.0-alpha.233

package/tests/CallerTest.res

@@ -0,0 +1,63 @@
+open JestGlobals
+
+// `Caller.owner` takes an id as a scenario holds it, typed or not, so a test
+// never converts one by hand; roles arrive as the plugin's own `Roles.t`.
+
+module CustomerId = Reventless.Id.Make({
+  let key = "customerId"
+})
+
+module Roles = {
+  type t = Merchandiser
+}
+
+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(
+      Reventless.Message.CallerClaim.Owned({userId: "c1"}),
+    )
+  )
+
+  testSync("takes a plain string too", () =>
+    expect(Behavior_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([])
+  )
+
+  testSync("holds the roles it is given, by name", () =>
+    expect(Behavior_GWT.Caller.owner("c1", ~roles=[Roles.Merchandiser]).roles)->toEqual([
+      "Merchandiser",
+    ])
+  )
+
+  // Anything that is not a string at runtime is not an id, and comparing it
+  // 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) {
+      | _ => false
+      | exception _ => true
+      },
+    )->toBe(true)
+  )
+})
+
+describe("Caller.inRoles", () => {
+  testSync("is signed in, holds the roles, and owns nothing in particular", () => {
+    let caller = Behavior_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]) {
+      | _ => false
+      | exception _ => true
+      },
+    )->toBe(true)
+  )
+})

package/tests/CallerTest.res.mjs

@@ -0,0 +1,70 @@
+// 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";
+
+let CustomerId = Id$Reventless.Make({
+  key: "customerId"
+});
+
+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({
+      TAG: "Owned",
+      userId: "c1"
+    });
+  });
+  globalThis.test("takes a plain string too", () => {
+    globalThis.expect(Behavior_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.test("holds the roles it is given, by name", () => {
+    globalThis.expect(Behavior_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);
+      tmp = false;
+    } catch (exn) {
+      tmp = true;
+    }
+    globalThis.expect(tmp).toBe(true);
+  });
+});
+
+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"]);
+    globalThis.expect([
+      caller.signedIn,
+      caller.roles
+    ]).toEqual([
+      true,
+      ["Merchandiser"]
+    ]);
+  });
+  globalThis.test("refuses a role that is not a payload-less case", () => {
+    let tmp;
+    try {
+      Behavior_GWT$ReventlessGwt.Caller.inRoles([42]);
+      tmp = false;
+    } catch (exn) {
+      tmp = true;
+    }
+    globalThis.expect(tmp).toBe(true);
+  });
+});
+
+export {
+  CustomerId,
+  Roles,
+}
+/* CustomerId Not a pure module */

package/tests/DelegateGwtTest.res

@@ -45,7 +45,8 @@ module ProductDelegate = {
   type error = NoError
 
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -132,7 +133,8 @@ module OrderDelegate = {
   type error = NoError
 
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -201,7 +203,8 @@ module SyncDelegate = {
   type error = NoError
 
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -279,7 +282,8 @@ module StockDelegate = {
   type error = NoError
 
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -341,7 +345,8 @@ module SyncedDelegate = {
   type error = NoError
 
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }

package/tests/FlowCrossPluginGwtTest.res

@@ -80,7 +80,8 @@ module ProductDelegate = {
   @schema type event = ProductAdded({productId: string, name: string, price: float})
   @schema type error = NoError
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -119,7 +120,8 @@ module OrderDelegate = {
   @schema type event = OrderPlaced({orderId: string, productIds: array<string>})
   @schema type error = NoError
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -156,7 +158,8 @@ module RecordDemandSlice = {
   type event =
     DemandRecorded({productId: @s.matches(Reventless.DcbTag.string) string, orderId: string})
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }
@@ -216,7 +219,8 @@ module SyncProductSlice = {
         price: float,
       })
   let moduleUrl = ""
-  let commandAuthorization = (_: command): Reventless.Authorization.permission => AllowAuthenticated
+  type role = Reventless.Role.name
+  let commandAuthorization = (_: command): Reventless.Authorization.rule<role> => AllowAuthenticated
   type lifecycleState = unit
   let commandTransition = (_: command): Reventless.Transition.t<lifecycleState> => Unrestricted
 }

package/tests/FlowCrossPluginGwtTest.res.mjs

@@ -691,7 +691,8 @@ let Sync = Flow_GWT$ReventlessGwt.CommandStep({
   consumedEventSchema: consumedEventSchema$2,
   commandSchema: commandSchema$6,
   errorSchema: errorSchema$4,
-  eventSchema: eventSchema$6
+  eventSchema: eventSchema$6,
+  commandAuthorization: commandAuthorization$6
 })({
   initialState: initialState$2,
   evolve: evolve$2,
@@ -762,7 +763,8 @@ let Demand = Flow_GWT$ReventlessGwt.CommandStep({
   consumedEventSchema: consumedEventSchema$1,
   commandSchema: commandSchema$5,
   errorSchema: errorSchema$3,
-  eventSchema: eventSchema$5
+  eventSchema: eventSchema$5,
+  commandAuthorization: commandAuthorization$5
 })({
   initialState: initialState$1,
   evolve: evolve$1,

package/tests/StateChange/ExternalAddCategorySlice_GWT.res.mjs

@@ -39,6 +39,10 @@ let Spec = include.Spec;
 
 let todo = include.todo;
 
+let Caller = include.Caller;
+
+let asCaller = include.asCaller;
+
 let thenEvents = include.thenEvents;
 
 let thenNoEvent = include.thenNoEvent;
@@ -47,6 +51,8 @@ let thenEventWithError = include.thenEventWithError;
 
 let thenEventsWithError = include.thenEventsWithError;
 
+let thenRefused = include.thenRefused;
+
 let thenAppendsConditionedOn = include.thenAppendsConditionedOn;
 
 let thenAppendsConditionedOnExactly = include.thenAppendsConditionedOnExactly;
@@ -57,6 +63,8 @@ export {
   todo,
   test,
   givenEvents,
+  Caller,
+  asCaller,
   whenCmd,
   thenEvent,
   thenEvents,
@@ -64,6 +72,7 @@ export {
   thenEventWithError,
   thenEventsWithError,
   thenError,
+  thenRefused,
   thenAppendsConditionedOn,
   thenAppendsConditionedOnExactly,
 }

package/tests/StateChange/WithFixtures_GWT.res.mjs

@@ -23,6 +23,10 @@ let Spec = include.Spec;
 
 let todo = include.todo;
 
+let Caller = include.Caller;
+
+let asCaller = include.asCaller;
+
 let thenEvents = include.thenEvents;
 
 let thenNoEvent = include.thenNoEvent;
@@ -33,6 +37,8 @@ let thenEventsWithError = include.thenEventsWithError;
 
 let thenError = include.thenError;
 
+let thenRefused = include.thenRefused;
+
 let thenAppendsConditionedOn = include.thenAppendsConditionedOn;
 
 let thenAppendsConditionedOnExactly = include.thenAppendsConditionedOnExactly;
@@ -43,6 +49,8 @@ export {
   todo,
   test,
   givenEvents,
+  Caller,
+  asCaller,
   whenCmd,
   thenEvent,
   thenEvents,
@@ -50,6 +58,7 @@ export {
   thenEventWithError,
   thenEventsWithError,
   thenError,
+  thenRefused,
   thenAppendsConditionedOn,
   thenAppendsConditionedOnExactly,
 }

package/tests/StateChange/WithManualOpen_GWT.res.mjs

@@ -23,6 +23,10 @@ let Spec = include.Spec;
 
 let todo = include.todo;
 
+let Caller = include.Caller;
+
+let asCaller = include.asCaller;
+
 let thenEvents = include.thenEvents;
 
 let thenNoEvent = include.thenNoEvent;
@@ -33,6 +37,8 @@ let thenEventsWithError = include.thenEventsWithError;
 
 let thenError = include.thenError;
 
+let thenRefused = include.thenRefused;
+
 let thenAppendsConditionedOn = include.thenAppendsConditionedOn;
 
 let thenAppendsConditionedOnExactly = include.thenAppendsConditionedOnExactly;
@@ -43,6 +49,8 @@ export {
   todo,
   test,
   givenEvents,
+  Caller,
+  asCaller,
   whenCmd,
   thenEvent,
   thenEvents,
@@ -50,6 +58,7 @@ export {
   thenEventWithError,
   thenEventsWithError,
   thenError,
+  thenRefused,
   thenAppendsConditionedOn,
   thenAppendsConditionedOnExactly,
 }

package/tests/StateChangeSliceAuthorizeGwtTest.res

@@ -0,0 +1,174 @@
+// `asCaller` with roles: a command's `@authorize` rule is checked against the
+// caller's roles before `decide`, and before the ownership rule, as production
+// checks them. A scenario without `asCaller` is checked against neither.
+
+@@reventless.gwt
+
+module ShelveSlice = {
+  let name = "Shelve"
+
+  // Inside the spec, so the zero-argument form still finds the spec and its
+  // behaviour first; the rule's `Roles` resolves by ordinary scoping either way.
+  module Roles = {
+    type t =
+      | Admin
+      | Merchandiser
+  }
+
+  @schema
+  type consumedEvent = ShelfOpened({shelfId: @s.matches(Reventless.DcbTag.string) string})
+
+  @schema
+  type command =
+    | @authorize(AllowRoles([Admin, Merchandiser]))
+    Shelve({
+        shelfId: @s.matches(Reventless.DcbTag.string) string,
+      })
+    | Browse({shelfId: @s.matches(Reventless.DcbTag.string) string})
+    | @authorize(AllowAnonymous) Peek({shelfId: @s.matches(Reventless.DcbTag.string) string})
+    | @authorize(DenyAll) Purge({shelfId: @s.matches(Reventless.DcbTag.string) string})
+
+  @schema
+  type error = unit
+
+  @schema
+  type event = Done({shelfId: @s.matches(Reventless.DcbTag.string) string})
+}
+
+module ShelveSliceBehavior = {
+  module Spec = ShelveSlice
+  open ShelveSlice
+
+  type state = unit
+  let initialState = ()
+  let evolve = (_state, _event: consumedEvent) => ()
+  let decide = (_state, command: command): result<array<event>, error> =>
+    switch command {
+    | Shelve({shelfId}) | Browse({shelfId}) | Peek({shelfId}) | Purge({shelfId}) =>
+      Ok([Done({shelfId: shelfId})])
+    }
+}
+
+let s1 = "s1"
+
+describe("a command's rule, checked against the caller's roles", () => {
+  test("accepted for each role the rule names: Admin", () =>
+    givenEvents([])
+    ->asCaller(Caller.inRoles([Admin]))
+    ->whenCmd(Shelve({shelfId: s1}))
+    ->thenEvent(Done({shelfId: s1}))
+  )
+
+  test("accepted for each role the rule names: Merchandiser", () =>
+    givenEvents([])
+    ->asCaller(Caller.inRoles([Merchandiser]))
+    ->whenCmd(Shelve({shelfId: s1}))
+    ->thenEvent(Done({shelfId: s1}))
+  )
+
+  test("refused for a signed-in caller holding none of them", () =>
+    givenEvents([])->asCaller(Caller.owner("c1"))->whenCmd(Shelve({shelfId: s1}))->thenRefused
+  )
+
+  test("refused for an anonymous caller", () =>
+    givenEvents([])->asCaller(Caller.anonymous)->whenCmd(Shelve({shelfId: s1}))->thenRefused
+  )
+
+  // Elevation lifts ownership rules, not rules about who may issue a command.
+  test("refused for an operator, who holds no role", () =>
+    givenEvents([])->asCaller(Caller.operator)->whenCmd(Shelve({shelfId: s1}))->thenRefused
+  )
+
+  test("DenyAll refuses every caller, Admin included", () =>
+    givenEvents([])
+    ->asCaller(Caller.inRoles([Admin]))
+    ->whenCmd(Purge({shelfId: s1}))
+    ->thenRefused
+  )
+
+  test("AllowAnonymous accepts an anonymous caller", () =>
+    givenEvents([])
+    ->asCaller(Caller.anonymous)
+    ->whenCmd(Peek({shelfId: s1}))
+    ->thenEvent(Done({shelfId: s1}))
+  )
+
+  test("the default rule refuses an anonymous caller", () =>
+    givenEvents([])->asCaller(Caller.anonymous)->whenCmd(Browse({shelfId: s1}))->thenRefused
+  )
+
+  test("a scenario without asCaller is checked against no rule", () =>
+    givenEvents([])->whenCmd(Purge({shelfId: s1}))->thenEvent(Done({shelfId: s1}))
+  )
+})
+
+// The same command on a slice whose history records an owner, through the same
+// functor the attribute includes, to show the two checks in production's order.
+module ClaimSlice = {
+  let name = "Claim"
+
+  module Roles = {
+    type t = Merchandiser
+  }
+
+  @schema
+  type consumedEvent =
+    | ShelfClaimed({
+        shelfId: @s.matches(Reventless.DcbTag.string) string,
+        owner: @s.matches(Reventless.Owner.string) string,
+      })
+
+  @schema
+  type command =
+    | @authorize(AllowRoles([Merchandiser]))
+    Shelve({
+        shelfId: @s.matches(Reventless.DcbTag.string) string,
+      })
+
+  @schema
+  type error = unit
+
+  @schema
+  type event = Done({shelfId: @s.matches(Reventless.DcbTag.string) string})
+}
+
+module Claim = Behavior_GWT.Make(
+  ClaimSlice,
+  {
+    type state = unit
+    let initialState = ()
+    let evolve = (_state, _event: ClaimSlice.consumedEvent) => ()
+    let decide = (_state, command: ClaimSlice.command): result<
+      array<ClaimSlice.event>,
+      ClaimSlice.error,
+    > =>
+      switch command {
+      | Shelve({shelfId}) => Ok([Done({shelfId: shelfId})])
+      }
+  },
+)
+
+let claimedByC1 = [ClaimSlice.ShelfClaimed({shelfId: s1, owner: "c1"})]
+
+describe("the rule, then ownership", () => {
+  Claim.test("an owner holding the role acts on what they own", () =>
+    Claim.givenEvents(claimedByC1)
+    ->Claim.asCaller(Claim.Caller.owner("c1", ~roles=[Merchandiser]))
+    ->Claim.whenCmd(Shelve({shelfId: s1}))
+    ->Claim.thenEvent(Done({shelfId: s1}))
+  )
+
+  Claim.test("passing the rule does not let a caller act on someone else's thing", () =>
+    Claim.givenEvents(claimedByC1)
+    ->Claim.asCaller(Claim.Caller.owner("c2", ~roles=[Merchandiser]))
+    ->Claim.whenCmd(Shelve({shelfId: s1}))
+    ->Claim.thenRefused
+  )
+
+  Claim.test("owning a thing does not pass a rule the owner fails", () =>
+    Claim.givenEvents(claimedByC1)
+    ->Claim.asCaller(Claim.Caller.owner("c1"))
+    ->Claim.whenCmd(Shelve({shelfId: s1}))
+    ->Claim.thenRefused
+  )
+})