jackherd 1.6.0 → 1.7.0

package/src/watch/watch-events.ts

@@ -1,8 +1,12 @@
 import { CHECKS, type ChecksState } from '../plans/pull-requests'
+import { APPROVAL_EVENT, type ApprovalEvent } from './approvals'
 import { type CoordinatorLevel, type CoordinatorReading, isContextLevel, levelStep } from './coordinator-fill'
+import { emptyFailureState, type FailureState, failedTestsOf, isFailureState } from './failures'
 import { emptyFeedbackState, FEEDBACK_EVENT, type FeedbackEvent, type FeedbackState, isFeedbackState } from './feedback'
 import { isRecord } from './json-guards'
 import { isLaneLevels, LANE_FILL_EVENT, type LaneFillEvent, type LaneLevels } from './lane-fill'
+import { isLaneModels, LANE_MODEL_EVENT, type LaneModelEvent, type LaneModels } from './lane-model'
+import { isLaneParallels, LANE_PARALLEL_EVENT, type LaneParallelEvent, type LaneParallels } from './lane-parallel'
 import { type LaneSnapshot, type SeenSeqs, seenSeqsOf } from './lane-watch'
 import { emptyPreviewState, isPreviewState, PREVIEW_EVENT, type PreviewEvent, type PreviewState } from './previews'
 import { PULL_REQUEST_STATE, type WatchedPullRequest } from './pull-requests'
@@ -21,10 +25,13 @@ export const WATCH_EVENT = {
   feedback: FEEDBACK_EVENT,
   preview: PREVIEW_EVENT,
   laneFill: LANE_FILL_EVENT,
+  laneModel: LANE_MODEL_EVENT,
+  laneParallel: LANE_PARALLEL_EVENT,
+  approval: APPROVAL_EVENT,
   source: SOURCE_EVENT,
 } as const
 
-export type PullRequestObservation = Omit<WatchedPullRequest, 'number' | 'branch'>
+export type PullRequestObservation = Omit<WatchedPullRequest, 'number' | 'branch' | 'failedRuns'>
 
 /** The settled verdict of a pull request's checks on one head commit, the unit that fires once. */
 export type CheckVerdict = { headCommit: string; checks: ChecksState }
@@ -60,10 +67,18 @@ export type WatchState = {
   coordinatorLevel: CoordinatorLevel | null
   /** The feedback seen on the lanes' open pull requests; kept apart from `pullRequests`, it is read over REST. */
   feedback: FeedbackState
+  /** The failed tests read from the logs of the lanes' red pull requests, once per head commit; see `failures.ts`. */
+  failures: FailureState
   /** The previews seen on the lanes' open pull requests: per pull request the head last reported and the source versions. */
   previews: PreviewState
   /** The context level last read for each watched lane's agent; a rise above it fires `lane <name> <level>`. */
   laneLevels: LaneLevels
+  /** The differing model last reported for each watched lane's agent; a lane fitting its model column has none. */
+  laneModels: LaneModels
+  /** The phases last reported as able to run together for each watched lane; a lane without two has none. */
+  laneParallels: LaneParallels
+  /** The ids of the approval requests on disk when they were last read, each reported once while it is open. */
+  approvals: string[]
   /** Per configured source of `watch.sources`: the entries seen (`[id, fingerprint]`) and the start of a failure streak. */
   sources: SourceState
   /** Lane → change time of the report file last shown for it, null when it had none; a lane without an entry is unseen. */
@@ -75,12 +90,18 @@ export type WatchState = {
 /** The kinds of the events a pull request fires. */
 export const PULL_REQUEST_KINDS = [WATCH_EVENT.merged, WATCH_EVENT.checksFailed, WATCH_EVENT.checksPassed] as const
 
-/** A lane's pull request, or an own one without a lane, which names its branch instead. */
+/**
+ * A lane's pull request, or an own one without a lane, which names its branch instead. `checks failed` carries the names
+ * of the failed checks and, for a lane's pull request, the tests read from the logs of the head commit, each only when
+ * there is one; no other kind carries either.
+ */
 export type PullRequestEvent = {
   kind: (typeof PULL_REQUEST_KINDS)[number]
   number: number
   headCommit: string
   mergeCommit: string | null
+  failedChecks?: string[]
+  failedTests?: string[]
 } & ({ lane: string } | { lane: null; branch: string })
 
 /** A run of a lane's merge, or without a lane: of an own pull request's merge (`pullRequest`), else started by hand. */
@@ -105,6 +126,9 @@ export type WatchEvent =
   | FeedbackEvent
   | PreviewEvent
   | LaneFillEvent
+  | LaneModelEvent
+  | LaneParallelEvent
+  | ApprovalEvent
   | SourceEvent
 
 export const isPullRequestEvent = (event: WatchEvent): event is PullRequestEvent =>
@@ -132,8 +156,12 @@ export const emptyWatchState = (): WatchState => ({
   laneBranches: {},
   coordinatorLevel: null,
   feedback: emptyFeedbackState(),
+  failures: emptyFailureState(),
   previews: emptyPreviewState(),
   laneLevels: {},
+  laneModels: {},
+  laneParallels: {},
+  approvals: [],
   sources: emptySourceState(),
   reportMtimes: {},
   statusLines: null,
@@ -169,8 +197,13 @@ const isWatchState = (value: Record<string, unknown>): value is WatchState =>
   everyValue(value.laneBranches, (entry) => typeof entry === 'string') &&
   (value.coordinatorLevel === null || isContextLevel(value.coordinatorLevel)) &&
   isFeedbackState(value.feedback) &&
+  isFailureState(value.failures) &&
   isPreviewState(value.previews) &&
   isLaneLevels(value.laneLevels) &&
+  isLaneModels(value.laneModels) &&
+  isLaneParallels(value.laneParallels) &&
+  Array.isArray(value.approvals) &&
+  value.approvals.every((id) => typeof id === 'string') &&
   isSourceState(value.sources) &&
   everyValue(value.reportMtimes, isSeq) &&
   (value.statusLines === null ||
@@ -189,8 +222,12 @@ export const parseWatchState = (json: string): WatchState => {
       laneBranches: {},
       coordinatorLevel: null,
       feedback: emptyFeedbackState(),
+      failures: emptyFailureState(),
       previews: emptyPreviewState(),
       laneLevels: {},
+      laneModels: {},
+      laneParallels: {},
+      approvals: [],
       sources: emptySourceState(),
       reportMtimes: {},
       statusLines: null,
@@ -260,8 +297,12 @@ export const recordWatchState = (previous: WatchState, observation: Observation,
     laneBranches: keptLaneBranches(previous, observation, github.pullRequests),
     coordinatorLevel: previous.coordinatorLevel,
     feedback: previous.feedback,
+    failures: previous.failures,
     previews: previous.previews,
     laneLevels: previous.laneLevels,
+    laneModels: previous.laneModels,
+    laneParallels: previous.laneParallels,
+    approvals: previous.approvals,
     sources: previous.sources,
     reportMtimes: previous.reportMtimes,
     statusLines: previous.statusLines,
@@ -317,16 +358,34 @@ const eventKindOf = (known: PullRequestRecord, observed: PullRequestSnapshot): P
 const laneOfBranch = (laneBranches: Readonly<Record<string, string>>, branch: string): string | undefined =>
   Object.keys(laneBranches).find((lane) => laneBranches[lane] === branch)
 
+/** What a `checks failed` event adds: the failed checks' names, and a lane's failed tests; nothing for another kind. */
+const failureDetails = (
+  kind: PullRequestEvent['kind'],
+  pullRequest: PullRequestSnapshot,
+  isLane: boolean,
+  failures: FailureState,
+): Pick<PullRequestEvent, 'failedChecks' | 'failedTests'> => {
+  if (kind !== WATCH_EVENT.checksFailed) return {}
+  const failedChecks = pullRequest.failedRuns.map(({ name }) => name)
+  const failedTests = isLane ? failedTestsOf(failures, pullRequest.number, pullRequest.headCommit) : []
+  return {
+    ...(failedChecks.length > 0 && { failedChecks }),
+    ...(failedTests.length > 0 && { failedTests }),
+  }
+}
+
 /**
  * The merges and settled checks of the lanes' pull requests since `previous`, and of the user's own pull requests on
  * a branch without a lane, which name their branch. A pull request number never seen is a baseline, and so is an own
  * one the state does not mark as own yet. Checks fire once per head commit and settled verdict: a new head commit
- * fires when its checks settle, not while they are pending, and pending never clears what was reported.
+ * fires when its checks settle, not while they are pending, and pending never clears what was reported. A red verdict
+ * names the failed checks and, for a lane's pull request, the tests `failures` holds for its head commit.
  */
 export const pullRequestEvents = (
   previous: WatchState,
   current: readonly PullRequestSnapshot[],
   laneBranches: Readonly<Record<string, string>>,
+  failures: FailureState = emptyFailureState(),
 ): PullRequestEvent[] =>
   current.flatMap((pullRequest) => {
     const lane = laneOfBranch(laneBranches, pullRequest.branch)
@@ -336,7 +395,8 @@ export const pullRequestEvents = (
     if (!kind) return []
     const { number, headCommit, mergeCommit, branch } = pullRequest
     const owner = lane === undefined ? { lane: null, branch } : { lane }
-    return [{ kind, ...owner, number, headCommit, mergeCommit }]
+    const details = failureDetails(kind, pullRequest, lane !== undefined, failures)
+    return [{ kind, ...owner, number, headCommit, mergeCommit, ...details }]
   })
 
 /** The lane each merge commit belongs to, for matching deploy runs to a lane's merge. */

package/src/watch/watcher-lock.ts

@@ -95,7 +95,7 @@ const isAlive = (pid: number): boolean => {
   }
 }
 
-/** Where `ensureWatcherDirectory` puts the watcher's files, without creating anything: for readers such as the plans view. */
+/** Where `ensureWatcherDirectory` puts the watcher's files, without creating anything: for readers such as the herd. */
 export const watcherDirectoryOf = (root: string): string =>
   join(tmpdir(), `${DIRECTORY_PREFIX}-${process.getuid?.() ?? 'user'}`, repositoryKey(root))
 

package/src/watch/workflow-runs.ts

@@ -1,4 +1,6 @@
 import type { JackherdConfig } from '../config'
+import { GITHUB_HOST } from '../plans/github'
+import { runIdOfLink } from '../plans/pull-requests'
 import { isRecord, parseArray } from './json-guards'
 
 /** Which workflow's runs are deploys, and which environments count as their target (`watch.deploy`). */
@@ -37,8 +39,6 @@ export const WORKFLOW_RUN_FIELDS = 'databaseId,event,headSha,status,conclusion,c
 
 const RUN_LIMIT = '20'
 
-const RUN_LOG_PATH = /\/actions\/runs\/(\d+)\//
-
 const isGhWorkflowRun = (value: unknown): value is GhWorkflowRun =>
   isRecord(value) &&
   typeof value.databaseId === 'number' &&
@@ -89,8 +89,6 @@ export const runListArgs = (deploy: DeployConfig | undefined, baseBranch: string
       ]
     : null
 
-/** The run ID a deployment status's `log_url` (`…/actions/runs/<id>/job/<job>`) points at, or null. */
-export const runIdOfLogUrl = (logUrl: string): number | null => {
-  const match = logUrl.match(RUN_LOG_PATH)
-  return match ? Number(match[1]) : null
-}
+/** The run ID a deployment status's `log_url` (`…/actions/runs/<id>/job/<job>`) points at, or null; see `runIdOfLink`. */
+export const runIdOfLogUrl = (logUrl: string): number | null =>
+  runIdOfLink(logUrl, { host: GITHUB_HOST, repository: null })

package/docs/lanes.mmd

@@ -1,9 +0,0 @@
-flowchart LR
-  coordinator[Coordinator<br/>/orchestrate] -- prompts --> laneA[Lane a<br/>worktree a]
-  coordinator -- open decisions,<br/>one approval per PR --> user([You])
-  coordinator -- prompts --> laneB[Lane b<br/>worktree b]
-  laneA -- questions as text --> coordinator
-  laneB -- questions as text --> coordinator
-  watcher[jh watch] -- wakes --> coordinator
-  laneA -. state, PR, checks .-> watcher
-  laneB -. state, PR, checks .-> watcher

package/docs/skills.mmd

@@ -1,10 +0,0 @@
-flowchart LR
-  grill["/grill<br/>settles decisions"] -- decision rows --> plan["/plan<br/>writes the plan"]
-  plan -- phases, Writes,<br/>model per phase --> orchestrate["/orchestrate<br/>lanes in herdr"]
-  plan -- one phase --> implement["/implement<br/>builds, ticks"]
-  orchestrate -- each lane runs --> implement
-  implement --> precommit["/pre-commit<br/>jh check"]
-  precommit --> review["/review"]
-  precommit --> spec["spec-review"]
-  precommit -. routed by path .-> routed["uncle-bob · security-audit · devops"]
-  diagnose["/diagnose<br/>bug, flaky failure"] -- red command --> implement