@volter/twin-inngest 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/README.md +131 -0
- package/dist/src/cli.d.ts +2 -0
- package/dist/src/cli.js +26 -0
- package/dist/src/index.d.ts +10 -0
- package/dist/src/index.js +61 -0
- package/dist/src/inngest-budget.d.ts +83 -0
- package/dist/src/inngest-budget.js +404 -0
- package/dist/src/inngest-capabilities.d.ts +4 -0
- package/dist/src/inngest-capabilities.js +512 -0
- package/dist/src/inngest-conformance.d.ts +7 -0
- package/dist/src/inngest-conformance.js +39 -0
- package/dist/src/inngest-connector.d.ts +60 -0
- package/dist/src/inngest-connector.js +109 -0
- package/dist/src/inngest-runtime.d.ts +98 -0
- package/dist/src/inngest-runtime.js +329 -0
- package/dist/src/inngest-server.d.ts +14 -0
- package/dist/src/inngest-server.js +42 -0
- package/dist/src/inngest-signing.d.ts +32 -0
- package/dist/src/inngest-signing.js +173 -0
- package/dist/src/inngest-twin.d.ts +30 -0
- package/dist/src/inngest-twin.js +332 -0
- package/package.json +51 -0
- package/src/cli.ts +25 -0
- package/src/index.ts +107 -0
- package/src/inngest-budget.ts +450 -0
- package/src/inngest-capabilities.ts +554 -0
- package/src/inngest-conformance.ts +43 -0
- package/src/inngest-connector.ts +133 -0
- package/src/inngest-runtime.ts +391 -0
- package/src/inngest-server.ts +50 -0
- package/src/inngest-signing.ts +180 -0
- package/src/inngest-twin.ts +366 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# @volter/twin-inngest
|
|
2
|
+
|
|
3
|
+
> **Legacy connector helpers:** this package still has callable helpers using the retired v1
|
|
4
|
+
> `syncPull` API. Those paths require migration before use on the current kernel;
|
|
5
|
+
> older helper descriptions below do not establish current compatibility. Check the
|
|
6
|
+
> [generated index](../../../generated/INDEX.md) for protocol standing and use the
|
|
7
|
+
> [shared model](../../../docs/concepts/the-model.md) for current state semantics.
|
|
8
|
+
|
|
9
|
+
Local Inngest twin for the **durable-execution workflow-orchestration** surface: event send
|
|
10
|
+
(Event API), function register/introspect (SDK exec protocol), and a REAL kernel-persisted
|
|
11
|
+
**step machine** — `step.run` memoize/replay, `step.sleep`/`sleepUntil` instant-advance,
|
|
12
|
+
`step.waitForEvent` gating, and exact retry-attempt counting — plus run status/get/list and
|
|
13
|
+
event-based cancellation, built on the shared `@volter/world-core` kernel. API-first vendor (no
|
|
14
|
+
product UI to mirror — the dev-server/cloud dashboard is a run-inspection state view, not an
|
|
15
|
+
agent navigation target).
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
bun packages/twin/inngest/src/cli.ts
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Three API surfaces + host/path split
|
|
22
|
+
|
|
23
|
+
Real Inngest addresses THREE distinct surfaces with overlapping shapes, routed here by
|
|
24
|
+
`routeInngestSurface` (path-primary — see `inngest-twin.ts` header):
|
|
25
|
+
|
|
26
|
+
1. **Event API** — `POST /e/{eventKey}` — GROUNDED against the installed `inngest@4.12.0` SDK's
|
|
27
|
+
own compiled source (`Inngest.send()` builds `new URL('e/'+eventKey, eventBaseUrl)`, and its
|
|
28
|
+
`options.baseUrl` / `INNGEST_BASE_URL` / `INNGEST_EVENT_API_BASE_URL` env override — VERIFIED
|
|
29
|
+
live before `inngest-sdk.integration.test.ts` was written — routes `.send()` at any host,
|
|
30
|
+
including this twin).
|
|
31
|
+
2. **SDK exec protocol** — `/api/inngest` (GET introspect, PUT register, POST — a **twin-only
|
|
32
|
+
simplification**, see below) and `/fn/register` (POST — the real SDK's actual outbound
|
|
33
|
+
registration target, grounded from `InngestCommHandler.js`'s `inngestRegisterUrl`).
|
|
34
|
+
3. **Dev-server/cloud v2 REST API** — `/api/v2/*` — GROUNDED at this EXACT path from a
|
|
35
|
+
live-fetched first-party OpenAPI document (`api-docs.inngest.com/api-specs/v2.json`,
|
|
36
|
+
`servers[1].url == "http://localhost:8288/api/v2"`) — this **corrects** the original build
|
|
37
|
+
spec's speculative `/v1/*` guess (a genuine, disclosed grounding upgrade, not a demotion).
|
|
38
|
+
|
|
39
|
+
## The durable-execution step machine (the signature strength)
|
|
40
|
+
|
|
41
|
+
`inngest-runtime.ts` is written FRESH for this pack. This twin does **not** execute real user
|
|
42
|
+
code — there is no sandboxed JS runtime here. A function's steps are **declared** up front (a
|
|
43
|
+
`step_plan` array on the `functions.register` body — a twin-only extension of the real wire
|
|
44
|
+
payload; the real SDK infers steps by re-running the handler up to its next `step.*()` call,
|
|
45
|
+
which a local twin cannot reproduce without a real running app). Given a declared plan, the twin
|
|
46
|
+
reproduces the real durable-execution **semantics** faithfully:
|
|
47
|
+
|
|
48
|
+
- **`steps.run_memoized` / `steps.replay_deterministic`** — every step's output is persisted to a
|
|
49
|
+
`step:<runId>::<stepId>` kernel row. Re-invoking (polling) a run **replays** every already-
|
|
50
|
+
completed step by reading its persisted output back out of the kernel — never recomputing it —
|
|
51
|
+
before advancing to the next uncompleted step. A 2-step run where step-2's output is a hash
|
|
52
|
+
function of step-1's memoized output proves this: an empty kernel (the mutation-test's
|
|
53
|
+
`httpEmpty` saboteur) makes step-1 "replay" as missing, so step-2's value comes out wrong.
|
|
54
|
+
- **`steps.sleep_instant`** — `Sleep`/`sleepUntil` steps complete on first touch, no wall clock.
|
|
55
|
+
- **`steps.wait_for_event_*`** — a `WaitForEvent` step holds the run at `RUNNING` (never jumps to
|
|
56
|
+
`COMPLETED`) until a matching-name event arrives; a non-matching event never resolves it; an
|
|
57
|
+
optional declared poll-count timeout resolves it with `output: null` (a **deterministic
|
|
58
|
+
poll-count**, never a real wall-clock timeout).
|
|
59
|
+
- **`steps.retry_*`** — a step can declare `failTimes: N` (fail N times, then succeed on attempt
|
|
60
|
+
N+1); `attempts` is an exact, kernel-persisted counter. Exceeding the configured
|
|
61
|
+
`config.retries` (default 4, doc-unverified exact vendor default) transitions the **run** to
|
|
62
|
+
`FAILED` with an error, never silently succeeding.
|
|
63
|
+
|
|
64
|
+
`exec.sdk_executor_roundtrip` — a real running app + real step handler functions Inngest calls
|
|
65
|
+
into over HTTP — is the filed `todo`.
|
|
66
|
+
|
|
67
|
+
## Cancellation is event-based, not a REST call
|
|
68
|
+
|
|
69
|
+
The REAL Inngest cancellation mechanism (grounded live,
|
|
70
|
+
`inngest.com/docs/features/inngest-functions/cancellation`): a function declares
|
|
71
|
+
`cancelOn: [{event, if}]`; sending a matching event cancels its non-terminal runs. The
|
|
72
|
+
live-fetched v2 OpenAPI document has **no REST cancel-run endpoint at all** — this twin's
|
|
73
|
+
`runs.cancel_via_event` capability models the real mechanism, not a fabricated `DELETE`. The `if`
|
|
74
|
+
CEL-style expression (grounded shape: `event.data.id == async.data.id`) is matched on **event
|
|
75
|
+
name only** today (config-acceptance done); full expression evaluation is
|
|
76
|
+
`scheduling.cancel_if_expression` (todo).
|
|
77
|
+
|
|
78
|
+
## Coverage
|
|
79
|
+
|
|
80
|
+
This is a v1 slice of the Inngest API, not the full surface. Modeled **`done`** (38): event
|
|
81
|
+
send (single/batch/idempotent/validation), function register/re-register/introspect/trigger-
|
|
82
|
+
match/fanout/cron-registration, run created/get/status-progression/isolation/unknown-404/
|
|
83
|
+
event-runs-list/cancel-via-event/cancel-conflict, the full step machine (memoize, **replay**,
|
|
84
|
+
sequential progression, sleep, **waitForEvent** gate/resolve/wrong-name/timeout, **retry** exact-
|
|
85
|
+
count/then-success/exhausted), concurrency config echo, HMAC sign/verify/tamper, read-only/
|
|
86
|
+
unmodeled-route safety, kernel-persisted state, conformance snapshot, and a handle-driven
|
|
87
|
+
connector pull (idempotent).
|
|
88
|
+
|
|
89
|
+
Left as **`todo`** (32, honest gaps — includes several REAL, live-confirmed v2 REST endpoints not
|
|
90
|
+
yet modeled): the real SDK-executor round-trip and its real wire step-op protocol, cross-function
|
|
91
|
+
`InvokeFunction`, parallel step fan-out, Inngest Connect (persistent WS execution channel), real
|
|
92
|
+
cron-tick/debounce/throttle/rate-limit/batching/priority/singleton/concurrency-key enforcement
|
|
93
|
+
physics, the `cancelOn` `if`-expression evaluator, `POST /runs/{id}/rerun` and
|
|
94
|
+
`GET /runs/{id}/trace` (both REAL v2 endpoints, live-fetched, not yet modeled), real pagination
|
|
95
|
+
over the event-runs list, multi-trigger functions, `step.ai` / AI Gateway, event-key/signing-key
|
|
96
|
+
auth parity, the FULL v2 error-code taxonomy, 429 rate-limiting, connector push + step-trace pull,
|
|
97
|
+
and fixture seeding. `events.get_by_id` is filed `todo` but **confirmed absent** from the real v2
|
|
98
|
+
REST API (no `GET /events/{id}` path exists at all — only `GET /events/{id}/runs`) — kept for
|
|
99
|
+
forward-compatibility, not because it's a live gap.
|
|
100
|
+
|
|
101
|
+
**Planned (todo):** enforce the accepted flow-control config deterministically — concurrency
|
|
102
|
+
limits, throttle, debounce, rate-limit and event batching are accepted and echoed back today but
|
|
103
|
+
never enforced (`inngest.scheduling.flow_control_enforcement`) — and evaluate a cron trigger
|
|
104
|
+
against the injected clock so a scheduled function actually runs
|
|
105
|
+
(`inngest.scheduling.cron_evaluation`).
|
|
106
|
+
|
|
107
|
+
See `src/inngest-capabilities.ts` for the full manifest (the real vendor surface is the
|
|
108
|
+
denominator — coverage is honest and partial until the twin reaches it).
|
|
109
|
+
|
|
110
|
+
## A note on grounding corrections over the original build spec
|
|
111
|
+
|
|
112
|
+
This pack's build spec cited several shapes from doc-prose against `origin/twin-pinecone`,
|
|
113
|
+
flagged for re-verification. Three genuine corrections came out of that re-verification (all
|
|
114
|
+
disclosed in the landing commits, see spec-sources.json):
|
|
115
|
+
|
|
116
|
+
- The dev-server/cloud REST management API lives at **`/api/v2/*`**, not `/v1/*` (live-fetched
|
|
117
|
+
first-party OpenAPI document, `api-docs.inngest.com/api-specs/v2.json`).
|
|
118
|
+
- The real run-status enum is **`QUEUED | RUNNING | COMPLETED | FAILED | CANCELLED`** (uppercase,
|
|
119
|
+
with a `QUEUED` pre-run state — the v2 OpenAPI `v2FunctionRunStatus` schema), not the
|
|
120
|
+
spec-assumed mixed-case `Running/Completed/Failed/Cancelled`.
|
|
121
|
+
- The `x-inngest-signature` header format is **`t=<unix_seconds>&s=<hex_hmac>`**
|
|
122
|
+
(`URLSearchParams`-encoded, SDK-source confirmed), not a bare hex signature; and the real
|
|
123
|
+
comm-handler's reject status for an invalid signature is **401** (`unauthorizedResponse`,
|
|
124
|
+
SDK-source confirmed), not the spec-cited 500 — filed as an annotation on
|
|
125
|
+
`auth.signature_500_reject_parity` (todo), not claimed either way as `done`.
|
|
126
|
+
|
|
127
|
+
## No webhooks module
|
|
128
|
+
|
|
129
|
+
Unlike replicate/fal/clerk, Inngest's Event API / exec protocol / v2 REST surface has no
|
|
130
|
+
webhook-delivery concept of its own for this v1 slice — signing (`inngest-signing.ts`) covers the
|
|
131
|
+
real executor↔SDK HMAC request-signing scheme instead, which is this pack's crypto surface.
|
package/dist/src/cli.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { keepProcessAlive } from '@volter/world-core/lifecycle';
|
|
3
|
+
// world-inngest CLI: serve the KERNEL-BACKED Inngest API twin, or run conformance. State
|
|
4
|
+
// lives in the @volter/world-core action log (no in-memory side-store). Conformance is dev-only +
|
|
5
|
+
// lazy-imported so the bin runs without @volter/world-tooling (E2).
|
|
6
|
+
import { hasFlag, optionValue } from '@volter/world-core/args';
|
|
7
|
+
import { createInngestTwinServer } from "./inngest-server.js";
|
|
8
|
+
const [cmd, ...rest] = process.argv.slice(2);
|
|
9
|
+
const port = Number(optionValue(rest, '--port', String(process.env.PORT ?? '0'))) || undefined;
|
|
10
|
+
const root = optionValue(rest, '--root') || undefined;
|
|
11
|
+
const readOnly = hasFlag(rest, '--read-only'); // a twin accepts writes unless started read-only
|
|
12
|
+
if (cmd === 'serve' || cmd === undefined) {
|
|
13
|
+
const s = await createInngestTwinServer({ readOnly, ...(root ? { root } : {}), ...(port ? { port } : {}) });
|
|
14
|
+
process.stdout.write(`inngest twin (durable-execution workflow orchestration: events/functions/runs/steps, host/path split)${readOnly ? ' [read-only]' : ''} at http://127.0.0.1:${s.port}\n`);
|
|
15
|
+
await keepProcessAlive();
|
|
16
|
+
}
|
|
17
|
+
else if (cmd === 'conformance') {
|
|
18
|
+
const { checkInngestConformance } = await import("./inngest-conformance.js");
|
|
19
|
+
const report = checkInngestConformance();
|
|
20
|
+
process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
|
|
21
|
+
if (!report.ok)
|
|
22
|
+
process.exitCode = 1;
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
process.stdout.write('Usage: world-inngest serve|conformance [--port N] [--root DIR] [--read-only]\n');
|
|
26
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export { handleInngestTwinRequest, routeInngestSurface, inngestTwinSnapshot, INNGEST_RESOURCE_TYPES, } from './inngest-twin.js';
|
|
2
|
+
export type { InngestRequest, InngestResponse, InngestResourceType, InngestSurface, InngestTwinSnapshot, } from './inngest-twin.js';
|
|
3
|
+
export { createInngestTwinFetch, createInngestTwinServer, type InngestTwinFetchOptions } from './inngest-server.js';
|
|
4
|
+
export { mapEvent, mapRun, pullInngestEvents, pullInngestRuns, syncInngestFromReal, } from './inngest-connector.js';
|
|
5
|
+
export type { InngestLikeClient, InngestEventHandle, InngestRunHandle, InngestRealEvent, InngestRealRun, InngestBudgetedOptions } from './inngest-connector.js';
|
|
6
|
+
export { INNGEST_BUDGETED_METHODS, INNGEST_BUDGET_CEILING, INNGEST_BUDGET_MAX_RETRY_AFTER_S, INNGEST_BUDGET_WINDOW_MS, INNGEST_CALL_WEIGHTS, INNGEST_RATE_BUDGET, InngestBudget, InngestBudgetError, inngestBudgetPath, inngestCallWeight, inngestClientBudget, guardInngestClient, } from './inngest-budget.js';
|
|
7
|
+
export type { InngestBudgetErrorKind, InngestBudgetOptions, InngestBudgetReservation, InngestBudgetSnapshot } from './inngest-budget.js';
|
|
8
|
+
export { INNGEST_SIGNING_KEY_TYPE, inngestSigningKey, mintInngestSigningKey, storedInngestSigningKey, signInngestRequest, buildInngestSignatureHeader, verifyInngestSignature, InngestSignatureError, } from './inngest-signing.js';
|
|
9
|
+
import type { TwinPack } from '@volter/world-core';
|
|
10
|
+
export declare const pack: TwinPack;
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
// @volter/twin-inngest — the Inngest durable-execution / event-driven workflow-orchestration
|
|
2
|
+
// twin, built on the shared @volter/world-core kernel. REST transport over three surfaces: the Event
|
|
3
|
+
// API (POST /e/{eventKey}), the SDK execution protocol (/api/inngest, /fn/register), and the
|
|
4
|
+
// dev-server/cloud v2 REST management API (/api/v2/*, GROUNDED at that exact path from a
|
|
5
|
+
// live-fetched first-party OpenAPI document — see inngest-twin.ts header). State lives entirely
|
|
6
|
+
// in the kernel action log (no side-store).
|
|
7
|
+
//
|
|
8
|
+
// THE DECLARED STEP PLAN: this twin does not run user code — a function's steps
|
|
9
|
+
// are DECLARED (at register time, or by a test) as an ordered `step_plan`, and the twin advances
|
|
10
|
+
// that plan deterministically with REAL kernel-persisted memoization/replay (step outputs are
|
|
11
|
+
// read back from the kernel on every re-invocation, never recomputed), instant sleep/sleepUntil
|
|
12
|
+
// advance (no wall clock), waitForEvent gating (holds a run at a step until a matching event
|
|
13
|
+
// arrives, or a deterministic poll-count timeout), and an exact retry-attempt counter. This is
|
|
14
|
+
// the manifest files calling into a real running app as `exec.sdk_executor_roundtrip`.
|
|
15
|
+
export { handleInngestTwinRequest, routeInngestSurface, inngestTwinSnapshot, INNGEST_RESOURCE_TYPES, } from "./inngest-twin.js";
|
|
16
|
+
export { createInngestTwinFetch, createInngestTwinServer } from "./inngest-server.js";
|
|
17
|
+
export { mapEvent, mapRun, pullInngestEvents, pullInngestRuns, syncInngestFromReal, } from "./inngest-connector.js";
|
|
18
|
+
// The client-side rate budget — the fail-closed backstop every live call goes through. The
|
|
19
|
+
// MECHANISM is the kernel's shared, vendor-agnostic `RateBudget`; what lives here is this vendor's
|
|
20
|
+
// DECLARATION (window/ceiling/per-method weights) plus `guardInngestClient`, the choke point the
|
|
21
|
+
// connector entrypoints apply unconditionally. Exported so an operator can inspect spend
|
|
22
|
+
// (`snapshot`) and a caller can catch `InngestBudgetError` by type; there is deliberately no export
|
|
23
|
+
// that disables the guard.
|
|
24
|
+
export { INNGEST_BUDGETED_METHODS, INNGEST_BUDGET_CEILING, INNGEST_BUDGET_MAX_RETRY_AFTER_S, INNGEST_BUDGET_WINDOW_MS, INNGEST_CALL_WEIGHTS, INNGEST_RATE_BUDGET, InngestBudget, InngestBudgetError, inngestBudgetPath, inngestCallWeight, inngestClientBudget, guardInngestClient, } from "./inngest-budget.js";
|
|
25
|
+
export { INNGEST_SIGNING_KEY_TYPE, inngestSigningKey, mintInngestSigningKey, storedInngestSigningKey, signInngestRequest, buildInngestSignatureHeader, verifyInngestSignature, InngestSignatureError, } from "./inngest-signing.js";
|
|
26
|
+
import { INNGEST_RATE_BUDGET as RATE_BUDGET } from "./inngest-budget.js";
|
|
27
|
+
export const pack = {
|
|
28
|
+
// The SAME object inngest-budget.ts declares at module load — one source of truth, so registering
|
|
29
|
+
// the pack and importing the connector can never arm two different ceilings.
|
|
30
|
+
rateBudget: RATE_BUDGET,
|
|
31
|
+
vendor: 'inngest',
|
|
32
|
+
transport: 'rest',
|
|
33
|
+
archetype: 'crud',
|
|
34
|
+
bin: 'world-inngest',
|
|
35
|
+
// The subject types the twin SERVES over its own API — the R2 resource-level claim, held in
|
|
36
|
+
// lockstep with inngest-twin.ts's INNGEST_RESOURCE_TYPES. `signing_key` IS here: the world's
|
|
37
|
+
// executor<->SDK signing key is minted once from real entropy and persisted
|
|
38
|
+
// (inngest-signing.ts), and `GET /api/v2/keys/signing` establishes it on first touch — a real
|
|
39
|
+
// held subject, not a name with nothing behind it. What that route serves stays masked.
|
|
40
|
+
resources: ['event', 'function', 'run', 'step', 'signing_key'],
|
|
41
|
+
// World wiring — declared HERE, not in init.ts's central table (descriptor-first exemplar (adding-a-twin.md §3)).
|
|
42
|
+
endpointEnv: {
|
|
43
|
+
name: 'INNGEST_BASE_URL',
|
|
44
|
+
templates: { INNGEST_EVENT_API_BASE_URL: '${url}' },
|
|
45
|
+
note: 'no injector entry: the inngest SDK is base-URL-configured through INNGEST_BASE_URL / INNGEST_EVENT_API_BASE_URL.',
|
|
46
|
+
},
|
|
47
|
+
specSource: 'inngest-conformance.ts (self-referential endpoint/resource inventory) — grounded read-only against inngest.com/docs, the installed inngest@4.12.0 npm package source (npm pack), and the live-fetched v2 REST OpenAPI document (api-docs.inngest.com/api-specs/v2.json); see spec-sources.json.',
|
|
48
|
+
description: 'Inngest durable-execution workflow-orchestration twin — event send (Event API), function register/introspect (SDK exec protocol), and a kernel-persisted step machine (step.run memoize/replay, sleep/sleepUntil instant-advance, waitForEvent gating, exact retry-attempt counters), run status/get/list, event-based cancellation, HMAC-SHA256 executor<->SDK request signing. Twin does not execute real user code — steps are declared, not run. Kernel-backed.',
|
|
49
|
+
browserRouting: { apiPathPrefix: '/', loaderHost: 'http://localhost:8288' },
|
|
50
|
+
// INTERCEPTION RULING — hostsNone, the pack's own home for it: SDK is base-URL-configured by
|
|
51
|
+
// design (options.baseUrl / INNGEST_BASE_URL / INNGEST_EVENT_API_BASE_URL, verified in the
|
|
52
|
+
// pack README) — worlds wire the twin through those vars.
|
|
53
|
+
hostsNone: "SDK is base-URL-configured by design (options.baseUrl / INNGEST_BASE_URL / INNGEST_EVENT_API_BASE_URL, verified in the pack README) — worlds wire the twin through those vars",
|
|
54
|
+
// Adoption, moved off the central maps unchanged (descriptor-first back-migration, adding-a-twin.md §3,
|
|
55
|
+
// 2026-08-31).
|
|
56
|
+
adoption: {
|
|
57
|
+
// Inngest's official Python SDK - same distribution name as the npm one.
|
|
58
|
+
pypi: ['inngest'],
|
|
59
|
+
sdks: ['inngest'], envStems: ['INNGEST'],
|
|
60
|
+
},
|
|
61
|
+
};
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { RateBudget, type RateBudgetDeclaration, type RateBudgetOptions, type RateBudgetReservation, type RateBudgetSnapshot } from '@volter/world-core';
|
|
2
|
+
import type { InngestLikeClient } from './inngest-connector.js';
|
|
3
|
+
/** Rolling window, in ms. Spend older than this is pruned. */
|
|
4
|
+
export declare const INNGEST_BUDGET_WINDOW_MS = 60000;
|
|
5
|
+
/** Weighted units allowed inside one window. See the header for where this number comes from. */
|
|
6
|
+
export declare const INNGEST_BUDGET_CEILING = 60;
|
|
7
|
+
/** Seconds. A `Retry-After` above this means the credential is throttled hard — fail loudly. */
|
|
8
|
+
export declare const INNGEST_BUDGET_MAX_RETRY_AFTER_S = 300;
|
|
9
|
+
/** Per-call cost, keyed by the client method the guard is about to invoke. See the header. */
|
|
10
|
+
export declare const INNGEST_CALL_WEIGHTS: {
|
|
11
|
+
/** Every modeled call. Inngest publishes no per-endpoint rate to differentiate. */
|
|
12
|
+
readonly other: 2;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* The client methods this pack PRICES BY NAME, as dotted paths into the injected client.
|
|
16
|
+
*
|
|
17
|
+
* Two kinds of entry: (a) every method this connector actually calls, and (b) an endpoint the
|
|
18
|
+
* VENDOR documents in a distinct tier which a consumer can reach through the guarded client even
|
|
19
|
+
* though this connector never calls it (see the weights section of the header). Used to build the
|
|
20
|
+
* guarded surface — and, in the pack's own suite, the counting fake.
|
|
21
|
+
*
|
|
22
|
+
* NOT a closed list, and not a claim about the injected client's shape. A path the real client does
|
|
23
|
+
* not have is SKIPPED (this connector's members are optional; inventing one would turn "observe
|
|
24
|
+
* nothing" into "call something that isn't there"), and a method absent from this list is still
|
|
25
|
+
* PRICED at `defaultWeight` when a caller reaches for it — an unmodeled endpoint must never be
|
|
26
|
+
* free, and dropping one would be worse than free because it would be invisible.
|
|
27
|
+
*/
|
|
28
|
+
export declare const INNGEST_BUDGETED_METHODS: readonly ["events.get", "runs.get"];
|
|
29
|
+
/** THE PACK'S DECLARATION — pure data, the only Inngest-specific thing in the whole budget. */
|
|
30
|
+
export declare const INNGEST_RATE_BUDGET: RateBudgetDeclaration;
|
|
31
|
+
/** Price one Inngest call by its client method key (a dotted path, e.g. `events.get`). */
|
|
32
|
+
export declare function inngestCallWeight(method: string): number;
|
|
33
|
+
/** Where Inngest's ledger lives. Token-keyed and cwd-independent by default (the vendor limits per
|
|
34
|
+
* credential, so a cwd-scoped ledger would hand the same credential a fresh allowance in every
|
|
35
|
+
* checkout, worktree and CI matrix leg); pass `root` to opt into world-scoped accounting. */
|
|
36
|
+
export declare function inngestBudgetPath(opts?: {
|
|
37
|
+
root?: string;
|
|
38
|
+
token?: string;
|
|
39
|
+
} | string): string;
|
|
40
|
+
/** Construction options for Inngest's budget. The vendor is fixed; everything else may only TIGHTEN. */
|
|
41
|
+
export type InngestBudgetOptions = Omit<RateBudgetOptions, 'vendor'>;
|
|
42
|
+
/**
|
|
43
|
+
* Inngest's budget — the shared kernel guard bound to this vendor's declaration. A real subclass,
|
|
44
|
+
* not an alias, so `budget instanceof InngestBudget` means "a budget that accounts against this
|
|
45
|
+
* vendor's ledger under this vendor's ceiling": another vendor's `RateBudget` (with its own,
|
|
46
|
+
* possibly larger, ceiling) is NOT assignable where one of these is required.
|
|
47
|
+
*/
|
|
48
|
+
export declare class InngestBudget extends RateBudget {
|
|
49
|
+
constructor(opts?: InngestBudgetOptions);
|
|
50
|
+
}
|
|
51
|
+
export type { RateBudgetErrorKind as InngestBudgetErrorKind } from '@volter/world-core';
|
|
52
|
+
export { RateBudgetError as InngestBudgetError } from '@volter/world-core';
|
|
53
|
+
export type InngestBudgetReservation = RateBudgetReservation;
|
|
54
|
+
export type InngestBudgetSnapshot = RateBudgetSnapshot;
|
|
55
|
+
/** What every budgeted connector entrypoint accepts. There is deliberately no option that turns the
|
|
56
|
+
* guard OFF — only ones that say WHICH ledger and clock to account against. */
|
|
57
|
+
export type InngestBudgetedOptions = {
|
|
58
|
+
/** An existing budget to share across calls. Omit and one is constructed. Cannot be null. */
|
|
59
|
+
budget?: InngestBudget;
|
|
60
|
+
/** Construction options for the default budget (ledger path, clock). Cannot loosen it. */
|
|
61
|
+
budgetOptions?: InngestBudgetOptions;
|
|
62
|
+
};
|
|
63
|
+
/** Pull the budget wiring out of a caller's opts bag, so an entrypoint can forward it verbatim. */
|
|
64
|
+
export declare function inngestBudgetOf(opts: InngestBudgetedOptions): InngestBudgetedOptions;
|
|
65
|
+
/** Is this client already behind a budget? Returns the budget it is behind, if so. */
|
|
66
|
+
export declare function inngestClientBudget(client: unknown): RateBudget | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* Wrap an INJECTED Inngest client so EVERY call it makes is charged against the shared budget
|
|
69
|
+
* BEFORE the request goes out. This pack's connector never constructs the transport itself (the
|
|
70
|
+
* consumer injects a client that satisfies `InngestLikeClient` structurally), so the guard is a
|
|
71
|
+
* DECORATOR rather than a factory — which is exactly why every connector entrypoint applies it
|
|
72
|
+
* UNCONDITIONALLY instead of trusting the caller to have done it.
|
|
73
|
+
*
|
|
74
|
+
* IDEMPOTENT: wrapping an already-guarded client returns it unchanged, so a caller who forgot is
|
|
75
|
+
* protected and a caller who wrapped deliberately is not double-charged.
|
|
76
|
+
*
|
|
77
|
+
* A method that THROWS is still inspected: an SDK typically RAISES on a 429 rather than returning
|
|
78
|
+
* it, and that error's back-off is exactly the signal that must become a persisted cooldown. Losing
|
|
79
|
+
* it would leave the ledger cheerfully spending into a throttled credential. The original error is
|
|
80
|
+
* always re-raised afterwards — the budget never swallows a vendor failure — EXCEPT when the
|
|
81
|
+
* back-off is beyond the cap, where the budget's own louder "stop calling" error takes precedence.
|
|
82
|
+
*/
|
|
83
|
+
export declare function guardInngestClient(client: InngestLikeClient, opts?: InngestBudgetedOptions): InngestLikeClient;
|