@loomwork/wire-abi 0.0.0-stage → 0.1.0
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/LICENSE +202 -0
- package/NOTICE +8 -0
- package/README.md +61 -2
- package/dist/carrier.d.ts +31 -0
- package/dist/carrier.d.ts.map +1 -0
- package/dist/carrier.js +102 -0
- package/dist/carrier.js.map +1 -0
- package/dist/foldVectors.d.ts +37 -0
- package/dist/foldVectors.d.ts.map +1 -0
- package/dist/foldVectors.js +769 -0
- package/dist/foldVectors.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +16 -0
- package/dist/index.js.map +1 -0
- package/dist/protocol.d.ts +80 -0
- package/dist/protocol.d.ts.map +1 -0
- package/dist/protocol.js +66 -0
- package/dist/protocol.js.map +1 -0
- package/package.json +58 -3
- package/src/carrier.ts +168 -0
- package/src/foldVectors.ts +944 -0
- package/src/index.ts +18 -0
- package/src/protocol.ts +122 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,62 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @loomwork/wire-abi — drive a Loom execution from a non-TypeScript client
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A versioned JSON-RPC description of the kernel, plus a request handler that starts, resumes, reads and
|
|
4
|
+
cancels executions over it. Use it when a client written in another language, or a shell script, needs
|
|
5
|
+
to talk to a Loom runtime without importing TypeScript. The TypeScript `ctx` surface stays the
|
|
6
|
+
authority; the wire method table is generated from `KERNEL_SYSCALLS`, so it cannot drift from it
|
|
7
|
+
(ADR 0026). If every caller is TypeScript, you do not need this package.
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { handleRpc } from "@loomwork/wire-abi";
|
|
11
|
+
import type { JsonRpcRequest } from "@loomwork/wire-abi";
|
|
12
|
+
import type { WorkflowRuntime } from "@loomwork/workflow-runtime";
|
|
13
|
+
|
|
14
|
+
declare const runtime: WorkflowRuntime; // booted, with your flows registered
|
|
15
|
+
|
|
16
|
+
// Call this from whatever transport you mount it on (node:http, a worker, ...).
|
|
17
|
+
export async function onRequest(request: JsonRpcRequest) {
|
|
18
|
+
return handleRpc(runtime, request, {
|
|
19
|
+
// Derive the caller from the authenticated connection, never from the body.
|
|
20
|
+
resolvePrincipal: () => ({ actor: "billing-service" }),
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
// Request: { jsonrpc: "2.0", id: 1, method: "execution.start", params: { flowId: "greet", input: {} } }
|
|
25
|
+
// Result: the folded state: { executionId, workflowId, status, sequence, variables, frames, suspendedOn? }
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Surface
|
|
29
|
+
|
|
30
|
+
- **Carrier.** `handleRpc(runtime, request, options?)` answers `execution.start`, `execution.resume`,
|
|
31
|
+
`execution.getState`, `execution.cancel` and `abi.describe`. It does not throw: every failure is a
|
|
32
|
+
JSON-RPC error object. `start` and `resume` wait until the run suspends or finishes, then return that
|
|
33
|
+
state. `CarrierOptions` takes `resolveFlow` (defaults to `runtime.getFlow`) and `resolvePrincipal`.
|
|
34
|
+
- **Descriptor.** `WIRE_ABI`, `WIRE_ABI_VERSION`, `WIRE_METHODS`, `CARRIER_METHODS`, `deriveWireMethods`.
|
|
35
|
+
`WIRE_METHODS` marks each syscall `unary` or `channel` (`stream` and `ui` are channels).
|
|
36
|
+
- **Framing.** `JsonRpcRequest`, `JsonRpcResponse` and `RPC_ERRORS`. A kernel refusal (denial, quota,
|
|
37
|
+
forged approval, and so on) is `-32000`.
|
|
38
|
+
- **Conformance vectors.** `FOLD_VECTORS` is a list of event logs with the state each must fold to, as
|
|
39
|
+
plain JSON. `runFoldVectors()` runs the TypeScript fold over them; another language can load the same
|
|
40
|
+
vectors and run its own fold.
|
|
41
|
+
|
|
42
|
+
## Behaviour that surprises people
|
|
43
|
+
|
|
44
|
+
- **It is a function, not a server.** Nothing in the repo mounts `handleRpc` on HTTP; you supply the
|
|
45
|
+
transport and its authentication.
|
|
46
|
+
- **`ctx.*` methods are not callable.** A wire client drives executions; individual syscalls such as
|
|
47
|
+
`ctx.execute` are answered with `methodNotFound`.
|
|
48
|
+
- **The principal comes from your code.** `resolvePrincipal` is applied to all four `execution.*`
|
|
49
|
+
methods, and any `principal` in the request params is ignored. If you omit it, no principal is
|
|
50
|
+
asserted and the runtime's default identity applies, which `security.strict` refuses.
|
|
51
|
+
- **The state view drops settled step inputs.** `frames[..].input` is present only for steps still in
|
|
52
|
+
flight (ADR 0138); read settled inputs from the log.
|
|
53
|
+
|
|
54
|
+
## Status / See also
|
|
55
|
+
|
|
56
|
+
Unpublished for now: inside this repo use `workspace:*`; from a sibling checkout use a `link:` override
|
|
57
|
+
(see [AGENTS.md](../../AGENTS.md)).
|
|
58
|
+
|
|
59
|
+
- [ADR 0026](../../docs/adr/0026-t2-wire-level-kernel-abi.md): the design, and what is staged.
|
|
60
|
+
- API reference: section "`@loomwork/wire-abi` — wire-level kernel ABI (T2)" in
|
|
61
|
+
[docs/api-reference.org](../../docs/api-reference.org).
|
|
62
|
+
- Guides: [docs/user-guide.md](../../docs/user-guide.md), [docs/README.md](../../docs/README.md).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { RegisteredFlow, WorkflowRuntime } from "@loomwork/workflow-runtime";
|
|
2
|
+
import { type JsonRpcRequest, type JsonRpcResponse } from "./protocol";
|
|
3
|
+
/** Resolve a flow id to the registered flow to start (the server's code registry). */
|
|
4
|
+
export type FlowResolver = (flowId: string) => RegisteredFlow | undefined;
|
|
5
|
+
export interface CarrierOptions {
|
|
6
|
+
/** How `execution.start` resolves a flowId to a RegisteredFlow. Defaults to `runtime.getFlow`. */
|
|
7
|
+
resolveFlow?: FlowResolver;
|
|
8
|
+
/**
|
|
9
|
+
* Resolve the authenticated principal for a request from the TRANSPORT's connection
|
|
10
|
+
* context — NEVER from the request body. The mounting transport authenticates the
|
|
11
|
+
* connection (mTLS, bearer token, signed header, …) and supplies this bound to that
|
|
12
|
+
* identity; the carrier ignores any client-supplied `principal` in the wire params.
|
|
13
|
+
* Omitted → no principal is asserted and the runtime's default identity applies (under
|
|
14
|
+
* `security.strict` that is ANONYMOUS, which an execution authorizer refuses).
|
|
15
|
+
* Applied to every `execution.*` method — start, resume, getState and cancel.
|
|
16
|
+
*
|
|
17
|
+
* This is the trust boundary: the K2/K12 authz ring keys tenant/actor grants and the
|
|
18
|
+
* DelegationAuthorizer confused-deputy binding on this principal, so it must reflect who
|
|
19
|
+
* is really connected, not who the client claims to be.
|
|
20
|
+
*/
|
|
21
|
+
resolvePrincipal?: (request: JsonRpcRequest) => Record<string, unknown> | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Handle one JSON-RPC request against the runtime. Never throws — every failure
|
|
25
|
+
* (bad params, kernel-ring refusal, unknown method) is a JSON-RPC error object,
|
|
26
|
+
* so a shell client parses one shape. `ctx.*` syscall methods are rejected
|
|
27
|
+
* with `methodNotFound`: a wire client drives executions, it does not make
|
|
28
|
+
* individual syscalls (that is the kernel's own concern — A3).
|
|
29
|
+
*/
|
|
30
|
+
export declare function handleRpc(runtime: WorkflowRuntime, request: JsonRpcRequest, options?: CarrierOptions): Promise<JsonRpcResponse>;
|
|
31
|
+
//# sourceMappingURL=carrier.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"carrier.d.ts","sourceRoot":"","sources":["../src/carrier.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClF,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,eAAe,EAAwB,MAAM,YAAY,CAAC;AAW7F,sFAAsF;AACtF,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,GAAG,SAAS,CAAC;AAE1E,MAAM,WAAW,cAAc;IAC7B,kGAAkG;IAClG,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACrF;AA2CD;;;;;;GAMG;AACH,wBAAsB,SAAS,CAC7B,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,cAAc,EACvB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,eAAe,CAAC,CAoE1B"}
|
package/dist/carrier.js
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.handleRpc = handleRpc;
|
|
4
|
+
const protocol_1 = require("./protocol");
|
|
5
|
+
function ok(id, result) {
|
|
6
|
+
return { jsonrpc: "2.0", id, result };
|
|
7
|
+
}
|
|
8
|
+
function err(id, code, message) {
|
|
9
|
+
return { jsonrpc: "2.0", id, error: { code, message } };
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* A JSON-safe projection of the folded state — what a wire client reads back.
|
|
13
|
+
* ADR 0138 (EVENT_SCHEMA 1.26.0): `frames[..].input` is present only for steps still in flight; a settled
|
|
14
|
+
* step's input is read from the log (or `LogLifecycle.readArchived` after a compaction).
|
|
15
|
+
*/
|
|
16
|
+
function stateView(state) {
|
|
17
|
+
return {
|
|
18
|
+
executionId: state.executionId,
|
|
19
|
+
workflowId: state.workflowId,
|
|
20
|
+
status: state.status,
|
|
21
|
+
sequence: state.sequence,
|
|
22
|
+
variables: state.variables,
|
|
23
|
+
frames: state.frames,
|
|
24
|
+
...(state.suspendedOn !== undefined && { suspendedOn: state.suspendedOn }),
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Handle one JSON-RPC request against the runtime. Never throws — every failure
|
|
29
|
+
* (bad params, kernel-ring refusal, unknown method) is a JSON-RPC error object,
|
|
30
|
+
* so a shell client parses one shape. `ctx.*` syscall methods are rejected
|
|
31
|
+
* with `methodNotFound`: a wire client drives executions, it does not make
|
|
32
|
+
* individual syscalls (that is the kernel's own concern — A3).
|
|
33
|
+
*/
|
|
34
|
+
async function handleRpc(runtime, request, options = {}) {
|
|
35
|
+
const { id, method, params } = request;
|
|
36
|
+
const resolveFlow = options.resolveFlow ?? ((fid) => runtime.getFlow(fid));
|
|
37
|
+
// SECURITY: the principal comes from the transport's AUTHENTICATED connection, never the body
|
|
38
|
+
// — and it is resolved ONCE for the request and applied to EVERY execution method. (It used to
|
|
39
|
+
// reach `execution.start` only, so under a runtime that fails closed on a missing principal a
|
|
40
|
+
// wire client could start an execution and never resume, read or cancel it.)
|
|
41
|
+
const principal = options.resolvePrincipal?.(request);
|
|
42
|
+
const identity = principal !== undefined ? { principal } : {};
|
|
43
|
+
try {
|
|
44
|
+
switch (method) {
|
|
45
|
+
case "abi.describe":
|
|
46
|
+
return ok(id, protocol_1.WIRE_ABI);
|
|
47
|
+
case "execution.start": {
|
|
48
|
+
const p = params;
|
|
49
|
+
const flow = resolveFlow(p.flowId);
|
|
50
|
+
if (flow === undefined) {
|
|
51
|
+
return err(id, protocol_1.RPC_ERRORS.invalidParams, `no flow registered: "${p.flowId}"`);
|
|
52
|
+
}
|
|
53
|
+
// A wire client cannot self-assert an actor/tenant, so a captured delegation token
|
|
54
|
+
// can't be replayed by supplying a matching `actor` field (see `principal` above).
|
|
55
|
+
const handle = await runtime.start(flow, p.input, {
|
|
56
|
+
...(p.executionId !== undefined && { executionId: p.executionId }),
|
|
57
|
+
...identity,
|
|
58
|
+
});
|
|
59
|
+
await settle(runtime, handle);
|
|
60
|
+
return ok(id, stateView(handle.getState()));
|
|
61
|
+
}
|
|
62
|
+
case "execution.resume": {
|
|
63
|
+
const p = params;
|
|
64
|
+
const handle = await runtime.resume(p.executionId, p.event, identity);
|
|
65
|
+
await settle(runtime, handle);
|
|
66
|
+
return ok(id, stateView(handle.getState()));
|
|
67
|
+
}
|
|
68
|
+
case "execution.getState": {
|
|
69
|
+
const p = params;
|
|
70
|
+
const state = await runtime.loadState(p.executionId, identity);
|
|
71
|
+
if (state === null) {
|
|
72
|
+
return err(id, protocol_1.RPC_ERRORS.invalidParams, `no execution: "${p.executionId}"`);
|
|
73
|
+
}
|
|
74
|
+
return ok(id, stateView(state));
|
|
75
|
+
}
|
|
76
|
+
case "execution.cancel": {
|
|
77
|
+
const p = params;
|
|
78
|
+
const cancelled = await runtime.cancel(p.executionId, p.reason, identity);
|
|
79
|
+
return ok(id, { cancelled });
|
|
80
|
+
}
|
|
81
|
+
default:
|
|
82
|
+
if (method.startsWith("ctx.")) {
|
|
83
|
+
return err(id, protocol_1.RPC_ERRORS.methodNotFound, `syscall "${method}" is kernel-internal; wire clients use the execution.* carrier`);
|
|
84
|
+
}
|
|
85
|
+
return err(id, protocol_1.RPC_ERRORS.methodNotFound, `unknown method: "${method}"`);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
catch (e) {
|
|
89
|
+
// A kernel-ring refusal (denial, quota, safety, mismatch, forged approval, …)
|
|
90
|
+
// surfaces here as a thrown error — reported as a kernel-refused RPC error.
|
|
91
|
+
return err(id, protocol_1.RPC_ERRORS.kernelRefused, e instanceof Error ? e.message : String(e));
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
// Wait for the run to reach a terminal-or-suspended state (whichever the flow
|
|
95
|
+
// does), so getState() returns a settled fold — never a mid-flight snapshot.
|
|
96
|
+
async function settle(_runtime, handle) {
|
|
97
|
+
await Promise.race([
|
|
98
|
+
handle.waitForSuspend().catch(() => undefined),
|
|
99
|
+
handle.waitForCompletion().catch(() => undefined),
|
|
100
|
+
]);
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=carrier.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../src/carrier.ts"],"names":[],"mappings":";;AAmFA,8BAwEC;AAzJD,yCAA6F;AAkD7F,SAAS,EAAE,CAAC,EAAwB,EAAE,MAAe;IACnD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;AACxC,CAAC;AACD,SAAS,GAAG,CAAC,EAAwB,EAAE,IAAY,EAAE,OAAe;IAClE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAqB;IACtC,OAAO;QACL,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,SAAS,CAC7B,OAAwB,EACxB,OAAuB,EACvB,UAA0B,EAAE;IAE5B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACvC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACnF,8FAA8F;IAC9F,+FAA+F;IAC/F,8FAA8F;IAC9F,6EAA6E;IAC7E,MAAM,SAAS,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAE9D,IAAI,CAAC;QACH,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,cAAc;gBACjB,OAAO,EAAE,CAAC,EAAE,EAAE,mBAAQ,CAAC,CAAC;YAE1B,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,MAAM,CAAC,GAAG,MAAqB,CAAC;gBAChC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,OAAO,GAAG,CAAC,EAAE,EAAE,qBAAU,CAAC,aAAa,EAAE,wBAAwB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;gBAChF,CAAC;gBACD,mFAAmF;gBACnF,mFAAmF;gBACnF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE;oBAChD,GAAG,CAAC,CAAC,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;oBAClE,GAAG,QAAQ;iBACZ,CAAC,CAAC;gBACH,MAAM,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC9B,OAAO,EAAE,CAAC,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC9C,CAAC;YAED,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACxB,MAAM,CAAC,GAAG,MAAsB,CAAC;gBACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBACtE,MAAM,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC9B,OAAO,EAAE,CAAC,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC9C,CAAC;YAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;gBAC1B,MAAM,CAAC,GAAG,MAAkB,CAAC;gBAC7B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC/D,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO,GAAG,CAAC,EAAE,EAAE,qBAAU,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC;gBAC/E,CAAC;gBACD,OAAO,EAAE,CAAC,EAAE,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAClC,CAAC;YAED,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACxB,MAAM,CAAC,GAAG,MAAkB,CAAC;gBAC7B,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAC1E,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAC/B,CAAC;YAED;gBACE,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC9B,OAAO,GAAG,CACR,EAAE,EACF,qBAAU,CAAC,cAAc,EACzB,YAAY,MAAM,gEAAgE,CACnF,CAAC;gBACJ,CAAC;gBACD,OAAO,GAAG,CAAC,EAAE,EAAE,qBAAU,CAAC,cAAc,EAAE,oBAAoB,MAAM,GAAG,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,8EAA8E;QAC9E,4EAA4E;QAC5E,OAAO,GAAG,CAAC,EAAE,EAAE,qBAAU,CAAC,aAAa,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,6EAA6E;AAC7E,KAAK,UAAU,MAAM,CACnB,QAAyB,EACzB,MAAqF;IAErF,MAAM,OAAO,CAAC,IAAI,CAAC;QACjB,MAAM,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;QAC9C,MAAM,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;KAClD,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { EventEnvelope } from "@loomwork/core";
|
|
2
|
+
export interface FoldVector {
|
|
3
|
+
name: string;
|
|
4
|
+
events: EventEnvelope[];
|
|
5
|
+
/** The expected `fold(events)` — compared field-by-field (JSON-equal). */
|
|
6
|
+
expected: {
|
|
7
|
+
status: string;
|
|
8
|
+
sequence: number;
|
|
9
|
+
variables: Record<string, unknown>;
|
|
10
|
+
frames: Record<string, {
|
|
11
|
+
status: string;
|
|
12
|
+
attempts: number;
|
|
13
|
+
}>;
|
|
14
|
+
/**
|
|
15
|
+
* Optional (ADR 0113, additive): each frame's first-start sequence and kernel-recorded scope
|
|
16
|
+
* path. Present only on the vectors that pin them, so the vectors that predate them are
|
|
17
|
+
* unchanged.
|
|
18
|
+
*/
|
|
19
|
+
frameMeta?: Record<string, {
|
|
20
|
+
firstSeq?: number;
|
|
21
|
+
scope?: string;
|
|
22
|
+
}>;
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* The canonical vectors. Deliberately covers the core lifecycle plus a
|
|
27
|
+
* representative kernel-ring fact, so a foreign fold that mishandles any of them
|
|
28
|
+
* fails loudly. Extend (never repurpose) alongside the K5 schema.
|
|
29
|
+
*/
|
|
30
|
+
export declare const FOLD_VECTORS: FoldVector[];
|
|
31
|
+
/** Run the reference fold over every vector; returns per-vector pass/fail + detail. */
|
|
32
|
+
export declare function runFoldVectors(vectors?: readonly FoldVector[]): Array<{
|
|
33
|
+
name: string;
|
|
34
|
+
passed: boolean;
|
|
35
|
+
detail?: string;
|
|
36
|
+
}>;
|
|
37
|
+
//# sourceMappingURL=foldVectors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"foldVectors.d.ts","sourceRoot":"","sources":["../src/foldVectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAapD,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,0EAA0E;IAC1E,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC7D;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACnE,CAAC;CACH;AAqBD;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,UAAU,EAi1BpC,CAAC;AAEF,uFAAuF;AACvF,wBAAgB,cAAc,CAAC,OAAO,GAAE,SAAS,UAAU,EAAiB,GAAG,KAAK,CAAC;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAgCD"}
|