@gate-forge/pack-task 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 +155 -0
- package/dist/adapter-schema.d.ts +83 -0
- package/dist/adapter-schema.d.ts.map +1 -0
- package/dist/adapter-schema.js +71 -0
- package/dist/adapter-schema.js.map +1 -0
- package/dist/detector.d.ts +48 -0
- package/dist/detector.d.ts.map +1 -0
- package/dist/detector.js +701 -0
- package/dist/detector.js.map +1 -0
- package/dist/index.d.ts +33 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +34 -0
- package/dist/index.js.map +1 -0
- package/dist/obligations.d.ts +41 -0
- package/dist/obligations.d.ts.map +1 -0
- package/dist/obligations.js +53 -0
- package/dist/obligations.js.map +1 -0
- package/dist/version.d.ts +12 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +12 -0
- package/dist/version.js.map +1 -0
- package/package.json +44 -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 2026 UKD
|
|
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,155 @@
|
|
|
1
|
+
# @gate-forge/pack-task
|
|
2
|
+
|
|
3
|
+
Background-task discovery pack: a pure-TypeScript GPP/3 in-process detector that finds background-task signatures in `.ts`/`.js`/`.mjs` source — no Python subprocess, no execution, no external deps — plus an audit-trail entity-adapter schema and an example server that proves the five obligation contracts the pack claims.
|
|
4
|
+
|
|
5
|
+
## How discovery works
|
|
6
|
+
|
|
7
|
+
The detector scans `.ts`/`.tsx`/`.js`/`.mjs` files with regex-based AST-light patterns (matching `pack-auth`'s strategy). It recognizes the task constructs below and reports its verdict through the discovery outcome's typed blocking vocabulary — the pack emits no resources and no classification signals of its own:
|
|
8
|
+
|
|
9
|
+
| Source construct | Recognized as |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| `new Queue('email.send', ...)` / `new BullMQ.Queue(...)` | BullMQ task + retry policy from `defaultJobOptions` |
|
|
12
|
+
| `new Bee('image.resize', ...)` | Bee-Queue task |
|
|
13
|
+
| `register('webhook.dispatch', handler)` | custom-queue task (single-line) |
|
|
14
|
+
| `new CustomQueue({ name, handler, ... })` | custom-queue task (multi-line, balanced-brace walk) |
|
|
15
|
+
| `navigator.serviceWorker.register(...)` / `*.serviceWorker.register(...)` / `serviceWorkerRegistration.register(...)` / `workbox.*` / `caches.*` / `window.*` / `document.*` | nothing — browser/platform registration APIs, never task queues (excluded before matching). The receiver chain is rebuilt across MULTI-LINE call expressions too, so `navigator.serviceWorker` on its own line above the `register(...)` continuation line is still excluded (the exact unified-dogfood false positive) |
|
|
16
|
+
| `onmessage = handler` / `.on('message', ...)` / `addEventListener('message', ...)` | message-handler task |
|
|
17
|
+
| `setInterval(handler, ms, ...)` / `setImmediate(handler, ...)` | recurring task |
|
|
18
|
+
| `@Task(...)` / `@Queue(...)` decorator annotations | decorator task |
|
|
19
|
+
|
|
20
|
+
### Classification signals (phase 4): none
|
|
21
|
+
|
|
22
|
+
The pack mints **no** `classificationSignals`. It once emitted
|
|
23
|
+
`internality`/`worker` reachability signals targeted at model names
|
|
24
|
+
GUESSED from the worker file (model/repository import-path segments,
|
|
25
|
+
every PascalCase identifier, stripped task-name fragments). Those
|
|
26
|
+
targets are guesses about OTHER detectors' resources — this pack
|
|
27
|
+
discovers no resources itself — so in real repos they mostly matched
|
|
28
|
+
nothing and every miss surfaced as a `STALE_SIGNAL_TARGET` blocker
|
|
29
|
+
(236 in the unified dogfood) while adding no information: unknown
|
|
30
|
+
exposure already defaults user-facing and unknown lifecycle already
|
|
31
|
+
defaults enabled (ADR 0003 D5), so removal flips no classification and
|
|
32
|
+
shrinks no obligation set. Core's `STALE_SIGNAL_TARGET` detection
|
|
33
|
+
remains for genuinely stale authority signals. The
|
|
34
|
+
`trustedInternalEntryPoints` worker category binding
|
|
35
|
+
(`detector: gateforge.pack-task`) stays syntactically valid but is
|
|
36
|
+
unexercised: internality certification that relied on guessed worker
|
|
37
|
+
reachability is now honestly unavailable
|
|
38
|
+
(`INCOMPLETE_PROOF_SCOPE`, conservative user-facing default) instead
|
|
39
|
+
of guess-based.
|
|
40
|
+
|
|
41
|
+
### Detector vocabulary
|
|
42
|
+
|
|
43
|
+
- **Recognized task inventory** — each recognized construct carries:
|
|
44
|
+
- `retryPolicy: { maxAttempts: number, backoff: 'fixed' | 'exponential' }` — extracted from `defaultJobOptions.attempts` / `.backoff.type`, defaults to `{maxAttempts: 1, backoff: 'fixed'}`.
|
|
45
|
+
- `idempotencyKey: boolean` — true if `jobId` / `dedupKey` / `idempotencyKey` / `dedupe` appears in source.
|
|
46
|
+
- `terminalOn: string[]` — error types from `terminalOn: [...]` (terminal = no retry).
|
|
47
|
+
- `observability: boolean` — true if `metrics` / `tracing` / `.on('completed'|'failed'|'stalled', ...)` appears.
|
|
48
|
+
- `source: { file, line, col }` — declaration location.
|
|
49
|
+
- `framework: 'bullmq' | 'bee-queue' | 'custom-queue' | 'message-handler' | 'recurring' | 'decorator'`.
|
|
50
|
+
|
|
51
|
+
The inventory itself is not emitted on the wire (no resources, no
|
|
52
|
+
signals — phase 4); it drives the blocking vocabulary below and the
|
|
53
|
+
obligation contracts the pack claims.
|
|
54
|
+
|
|
55
|
+
- **Findings**
|
|
56
|
+
- `DUPLICATE_TASK_ID` — same id discovered twice; first wins.
|
|
57
|
+
- `AMBIGUOUS_HANDLER` — `register(...)` or `new CustomQueue(...)` with no resolvable handler reference. For the single-line `register(...)` shape this fires only when the file shows real queue evidence (an import from a known queue library — `bullmq`, `bull`, `bee-queue`, `celery`, `kue`, `agenda`, `pg-boss`, `sidekiq` — a queue-named module, or a queue constructor such as `new Queue(...)` / `new CustomQueue(...)`).
|
|
58
|
+
- `PARSE_ERROR` — file could not be read.
|
|
59
|
+
|
|
60
|
+
- **Unresolved**
|
|
61
|
+
- `UNPROVEN_QUEUE_REGISTRATION` — a handler-less `register('name')` in a file with no queue evidence: the shape is not provably a task registration, so the detector emits no worker signal and reports this typed blocking reason instead of the vague `AMBIGUOUS_HANDLER` finding (a browser service-worker registration produces nothing at all).
|
|
62
|
+
|
|
63
|
+
## Obligation contract vocabulary
|
|
64
|
+
|
|
65
|
+
Five contracts, every detected task generates all of them:
|
|
66
|
+
|
|
67
|
+
| Contract | Meaning | Example test in `example/task/` |
|
|
68
|
+
| --- | --- | --- |
|
|
69
|
+
| `task:retry-policy-enforced` | flaky task retries up to `maxAttempts` before final failure | flaky profile, 5 attempts before success |
|
|
70
|
+
| `task:idempotent` | same idempotency key is deduplicated | duplicate profile, side-effect runs once |
|
|
71
|
+
| `task:terminal-handled` | errors whose type is in `terminalOn` are NOT retried | terminal profile, 1 attempt only |
|
|
72
|
+
| `task:observability-recorded` | every execution (success + failure) emits an audit row in `runs.json` | every profile |
|
|
73
|
+
| `task:duplicate-delivery-handled` | duplicate deliveries produce exactly one side effect | duplicate profile |
|
|
74
|
+
|
|
75
|
+
The full obligation id is `<resourceId>:<contract>` — e.g.
|
|
76
|
+
`task.email.send:task:retry-policy-enforced`.
|
|
77
|
+
|
|
78
|
+
## Setup
|
|
79
|
+
|
|
80
|
+
```yaml
|
|
81
|
+
# .gateforge.yml
|
|
82
|
+
plugins:
|
|
83
|
+
- id: gateforge.pack-task
|
|
84
|
+
version: 0.1.0
|
|
85
|
+
transport: in-process
|
|
86
|
+
module: '@gate-forge/pack-task'
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The pack's default export is the pinned `{ discover(paths) }` contract.
|
|
90
|
+
|
|
91
|
+
## Entity adapter schema + audit trail
|
|
92
|
+
|
|
93
|
+
Every detected task generates `runs.json` audit rows when run against the example server. The witness reads them via the adapter contract:
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
{
|
|
97
|
+
resourceId: 'task.runs',
|
|
98
|
+
read(ctx, id) -> Promise<{ runId, attempts, sideEffectCount, terminal, ... }>,
|
|
99
|
+
normalize(body) -> { entityId, fields: { id, retries, sideEffectCount, terminal } },
|
|
100
|
+
deletion: 'archive',
|
|
101
|
+
environmentFingerprint: 'task-loopback-v1',
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
`TaskAuditAdapterSchema` + `validateTaskAuditAdapter` (mirrors
|
|
106
|
+
`pack-sqlalchemy`'s `EntityAdapterSchema`) enforce the contract
|
|
107
|
+
fail-closed.
|
|
108
|
+
|
|
109
|
+
## Example app
|
|
110
|
+
|
|
111
|
+
`example/task/server.js` (port 3004, `node:http` only):
|
|
112
|
+
|
|
113
|
+
| Route | Method | Behaviour |
|
|
114
|
+
| --- | --- | --- |
|
|
115
|
+
| `/health` | GET | `{ ok: true }` |
|
|
116
|
+
| `/tasks` | GET | list of registered task names |
|
|
117
|
+
| `/enqueue` | POST | `{ name, key?, profile, payload }` — enqueues a task |
|
|
118
|
+
| `/runs` | GET | audit trail (`runs.json`) |
|
|
119
|
+
|
|
120
|
+
Profiles:
|
|
121
|
+
- `flaky` — fails on attempts `1..maxAttempts-1`, succeeds on the last
|
|
122
|
+
- `duplicate` — always succeeds; same `key` is deduped
|
|
123
|
+
- `terminal` — throws `AuthError` immediately; no retry
|
|
124
|
+
- `normal` — always succeeds
|
|
125
|
+
|
|
126
|
+
Usage:
|
|
127
|
+
```sh
|
|
128
|
+
node example/task/server.js --port 3004
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Adversarial coverage
|
|
132
|
+
|
|
133
|
+
| Case | Behaviour asserted in `test/e2e.test.ts` |
|
|
134
|
+
| --- | --- |
|
|
135
|
+
| (a) flaky | 5 attempts, last attempt succeeds, 4 retry rows + 1 success row |
|
|
136
|
+
| (b + e) duplicate | same key deduped, `sideEffectCount` stays at 1 across two calls |
|
|
137
|
+
| (c) terminal | 1 attempt only, no retry, `terminal: true` |
|
|
138
|
+
| (d) observability | every enqueue appends to `runs.json` |
|
|
139
|
+
| (i) fake-green idempotent | `sideEffectCount` ≠ 2 on duplicate key (regression line) |
|
|
140
|
+
| (ii) fake-green terminal-handled | terminal does NOT retry (regression line) |
|
|
141
|
+
|
|
142
|
+
## Determinism
|
|
143
|
+
|
|
144
|
+
Same input paths + same file bytes → byte-identical discovery output:
|
|
145
|
+
no `Date.now()` / `Math.random()`; every array sorted; every name a
|
|
146
|
+
literal from the source; fixed key order on the wire.
|
|
147
|
+
|
|
148
|
+
## Development
|
|
149
|
+
|
|
150
|
+
```sh
|
|
151
|
+
npm test # vitest run
|
|
152
|
+
npm run typecheck
|
|
153
|
+
npm run build # tsc → dist/
|
|
154
|
+
node ../example/task/server.js --port 3004 # ad-hoc serve
|
|
155
|
+
```
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Entity-adapter schema (pack deliverable: "entity-adapter schema doc").
|
|
3
|
+
*
|
|
4
|
+
* The evidence-witness contract (interface pin #8, ADR 0002): an
|
|
5
|
+
* adapter is a reviewed, engine-side module whose default export
|
|
6
|
+
* executes GET-only reads against the target resource. The witness
|
|
7
|
+
* service loads `.gateforge/adapters/<resourceId>.mjs` and calls
|
|
8
|
+
* `read(ctx, id)` when a test asks for persistence evidence; the raw
|
|
9
|
+
* adapter response is never returned to the test process — only the
|
|
10
|
+
* `verdictRelevant` projection is.
|
|
11
|
+
*
|
|
12
|
+
* Adapter responsibilities (mirrored by {@link TaskAuditAdapterSchema}
|
|
13
|
+
* and enforced by {@link validateTaskAuditAdapter}):
|
|
14
|
+
* - `resourceId` — the resource this adapter proves; must match the
|
|
15
|
+
* file name (`<resourceId>.mjs`) so the registry binds by filename.
|
|
16
|
+
* - `read(ctx, id)` — GET-only fetch of one audit trail entry; returns
|
|
17
|
+
* the raw audit row from `runs.json`.
|
|
18
|
+
* - `normalize(body)` — project the raw audit row onto the evidence
|
|
19
|
+
* shape `{ entityId, fields }` where `fields` carry the contract
|
|
20
|
+
* verdicts (retry count, side-effect count, terminal flag, run id).
|
|
21
|
+
* - `deletion: 'hard' | 'archive'` — how removal manifests (audit
|
|
22
|
+
* trails archive by default: rows keep existing retrievable).
|
|
23
|
+
* - `environmentFingerprint` — header value to check (the example
|
|
24
|
+
* server answers `x-gateforge-env: task-loopback-v1`).
|
|
25
|
+
*/
|
|
26
|
+
import { z } from 'zod';
|
|
27
|
+
/** The evidence shape `normalize` must return. */
|
|
28
|
+
export interface NormalizedAuditEntity {
|
|
29
|
+
/** The audit entry id, extracted from the raw body. */
|
|
30
|
+
entityId: string;
|
|
31
|
+
/** Projected fields the obligation's `expectFields` can match. */
|
|
32
|
+
fields: Record<string, unknown>;
|
|
33
|
+
}
|
|
34
|
+
/** Context handed to `read` by the witness service. */
|
|
35
|
+
export interface TaskAuditAdapterContext {
|
|
36
|
+
/** Base URL of the target environment (loopback, trusted). */
|
|
37
|
+
baseUrl: string;
|
|
38
|
+
/** Per-request headers (e.g. the run token for authenticity). */
|
|
39
|
+
headers?: Record<string, string>;
|
|
40
|
+
}
|
|
41
|
+
/** The frozen adapter module contract (pin #8). */
|
|
42
|
+
export interface TaskAuditAdapter {
|
|
43
|
+
resourceId: string;
|
|
44
|
+
read(ctx: TaskAuditAdapterContext, id: string): Promise<unknown>;
|
|
45
|
+
normalize(body: unknown): NormalizedAuditEntity;
|
|
46
|
+
deletion: 'hard' | 'archive';
|
|
47
|
+
environmentFingerprint: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Zod schema for the data fields of an adapter module (functions are
|
|
51
|
+
* checked by {@link validateTaskAuditAdapter} for a single-cause
|
|
52
|
+
* diagnostic list; zod function schemas would blur the message).
|
|
53
|
+
*/
|
|
54
|
+
export declare const TaskAuditAdapterSchema: z.ZodObject<{
|
|
55
|
+
resourceId: z.ZodString;
|
|
56
|
+
deletion: z.ZodEnum<{
|
|
57
|
+
hard: "hard";
|
|
58
|
+
archive: "archive";
|
|
59
|
+
}>;
|
|
60
|
+
environmentFingerprint: z.ZodString;
|
|
61
|
+
read: z.ZodUnknown;
|
|
62
|
+
normalize: z.ZodUnknown;
|
|
63
|
+
}, z.core.$strict>;
|
|
64
|
+
/** Outcome of {@link validateTaskAuditAdapter}. */
|
|
65
|
+
export type TaskAuditAdapterValidation = {
|
|
66
|
+
ok: true;
|
|
67
|
+
adapter: TaskAuditAdapter;
|
|
68
|
+
} | {
|
|
69
|
+
ok: false;
|
|
70
|
+
issues: string[];
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* Validates an adapter module against the frozen contract, failing
|
|
74
|
+
* closed with one issue per violated field.
|
|
75
|
+
*
|
|
76
|
+
* Args:
|
|
77
|
+
* value: The default export of an `.mjs` adapter module.
|
|
78
|
+
*
|
|
79
|
+
* Returns:
|
|
80
|
+
* TaskAuditAdapterValidation: The typed adapter, or every issue found.
|
|
81
|
+
*/
|
|
82
|
+
export declare function validateTaskAuditAdapter(value: unknown): TaskAuditAdapterValidation;
|
|
83
|
+
//# sourceMappingURL=adapter-schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter-schema.d.ts","sourceRoot":"","sources":["../src/adapter-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,kDAAkD;AAClD,MAAM,WAAW,qBAAqB;IACpC,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,WAAW,uBAAuB;IACtC,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,mDAAmD;AACnD,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,GAAG,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,qBAAqB,CAAC;IAChD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;kBAQxB,CAAC;AAEZ,mDAAmD;AACnD,MAAM,MAAM,0BAA0B,GAClC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAA;CAAE,GACvC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEpC;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAkBnF"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Entity-adapter schema (pack deliverable: "entity-adapter schema doc").
|
|
3
|
+
*
|
|
4
|
+
* The evidence-witness contract (interface pin #8, ADR 0002): an
|
|
5
|
+
* adapter is a reviewed, engine-side module whose default export
|
|
6
|
+
* executes GET-only reads against the target resource. The witness
|
|
7
|
+
* service loads `.gateforge/adapters/<resourceId>.mjs` and calls
|
|
8
|
+
* `read(ctx, id)` when a test asks for persistence evidence; the raw
|
|
9
|
+
* adapter response is never returned to the test process — only the
|
|
10
|
+
* `verdictRelevant` projection is.
|
|
11
|
+
*
|
|
12
|
+
* Adapter responsibilities (mirrored by {@link TaskAuditAdapterSchema}
|
|
13
|
+
* and enforced by {@link validateTaskAuditAdapter}):
|
|
14
|
+
* - `resourceId` — the resource this adapter proves; must match the
|
|
15
|
+
* file name (`<resourceId>.mjs`) so the registry binds by filename.
|
|
16
|
+
* - `read(ctx, id)` — GET-only fetch of one audit trail entry; returns
|
|
17
|
+
* the raw audit row from `runs.json`.
|
|
18
|
+
* - `normalize(body)` — project the raw audit row onto the evidence
|
|
19
|
+
* shape `{ entityId, fields }` where `fields` carry the contract
|
|
20
|
+
* verdicts (retry count, side-effect count, terminal flag, run id).
|
|
21
|
+
* - `deletion: 'hard' | 'archive'` — how removal manifests (audit
|
|
22
|
+
* trails archive by default: rows keep existing retrievable).
|
|
23
|
+
* - `environmentFingerprint` — header value to check (the example
|
|
24
|
+
* server answers `x-gateforge-env: task-loopback-v1`).
|
|
25
|
+
*/
|
|
26
|
+
import { z } from 'zod';
|
|
27
|
+
/**
|
|
28
|
+
* Zod schema for the data fields of an adapter module (functions are
|
|
29
|
+
* checked by {@link validateTaskAuditAdapter} for a single-cause
|
|
30
|
+
* diagnostic list; zod function schemas would blur the message).
|
|
31
|
+
*/
|
|
32
|
+
export const TaskAuditAdapterSchema = z
|
|
33
|
+
.object({
|
|
34
|
+
resourceId: z.string().min(1),
|
|
35
|
+
deletion: z.enum(['hard', 'archive']),
|
|
36
|
+
environmentFingerprint: z.string().min(1),
|
|
37
|
+
read: z.unknown(),
|
|
38
|
+
normalize: z.unknown(),
|
|
39
|
+
})
|
|
40
|
+
.strict();
|
|
41
|
+
/**
|
|
42
|
+
* Validates an adapter module against the frozen contract, failing
|
|
43
|
+
* closed with one issue per violated field.
|
|
44
|
+
*
|
|
45
|
+
* Args:
|
|
46
|
+
* value: The default export of an `.mjs` adapter module.
|
|
47
|
+
*
|
|
48
|
+
* Returns:
|
|
49
|
+
* TaskAuditAdapterValidation: The typed adapter, or every issue found.
|
|
50
|
+
*/
|
|
51
|
+
export function validateTaskAuditAdapter(value) {
|
|
52
|
+
const parsed = TaskAuditAdapterSchema.safeParse(value);
|
|
53
|
+
if (!parsed.success) {
|
|
54
|
+
return {
|
|
55
|
+
ok: false,
|
|
56
|
+
issues: parsed.error.issues.map((issue) => `${issue.path.join('.')}: ${issue.message}`),
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
const candidate = value;
|
|
60
|
+
const issues = [];
|
|
61
|
+
if (typeof candidate.read !== 'function') {
|
|
62
|
+
issues.push('read: must be a function (ctx, id) => Promise<unknown>');
|
|
63
|
+
}
|
|
64
|
+
if (typeof candidate.normalize !== 'function') {
|
|
65
|
+
issues.push('normalize: must be a function (body) => { entityId, fields }');
|
|
66
|
+
}
|
|
67
|
+
if (issues.length > 0)
|
|
68
|
+
return { ok: false, issues };
|
|
69
|
+
return { ok: true, adapter: value };
|
|
70
|
+
}
|
|
71
|
+
//# sourceMappingURL=adapter-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter-schema.js","sourceRoot":"","sources":["../src/adapter-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA2BxB;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;IACjB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;CACvB,CAAC;KACD,MAAM,EAAE,CAAC;AAOZ;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;SACxF,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,KAAkC,CAAC;IACrD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACzC,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QAC9C,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACpD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAyB,EAAE,CAAC;AAC1D,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { DiscoveryOutcome } from '@gate-forge/plugin-protocol';
|
|
2
|
+
/** Attributes attached to every detected `task.resource`. */
|
|
3
|
+
export interface TaskResourceAttributes {
|
|
4
|
+
/** Literal task name extracted from the source. */
|
|
5
|
+
taskName: string;
|
|
6
|
+
/** Detection pattern that produced this resource. */
|
|
7
|
+
framework: 'bullmq' | 'bee-queue' | 'custom-queue' | 'message-handler' | 'recurring' | 'decorator';
|
|
8
|
+
/** Retry policy: max attempts + backoff kind (defaults applied if absent). */
|
|
9
|
+
retryPolicy: {
|
|
10
|
+
maxAttempts: number;
|
|
11
|
+
backoff: 'fixed' | 'exponential';
|
|
12
|
+
};
|
|
13
|
+
/** True if the source declares an idempotency key / dedup hint. */
|
|
14
|
+
idempotencyKey: boolean;
|
|
15
|
+
/** Error types whose occurrence marks the task terminal (no retry). */
|
|
16
|
+
terminalOn: string[];
|
|
17
|
+
/** True if the source declares observability hooks (metrics/tracing/listeners). */
|
|
18
|
+
observability: boolean;
|
|
19
|
+
/** Source declaration location (file + line + col). */
|
|
20
|
+
source: {
|
|
21
|
+
file: string;
|
|
22
|
+
line: number;
|
|
23
|
+
col: number;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
/** Options for {@link createTaskDetector}. */
|
|
27
|
+
export interface TaskDetectorOptions {
|
|
28
|
+
/** Override the repo root used for relative path computation. */
|
|
29
|
+
rootDir?: string;
|
|
30
|
+
}
|
|
31
|
+
/** The pinned in-process plugin contract: `{ discover(paths) }`. */
|
|
32
|
+
export interface TaskDetector {
|
|
33
|
+
discover(paths: string[]): Promise<DiscoveryOutcome>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Creates a discover-capable detector module. The default export of the
|
|
37
|
+
* pack is an instance with no overrides.
|
|
38
|
+
*
|
|
39
|
+
* Args:
|
|
40
|
+
* options: Optional `{ rootDir }` override (defaults to `process.cwd()`).
|
|
41
|
+
*
|
|
42
|
+
* Returns:
|
|
43
|
+
* TaskDetector: A `{ discover(paths) }` callable.
|
|
44
|
+
*/
|
|
45
|
+
export declare function createTaskDetector(options?: TaskDetectorOptions): TaskDetector;
|
|
46
|
+
/** The pinned in-process plugin contract: `{ discover(paths) }`. */
|
|
47
|
+
export declare const discover: TaskDetector['discover'];
|
|
48
|
+
//# sourceMappingURL=detector.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"detector.d.ts","sourceRoot":"","sources":["../src/detector.ts"],"names":[],"mappings":"AA0EA,OAAO,KAAK,EAAE,gBAAgB,EAAW,MAAM,6BAA6B,CAAC;AAE7E,6DAA6D;AAC7D,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,qDAAqD;IACrD,SAAS,EAAE,QAAQ,GAAG,WAAW,GAAG,cAAc,GAAG,iBAAiB,GAAG,WAAW,GAAG,WAAW,CAAC;IACnG,8EAA8E;IAC9E,WAAW,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,GAAG,aAAa,CAAA;KAAE,CAAC;IACvE,mEAAmE;IACnE,cAAc,EAAE,OAAO,CAAC;IACxB,uEAAuE;IACvE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,mFAAmF;IACnF,aAAa,EAAE,OAAO,CAAC;IACvB,uDAAuD;IACvD,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACrD;AAED,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IAClC,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oEAAoE;AACpE,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACtD;AAuED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,GAAG,YAAY,CA+BlF;AAyiBD,oEAAoE;AACpE,eAAO,MAAM,QAAQ,EAAE,YAAY,CAAC,UAAU,CAA8C,CAAC"}
|