@reventlessdev/online-shop-dcb-ordering 1.0.0-alpha.249 → 1.0.0-alpha.251

package/lib/ocaml/Customers_GWT.res

@@ -1,49 +1,45 @@
 @@reventless.gwt
 
-let cid = CustomerId.make
+open Ordering_Examples
 
 describe("Customers StateViewSlice", () => {
+  // scenario-id: 56a23bc7-31ce-4e9c-a7f1-d523e75aefba
   test("CustomerRegistered creates a row", () =>
     givenEvents([])
-    ->whenEvent(
-      CustomerRegistered({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}),
-    )
+    ->whenEvent(CustomerRegistered({customerId: c1, email: aliceEmail, address: mainStreet}))
     ->thenStateWithId(
       "c1",
-      {customerId: cid("c1"), email: "alice@x.y", address: "123 Main", deactivated: false},
+      {customerId: c1, email: aliceEmail, address: mainStreet, deactivated: false},
     )
   )
 
+  // scenario-id: 941f8ba9-3740-49f7-bb3a-e3aca90f10bf
   test("EmailChanged updates the email", () =>
-    givenEvents([
-      CustomerRegistered({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}),
-    ])
-    ->whenEvent(EmailChanged({customerId: cid("c1"), email: "alice2@x.y"}))
+    givenEvents([CustomerRegistered({customerId: c1, email: aliceEmail, address: mainStreet})])
+    ->whenEvent(EmailChanged({customerId: c1, email: aliceNewEmail}))
     ->thenStateWithId(
       "c1",
-      {customerId: cid("c1"), email: "alice2@x.y", address: "123 Main", deactivated: false},
+      {customerId: c1, email: aliceNewEmail, address: mainStreet, deactivated: false},
     )
   )
 
+  // scenario-id: 778d3e61-2b9b-4f55-a4ca-57f5e476a09b
   test("AddressChanged updates the address", () =>
-    givenEvents([
-      CustomerRegistered({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}),
-    ])
-    ->whenEvent(AddressChanged({customerId: cid("c1"), address: "789 Pine"}))
+    givenEvents([CustomerRegistered({customerId: c1, email: aliceEmail, address: mainStreet})])
+    ->whenEvent(AddressChanged({customerId: c1, address: pineStreet}))
     ->thenStateWithId(
       "c1",
-      {customerId: cid("c1"), email: "alice@x.y", address: "789 Pine", deactivated: false},
+      {customerId: c1, email: aliceEmail, address: pineStreet, deactivated: false},
     )
   )
 
+  // scenario-id: 783d84a5-3b4d-41df-bf3c-abaa9c717bd7
   test("CustomerDeactivated sets deactivated flag", () =>
-    givenEvents([
-      CustomerRegistered({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}),
-    ])
-    ->whenEvent(CustomerDeactivated({customerId: cid("c1")}))
+    givenEvents([CustomerRegistered({customerId: c1, email: aliceEmail, address: mainStreet})])
+    ->whenEvent(CustomerDeactivated({customerId: c1}))
     ->thenStateWithId(
       "c1",
-      {customerId: cid("c1"), email: "alice@x.y", address: "123 Main", deactivated: true},
+      {customerId: c1, email: aliceEmail, address: mainStreet, deactivated: true},
     )
   )
 })

package/lib/ocaml/DeactivateCustomer_GWT.res

@@ -1,23 +1,26 @@
 @@reventless.gwt
 
-let cid = CustomerId.make
+open Ordering_Examples
 
 describe("DeactivateCustomer StateChangeSlice", () => {
+  // scenario-id: 1baa12f3-6e24-4660-8b23-aaabcf0de1e3
   test("non-existent customer returns CustomerNotFound", () =>
     givenEvents([])
-    ->whenCmd(DeactivateCustomer({customerId: cid("c1")}))
+    ->whenCmd(DeactivateCustomer({customerId: c1}))
     ->thenError(CustomerNotFound)
   )
 
+  // scenario-id: 0e52a2a6-9424-474d-b3be-b6c3c8d12bbe
   test("existing customer produces CustomerDeactivated", () =>
     givenEvents([CustomerRegistered])
-    ->whenCmd(DeactivateCustomer({customerId: cid("c1")}))
-    ->thenEvent(CustomerDeactivated({customerId: cid("c1")}))
+    ->whenCmd(DeactivateCustomer({customerId: c1}))
+    ->thenEvent(CustomerDeactivated({customerId: c1}))
   )
 
+  // scenario-id: c4b62b80-ea23-4d1a-a937-68409af297ec
   test("already deactivated customer produces no events (idempotent)", () =>
     givenEvents([CustomerRegistered, CustomerDeactivated])
-    ->whenCmd(DeactivateCustomer({customerId: cid("c1")}))
+    ->whenCmd(DeactivateCustomer({customerId: c1}))
     ->thenNoEvent
   )
 })

package/lib/ocaml/OrderingPlugin.mlmap

@@ -24,6 +24,7 @@ DeactivateCustomer_GWT
 EmailService
 LifecycleModel
 OrderId
+Ordering_Examples
 Orders
 Orders_ExtensionPointMapping
 Orders_ExtensionPointMapping_GWT

package/lib/ocaml/Ordering_Examples.res

@@ -0,0 +1,15 @@
+@@reventless.examples
+
+let p1: CatalogSpec.ProductId.t = CatalogSpec.ProductId.makeFromString("p1")
+let p2: CatalogSpec.ProductId.t = CatalogSpec.ProductId.makeFromString("p2")
+
+let c1: CustomerId.t = CustomerId.makeFromString("c1")
+
+let o1: OrderId.t = OrderId.makeFromString("o1")
+let o2: OrderId.t = OrderId.makeFromString("o2")
+
+let aliceEmail: string = "alice@x.y"
+let aliceNewEmail: string = "alice2@x.y"
+let laptop: string = "Laptop"
+let mainStreet: string = "123 Main"
+let pineStreet: string = "789 Pine"

package/lib/ocaml/Orders_ExtensionPointMapping_GWT.res

@@ -2,17 +2,16 @@
 // into one public per-product event each (one-to-many fan-out).
 @@reventless.gwt
 
-let cid = CustomerId.make
-let oid = OrderId.make
-let pid = CatalogSpec.ProductId.make
+open Ordering_Examples
 
 describe("Orders ExtensionPoint mapping — per-product fan-out", () => {
+  // scenario-id: 1a9119c4-48fe-4f5f-b357-a3326dcd4ae9
   test("OrderPlaced fans out to one ItemOrdered per product", () =>
     whenDelegateEvent(
       Delegate.OrderPlaced({
-        orderId: oid("o1"),
-        customerId: cid("c1"),
-        productIds: [pid("p1"), pid("p2")],
+        orderId: o1,
+        customerId: c1,
+        productIds: [p1, p2],
       }),
     )->thenPublishesEvents([
       ("p1", ExtensionPoint.ItemOrdered({productId: "p1", orderId: "o1", customerId: "c1"})),
@@ -20,9 +19,10 @@ describe("Orders ExtensionPoint mapping — per-product fan-out", () => {
     ])
   )
 
+  // scenario-id: c8a2bb56-33d0-4f1d-a9f0-220e4e04f755
   test("OrderCancelled fans out to one ItemOrderCancelled per product", () =>
     whenDelegateEvent(
-      Delegate.OrderCancelled({orderId: oid("o1"), productIds: [pid("p1"), pid("p2")]}),
+      Delegate.OrderCancelled({orderId: o1, productIds: [p1, p2]}),
     )->thenPublishesEvents([
       ("p1", ExtensionPoint.ItemOrderCancelled({productId: "p1", orderId: "o1"})),
       ("p2", ExtensionPoint.ItemOrderCancelled({productId: "p2", orderId: "o1"})),

package/lib/ocaml/Orders_GWT.res

@@ -1,41 +1,34 @@
 @@reventless.gwt
 
-let cid = CustomerId.make
-let oid = OrderId.make
-let pid = CatalogSpec.ProductId.make
+open Ordering_Examples
 
 describe("Orders StateViewSlice", () => {
+  // scenario-id: 7967e51a-49fb-4f1e-81f8-a4feabeccf8a
   test("OrderPlaced creates a row with status Placed", () =>
     givenEvents([])
-    ->whenEvent(
-      OrderPlaced({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1"), pid("p2")]}),
-    )
+    ->whenEvent(OrderPlaced({orderId: o1, customerId: c1, productIds: [p1, p2]}))
     ->thenStateWithId(
       "o1",
       {
-        orderId: oid("o1"),
-        customerId: cid("c1"),
-        productIds: [pid("p1"), pid("p2")],
+        orderId: o1,
+        customerId: c1,
+        productIds: [p1, p2],
         lifecycle: Placed,
       },
     )
   )
 
+  // scenario-id: e97d9c01-c2e6-48c1-82d2-3cc2e7c8e401
   test("OrderShipped updates status to Shipped", () =>
-    givenEvents([OrderPlaced({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]})])
-    ->whenEvent(OrderShipped({orderId: oid("o1")}))
-    ->thenStateWithId(
-      "o1",
-      {orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")], lifecycle: Shipped},
-    )
+    givenEvents([OrderPlaced({orderId: o1, customerId: c1, productIds: [p1]})])
+    ->whenEvent(OrderShipped({orderId: o1}))
+    ->thenStateWithId("o1", {orderId: o1, customerId: c1, productIds: [p1], lifecycle: Shipped})
   )
 
+  // scenario-id: 94ff556f-1d4d-444d-8eda-0a9192715489
   test("OrderCancelled updates status to Cancelled", () =>
-    givenEvents([OrderPlaced({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]})])
-    ->whenEvent(OrderCancelled({orderId: oid("o1")}))
-    ->thenStateWithId(
-      "o1",
-      {orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")], lifecycle: Cancelled},
-    )
+    givenEvents([OrderPlaced({orderId: o1, customerId: c1, productIds: [p1]})])
+    ->whenEvent(OrderCancelled({orderId: o1}))
+    ->thenStateWithId("o1", {orderId: o1, customerId: c1, productIds: [p1], lifecycle: Cancelled})
   )
 })

package/lib/ocaml/PlaceOrder_GWT.res

@@ -1,39 +1,40 @@
 @@reventless.gwt
 
-let cid = CustomerId.make
-let oid = OrderId.make
-let pid = CatalogSpec.ProductId.make
+open Ordering_Examples
 
 describe("PlaceOrder StateChangeSlice", () => {
+  // scenario-id: 2165f9d4-87c0-4f25-a4f6-c3e0ac59a41b
   test("requires referenced products to be synced first", () =>
     givenEvents([])
-    ->whenCmd(PlaceOrder({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
-    ->thenError(ProductsNotAvailable({missing: [pid("p1")]}))
+    ->whenCmd(PlaceOrder({orderId: o1, customerId: c1, productIds: [p1]}))
+    ->thenError(ProductsNotAvailable({missing: [p1]}))
   )
 
+  // scenario-id: d20adf8e-1883-4e2f-8d22-10f2470a1f44
   test("placement succeeds when products are available", () =>
-    givenEvents([CatalogProductSynced({productId: pid("p1")})])
-    ->whenCmd(PlaceOrder({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
-    ->thenEvent(OrderPlaced({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
+    givenEvents([CatalogProductSynced({productId: p1})])
+    ->whenCmd(PlaceOrder({orderId: o1, customerId: c1, productIds: [p1]}))
+    ->thenEvent(OrderPlaced({orderId: o1, customerId: c1, productIds: [p1]}))
   )
 
+  // scenario-id: 7594b170-f241-4eb9-83d1-aaa651a80f66
   test("partial product availability returns ProductsNotAvailable with missing list", () =>
-    givenEvents([CatalogProductSynced({productId: pid("p1")})])
-    ->whenCmd(
-      PlaceOrder({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1"), pid("p2")]}),
-    )
-    ->thenError(ProductsNotAvailable({missing: [pid("p2")]}))
+    givenEvents([CatalogProductSynced({productId: p1})])
+    ->whenCmd(PlaceOrder({orderId: o1, customerId: c1, productIds: [p1, p2]}))
+    ->thenError(ProductsNotAvailable({missing: [p2]}))
   )
 
+  // scenario-id: 2d259e4c-b8d5-40ae-b5f5-018cbf31eaa4
   test("re-placing the same orderId returns OrderAlreadyPlaced", () =>
-    givenEvents([CatalogProductSynced({productId: pid("p1")}), OrderPlaced({orderId: oid("o1")})])
-    ->whenCmd(PlaceOrder({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
+    givenEvents([CatalogProductSynced({productId: p1}), OrderPlaced({orderId: o1})])
+    ->whenCmd(PlaceOrder({orderId: o1, customerId: c1, productIds: [p1]}))
     ->thenError(OrderAlreadyPlaced)
   )
 
+  // scenario-id: 2fc00acf-df4c-4c2e-8280-a82dedad5fb0
   test("a sibling OrderPlaced for a different orderId does not block placement", () =>
-    givenEvents([CatalogProductSynced({productId: pid("p1")}), OrderPlaced({orderId: oid("o2")})])
-    ->whenCmd(PlaceOrder({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
-    ->thenEvent(OrderPlaced({orderId: oid("o1"), customerId: cid("c1"), productIds: [pid("p1")]}))
+    givenEvents([CatalogProductSynced({productId: p1}), OrderPlaced({orderId: o2})])
+    ->whenCmd(PlaceOrder({orderId: o1, customerId: c1, productIds: [p1]}))
+    ->thenEvent(OrderPlaced({orderId: o1, customerId: c1, productIds: [p1]}))
   )
 })

package/lib/ocaml/Products_Extension_GWT.res

@@ -2,24 +2,24 @@
 // SyncCatalogProduct commands on Ordering's local shadow slice.
 @@reventless.gwt
 
-let pid = CatalogSpec.ProductId.make
+open Ordering_Examples
 
 // `Mapping` is brought into scope by the PPX `open Products_Extension`; opening
 // it surfaces the extension point's events and the delegate's commands.
 open Mapping
 
 describe("Products Extension delegate", () => {
+  // scenario-id: a4680fe3-1546-4669-9334-d8971e2b7162
   test("ProductBecameAvailable issues SyncNewProduct", () =>
     whenIncomingEvent(
-      ExtensionPoint.ProductBecameAvailable({productId: pid("p1"), name: "Book", price: 9.99}),
-    )->thenPublishesCommand(
-      Delegate.SyncNewProduct({productId: pid("p1"), name: "Book", price: 9.99}),
-    )
+      ExtensionPoint.ProductBecameAvailable({productId: p1, name: "Book", price: 9.99}),
+    )->thenPublishesCommand(Delegate.SyncNewProduct({productId: p1, name: "Book", price: 9.99}))
   )
 
+  // scenario-id: b8178540-b81e-4d82-9b93-9f2f68b968c6
   test("ProductPriceChanged issues ChangeSyncedPrice", () =>
     whenIncomingEvent(
-      ExtensionPoint.ProductPriceChanged({productId: pid("p1"), price: 7.5}),
-    )->thenPublishesCommand(Delegate.ChangeSyncedPrice({productId: pid("p1"), price: 7.5}))
+      ExtensionPoint.ProductPriceChanged({productId: p1, price: 7.5}),
+    )->thenPublishesCommand(Delegate.ChangeSyncedPrice({productId: p1, price: 7.5}))
   )
 })

package/lib/ocaml/RegisterCustomer_GWT.res

@@ -1,19 +1,19 @@
 @@reventless.gwt
 
-let cid = CustomerId.make
+open Ordering_Examples
 
 describe("RegisterCustomer StateChangeSlice", () => {
+  // scenario-id: fd616ac0-6ee3-47ef-b74f-212a7befac4a
   test("empty event log produces CustomerRegistered", () =>
     givenEvents([])
-    ->whenCmd(RegisterCustomer({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}))
-    ->thenEvent(
-      CustomerRegistered({customerId: cid("c1"), email: "alice@x.y", address: "123 Main"}),
-    )
+    ->whenCmd(RegisterCustomer({customerId: c1, email: aliceEmail, address: mainStreet}))
+    ->thenEvent(CustomerRegistered({customerId: c1, email: aliceEmail, address: mainStreet}))
   )
 
+  // scenario-id: d99db741-d659-456e-b84f-9af30a7d8a41
   test("existing customer returns CustomerAlreadyRegistered", () =>
     givenEvents([CustomerRegistered])
-    ->whenCmd(RegisterCustomer({customerId: cid("c1"), email: "bob@x.y", address: "456 Oak"}))
+    ->whenCmd(RegisterCustomer({customerId: c1, email: "bob@x.y", address: "456 Oak"}))
     ->thenError(CustomerAlreadyRegistered)
   )
 })

package/lib/ocaml/SendOrderConfirmation_GWT.res

@@ -12,24 +12,25 @@ module SendOrderConfirmationSlice = {
 
 @@reventless.gwt
 
-let cid = CustomerId.make
-let oid = OrderId.make
+open Ordering_Examples
 
 describe("SendOrderConfirmation OutboundTranslationSlice", () => {
   testSync("collect: OrderPlaced queues an outbound TODO", () =>
-    givenEvent(OrderPlaced({orderId: oid("o1"), customerId: cid("c1")}))
+    givenEvent(OrderPlaced({orderId: o1, customerId: c1}))
     ->whenCollect
-    ->thenTodos([("o1", {orderId: oid("o1"), customerId: cid("c1")})])
+    ->thenTodos([("o1", {orderId: o1, customerId: c1})])
   )
 
+  // scenario-id: f72032f8-25ba-482e-be6e-4c765908bb70
   test("translate success marks the TODO Completed", () =>
-    givenTodo("o1", {orderId: oid("o1"), customerId: cid("c1")})
+    givenTodo("o1", {orderId: o1, customerId: c1})
     ->whenTranslateMocked((_id, _item) => Promise.resolve(Ok(None)))
     ->thenTodoStatus("o1", #Completed)
   )
 
+  // scenario-id: a4563058-8777-4756-8e12-983fcd0e8f20
   test("translate failure leaves the TODO Pending for retry", () =>
-    givenTodo("o1", {orderId: oid("o1"), customerId: cid("c1")})
+    givenTodo("o1", {orderId: o1, customerId: c1})
     ->whenTranslateMocked((_id, _item) => Promise.resolve(Error("smtp down")))
     ->thenTodoStatus("o1", #Pending)
   )

package/lib/ocaml/ShipOrder_GWT.res

@@ -1,29 +1,33 @@
 @@reventless.gwt
 
-let oid = OrderId.make
+open Ordering_Examples
 
 describe("ShipOrder StateChangeSlice", () => {
+  // scenario-id: 2146c7ce-d052-4b18-8d15-373916445f80
   test("non-existent order returns OrderNotFound", () =>
     givenEvents([])
-    ->whenCmd(ShipOrder({orderId: oid("o1")}))
+    ->whenCmd(ShipOrder({orderId: o1}))
     ->thenError(OrderNotFound)
   )
 
+  // scenario-id: 76062151-57bb-468b-9fee-915e35e8d67e
   test("placed order produces OrderShipped", () =>
     givenEvents([OrderPlaced])
-    ->whenCmd(ShipOrder({orderId: oid("o1")}))
-    ->thenEvent(OrderShipped({orderId: oid("o1")}))
+    ->whenCmd(ShipOrder({orderId: o1}))
+    ->thenEvent(OrderShipped({orderId: o1}))
   )
 
+  // scenario-id: 3ffc1f1f-8611-4c99-90b3-435b441140d3
   test("already shipped order produces no events (idempotent)", () =>
     givenEvents([OrderPlaced, OrderShipped])
-    ->whenCmd(ShipOrder({orderId: oid("o1")}))
+    ->whenCmd(ShipOrder({orderId: o1}))
     ->thenNoEvent
   )
 
+  // scenario-id: 23a22483-510c-458d-aa40-17c442470b22
   test("cancelled order returns OrderAlreadyCancelled", () =>
     givenEvents([OrderPlaced, OrderCancelled])
-    ->whenCmd(ShipOrder({orderId: oid("o1")}))
+    ->whenCmd(ShipOrder({orderId: o1}))
     ->thenError(OrderAlreadyCancelled)
   )
 })