@powerhousedao/switchboard 6.2.3-dev.4 → 6.2.3-dev.41
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/.tsbuild/test/attachments/byte-grants.test.d.ts +2 -0
- package/.tsbuild/test/attachments/byte-grants.test.d.ts.map +1 -0
- package/.tsbuild/test/attachments/byte-routes-read-gate.integration.test.d.ts +2 -0
- package/.tsbuild/test/attachments/byte-routes-read-gate.integration.test.d.ts.map +1 -0
- package/.tsbuild/test/attachments/reserve-metadata-parity.test.d.ts +2 -0
- package/.tsbuild/test/attachments/reserve-metadata-parity.test.d.ts.map +1 -0
- package/.tsbuild/test/attachments/url-signer.test.d.ts +2 -0
- package/.tsbuild/test/attachments/url-signer.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-create-signature-policy.test.d.ts +2 -0
- package/.tsbuild/test/boot-create-signature-policy.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-mcp-enabled.test.d.ts +2 -0
- package/.tsbuild/test/boot-mcp-enabled.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-privacy.test.d.ts +2 -0
- package/.tsbuild/test/boot-privacy.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-unsupported-stored-documents.test.d.ts +2 -0
- package/.tsbuild/test/boot-unsupported-stored-documents.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-without-renown.test.d.ts +2 -0
- package/.tsbuild/test/boot-without-renown.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-without-require-signatures.test.d.ts +2 -0
- package/.tsbuild/test/boot-without-require-signatures.test.d.ts.map +1 -0
- package/.tsbuild/test/boot-worker-trust-policy.test.d.ts +2 -0
- package/.tsbuild/test/boot-worker-trust-policy.test.d.ts.map +1 -0
- package/.tsbuild/test/builder-defaults.test.d.ts +2 -0
- package/.tsbuild/test/builder-defaults.test.d.ts.map +1 -0
- package/.tsbuild/test/create-signature-policy.test.d.ts +2 -0
- package/.tsbuild/test/create-signature-policy.test.d.ts.map +1 -0
- package/.tsbuild/test/fatal-shutdown.test.d.ts +2 -0
- package/.tsbuild/test/fatal-shutdown.test.d.ts.map +1 -0
- package/.tsbuild/test/mcp-flag.test.d.ts +2 -0
- package/.tsbuild/test/mcp-flag.test.d.ts.map +1 -0
- package/.tsbuild/test/renown-trust-policy.test.d.ts +2 -0
- package/.tsbuild/test/renown-trust-policy.test.d.ts.map +1 -0
- package/.tsbuild/test/unsupported-stored-documents.test.d.ts +2 -0
- package/.tsbuild/test/unsupported-stored-documents.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/harness.d.ts +56 -0
- package/.tsbuild/test/workflow/harness.d.ts.map +1 -0
- package/.tsbuild/test/workflow/oauth.test.d.ts +2 -0
- package/.tsbuild/test/workflow/oauth.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/resolvers.test.d.ts +2 -0
- package/.tsbuild/test/workflow/resolvers.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/webhook-dedupe.test.d.ts +2 -0
- package/.tsbuild/test/workflow/webhook-dedupe.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/webhook-signed.test.d.ts +2 -0
- package/.tsbuild/test/workflow/webhook-signed.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/webhook-trigger-test.test.d.ts +2 -0
- package/.tsbuild/test/workflow/webhook-trigger-test.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow/webhook-unsigned.test.d.ts +2 -0
- package/.tsbuild/test/workflow/webhook-unsigned.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow-read-gate.test.d.ts +2 -0
- package/.tsbuild/test/workflow-read-gate.test.d.ts.map +1 -0
- package/.tsbuild/test/workflow-runtime.test.d.ts +2 -0
- package/.tsbuild/test/workflow-runtime.test.d.ts.map +1 -0
- package/.tsbuild/tsconfig.tsbuildinfo +1 -1
- package/.tsbuild/tsdown.config.d.ts.map +1 -1
- package/.tsbuild/vitest.config.d.ts.map +1 -1
- package/Auth.md +94 -0
- package/CHANGELOG.md +411 -0
- package/README.md +35 -0
- package/dist/index.d.mts +2 -1
- package/dist/index.mjs +10 -8
- package/dist/index.mjs.map +1 -1
- package/dist/install-packages.d.mts +2 -1
- package/dist/install-packages.mjs +2 -2
- package/dist/install-packages.mjs.map +1 -1
- package/dist/migrate.d.mts +2 -1
- package/dist/migrate.mjs +4 -3
- package/dist/migrate.mjs.map +1 -1
- package/dist/server-CMAxYG6D.mjs +3052 -0
- package/dist/server-CMAxYG6D.mjs.map +1 -0
- package/dist/server.d.mts +120 -29
- package/dist/server.d.mts.map +1 -1
- package/dist/server.mjs +4 -5
- package/dist/{utils-Baw7rThP.mjs → utils-uaBlzyjS.mjs} +15 -9
- package/dist/utils-uaBlzyjS.mjs.map +1 -0
- package/dist/utils.d.mts +4 -5
- package/dist/utils.d.mts.map +1 -1
- package/dist/utils.mjs +3 -3
- package/package.json +22 -17
- package/test/attachment-reference-read-model.test.ts +6 -1
- package/test/attachments/auth.test.ts +85 -0
- package/test/attachments/byte-grants.test.ts +290 -0
- package/test/attachments/byte-routes-read-gate.integration.test.ts +314 -0
- package/test/attachments/download-target.test.ts +201 -32
- package/test/attachments/index.test.ts +34 -3
- package/test/attachments/reserve-metadata-parity.test.ts +96 -0
- package/test/attachments/routes-integration.test.ts +60 -4
- package/test/attachments/routes.test.ts +166 -23
- package/test/attachments/service-config.test.ts +13 -3
- package/test/attachments/url-signer.test.ts +105 -0
- package/test/boot-create-signature-policy.test.ts +108 -0
- package/test/boot-mcp-enabled.test.ts +121 -0
- package/test/boot-privacy.test.ts +243 -0
- package/test/boot-unsupported-stored-documents.test.ts +213 -0
- package/test/boot-without-renown.test.ts +81 -0
- package/test/boot-without-require-signatures.test.ts +74 -0
- package/test/boot-worker-trust-policy.test.ts +90 -0
- package/test/builder-defaults.test.ts +80 -0
- package/test/create-signature-policy.test.ts +69 -0
- package/test/fatal-shutdown.test.ts +132 -0
- package/test/mcp-flag.test.ts +56 -0
- package/test/renown-trust-policy.test.ts +315 -0
- package/test/unsupported-stored-documents.test.ts +72 -0
- package/test/workflow/harness.ts +289 -0
- package/test/workflow/oauth.test.ts +214 -0
- package/test/workflow/resolvers.test.ts +296 -0
- package/test/workflow/webhook-dedupe.test.ts +295 -0
- package/test/workflow/webhook-signed.test.ts +509 -0
- package/test/workflow/webhook-trigger-test.test.ts +82 -0
- package/test/workflow/webhook-unsigned.test.ts +345 -0
- package/test/workflow-read-gate.test.ts +145 -0
- package/test/workflow-runtime.test.ts +499 -0
- package/tsconfig.json +9 -0
- package/tsdown.config.ts +3 -1
- package/dist/server-CiKkVE6g.mjs +0 -1555
- package/dist/server-CiKkVE6g.mjs.map +0 -1
- package/dist/utils-Baw7rThP.mjs.map +0 -1
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
ActionSigner,
|
|
3
|
+
ISigner,
|
|
4
|
+
} from "@powerhousedao/shared/document-model";
|
|
5
|
+
import {
|
|
6
|
+
ReactorBuilder,
|
|
7
|
+
ReactorClientBuilder,
|
|
8
|
+
type SignatureTrustPolicy,
|
|
9
|
+
} from "@powerhousedao/reactor";
|
|
10
|
+
import type { IRenown } from "@renown/sdk/node";
|
|
11
|
+
import { existsSync } from "node:fs";
|
|
12
|
+
import { pathToFileURL } from "node:url";
|
|
13
|
+
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
14
|
+
import { applySwitchboardReactorDefaults } from "../src/builder-defaults.mjs";
|
|
15
|
+
import {
|
|
16
|
+
assertWorkerTrustPolicy,
|
|
17
|
+
getRenownTrustPolicyConfig,
|
|
18
|
+
} from "../src/renown.js";
|
|
19
|
+
|
|
20
|
+
const WALLET = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266";
|
|
21
|
+
const CONNECT_KEY = "did:key:zDnaeConnectKey";
|
|
22
|
+
const SWITCHBOARD_KEY = "did:key:zDnaeSwitchboardKey";
|
|
23
|
+
const SWITCHBOARD_USER = {
|
|
24
|
+
address: "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
|
|
25
|
+
networkId: "eip155",
|
|
26
|
+
chainId: 1,
|
|
27
|
+
};
|
|
28
|
+
const GRAPHQL = "http://renown.test/graphql";
|
|
29
|
+
|
|
30
|
+
// Signed by WALLET's Anvil dev key; its expiry is ignored by the policy.
|
|
31
|
+
const CREDENTIAL_ROW = {
|
|
32
|
+
documentId: "doc-cred",
|
|
33
|
+
credentialId: "urn:uuid:c7882913-68ef-48e5-9e89-f2948d2ca22c",
|
|
34
|
+
context: ["https://www.w3.org/2018/credentials/v1"],
|
|
35
|
+
type: ["VerifiableCredential", "RenownCredential"],
|
|
36
|
+
issuerId: "did:pkh:eip155:1:0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
|
|
37
|
+
issuerEthereumAddress: WALLET,
|
|
38
|
+
issuanceDate: "2026-09-24T00:48:25.566Z",
|
|
39
|
+
expirationDate: "2026-10-01T00:48:25.566Z",
|
|
40
|
+
credentialSubjectId: CONNECT_KEY,
|
|
41
|
+
credentialSubjectApp: "connect",
|
|
42
|
+
credentialStatusId: null,
|
|
43
|
+
credentialStatusType: null,
|
|
44
|
+
credentialSchemaId: "https://renown.id/schemas/renown-credential/v1",
|
|
45
|
+
credentialSchemaType: "JsonSchemaValidator2018",
|
|
46
|
+
proofVerificationMethod:
|
|
47
|
+
"did:pkh:eip155:1:0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
|
|
48
|
+
proofEthereumAddress: WALLET,
|
|
49
|
+
proofCreated: "2026-09-24T00:48:25.566Z",
|
|
50
|
+
proofPurpose: "assertionMethod",
|
|
51
|
+
proofType: "EthereumEip712Signature2021",
|
|
52
|
+
proofValue:
|
|
53
|
+
"0xe8d7a2468b9eb21286483fd88601d350ac7a8ed908506e51a34c6b119f93a7d75c6284a3f231698f6fcc8a3ad0ec5096a34811c7b6adef2d1e4146ddb22826a91c",
|
|
54
|
+
proofEip712Domain: JSON.stringify({ version: "1", chainId: 1 }),
|
|
55
|
+
proofEip712PrimaryType: "VerifiableCredential",
|
|
56
|
+
revoked: false,
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
function stubRenown(user: ActionSigner["user"] = SWITCHBOARD_USER): IRenown {
|
|
60
|
+
const signer = {
|
|
61
|
+
user,
|
|
62
|
+
app: { name: "switchboard", key: SWITCHBOARD_KEY },
|
|
63
|
+
} as unknown as ISigner;
|
|
64
|
+
return { signer } as unknown as IRenown;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
function claim(address: string, key: string): ActionSigner {
|
|
68
|
+
return {
|
|
69
|
+
user: { address, networkId: "eip155", chainId: 1 },
|
|
70
|
+
app: { name: "connect", key },
|
|
71
|
+
signatures: [],
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** Answers the renown read model with `rows`; counts the requests. */
|
|
76
|
+
function mockReadModel(rows: unknown[] = [CREDENTIAL_ROW]) {
|
|
77
|
+
return vi.spyOn(globalThis, "fetch").mockImplementation(() =>
|
|
78
|
+
Promise.resolve(
|
|
79
|
+
new Response(JSON.stringify({ data: { renownCredentials: rows } }), {
|
|
80
|
+
status: 200,
|
|
81
|
+
}),
|
|
82
|
+
),
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
async function remotePolicy(
|
|
87
|
+
renown = stubRenown(),
|
|
88
|
+
): Promise<SignatureTrustPolicy> {
|
|
89
|
+
const { trustPolicy } = await getRenownTrustPolicyConfig(
|
|
90
|
+
{ source: "remote", switchboardUrl: GRAPHQL },
|
|
91
|
+
renown,
|
|
92
|
+
);
|
|
93
|
+
return trustPolicy!;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
describe("getRenownTrustPolicyConfig", () => {
|
|
97
|
+
afterEach(() => vi.restoreAllMocks());
|
|
98
|
+
|
|
99
|
+
it("accepts a key a credential binds to the claimed wallet", async () => {
|
|
100
|
+
const fetchMock = mockReadModel();
|
|
101
|
+
const policy = await remotePolicy();
|
|
102
|
+
|
|
103
|
+
await expect(
|
|
104
|
+
policy.authorizeSigner(claim(WALLET, CONNECT_KEY), CONNECT_KEY, "doc"),
|
|
105
|
+
).resolves.toBe(true);
|
|
106
|
+
expect(fetchMock.mock.calls[0][0]).toBe(GRAPHQL);
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it("refuses a mismatched address or key", async () => {
|
|
110
|
+
mockReadModel();
|
|
111
|
+
const policy = await remotePolicy();
|
|
112
|
+
|
|
113
|
+
await expect(
|
|
114
|
+
policy.authorizeSigner(
|
|
115
|
+
claim(SWITCHBOARD_USER.address, CONNECT_KEY),
|
|
116
|
+
CONNECT_KEY,
|
|
117
|
+
"doc",
|
|
118
|
+
),
|
|
119
|
+
).resolves.toBe(false);
|
|
120
|
+
await expect(
|
|
121
|
+
policy.authorizeSigner(
|
|
122
|
+
claim(WALLET, "did:key:zDnaeOther"),
|
|
123
|
+
"did:key:zDnaeOther",
|
|
124
|
+
"doc",
|
|
125
|
+
),
|
|
126
|
+
).resolves.toBe(false);
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it("refuses a key no credential binds yet", async () => {
|
|
130
|
+
const fetchMock = mockReadModel([]);
|
|
131
|
+
const policy = await remotePolicy();
|
|
132
|
+
|
|
133
|
+
await expect(
|
|
134
|
+
policy.authorizeSigner(claim(WALLET, CONNECT_KEY), CONNECT_KEY, "doc"),
|
|
135
|
+
).resolves.toBe(false);
|
|
136
|
+
await expect(
|
|
137
|
+
policy.authorizeSigner(claim(WALLET, CONNECT_KEY), CONNECT_KEY, "doc"),
|
|
138
|
+
).resolves.toBe(false);
|
|
139
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
140
|
+
});
|
|
141
|
+
|
|
142
|
+
it("caches an acceptance per (address, key)", async () => {
|
|
143
|
+
const fetchMock = mockReadModel();
|
|
144
|
+
const policy = await remotePolicy();
|
|
145
|
+
const signer = claim(WALLET, CONNECT_KEY);
|
|
146
|
+
|
|
147
|
+
await policy.authorizeSigner(signer, CONNECT_KEY, "doc-1");
|
|
148
|
+
fetchMock.mockRejectedValue(new TypeError("offline"));
|
|
149
|
+
|
|
150
|
+
await expect(
|
|
151
|
+
policy.authorizeSigner(signer, CONNECT_KEY, "doc-2"),
|
|
152
|
+
).resolves.toBe(true);
|
|
153
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
it("throws on a network failure rather than refusing", async () => {
|
|
157
|
+
vi.spyOn(globalThis, "fetch").mockRejectedValue(new TypeError("offline"));
|
|
158
|
+
const policy = await remotePolicy();
|
|
159
|
+
|
|
160
|
+
await expect(
|
|
161
|
+
policy.authorizeSigner(claim(WALLET, CONNECT_KEY), CONNECT_KEY, "doc"),
|
|
162
|
+
).rejects.toThrow("offline");
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("accepts the switchboard's own key for its own user without a lookup", async () => {
|
|
166
|
+
const fetchMock = mockReadModel([]);
|
|
167
|
+
const policy = await remotePolicy();
|
|
168
|
+
|
|
169
|
+
await expect(
|
|
170
|
+
policy.authorizeSigner(
|
|
171
|
+
claim(SWITCHBOARD_USER.address, SWITCHBOARD_KEY),
|
|
172
|
+
SWITCHBOARD_KEY,
|
|
173
|
+
"doc",
|
|
174
|
+
),
|
|
175
|
+
).resolves.toBe(true);
|
|
176
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
it("matches the switchboard's own key against its current user", async () => {
|
|
180
|
+
const fetchMock = mockReadModel([]);
|
|
181
|
+
const renown = stubRenown();
|
|
182
|
+
const policy = await remotePolicy(renown);
|
|
183
|
+
|
|
184
|
+
renown.signer.user = { address: WALLET, networkId: "eip155", chainId: 1 };
|
|
185
|
+
|
|
186
|
+
await expect(
|
|
187
|
+
policy.authorizeSigner(
|
|
188
|
+
claim(WALLET, SWITCHBOARD_KEY),
|
|
189
|
+
SWITCHBOARD_KEY,
|
|
190
|
+
"doc",
|
|
191
|
+
),
|
|
192
|
+
).resolves.toBe(true);
|
|
193
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
194
|
+
await expect(
|
|
195
|
+
policy.authorizeSigner(
|
|
196
|
+
claim(SWITCHBOARD_USER.address, SWITCHBOARD_KEY),
|
|
197
|
+
SWITCHBOARD_KEY,
|
|
198
|
+
"doc",
|
|
199
|
+
),
|
|
200
|
+
).resolves.toBe(false);
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
it("gives pooled workers a spec that builds the same policy", async () => {
|
|
204
|
+
const fetchMock = mockReadModel();
|
|
205
|
+
const { workerTrustPolicy } = await getRenownTrustPolicyConfig(
|
|
206
|
+
{ source: "remote", switchboardUrl: GRAPHQL },
|
|
207
|
+
stubRenown(),
|
|
208
|
+
);
|
|
209
|
+
|
|
210
|
+
const module = workerTrustPolicy!.module;
|
|
211
|
+
expect(module.exportName).toBe("createRenownTrustPolicy");
|
|
212
|
+
const filePath = "filePath" in module ? module.filePath : "";
|
|
213
|
+
expect(existsSync(filePath)).toBe(true);
|
|
214
|
+
expect(workerTrustPolicy!.initArgs).toEqual({
|
|
215
|
+
switchboard: GRAPHQL,
|
|
216
|
+
self: { key: SWITCHBOARD_KEY, user: SWITCHBOARD_USER },
|
|
217
|
+
});
|
|
218
|
+
|
|
219
|
+
const imported = (await import(pathToFileURL(filePath).href)) as Record<
|
|
220
|
+
string,
|
|
221
|
+
(args: unknown) => SignatureTrustPolicy
|
|
222
|
+
>;
|
|
223
|
+
const policy = imported[module.exportName](workerTrustPolicy!.initArgs);
|
|
224
|
+
await expect(
|
|
225
|
+
policy.authorizeSigner(claim(WALLET, CONNECT_KEY), CONNECT_KEY, "doc"),
|
|
226
|
+
).resolves.toBe(true);
|
|
227
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
it("reads a self source in process and gives workers no spec", async () => {
|
|
231
|
+
const request = vi.fn(() =>
|
|
232
|
+
Promise.resolve({ renownCredentials: [CREDENTIAL_ROW] }),
|
|
233
|
+
);
|
|
234
|
+
const config = await getRenownTrustPolicyConfig(
|
|
235
|
+
{ source: "self", request },
|
|
236
|
+
null,
|
|
237
|
+
);
|
|
238
|
+
|
|
239
|
+
expect(config.workerTrustPolicy).toBeUndefined();
|
|
240
|
+
await expect(
|
|
241
|
+
config.trustPolicy!.authorizeSigner(
|
|
242
|
+
claim(WALLET, CONNECT_KEY),
|
|
243
|
+
CONNECT_KEY,
|
|
244
|
+
"doc",
|
|
245
|
+
),
|
|
246
|
+
).resolves.toBe(true);
|
|
247
|
+
expect(request).toHaveBeenCalledTimes(1);
|
|
248
|
+
});
|
|
249
|
+
});
|
|
250
|
+
|
|
251
|
+
describe("assertWorkerTrustPolicy", () => {
|
|
252
|
+
it("fails with workers, authEnforcement and a self source", () => {
|
|
253
|
+
expect(() =>
|
|
254
|
+
assertWorkerTrustPolicy({
|
|
255
|
+
workers: 2,
|
|
256
|
+
authEnforcement: true,
|
|
257
|
+
renownSource: "self",
|
|
258
|
+
}),
|
|
259
|
+
).toThrow(
|
|
260
|
+
/REACTOR_WORKERS[\s\S]*REACTOR_AUTH_ENFORCEMENT[\s\S]*RENOWN_SOURCE/,
|
|
261
|
+
);
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
it.each([
|
|
265
|
+
{ workers: 0, authEnforcement: true, renownSource: "self" as const },
|
|
266
|
+
{ workers: 2, authEnforcement: false, renownSource: "self" as const },
|
|
267
|
+
{ workers: 2, authEnforcement: true, renownSource: "remote" as const },
|
|
268
|
+
])("passes %o", (config) => {
|
|
269
|
+
expect(() => assertWorkerTrustPolicy(config)).not.toThrow();
|
|
270
|
+
});
|
|
271
|
+
});
|
|
272
|
+
|
|
273
|
+
describe("applySwitchboardReactorDefaults with a trust policy", () => {
|
|
274
|
+
it("gives the reactor the policy and its worker spec", () => {
|
|
275
|
+
const reactorBuilder = new ReactorBuilder();
|
|
276
|
+
const withTrustPolicy = vi.spyOn(reactorBuilder, "withTrustPolicy");
|
|
277
|
+
const trustPolicy: SignatureTrustPolicy = {
|
|
278
|
+
authorizeSigner: () => Promise.resolve(true),
|
|
279
|
+
};
|
|
280
|
+
const workerTrustPolicy = {
|
|
281
|
+
module: { filePath: "/trust.js", exportName: "createTrustPolicy" },
|
|
282
|
+
};
|
|
283
|
+
|
|
284
|
+
applySwitchboardReactorDefaults(
|
|
285
|
+
reactorBuilder,
|
|
286
|
+
new ReactorClientBuilder(),
|
|
287
|
+
{
|
|
288
|
+
includeBaseModels: false,
|
|
289
|
+
signalHandlers: false,
|
|
290
|
+
trustPolicy: { trustPolicy, workerTrustPolicy },
|
|
291
|
+
},
|
|
292
|
+
);
|
|
293
|
+
|
|
294
|
+
expect(withTrustPolicy).toHaveBeenCalledWith(
|
|
295
|
+
trustPolicy,
|
|
296
|
+
workerTrustPolicy,
|
|
297
|
+
);
|
|
298
|
+
expect(reactorBuilder.hasTrustPolicy()).toBe(true);
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
it("leaves the reactor on the default without one", () => {
|
|
302
|
+
const reactorBuilder = new ReactorBuilder();
|
|
303
|
+
|
|
304
|
+
applySwitchboardReactorDefaults(
|
|
305
|
+
reactorBuilder,
|
|
306
|
+
new ReactorClientBuilder(),
|
|
307
|
+
{
|
|
308
|
+
includeBaseModels: false,
|
|
309
|
+
signalHandlers: false,
|
|
310
|
+
},
|
|
311
|
+
);
|
|
312
|
+
|
|
313
|
+
expect(reactorBuilder.hasTrustPolicy()).toBe(false);
|
|
314
|
+
});
|
|
315
|
+
});
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { UnsupportedStoredProtocolError } from "@powerhousedao/reactor";
|
|
2
|
+
import { describe, expect, it } from "vitest";
|
|
3
|
+
import {
|
|
4
|
+
StoredDocumentsRefusedError,
|
|
5
|
+
resolveUnsupportedStoredDocuments,
|
|
6
|
+
} from "../src/unsupported-stored-documents.mjs";
|
|
7
|
+
|
|
8
|
+
describe("resolveUnsupportedStoredDocuments", () => {
|
|
9
|
+
it("refuses by default", () => {
|
|
10
|
+
expect(resolveUnsupportedStoredDocuments(undefined, {})).toBe("refuse");
|
|
11
|
+
expect(
|
|
12
|
+
resolveUnsupportedStoredDocuments(undefined, {
|
|
13
|
+
REACTOR_UNSUPPORTED_STORED_DOCUMENTS: " ",
|
|
14
|
+
}),
|
|
15
|
+
).toBe("refuse");
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it("reads REACTOR_UNSUPPORTED_STORED_DOCUMENTS", () => {
|
|
19
|
+
expect(
|
|
20
|
+
resolveUnsupportedStoredDocuments(undefined, {
|
|
21
|
+
REACTOR_UNSUPPORTED_STORED_DOCUMENTS: " read-only ",
|
|
22
|
+
}),
|
|
23
|
+
).toBe("read-only");
|
|
24
|
+
expect(
|
|
25
|
+
resolveUnsupportedStoredDocuments(undefined, {
|
|
26
|
+
REACTOR_UNSUPPORTED_STORED_DOCUMENTS: "refuse",
|
|
27
|
+
}),
|
|
28
|
+
).toBe("refuse");
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it("lets the option win over the env var", () => {
|
|
32
|
+
expect(
|
|
33
|
+
resolveUnsupportedStoredDocuments("refuse", {
|
|
34
|
+
REACTOR_UNSUPPORTED_STORED_DOCUMENTS: "read-only",
|
|
35
|
+
}),
|
|
36
|
+
).toBe("refuse");
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it("refuses an unknown value", () => {
|
|
40
|
+
expect(() =>
|
|
41
|
+
resolveUnsupportedStoredDocuments(undefined, {
|
|
42
|
+
REACTOR_UNSUPPORTED_STORED_DOCUMENTS: "readonly",
|
|
43
|
+
}),
|
|
44
|
+
).toThrow(
|
|
45
|
+
'REACTOR_UNSUPPORTED_STORED_DOCUMENTS must be "refuse" or "read-only", got "readonly"',
|
|
46
|
+
);
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
describe("StoredDocumentsRefusedError", () => {
|
|
51
|
+
it("names the versions, the count and both ways forward", () => {
|
|
52
|
+
const cause = new UnsupportedStoredProtocolError(
|
|
53
|
+
[
|
|
54
|
+
{ protocol: "base-reducer", version: 3 },
|
|
55
|
+
{ protocol: "base-reducer", version: 7 },
|
|
56
|
+
],
|
|
57
|
+
4,
|
|
58
|
+
);
|
|
59
|
+
|
|
60
|
+
const error = new StoredDocumentsRefusedError(cause);
|
|
61
|
+
|
|
62
|
+
expect(error.message).toBe(
|
|
63
|
+
"Refusing to start: 4 stored document(s) require base-reducer 3, base-reducer 7, which this switchboard does not run. " +
|
|
64
|
+
"Either start a switchboard build that runs base-reducer 3, base-reducer 7, or set REACTOR_UNSUPPORTED_STORED_DOCUMENTS=read-only to start with those documents read-only.",
|
|
65
|
+
);
|
|
66
|
+
expect(error.documents).toBe(4);
|
|
67
|
+
expect(error.versions).toBe(cause.versions);
|
|
68
|
+
expect(error.cause).toBe(cause);
|
|
69
|
+
expect(StoredDocumentsRefusedError.isError(error)).toBe(true);
|
|
70
|
+
expect(StoredDocumentsRefusedError.isError(cause)).toBe(false);
|
|
71
|
+
});
|
|
72
|
+
});
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
// Shared harness: the suites go over a real socket through the reactor's own
|
|
2
|
+
// adapter, route service and webhook service, which the unit tests cannot.
|
|
3
|
+
import {
|
|
4
|
+
createHttpAdapter,
|
|
5
|
+
getDbClient,
|
|
6
|
+
HttpRouteService,
|
|
7
|
+
MemoryWebhookStore,
|
|
8
|
+
WebhookService,
|
|
9
|
+
} from "@powerhousedao/reactor-api";
|
|
10
|
+
import {
|
|
11
|
+
createWorkflowRuntime,
|
|
12
|
+
type WorkflowRuntimeService,
|
|
13
|
+
} from "@powerhousedao/reactor-workflow";
|
|
14
|
+
import {
|
|
15
|
+
createRelationalDb,
|
|
16
|
+
type IRelationalDb,
|
|
17
|
+
} from "@powerhousedao/shared/processors";
|
|
18
|
+
import type { OperationWithContext } from "document-model";
|
|
19
|
+
import type { Kysely } from "kysely";
|
|
20
|
+
import { vi } from "vitest";
|
|
21
|
+
import {
|
|
22
|
+
CORE_PIECE_NAME,
|
|
23
|
+
CORE_PIECE_VERSION,
|
|
24
|
+
} from "@powerhousedao/reactor-workflow";
|
|
25
|
+
|
|
26
|
+
export const WORKFLOW_TYPE = "powerhouse/workflow";
|
|
27
|
+
export const PACKAGE_NAME = "@powerhousedao/workflow";
|
|
28
|
+
/** A ref the harness's secret store resolves; anything else rejects. */
|
|
29
|
+
export const SECRET_REF = "secret://v1:00112233445566778899aabbccddeeff";
|
|
30
|
+
export const SECRET = "s3cret";
|
|
31
|
+
// Minting an endpoint is a read of the workflow, so the harness asks as one.
|
|
32
|
+
const CALLER = { headers: {}, db: {}, user: { address: "0xabc" } } as never;
|
|
33
|
+
|
|
34
|
+
export interface FiredRun {
|
|
35
|
+
workflowId: string;
|
|
36
|
+
payload: unknown;
|
|
37
|
+
kind: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export interface TriggerFields {
|
|
41
|
+
pieceName: string;
|
|
42
|
+
pieceVersion: string;
|
|
43
|
+
triggerName: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// The core piece's webhook trigger, pinned to the installed core piece.
|
|
47
|
+
export const WEBHOOK_TRIGGER: TriggerFields = {
|
|
48
|
+
pieceName: CORE_PIECE_NAME,
|
|
49
|
+
pieceVersion: CORE_PIECE_VERSION,
|
|
50
|
+
triggerName: "webhook",
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
export interface WebhookHost {
|
|
54
|
+
/** Origin the endpoint is served from, e.g. `http://127.0.0.1:53124`. */
|
|
55
|
+
readonly url: string;
|
|
56
|
+
/** Runs the trigger started, in order. Cleared by `arm`. */
|
|
57
|
+
readonly fired: FiredRun[];
|
|
58
|
+
readonly service: WorkflowRuntimeService;
|
|
59
|
+
/** Publishes an ENABLED workflow with `config`; returns its endpoint. */
|
|
60
|
+
arm(
|
|
61
|
+
config: Record<string, unknown>,
|
|
62
|
+
options?: { trigger?: TriggerFields; workflowId?: string },
|
|
63
|
+
): Promise<{ token: string; url: string }>;
|
|
64
|
+
/** Publishes the same workflow as DISABLED, keeping its endpoint row. */
|
|
65
|
+
disarm(workflowId?: string): Promise<void>;
|
|
66
|
+
/** Deletes the workflow document, as the reactor reports it. */
|
|
67
|
+
remove(workflowId?: string): Promise<void>;
|
|
68
|
+
/** Whether the reactor's webhook store still holds this token. */
|
|
69
|
+
hasToken(token: string): Promise<boolean>;
|
|
70
|
+
/** The policy the service hands the reactor for one endpoint. */
|
|
71
|
+
policyFor(workflowId?: string): Promise<unknown>;
|
|
72
|
+
deliver(
|
|
73
|
+
token: string,
|
|
74
|
+
init?: {
|
|
75
|
+
method?: string;
|
|
76
|
+
headers?: Record<string, string>;
|
|
77
|
+
body?: string;
|
|
78
|
+
query?: Record<string, string>;
|
|
79
|
+
},
|
|
80
|
+
): Promise<Response>;
|
|
81
|
+
stop(): Promise<void>;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export const DEFAULT_WORKFLOW = "wf-integration";
|
|
85
|
+
|
|
86
|
+
// Module-scoped: the service ignores any ordinal at or below the highest it
|
|
87
|
+
// has seen, so a per-host counter would make a file's second host see nothing.
|
|
88
|
+
let ordinal = 0;
|
|
89
|
+
|
|
90
|
+
export function workflowOperation(
|
|
91
|
+
state: Record<string, unknown>,
|
|
92
|
+
workflowId = DEFAULT_WORKFLOW,
|
|
93
|
+
): OperationWithContext {
|
|
94
|
+
ordinal += 1;
|
|
95
|
+
return {
|
|
96
|
+
operation: {
|
|
97
|
+
index: ordinal,
|
|
98
|
+
timestampUtcMs: `${ordinal}`,
|
|
99
|
+
action: { type: "SET_WORKFLOW_NAME", input: {} },
|
|
100
|
+
resultingState: JSON.stringify(state),
|
|
101
|
+
},
|
|
102
|
+
context: {
|
|
103
|
+
documentId: workflowId,
|
|
104
|
+
documentType: WORKFLOW_TYPE,
|
|
105
|
+
scope: "global",
|
|
106
|
+
branch: "main",
|
|
107
|
+
ordinal,
|
|
108
|
+
},
|
|
109
|
+
} as unknown as OperationWithContext;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
// `publicUrl` is known only after `listen`: a family registered against the
|
|
113
|
+
// wrong origin advertises URLs no caller can reach.
|
|
114
|
+
export async function startWebhookHost(
|
|
115
|
+
options: {
|
|
116
|
+
fire?: (run: FiredRun) => unknown;
|
|
117
|
+
// Reads and writes of the workflow documents; none by default.
|
|
118
|
+
reactorClient?: unknown;
|
|
119
|
+
} = {},
|
|
120
|
+
): Promise<WebhookHost> {
|
|
121
|
+
// The public factory, not the adapter class: the class is internal, so
|
|
122
|
+
// constructing it would test a path no consumer can take.
|
|
123
|
+
const { adapter } = await createHttpAdapter("express");
|
|
124
|
+
adapter.setupMiddleware({});
|
|
125
|
+
const server = await adapter.listen(0, undefined, "127.0.0.1");
|
|
126
|
+
const { port } = server.address() as { port: number };
|
|
127
|
+
const url = `http://127.0.0.1:${port}`;
|
|
128
|
+
|
|
129
|
+
const webhookStore = new MemoryWebhookStore();
|
|
130
|
+
const webhooks = new WebhookService({ store: webhookStore });
|
|
131
|
+
const routes = new HttpRouteService({
|
|
132
|
+
httpAdapter: adapter,
|
|
133
|
+
webhooks,
|
|
134
|
+
publicUrl: url,
|
|
135
|
+
});
|
|
136
|
+
// Core serves the endpoint family from its own host scope, exactly as the
|
|
137
|
+
// reactor wires it: nothing here touches the adapter directly.
|
|
138
|
+
webhooks.attach(routes.hostScope("@powerhousedao/reactor-api", "/webhooks"));
|
|
139
|
+
|
|
140
|
+
const { db } = getDbClient();
|
|
141
|
+
const fired: FiredRun[] = [];
|
|
142
|
+
|
|
143
|
+
// Every host surface the runtime asks for, and nothing it does not: no run
|
|
144
|
+
// here reaches the reactor, and the secret store answers one fixed ref.
|
|
145
|
+
const service = createWorkflowRuntime({
|
|
146
|
+
relationalDb: createRelationalDb(
|
|
147
|
+
db as unknown as Kysely<unknown>,
|
|
148
|
+
) as IRelationalDb,
|
|
149
|
+
reactorClient: options.reactorClient ?? {
|
|
150
|
+
get: () => Promise.reject(new Error("not used")),
|
|
151
|
+
find: () => Promise.resolve({ results: [] }),
|
|
152
|
+
},
|
|
153
|
+
assertCanRead: () => Promise.resolve(undefined),
|
|
154
|
+
assertCanWrite: () => Promise.resolve(undefined),
|
|
155
|
+
webhooks: routes.scopeFor(PACKAGE_NAME).webhooks,
|
|
156
|
+
secrets: {
|
|
157
|
+
get: (ref: string) =>
|
|
158
|
+
ref === SECRET_REF
|
|
159
|
+
? Promise.resolve(SECRET)
|
|
160
|
+
: Promise.reject(new Error(`No secret found for ref "${ref}"`)),
|
|
161
|
+
},
|
|
162
|
+
} as never);
|
|
163
|
+
vi.spyOn(service, "fire").mockImplementation(
|
|
164
|
+
(workflowId: string, payload?: unknown, kind = "manual") => {
|
|
165
|
+
const run = { workflowId, payload, kind };
|
|
166
|
+
fired.push(run);
|
|
167
|
+
const outcome = options.fire?.(run);
|
|
168
|
+
return Promise.resolve(
|
|
169
|
+
(outcome ?? {
|
|
170
|
+
runId: `run-${fired.length}`,
|
|
171
|
+
status: "SUCCEEDED",
|
|
172
|
+
steps: [],
|
|
173
|
+
}) as never,
|
|
174
|
+
);
|
|
175
|
+
},
|
|
176
|
+
);
|
|
177
|
+
|
|
178
|
+
await service.registerWebhookEndpoint();
|
|
179
|
+
|
|
180
|
+
const publish = async (
|
|
181
|
+
config: Record<string, unknown>,
|
|
182
|
+
status: string,
|
|
183
|
+
trigger: TriggerFields,
|
|
184
|
+
workflowId: string,
|
|
185
|
+
) => {
|
|
186
|
+
await service.onOperations([
|
|
187
|
+
workflowOperation(
|
|
188
|
+
{
|
|
189
|
+
name: "Integration",
|
|
190
|
+
status,
|
|
191
|
+
version: ordinal + 1,
|
|
192
|
+
trigger: { id: "t1", ...trigger, config },
|
|
193
|
+
steps: [],
|
|
194
|
+
edges: [],
|
|
195
|
+
variables: [],
|
|
196
|
+
},
|
|
197
|
+
workflowId,
|
|
198
|
+
),
|
|
199
|
+
]);
|
|
200
|
+
};
|
|
201
|
+
|
|
202
|
+
return {
|
|
203
|
+
url,
|
|
204
|
+
fired,
|
|
205
|
+
service,
|
|
206
|
+
async arm(config, opts = {}) {
|
|
207
|
+
const workflowId = opts.workflowId ?? DEFAULT_WORKFLOW;
|
|
208
|
+
// The runtime requires a scheme; an unsigned suite names "none".
|
|
209
|
+
await publish(
|
|
210
|
+
{ scheme: "none", ...config },
|
|
211
|
+
"ENABLED",
|
|
212
|
+
opts.trigger ?? WEBHOOK_TRIGGER,
|
|
213
|
+
workflowId,
|
|
214
|
+
);
|
|
215
|
+
const endpoint = await service.webhookEndpoint(workflowId, CALLER);
|
|
216
|
+
if (!endpoint) throw new Error(`No endpoint minted for ${workflowId}`);
|
|
217
|
+
fired.length = 0;
|
|
218
|
+
return {
|
|
219
|
+
url: endpoint.url,
|
|
220
|
+
token: endpoint.url.slice(endpoint.url.lastIndexOf("/") + 1),
|
|
221
|
+
};
|
|
222
|
+
},
|
|
223
|
+
async disarm(workflowId = DEFAULT_WORKFLOW) {
|
|
224
|
+
await publish({}, "DISABLED", WEBHOOK_TRIGGER, workflowId);
|
|
225
|
+
},
|
|
226
|
+
async remove(workflowId = DEFAULT_WORKFLOW) {
|
|
227
|
+
ordinal += 1;
|
|
228
|
+
await service.onOperations([
|
|
229
|
+
{
|
|
230
|
+
operation: {
|
|
231
|
+
index: ordinal,
|
|
232
|
+
timestampUtcMs: `${ordinal}`,
|
|
233
|
+
action: {
|
|
234
|
+
type: "DELETE_DOCUMENT",
|
|
235
|
+
input: { documentId: workflowId },
|
|
236
|
+
},
|
|
237
|
+
},
|
|
238
|
+
context: {
|
|
239
|
+
documentId: workflowId,
|
|
240
|
+
documentType: WORKFLOW_TYPE,
|
|
241
|
+
scope: "document",
|
|
242
|
+
branch: "main",
|
|
243
|
+
ordinal,
|
|
244
|
+
},
|
|
245
|
+
} as unknown as OperationWithContext,
|
|
246
|
+
]);
|
|
247
|
+
},
|
|
248
|
+
async hasToken(token) {
|
|
249
|
+
return (await webhookStore.find(token)) !== undefined;
|
|
250
|
+
},
|
|
251
|
+
policyFor(workflowId = DEFAULT_WORKFLOW) {
|
|
252
|
+
return service.webhookPolicy(workflowId);
|
|
253
|
+
},
|
|
254
|
+
deliver(token, init = {}) {
|
|
255
|
+
const query = init.query
|
|
256
|
+
? `?${new URLSearchParams(init.query).toString()}`
|
|
257
|
+
: "";
|
|
258
|
+
return fetch(`${url}/webhooks/${token}${query}`, {
|
|
259
|
+
method: init.method ?? "POST",
|
|
260
|
+
headers: init.headers,
|
|
261
|
+
body: init.body,
|
|
262
|
+
});
|
|
263
|
+
},
|
|
264
|
+
stop() {
|
|
265
|
+
return new Promise<void>((resolve, reject) =>
|
|
266
|
+
server.close((error) => (error ? reject(error) : resolve())),
|
|
267
|
+
);
|
|
268
|
+
},
|
|
269
|
+
};
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
// A delivery is answered before its run starts, so asserting on `fired`
|
|
273
|
+
// straight after a 202 is a race that passes for the wrong reason.
|
|
274
|
+
export async function waitForRuns(
|
|
275
|
+
host: WebhookHost,
|
|
276
|
+
count: number,
|
|
277
|
+
timeoutMs = 2000,
|
|
278
|
+
): Promise<FiredRun[]> {
|
|
279
|
+
const deadline = Date.now() + timeoutMs;
|
|
280
|
+
while (host.fired.length < count && Date.now() < deadline) {
|
|
281
|
+
await new Promise((resolve) => setTimeout(resolve, 5));
|
|
282
|
+
}
|
|
283
|
+
if (host.fired.length < count) {
|
|
284
|
+
throw new Error(
|
|
285
|
+
`Expected ${count} run(s), saw ${host.fired.length} within ${timeoutMs}ms`,
|
|
286
|
+
);
|
|
287
|
+
}
|
|
288
|
+
return host.fired;
|
|
289
|
+
}
|