@reventlessdev/reventless-core 3.0.0-alpha.311 → 3.0.0-alpha.313

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 (42) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/package.json +6 -6
  3. package/src/Message.res +23 -6
  4. package/src/Message.res.mjs +14 -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/components/Api/SuryToJsonSchema.res +19 -0
  8. package/src/components/Api/SuryToJsonSchema.res.mjs +26 -5
  9. package/src/components/AutomationSlice/AutomationSlice_Callback.res.mjs +2 -2
  10. package/src/components/CommandGenerator/CommandGenerator.res +3 -1
  11. package/src/components/CommandGenerator/CommandGenerator_Callback.res +0 -1
  12. package/src/components/CommandGenerator/CommandGenerator_Callback.res.mjs +0 -2
  13. package/src/components/CommandTopic/CommandTopic_Callback.res +3 -1
  14. package/src/components/CommandTopic/CommandTopic_Callback.res.mjs +2 -1
  15. package/src/components/Counter/Counter_Callback.res.mjs +1 -1
  16. package/src/components/DcbEventLog/DcbEventLog_Operations.res.mjs +1 -1
  17. package/src/components/EventLog/EventLog_Operations.res +1 -1
  18. package/src/components/EventLog/EventLog_Operations.res.mjs +1 -1
  19. package/src/components/Heartbeat/Heartbeat_Callback.res +0 -1
  20. package/src/components/Heartbeat/Heartbeat_Callback.res.mjs +0 -1
  21. package/src/components/InboundTranslationSlice/InboundTranslationSlice_Callback.res.mjs +1 -1
  22. package/src/components/OutboundTranslationSlice/OutboundTranslationSlice_Callback.res.mjs +1 -1
  23. package/src/components/StateViewSlice/StateViewSlice_Builder.res.mjs +2 -2
  24. package/src/plugin/connect/PluginExtensionPoint_Plugin.res.mjs +1 -1
  25. package/src/util/CommandPublisher.res.mjs +1 -1
  26. package/src/util/LogFormat.res +22 -4
  27. package/src/util/LogFormat.res.mjs +26 -5
  28. package/src/util/Logger.res +11 -2
  29. package/src/util/Logger.res.mjs +3 -2
  30. package/tests/Secrets_Node_BackendTest.res +32 -0
  31. package/tests/Secrets_Node_BackendTest.res.mjs +29 -1
  32. package/tests/dcb/DcbEventLogOperationsTest.res.mjs +1 -1
  33. package/tests/logger/LogFormatTest.res +5 -3
  34. package/tests/message/MessageTest.res +9 -0
  35. package/tests/message/MessageTest.res.mjs +5 -0
  36. package/tests/message/MetaEnvelopeTest.res +37 -20
  37. package/tests/message/MetaEnvelopeTest.res.mjs +32 -17
  38. package/tests/pii/PiiMember.res +18 -0
  39. package/tests/pii/PiiMember.res.mjs +59 -0
  40. package/tests/pii/PiiPpxTest.res +128 -0
  41. package/tests/pii/PiiPpxTest.res.mjs +151 -0
  42. package/tests/plugin/HeartbeatDisconnectGraceTest.res.mjs +1 -1
@@ -90,10 +90,10 @@ function Make(RuntimeEnvironment) {
90
90
  try {
91
91
  meta = Util_Sury$Reventless.fromJson(m, Message$ReventlessCore.metaSchema);
92
92
  } catch (exn) {
93
- meta = Message$ReventlessCore.generateMeta(Spec.name, undefined, undefined, undefined, undefined, undefined, undefined, undefined);
93
+ meta = Message$ReventlessCore.generateMeta(Spec.name, undefined, undefined, undefined, undefined, undefined, undefined);
94
94
  }
95
95
  } else {
96
- meta = Message$ReventlessCore.generateMeta(Spec.name, undefined, undefined, undefined, undefined, undefined, undefined, undefined);
96
+ meta = Message$ReventlessCore.generateMeta(Spec.name, undefined, undefined, undefined, undefined, undefined, undefined);
97
97
  }
98
98
  let recordedAt = Stdlib_Option.getOr(Stdlib_Option.flatMap(envelopeDict["recordedAt"], Stdlib_JSON.Decode.string), "");
99
99
  let match = Message$ReventlessCore.splitMessage(rawEvent);
@@ -111,7 +111,7 @@ function Make(Spec) {
111
111
  time: ScheduleOps$ReventlessCore.minutesFromNow(directive._1),
112
112
  payload: JSON.stringify(Message$ReventlessCore.encodeCommand$p({
113
113
  id: id,
114
- meta: Message$ReventlessCore.generateMeta(PluginExtensionPointSpec$ReventlessInfra.name, undefined, "Scheduler", undefined, undefined, undefined, undefined, undefined),
114
+ meta: Message$ReventlessCore.generateMeta(PluginExtensionPointSpec$ReventlessInfra.name, "Scheduler", undefined, undefined, undefined, undefined, undefined),
115
115
  command: "DisconnectPlugin"
116
116
  }, Sury.string, PluginExtensionPointSpec$ReventlessInfra.commandSchema))
117
117
  });
@@ -41,7 +41,7 @@ function Make(Spec) {
41
41
  let commandJson = Message$ReventlessCore.encode(param[1], Spec.commandSchema);
42
42
  return {
43
43
  id: param[0],
44
- meta: Message$ReventlessCore.generateMeta(Spec.name, undefined, Config.user, undefined, undefined, undefined, undefined, undefined),
44
+ meta: Message$ReventlessCore.generateMeta(Spec.name, Config.user, undefined, undefined, undefined, undefined, undefined),
45
45
  commandJson: commandJson
46
46
  };
47
47
  });
@@ -93,7 +93,7 @@ external stringifiedOrAbsent: string => Nullable.t<string> = "%identity"
93
93
  // {"TAG":"Add","name":"Cat 1"} → {name:"Cat 1"}
94
94
  // "Add" (bare string variant) → ""
95
95
  let variantFields = (json: JSON.t): string =>
96
- switch json {
96
+ switch json->Reventless.LogRedaction.redactJson {
97
97
  | Object(dict) =>
98
98
  let fields =
99
99
  dict
@@ -135,9 +135,23 @@ let cmdLabelOfJson = (json: JSON.t): string => {
135
135
  let cmdDetailNoId = (msg: Message.commandJson): string => msg.commandJson->cmdLabelOfJson
136
136
 
137
137
  // "{\"command\":{...},\"meta\":{...},\"id\":\"1\"}" (full envelope with meta, no summary prefix)
138
+ /** The envelope as a log line prints it: without the caller's address, which is
139
+ personal data, and without the header bag, which holds whatever a caller put
140
+ in it. */
141
+ let metaForLog = (meta: JSON.t): JSON.t =>
142
+ switch meta {
143
+ | Object(obj) =>
144
+ obj
145
+ ->Dict.toArray
146
+ ->Array.filter(((k, _)) => k != "ip" && k != "headers")
147
+ ->Dict.fromArray
148
+ ->JSON.Encode.object
149
+ | other => other
150
+ }
151
+
138
152
  let cmdFull = (msg: Message.commandJson): string => {
139
- let commandStr = msg.commandJson->JSON.stringify
140
- let metaStr = msg.meta->Message.encode(Message.metaSchema)->JSON.stringify
153
+ let commandStr = msg.commandJson->Reventless.LogRedaction.redactJson->JSON.stringify
154
+ let metaStr = msg.meta->Message.encode(Message.metaSchema)->metaForLog->JSON.stringify
141
155
  `{"command":${commandStr},"meta":${metaStr},"id":"${msg.id}"}`
142
156
  }
143
157
 
@@ -178,7 +192,11 @@ let eventDetails = (events: array<JSON.t>): string =>
178
192
 
179
193
  // "{\"event\":{...},\"meta\":{...},\"id\":\"1\"}" (full envelope with meta, no summary prefix)
180
194
  let eventFull = (j: JSON.t): string => {
181
- let (id, metaStr, eventStr) = j->Message.idMetaEventOfEvent'Json
195
+ let (id, _, _) = j->Message.idMetaEventOfEvent'Json
196
+ let part = key =>
197
+ j->JSON.Decode.object->Option.flatMap(d => d->Dict.get(key))->Option.getOr(JSON.Encode.null)
198
+ let eventStr = part("event")->Reventless.LogRedaction.redactJson->JSON.stringify
199
+ let metaStr = part("meta")->metaForLog->JSON.stringify
182
200
  `{"event":${eventStr},"meta":${metaStr},"id":"${id}"}`
183
201
  }
184
202
 
@@ -8,6 +8,7 @@ import * as Primitive_option from "@rescript/runtime/lib/es6/Primitive_option.js
8
8
  import * as AnsiStyle$Reventless from "@reventlessdev/reventless-spec/src/AnsiStyle.res.mjs";
9
9
  import * as Util_Sury$Reventless from "@reventlessdev/reventless-spec/src/util/Util_Sury.res.mjs";
10
10
  import * as Message$ReventlessCore from "../Message.res.mjs";
11
+ import * as LogRedaction$Reventless from "@reventlessdev/reventless-spec/src/util/LogRedaction.res.mjs";
11
12
 
12
13
  let maxValueChars = Stdlib_Option.getOr(Stdlib_Option.flatMap(process.env["REVENTLESS_LOG_MAX_VALUE"], v => Stdlib_Int.fromString(v, undefined)), 512);
13
14
 
@@ -37,10 +38,11 @@ function cmdSummaries(msgs) {
37
38
  }
38
39
 
39
40
  function variantFields(json) {
40
- if (typeof json !== "object" || json === null || Array.isArray(json)) {
41
+ let dict = LogRedaction$Reventless.redactJson(json);
42
+ if (typeof dict !== "object" || dict === null || Array.isArray(dict)) {
41
43
  return "";
42
44
  }
43
- let fields = Stdlib_Array.filterMap(Object.entries(json).filter(param => param[0] !== "TAG"), param => {
45
+ let fields = Stdlib_Array.filterMap(Object.entries(dict).filter(param => param[0] !== "TAG"), param => {
44
46
  let k = param[0];
45
47
  return Stdlib_Option.map(Primitive_option.fromNullable(JSON.stringify(param[1])), s => k + `:` + truncate(s));
46
48
  }).join(",");
@@ -69,9 +71,24 @@ function cmdDetailNoId(msg) {
69
71
  return cmdLabelOfJson(msg.commandJson);
70
72
  }
71
73
 
74
+ function metaForLog(meta) {
75
+ if (typeof meta === "object" && meta !== null && !Array.isArray(meta)) {
76
+ return Object.fromEntries(Object.entries(meta).filter(param => {
77
+ let k = param[0];
78
+ if (k !== "ip") {
79
+ return k !== "headers";
80
+ } else {
81
+ return false;
82
+ }
83
+ }));
84
+ } else {
85
+ return meta;
86
+ }
87
+ }
88
+
72
89
  function cmdFull(msg) {
73
- let commandStr = JSON.stringify(msg.commandJson);
74
- let metaStr = JSON.stringify(Message$ReventlessCore.encode(msg.meta, Message$ReventlessCore.metaSchema));
90
+ let commandStr = JSON.stringify(LogRedaction$Reventless.redactJson(msg.commandJson));
91
+ let metaStr = JSON.stringify(metaForLog(Message$ReventlessCore.encode(msg.meta, Message$ReventlessCore.metaSchema)));
75
92
  return `{"command":` + commandStr + `,"meta":` + metaStr + `,"id":"` + msg.id + `"}`;
76
93
  }
77
94
 
@@ -108,7 +125,10 @@ function eventDetails(events) {
108
125
 
109
126
  function eventFull(j) {
110
127
  let match = Message$ReventlessCore.idMetaEventOfEvent$pJson(j);
111
- return `{"event":` + match[2] + `,"meta":` + match[1] + `,"id":"` + match[0] + `"}`;
128
+ let part = key => Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(j), d => d[key]), null);
129
+ let eventStr = JSON.stringify(LogRedaction$Reventless.redactJson(part("event")));
130
+ let metaStr = JSON.stringify(metaForLog(part("meta")));
131
+ return `{"event":` + eventStr + `,"meta":` + metaStr + `,"id":"` + match[0] + `"}`;
112
132
  }
113
133
 
114
134
  function eventFulls(events) {
@@ -248,6 +268,7 @@ export {
248
268
  cmdDetails,
249
269
  cmdLabelOfJson,
250
270
  cmdDetailNoId,
271
+ metaForLog,
251
272
  cmdFull,
252
273
  cmdFulls,
253
274
  eventName,
@@ -148,7 +148,13 @@ let emit = (
148
148
  ->Array.concat(pluginField->Option.mapOr([], p => [("plugin", JSON.Encode.string(p))]))
149
149
  ->Array.concat(comp->Option.mapOr([], c => [("comp", JSON.Encode.string(c))]))
150
150
  ->Array.concat(annotationFields)
151
- ->Array.concat(detail->Option.mapOr([], d => [("detail", truncateDetail(d))]))
151
+ // Redacted before anything else: a personal value must not reach a log
152
+ // group, which cannot be swept for one person (`LogRedaction`).
153
+ ->Array.concat(
154
+ detail->Option.mapOr([], d => [
155
+ ("detail", d->Reventless.LogRedaction.redactJson->truncateDetail),
156
+ ]),
157
+ )
152
158
  Console.log(fields->Dict.fromArray->JSON.Encode.object->JSON.stringify)
153
159
  } else {
154
160
  // Terminal — colored, human-readable, no detail
@@ -179,7 +185,10 @@ let setDefaultMinLevel = (l: level) => defaultMinLevel := l
179
185
  let makeLoggerWith = (shouldLog: level => bool): t => {
180
186
  let log = (level, ~comp=?, ~data=?, msg) =>
181
187
  if shouldLog(level) {
182
- let dataStr = data->Option.map(d => ` ${d->JSON.stringify}`)->Option.getOr("")
188
+ let dataStr =
189
+ data
190
+ ->Option.map(d => ` ${d->Reventless.LogRedaction.redactJson->JSON.stringify}`)
191
+ ->Option.getOr("")
183
192
  emit(~level, ~comp?, `${msg}${dataStr}`)
184
193
  }
185
194
  {
@@ -4,6 +4,7 @@ import * as Stdlib_Int from "@rescript/runtime/lib/es6/Stdlib_Int.js";
4
4
  import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
5
5
  import * as AnsiStyle$Reventless from "@reventlessdev/reventless-spec/src/AnsiStyle.res.mjs";
6
6
  import * as LogPrefix$Reventless from "@reventlessdev/reventless-spec/src/LogPrefix.res.mjs";
7
+ import * as LogRedaction$Reventless from "@reventlessdev/reventless-spec/src/util/LogRedaction.res.mjs";
7
8
 
8
9
  function serviceName() {
9
10
  let s = process.env.REVENTLESS_SERVICE;
@@ -119,7 +120,7 @@ function emit(level, comp, plugin, detail, annotations, msg) {
119
120
  c
120
121
  ]])).concat(annotationFields).concat(Stdlib_Option.mapOr(detail, [], d => [[
121
122
  "detail",
122
- truncateDetail(d)
123
+ truncateDetail(LogRedaction$Reventless.redactJson(d))
123
124
  ]]));
124
125
  console.log(JSON.stringify(Object.fromEntries(fields)));
125
126
  return;
@@ -155,7 +156,7 @@ function makeLoggerWith(shouldLog) {
155
156
  if (!shouldLog(level)) {
156
157
  return;
157
158
  }
158
- let dataStr = Stdlib_Option.getOr(Stdlib_Option.map(data, d => ` ` + JSON.stringify(d)), "");
159
+ let dataStr = Stdlib_Option.getOr(Stdlib_Option.map(data, d => ` ` + JSON.stringify(LogRedaction$Reventless.redactJson(d))), "");
159
160
  emit(level, comp, undefined, undefined, undefined, msg + dataStr);
160
161
  };
161
162
  return {
@@ -139,3 +139,35 @@ describe("Secrets.fixed", () => {
139
139
  expect(provider.hash("known"))->toEqual(Ok("hashed:known"))
140
140
  )
141
141
  })
142
+
143
+ describe("fingerprint", () => {
144
+ let key = "0123456789abcdef0123456789abcdef"
145
+ let keyed = Secrets_Node_Backend.make(~fingerprintKey=() => Some(key))
146
+
147
+ testSync("is deterministic, keyed and never the input", () => {
148
+ let a = keyed.fingerprint(~purpose="contactAddress", "alice@example.com")
149
+ expect(a)->toEqual(keyed.fingerprint(~purpose="contactAddress", "alice@example.com"))
150
+ switch a {
151
+ | Ok(value) =>
152
+ expect(value->String.includes("alice"))->toBe(false)
153
+ expect(value->String.length)->toBe(64)
154
+ | Error(_) => fail("expected a fingerprint")
155
+ }
156
+ let other = Secrets_Node_Backend.make(~fingerprintKey=() => Some(key ++ "-other"))
157
+ expect(other.fingerprint(~purpose="contactAddress", "alice@example.com") == a)->toBe(false)
158
+ })
159
+
160
+ testSync("two purposes never share a fingerprint", () =>
161
+ expect(
162
+ keyed.fingerprint(~purpose="contactAddress", "x") ==
163
+ keyed.fingerprint(~purpose="sourceAddress", "x"),
164
+ )->toBe(false)
165
+ )
166
+
167
+ testSync("is refused, never degraded, without a key or with a short one", () => {
168
+ let none = Secrets_Node_Backend.make(~fingerprintKey=() => None)
169
+ expect(none.fingerprint(~purpose="p", "x")->Result.isError)->toBe(true)
170
+ let short = Secrets_Node_Backend.make(~fingerprintKey=() => Some("short"))
171
+ expect(short.fingerprint(~purpose="p", "x")->Result.isError)->toBe(true)
172
+ })
173
+ })
@@ -1,5 +1,6 @@
1
1
  // Generated by ReScript, PLEASE EDIT WITH CARE
2
2
 
3
+ import * as JestGlobals from "@reventlessdev/rescript-jest/src/JestGlobals.res.mjs";
3
4
  import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
4
5
  import * as Primitive_int from "@rescript/runtime/lib/es6/Primitive_int.js";
5
6
  import * as Stdlib_Result from "@rescript/runtime/lib/es6/Stdlib_Result.js";
@@ -125,7 +126,7 @@ globalThis.describe("Capabilities.none.secrets", () => {
125
126
  });
126
127
 
127
128
  globalThis.describe("Secrets.fixed", () => {
128
- let provider = Secrets$Reventless.fixed("known", input => `hashed:` + input);
129
+ let provider = Secrets$Reventless.fixed("known", input => `hashed:` + input, undefined);
129
130
  globalThis.test("hands back the token it was built with", () => {
130
131
  globalThis.expect(provider.randomToken(32, "UrlSafe")).toEqual({
131
132
  TAG: "Ok",
@@ -140,6 +141,33 @@ globalThis.describe("Secrets.fixed", () => {
140
141
  });
141
142
  });
142
143
 
144
+ globalThis.describe("fingerprint", () => {
145
+ let key = "0123456789abcdef0123456789abcdef";
146
+ let keyed = Secrets_Node_Backend$ReventlessCore.make(() => key);
147
+ globalThis.test("is deterministic, keyed and never the input", () => {
148
+ let a = keyed.fingerprint("contactAddress", "alice@example.com");
149
+ globalThis.expect(a).toEqual(keyed.fingerprint("contactAddress", "alice@example.com"));
150
+ if (a.TAG === "Ok") {
151
+ let value = a._0;
152
+ globalThis.expect(value.includes("alice")).toBe(false);
153
+ globalThis.expect(value.length).toBe(64);
154
+ } else {
155
+ JestGlobals.fail("expected a fingerprint");
156
+ }
157
+ let other = Secrets_Node_Backend$ReventlessCore.make(() => key + "-other");
158
+ globalThis.expect(Primitive_object.equal(other.fingerprint("contactAddress", "alice@example.com"), a)).toBe(false);
159
+ });
160
+ globalThis.test("two purposes never share a fingerprint", () => {
161
+ globalThis.expect(Primitive_object.equal(keyed.fingerprint("contactAddress", "x"), keyed.fingerprint("sourceAddress", "x"))).toBe(false);
162
+ });
163
+ globalThis.test("is refused, never degraded, without a key or with a short one", () => {
164
+ let none = Secrets_Node_Backend$ReventlessCore.make(() => {});
165
+ globalThis.expect(Stdlib_Result.isError(none.fingerprint("p", "x"))).toBe(true);
166
+ let short = Secrets_Node_Backend$ReventlessCore.make(() => "short");
167
+ globalThis.expect(Stdlib_Result.isError(short.fingerprint("p", "x"))).toBe(true);
168
+ });
169
+ });
170
+
143
171
  let Secrets;
144
172
 
145
173
  let Backend;
@@ -43,7 +43,7 @@ function encodeEvent(event) {
43
43
  let json = Util_Sury$Reventless.toJson(event, DcbFixtures$ReventlessCore.TestEventLogSpec.eventSchema);
44
44
  let match = Message$ReventlessCore.splitMessage(json);
45
45
  let tags = DcbTag$Reventless.extractTags(DcbFixtures$ReventlessCore.TestEventLogSpec.eventSchema, event);
46
- let meta = Message$ReventlessCore.generateMeta("test", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
46
+ let meta = Message$ReventlessCore.generateMeta("test", undefined, undefined, undefined, undefined, undefined, undefined);
47
47
  return {
48
48
  eventType: match[0],
49
49
  data: match[1],
@@ -29,7 +29,8 @@ describe("LogFormat", () => {
29
29
  msgId: "testMsgId",
30
30
  correlationId: "testCorrelationId",
31
31
  }
32
- let metaStr = meta->Message.encode(Message.metaSchema)->JSON.stringify
32
+ // Printed without the caller's address and the header bag.
33
+ let metaStr = meta->Message.encode(Message.metaSchema)->LogFormat.metaForLog->JSON.stringify
33
34
  let arr: array<Message.commandJson> = commands->Array.mapWithIndex(
34
35
  (command, idx) => {
35
36
  {
@@ -80,7 +81,8 @@ describe("LogFormat", () => {
80
81
  msgId: "testMsgId",
81
82
  correlationId: "testCorrelationId",
82
83
  }
83
- let metaStr = meta->Message.encode(Message.metaSchema)->JSON.stringify
84
+ // Printed without the caller's address and the header bag.
85
+ let metaStr = meta->Message.encode(Message.metaSchema)->LogFormat.metaForLog->JSON.stringify
84
86
  let arr: array<Message.commandJson> = commands->Array.mapWithIndex(
85
87
  (command, idx) => {
86
88
  {
@@ -118,7 +120,7 @@ describe("LogFormat", () => {
118
120
 
119
121
  // sury 11 (alpha.8) serialises meta keys in a different order than alpha.4
120
122
  // (msgId/correlationId before ip/user) — same data, JSON-equivalent.
121
- let expected = `\x1b[1mVersionDetected\x1b[0m(testId): {"event":{"TAG":"VersionDetected","_0":"0.0.0"},"meta":{"service":"testService","time":"testTime","msgId":"testMsgId","correlationId":"testCorrelationId","ip":"testIp","user":"testUser"},"id":"testId"}`
123
+ let expected = `\x1b[1mVersionDetected\x1b[0m(testId): {"event":{"TAG":"VersionDetected","_0":"0.0.0"},"meta":{"service":"testService","time":"testTime","msgId":"testMsgId","correlationId":"testCorrelationId","user":"testUser"},"id":"testId"}`
122
124
 
123
125
  expect(msg)->toEqual(expected)
124
126
  },
@@ -260,6 +260,15 @@ describe("Message.deriveStableMeta", () => {
260
260
  expect(a.headers->Option.flatMap(h => h->Dict.get("tenantId")))->toEqual(Some("t1"))
261
261
  })
262
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
+
263
272
  testSync("a different parent, emitter, index or item gives a different msgId", () => {
264
273
  let base = deriveStableMeta(~parent, ~service="Ordering.Orders", ~index=0)
265
274
  let otherParent = deriveStableMeta(
@@ -242,6 +242,11 @@ globalThis.describe("Message.deriveStableMeta", () => {
242
242
  globalThis.expect(a.traceparent).toEqual("00-trace-span-01");
243
243
  globalThis.expect(Stdlib_Option.flatMap(a.headers, h => h["tenantId"])).toEqual("t1");
244
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
+ });
245
250
  globalThis.test("a different parent, emitter, index or item gives a different msgId", () => {
246
251
  let base = Message$ReventlessCore.deriveStableMeta(parent, "Ordering.Orders", 0, undefined);
247
252
  let newrecord = {...parent};
@@ -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
+ })
@@ -8,7 +8,7 @@ import * as Message$ReventlessCore from "../../src/Message.res.mjs";
8
8
 
9
9
  globalThis.describe("Message.meta optional fields:", () => {
10
10
  globalThis.test("generateMeta() with no ~ip/~user omits those keys from JSON", () => {
11
- let meta = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
11
+ let meta = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined);
12
12
  let json = Util_Sury$Reventless.toJson(meta, Message$ReventlessCore.metaSchema);
13
13
  let obj = Stdlib_Option.getOrThrow(Stdlib_JSON.Decode.object(json), undefined);
14
14
  globalThis.expect(obj["ip"]).toEqual(undefined);
@@ -23,11 +23,11 @@ globalThis.describe("Message.meta optional fields:", () => {
23
23
  globalThis.expect(Stdlib_Option.isSome(obj["correlationId"])).toBe(true);
24
24
  });
25
25
  globalThis.test("generateMeta() correlationId defaults to msgId", () => {
26
- let meta = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
26
+ let meta = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined);
27
27
  globalThis.expect(meta.correlationId).toBe(meta.msgId);
28
28
  });
29
29
  globalThis.test("generateMeta(~user=alice) round-trips Some(alice)", () => {
30
- let meta = Message$ReventlessCore.generateMeta("svc", undefined, "alice", undefined, undefined, undefined, undefined, undefined);
30
+ let meta = Message$ReventlessCore.generateMeta("svc", "alice", undefined, undefined, undefined, undefined, undefined);
31
31
  let json = Util_Sury$Reventless.toJson(meta, Message$ReventlessCore.metaSchema);
32
32
  let decoded = Util_Sury$Reventless.fromJson(json, Message$ReventlessCore.metaSchema);
33
33
  globalThis.expect(decoded.user).toEqual("alice");
@@ -43,8 +43,9 @@ globalThis.describe("Message.meta optional fields:", () => {
43
43
  "on"
44
44
  ]
45
45
  ]);
46
- let meta = Message$ReventlessCore.generateMeta("svc", "10.0.0.1", "bob", "parent-msg-id", "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01", "root-msg-id", "1.2.0", headers);
47
- let json = Util_Sury$Reventless.toJson(meta, Message$ReventlessCore.metaSchema);
46
+ let newrecord = {...Message$ReventlessCore.generateMeta("svc", "bob", "parent-msg-id", "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01", "root-msg-id", "1.2.0", headers)};
47
+ newrecord.ip = "10.0.0.1";
48
+ let json = Util_Sury$Reventless.toJson(newrecord, Message$ReventlessCore.metaSchema);
48
49
  let decoded = Util_Sury$Reventless.fromJson(json, Message$ReventlessCore.metaSchema);
49
50
  globalThis.expect(decoded.ip).toEqual("10.0.0.1");
50
51
  globalThis.expect(decoded.user).toEqual("bob");
@@ -58,37 +59,38 @@ globalThis.describe("Message.meta optional fields:", () => {
58
59
 
59
60
  globalThis.describe("Message.deriveMeta:", () => {
60
61
  globalThis.test("emits a new msgId distinct from the parent", () => {
61
- let parent = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
62
+ let parent = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined);
62
63
  let child = Message$ReventlessCore.deriveMeta(parent, undefined);
63
64
  globalThis.expect(child.msgId === parent.msgId).toBe(false);
64
65
  });
65
66
  globalThis.test("sets causationId = parent.msgId", () => {
66
- let parent = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
67
+ let parent = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined);
67
68
  let child = Message$ReventlessCore.deriveMeta(parent, undefined);
68
69
  globalThis.expect(child.causationId).toEqual(parent.msgId);
69
70
  });
70
71
  globalThis.test("inherits correlationId (chain-root id stays stable)", () => {
71
- let root = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
72
+ let root = Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined);
72
73
  let mid = Message$ReventlessCore.deriveMeta(root, undefined);
73
74
  let leaf = Message$ReventlessCore.deriveMeta(mid, undefined);
74
75
  globalThis.expect(mid.correlationId).toBe(root.correlationId);
75
76
  globalThis.expect(leaf.correlationId).toBe(root.correlationId);
76
77
  globalThis.expect(leaf.causationId).toEqual(mid.msgId);
77
78
  });
78
- globalThis.test("inherits ip/user/traceparent/schemaVersion/headers from parent", () => {
79
- let parent = Message$ReventlessCore.generateMeta("svc", "10.0.0.1", "alice", undefined, "tp", undefined, "1", Object.fromEntries([[
79
+ globalThis.test("inherits user/traceparent/schemaVersion/headers from parent, never ip", () => {
80
+ let newrecord = {...Message$ReventlessCore.generateMeta("svc", "alice", undefined, "tp", undefined, "1", Object.fromEntries([[
80
81
  "k",
81
82
  "v"
82
- ]]));
83
- let child = Message$ReventlessCore.deriveMeta(parent, undefined);
84
- globalThis.expect(child.ip).toEqual("10.0.0.1");
83
+ ]]))};
84
+ newrecord.ip = "10.0.0.1";
85
+ let child = Message$ReventlessCore.deriveMeta(newrecord, undefined);
86
+ globalThis.expect(child.ip).toEqual(undefined);
85
87
  globalThis.expect(child.user).toEqual("alice");
86
88
  globalThis.expect(child.traceparent).toEqual("tp");
87
89
  globalThis.expect(child.schemaVersion).toEqual("1");
88
90
  globalThis.expect(Stdlib_Option.getOr(child.headers, {})["k"]).toEqual("v");
89
91
  });
90
92
  globalThis.test("~service overrides parent's service; defaults to parent's service", () => {
91
- let parent = Message$ReventlessCore.generateMeta("parent-svc", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
93
+ let parent = Message$ReventlessCore.generateMeta("parent-svc", undefined, undefined, undefined, undefined, undefined, undefined);
92
94
  let inherited = Message$ReventlessCore.deriveMeta(parent, undefined);
93
95
  let overridden = Message$ReventlessCore.deriveMeta(parent, "child-svc");
94
96
  globalThis.expect(inherited.service).toBe("parent-svc");
@@ -98,7 +100,7 @@ globalThis.describe("Message.deriveMeta:", () => {
98
100
 
99
101
  globalThis.describe("StoredEvent encode/decode round-trip:", () => {
100
102
  globalThis.test("aggregate-style record (no tags) round-trips through the flat-dict bridge", () => {
101
- let meta = Message$ReventlessCore.generateMeta("catalog", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
103
+ let meta = Message$ReventlessCore.generateMeta("catalog", undefined, undefined, undefined, undefined, undefined, undefined);
102
104
  let stored_data = Object.fromEntries([
103
105
  [
104
106
  "itemId",
@@ -128,7 +130,7 @@ globalThis.describe("StoredEvent encode/decode round-trip:", () => {
128
130
  globalThis.expect(roundTrip.tags).toEqual(undefined);
129
131
  });
130
132
  globalThis.test("DCB-style record (with tags) round-trips and preserves the tag list", () => {
131
- let meta = Message$ReventlessCore.generateMeta("catalog", undefined, undefined, "cmd-1", undefined, undefined, undefined, undefined);
133
+ let meta = Message$ReventlessCore.generateMeta("catalog", undefined, "cmd-1", undefined, undefined, undefined, undefined);
132
134
  let stored_data = Object.fromEntries([[
133
135
  "productId",
134
136
  "p-1"
@@ -165,7 +167,7 @@ globalThis.describe("StoredEvent encode/decode round-trip:", () => {
165
167
  globalThis.expect(first.value).toBe("p-1");
166
168
  });
167
169
  globalThis.test("meta is flattened to top-level keys in the on-disk JSON (DynamoDB GSI projectability)", () => {
168
- let meta = Message$ReventlessCore.generateMeta("catalog", undefined, undefined, undefined, undefined, undefined, undefined, undefined);
170
+ let meta = Message$ReventlessCore.generateMeta("catalog", undefined, undefined, undefined, undefined, undefined, undefined);
169
171
  let stored_data = {};
170
172
  let stored = {
171
173
  id: "agg-1",
@@ -186,4 +188,17 @@ globalThis.describe("StoredEvent encode/decode round-trip:", () => {
186
188
  });
187
189
  });
188
190
 
191
+ globalThis.describe("reserved envelope keys", () => {
192
+ globalThis.test("dataClass and keyRef are optional, round-trip, and are meta keys", () => {
193
+ let newrecord = {...Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined)};
194
+ newrecord.keyRef = "k-1";
195
+ newrecord.dataClass = "personal";
196
+ let decoded = Util_Sury$Reventless.fromJson(Util_Sury$Reventless.toJson(newrecord, Message$ReventlessCore.metaSchema), Message$ReventlessCore.metaSchema);
197
+ globalThis.expect(decoded.dataClass).toEqual("personal");
198
+ globalThis.expect(decoded.keyRef).toEqual("k-1");
199
+ globalThis.expect(Message$ReventlessCore.generateMeta("svc", undefined, undefined, undefined, undefined, undefined, undefined).dataClass).toEqual(undefined);
200
+ globalThis.expect(Message$ReventlessCore.metaKeys.includes("dataClass") && Message$ReventlessCore.metaKeys.includes("keyRef")).toBe(true);
201
+ });
202
+ });
203
+
189
204
  /* Not a pure module */
@@ -0,0 +1,18 @@
1
+ // Fixture: a spec whose event and command mark personal fields with `@pii`.
2
+
3
+ @@reventless.spec("PiiMember")
4
+
5
+ @schema
6
+ type event =
7
+ | MemberJoined({
8
+ @owner memberId: string,
9
+ @pii name: string,
10
+ @pii bio?: string,
11
+ @pii nickname: option<string>,
12
+ @pii address: Reventless.Email.t,
13
+ @pii({subject: "memberId"}) @storageRef("photos") photo: string,
14
+ })
15
+ | InvitationSent({invitationId: string, @pii("invitationId") invitee: Reventless.Email.t})
16
+
17
+ @schema
18
+ type command = Join({@owner memberId: string, @pii name: string, @pii address: Reventless.Email.t})
@@ -0,0 +1,59 @@
1
+ // Generated by ReScript, PLEASE EDIT WITH CARE
2
+
3
+ import * as Sury from "sury";
4
+ import * as Pii$Reventless from "@reventlessdev/reventless-spec/src/components/Pii.res.mjs";
5
+ import * as Email$Reventless from "@reventlessdev/reventless-spec/src/semantic/Email.res.mjs";
6
+ import * as Owner$Reventless from "@reventlessdev/reventless-spec/src/components/Owner.res.mjs";
7
+ import * as StorageRef$Reventless from "@reventlessdev/reventless-spec/src/semantic/StorageRef.res.mjs";
8
+
9
+ let eventSchema = Sury.union([
10
+ Sury.$schema(s => ({
11
+ TAG: "MemberJoined",
12
+ memberId: s.m(Owner$Reventless.string),
13
+ name: s.m(Pii$Reventless.marked("memberId", undefined, Sury.string)),
14
+ bio: s.m(Sury.$option(Pii$Reventless.marked("memberId", undefined, Sury.string))),
15
+ nickname: s.m(Sury.$option(Pii$Reventless.marked("memberId", undefined, Sury.string))),
16
+ address: s.m(Pii$Reventless.marked("memberId", undefined, Email$Reventless.schema)),
17
+ photo: s.m(Pii$Reventless.marked("memberId", true, StorageRef$Reventless.forStore(undefined, "photos")))
18
+ })),
19
+ Sury.$schema(s => ({
20
+ TAG: "InvitationSent",
21
+ invitationId: s.m(Sury.string),
22
+ invitee: s.m(Pii$Reventless.marked("invitationId", undefined, Email$Reventless.schema))
23
+ }))
24
+ ]);
25
+
26
+ let commandSchema = Sury.$schema(s => ({
27
+ TAG: "Join",
28
+ memberId: s.m(Owner$Reventless.string),
29
+ name: s.m(Pii$Reventless.mark("memberId", undefined, Sury.string)),
30
+ address: s.m(Pii$Reventless.mark("memberId", undefined, Email$Reventless.schema))
31
+ }));
32
+
33
+ function authorizationOf(param) {
34
+ return "AllowAuthenticated";
35
+ }
36
+
37
+ function commandTransition(param) {
38
+ return "Undeclared";
39
+ }
40
+
41
+ let traits = [];
42
+
43
+ let name = "PiiMember";
44
+
45
+ let Id;
46
+
47
+ let moduleUrl = "@reventlessdev/reventless-core/tests/pii/PiiMember.res.mjs";
48
+
49
+ export {
50
+ name,
51
+ Id,
52
+ eventSchema,
53
+ commandSchema,
54
+ moduleUrl,
55
+ authorizationOf,
56
+ commandTransition,
57
+ traits,
58
+ }
59
+ /* eventSchema Not a pure module */