@gr8ful/spf 0.3.0 → 0.4.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/README.md +55 -5
- package/assets/defaults/spf.config.yaml +16 -0
- package/assets/prompts/refiner/system.md +53 -0
- package/assets/prompts/refiner/user.md +70 -0
- package/assets/skill/references/config.md +38 -2
- package/assets/templates/ts-cc.spf.config.yaml +3 -3
- package/assets/templates/ts.spf.config.yaml +10 -2
- package/dist/chains/context.d.ts +9 -0
- package/dist/chains/index.js +5 -0
- package/dist/chains/steps.d.ts +24 -0
- package/dist/chains/steps.js +55 -4
- package/dist/cli/commands/doctor.js +6 -0
- package/dist/cli/commands/init.js +30 -3
- package/dist/cli/commands/install-skill.js +5 -2
- package/dist/cli/commands/list.js +1 -0
- package/dist/cli/commands/run.js +5 -1
- package/dist/cli/commands/watch.js +69 -8
- package/dist/cli/index.js +3 -3
- package/dist/cli/interview.js +17 -0
- package/dist/core/data_types.d.ts +78 -0
- package/dist/core/data_types.js +42 -0
- package/dist/core/gates.d.ts +13 -0
- package/dist/core/gates.js +103 -0
- package/dist/core/issues/github_provider.d.ts +35 -9
- package/dist/core/issues/github_provider.js +76 -28
- package/dist/core/issues/jira_provider.d.ts +14 -1
- package/dist/core/issues/jira_provider.js +9 -7
- package/dist/core/issues/provider.d.ts +77 -15
- package/dist/core/issues/provider.js +7 -4
- package/dist/core/notify/channel.d.ts +1 -1
- package/dist/core/refine.d.ts +39 -0
- package/dist/core/refine.js +144 -0
- package/dist/core/watch.d.ts +56 -1
- package/dist/core/watch.js +200 -11
- package/dist/test/chains.test.js +1 -0
- package/dist/test/init_command.test.js +17 -0
- package/dist/test/interview.test.js +4 -3
- package/dist/test/refine.test.d.ts +1 -0
- package/dist/test/refine.test.js +126 -0
- package/dist/test/watch.test.js +173 -5
- package/package.json +1 -1
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
const API = "https://api.github.com";
|
|
2
|
-
const STATES = ["ready", "working", "review", "done", "blocked"];
|
|
2
|
+
const STATES = ["ready", "working", "review", "done", "blocked", "spec-ready", "refining", "refined"];
|
|
3
3
|
const MARKER_RE = /<!--\s*spf-watch:\s*(\{.*?\})\s*-->/s;
|
|
4
|
+
/** The refine lane's leaf/container taxonomy — see `data_types.ts`'s `RefinedIssueSchema.kind`. Not a `WatchState`: these never appear on the left of a `transition()` call, so `transition()` never strips them. */
|
|
5
|
+
export const ISSUE_KINDS = ["epic", "feature", "story", "bug", "task"];
|
|
4
6
|
// GitHub label colors are 6 hex digits, no leading '#'.
|
|
5
7
|
const LABEL_META = {
|
|
6
8
|
ready: { color: "0e8a16", description: "spf watch will claim this issue on its next poll" },
|
|
@@ -8,6 +10,16 @@ const LABEL_META = {
|
|
|
8
10
|
review: { color: "1d76db", description: "spf watch opened a PR for this issue — awaiting merge" },
|
|
9
11
|
done: { color: "5319e7", description: "spf watch's PR for this issue merged" },
|
|
10
12
|
blocked: { color: "d93f0b", description: "spf watch gave up — needs a human" },
|
|
13
|
+
"spec-ready": { color: "0e8a16", description: "spf watch's refine lane will claim this spec on its next poll" },
|
|
14
|
+
refining: { color: "fbca04", description: "spf watch has claimed this spec and is decomposing it into issues" },
|
|
15
|
+
refined: { color: "c2e0c6", description: "generated by spf watch's refine lane — promote to spf:ready when it's worth building" },
|
|
16
|
+
};
|
|
17
|
+
const TYPE_LABEL_META = {
|
|
18
|
+
epic: { color: "5319e7", description: "a container generated by spf watch's refine lane — not directly workable" },
|
|
19
|
+
feature: { color: "1d76db", description: "a container generated by spf watch's refine lane — not directly workable" },
|
|
20
|
+
story: { color: "bfd4f2", description: "a leaf generated by spf watch's refine lane — vertical-slice, independently workable" },
|
|
21
|
+
bug: { color: "e99695", description: "a leaf generated by spf watch's refine lane — vertical-slice, independently workable" },
|
|
22
|
+
task: { color: "d4c5f9", description: "a leaf generated by spf watch's refine lane — vertical-slice, independently workable" },
|
|
11
23
|
};
|
|
12
24
|
export class GitHubProvider {
|
|
13
25
|
repo;
|
|
@@ -41,6 +53,9 @@ export class GitHubProvider {
|
|
|
41
53
|
label(state) {
|
|
42
54
|
return `${this.labelPrefix}:${state}`;
|
|
43
55
|
}
|
|
56
|
+
typeLabel(kind) {
|
|
57
|
+
return `${this.labelPrefix}:type:${kind}`;
|
|
58
|
+
}
|
|
44
59
|
/** `null` on a real 404 (label doesn't exist yet) — any other non-2xx still throws, same as `gh()`. */
|
|
45
60
|
async getLabel(name) {
|
|
46
61
|
const response = await fetch(`${API}/repos/${this.repo}/labels/${encodeURIComponent(name)}`, {
|
|
@@ -55,39 +70,45 @@ export class GitHubProvider {
|
|
|
55
70
|
return (await response.json());
|
|
56
71
|
}
|
|
57
72
|
/**
|
|
58
|
-
* Idempotent by inspection, not by "create and catch a 422": GET
|
|
73
|
+
* Idempotent by inspection, not by "create and catch a 422": GET the
|
|
59
74
|
* label first, then create/update/leave alone depending on what's
|
|
60
75
|
* actually there. One fewer request in the common "already correct"
|
|
61
76
|
* case, and no brittle matching against GitHub's error-message text.
|
|
77
|
+
* Shared by `ensureLabels()`'s state-label and type-label passes.
|
|
62
78
|
*/
|
|
79
|
+
async ensureOneLabel(name, color, description, result) {
|
|
80
|
+
const existing = await this.getLabel(name);
|
|
81
|
+
if (!existing) {
|
|
82
|
+
await this.gh(`/repos/${this.repo}/labels`, { method: "POST", body: JSON.stringify({ name, color, description }) });
|
|
83
|
+
result.created.push(name);
|
|
84
|
+
}
|
|
85
|
+
else if (existing.color !== color || (existing.description ?? "") !== description) {
|
|
86
|
+
await this.gh(`/repos/${this.repo}/labels/${encodeURIComponent(name)}`, {
|
|
87
|
+
method: "PATCH",
|
|
88
|
+
body: JSON.stringify({ color, description }),
|
|
89
|
+
});
|
|
90
|
+
result.updated.push(name);
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
result.unchanged.push(name);
|
|
94
|
+
}
|
|
95
|
+
}
|
|
63
96
|
async ensureLabels() {
|
|
64
|
-
const
|
|
65
|
-
const updated = [];
|
|
66
|
-
const unchanged = [];
|
|
97
|
+
const result = { created: [], updated: [], unchanged: [] };
|
|
67
98
|
for (const state of STATES) {
|
|
68
|
-
const name = this.label(state);
|
|
69
99
|
const { color, description } = LABEL_META[state];
|
|
70
|
-
|
|
71
|
-
if (!existing) {
|
|
72
|
-
await this.gh(`/repos/${this.repo}/labels`, { method: "POST", body: JSON.stringify({ name, color, description }) });
|
|
73
|
-
created.push(name);
|
|
74
|
-
}
|
|
75
|
-
else if (existing.color !== color || (existing.description ?? "") !== description) {
|
|
76
|
-
await this.gh(`/repos/${this.repo}/labels/${encodeURIComponent(name)}`, {
|
|
77
|
-
method: "PATCH",
|
|
78
|
-
body: JSON.stringify({ color, description }),
|
|
79
|
-
});
|
|
80
|
-
updated.push(name);
|
|
81
|
-
}
|
|
82
|
-
else {
|
|
83
|
-
unchanged.push(name);
|
|
84
|
-
}
|
|
100
|
+
await this.ensureOneLabel(this.label(state), color, description, result);
|
|
85
101
|
}
|
|
86
|
-
|
|
102
|
+
for (const kind of ISSUE_KINDS) {
|
|
103
|
+
const { color, description } = TYPE_LABEL_META[kind];
|
|
104
|
+
await this.ensureOneLabel(this.typeLabel(kind), color, description, result);
|
|
105
|
+
}
|
|
106
|
+
return result;
|
|
87
107
|
}
|
|
88
108
|
toIssue(raw) {
|
|
89
109
|
return {
|
|
90
110
|
id: String(raw.number),
|
|
111
|
+
internal_id: String(raw.id),
|
|
91
112
|
title: raw.title,
|
|
92
113
|
body: raw.body ?? "",
|
|
93
114
|
labels: raw.labels.map((l) => (typeof l === "string" ? l : l.name)),
|
|
@@ -103,22 +124,24 @@ export class GitHubProvider {
|
|
|
103
124
|
async listInState(state, opts) {
|
|
104
125
|
return this.listByLabel(this.label(state), opts?.includeAll ? "all" : "open");
|
|
105
126
|
}
|
|
106
|
-
async claim(issue) {
|
|
107
|
-
|
|
127
|
+
async claim(issue, opts) {
|
|
128
|
+
const from = this.label(opts?.from ?? "ready");
|
|
129
|
+
const to = this.label(opts?.to ?? "working");
|
|
130
|
+
await this.gh(`/repos/${this.repo}/issues/${issue.id}/labels/${encodeURIComponent(from)}`, {
|
|
108
131
|
method: "DELETE",
|
|
109
132
|
}).catch(() => undefined); // already gone is fine
|
|
110
133
|
await this.gh(`/repos/${this.repo}/issues/${issue.id}/labels`, {
|
|
111
134
|
method: "POST",
|
|
112
|
-
body: JSON.stringify({ labels: [
|
|
135
|
+
body: JSON.stringify({ labels: [to] }),
|
|
113
136
|
});
|
|
114
137
|
const fresh = await this.gh(`/repos/${this.repo}/issues/${issue.id}`);
|
|
115
138
|
const labels = this.toIssue(fresh).labels;
|
|
116
|
-
const claimed = labels.includes(
|
|
139
|
+
const claimed = labels.includes(to) && !labels.includes(from);
|
|
117
140
|
if (!claimed) {
|
|
118
|
-
// Lost the race (or something else relabeled it) — put
|
|
141
|
+
// Lost the race (or something else relabeled it) — put the source label back so it's not stuck.
|
|
119
142
|
await this.gh(`/repos/${this.repo}/issues/${issue.id}/labels`, {
|
|
120
143
|
method: "POST",
|
|
121
|
-
body: JSON.stringify({ labels: [
|
|
144
|
+
body: JSON.stringify({ labels: [from] }),
|
|
122
145
|
}).catch(() => undefined);
|
|
123
146
|
}
|
|
124
147
|
return claimed;
|
|
@@ -173,6 +196,31 @@ export class GitHubProvider {
|
|
|
173
196
|
}
|
|
174
197
|
return { merged: detail.merged, state: detail.state, ciStatus };
|
|
175
198
|
}
|
|
199
|
+
/** `IssueAuthoringProvider` — the refine lane's own need (see `provider.ts`'s module doc). */
|
|
200
|
+
async createIssue(input) {
|
|
201
|
+
const raw = await this.gh(`/repos/${this.repo}/issues`, {
|
|
202
|
+
method: "POST",
|
|
203
|
+
body: JSON.stringify({ title: input.title, body: input.body, labels: input.labels }),
|
|
204
|
+
});
|
|
205
|
+
return this.toIssue(raw);
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* `POST /repos/{o}/{r}/issues/{parent_number}/sub_issues` — GitHub's
|
|
209
|
+
* native sub-issue link. Confirmed against GitHub's own REST docs: the
|
|
210
|
+
* body param is `sub_issue_id`, the CHILD's database id, not its issue
|
|
211
|
+
* number — hence `linkChild` requiring `child.internal_id` rather than
|
|
212
|
+
* `child.id`. GitHub's documented limits (not enforced client-side here):
|
|
213
|
+
* 100 sub-issues per parent, 8 levels of nesting.
|
|
214
|
+
*/
|
|
215
|
+
async linkChild(parent, child) {
|
|
216
|
+
if (!child.internal_id) {
|
|
217
|
+
throw new Error(`linkChild: child issue #${child.id} has no internal_id — only an issue this provider just created/fetched can be linked`);
|
|
218
|
+
}
|
|
219
|
+
await this.gh(`/repos/${this.repo}/issues/${parent.id}/sub_issues`, {
|
|
220
|
+
method: "POST",
|
|
221
|
+
body: JSON.stringify({ sub_issue_id: Number(child.internal_id) }),
|
|
222
|
+
});
|
|
223
|
+
}
|
|
176
224
|
async findMarkerComment(issueId) {
|
|
177
225
|
const comments = await this.gh(`/repos/${this.repo}/issues/${issueId}/comments?per_page=100`);
|
|
178
226
|
let found = null;
|
|
@@ -29,6 +29,16 @@
|
|
|
29
29
|
* `ensureLabels()` is a no-op that reports the labels this run will use:
|
|
30
30
|
* Jira labels are freeform strings with no color/description registry to
|
|
31
31
|
* seed, unlike GitHub's.
|
|
32
|
+
*
|
|
33
|
+
* Does NOT implement `IssueAuthoringProvider` — the refine lane's create/
|
|
34
|
+
* link seam. Jira maps cleanly in principle (native issue types plus a
|
|
35
|
+
* `parent` field give a real hierarchy, unlike the label trick this file
|
|
36
|
+
* already leans on for state), but that is a real implementation, not a
|
|
37
|
+
* one-line stub, so it is a deliberate follow-on rather than done here.
|
|
38
|
+
* `resolveIssueAuthoringProvider()` (`cli/commands/watch.ts`) returns `null`
|
|
39
|
+
* for this provider, and `watch.refine.enabled: true` with
|
|
40
|
+
* `issue_provider: jira` fails loudly at startup rather than silently
|
|
41
|
+
* running a refine lane that can never publish anything.
|
|
32
42
|
*/
|
|
33
43
|
import type { EnsureLabelsResult, Issue, IssueProvider, WatchMarker, WatchState } from "./provider.ts";
|
|
34
44
|
export declare class JiraProvider implements IssueProvider {
|
|
@@ -63,7 +73,10 @@ export declare class JiraProvider implements IssueProvider {
|
|
|
63
73
|
* could make a `review`-labeled issue vanish from an unfiltered query.
|
|
64
74
|
*/
|
|
65
75
|
listInState(state: WatchState): Promise<Issue[]>;
|
|
66
|
-
claim(issue: Issue
|
|
76
|
+
claim(issue: Issue, opts?: {
|
|
77
|
+
from?: WatchState;
|
|
78
|
+
to?: WatchState;
|
|
79
|
+
}): Promise<boolean>;
|
|
67
80
|
transition(issue: Issue, to: WatchState, detail?: string): Promise<void>;
|
|
68
81
|
comment(issue: Issue, body: string): Promise<void>;
|
|
69
82
|
private findMarkerComment;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const STATES = ["ready", "working", "review", "done", "blocked"];
|
|
1
|
+
const STATES = ["ready", "working", "review", "done", "blocked", "spec-ready", "refining", "refined"];
|
|
2
2
|
const MARKER_RE = /\[spf-watch-marker\]\s*(\{.*?\})/s;
|
|
3
3
|
function toAdf(text) {
|
|
4
4
|
return {
|
|
@@ -103,16 +103,18 @@ export class JiraProvider {
|
|
|
103
103
|
async listInState(state) {
|
|
104
104
|
return this.searchByLabel(this.label(state));
|
|
105
105
|
}
|
|
106
|
-
async claim(issue) {
|
|
107
|
-
const
|
|
108
|
-
|
|
106
|
+
async claim(issue, opts) {
|
|
107
|
+
const from = this.label(opts?.from ?? "ready");
|
|
108
|
+
const to = this.label(opts?.to ?? "working");
|
|
109
|
+
const next = issue.labels.filter((l) => l !== from);
|
|
110
|
+
next.push(to);
|
|
109
111
|
await this.jira(`/rest/api/3/issue/${issue.id}`, { method: "PUT", body: JSON.stringify({ fields: { labels: next } }) });
|
|
110
112
|
const fresh = await this.jira(`/rest/api/3/issue/${issue.id}?fields=summary,description,labels`);
|
|
111
113
|
const labels = fresh.fields.labels;
|
|
112
|
-
const claimed = labels.includes(
|
|
114
|
+
const claimed = labels.includes(to) && !labels.includes(from);
|
|
113
115
|
if (!claimed) {
|
|
114
|
-
const revert = labels.filter((l) => l !==
|
|
115
|
-
revert.push(
|
|
116
|
+
const revert = labels.filter((l) => l !== to);
|
|
117
|
+
revert.push(from);
|
|
116
118
|
await this.jira(`/rest/api/3/issue/${issue.id}`, { method: "PUT", body: JSON.stringify({ fields: { labels: revert } }) }).catch(() => undefined);
|
|
117
119
|
}
|
|
118
120
|
return claimed;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* The seams `spf watch` drives — the abstraction the user's own reference
|
|
3
|
+
* implementation (a GitHub-issues SDLC poller) never had: its GitHub client
|
|
4
|
+
* is a concrete class referenced by type everywhere, so adding a second
|
|
5
|
+
* tracker would mean reworking the poll loop itself.
|
|
6
6
|
*
|
|
7
7
|
* `IssueProvider` (tracker: list/claim/transition/comment/markers) and
|
|
8
8
|
* `CodeHostProvider` (PR lifecycle: open/status) are deliberately separate
|
|
@@ -13,19 +13,45 @@
|
|
|
13
13
|
* implements only `IssueProvider`, `bitbucket_provider.ts` only
|
|
14
14
|
* `CodeHostProvider` — any tracker x host combination is just config
|
|
15
15
|
* (`watch.issue_provider` x `watch.code_host`), never a poll-loop change.
|
|
16
|
+
* `IssueAuthoringProvider` (create/link, at the bottom of this file) is a
|
|
17
|
+
* third, again separate — the refine lane's own need, optional per tracker,
|
|
18
|
+
* and orthogonal to which one is the code host.
|
|
16
19
|
*
|
|
17
20
|
* The label-as-state-machine design is deliberate, copied from that same
|
|
18
21
|
* reference: `transition()` is the ONE mutator, so every state change is
|
|
19
22
|
* traceable to one call site, and a provider can layer notifications
|
|
20
23
|
* (Slack, a webhook, whatever) on top of it without the poll loop caring.
|
|
21
24
|
*/
|
|
22
|
-
|
|
25
|
+
/**
|
|
26
|
+
* `spec-ready`/`refining` drive the SECOND lane's state machine (a product
|
|
27
|
+
* spec being decomposed — see `reconcileRefining`/`claimSpecs` in
|
|
28
|
+
* `watch.ts`), independent of the build lane's own `ready..blocked` states.
|
|
29
|
+
* `refined` is not a lane state at all — it never appears on the left of a
|
|
30
|
+
* `transition()` call. It is the terminal label a generated LEAF issue
|
|
31
|
+
* (story/bug/task) gets, marking it awaiting a human's promotion to `ready`.
|
|
32
|
+
* All eight still live in one `WatchState` union (not two separate unions)
|
|
33
|
+
* because `transition()`'s "strip every `<prefix>:<state>` label, then add
|
|
34
|
+
* one" logic (see `github_provider.ts`/`jira_provider.ts`) has to know about
|
|
35
|
+
* every one of them to strip correctly, and `ensureLabels()` seeds all of
|
|
36
|
+
* them from one `STATES` array.
|
|
37
|
+
*/
|
|
38
|
+
export type WatchState = "ready" | "working" | "review" | "done" | "blocked" | "spec-ready" | "refining" | "refined";
|
|
23
39
|
export interface Issue {
|
|
24
40
|
/** Opaque tracker identifier: a GitHub issue number stringified ("42"), a Jira key ("PROJ-123"). */
|
|
25
41
|
id: string;
|
|
26
42
|
title: string;
|
|
27
43
|
body: string;
|
|
28
44
|
labels: string[];
|
|
45
|
+
/**
|
|
46
|
+
* The tracker's own internal/database id, distinct from `id` (the
|
|
47
|
+
* human-facing number/key) — only populated where an authoring operation
|
|
48
|
+
* needs it. GitHub's sub-issue API is the reason this exists: `POST
|
|
49
|
+
* /repos/{o}/{r}/issues/{n}/sub_issues` takes `sub_issue_id` as the
|
|
50
|
+
* issue's database id, not its issue number, so `linkChild()` cannot work
|
|
51
|
+
* from `id` alone. `undefined` on any issue this provider didn't just
|
|
52
|
+
* create/fetch with that field available.
|
|
53
|
+
*/
|
|
54
|
+
internal_id?: string;
|
|
29
55
|
}
|
|
30
56
|
export interface PrRef {
|
|
31
57
|
number: number;
|
|
@@ -42,12 +68,18 @@ export interface PrStatus {
|
|
|
42
68
|
* on the issue itself — zero infrastructure, survives a daemon crash,
|
|
43
69
|
* human-readable. `attempt` bounds orphan-retry (see `watch.ts`); `ciFixes`
|
|
44
70
|
* is reserved for a future fix-loop, unused by the lean v1 poll logic.
|
|
71
|
+
* `refined` is the refine lane's own idempotency record: the ids of every
|
|
72
|
+
* issue a completed publish pass created for this spec. A re-claimed spec
|
|
73
|
+
* whose marker already lists them skips creation entirely — `to-tickets`
|
|
74
|
+
* (the skill this lane's prompt is ported from) has no such guard and
|
|
75
|
+
* duplicates every ticket on a re-run; this is what closes that gap.
|
|
45
76
|
*/
|
|
46
77
|
export interface WatchMarker {
|
|
47
78
|
worktree?: string;
|
|
48
79
|
branch?: string;
|
|
49
80
|
pr?: number;
|
|
50
81
|
attempt?: number;
|
|
82
|
+
refined?: string[];
|
|
51
83
|
}
|
|
52
84
|
/** What `ensureLabels()` actually did, per label — for `spf watch init`'s report. */
|
|
53
85
|
export interface EnsureLabelsResult {
|
|
@@ -58,11 +90,12 @@ export interface EnsureLabelsResult {
|
|
|
58
90
|
export interface IssueProvider {
|
|
59
91
|
/**
|
|
60
92
|
* Idempotently seed whatever this tracker needs for the state machine to
|
|
61
|
-
* work at all — GitHub:
|
|
62
|
-
*
|
|
63
|
-
* with
|
|
64
|
-
*
|
|
65
|
-
*
|
|
93
|
+
* work at all — GitHub: every `<prefix>:*` state label plus the
|
|
94
|
+
* `<prefix>:type:*` vocabulary the refine lane's generated issues carry,
|
|
95
|
+
* each with a color and description, created if missing and corrected if
|
|
96
|
+
* drifted. A tracker with no such concept (Jira labels are freeform
|
|
97
|
+
* strings, not seedable objects) can make this a no-op — `spf watch init`
|
|
98
|
+
* just reports whatever comes back, empty results included.
|
|
66
99
|
*/
|
|
67
100
|
ensureLabels(): Promise<EnsureLabelsResult>;
|
|
68
101
|
/** Issues currently labeled `<prefix>:ready`. */
|
|
@@ -81,12 +114,20 @@ export interface IssueProvider {
|
|
|
81
114
|
includeAll?: boolean;
|
|
82
115
|
}): Promise<Issue[]>;
|
|
83
116
|
/**
|
|
84
|
-
* Move `ready` -> `
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* the
|
|
117
|
+
* Move `opts.from` (default `ready`) -> `opts.to` (default `working`),
|
|
118
|
+
* with a read-back verify (like the reference implementation's
|
|
119
|
+
* `claimIssue`) — not a true atomic claim, but enough to catch the common
|
|
120
|
+
* case; the real safety net against two daemons racing the same issue is
|
|
121
|
+
* `spf watch`'s own single-instance lockfile. Parameterized so the refine
|
|
122
|
+
* lane's `spec-ready -> refining` claim (see `claimSpecs` in `watch.ts`)
|
|
123
|
+
* reuses the identical DELETE-from/POST-to/read-back-verify dance the
|
|
124
|
+
* build lane's `ready -> working` claim already does, rather than a
|
|
125
|
+
* second copy of it per provider.
|
|
88
126
|
*/
|
|
89
|
-
claim(issue: Issue
|
|
127
|
+
claim(issue: Issue, opts?: {
|
|
128
|
+
from?: WatchState;
|
|
129
|
+
to?: WatchState;
|
|
130
|
+
}): Promise<boolean>;
|
|
90
131
|
/** The one state-mutating call. `detail`, if given, is also posted as a comment. */
|
|
91
132
|
transition(issue: Issue, to: WatchState, detail?: string): Promise<void>;
|
|
92
133
|
comment(issue: Issue, body: string): Promise<void>;
|
|
@@ -111,3 +152,24 @@ export interface CodeHostProvider {
|
|
|
111
152
|
}): Promise<PrRef>;
|
|
112
153
|
prStatus(pr: PrRef): Promise<PrStatus>;
|
|
113
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* The third seam: creating issues and linking them into a hierarchy — what
|
|
157
|
+
* the refine lane needs and neither `IssueProvider` nor `CodeHostProvider`
|
|
158
|
+
* provides (a tracker's read/claim/transition surface has no reason to
|
|
159
|
+
* create new work items). Kept separate rather than folded into
|
|
160
|
+
* `IssueProvider` for the same reason `CodeHostProvider` is separate: not
|
|
161
|
+
* every tracker can do this (Jira could, in principle, via its native issue
|
|
162
|
+
* types + `parent` field, but that is a real future implementation, not a
|
|
163
|
+
* one-line stub — see `jira_provider.ts`'s module comment), and a tracker
|
|
164
|
+
* that can't should be a `null` from `resolveIssueAuthoringProvider()`
|
|
165
|
+
* (`cli/commands/watch.ts`), not a method that throws at call time.
|
|
166
|
+
*/
|
|
167
|
+
export interface IssueAuthoringProvider {
|
|
168
|
+
createIssue(input: {
|
|
169
|
+
title: string;
|
|
170
|
+
body: string;
|
|
171
|
+
labels: string[];
|
|
172
|
+
}): Promise<Issue>;
|
|
173
|
+
/** Link `child` under `parent` using the tracker's native hierarchy — GitHub's sub-issues API today. */
|
|
174
|
+
linkChild(parent: Issue, child: Issue): Promise<void>;
|
|
175
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* The seams `spf watch` drives — the abstraction the user's own reference
|
|
3
|
+
* implementation (a GitHub-issues SDLC poller) never had: its GitHub client
|
|
4
|
+
* is a concrete class referenced by type everywhere, so adding a second
|
|
5
|
+
* tracker would mean reworking the poll loop itself.
|
|
6
6
|
*
|
|
7
7
|
* `IssueProvider` (tracker: list/claim/transition/comment/markers) and
|
|
8
8
|
* `CodeHostProvider` (PR lifecycle: open/status) are deliberately separate
|
|
@@ -13,6 +13,9 @@
|
|
|
13
13
|
* implements only `IssueProvider`, `bitbucket_provider.ts` only
|
|
14
14
|
* `CodeHostProvider` — any tracker x host combination is just config
|
|
15
15
|
* (`watch.issue_provider` x `watch.code_host`), never a poll-loop change.
|
|
16
|
+
* `IssueAuthoringProvider` (create/link, at the bottom of this file) is a
|
|
17
|
+
* third, again separate — the refine lane's own need, optional per tracker,
|
|
18
|
+
* and orthogonal to which one is the code host.
|
|
16
19
|
*
|
|
17
20
|
* The label-as-state-machine design is deliberate, copied from that same
|
|
18
21
|
* reference: `transition()` is the ONE mutator, so every state change is
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* predicate a `Notifier` applies — no separate per-kind severity table to
|
|
12
12
|
* keep in sync with this list.
|
|
13
13
|
*/
|
|
14
|
-
export type NotifyKind = "run_started" | "run_finished" | "run_failed" | "phase_failed" | "phase_retry" | "watch_started" | "watch_stopped" | "watch_error" | "issue_claimed" | "pr_opened" | "issue_done" | "issue_blocked";
|
|
14
|
+
export type NotifyKind = "run_started" | "run_finished" | "run_failed" | "phase_failed" | "phase_retry" | "watch_started" | "watch_stopped" | "watch_error" | "issue_claimed" | "pr_opened" | "issue_done" | "issue_blocked" | "spec_refined";
|
|
15
15
|
export interface NotifyEvent {
|
|
16
16
|
kind: NotifyKind;
|
|
17
17
|
/** "error" sends under both `events: errors` and `events: all`; "info" only under `all`. */
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { Issue, IssueAuthoringProvider } from "./issues/provider.ts";
|
|
2
|
+
import type { RefinedIssue, SFConfig } from "./data_types.ts";
|
|
3
|
+
export interface PublishedIssue {
|
|
4
|
+
/** The `RefinedIssue.key` this came from — a run-local id, never a tracker id. */
|
|
5
|
+
key: string;
|
|
6
|
+
issue: Issue;
|
|
7
|
+
kind: RefinedIssue["kind"];
|
|
8
|
+
/** A node nothing else names as `parent` — the independently-workable unit `spf:refined` goes on. */
|
|
9
|
+
isLeaf: boolean;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* `IssueAuthoringProvider` has a real implementation only on `GitHubProvider`
|
|
13
|
+
* today — see `jira_provider.ts`'s module comment on why Jira isn't wired up
|
|
14
|
+
* yet. Throws rather than returning `null` so a `code` phase calling this
|
|
15
|
+
* (`steps.publishIssues()`) fails the phase with a clear, specific reason —
|
|
16
|
+
* the same "fail loudly, never silently do nothing" contract
|
|
17
|
+
* `agents.validate()` uses for an unconfigured quality suite.
|
|
18
|
+
*/
|
|
19
|
+
export declare function resolveAuthoringProvider(cfg: SFConfig): IssueAuthoringProvider;
|
|
20
|
+
export interface PublishOptions {
|
|
21
|
+
labelPrefix: string;
|
|
22
|
+
/** The originating spec issue's id, for every created issue's `## Parent` back-reference. `null`/omitted for a manual run with no source issue. */
|
|
23
|
+
specIssueId?: string | null;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Create every node in `issues`, in dependency order, with its
|
|
27
|
+
* `<prefix>:type:<kind>` label (plus `<prefix>:refined` on leaves only —
|
|
28
|
+
* see `WatchState`'s doc comment in `provider.ts`), link each to its parent
|
|
29
|
+
* via the tracker's native hierarchy, and render real `#n` references into
|
|
30
|
+
* `## Blocked by`. Returns what it created, in creation order.
|
|
31
|
+
*
|
|
32
|
+
* Not transactional: if a create or link call throws partway through, the
|
|
33
|
+
* nodes already published stay published, orphaned from whatever hadn't run
|
|
34
|
+
* yet. No rollback is attempted — the gate already ran, so this only fails
|
|
35
|
+
* on a live tracker error (rate limit, network), which a human re-running
|
|
36
|
+
* the spec (once the marker's `refined` list explains what already exists)
|
|
37
|
+
* can sort out same as any other `spf watch` failure.
|
|
38
|
+
*/
|
|
39
|
+
export declare function publish(tracker: IssueAuthoringProvider, issues: RefinedIssue[], opts: PublishOptions): Promise<PublishedIssue[]>;
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Publish logic for the refine lane: turn a gated `RefineOutput.issues` list
|
|
3
|
+
* (a product spec decomposed into a feature/story tree — see
|
|
4
|
+
* `RefinedIssueSchema` in `data_types.ts`) into real tracker issues, in
|
|
5
|
+
* dependency order, with the right labels and parent/child links. Nothing
|
|
6
|
+
* else: no marker bookkeeping, no `transition()`, no comment posted back
|
|
7
|
+
* onto the spec issue. Those are watch-lifecycle concerns `core/watch.ts`'s
|
|
8
|
+
* `runSpec` owns, exactly the way `runIssue` (the build lane) owns
|
|
9
|
+
* `openPr`/`transition` rather than a chain step doing it — this file is
|
|
10
|
+
* "given issues and a tracker, create them correctly," the one part
|
|
11
|
+
* `to-tickets` (the skill this lane's prompt is ported from) leaves
|
|
12
|
+
* entirely unspecified, and the part that makes a re-run duplicate every
|
|
13
|
+
* ticket (see `WatchMarker.refined`'s doc comment in `provider.ts` for how
|
|
14
|
+
* `runSpec` closes that gap using what this module returns).
|
|
15
|
+
*/
|
|
16
|
+
import { GitHubProvider } from "./issues/github_provider.js";
|
|
17
|
+
/**
|
|
18
|
+
* `IssueAuthoringProvider` has a real implementation only on `GitHubProvider`
|
|
19
|
+
* today — see `jira_provider.ts`'s module comment on why Jira isn't wired up
|
|
20
|
+
* yet. Throws rather than returning `null` so a `code` phase calling this
|
|
21
|
+
* (`steps.publishIssues()`) fails the phase with a clear, specific reason —
|
|
22
|
+
* the same "fail loudly, never silently do nothing" contract
|
|
23
|
+
* `agents.validate()` uses for an unconfigured quality suite.
|
|
24
|
+
*/
|
|
25
|
+
export function resolveAuthoringProvider(cfg) {
|
|
26
|
+
if (cfg.watch.issue_provider !== "github") {
|
|
27
|
+
throw new Error(`watch.issue_provider ${JSON.stringify(cfg.watch.issue_provider)} does not support issue authoring — ` +
|
|
28
|
+
`the refine lane needs "github" (see jira_provider.ts's module comment on why Jira isn't wired up yet)`);
|
|
29
|
+
}
|
|
30
|
+
if (!cfg.watch.repo.trim()) {
|
|
31
|
+
throw new Error(`watch.repo is not configured — add it to spf.config.yaml's watch: section, e.g. "owner/name"`);
|
|
32
|
+
}
|
|
33
|
+
const token = process.env["GITHUB_TOKEN"];
|
|
34
|
+
if (!token) {
|
|
35
|
+
throw new Error('GITHUB_TOKEN is not set — the refine lane needs a classic PAT with "repo" scope (or "public_repo" for a public-only repo)');
|
|
36
|
+
}
|
|
37
|
+
return new GitHubProvider(cfg.watch.repo, cfg.watch.label_prefix, token);
|
|
38
|
+
}
|
|
39
|
+
function typeLabel(labelPrefix, kind) {
|
|
40
|
+
return `${labelPrefix}:type:${kind}`;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* The body GitHub actually stores: the refiner's own `## What to build` /
|
|
44
|
+
* `## Acceptance criteria` text, plus a `## Parent` back-reference to the
|
|
45
|
+
* source spec (when there is one — a bare `spf refine` run with no
|
|
46
|
+
* `--issue` has none), plus a `## Blocked by` section with real `#n`
|
|
47
|
+
* references — `to-tickets`' own template shape, ported. Every `blocked_by`
|
|
48
|
+
* key is guaranteed to already be in `byKey` by the time this runs:
|
|
49
|
+
* `topoOrder` visits a node's dependencies before the node itself.
|
|
50
|
+
*/
|
|
51
|
+
function renderBody(node, byKey, specIssueId) {
|
|
52
|
+
const parts = [node.body.trim()];
|
|
53
|
+
if (specIssueId)
|
|
54
|
+
parts.push(`## Parent\n\nDecomposed from #${specIssueId}.`);
|
|
55
|
+
if (node.blocked_by.length > 0) {
|
|
56
|
+
const refs = node.blocked_by.map((key) => {
|
|
57
|
+
const published = byKey.get(key);
|
|
58
|
+
// Defensive only: gates.refinementWellFormed already rejects a
|
|
59
|
+
// blocked_by key that doesn't resolve to another node in the list.
|
|
60
|
+
return published ? `#${published.issue.id}` : key;
|
|
61
|
+
});
|
|
62
|
+
parts.push(`## Blocked by\n\n${refs.map((r) => `- ${r}`).join("\n")}`);
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
parts.push(`## Blocked by\n\nNone (can start immediately).`);
|
|
66
|
+
}
|
|
67
|
+
return parts.join("\n\n");
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Order nodes so every `parent` and every `blocked_by` reference is already
|
|
71
|
+
* published (a real issue, in `byKey`) before the node that names it —
|
|
72
|
+
* required both for the sub-issue link (the parent must exist first) and
|
|
73
|
+
* for `renderBody`'s `#n` references. `gates.refinementWellFormed` has
|
|
74
|
+
* already rejected a cyclic input by the time `publish()` ever runs; the
|
|
75
|
+
* `visiting` check here is a defensive backstop against a caller that
|
|
76
|
+
* skipped the gate, not the primary line of defense.
|
|
77
|
+
*/
|
|
78
|
+
function topoOrder(issues) {
|
|
79
|
+
const byKey = new Map(issues.map((i) => [i.key, i]));
|
|
80
|
+
const ordered = [];
|
|
81
|
+
const done = new Set();
|
|
82
|
+
const visiting = new Set();
|
|
83
|
+
function visit(node) {
|
|
84
|
+
if (done.has(node.key))
|
|
85
|
+
return;
|
|
86
|
+
if (visiting.has(node.key)) {
|
|
87
|
+
throw new Error(`refine: dependency cycle detected at key ${JSON.stringify(node.key)} — gates.refinementWellFormed should have caught this before publish ran`);
|
|
88
|
+
}
|
|
89
|
+
visiting.add(node.key);
|
|
90
|
+
for (const depKey of [node.parent, ...node.blocked_by]) {
|
|
91
|
+
if (!depKey)
|
|
92
|
+
continue;
|
|
93
|
+
const dep = byKey.get(depKey);
|
|
94
|
+
if (dep)
|
|
95
|
+
visit(dep);
|
|
96
|
+
}
|
|
97
|
+
visiting.delete(node.key);
|
|
98
|
+
done.add(node.key);
|
|
99
|
+
ordered.push(node);
|
|
100
|
+
}
|
|
101
|
+
for (const issue of issues)
|
|
102
|
+
visit(issue);
|
|
103
|
+
return ordered;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Create every node in `issues`, in dependency order, with its
|
|
107
|
+
* `<prefix>:type:<kind>` label (plus `<prefix>:refined` on leaves only —
|
|
108
|
+
* see `WatchState`'s doc comment in `provider.ts`), link each to its parent
|
|
109
|
+
* via the tracker's native hierarchy, and render real `#n` references into
|
|
110
|
+
* `## Blocked by`. Returns what it created, in creation order.
|
|
111
|
+
*
|
|
112
|
+
* Not transactional: if a create or link call throws partway through, the
|
|
113
|
+
* nodes already published stay published, orphaned from whatever hadn't run
|
|
114
|
+
* yet. No rollback is attempted — the gate already ran, so this only fails
|
|
115
|
+
* on a live tracker error (rate limit, network), which a human re-running
|
|
116
|
+
* the spec (once the marker's `refined` list explains what already exists)
|
|
117
|
+
* can sort out same as any other `spf watch` failure.
|
|
118
|
+
*/
|
|
119
|
+
export async function publish(tracker, issues, opts) {
|
|
120
|
+
const ordered = topoOrder(issues);
|
|
121
|
+
const childKeys = new Set(issues.filter((i) => i.parent).map((i) => i.parent));
|
|
122
|
+
const byKey = new Map();
|
|
123
|
+
const created = [];
|
|
124
|
+
for (const node of ordered) {
|
|
125
|
+
const isLeaf = !childKeys.has(node.key);
|
|
126
|
+
const labels = [typeLabel(opts.labelPrefix, node.kind)];
|
|
127
|
+
if (isLeaf)
|
|
128
|
+
labels.push(`${opts.labelPrefix}:refined`);
|
|
129
|
+
const body = renderBody(node, byKey, opts.specIssueId);
|
|
130
|
+
const issue = await tracker.createIssue({ title: node.title, body, labels });
|
|
131
|
+
const published = { key: node.key, issue, kind: node.kind, isLeaf };
|
|
132
|
+
byKey.set(node.key, published);
|
|
133
|
+
created.push(published);
|
|
134
|
+
if (node.parent) {
|
|
135
|
+
const parent = byKey.get(node.parent);
|
|
136
|
+
// topoOrder guarantees the parent was visited (and thus published)
|
|
137
|
+
// first; a missing entry here would mean the gate let an
|
|
138
|
+
// unresolved parent through, which refinementWellFormed rejects.
|
|
139
|
+
if (parent)
|
|
140
|
+
await tracker.linkChild(parent.issue, issue);
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
return created;
|
|
144
|
+
}
|