@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.
- package/CHANGELOG.md +40 -0
- package/package.json +6 -6
- package/src/Message.res +23 -6
- package/src/Message.res.mjs +14 -6
- package/src/adapter/Secrets/Secrets_Node_Backend.res +41 -2
- package/src/adapter/Secrets/Secrets_Node_Backend.res.mjs +65 -23
- package/src/components/Api/SuryToJsonSchema.res +19 -0
- package/src/components/Api/SuryToJsonSchema.res.mjs +26 -5
- package/src/components/AutomationSlice/AutomationSlice_Callback.res.mjs +2 -2
- package/src/components/CommandGenerator/CommandGenerator.res +3 -1
- package/src/components/CommandGenerator/CommandGenerator_Callback.res +0 -1
- package/src/components/CommandGenerator/CommandGenerator_Callback.res.mjs +0 -2
- package/src/components/CommandTopic/CommandTopic_Callback.res +3 -1
- package/src/components/CommandTopic/CommandTopic_Callback.res.mjs +2 -1
- package/src/components/Counter/Counter_Callback.res.mjs +1 -1
- package/src/components/DcbEventLog/DcbEventLog_Operations.res.mjs +1 -1
- package/src/components/EventLog/EventLog_Operations.res +1 -1
- package/src/components/EventLog/EventLog_Operations.res.mjs +1 -1
- package/src/components/Heartbeat/Heartbeat_Callback.res +0 -1
- package/src/components/Heartbeat/Heartbeat_Callback.res.mjs +0 -1
- package/src/components/InboundTranslationSlice/InboundTranslationSlice_Callback.res.mjs +1 -1
- package/src/components/OutboundTranslationSlice/OutboundTranslationSlice_Callback.res.mjs +1 -1
- package/src/components/StateViewSlice/StateViewSlice_Builder.res.mjs +2 -2
- package/src/plugin/connect/PluginExtensionPoint_Plugin.res.mjs +1 -1
- package/src/util/CommandPublisher.res.mjs +1 -1
- package/src/util/LogFormat.res +22 -4
- package/src/util/LogFormat.res.mjs +26 -5
- package/src/util/Logger.res +11 -2
- package/src/util/Logger.res.mjs +3 -2
- package/tests/Secrets_Node_BackendTest.res +32 -0
- package/tests/Secrets_Node_BackendTest.res.mjs +29 -1
- package/tests/dcb/DcbEventLogOperationsTest.res.mjs +1 -1
- package/tests/logger/LogFormatTest.res +5 -3
- package/tests/message/MessageTest.res +9 -0
- package/tests/message/MessageTest.res.mjs +5 -0
- package/tests/message/MetaEnvelopeTest.res +37 -20
- package/tests/message/MetaEnvelopeTest.res.mjs +32 -17
- package/tests/pii/PiiMember.res +18 -0
- package/tests/pii/PiiMember.res.mjs +59 -0
- package/tests/pii/PiiPpxTest.res +128 -0
- package/tests/pii/PiiPpxTest.res.mjs +151 -0
- package/tests/plugin/HeartbeatDisconnectGraceTest.res.mjs +1 -1
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// `@pii` as the PPX expands it: on an event the field reads `Pii.t`, and on a
|
|
2
|
+
// command it keeps its type; on both the schema carries the marker and
|
|
3
|
+
// `@sensitive`, and the JSON schema lists it.
|
|
4
|
+
|
|
5
|
+
open JestGlobals
|
|
6
|
+
|
|
7
|
+
module M = PiiMember
|
|
8
|
+
|
|
9
|
+
let encode = e => e->Reventless.Util_Sury.toJson(M.eventSchema)
|
|
10
|
+
let decode = json => json->Reventless.Util_Sury.fromJson(M.eventSchema)
|
|
11
|
+
|
|
12
|
+
let joined: M.event = MemberJoined({
|
|
13
|
+
memberId: "m-1",
|
|
14
|
+
name: Value("Ada"),
|
|
15
|
+
bio: Value("mathematician"),
|
|
16
|
+
nickname: None,
|
|
17
|
+
address: Value(Reventless.Email.unsafe("ada@example.com")),
|
|
18
|
+
photo: Value("/photos/m-1/0b1c.jpg"),
|
|
19
|
+
})
|
|
20
|
+
|
|
21
|
+
describe("@pii on an event", () => {
|
|
22
|
+
testSync("a value is stored as the plain value with no provider, and reads back", () => {
|
|
23
|
+
let json = encode(joined)
|
|
24
|
+
expect(json->JSON.stringify->String.includes("\"Ada\""))->toBe(true)
|
|
25
|
+
expect(decode(json))->toEqual(joined)
|
|
26
|
+
})
|
|
27
|
+
|
|
28
|
+
testSync("an erased value reads Erased, not a string", () => {
|
|
29
|
+
let erased: M.event = MemberJoined({
|
|
30
|
+
memberId: "m-1",
|
|
31
|
+
name: Erased,
|
|
32
|
+
nickname: None,
|
|
33
|
+
address: Erased,
|
|
34
|
+
photo: Forgotten,
|
|
35
|
+
})
|
|
36
|
+
expect(decode(encode(erased)))->toEqual(erased)
|
|
37
|
+
})
|
|
38
|
+
|
|
39
|
+
testSync("the marker names the subject, defaulting to the @owner field", () => {
|
|
40
|
+
let fields =
|
|
41
|
+
M.eventSchema->S.castToUnknown->Reventless.Pii.variantFields(~variant="MemberJoined")
|
|
42
|
+
expect(fields->Array.map(((name, m)) => (name, m.subject, m.forgettable)))->toEqual([
|
|
43
|
+
("name", "memberId", false),
|
|
44
|
+
("bio", "memberId", false),
|
|
45
|
+
("nickname", "memberId", false),
|
|
46
|
+
("address", "memberId", false),
|
|
47
|
+
("photo", "memberId", true),
|
|
48
|
+
])
|
|
49
|
+
let invited =
|
|
50
|
+
M.eventSchema->S.castToUnknown->Reventless.Pii.variantFields(~variant="InvitationSent")
|
|
51
|
+
expect(invited->Array.map(((name, m)) => (name, m.subject)))->toEqual([
|
|
52
|
+
("invitee", "invitationId"),
|
|
53
|
+
])
|
|
54
|
+
})
|
|
55
|
+
|
|
56
|
+
testSync("@pii implies @sensitive", () =>
|
|
57
|
+
expect(
|
|
58
|
+
M.eventSchema
|
|
59
|
+
->S.castToUnknown
|
|
60
|
+
->Reventless.Sensitive.variantFieldNames(~variant="MemberJoined")
|
|
61
|
+
->Array.includes("name"),
|
|
62
|
+
)->toBe(true)
|
|
63
|
+
)
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
describe("@pii on a command", () => {
|
|
67
|
+
testSync("keeps the plain type and carries the marker", () => {
|
|
68
|
+
let join: M.command = Join({
|
|
69
|
+
memberId: "m-1",
|
|
70
|
+
name: "Ada",
|
|
71
|
+
address: Reventless.Email.unsafe("ada@example.com"),
|
|
72
|
+
})
|
|
73
|
+
let back =
|
|
74
|
+
join
|
|
75
|
+
->Reventless.Util_Sury.toJson(M.commandSchema)
|
|
76
|
+
->Reventless.Util_Sury.fromJson(M.commandSchema)
|
|
77
|
+
expect(back)->toEqual(join)
|
|
78
|
+
let fields = M.commandSchema->S.castToUnknown->Reventless.Pii.variantFields(~variant="Join")
|
|
79
|
+
expect(fields->Array.map(((name, _)) => name))->toEqual(["name", "address"])
|
|
80
|
+
})
|
|
81
|
+
})
|
|
82
|
+
|
|
83
|
+
describe("the JSON schema", () => {
|
|
84
|
+
testSync("lists the marker on the field", () => {
|
|
85
|
+
let fields =
|
|
86
|
+
M.eventSchema
|
|
87
|
+
->S.castToUnknown
|
|
88
|
+
->Reventless.Semantic.unionVariant(~variant="MemberJoined")
|
|
89
|
+
->Option.getOrThrow
|
|
90
|
+
let json = SuryToJsonSchema.deriveObjectSchema(fields)->JSON.stringify
|
|
91
|
+
expect(
|
|
92
|
+
json->String.includes(
|
|
93
|
+
"\"x-reventless-pii\":{\"subject\":\"memberId\",\"forgettable\":false}",
|
|
94
|
+
),
|
|
95
|
+
)->toBe(true)
|
|
96
|
+
})
|
|
97
|
+
})
|
|
98
|
+
|
|
99
|
+
describe("a log line of a @pii event or command", () => {
|
|
100
|
+
testSync("holds no personal value, whichever formatter prints it", () => {
|
|
101
|
+
let eventJson = encode(joined)
|
|
102
|
+
let envelope =
|
|
103
|
+
Dict.fromArray([
|
|
104
|
+
("id", JSON.Encode.string("m-1")),
|
|
105
|
+
("meta", Dict.fromArray([("ip", JSON.Encode.string("10.0.0.1"))])->JSON.Encode.object),
|
|
106
|
+
("event", eventJson),
|
|
107
|
+
])->JSON.Encode.object
|
|
108
|
+
let lines = [LogFormat.eventDetail(envelope), LogFormat.eventFull(envelope)]
|
|
109
|
+
lines->Array.forEach(
|
|
110
|
+
line => {
|
|
111
|
+
expect(line->String.includes("Ada"))->toBe(false)
|
|
112
|
+
expect(line->String.includes("ada@example.com"))->toBe(false)
|
|
113
|
+
expect(line->String.includes("mathematician"))->toBe(false)
|
|
114
|
+
expect(line->String.includes("10.0.0.1"))->toBe(false)
|
|
115
|
+
expect(line->String.includes("m-1"))->toBe(true)
|
|
116
|
+
},
|
|
117
|
+
)
|
|
118
|
+
let join: M.command = Join({
|
|
119
|
+
memberId: "m-1",
|
|
120
|
+
name: "Ada",
|
|
121
|
+
address: Reventless.Email.unsafe("ada@example.com"),
|
|
122
|
+
})
|
|
123
|
+
let commandJson = join->Reventless.Util_Sury.toJson(M.commandSchema)
|
|
124
|
+
let label = LogFormat.cmdLabelOfJson(commandJson)
|
|
125
|
+
expect(label->String.includes("Ada"))->toBe(false)
|
|
126
|
+
expect(label->String.includes("m-1"))->toBe(true)
|
|
127
|
+
})
|
|
128
|
+
})
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
// Generated by ReScript, PLEASE EDIT WITH CARE
|
|
2
|
+
|
|
3
|
+
import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
|
|
4
|
+
import * as Pii$Reventless from "@reventlessdev/reventless-spec/src/components/Pii.res.mjs";
|
|
5
|
+
import * as Semantic$Reventless from "@reventlessdev/reventless-spec/src/semantic/Semantic.res.mjs";
|
|
6
|
+
import * as Sensitive$Reventless from "@reventlessdev/reventless-spec/src/components/Sensitive.res.mjs";
|
|
7
|
+
import * as Util_Sury$Reventless from "@reventlessdev/reventless-spec/src/util/Util_Sury.res.mjs";
|
|
8
|
+
import * as PiiMember$ReventlessCore from "./PiiMember.res.mjs";
|
|
9
|
+
import * as SuryToJsonSchema$ReventlessCore from "../../src/components/Api/SuryToJsonSchema.res.mjs";
|
|
10
|
+
|
|
11
|
+
function encode(e) {
|
|
12
|
+
return Util_Sury$Reventless.toJson(e, PiiMember$ReventlessCore.eventSchema);
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
function decode(json) {
|
|
16
|
+
return Util_Sury$Reventless.fromJson(json, PiiMember$ReventlessCore.eventSchema);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
let joined_1 = {
|
|
20
|
+
TAG: "Value",
|
|
21
|
+
_0: "Ada"
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
let joined_2 = {
|
|
25
|
+
TAG: "Value",
|
|
26
|
+
_0: "mathematician"
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
let joined_4 = {
|
|
30
|
+
TAG: "Value",
|
|
31
|
+
_0: "ada@example.com"
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
let joined_5 = {
|
|
35
|
+
TAG: "Value",
|
|
36
|
+
_0: "/photos/m-1/0b1c.jpg"
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
let joined = {
|
|
40
|
+
TAG: "MemberJoined",
|
|
41
|
+
memberId: "m-1",
|
|
42
|
+
name: joined_1,
|
|
43
|
+
bio: joined_2,
|
|
44
|
+
nickname: undefined,
|
|
45
|
+
address: joined_4,
|
|
46
|
+
photo: joined_5
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
globalThis.describe("@pii on an event", () => {
|
|
50
|
+
globalThis.test("a value is stored as the plain value with no provider, and reads back", () => {
|
|
51
|
+
let json = Util_Sury$Reventless.toJson(joined, PiiMember$ReventlessCore.eventSchema);
|
|
52
|
+
globalThis.expect(JSON.stringify(json).includes("\"Ada\"")).toBe(true);
|
|
53
|
+
globalThis.expect(Util_Sury$Reventless.fromJson(json, PiiMember$ReventlessCore.eventSchema)).toEqual(joined);
|
|
54
|
+
});
|
|
55
|
+
globalThis.test("an erased value reads Erased, not a string", () => {
|
|
56
|
+
let erased = {
|
|
57
|
+
TAG: "MemberJoined",
|
|
58
|
+
memberId: "m-1",
|
|
59
|
+
name: "Erased",
|
|
60
|
+
nickname: undefined,
|
|
61
|
+
address: "Erased",
|
|
62
|
+
photo: "Forgotten"
|
|
63
|
+
};
|
|
64
|
+
let json = Util_Sury$Reventless.toJson(erased, PiiMember$ReventlessCore.eventSchema);
|
|
65
|
+
globalThis.expect(Util_Sury$Reventless.fromJson(json, PiiMember$ReventlessCore.eventSchema)).toEqual(erased);
|
|
66
|
+
});
|
|
67
|
+
globalThis.test("the marker names the subject, defaulting to the @owner field", () => {
|
|
68
|
+
let fields = Pii$Reventless.variantFields(PiiMember$ReventlessCore.eventSchema, "MemberJoined");
|
|
69
|
+
globalThis.expect(fields.map(param => {
|
|
70
|
+
let m = param[1];
|
|
71
|
+
return [
|
|
72
|
+
param[0],
|
|
73
|
+
m.subject,
|
|
74
|
+
m.forgettable
|
|
75
|
+
];
|
|
76
|
+
})).toEqual([
|
|
77
|
+
[
|
|
78
|
+
"name",
|
|
79
|
+
"memberId",
|
|
80
|
+
false
|
|
81
|
+
],
|
|
82
|
+
[
|
|
83
|
+
"bio",
|
|
84
|
+
"memberId",
|
|
85
|
+
false
|
|
86
|
+
],
|
|
87
|
+
[
|
|
88
|
+
"nickname",
|
|
89
|
+
"memberId",
|
|
90
|
+
false
|
|
91
|
+
],
|
|
92
|
+
[
|
|
93
|
+
"address",
|
|
94
|
+
"memberId",
|
|
95
|
+
false
|
|
96
|
+
],
|
|
97
|
+
[
|
|
98
|
+
"photo",
|
|
99
|
+
"memberId",
|
|
100
|
+
true
|
|
101
|
+
]
|
|
102
|
+
]);
|
|
103
|
+
let invited = Pii$Reventless.variantFields(PiiMember$ReventlessCore.eventSchema, "InvitationSent");
|
|
104
|
+
globalThis.expect(invited.map(param => [
|
|
105
|
+
param[0],
|
|
106
|
+
param[1].subject
|
|
107
|
+
])).toEqual([[
|
|
108
|
+
"invitee",
|
|
109
|
+
"invitationId"
|
|
110
|
+
]]);
|
|
111
|
+
});
|
|
112
|
+
globalThis.test("@pii implies @sensitive", () => {
|
|
113
|
+
globalThis.expect(Sensitive$Reventless.variantFieldNames(PiiMember$ReventlessCore.eventSchema, "MemberJoined").includes("name")).toBe(true);
|
|
114
|
+
});
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
globalThis.describe("@pii on a command", () => {
|
|
118
|
+
globalThis.test("keeps the plain type and carries the marker", () => {
|
|
119
|
+
let join = {
|
|
120
|
+
TAG: "Join",
|
|
121
|
+
memberId: "m-1",
|
|
122
|
+
name: "Ada",
|
|
123
|
+
address: "ada@example.com"
|
|
124
|
+
};
|
|
125
|
+
let back = Util_Sury$Reventless.fromJson(Util_Sury$Reventless.toJson(join, PiiMember$ReventlessCore.commandSchema), PiiMember$ReventlessCore.commandSchema);
|
|
126
|
+
globalThis.expect(back).toEqual(join);
|
|
127
|
+
let fields = Pii$Reventless.variantFields(PiiMember$ReventlessCore.commandSchema, "Join");
|
|
128
|
+
globalThis.expect(fields.map(param => param[0])).toEqual([
|
|
129
|
+
"name",
|
|
130
|
+
"address"
|
|
131
|
+
]);
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
globalThis.describe("the JSON schema", () => {
|
|
136
|
+
globalThis.test("lists the marker on the field", () => {
|
|
137
|
+
let fields = Stdlib_Option.getOrThrow(Semantic$Reventless.unionVariant(PiiMember$ReventlessCore.eventSchema, "MemberJoined"), undefined);
|
|
138
|
+
let json = JSON.stringify(SuryToJsonSchema$ReventlessCore.deriveObjectSchema(undefined, undefined, fields));
|
|
139
|
+
globalThis.expect(json.includes("\"x-reventless-pii\":{\"subject\":\"memberId\",\"forgettable\":false}")).toBe(true);
|
|
140
|
+
});
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
let M;
|
|
144
|
+
|
|
145
|
+
export {
|
|
146
|
+
M,
|
|
147
|
+
encode,
|
|
148
|
+
decode,
|
|
149
|
+
joined,
|
|
150
|
+
}
|
|
151
|
+
/* Not a pure module */
|
|
@@ -23,7 +23,7 @@ function graceFromActions(actions) {
|
|
|
23
23
|
});
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
let meta = Message$ReventlessCore.generateMeta("test",
|
|
26
|
+
let meta = Message$ReventlessCore.generateMeta("test", "test", undefined, undefined, undefined, undefined, undefined);
|
|
27
27
|
|
|
28
28
|
globalThis.describe("disconnectGrace", () => {
|
|
29
29
|
globalThis.test("scales with the interval (5→7, 10→15, 60→90)", () => {
|