@reventlessdev/reventless-core 3.0.0-alpha.310 → 3.0.0-alpha.312

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/package.json +6 -6
  3. package/src/Message.res +23 -6
  4. package/src/Message.res.mjs +15 -6
  5. package/src/adapter/Secrets/Secrets_Node_Backend.res +41 -2
  6. package/src/adapter/Secrets/Secrets_Node_Backend.res.mjs +65 -23
  7. package/src/admin/Platform_Admin.res.mjs +0 -2
  8. package/src/components/Aggregate/Aggregate_Callback.res +111 -48
  9. package/src/components/Aggregate/Aggregate_Callback.res.mjs +107 -49
  10. package/src/components/AutomationSlice/AutomationSlice_Callback.res.mjs +2 -2
  11. package/src/components/Builder_Helpers.res +0 -17
  12. package/src/components/Builder_Helpers.res.mjs +0 -15
  13. package/src/components/CommandGenerator/CommandGenerator.res +3 -1
  14. package/src/components/CommandGenerator/CommandGenerator_Callback.res +0 -1
  15. package/src/components/CommandGenerator/CommandGenerator_Callback.res.mjs +0 -2
  16. package/src/components/Counter/Counter_Callback.res.mjs +1 -1
  17. package/src/components/DcbEventLog/DcbEventLog_Operations.res.mjs +1 -1
  18. package/src/components/EventLog/EventLog.res +7 -0
  19. package/src/components/EventLog/EventLog_Builder.res +2 -0
  20. package/src/components/EventLog/EventLog_Builder.res.mjs +1 -0
  21. package/src/components/EventLog/EventLog_Operations.res +30 -0
  22. package/src/components/EventLog/EventLog_Operations.res.mjs +18 -0
  23. package/src/components/Extension/Extension.res +0 -2
  24. package/src/components/Extension/Extension_Builder.res +2 -20
  25. package/src/components/Extension/Extension_Builder.res.mjs +1 -3
  26. package/src/components/Extension/Extension_Operations.res +0 -19
  27. package/src/components/Extension/Extension_Operations.res.mjs +1 -7
  28. package/src/components/Heartbeat/Heartbeat_Callback.res +0 -1
  29. package/src/components/Heartbeat/Heartbeat_Callback.res.mjs +0 -1
  30. package/src/components/InboundTranslationSlice/InboundTranslationSlice_Callback.res.mjs +1 -1
  31. package/src/components/OutboundTranslationSlice/OutboundTranslationSlice_Callback.res.mjs +1 -1
  32. package/src/components/ReadModel/ReadModel_Builder.res +12 -2
  33. package/src/components/ReadModel/ReadModel_Builder.res.mjs +2 -1
  34. package/src/components/StateChangeSlice/StateChangeSlice_Callback.res +72 -35
  35. package/src/components/StateChangeSlice/StateChangeSlice_Callback.res.mjs +45 -31
  36. package/src/components/StateViewSlice/StateViewSlice_Builder.res.mjs +2 -2
  37. package/src/plugin/component/Plugin_Builder.res +1 -26
  38. package/src/plugin/component/Plugin_Builder.res.mjs +6 -20
  39. package/src/plugin/component/Plugin_Helpers.res +0 -37
  40. package/src/plugin/component/Plugin_Helpers.res.mjs +8 -21
  41. package/src/plugin/connect/PluginExtensionPoint_Plugin.res.mjs +1 -1
  42. package/src/util/CommandPublisher.res.mjs +1 -1
  43. package/tests/Secrets_Node_BackendTest.res +32 -0
  44. package/tests/Secrets_Node_BackendTest.res.mjs +29 -1
  45. package/tests/aggregate/AggregateCacheTest.res +6 -0
  46. package/tests/aggregate/AggregateCacheTest.res.mjs +5 -0
  47. package/tests/aggregate/AggregateConflictTest.res +6 -0
  48. package/tests/aggregate/AggregateConflictTest.res.mjs +5 -0
  49. package/tests/aggregate/AggregateFixtures.res +6 -0
  50. package/tests/aggregate/AggregateFixtures.res.mjs +5 -0
  51. package/tests/aggregate/AggregateRepeatTest.res +186 -0
  52. package/tests/aggregate/AggregateRepeatTest.res.mjs +332 -0
  53. package/tests/aggregate/AggregateSnapshotTest.res +6 -0
  54. package/tests/aggregate/AggregateSnapshotTest.res.mjs +12 -0
  55. package/tests/commandgenerator/OwnerActingTest.res +6 -0
  56. package/tests/commandgenerator/OwnerActingTest.res.mjs +5 -0
  57. package/tests/dcb/DcbEventLogOperationsTest.res.mjs +1 -1
  58. package/tests/extensionpoint/DerivedMessageIdTest.res +217 -0
  59. package/tests/extensionpoint/DerivedMessageIdTest.res.mjs +361 -0
  60. package/tests/logger/LogFormatTest.res +1 -2
  61. package/tests/logger/LogFormatTest.res.mjs +2 -3
  62. package/tests/message/MessageTest.res +57 -1
  63. package/tests/message/MessageTest.res.mjs +61 -2
  64. package/tests/message/MetaEnvelopeTest.res +37 -20
  65. package/tests/message/MetaEnvelopeTest.res.mjs +32 -17
  66. package/tests/plugin/HeartbeatDisconnectGraceTest.res.mjs +1 -1
  67. package/tests/plugin/pluginDefinitionRequiredScalars.txt +0 -1
@@ -0,0 +1,361 @@
1
+ // Generated by ReScript, PLEASE EDIT WITH CARE
2
+
3
+ import * as Sury from "sury";
4
+ import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
5
+ import * as Id$Reventless from "@reventlessdev/reventless-spec/src/types/Id.res.mjs";
6
+ import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
7
+ import * as Belt_SetString from "@rescript/runtime/lib/es6/Belt_SetString.js";
8
+ import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
9
+ import * as Message$Reventless from "@reventlessdev/reventless-spec/src/types/Message.res.mjs";
10
+ import * as ExtensionMapping$ReventlessInfra from "@reventlessdev/reventless-infra/src/types/ExtensionMapping.res.mjs";
11
+ import * as ExtensionPointMapping$ReventlessInfra from "@reventlessdev/reventless-infra/src/types/ExtensionPointMapping.res.mjs";
12
+
13
+ let name = "Ordering.Orders";
14
+
15
+ let commandSchema = Sury.literal("Noop");
16
+
17
+ let eventSchema = Sury.$schema(s => ({
18
+ TAG: "ItemOrdered",
19
+ productId: s.m(Sury.string),
20
+ orderId: s.m(Sury.string)
21
+ }));
22
+
23
+ let directiveSchema = Sury.literal("NoDirective");
24
+
25
+ let moduleUrl = import.meta.url;
26
+
27
+ function authorizationOf(param) {
28
+ return "AllowAuthenticated";
29
+ }
30
+
31
+ function commandTransition(param) {
32
+ return "Undeclared";
33
+ }
34
+
35
+ let traits = [];
36
+
37
+ let Port = {
38
+ name: name,
39
+ commandSchema: commandSchema,
40
+ eventSchema: eventSchema,
41
+ directiveSchema: directiveSchema,
42
+ moduleUrl: moduleUrl,
43
+ authorizationOf: authorizationOf,
44
+ commandTransition: commandTransition,
45
+ traits: traits
46
+ };
47
+
48
+ let name$1 = "Order";
49
+
50
+ let commandSchema$1 = Sury.$schema(s => ({
51
+ TAG: "Place",
52
+ orderId: s.m(Sury.string)
53
+ }));
54
+
55
+ let eventSchema$1 = Sury.$schema(s => ({
56
+ TAG: "OrderPlaced",
57
+ orderId: s.m(Sury.string),
58
+ productId: s.m(Sury.string)
59
+ }));
60
+
61
+ let errorSchema = Sury.$unit;
62
+
63
+ let moduleUrl$1 = import.meta.url;
64
+
65
+ function authorizationOf$1(param) {
66
+ return "AllowAuthenticated";
67
+ }
68
+
69
+ function commandTransition$1(param) {
70
+ return "Unrestricted";
71
+ }
72
+
73
+ let traits$1 = [];
74
+
75
+ let Order = {
76
+ Id: undefined,
77
+ name: name$1,
78
+ commandSchema: commandSchema$1,
79
+ eventSchema: eventSchema$1,
80
+ errorSchema: errorSchema,
81
+ moduleUrl: moduleUrl$1,
82
+ authorizationOf: authorizationOf$1,
83
+ commandTransition: commandTransition$1,
84
+ traits: traits$1
85
+ };
86
+
87
+ let name$2 = "RecordProductDemand";
88
+
89
+ let commandSchema$2 = Sury.$schema(s => ({
90
+ TAG: "RecordDemand",
91
+ productId: s.m(Sury.string),
92
+ orderId: s.m(Sury.string)
93
+ }));
94
+
95
+ let eventSchema$2 = Sury.$schema(s => ({
96
+ TAG: "DemandRecorded",
97
+ productId: s.m(Sury.string),
98
+ orderId: s.m(Sury.string)
99
+ }));
100
+
101
+ let errorSchema$1 = Sury.$unit;
102
+
103
+ let moduleUrl$2 = import.meta.url;
104
+
105
+ function authorizationOf$2(param) {
106
+ return "AllowAuthenticated";
107
+ }
108
+
109
+ function commandTransition$2(param) {
110
+ return "Unrestricted";
111
+ }
112
+
113
+ let traits$2 = [];
114
+
115
+ let Demand = {
116
+ Id: undefined,
117
+ name: name$2,
118
+ commandSchema: commandSchema$2,
119
+ eventSchema: eventSchema$2,
120
+ errorSchema: errorSchema$1,
121
+ moduleUrl: moduleUrl$2,
122
+ authorizationOf: authorizationOf$2,
123
+ commandTransition: commandTransition$2,
124
+ traits: traits$2
125
+ };
126
+
127
+ let moduleUrl$3 = import.meta.url;
128
+
129
+ function mapIncomingCommand(_id, _command, _meta) {
130
+ return [];
131
+ }
132
+
133
+ let mapOutgoingEvent = (id, event, _meta, _queryEngine) => [{
134
+ TAG: "PublishEvent",
135
+ _0: id,
136
+ _1: {
137
+ TAG: "ItemOrdered",
138
+ productId: event.productId,
139
+ orderId: event.orderId
140
+ }
141
+ }];
142
+
143
+ let publishedEvents = [];
144
+
145
+ let acceptedCommands = [];
146
+
147
+ let PortMapping = ExtensionPointMapping$ReventlessInfra.Make({
148
+ ExtensionPoint: {
149
+ name: name,
150
+ moduleUrl: moduleUrl,
151
+ commandSchema: commandSchema,
152
+ eventSchema: eventSchema,
153
+ directiveSchema: directiveSchema
154
+ },
155
+ Delegate: {
156
+ Id: Id$Reventless.$$String,
157
+ name: name$1,
158
+ eventSchema: eventSchema$1,
159
+ errorSchema: errorSchema,
160
+ commandSchema: commandSchema$1,
161
+ moduleUrl: moduleUrl$1,
162
+ authorizationOf: authorizationOf$1,
163
+ commandTransition: commandTransition$1,
164
+ traits: traits$1
165
+ },
166
+ moduleUrl: moduleUrl$3,
167
+ mapIncomingCommand: mapIncomingCommand,
168
+ mapOutgoingEvent: mapOutgoingEvent,
169
+ publishedEvents: publishedEvents,
170
+ acceptedCommands: acceptedCommands
171
+ });
172
+
173
+ let moduleUrl$4 = import.meta.url;
174
+
175
+ function mapIncomingEvent(_id, event, _meta, _pluginDef, _queryEngine) {
176
+ let productId = event.productId;
177
+ return [{
178
+ TAG: "PublishAggregateCommand",
179
+ _0: productId,
180
+ _1: {
181
+ TAG: "RecordDemand",
182
+ productId: productId,
183
+ orderId: event.orderId
184
+ }
185
+ }];
186
+ }
187
+
188
+ let handledEvents = [];
189
+
190
+ let issuedCommands = [];
191
+
192
+ let DemandExtension = ExtensionMapping$ReventlessInfra.Make({
193
+ ExtensionPoint: {
194
+ name: name,
195
+ moduleUrl: moduleUrl,
196
+ commandSchema: commandSchema,
197
+ eventSchema: eventSchema,
198
+ directiveSchema: directiveSchema
199
+ },
200
+ Delegate: {
201
+ Id: Id$Reventless.$$String,
202
+ name: name$2,
203
+ eventSchema: eventSchema$2,
204
+ errorSchema: errorSchema$1,
205
+ commandSchema: commandSchema$2,
206
+ moduleUrl: moduleUrl$2,
207
+ authorizationOf: authorizationOf$2,
208
+ commandTransition: commandTransition$2,
209
+ traits: traits$2
210
+ },
211
+ moduleUrl: moduleUrl$4,
212
+ delegateModuleUrl: moduleUrl$2,
213
+ mapIncomingEvent: mapIncomingEvent,
214
+ mapOutgoingEvent: undefined,
215
+ handledEvents: handledEvents,
216
+ issuedCommands: issuedCommands
217
+ });
218
+
219
+ async function queryEngine_scan(param, param$1, param$2) {
220
+ return [];
221
+ }
222
+
223
+ async function queryEngine_query(param, param$1, param$2, param$3, param$4, param$5, param$6) {
224
+ return [];
225
+ }
226
+
227
+ let queryEngine = {
228
+ scan: queryEngine_scan,
229
+ query: queryEngine_query
230
+ };
231
+
232
+ async function createSchedule(param) {
233
+
234
+ }
235
+
236
+ async function deleteSchedule(param) {
237
+
238
+ }
239
+
240
+ let pluginDefinition = {
241
+ id: "Catalog@1",
242
+ name: "Catalog",
243
+ version: "1",
244
+ extensionPoints: [],
245
+ extensions: [{
246
+ name: "Catalog",
247
+ extensionPointName: name
248
+ }],
249
+ eventCollector: "eventCollector",
250
+ extensionProtocols: [],
251
+ apiSchemaFragment: undefined,
252
+ structure: undefined,
253
+ kind: "Domain"
254
+ };
255
+
256
+ let storedMeta_causationId = "place-order-cmd";
257
+
258
+ let storedMeta = {
259
+ service: name$1,
260
+ time: "2024-01-01T00:00:00Z",
261
+ msgId: "order-event-msg",
262
+ correlationId: "place-order-cmd",
263
+ causationId: storedMeta_causationId
264
+ };
265
+
266
+ let storedEventJson$p = Message$Reventless.composeEventJson$p("order-1", storedMeta, Message$Reventless.encode({
267
+ TAG: "OrderPlaced",
268
+ orderId: "order-1",
269
+ productId: "product-1"
270
+ }, eventSchema$1));
271
+
272
+ function msgIdOf(eventJson$p) {
273
+ return Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(eventJson$p), o => o["meta"]), Stdlib_JSON.Decode.object), m => m["msgId"]), Stdlib_JSON.Decode.string), "");
274
+ }
275
+
276
+ function publishOnce() {
277
+ let match = Stdlib_Option.getOrThrow(PortMapping.mapOutgoingEvent, undefined)(storedEventJson$p, createSchedule, deleteSchedule, queryEngine);
278
+ if (match.length !== 1) {
279
+ return Stdlib_JsError.throwWithMessage("expected one published event");
280
+ }
281
+ let match$1 = match[0];
282
+ switch (match$1.TAG) {
283
+ case "AbstractPublishEvent" :
284
+ return [
285
+ match$1._1,
286
+ match$1._2
287
+ ];
288
+ case "AbstractPublishEventAsync" :
289
+ case "AbstractHandleDirective" :
290
+ return Stdlib_JsError.throwWithMessage("expected one published event");
291
+ }
292
+ }
293
+
294
+ function commandOnce(published) {
295
+ let match = DemandExtension.mapIncomingEvent({
296
+ id: "product-1",
297
+ meta: published,
298
+ event: {
299
+ TAG: "ItemOrdered",
300
+ productId: "product-1",
301
+ orderId: "order-1"
302
+ }
303
+ }, pluginDefinition, queryEngine);
304
+ if (match.length !== 1) {
305
+ return Stdlib_JsError.throwWithMessage("expected one delegate command");
306
+ }
307
+ let match$1 = match[0];
308
+ if (match$1.TAG === "AbstractPublishAggregateCommand") {
309
+ return match$1._1;
310
+ } else {
311
+ return Stdlib_JsError.throwWithMessage("expected one delegate command");
312
+ }
313
+ }
314
+
315
+ globalThis.describe("a derived message's id is stable along the chain", () => {
316
+ globalThis.test("the extension point publishes the same msgId for the same stored event", () => {
317
+ let match = publishOnce();
318
+ let firstJson$p = match[1];
319
+ let first = match[0];
320
+ let match$1 = publishOnce();
321
+ globalThis.expect(first.msgId).toBe(match$1[0].msgId);
322
+ globalThis.expect(first.service).toBe(name);
323
+ globalThis.expect(first.causationId).toEqual("order-event-msg");
324
+ globalThis.expect(first.correlationId).toBe("place-order-cmd");
325
+ globalThis.expect(msgIdOf(firstJson$p)).toBe(msgIdOf(match$1[1]));
326
+ globalThis.expect(msgIdOf(firstJson$p)).toBe(first.msgId);
327
+ });
328
+ globalThis.test("the Extension sends the same command msgId for the same published event", () => {
329
+ let match = publishOnce();
330
+ let published = match[0];
331
+ let first = commandOnce(published);
332
+ let again = commandOnce(published);
333
+ globalThis.expect(first.meta.msgId).toBe(again.meta.msgId);
334
+ globalThis.expect(first.meta.service).toBe(name$2);
335
+ globalThis.expect(first.meta.causationId).toEqual(published.msgId);
336
+ globalThis.expect(first.meta.correlationId).toBe("place-order-cmd");
337
+ globalThis.expect(Belt_SetString.size(Belt_SetString.fromArray([
338
+ "order-event-msg",
339
+ published.msgId,
340
+ first.meta.msgId
341
+ ]))).toBe(3);
342
+ });
343
+ });
344
+
345
+ export {
346
+ Port,
347
+ Order,
348
+ Demand,
349
+ PortMapping,
350
+ DemandExtension,
351
+ queryEngine,
352
+ createSchedule,
353
+ deleteSchedule,
354
+ pluginDefinition,
355
+ storedMeta,
356
+ storedEventJson$p,
357
+ msgIdOf,
358
+ publishOnce,
359
+ commandOnce,
360
+ }
361
+ /* commandSchema Not a pure module */
@@ -63,7 +63,6 @@ describe("LogFormat", () => {
63
63
  {
64
64
  name: "testExtension",
65
65
  extensionPointName: "testExtensionPoint",
66
- dcbSources: [],
67
66
  },
68
67
  ],
69
68
  eventCollector: "testEventCollector",
@@ -92,7 +91,7 @@ describe("LogFormat", () => {
92
91
  },
93
92
  )
94
93
  let expected1 = `1/2: \x1b[1mHeartbeat\x1b[0m(0): {"command":{"TAG":"Heartbeat","_0":"0.0.0"},"meta":${metaStr},"id":"0"}`
95
- let expected2 = `2/2: \x1b[1mConnect\x1b[0m(1): {"command":{"TAG":"Connect","_0":{"id":"id","name":"testName","version":"testVersion","extensionPoints":[{"name":"testExtensionPoint","commandTopic":"testCommandTopic","eventTopic":"testEventTopic"}],"extensions":[{"name":"testExtension","extensionPointName":"testExtensionPoint","dcbSources":[]}],"eventCollector":"testEventCollector","extensionProtocols":[],"apiSchemaFragment":null,"structure":null,"kind":"Domain"}},"meta":${metaStr},"id":"1"}`
94
+ let expected2 = `2/2: \x1b[1mConnect\x1b[0m(1): {"command":{"TAG":"Connect","_0":{"id":"id","name":"testName","version":"testVersion","extensionPoints":[{"name":"testExtensionPoint","commandTopic":"testCommandTopic","eventTopic":"testEventTopic"}],"extensions":[{"name":"testExtension","extensionPointName":"testExtensionPoint"}],"eventCollector":"testEventCollector","extensionProtocols":[],"apiSchemaFragment":null,"structure":null,"kind":"Domain"}},"meta":${metaStr},"id":"1"}`
96
95
  expect(commandJsonsToLogMessages(arr))->toEqual([expected1, expected2])
97
96
  },
98
97
  )
@@ -66,8 +66,7 @@ globalThis.describe("LogFormat", () => {
66
66
  }],
67
67
  extensions: [{
68
68
  name: "testExtension",
69
- extensionPointName: "testExtensionPoint",
70
- dcbSources: []
69
+ extensionPointName: "testExtensionPoint"
71
70
  }],
72
71
  eventCollector: "testEventCollector",
73
72
  extensionProtocols: [],
@@ -92,7 +91,7 @@ globalThis.describe("LogFormat", () => {
92
91
  commandJson: Message$ReventlessCore.encode(command, PluginSpec$ReventlessCore.commandSchema)
93
92
  }));
94
93
  let expected1 = `1/2: \x1b[1mHeartbeat\x1b[0m(0): {"command":{"TAG":"Heartbeat","_0":"0.0.0"},"meta":` + metaStr + `,"id":"0"}`;
95
- let expected2 = `2/2: \x1b[1mConnect\x1b[0m(1): {"command":{"TAG":"Connect","_0":{"id":"id","name":"testName","version":"testVersion","extensionPoints":[{"name":"testExtensionPoint","commandTopic":"testCommandTopic","eventTopic":"testEventTopic"}],"extensions":[{"name":"testExtension","extensionPointName":"testExtensionPoint","dcbSources":[]}],"eventCollector":"testEventCollector","extensionProtocols":[],"apiSchemaFragment":null,"structure":null,"kind":"Domain"}},"meta":` + metaStr + `,"id":"1"}`;
94
+ let expected2 = `2/2: \x1b[1mConnect\x1b[0m(1): {"command":{"TAG":"Connect","_0":{"id":"id","name":"testName","version":"testVersion","extensionPoints":[{"name":"testExtensionPoint","commandTopic":"testCommandTopic","eventTopic":"testEventTopic"}],"extensions":[{"name":"testExtension","extensionPointName":"testExtensionPoint"}],"eventCollector":"testEventCollector","extensionProtocols":[],"apiSchemaFragment":null,"structure":null,"kind":"Domain"}},"meta":` + metaStr + `,"id":"1"}`;
96
95
  globalThis.expect(LogFormat$ReventlessCore.commandJsonsToLogMessages(arr)).toEqual([
97
96
  expected1,
98
97
  expected2
@@ -34,7 +34,6 @@ describe("Message should", () => {
34
34
  {
35
35
  name: "testExtension",
36
36
  extensionPointName: "testExtensionPoint",
37
- dcbSources: [],
38
37
  },
39
38
  ],
40
39
  eventCollector: "testEventCollector",
@@ -233,3 +232,60 @@ describe("Message should", () => {
233
232
  }
234
233
  })
235
234
  })
235
+
236
+ // A message a mapping derives from another: the id is a function of the input,
237
+ // so a mapping run again on a redelivered parent mints the same id.
238
+ describe("Message.deriveStableMeta", () => {
239
+ let parent: meta = {
240
+ service: "Order",
241
+ time: "2024-01-01T00:00:00Z",
242
+ msgId: "parent-msg",
243
+ correlationId: "root-msg",
244
+ causationId: "grandparent-msg",
245
+ user: "alice",
246
+ traceparent: "00-trace-span-01",
247
+ headers: Dict.fromArray([("tenantId", "t1")]),
248
+ }
249
+
250
+ testSync("the same input gives the same msgId; a parent's msgId is its child's cause", () => {
251
+ let a = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=0)
252
+ let b = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=0)
253
+ expect(a.msgId)->toBe(b.msgId)
254
+ expect(a.msgId != parent.msgId)->toBe(true)
255
+ expect(a.causationId)->toEqual(Some("parent-msg"))
256
+ expect(a.correlationId)->toBe("root-msg")
257
+ expect(a.service)->toBe("Ordering.Orders")
258
+ expect(a.user)->toEqual(Some("alice"))
259
+ expect(a.traceparent)->toEqual(Some("00-trace-span-01"))
260
+ expect(a.headers->Option.flatMap(h => h->Dict.get("tenantId")))->toEqual(Some("t1"))
261
+ })
262
+
263
+ testSync("a derived message never carries the caller's ip, even from an old parent", () => {
264
+ let a = deriveStableMeta(
265
+ ~parent={...parent, ip: "10.0.0.1"},
266
+ ~service="Ordering.Orders",
267
+ ~index=0,
268
+ )
269
+ expect(a.ip)->toEqual(None)
270
+ })
271
+
272
+ testSync("a different parent, emitter, index or item gives a different msgId", () => {
273
+ let base = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=0)
274
+ let otherParent = deriveStableMeta(
275
+ ~parent={...parent, msgId: "parent-msg-2"},
276
+ ~service="Ordering.Orders",
277
+ ~index=0,
278
+ )
279
+ let otherEmitter = deriveStableMeta(~parent, ~service="Catalog.Products", ~index=0)
280
+ let otherIndex = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=1)
281
+ let otherItem = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=0, ~item=1)
282
+ let ids = [base.msgId, otherParent.msgId, otherEmitter.msgId, otherIndex.msgId, otherItem.msgId]
283
+ expect(ids->Belt.Set.String.fromArray->Belt.Set.String.size)->toBe(5)
284
+ })
285
+
286
+ testSync("a derived message never carries its parent's caller claim", () => {
287
+ let claimed = {...parent, callerClaim: Reventless.Message.CallerClaim.Exempt}
288
+ let a = deriveStableMeta(~parent=claimed, ~service="Ordering.Orders", ~index=0)
289
+ expect(a.callerClaim->Option.isNone)->toBe(true)
290
+ })
291
+ })
@@ -2,6 +2,7 @@
2
2
 
3
3
  import * as Sury from "sury";
4
4
  import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
5
+ import * as Belt_SetString from "@rescript/runtime/lib/es6/Belt_SetString.js";
5
6
  import * as Offload$Reventless from "@reventlessdev/reventless-spec/src/semantic/Offload.res.mjs";
6
7
  import * as Util_Sury$Reventless from "@reventlessdev/reventless-spec/src/util/Util_Sury.res.mjs";
7
8
  import * as Message$ReventlessCore from "../../src/Message.res.mjs";
@@ -36,8 +37,7 @@ globalThis.describe("Message should", () => {
36
37
  }],
37
38
  extensions: [{
38
39
  name: "testExtension",
39
- extensionPointName: "testExtensionPoint",
40
- dcbSources: []
40
+ extensionPointName: "testExtensionPoint"
41
41
  }],
42
42
  eventCollector: "testEventCollector",
43
43
  extensionProtocols: [],
@@ -212,4 +212,63 @@ globalThis.describe("Message should", () => {
212
212
  });
213
213
  });
214
214
 
215
+ globalThis.describe("Message.deriveStableMeta", () => {
216
+ let parent_user = "alice";
217
+ let parent_causationId = "grandparent-msg";
218
+ let parent_traceparent = "00-trace-span-01";
219
+ let parent_headers = Object.fromEntries([[
220
+ "tenantId",
221
+ "t1"
222
+ ]]);
223
+ let parent = {
224
+ service: "Order",
225
+ time: "2024-01-01T00:00:00Z",
226
+ user: parent_user,
227
+ msgId: "parent-msg",
228
+ correlationId: "root-msg",
229
+ causationId: parent_causationId,
230
+ traceparent: parent_traceparent,
231
+ headers: parent_headers
232
+ };
233
+ globalThis.test("the same input gives the same msgId; a parent's msgId is its child's cause", () => {
234
+ let a = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 0, undefined);
235
+ let b = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 0, undefined);
236
+ globalThis.expect(a.msgId).toBe(b.msgId);
237
+ globalThis.expect(a.msgId !== "parent-msg").toBe(true);
238
+ globalThis.expect(a.causationId).toEqual("parent-msg");
239
+ globalThis.expect(a.correlationId).toBe("root-msg");
240
+ globalThis.expect(a.service).toBe("Ordering.Orders");
241
+ globalThis.expect(a.user).toEqual("alice");
242
+ globalThis.expect(a.traceparent).toEqual("00-trace-span-01");
243
+ globalThis.expect(Stdlib_Option.flatMap(a.headers, h => h["tenantId"])).toEqual("t1");
244
+ });
245
+ globalThis.test("a derived message never carries the caller's ip, even from an old parent", () => {
246
+ let newrecord = {...parent};
247
+ let a = Message$ReventlessCore.deriveStableMeta((newrecord.ip = "10.0.0.1", newrecord), "Ordering.Orders", 0, undefined);
248
+ globalThis.expect(a.ip).toEqual(undefined);
249
+ });
250
+ globalThis.test("a different parent, emitter, index or item gives a different msgId", () => {
251
+ let base = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 0, undefined);
252
+ let newrecord = {...parent};
253
+ let otherParent = Message$ReventlessCore.deriveStableMeta((newrecord.msgId = "parent-msg-2", newrecord), "Ordering.Orders", 0, undefined);
254
+ let otherEmitter = Message$ReventlessCore.deriveStableMeta(parent, "Catalog.Products", 0, undefined);
255
+ let otherIndex = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 1, undefined);
256
+ let otherItem = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 0, 1);
257
+ let ids = [
258
+ base.msgId,
259
+ otherParent.msgId,
260
+ otherEmitter.msgId,
261
+ otherIndex.msgId,
262
+ otherItem.msgId
263
+ ];
264
+ globalThis.expect(Belt_SetString.size(Belt_SetString.fromArray(ids))).toBe(5);
265
+ });
266
+ globalThis.test("a derived message never carries its parent's caller claim", () => {
267
+ let newrecord = {...parent};
268
+ newrecord.callerClaim = "Exempt";
269
+ let a = Message$ReventlessCore.deriveStableMeta(newrecord, "Ordering.Orders", 0, undefined);
270
+ globalThis.expect(Stdlib_Option.isNone(a.callerClaim)).toBe(true);
271
+ });
272
+ });
273
+
215
274
  /* Not a pure module */
@@ -44,16 +44,19 @@ describe("Message.meta optional fields:", () => {
44
44
 
45
45
  testSync("all new optional fields round-trip when set", () => {
46
46
  let headers = Dict.fromArray([("tenantId", "t1"), ("feature.x", "on")])
47
- let meta = generateMeta(
48
- ~service="svc",
49
- ~ip="10.0.0.1",
50
- ~user="bob",
51
- ~causationId="parent-msg-id",
52
- ~traceparent="00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
53
- ~correlationId="root-msg-id",
54
- ~schemaVersion="1.2.0",
55
- ~headers,
56
- )
47
+ let meta = {
48
+ ...generateMeta(
49
+ ~service="svc",
50
+ ~user="bob",
51
+ ~causationId="parent-msg-id",
52
+ ~traceparent="00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
53
+ ~correlationId="root-msg-id",
54
+ ~schemaVersion="1.2.0",
55
+ ~headers,
56
+ ),
57
+ // Nothing writes `ip` any more; a message written before still carries it.
58
+ ip: "10.0.0.1",
59
+ }
57
60
  let json = meta->Reventless.Util_Sury.toJson(metaSchema)
58
61
  let decoded = json->Reventless.Util_Sury.fromJson(metaSchema)
59
62
  expect(decoded.ip)->toEqual(Some("10.0.0.1"))->ignore
@@ -95,17 +98,19 @@ describe("Message.deriveMeta:", () => {
95
98
  expect(leaf.causationId)->toEqual(Some(mid.msgId))
96
99
  })
97
100
 
98
- testSync("inherits ip/user/traceparent/schemaVersion/headers from parent", () => {
99
- let parent = generateMeta(
100
- ~service="svc",
101
- ~ip="10.0.0.1",
102
- ~user="alice",
103
- ~traceparent="tp",
104
- ~schemaVersion="1",
105
- ~headers=Dict.fromArray([("k", "v")]),
106
- )
101
+ testSync("inherits user/traceparent/schemaVersion/headers from parent, never ip", () => {
102
+ let parent = {
103
+ ...generateMeta(
104
+ ~service="svc",
105
+ ~user="alice",
106
+ ~traceparent="tp",
107
+ ~schemaVersion="1",
108
+ ~headers=Dict.fromArray([("k", "v")]),
109
+ ),
110
+ ip: "10.0.0.1",
111
+ }
107
112
  let child = deriveMeta(~parent)
108
- expect(child.ip)->toEqual(Some("10.0.0.1"))->ignore
113
+ expect(child.ip)->toEqual(None)->ignore
109
114
  expect(child.user)->toEqual(Some("alice"))->ignore
110
115
  expect(child.traceparent)->toEqual(Some("tp"))->ignore
111
116
  expect(child.schemaVersion)->toEqual(Some("1"))->ignore
@@ -194,3 +199,15 @@ describe("StoredEvent encode/decode round-trip:", () => {
194
199
  },
195
200
  )
196
201
  })
202
+
203
+ describe("reserved envelope keys", () => {
204
+ testSync("dataClass and keyRef are optional, round-trip, and are meta keys", () => {
205
+ let meta = {...generateMeta(~service="svc"), dataClass: "personal", keyRef: "k-1"}
206
+ let decoded =
207
+ meta->Reventless.Util_Sury.toJson(metaSchema)->Reventless.Util_Sury.fromJson(metaSchema)
208
+ expect(decoded.dataClass)->toEqual(Some("personal"))->ignore
209
+ expect(decoded.keyRef)->toEqual(Some("k-1"))->ignore
210
+ expect(generateMeta(~service="svc").dataClass)->toEqual(None)->ignore
211
+ expect(metaKeys->Array.includes("dataClass") && metaKeys->Array.includes("keyRef"))->toBe(true)
212
+ })
213
+ })