typeclaw 0.48.13 → 0.49.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/package.json +5 -5
- package/scripts/dump-system-prompt.ts +52 -110
- package/src/agent/index.ts +144 -72
- package/src/agent/live-sessions.ts +2 -2
- package/src/agent/live-subagents.ts +1 -0
- package/src/agent/plugin-tools.ts +53 -11
- package/src/agent/prompt-cache-key.ts +42 -0
- package/src/agent/provider-error.ts +179 -10
- package/src/agent/restart-handoff/index.ts +7 -14
- package/src/agent/reviewer-activity.ts +68 -0
- package/src/agent/session-origin.ts +33 -0
- package/src/agent/subagents.ts +13 -1
- package/src/agent/system-prompt.ts +68 -202
- package/src/agent/todo/continuation-policy.ts +12 -4
- package/src/agent/tool-file-safety.ts +113 -14
- package/src/agent/tool-not-found-nudge.ts +1 -1
- package/src/agent/tools/channel-history-render.ts +2 -1
- package/src/agent/tools/channel-reply.ts +23 -5
- package/src/agent/tools/channel-send.ts +49 -7
- package/src/agent/tools/curl-impersonate.ts +11 -2
- package/src/agent/tools/post-github-review.ts +77 -15
- package/src/agent/tools/skip-response.ts +2 -2
- package/src/agent/tools/spawn-subagent.ts +163 -12
- package/src/agent/tools/subagent-output.ts +8 -0
- package/src/bundled-plugins/backup/README.md +10 -9
- package/src/bundled-plugins/backup/runner.ts +140 -58
- package/src/bundled-plugins/backup/subagents.ts +58 -26
- package/src/bundled-plugins/github-cli-auth/gh-command.ts +34 -2
- package/src/bundled-plugins/github-cli-auth/granted-push.ts +135 -0
- package/src/bundled-plugins/github-cli-auth/index.ts +83 -11
- package/src/bundled-plugins/github-cli-auth/review-account.ts +23 -0
- package/src/bundled-plugins/github-cli-auth/review-checkout.ts +9 -2
- package/src/bundled-plugins/github-cli-auth/review-recorder.ts +45 -7
- package/src/bundled-plugins/operator/operator.ts +15 -4
- package/src/bundled-plugins/reviewer/skills/code-review.ts +1 -1
- package/src/bundled-plugins/security/index.ts +50 -2
- package/src/bundled-plugins/security/policies/git-exfil.ts +24 -12
- package/src/channels/adapters/discord-bot-reactions.ts +18 -0
- package/src/channels/adapters/discord-bot.ts +122 -67
- package/src/channels/adapters/discord-reactions.ts +18 -0
- package/src/channels/adapters/discord.ts +114 -8
- package/src/channels/adapters/github/inbound.ts +103 -8
- package/src/channels/adapters/github/index.ts +251 -19
- package/src/channels/adapters/github/last-alive.ts +27 -0
- package/src/channels/adapters/github/outbound.ts +54 -18
- package/src/channels/adapters/github/pending-review-store.ts +141 -0
- package/src/channels/adapters/github/permission-guidance.ts +1 -0
- package/src/channels/adapters/github/reactions.ts +100 -0
- package/src/channels/adapters/github/reconcile-cooldown-store.ts +197 -67
- package/src/channels/adapters/github/reconcile-open-prs.ts +418 -33
- package/src/channels/adapters/github/recovery.ts +106 -0
- package/src/channels/adapters/github/review-check.ts +510 -0
- package/src/channels/adapters/github/review-submitter.ts +34 -2
- package/src/channels/adapters/instagram.ts +32 -14
- package/src/channels/adapters/kakaotalk.ts +22 -7
- package/src/channels/adapters/line.ts +18 -3
- package/src/channels/adapters/outbound-account.ts +20 -0
- package/src/channels/adapters/own-reactions.ts +66 -0
- package/src/channels/adapters/recovery-correlation.ts +214 -0
- package/src/channels/adapters/slack-bot-classify.ts +18 -11
- package/src/channels/adapters/slack-bot-dedupe.ts +111 -28
- package/src/channels/adapters/slack-bot-reactions.ts +18 -0
- package/src/channels/adapters/slack-bot.ts +125 -57
- package/src/channels/adapters/slack-classify.ts +25 -4
- package/src/channels/adapters/slack-inbound-revision.ts +96 -0
- package/src/channels/adapters/slack-reactions.ts +18 -0
- package/src/channels/adapters/slack-thread-ts.ts +6 -0
- package/src/channels/adapters/slack.ts +48 -3
- package/src/channels/adapters/teams.ts +14 -4
- package/src/channels/adapters/telegram-bot.ts +56 -10
- package/src/channels/adapters/webex-bot.ts +12 -2
- package/src/channels/adapters/webex.ts +12 -2
- package/src/channels/background-handoff.ts +434 -0
- package/src/channels/background-obligations.ts +893 -0
- package/src/channels/continuity-types.ts +271 -0
- package/src/channels/github-review-check.ts +598 -0
- package/src/channels/github-review-turn-ledger.ts +102 -28
- package/src/channels/github-review-verdict-coordinator.ts +72 -12
- package/src/channels/github-token-bridge.ts +11 -5
- package/src/channels/inbound-journal.ts +1738 -0
- package/src/channels/index.ts +6 -1
- package/src/channels/manager.ts +17 -7
- package/src/channels/recovery-dispatcher.ts +264 -0
- package/src/channels/recovery-notice.ts +94 -0
- package/src/channels/recovery-outbox.ts +459 -0
- package/src/channels/router.ts +2539 -615
- package/src/channels/schema.ts +8 -1
- package/src/channels/subagent-completion-bridge.ts +17 -14
- package/src/channels/types.ts +121 -16
- package/src/channels/waiting-reactions.ts +664 -0
- package/src/cli/compose.ts +7 -4
- package/src/cli/hostd.ts +49 -3
- package/src/cli/inspect.ts +11 -14
- package/src/coding-agent/broker-body.ts +38 -0
- package/src/coding-agent/broker.ts +290 -0
- package/src/coding-agent/claude.ts +95 -0
- package/src/coding-agent/codex.ts +104 -0
- package/src/coding-agent/index.ts +506 -0
- package/src/coding-agent/omo-state.ts +69 -0
- package/src/coding-agent/omo-stream.ts +98 -0
- package/src/coding-agent/omo.ts +192 -0
- package/src/coding-agent/runner.ts +263 -0
- package/src/coding-agent/tool.ts +62 -0
- package/src/coding-agent/worktree.ts +355 -0
- package/src/compose/restart.ts +10 -3
- package/src/compose/start.ts +20 -3
- package/src/config/config.ts +10 -3
- package/src/config/providers.ts +12 -9
- package/src/container/exit-reason.ts +44 -0
- package/src/container/index.ts +5 -0
- package/src/container/log-archive.ts +51 -13
- package/src/container/memory-limit.ts +1 -1
- package/src/container/memory-oversubscription.ts +36 -6
- package/src/container/oom-events.ts +86 -0
- package/src/container/restart.ts +2 -0
- package/src/container/shared.ts +8 -1
- package/src/container/start.ts +25 -13
- package/src/container/stop.ts +6 -2
- package/src/container/tool-oom-priority.ts +32 -0
- package/src/cron/consumer.ts +10 -4
- package/src/cron/reloadable.ts +23 -2
- package/src/doctor/checks.ts +14 -2
- package/src/hostd/daemon.ts +20 -10
- package/src/hostd/spawn.ts +106 -5
- package/src/hostd/version.ts +20 -0
- package/src/hostd/watchdog.ts +241 -0
- package/src/init/dockerfile.ts +57 -592
- package/src/init/index.ts +2 -3
- package/src/mcp/client.ts +3 -1
- package/src/operations/classify-tool-outcome.ts +45 -1
- package/src/operations/incidents.ts +10 -5
- package/src/plugin/core-tool-names.ts +1 -1
- package/src/plugin/define.ts +1 -0
- package/src/plugin/index.ts +1 -0
- package/src/plugin/types.ts +6 -1
- package/src/run/background-handoff-boot.ts +86 -0
- package/src/run/index.ts +83 -83
- package/src/run/resource-sample.ts +19 -0
- package/src/sandbox/build.ts +4 -0
- package/src/sandbox/coding-agent.ts +214 -0
- package/src/sandbox/policy.ts +1 -0
- package/src/sandbox/runtime-private.ts +4 -1
- package/src/secrets/coding-agent-auth.ts +97 -0
- package/src/secrets/index.ts +0 -16
- package/src/server/command-runner.ts +6 -2
- package/src/server/index.ts +101 -40
- package/src/skills/typeclaw-channel-github/SKILL.md +7 -5
- package/src/skills/typeclaw-claude-code/SKILL.md +25 -260
- package/src/skills/typeclaw-claude-code/references/auth-flow.md +7 -23
- package/src/skills/typeclaw-claude-code/references/headless-sessions.md +11 -0
- package/src/skills/typeclaw-claude-code/references/results-and-worktrees.md +13 -0
- package/src/skills/typeclaw-codex-cli/SKILL.md +35 -270
- package/src/skills/typeclaw-codex-cli/references/auth-flow.md +13 -20
- package/src/skills/typeclaw-codex-cli/references/headless-sessions.md +26 -0
- package/src/skills/typeclaw-codex-cli/references/results-and-worktrees.md +28 -0
- package/src/skills/typeclaw-config/SKILL.md +21 -21
- package/src/skills/typeclaw-config/references/dockerfile.md +14 -13
- package/src/skills/typeclaw-cron/SKILL.md +1 -1
- package/src/skills/typeclaw-github-contributing/SKILL.md +2 -2
- package/src/skills/typeclaw-memory/SKILL.md +3 -3
- package/src/skills/typeclaw-omo-cli/SKILL.md +52 -0
- package/src/skills/typeclaw-omo-cli/references/auth-flow.md +11 -0
- package/src/skills/typeclaw-omo-cli/references/headless-sessions.md +11 -0
- package/src/skills/typeclaw-omo-cli/references/results-and-worktrees.md +23 -0
- package/src/skills/typeclaw-plugins/SKILL.md +15 -15
- package/src/skills/typeclaw-skills/SKILL.md +19 -2
- package/src/skills/typeclaw-troubleshooting/SKILL.md +15 -2
- package/typeclaw.schema.json +12 -1
- package/src/secrets/claude-credentials-json.ts +0 -129
- package/src/secrets/codex-auth-json.ts +0 -102
- package/src/secrets/export-claude-credentials-file.ts +0 -270
- package/src/secrets/export-codex-auth-file.ts +0 -250
- package/src/skills/typeclaw-claude-code/references/stop-hook.md +0 -101
- package/src/skills/typeclaw-claude-code/references/tmux-driving.md +0 -243
- package/src/skills/typeclaw-codex-cli/references/stop-hook.md +0 -92
- package/src/skills/typeclaw-codex-cli/references/tmux-driving.md +0 -239
|
@@ -0,0 +1,598 @@
|
|
|
1
|
+
import { randomUUID } from 'node:crypto'
|
|
2
|
+
|
|
3
|
+
import { canonicalGithubRepo } from './github-repo'
|
|
4
|
+
|
|
5
|
+
// Shows the agent's own PR review as a GitHub check on the reviewed commit:
|
|
6
|
+
// in progress while a reviewer subagent works, completed with the verdict once
|
|
7
|
+
// the review is verified on GitHub. The tracker is a process-wide singleton
|
|
8
|
+
// (like the verdict coordinator) because its producers live on both sides of
|
|
9
|
+
// the agent/channel boundary: `spawn_subagent` begins and settles reviewer work,
|
|
10
|
+
// while the github adapter attaches the publisher and reports verified reviews.
|
|
11
|
+
//
|
|
12
|
+
// A check left `in_progress` stays that way on GitHub indefinitely, so every
|
|
13
|
+
// path must end it without relying on the model: reviewer settlement, a review
|
|
14
|
+
// that never posts (deadline sweep), cancellation, and a restart (durable lease
|
|
15
|
+
// file reaped on the next attach). A decided outcome is persisted with its lease
|
|
16
|
+
// and retried until GitHub acknowledges it, so a transient publish failure or a
|
|
17
|
+
// detached adapter cannot strand the check either.
|
|
18
|
+
|
|
19
|
+
// Fallback check name; the adapter names the check after the agent's GitHub
|
|
20
|
+
// identity once known (see `reviewCheckName`).
|
|
21
|
+
export const REVIEW_CHECK_NAME = 'typeclaw/review'
|
|
22
|
+
|
|
23
|
+
// Backstop for the reviewing phase. The reviewer subagent's own ceiling
|
|
24
|
+
// (REVIEWER_SPAWN_TIMEOUT_MS, 30m) normally settles it first as a failure; this
|
|
25
|
+
// only fires when that settlement never arrives.
|
|
26
|
+
export const REVIEW_CHECK_REVIEWING_DEADLINE_MS = 35 * 60_000
|
|
27
|
+
|
|
28
|
+
// The reviewer finished, but the parent session still has to post. A parent
|
|
29
|
+
// that wedges or dies here would otherwise leave the check spinning.
|
|
30
|
+
export const REVIEW_CHECK_POSTING_DEADLINE_MS = 10 * 60_000
|
|
31
|
+
|
|
32
|
+
export const REVIEW_CHECK_SWEEP_INTERVAL_MS = 60_000
|
|
33
|
+
|
|
34
|
+
// A decided outcome GitHub keeps rejecting as transient is abandoned after this
|
|
35
|
+
// long so a permanently broken repo cannot grow the lease file forever.
|
|
36
|
+
export const REVIEW_CHECK_PUBLISH_GIVE_UP_MS = 24 * 60 * 60_000
|
|
37
|
+
|
|
38
|
+
export type ReviewCheckKey = { repo: string; pullRequest: number; headSha: string }
|
|
39
|
+
|
|
40
|
+
export type ReviewCheckRef = { mode: 'check-run'; checkRunId: number } | { mode: 'status'; context?: string }
|
|
41
|
+
|
|
42
|
+
export type ReviewCheckFinding = { path: string; line: number; side?: 'LEFT' | 'RIGHT'; title: string }
|
|
43
|
+
|
|
44
|
+
// Persisted with the outcome, so it stays small: `findings` is capped and
|
|
45
|
+
// `findingCount` keeps the real total.
|
|
46
|
+
export type ReviewCheckVerdictDetails = {
|
|
47
|
+
reviewId?: number
|
|
48
|
+
findings?: ReviewCheckFinding[]
|
|
49
|
+
findingCount?: number
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export type ReviewCheckOutcome =
|
|
53
|
+
| { kind: 'verdict'; state: 'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED'; details?: ReviewCheckVerdictDetails }
|
|
54
|
+
| { kind: 'failed'; reason: string }
|
|
55
|
+
| { kind: 'cancelled'; reason: string }
|
|
56
|
+
|
|
57
|
+
export type ReviewerSettlement =
|
|
58
|
+
| { kind: 'ok' }
|
|
59
|
+
| { kind: 'failed'; reason: string }
|
|
60
|
+
| { kind: 'cancelled'; reason: string }
|
|
61
|
+
|
|
62
|
+
// What a reviewer is doing, in plain categories: the check page never shows
|
|
63
|
+
// task ids, session ids, tool names, or model text.
|
|
64
|
+
export type ReviewerActivity = {
|
|
65
|
+
started: boolean
|
|
66
|
+
filesRead: number
|
|
67
|
+
commandsRun: number
|
|
68
|
+
current: 'reading' | 'commands' | 'writing' | null
|
|
69
|
+
lastActivityAt: number | null
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export type ReviewCheckProgress = {
|
|
73
|
+
phase: 'reviewing' | 'posting'
|
|
74
|
+
startedAt: number
|
|
75
|
+
now: number
|
|
76
|
+
reviewKind?: 'review' | 're-review'
|
|
77
|
+
activity: ReviewerActivity | null
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export type ReviewCheckTiming = { startedAt: number; decidedAt: number; tracked: boolean }
|
|
81
|
+
|
|
82
|
+
// 'published': GitHub has the outcome, or retrying cannot help (disabled, no
|
|
83
|
+
// permission). 'retry': a transient failure; the tracker keeps the outcome.
|
|
84
|
+
export type ReviewCheckPublishResult = 'published' | 'retry'
|
|
85
|
+
|
|
86
|
+
export type ReviewCheckPublisher = {
|
|
87
|
+
// The name a new check (or commit-status context) is created under now.
|
|
88
|
+
// Defaults to REVIEW_CHECK_NAME.
|
|
89
|
+
name?: () => string
|
|
90
|
+
// null: checks are disabled, not permitted, or the create failed — no check exists.
|
|
91
|
+
start: (key: ReviewCheckKey) => Promise<ReviewCheckRef | null>
|
|
92
|
+
// `ref: null` means no in-progress check exists; a publisher creates a
|
|
93
|
+
// completed check directly for a verdict and ignores other outcomes.
|
|
94
|
+
finish: (
|
|
95
|
+
key: ReviewCheckKey,
|
|
96
|
+
ref: ReviewCheckRef | null,
|
|
97
|
+
outcome: ReviewCheckOutcome,
|
|
98
|
+
timing?: ReviewCheckTiming,
|
|
99
|
+
) => Promise<ReviewCheckPublishResult>
|
|
100
|
+
// Best effort: a lost progress update is replaced by the next one.
|
|
101
|
+
progress?: (key: ReviewCheckKey, ref: ReviewCheckRef, progress: ReviewCheckProgress) => Promise<void>
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
// `ref: null` is only persisted together with an outcome: a verdict whose
|
|
105
|
+
// completed check still has to be created.
|
|
106
|
+
export type PersistedReviewCheckLease = ReviewCheckKey & {
|
|
107
|
+
ref: ReviewCheckRef | null
|
|
108
|
+
startedAt: number
|
|
109
|
+
// Absent in records written before review durations were shown.
|
|
110
|
+
tracked?: boolean
|
|
111
|
+
outcome?: ReviewCheckOutcome
|
|
112
|
+
outcomeAt?: number
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export type ReviewCheckLeaseStore = {
|
|
116
|
+
load: () => Promise<PersistedReviewCheckLease[]>
|
|
117
|
+
save: (leases: PersistedReviewCheckLease[]) => Promise<void>
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
export type ReviewCheckLogger = { info: (m: string) => void; warn: (m: string) => void }
|
|
121
|
+
|
|
122
|
+
type Lease = {
|
|
123
|
+
uid: string
|
|
124
|
+
seq: number
|
|
125
|
+
key: ReviewCheckKey
|
|
126
|
+
// Only a check written under the same name can replace this one on GitHub.
|
|
127
|
+
name: string
|
|
128
|
+
startedAt: number
|
|
129
|
+
owners: Set<string>
|
|
130
|
+
ownerSucceeded: boolean
|
|
131
|
+
phase: 'reviewing' | 'posting'
|
|
132
|
+
deadlineAt: number
|
|
133
|
+
// undefined while the start call is in flight.
|
|
134
|
+
ref: ReviewCheckRef | null | undefined
|
|
135
|
+
started: Promise<void>
|
|
136
|
+
// False for a lease created only to publish a verdict nobody was tracked
|
|
137
|
+
// reviewing; its duration means nothing.
|
|
138
|
+
tracked: boolean
|
|
139
|
+
reviewKind?: 'review' | 're-review'
|
|
140
|
+
activity: ReviewerActivity | null
|
|
141
|
+
outcome?: ReviewCheckOutcome
|
|
142
|
+
outcomeAt?: number
|
|
143
|
+
outcomeVersion: number
|
|
144
|
+
publishing: Promise<void> | null
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
type Attachment = { publisher: ReviewCheckPublisher; store: ReviewCheckLeaseStore; logger: ReviewCheckLogger }
|
|
148
|
+
|
|
149
|
+
const RESTARTED_OUTCOME: ReviewCheckOutcome = {
|
|
150
|
+
kind: 'failed',
|
|
151
|
+
reason: 'TypeClaw restarted before this review was posted',
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export class GithubReviewCheckTracker {
|
|
155
|
+
private readonly leases = new Map<string, Lease>()
|
|
156
|
+
private readonly leaseByTask = new Map<string, string>()
|
|
157
|
+
private readonly publishLocks = new Map<string, Promise<void>>()
|
|
158
|
+
// Newest lease per commit that owns a check on GitHub. Outlives that lease so
|
|
159
|
+
// an older queued outcome stays superseded after the newer one publishes.
|
|
160
|
+
private readonly newestCheckSeq = new Map<string, number>()
|
|
161
|
+
private nextSeq = 0
|
|
162
|
+
private attachment: Attachment | null = null
|
|
163
|
+
// Kept across detach so a lease decided while no adapter is attached is still
|
|
164
|
+
// persisted and published on the next attach.
|
|
165
|
+
private store: { store: ReviewCheckLeaseStore; logger: ReviewCheckLogger } | null = null
|
|
166
|
+
private sweepTimer: ReturnType<typeof setInterval> | null = null
|
|
167
|
+
private persistChain: Promise<void> = Promise.resolve()
|
|
168
|
+
|
|
169
|
+
constructor(private readonly now: () => number = Date.now) {}
|
|
170
|
+
|
|
171
|
+
// Called on adapter start. A persisted lease this process does not hold was
|
|
172
|
+
// written by a previous process: its decided outcome is republished, and an
|
|
173
|
+
// undecided one died with that process's reviewer.
|
|
174
|
+
async attach(attachment: Attachment): Promise<void> {
|
|
175
|
+
this.attachment = attachment
|
|
176
|
+
this.store = { store: attachment.store, logger: attachment.logger }
|
|
177
|
+
if (this.sweepTimer === null) {
|
|
178
|
+
this.sweepTimer = setInterval(() => void this.sweep(), REVIEW_CHECK_SWEEP_INTERVAL_MS)
|
|
179
|
+
this.sweepTimer.unref?.()
|
|
180
|
+
}
|
|
181
|
+
let persisted: PersistedReviewCheckLease[] = []
|
|
182
|
+
try {
|
|
183
|
+
persisted = await attachment.store.load()
|
|
184
|
+
} catch (err) {
|
|
185
|
+
attachment.logger.warn(`[github] review check leases unreadable: ${describe(err)}`)
|
|
186
|
+
}
|
|
187
|
+
let restored = 0
|
|
188
|
+
for (const record of persisted) {
|
|
189
|
+
if (this.holds(record)) continue
|
|
190
|
+
const lease = this.createLease(normalizeKey(record), record.startedAt)
|
|
191
|
+
lease.ref = record.ref
|
|
192
|
+
if (record.ref?.mode === 'status') lease.name = record.ref.context ?? REVIEW_CHECK_NAME
|
|
193
|
+
lease.tracked = record.tracked === true
|
|
194
|
+
this.claimCheck(lease)
|
|
195
|
+
this.decide(lease, record.outcome ?? RESTARTED_OUTCOME, record.outcomeAt)
|
|
196
|
+
restored++
|
|
197
|
+
}
|
|
198
|
+
if (restored > 0) {
|
|
199
|
+
attachment.logger.info(`[github] closing ${restored} review check(s) left by a previous process`)
|
|
200
|
+
await this.persist()
|
|
201
|
+
}
|
|
202
|
+
await this.publishDecided()
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
detach(publisher: ReviewCheckPublisher): void {
|
|
206
|
+
if (this.attachment?.publisher !== publisher) return
|
|
207
|
+
this.attachment = null
|
|
208
|
+
if (this.sweepTimer !== null) {
|
|
209
|
+
clearInterval(this.sweepTimer)
|
|
210
|
+
this.sweepTimer = null
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
beginReview(
|
|
215
|
+
key: ReviewCheckKey,
|
|
216
|
+
taskId: string,
|
|
217
|
+
options: { reviewKind?: 'review' | 're-review' } = {},
|
|
218
|
+
): Promise<void> {
|
|
219
|
+
const attachment = this.attachment
|
|
220
|
+
if (attachment === null) return Promise.resolve()
|
|
221
|
+
const normalized = normalizeKey(key)
|
|
222
|
+
const existing = this.openLease(normalized)
|
|
223
|
+
if (existing !== undefined) {
|
|
224
|
+
this.leaseByTask.set(taskId, existing.uid)
|
|
225
|
+
existing.owners.add(taskId)
|
|
226
|
+
existing.phase = 'reviewing'
|
|
227
|
+
existing.deadlineAt = this.now() + REVIEW_CHECK_REVIEWING_DEADLINE_MS
|
|
228
|
+
if (options.reviewKind !== undefined) existing.reviewKind = options.reviewKind
|
|
229
|
+
return existing.started
|
|
230
|
+
}
|
|
231
|
+
const lease = this.createLease(normalized, this.now())
|
|
232
|
+
lease.tracked = true
|
|
233
|
+
if (options.reviewKind !== undefined) lease.reviewKind = options.reviewKind
|
|
234
|
+
this.leaseByTask.set(taskId, lease.uid)
|
|
235
|
+
lease.owners.add(taskId)
|
|
236
|
+
lease.started = attachment.publisher
|
|
237
|
+
.start(normalized)
|
|
238
|
+
.then(
|
|
239
|
+
(ref) => {
|
|
240
|
+
lease.ref = ref
|
|
241
|
+
if (ref?.mode === 'status' && ref.context !== undefined) lease.name = ref.context
|
|
242
|
+
},
|
|
243
|
+
(err: unknown) => {
|
|
244
|
+
attachment.logger.warn(`[github] review check start failed for ${leaseId(normalized)}: ${describe(err)}`)
|
|
245
|
+
lease.ref = null
|
|
246
|
+
},
|
|
247
|
+
)
|
|
248
|
+
.then(() => this.afterStart(lease))
|
|
249
|
+
return lease.started
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
reviewerSettled(taskId: string, settlement: ReviewerSettlement): Promise<void> {
|
|
253
|
+
const uid = this.leaseByTask.get(taskId)
|
|
254
|
+
if (uid === undefined) return Promise.resolve()
|
|
255
|
+
this.leaseByTask.delete(taskId)
|
|
256
|
+
const lease = this.leases.get(uid)
|
|
257
|
+
if (lease === undefined || lease.outcome !== undefined || !lease.owners.delete(taskId)) return Promise.resolve()
|
|
258
|
+
if (settlement.kind === 'ok') lease.ownerSucceeded = true
|
|
259
|
+
// A sibling reviewer for the same commit is still working; its settlement decides.
|
|
260
|
+
if (lease.owners.size > 0) return Promise.resolve()
|
|
261
|
+
if (lease.ownerSucceeded) {
|
|
262
|
+
lease.phase = 'posting'
|
|
263
|
+
lease.deadlineAt = this.now() + REVIEW_CHECK_POSTING_DEADLINE_MS
|
|
264
|
+
return this.publishProgress(lease)
|
|
265
|
+
}
|
|
266
|
+
return this.finish(lease, settlement.kind === 'ok' ? { kind: 'failed', reason: 'reviewer failed' } : settlement)
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
// The latest snapshot wins; it is published on the next sweep tick, which
|
|
270
|
+
// bounds progress PATCHes to one per lease per sweep interval.
|
|
271
|
+
reportActivity(taskId: string, activity: ReviewerActivity): void {
|
|
272
|
+
const uid = this.leaseByTask.get(taskId)
|
|
273
|
+
const lease = uid === undefined ? undefined : this.leases.get(uid)
|
|
274
|
+
if (lease === undefined || lease.outcome !== undefined) return
|
|
275
|
+
lease.activity = activity
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
async reviewPosted(
|
|
279
|
+
key: ReviewCheckKey,
|
|
280
|
+
state: 'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED',
|
|
281
|
+
details?: ReviewCheckVerdictDetails,
|
|
282
|
+
): Promise<void> {
|
|
283
|
+
const normalized = normalizeKey(key)
|
|
284
|
+
const outcome: ReviewCheckOutcome = { kind: 'verdict', state, ...(details !== undefined ? { details } : {}) }
|
|
285
|
+
const open = this.openLease(normalized)
|
|
286
|
+
if (open !== undefined) return this.finish(open, outcome)
|
|
287
|
+
// A verdict that lands after a failure was decided but before GitHub has
|
|
288
|
+
// it supersedes that failure.
|
|
289
|
+
const pending = [...this.leases.values()].find(
|
|
290
|
+
(lease) => lease.outcome !== undefined && sameKey(lease.key, normalized) && lease.ref !== null,
|
|
291
|
+
)
|
|
292
|
+
if (pending !== undefined) return this.finish(pending, outcome, { supersede: true })
|
|
293
|
+
// A review posted without a tracked reviewer (or after its lease closed)
|
|
294
|
+
// still deserves its verdict on the commit.
|
|
295
|
+
if (this.attachment === null) return
|
|
296
|
+
const lease = this.createLease(normalized, this.now())
|
|
297
|
+
lease.ref = null
|
|
298
|
+
this.claimCheck(lease)
|
|
299
|
+
return this.finish(lease, outcome, { createIfMissing: true })
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
// For a verdict posted without the reviewed head: only reviews that already
|
|
303
|
+
// finished on this PR can be the ones it reports.
|
|
304
|
+
async completePostingReviews(
|
|
305
|
+
repo: string,
|
|
306
|
+
pullRequest: number,
|
|
307
|
+
state: 'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED',
|
|
308
|
+
): Promise<void> {
|
|
309
|
+
const canonical = canonicalGithubRepo(repo)
|
|
310
|
+
const matching = [...this.leases.values()].filter(
|
|
311
|
+
(lease) =>
|
|
312
|
+
lease.outcome === undefined &&
|
|
313
|
+
lease.phase === 'posting' &&
|
|
314
|
+
lease.key.repo === canonical &&
|
|
315
|
+
lease.key.pullRequest === pullRequest,
|
|
316
|
+
)
|
|
317
|
+
await Promise.all(matching.map((lease) => this.finish(lease, { kind: 'verdict', state })))
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
async cancelPullRequest(repo: string, pullRequest: number, reason: string): Promise<void> {
|
|
321
|
+
const canonical = canonicalGithubRepo(repo)
|
|
322
|
+
const matching = [...this.leases.values()].filter(
|
|
323
|
+
(lease) => lease.outcome === undefined && lease.key.repo === canonical && lease.key.pullRequest === pullRequest,
|
|
324
|
+
)
|
|
325
|
+
await Promise.all(matching.map((lease) => this.finish(lease, { kind: 'cancelled', reason })))
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
async sweep(): Promise<void> {
|
|
329
|
+
const now = this.now()
|
|
330
|
+
const expired = [...this.leases.values()].filter((lease) => lease.outcome === undefined && lease.deadlineAt <= now)
|
|
331
|
+
await Promise.all(
|
|
332
|
+
expired.map((lease) =>
|
|
333
|
+
this.finish(lease, {
|
|
334
|
+
kind: 'failed',
|
|
335
|
+
reason:
|
|
336
|
+
lease.phase === 'posting'
|
|
337
|
+
? 'the review finished but was not posted in time'
|
|
338
|
+
: 'the reviewer did not finish in time',
|
|
339
|
+
}),
|
|
340
|
+
),
|
|
341
|
+
)
|
|
342
|
+
await this.publishDecided()
|
|
343
|
+
const open = [...this.leases.values()].filter((lease) => lease.outcome === undefined)
|
|
344
|
+
await Promise.all(open.map((lease) => this.publishProgress(lease)))
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
private createLease(key: ReviewCheckKey, startedAt: number): Lease {
|
|
348
|
+
const lease: Lease = {
|
|
349
|
+
uid: randomUUID(),
|
|
350
|
+
seq: this.nextSeq++,
|
|
351
|
+
key,
|
|
352
|
+
name: this.attachment?.publisher.name?.() ?? REVIEW_CHECK_NAME,
|
|
353
|
+
startedAt,
|
|
354
|
+
owners: new Set(),
|
|
355
|
+
ownerSucceeded: false,
|
|
356
|
+
phase: 'reviewing',
|
|
357
|
+
deadlineAt: this.now() + REVIEW_CHECK_REVIEWING_DEADLINE_MS,
|
|
358
|
+
ref: undefined,
|
|
359
|
+
started: Promise.resolve(),
|
|
360
|
+
tracked: false,
|
|
361
|
+
activity: null,
|
|
362
|
+
outcomeVersion: 0,
|
|
363
|
+
publishing: null,
|
|
364
|
+
}
|
|
365
|
+
this.leases.set(lease.uid, lease)
|
|
366
|
+
return lease
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
private async afterStart(lease: Lease): Promise<void> {
|
|
370
|
+
if (lease.ref === null) {
|
|
371
|
+
// No check exists, so there is nothing to complete or recover.
|
|
372
|
+
if (lease.outcome !== undefined) this.drop(lease)
|
|
373
|
+
return
|
|
374
|
+
}
|
|
375
|
+
this.claimCheck(lease)
|
|
376
|
+
await this.persist()
|
|
377
|
+
if (lease.outcome !== undefined) await this.publish(lease)
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
private async finish(
|
|
381
|
+
lease: Lease,
|
|
382
|
+
outcome: ReviewCheckOutcome,
|
|
383
|
+
options: { supersede?: boolean; createIfMissing?: boolean } = {},
|
|
384
|
+
): Promise<void> {
|
|
385
|
+
if (lease.outcome !== undefined && options.supersede !== true) return
|
|
386
|
+
this.decide(lease, outcome)
|
|
387
|
+
for (const owner of lease.owners) this.leaseByTask.delete(owner)
|
|
388
|
+
lease.owners.clear()
|
|
389
|
+
if (lease.ref === undefined) return lease.started
|
|
390
|
+
if (lease.ref === null && options.createIfMissing !== true) {
|
|
391
|
+
this.drop(lease)
|
|
392
|
+
return
|
|
393
|
+
}
|
|
394
|
+
await this.persist()
|
|
395
|
+
await this.publish(lease)
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
private decide(lease: Lease, outcome: ReviewCheckOutcome, at?: number): void {
|
|
399
|
+
lease.outcome = outcome
|
|
400
|
+
lease.outcomeAt = at ?? this.now()
|
|
401
|
+
lease.outcomeVersion += 1
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
private async publishDecided(): Promise<void> {
|
|
405
|
+
const decided = [...this.leases.values()].filter((lease) => lease.outcome !== undefined && lease.ref !== undefined)
|
|
406
|
+
await Promise.all(decided.map((lease) => this.publish(lease)))
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
// Publishes for one commit run one at a time: commit statuses (and a
|
|
410
|
+
// completed check created from no ref) share one name on the commit, so
|
|
411
|
+
// whichever lands last is what GitHub shows.
|
|
412
|
+
private publish(lease: Lease): Promise<void> {
|
|
413
|
+
if (lease.publishing !== null) return lease.publishing
|
|
414
|
+
lease.publishing = this.withPublishLock(lease.key, () => this.publishUntilCurrent(lease)).finally(() => {
|
|
415
|
+
lease.publishing = null
|
|
416
|
+
})
|
|
417
|
+
return lease.publishing
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
// Shares the completion's per-commit lock, and re-checks for an outcome once
|
|
421
|
+
// it holds it, so a progress update can never land after the completed check.
|
|
422
|
+
private publishProgress(lease: Lease): Promise<void> {
|
|
423
|
+
if (lease.ref?.mode !== 'check-run' || this.attachment?.publisher.progress === undefined) return Promise.resolve()
|
|
424
|
+
return this.withPublishLock(lease.key, async () => {
|
|
425
|
+
const attachment = this.attachment
|
|
426
|
+
const progress = attachment?.publisher.progress
|
|
427
|
+
const ref = lease.ref
|
|
428
|
+
if (progress === undefined || lease.outcome !== undefined || ref?.mode !== 'check-run') return
|
|
429
|
+
if (this.leases.get(lease.uid) !== lease) return
|
|
430
|
+
try {
|
|
431
|
+
await progress(lease.key, ref, {
|
|
432
|
+
phase: lease.phase,
|
|
433
|
+
startedAt: lease.startedAt,
|
|
434
|
+
now: this.now(),
|
|
435
|
+
...(lease.reviewKind !== undefined ? { reviewKind: lease.reviewKind } : {}),
|
|
436
|
+
activity: lease.activity,
|
|
437
|
+
})
|
|
438
|
+
} catch (err) {
|
|
439
|
+
attachment?.logger.warn(`[github] review check progress failed for ${leaseId(lease.key)}: ${describe(err)}`)
|
|
440
|
+
}
|
|
441
|
+
}).catch(() => {})
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
private withPublishLock(key: ReviewCheckKey, fn: () => Promise<void>): Promise<void> {
|
|
445
|
+
const lockId = leaseId(key)
|
|
446
|
+
const run = (this.publishLocks.get(lockId) ?? Promise.resolve()).then(fn)
|
|
447
|
+
const tail = run.catch(() => {})
|
|
448
|
+
this.publishLocks.set(lockId, tail)
|
|
449
|
+
void tail.then(() => {
|
|
450
|
+
if (this.publishLocks.get(lockId) === tail) this.publishLocks.delete(lockId)
|
|
451
|
+
})
|
|
452
|
+
return run
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
private async publishUntilCurrent(lease: Lease): Promise<void> {
|
|
456
|
+
for (;;) {
|
|
457
|
+
const attachment = this.attachment
|
|
458
|
+
const outcome = lease.outcome
|
|
459
|
+
if (attachment === null || outcome === undefined || lease.ref === undefined) return
|
|
460
|
+
if (this.isSuperseded(lease)) {
|
|
461
|
+
this.drop(lease)
|
|
462
|
+
await this.persist()
|
|
463
|
+
return
|
|
464
|
+
}
|
|
465
|
+
const version = lease.outcomeVersion
|
|
466
|
+
let result: ReviewCheckPublishResult
|
|
467
|
+
try {
|
|
468
|
+
result = await attachment.publisher.finish(lease.key, lease.ref, outcome, {
|
|
469
|
+
startedAt: lease.startedAt,
|
|
470
|
+
decidedAt: lease.outcomeAt ?? this.now(),
|
|
471
|
+
tracked: lease.tracked,
|
|
472
|
+
})
|
|
473
|
+
} catch (err) {
|
|
474
|
+
attachment.logger.warn(`[github] review check finish failed for ${leaseId(lease.key)}: ${describe(err)}`)
|
|
475
|
+
result = 'retry'
|
|
476
|
+
}
|
|
477
|
+
if (result === 'retry') {
|
|
478
|
+
if (this.now() - (lease.outcomeAt ?? this.now()) >= REVIEW_CHECK_PUBLISH_GIVE_UP_MS) {
|
|
479
|
+
attachment.logger.warn(
|
|
480
|
+
`[github] giving up on review check ${leaseId(lease.key)}: GitHub kept rejecting its completion`,
|
|
481
|
+
)
|
|
482
|
+
this.drop(lease)
|
|
483
|
+
await this.persist()
|
|
484
|
+
}
|
|
485
|
+
return
|
|
486
|
+
}
|
|
487
|
+
if (version === lease.outcomeVersion) {
|
|
488
|
+
this.drop(lease)
|
|
489
|
+
await this.persist()
|
|
490
|
+
return
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
// A queued outcome that would write a shared commit-status context (or
|
|
496
|
+
// create a new check run) must not overwrite a newer review of the same
|
|
497
|
+
// commit under the same name. An App check run has its own id, and a check
|
|
498
|
+
// under another name is a separate check, so completing either stays safe.
|
|
499
|
+
private isSuperseded(lease: Lease): boolean {
|
|
500
|
+
if (lease.ref?.mode === 'check-run') return false
|
|
501
|
+
if ((this.newestCheckSeq.get(checkId(lease)) ?? -1) > lease.seq) return true
|
|
502
|
+
// A newer review whose check is still being created will overwrite it too.
|
|
503
|
+
return [...this.leases.values()].some(
|
|
504
|
+
(other) =>
|
|
505
|
+
other.seq > lease.seq && other.ref === undefined && sameKey(other.key, lease.key) && other.name === lease.name,
|
|
506
|
+
)
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
// Older decided outcomes this lease supersedes are retired right away, not at
|
|
510
|
+
// their next publish, so the persisted snapshot never holds one a restart
|
|
511
|
+
// could replay over the newer review.
|
|
512
|
+
private claimCheck(lease: Lease): void {
|
|
513
|
+
const id = checkId(lease)
|
|
514
|
+
this.newestCheckSeq.set(id, Math.max(this.newestCheckSeq.get(id) ?? -1, lease.seq))
|
|
515
|
+
for (const older of this.leases.values()) {
|
|
516
|
+
if (
|
|
517
|
+
older.seq < lease.seq &&
|
|
518
|
+
older.outcome !== undefined &&
|
|
519
|
+
older.ref !== undefined &&
|
|
520
|
+
older.ref?.mode !== 'check-run' &&
|
|
521
|
+
sameKey(older.key, lease.key) &&
|
|
522
|
+
older.name === lease.name
|
|
523
|
+
) {
|
|
524
|
+
this.leases.delete(older.uid)
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
private drop(lease: Lease): void {
|
|
530
|
+
if (this.leases.get(lease.uid) === lease) this.leases.delete(lease.uid)
|
|
531
|
+
if (![...this.leases.values()].some((other) => sameKey(other.key, lease.key) && other.name === lease.name)) {
|
|
532
|
+
this.newestCheckSeq.delete(checkId(lease))
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
private openLease(key: ReviewCheckKey): Lease | undefined {
|
|
537
|
+
return [...this.leases.values()].find((lease) => lease.outcome === undefined && sameKey(lease.key, key))
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
private holds(record: PersistedReviewCheckLease): boolean {
|
|
541
|
+
const key = normalizeKey(record)
|
|
542
|
+
return [...this.leases.values()].some((lease) => sameKey(lease.key, key) && sameRef(lease.ref, record.ref))
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
private persist(): Promise<void> {
|
|
546
|
+
const target = this.store
|
|
547
|
+
if (target === null) return this.persistChain
|
|
548
|
+
const snapshot: PersistedReviewCheckLease[] = [...this.leases.values()].flatMap((lease) => {
|
|
549
|
+
if (lease.ref === undefined || (lease.ref === null && lease.outcome === undefined)) return []
|
|
550
|
+
return [
|
|
551
|
+
{
|
|
552
|
+
...lease.key,
|
|
553
|
+
ref: lease.ref,
|
|
554
|
+
startedAt: lease.startedAt,
|
|
555
|
+
...(lease.tracked ? { tracked: true } : {}),
|
|
556
|
+
...(lease.outcome !== undefined ? { outcome: lease.outcome, outcomeAt: lease.outcomeAt } : {}),
|
|
557
|
+
},
|
|
558
|
+
]
|
|
559
|
+
})
|
|
560
|
+
this.persistChain = this.persistChain
|
|
561
|
+
.then(() => target.store.save(snapshot))
|
|
562
|
+
.catch((err: unknown) => {
|
|
563
|
+
target.logger.warn(`[github] review check leases not persisted: ${describe(err)}`)
|
|
564
|
+
})
|
|
565
|
+
return this.persistChain
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
export const githubReviewChecks = new GithubReviewCheckTracker()
|
|
570
|
+
|
|
571
|
+
function normalizeKey(key: ReviewCheckKey): ReviewCheckKey {
|
|
572
|
+
return { repo: canonicalGithubRepo(key.repo), pullRequest: key.pullRequest, headSha: key.headSha.toLowerCase() }
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
function sameKey(a: ReviewCheckKey, b: ReviewCheckKey): boolean {
|
|
576
|
+
return a.repo === b.repo && a.pullRequest === b.pullRequest && a.headSha === b.headSha
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
function sameRef(a: ReviewCheckRef | null | undefined, b: ReviewCheckRef | null): boolean {
|
|
580
|
+
if (a === undefined || a === null || b === null) return a === b
|
|
581
|
+
if (a.mode === 'check-run' && b.mode === 'check-run') return a.checkRunId === b.checkRunId
|
|
582
|
+
if (a.mode === 'status' && b.mode === 'status') {
|
|
583
|
+
return (a.context ?? REVIEW_CHECK_NAME) === (b.context ?? REVIEW_CHECK_NAME)
|
|
584
|
+
}
|
|
585
|
+
return false
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
function checkId(lease: Lease): string {
|
|
589
|
+
return `${leaseId(lease.key)}:${lease.name}`
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
function leaseId(key: ReviewCheckKey): string {
|
|
593
|
+
return `${canonicalGithubRepo(key.repo)}#${key.pullRequest}@${key.headSha.toLowerCase()}`
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
function describe(err: unknown): string {
|
|
597
|
+
return err instanceof Error ? err.message : String(err)
|
|
598
|
+
}
|