Skip to main content

runner_manager_agent/
reconcile.rs

1// owner: e1-reconciliation-capacity
2
3//! The loop that turns GitHub demand into a decision to start runners — and
4//! that refuses to start them when it should not.
5//!
6//! Every ceiling in this product is enforced from here, so the module is
7//! organised around the four things that can go wrong silently:
8//!
9//! * [`PollSchedule`] — the budget-aware interval. Demand shares one 5,000
10//!   requests/hour ceiling with inventory and workflow counts, so this loop
11//!   polls an *active* target on a bounded interval (default 60 s, hard floor
12//!   30 s per target) and *increases* the delay under a rate-limit signal,
13//!   never decreases it to catch up. A target with nothing happening is polled
14//!   at the shorter *idle* interval (default 10 s), because its polls are
15//!   conditional requests answered `304`, which GitHub does not charge against
16//!   the hourly ceiling — and because work usually arrives after idle. When
17//!   the account's remaining quota runs low, the schedule stretches.
18//! * [`RepositoryCache`] — the per-organization repository list, refreshed on
19//!   an interval materially slower than the demand poll. Re-listing an
20//!   organization at demand-poll frequency is what exhausts the shared budget
21//!   the paragraph above exists to protect.
22//! * [`Reconciler::reconcile`] — the allocation pass. It re-reads the attempt
23//!   set **under the host-wide allocation lock, once per runtime created**, so
24//!   two policies reconciling concurrently cannot both spend the same headroom.
25//! * [`LifecycleEvent`] — what `g2` and the local log sink see. Every field is
26//!   an identifier, a count, an enumerated state or a duration; nothing free
27//!   text, and nothing that came off the wire.
28//!
29//! # There is no acquisition step, and none may be added
30//!
31//! The scale-set model called `AcquireJobs` to reserve an assignment before
32//! scaling. The REST path has no equivalent (`01-current-architecture.md`, edge
33//! case 6), so demand is **advisory**. Two consequences are load-bearing here
34//! and neither is a defect:
35//!
36//! 1. **A surplus runner is an accepted outcome.** Another host serving the
37//!    same labels may take the job first; this host's runner then finds no work
38//!    and exits on its idle timeout, having cost one capacity slot and one cold
39//!    start. That terminal outcome is
40//!    [`AttemptOutcome::ExitedIdleWithoutWork`], is cleaned like any other, and
41//!    is counted apart from a failure — see [`ReconcileReport::idle_exits`].
42//! 2. **The same job is still `queued` on the next poll** while its runner
43//!    starts. Subtracting only unassigned supply in
44//!    [`HostAllocator::allocate`] is what stops that from starting a second
45//!    runner, and then a third. This module's only job in that arithmetic is to
46//!    hand the allocator the attempt set the host actually holds — which is why
47//!    [`RunnerLauncher`] supplies both the attempts and the launch, from one
48//!    supply point, for the reason `b1` gives at
49//!    [`HostAllocator::from_attempts`].
50//!
51//! `tests::nothing_in_this_module_reserves_or_claims_a_job` is a tripwire on the
52//! obvious shape of a reservation being added back.
53//!
54//! # Demand is measured in JOBS, filtered by this policy's routing labels
55//!
56//! `02-target-architecture.md` writes the formula as *"queued jobs whose
57//! `runs-on` matches this policy's routing labels"*, and that is now exactly
58//! what this module clamps. It was not always: an earlier owner decision priced
59//! the per-run job listing out and left this module clamping a count of
60//! **runs**, unfiltered. `crates/github/src/demand.rs` records that decision,
61//! why it was reversed, and what the reversal costs in requests.
62//!
63//! What the reversal means here is two changes to one line:
64//!
65//! * **A run of eight jobs is now eight units of demand, not one.** Under the
66//!   run count a matrix filled one runner per poll while the rest of the matrix
67//!   waited, so a host configured for ten concurrent runners served an
68//!   eight-job matrix nearly serially. That was the defect that forced the
69//!   decision back.
70//! * **A job this host cannot serve is no longer demand.** A repository whose
71//!   jobs target `ubuntu-latest`, or another host's `rm-<host>-…` label, used to
72//!   drive its policy toward `max_capacity` and start runners that idled until
73//!   they timed out. The gateway now returns each queued job's `runs-on`, so
74//!   `b1`'s predicate finally has its input.
75//!
76//! **The predicate is still `b1`'s and the input is still `c4`'s.** This module
77//! calls [`runner_manager_domain::policy::RoutingLabels`]'s `tally` and
78//! implements no label comparison of its own;
79//! `tests::the_label_predicate_is_b1s_and_this_module_only_applies_it` scans
80//! this file's own source and fails if a second implementation grows here, which
81//! is the same tripwire `c4` carries one layer down.
82//!
83//! # The filtering happens here rather than in the gateway, on purpose
84//!
85//! One target can be watched by more than one policy, each with its own routing
86//! labels, and [`Reconciler`]'s `poll_targets` deliberately polls a target **once**
87//! for all of them. A gateway that filtered would have to be told whose labels to
88//! filter by, which would make the poll per-policy and multiply its request cost
89//! by the number of policies sharing the target — the budget model prices a
90//! target, not a policy. So the gateway returns the jobs and each policy tallies
91//! them against its own labels.
92//!
93//! # What is still approximate
94//!
95//! The surplus-runner path above is narrowed by this change and not closed. A
96//! `runs-on: ${{ matrix.runner }}` cannot be resolved without evaluating the
97//! workflow, so `b1` reports it as unresolvable: never counted as demand, never
98//! silently dropped, and surfaced through
99//! [`LifecycleEvent::DemandObserved::unresolvable`] so that an operator can see
100//! a workflow this host will never serve sitting in the queue. And demand
101//! remains advisory — another host may still take a job this one started a
102//! runner for — which is what the two ceilings bound.
103//!
104//! # What is testable without a network, a filesystem, or a process
105//!
106//! All of it. [`DemandSource`], [`RunnerLauncher`], [`AllocationLock`],
107//! [`RepositoryDirectory`], [`Jitter`] and [`EventSink`] are ports;
108//! [`GatewayDemand`], [`FileAllocationLock`], [`RandomJitter`] and
109//! [`TracingEvents`] are the production adapters, and every one of them is a
110//! thin shell over a decision made in this file.
111
112use std::collections::{BTreeMap, BTreeSet};
113use std::fmt;
114use std::num::NonZeroU16;
115use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
116use std::sync::{Arc, Mutex};
117use std::time::Duration;
118
119use runner_manager_domain::attempt::{
120    AttemptOutcome, AttemptState, FailureReason, IsolationProviderFailure, RunnerAttempt,
121};
122use runner_manager_domain::capacity::{Allocation, HostAllocator, LimitingFactor};
123use runner_manager_domain::memory::{MemoryFigures, MemoryVerdict};
124use runner_manager_domain::model::Label;
125use runner_manager_domain::model::{
126    AttemptId, Clock, Host, IdlePollInterval, Org, OwnerRepo, PolicyId, RefreshInterval,
127    ScaleTarget, Timestamp,
128};
129use runner_manager_domain::policy::{DemandTally, HostTraits, ScalePolicy};
130use runner_manager_github::demand::{DemandGateway, QueuedDemand, demand_requests_per_poll};
131use runner_manager_github::rest::{
132    ActivityScope, CancelToken, InventoryError, RateLimitKind, RefreshState,
133};
134use runner_manager_github::traffic::{PrimaryPressure, RateLimitSnapshot};
135
136// ---------------------------------------------------------------------------
137// Constants
138// ---------------------------------------------------------------------------
139
140/// How much slower than the demand poll the per-organization repository list is
141/// refreshed.
142///
143/// There is no organization-wide workflow-runs endpoint, so an organization
144/// target costs one demand request **per repository the App is installed on**
145/// (`crates/github/src/demand.rs`). Discovering that repository list costs
146/// requests of its own, and it is the one input to a demand poll that changes on
147/// a human timescale: repositories are added to an installation by hand, not by
148/// a workflow starting.
149///
150/// Thirty polls is 30 minutes at the 60-second default and 15 at the 30-second
151/// floor — slow enough that the list is a rounding error against the demand
152/// requests it scopes, and fast enough that a repository added to the
153/// installation starts being served within one coffee break rather than at the
154/// next restart.
155pub const REPOSITORY_LIST_REFRESH_MULTIPLE: u32 = 30;
156
157/// The longest the *unjittered* offline back-off may grow to.
158///
159/// A back-off is a safety mechanism, and an unclamped one is an outage with
160/// extra steps. Fifteen minutes matches
161/// [`runner_manager_github::rest::MAX_RATE_LIMIT_BACKOFF`], which is the other
162/// place in this product where a delay is allowed to grow, and it is far inside
163/// the 24-hour bound at which GitHub cancels the queued jobs this loop exists to
164/// serve.
165pub const MAX_OFFLINE_BACKOFF: Duration = Duration::from_secs(15 * 60);
166
167/// The most the offline back-off is doubled, before the cap applies.
168///
169/// At the 60-second default this reaches [`MAX_OFFLINE_BACKOFF`] on the sixth
170/// consecutive failure, which is roughly half an hour of outage. Past that the
171/// cap holds it flat.
172const MAX_BACKOFF_DOUBLINGS: u32 = 5;
173
174/// How much of the computed back-off is jitter.
175///
176/// Jitter is **added** rather than subtracted, so a back-off never comes out
177/// shorter than the delay it was computed from. Subtractive jitter would let the
178/// first offline poll retry sooner than the nominal interval, which is the
179/// opposite of backing off; it is spelled out because "add jitter" reads as
180/// symmetric and is not.
181const JITTER_RATIO: f64 = 0.5;
182
183/// How much of a rate-limit wait is jitter: added, never subtracted.
184///
185/// Every target loop on a host shares one rate-limit quiet period, so without
186/// it they all wake at the same instant the period ends, and a burst is the
187/// shape most likely to meet the secondary limit again. A tenth spreads them
188/// over a few seconds to a minute and a half without overshooting a
189/// 15-minute wait by much.
190const RATE_LIMIT_JITTER_RATIO: f64 = 0.1;
191
192/// The most demand requests a minute one target's idle polling may cost.
193///
194/// A third of GitHub's 900-a-minute secondary limit. A target of one or a few
195/// repositories never reaches it at the 5-second floor, but an organization of
196/// a hundred repositories costs about four hundred requests a pass, and at a
197/// 10-second idle interval that alone would exceed the whole account's
198/// secondary limit. Its idle interval stretches instead.
199pub const MAX_IDLE_REQUESTS_PER_MINUTE_PER_TARGET: u32 = 300;
200
201/// GitHub cancels a queued job after this long.
202///
203/// `01-current-architecture.md` records the measurement; `03-control-flows.md`
204/// flow 3.3 requires that the offline state **states** it, because an agent
205/// offline for longer than this has lost queued work and the operator cannot
206/// infer that from "offline". [`OfflineState`] is where it is said.
207pub const GITHUB_CANCELS_QUEUED_JOBS_AFTER: Duration = Duration::from_secs(24 * 60 * 60);
208
209/// How long [`FileAllocationLock`] waits for the host-wide allocation lock
210/// before reporting contention.
211///
212/// Contention here is expected rather than exceptional — it is two of this
213/// host's own policies creating runtimes at the same moment — and each hold
214/// lasts only as long as one runtime creation. Waiting a few seconds turns the
215/// common case into a short pause instead of a skipped runner.
216///
217/// # How many of these a poll actually costs
218///
219/// One per runtime created, none for a policy that is granted nothing, and at
220/// most one further hold per policy — the case where the pre-check proposed a
221/// grant and the under-lock re-read found the host had filled up underneath it,
222/// so that hold creates nothing and ends the loop. `(3..=5)` in
223/// `two_policies_reconciling_concurrently_never_exceed_host_capacity` is that
224/// bound with two policies and three runtimes; the deterministic single-policy
225/// case is pinned at exactly one per runtime.
226///
227/// That is worth stating because it did not used to be true and the
228/// difference only shows up here: the budget was checked *after* the lock had
229/// been taken and the attempt set re-read, so a policy granted N runners took
230/// N+1 holds, and `start_runners` ran for every readable autoscale policy
231/// including the zero-demand ones — so an idle host with P policies took P
232/// host-wide locks per poll for nothing. Free under
233/// [`InProcessAllocationLock`]; under [`FileAllocationLock`] each one is a
234/// `spawn_blocking` plus a filesystem lock, with this wait behind it.
235///
236/// [`Reconciler::start_runners`] now pre-checks lock-free and stops as soon as
237/// the budget is spent. The under-lock re-read still decides.
238pub const ALLOCATION_LOCK_WAIT: Duration = Duration::from_secs(5);
239
240// ---------------------------------------------------------------------------
241// What one demand poll produced
242// ---------------------------------------------------------------------------
243
244/// One target's demand poll, as a value this module can decide from.
245///
246/// The failure half is `c3`'s [`RefreshState`] rather than an
247/// [`InventoryError`], for the reason `c3` gives: `InventoryError` owns a
248/// `reqwest::Error` and a `serde_json::Error`, so it is neither `Clone` nor
249/// `PartialEq` and cannot be stored, compared, or rendered. Summarising at the
250/// gateway boundary — exactly once, in [`GatewayDemand`] — is what lets the
251/// whole schedule below be a pure function of values a test can construct.
252///
253/// [`RefreshState::Ready`] never appears in [`PollOutcome::Failed`]:
254/// [`RefreshState::from_error`] cannot produce it, and a demand poll returns a
255/// [`QueuedDemand`] rather than the runner inventory that variant carries.
256#[derive(Debug, Clone, PartialEq, Eq)]
257pub enum PollOutcome {
258    /// GitHub answered. The count may still be a floor — see
259    /// [`QueuedDemand::is_complete`].
260    Ready(QueuedDemand),
261    /// GitHub did not answer, or answered something this loop must slow down
262    /// for.
263    Failed(RefreshState),
264}
265
266impl PollOutcome {
267    /// The demand reading, when there is one.
268    #[must_use]
269    pub const fn reading(&self) -> Option<&QueuedDemand> {
270        match self {
271            Self::Ready(demand) => Some(demand),
272            Self::Failed(_) => None,
273        }
274    }
275
276    /// The failure, when there is one.
277    #[must_use]
278    pub const fn failure(&self) -> Option<&RefreshState> {
279        match self {
280            Self::Failed(state) => Some(state),
281            Self::Ready(_) => None,
282        }
283    }
284
285    /// Whether GitHub could not be reached at all, as opposed to answering
286    /// something unwelcome.
287    ///
288    /// The whole of flow 3.3 turns on this distinction: an outage retains
289    /// running runners and backs off, while a rejection is a configuration
290    /// problem that waiting does not fix.
291    #[must_use]
292    pub fn is_offline(&self) -> bool {
293        matches!(self, Self::Failed(RefreshState::Offline))
294    }
295}
296
297/// Where this loop gets its demand from.
298///
299/// A port rather than a direct [`DemandGateway`] dependency, because the two
300/// failures this loop must handle differently — unreachable and rate-limited —
301/// are distinguished by [`RefreshState`], and a test that wants to drive the
302/// offline path should not have to manufacture a `reqwest::Error` to do it.
303/// [`GatewayDemand`] is the one adapter that talks to `c4`.
304#[async_trait::async_trait]
305pub trait DemandSource: fmt::Debug + Send + Sync {
306    /// Queued runs across `scope`, or why there are none to report.
307    async fn poll(&self, scope: &ActivityScope) -> PollOutcome;
308}
309
310/// [`DemandSource`] over `c4`'s [`DemandGateway`].
311///
312/// Holds the [`CancelToken`] so that a shutting-down daemon can withdraw a poll
313/// that is already blocked on a socket; `f3` keeps a clone and cancels it.
314#[derive(Debug)]
315pub struct GatewayDemand<G> {
316    gateway: G,
317    cancel: CancelToken,
318}
319
320impl<G: DemandGateway> GatewayDemand<G> {
321    #[must_use]
322    pub const fn new(gateway: G, cancel: CancelToken) -> Self {
323        Self { gateway, cancel }
324    }
325
326    #[must_use]
327    pub const fn gateway(&self) -> &G {
328        &self.gateway
329    }
330}
331
332#[async_trait::async_trait]
333impl<G: DemandGateway + 'static> DemandSource for GatewayDemand<G> {
334    async fn poll(&self, scope: &ActivityScope) -> PollOutcome {
335        match self.gateway.queued_demand(scope, &self.cancel).await {
336            Ok(demand) => PollOutcome::Ready(demand),
337            // The one place an `InventoryError` is summarised. `c3` owns the
338            // mapping — including transport-to-`Offline`, which is what flow
339            // 3.3 branches on — so this loop never re-decides it.
340            Err(error) => PollOutcome::Failed(RefreshState::from_error(&error)),
341        }
342    }
343}
344
345// ---------------------------------------------------------------------------
346// The repository list, cached
347// ---------------------------------------------------------------------------
348
349/// Which repositories an organization installation reaches.
350///
351/// `f1` already holds this, from
352/// [`runner_manager_github::AuthenticatedClient::discover_installations`]. It is
353/// a port here so that [`RepositoryCache`] can be tested for the property that
354/// matters — how *often* it asks — without a network.
355#[async_trait::async_trait]
356pub trait RepositoryDirectory: fmt::Debug + Send + Sync {
357    /// The repositories this credential reaches in `org`.
358    ///
359    /// # Errors
360    /// Anything the underlying gateway reports.
361    async fn repositories(&self, org: &Org) -> Result<Vec<OwnerRepo>, InventoryError>;
362}
363
364#[derive(Debug, Clone)]
365struct CachedRepositories {
366    repositories: Vec<OwnerRepo>,
367    fetched_at: Timestamp,
368}
369
370/// The per-organization repository list, refreshed far more slowly than demand.
371///
372/// # Why this is not just "call the directory each poll"
373///
374/// An organization demand poll already costs one request per repository. Adding
375/// the installation listing to every poll makes the *scoping* of a poll cost
376/// requests on the same schedule as the poll itself, which is how a
377/// ten-repository organization at the 30-second floor stops fitting inside the
378/// half-of-5,000 allowance `f2` admits targets against. The repository list is
379/// also the one input that changes on a human timescale, so refreshing it
380/// [`REPOSITORY_LIST_REFRESH_MULTIPLE`] times more slowly costs nothing real.
381///
382/// # A repository target never consults the directory at all
383///
384/// Its scope is itself. That is not an optimisation; asking an installation
385/// listing which repositories a single named repository covers would be asking a
386/// question whose answer is already in the target.
387#[derive(Debug)]
388pub struct RepositoryCache {
389    directory: Arc<dyn RepositoryDirectory>,
390    clock: Arc<dyn Clock>,
391    ttl: Duration,
392    entries: Mutex<BTreeMap<Org, CachedRepositories>>,
393    lookups: AtomicU64,
394}
395
396impl RepositoryCache {
397    /// Build a cache whose refresh interval is `poll` slowed by
398    /// [`REPOSITORY_LIST_REFRESH_MULTIPLE`].
399    #[must_use]
400    pub fn new(
401        directory: Arc<dyn RepositoryDirectory>,
402        clock: Arc<dyn Clock>,
403        poll: RefreshInterval,
404    ) -> Self {
405        let ttl = Duration::from_secs(u64::from(poll.as_secs()))
406            .saturating_mul(REPOSITORY_LIST_REFRESH_MULTIPLE);
407        Self {
408            directory,
409            clock,
410            ttl,
411            entries: Mutex::new(BTreeMap::new()),
412            lookups: AtomicU64::new(0),
413        }
414    }
415
416    /// How long a cached repository list is reused for.
417    #[must_use]
418    pub const fn ttl(&self) -> Duration {
419        self.ttl
420    }
421
422    /// How many times the underlying directory was actually asked.
423    ///
424    /// Measured rather than assumed, for the reason `c4` measures its own
425    /// request count: a budget nothing counts is a table in a document.
426    #[must_use]
427    pub fn lookups(&self) -> u64 {
428        self.lookups.load(Ordering::SeqCst)
429    }
430
431    /// The scope one demand poll of `target` covers.
432    ///
433    /// # Errors
434    /// Whatever the directory reported, for an organization target whose list is
435    /// stale or absent. A repository target cannot fail.
436    pub async fn scope_for(&self, target: &ScaleTarget) -> Result<ActivityScope, InventoryError> {
437        match target {
438            ScaleTarget::Repository(repository) => {
439                Ok(ActivityScope::repository(repository.clone()))
440            }
441            ScaleTarget::Organization(org) => {
442                let repositories = self.repositories_of(org).await?;
443                Ok(ActivityScope::organization(org.clone(), repositories))
444            }
445        }
446    }
447
448    async fn repositories_of(&self, org: &Org) -> Result<Vec<OwnerRepo>, InventoryError> {
449        let now = self.clock.now();
450        if let Some(fresh) = self.fresh_entry(org, now) {
451            return Ok(fresh);
452        }
453
454        // The directory call is deliberately made with no lock held. Two
455        // concurrent misses can therefore both ask, which costs one extra
456        // listing on the poll that follows a restart; holding a `std::sync`
457        // mutex across an `await` would cost a blocked executor thread and, on
458        // a current-thread runtime, a deadlock. The cheaper mistake is the one
459        // that spends a request.
460        let repositories = self.directory.repositories(org).await?;
461        self.lookups.fetch_add(1, Ordering::SeqCst);
462        self.store(org.clone(), repositories.clone(), now);
463        Ok(repositories)
464    }
465
466    fn fresh_entry(&self, org: &Org, now: Timestamp) -> Option<Vec<OwnerRepo>> {
467        let entries = self.entries.lock().ok()?;
468        let entry = entries.get(org)?;
469        let age = now.signed_duration_since(entry.fetched_at).to_std().ok()?;
470        (age < self.ttl).then(|| entry.repositories.clone())
471    }
472
473    fn store(&self, org: Org, repositories: Vec<OwnerRepo>, fetched_at: Timestamp) {
474        if let Ok(mut entries) = self.entries.lock() {
475            entries.insert(
476                org,
477                CachedRepositories {
478                    repositories,
479                    fetched_at,
480                },
481            );
482        }
483    }
484}
485
486// ---------------------------------------------------------------------------
487// Jitter
488// ---------------------------------------------------------------------------
489
490/// The randomness in the offline back-off, as a port.
491///
492/// Flow 3.3 requires jittered back-off, and a jittered delay is by construction
493/// not reproducible — so the source of the randomness is a port, and every test
494/// below asserts the *bounds* of the delay against a fixed fraction rather than
495/// asserting a number it could only have got by running the generator.
496pub trait Jitter: fmt::Debug + Send + Sync {
497    /// A fraction in `[0.0, 1.0)`. Values outside that range are clamped by the
498    /// caller, so an implementation cannot lengthen a back-off without bound.
499    fn fraction(&self) -> f64;
500}
501
502/// The production source.
503#[derive(Debug, Clone, Copy, Default)]
504pub struct RandomJitter;
505
506impl Jitter for RandomJitter {
507    fn fraction(&self) -> f64 {
508        rand::random::<f64>()
509    }
510}
511
512/// A fixed fraction, for tests and for the acceptance suite.
513#[derive(Debug, Clone, Copy)]
514pub struct FixedJitter(pub f64);
515
516impl Jitter for FixedJitter {
517    fn fraction(&self) -> f64 {
518        self.0
519    }
520}
521
522/// No jitter at all: the back-off is exactly what the schedule computed.
523#[derive(Debug, Clone, Copy, Default)]
524pub struct NoJitter;
525
526impl Jitter for NoJitter {
527    fn fraction(&self) -> f64 {
528        0.0
529    }
530}
531
532// ---------------------------------------------------------------------------
533// The schedule
534// ---------------------------------------------------------------------------
535
536/// Why the next poll is when it is.
537///
538/// Reported rather than inferred, because
539/// `04-subsystem-contracts.md` requires that rate limiting be *"displayed, never
540/// hidden"* — and a delay that grew for a reason the caller cannot name is
541/// hidden however visible the number is.
542#[derive(Debug, Clone, Copy, PartialEq, Eq)]
543pub enum PollPace {
544    /// The configured (active) interval. Nothing is throttling this loop.
545    Nominal,
546    /// The idle interval: nothing is happening on this target, so its polls
547    /// are `304`s and cost nothing against the hourly quota. Not a slowdown.
548    Idle,
549    /// The account's remaining hourly quota is low, so this loop waits a
550    /// multiple of its active interval. GitHub's quota is per user, shared by
551    /// every host signed in as that user, so this can be another machine's
552    /// doing.
553    Stretched { pressure: PrimaryPressure },
554    /// GitHub's rate limit is exhausted. Resolves by waiting.
555    RateLimited { kind: RateLimitKind },
556    /// GitHub's temporary authentication lockout. The credential is fine.
557    LockedOut,
558    /// GitHub could not be reached. `consecutive` counts the unbroken run of
559    /// failures the back-off was computed from.
560    Offline { consecutive: u32 },
561    /// GitHub answered something no amount of waiting fixes — a rejected
562    /// credential, a permissions refusal, or an error status. The loop keeps
563    /// polling at its nominal interval so that a fix is noticed, and says that
564    /// it is blocked rather than pretending the poll succeeded.
565    Blocked,
566}
567
568impl PollPace {
569    /// Whether this pace is a slowdown the operator should be told about.
570    #[must_use]
571    pub const fn is_throttled(&self) -> bool {
572        !matches!(self, Self::Nominal | Self::Idle)
573    }
574
575    /// A fixed, credential-free name for the log sink and for `g2`.
576    #[must_use]
577    pub const fn as_str(&self) -> &'static str {
578        match self {
579            Self::Nominal => "nominal",
580            Self::Idle => "idle",
581            Self::Stretched {
582                pressure: PrimaryPressure::Normal,
583            } => "nominal",
584            Self::Stretched {
585                pressure: PrimaryPressure::Low,
586            } => "stretched_low_budget",
587            Self::Stretched {
588                pressure: PrimaryPressure::Critical,
589            } => "stretched_critical_budget",
590            Self::RateLimited {
591                kind: RateLimitKind::Primary,
592            } => "rate_limited_primary",
593            Self::RateLimited {
594                kind: RateLimitKind::Secondary,
595            } => "rate_limited_secondary",
596            Self::LockedOut => "locked_out",
597            Self::Offline { .. } => "offline",
598            Self::Blocked => "blocked",
599        }
600    }
601}
602
603impl fmt::Display for PollPace {
604    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
605        f.write_str(self.as_str())
606    }
607}
608
609/// When to poll next, and why then.
610#[derive(Debug, Clone, Copy, PartialEq, Eq)]
611pub struct NextPoll {
612    pub delay: Duration,
613    pub pace: PollPace,
614}
615
616/// The bounded, budget-aware poll interval.
617///
618/// # The floor is a rate-budget constraint, not a preference
619///
620/// [`RefreshInterval`] refuses anything under 30 seconds at construction, and
621/// every delay this type produces is at least that — including the ones it
622/// computes from a remote header. A rate limit may only ever make this loop
623/// *slower*.
624///
625/// # `retry_delay` is an absolute floor, not an addend
626///
627/// `c3` documents [`RefreshState::retry_delay`] as *"the earliest time a retry
628/// may occur"*: the scheduling rule is `next_attempt_at = now + retry_delay`,
629/// and **not** the ordinary interval plus it. Adding the two compounds on every
630/// successive retry — each new answer carries the remaining window, so an
631/// addend ratchets outward — and the symptom is a dashboard that stays dark
632/// long after GitHub said it could come back, which reads as a hang rather than
633/// as a rate limit. So the two are combined with `max`, which is what makes the
634/// floor a floor.
635#[derive(Debug, Clone)]
636pub struct PollSchedule {
637    interval: RefreshInterval,
638    /// The idle interval. Equal to the active one until [`Self::with_idle`]
639    /// says otherwise, so a caller that never heard of it keeps its schedule.
640    idle: Duration,
641    consecutive_offline: u32,
642    offline_since: Option<Timestamp>,
643}
644
645/// What a successful pass found, beyond "GitHub answered".
646#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
647pub struct PollConditions {
648    /// Nothing is happening: no live runner, no run whose listings changed.
649    /// See `QueuedDemand::is_quiet`.
650    pub quiet: bool,
651    /// The account's hourly quota as GitHub last reported it.
652    pub quota: Option<RateLimitSnapshot>,
653    /// What one poll of this target costs, in demand requests. Stretches the
654    /// idle interval of a target too large to poll that often; see
655    /// [`MAX_IDLE_REQUESTS_PER_MINUTE_PER_TARGET`].
656    pub requests_per_pass: u32,
657}
658
659impl PollSchedule {
660    #[must_use]
661    pub const fn new(interval: RefreshInterval) -> Self {
662        Self {
663            interval,
664            idle: Duration::from_secs(interval.as_secs() as u64),
665            consecutive_offline: 0,
666            offline_since: None,
667        }
668    }
669
670    /// Poll a quiet target every `idle` instead of every active interval.
671    ///
672    /// Never longer than the active interval: an idle interval above it would
673    /// make a quiet target *slower* to notice work than a busy one.
674    #[must_use]
675    pub fn with_idle(mut self, idle: Duration) -> Self {
676        self.set_intervals(self.interval, idle);
677        self
678    }
679
680    /// Change both intervals while running.
681    pub fn set_intervals(&mut self, interval: RefreshInterval, idle: Duration) {
682        self.interval = interval;
683        self.idle = idle.min(self.nominal()).max(Self::idle_floor());
684    }
685
686    #[must_use]
687    pub const fn interval(&self) -> RefreshInterval {
688        self.interval
689    }
690
691    /// The interval a quiet target is polled at.
692    #[must_use]
693    pub const fn idle(&self) -> Duration {
694        self.idle
695    }
696
697    /// The shortest delay this schedule ever produces: the idle interval's
698    /// floor. See `IdlePollInterval` for why it is lower than [`Self::floor`].
699    #[must_use]
700    pub const fn idle_floor() -> Duration {
701        Duration::from_secs(IdlePollInterval::MIN_SECS as u64)
702    }
703
704    /// The nominal interval as a [`Duration`].
705    #[must_use]
706    pub const fn nominal(&self) -> Duration {
707        Duration::from_secs(self.interval.as_secs() as u64)
708    }
709
710    /// The unbroken run of offline polls this schedule has seen.
711    #[must_use]
712    pub const fn consecutive_offline(&self) -> u32 {
713        self.consecutive_offline
714    }
715
716    /// How long GitHub has been unreachable, or `None` when it is not.
717    ///
718    /// Measured from the first poll of the current run rather than inferred
719    /// from [`Self::consecutive_offline`] times the interval. The two diverge
720    /// as soon as the back-off starts doubling, and this is the number the
721    /// 24-hour queue-cancellation warning is compared against — an estimate
722    /// would make that warning fire early or late, and it is the one thing the
723    /// offline state exists to say.
724    #[must_use]
725    pub fn offline_for(&self, now: Timestamp) -> Option<Duration> {
726        let since = self.offline_since?;
727        now.signed_duration_since(since).to_std().ok()
728    }
729
730    /// The hard floor no computed delay may go below.
731    #[must_use]
732    pub const fn floor() -> Duration {
733        Duration::from_secs(RefreshInterval::MIN_SECS as u64)
734    }
735
736    /// Decide when to poll next, given how this pass ended.
737    ///
738    /// `failure` is the most severe failure across the targets polled this pass,
739    /// or `None` when every target answered. A pass that answered resets the
740    /// offline run, which is the whole of "recovery needs no bookkeeping":
741    /// demand is recomputed from the current queued-run set on every poll, so
742    /// there is nothing else to unwind.
743    pub fn next_poll(
744        &mut self,
745        failure: Option<&RefreshState>,
746        now: Timestamp,
747        jitter: &dyn Jitter,
748    ) -> NextPoll {
749        self.next_poll_with(failure, PollConditions::default(), now, jitter)
750    }
751
752    /// [`Self::next_poll`], with what a successful pass found.
753    ///
754    /// # On success, three paces, in this order
755    ///
756    /// 1. **Stretched**, when the account's remaining quota is under
757    ///    `LOW_PRIMARY_REMAINING_PERCENT`: the active interval times
758    ///    [`PrimaryPressure::stretch_factor`] (2, or 4 under
759    ///    `CRITICAL_PRIMARY_REMAINING_PERCENT`), but never past the quota's
760    ///    reset — waiting longer than that buys nothing, because the bucket is
761    ///    full again. This wins over idle: a `304` is free, but the poll that
762    ///    finds new work is not, and every host on the account draws from the
763    ///    same bucket.
764    /// 2. **Idle**, when the pass was quiet.
765    /// 3. **Nominal**, the active interval, otherwise.
766    pub fn next_poll_with(
767        &mut self,
768        failure: Option<&RefreshState>,
769        conditions: PollConditions,
770        now: Timestamp,
771        jitter: &dyn Jitter,
772    ) -> NextPoll {
773        let nominal = self.nominal();
774
775        let next = match failure {
776            None => {
777                self.recovered();
778                let pressure = conditions
779                    .quota
780                    .map_or(PrimaryPressure::Normal, |quota| quota.pressure(now));
781                match (pressure, conditions.quota) {
782                    (PrimaryPressure::Low | PrimaryPressure::Critical, Some(quota)) => NextPoll {
783                        delay: nominal
784                            .saturating_mul(pressure.stretch_factor())
785                            .min(quota.reset_in(now).max(nominal)),
786                        pace: PollPace::Stretched { pressure },
787                    },
788                    // An idle interval no shorter than the active one is no
789                    // idle interval at all, and naming it would be noise.
790                    _ if conditions.quiet && self.idle < nominal => NextPoll {
791                        delay: self.idle.max(idle_floor_for(conditions.requests_per_pass)),
792                        pace: PollPace::Idle,
793                    },
794                    _ => NextPoll {
795                        delay: nominal,
796                        pace: PollPace::Nominal,
797                    },
798                }
799            }
800            Some(RefreshState::Offline) => {
801                self.consecutive_offline = self.consecutive_offline.saturating_add(1);
802                // The instant the *run* began, not the instant of this poll.
803                self.offline_since.get_or_insert(now);
804                NextPoll {
805                    delay: self.offline_delay(nominal, jitter),
806                    pace: PollPace::Offline {
807                        consecutive: self.consecutive_offline,
808                    },
809                }
810            }
811            Some(state @ RefreshState::RateLimited(limit)) => {
812                self.recovered();
813                // `max`, never `+`. See the type documentation. The jitter is
814                // added to the result, never to the floor GitHub named.
815                let wait = retry_floor(state, now).max(nominal);
816                NextPoll {
817                    delay: wait.saturating_add(
818                        wait.mul_f64(RATE_LIMIT_JITTER_RATIO * jitter.fraction().clamp(0.0, 1.0)),
819                    ),
820                    pace: PollPace::RateLimited { kind: limit.kind },
821                }
822            }
823            Some(state @ RefreshState::LockedOut { .. }) => {
824                self.recovered();
825                NextPoll {
826                    delay: retry_floor(state, now).max(nominal),
827                    pace: PollPace::LockedOut,
828                }
829            }
830            // Unauthorized, Forbidden, Failed, Cancelled. `retry_delay` is
831            // `None` for all of them, and deliberately: no wait fixes a revoked
832            // credential or a missing grant. Polling stops being useful but
833            // does not stop, because the poll is also how a re-authentication
834            // is noticed.
835            Some(_) => {
836                // GitHub answered, so it is reachable: whatever is wrong, it is
837                // not an outage, and an outage run that was open must close.
838                self.recovered();
839                NextPoll {
840                    delay: nominal,
841                    pace: PollPace::Blocked,
842                }
843            }
844        };
845
846        debug_assert!(
847            next.delay >= Self::floor() || next.pace == PollPace::Idle,
848            "the 30-second floor is a rate-budget constraint and no charged branch may go below it"
849        );
850        debug_assert!(
851            next.delay >= Self::idle_floor(),
852            "the idle floor is a secondary-limit constraint and no branch may go below it"
853        );
854        next
855    }
856
857    /// GitHub answered something. Whatever it was, the outage run is over.
858    fn recovered(&mut self) {
859        self.consecutive_offline = 0;
860        self.offline_since = None;
861    }
862
863    fn offline_delay(&self, nominal: Duration, jitter: &dyn Jitter) -> Duration {
864        let doublings = self
865            .consecutive_offline
866            .saturating_sub(1)
867            .min(MAX_BACKOFF_DOUBLINGS);
868        let grown = nominal.saturating_mul(1_u32 << doublings);
869        let capped = grown.min(MAX_OFFLINE_BACKOFF);
870        // Additive, never subtractive: see `JITTER_RATIO`. The result may exceed
871        // `MAX_OFFLINE_BACKOFF` by up to the jitter ratio, which is the price of
872        // keeping a fleet of agents from retrying in lockstep at the plateau —
873        // a cap applied *after* jitter would collapse every agent onto the same
874        // instant precisely when the outage is longest.
875        let spread = capped.mul_f64(JITTER_RATIO * jitter.fraction().clamp(0.0, 1.0));
876        capped.saturating_add(spread).max(Self::floor())
877    }
878}
879
880/// Whether a pass found nothing happening, so the next one may come at the
881/// idle interval.
882///
883/// All three are needed. Every target answered, and quietly
884/// (`QueuedDemand::is_quiet`); this pass started no runner; and no policy
885/// here holds a live one. A live runner means a job is running or about to,
886/// and its follow-on work (`needs:`, the next matrix wave) is exactly what an
887/// active target is polled for. A pass that polled nothing is not quiet: there
888/// is nothing to be quiet about, and the active interval is what it had
889/// before.
890fn is_quiet(readings: &BTreeMap<ScaleTarget, PollOutcome>, report: &ReconcileReport) -> bool {
891    !readings.is_empty()
892        && readings
893            .values()
894            .all(|outcome| outcome.reading().is_some_and(QueuedDemand::is_quiet))
895        && report.started == 0
896        // A missing allocation after a journal failure is unknown activity,
897        // not evidence that the host is idle.
898        && report.host_capacity_unreadable == 0
899        && report.attempts_unreadable == 0
900        // Demand this host matched and did not serve is not quiet either: a
901        // launch that keeps failing (a refused JIT registration) would
902        // otherwise be retried, and charged, every few seconds.
903        && report
904            .allocations
905            .iter()
906            .all(|allocation| allocation.active_owned == 0 && allocation.demand == 0)
907}
908
909/// The shortest idle delay a poll of `requests_per_pass` requests may have.
910fn idle_floor_for(requests_per_pass: u32) -> Duration {
911    Duration::from_secs(
912        u64::from(requests_per_pass) * 60 / u64::from(MAX_IDLE_REQUESTS_PER_MINUTE_PER_TARGET),
913    )
914}
915
916/// `c3`'s retry floor, with the one fallback this loop needs.
917///
918/// [`RefreshState::retry_delay`] answers `None` for the states no wait fixes,
919/// and those never reach here — the caller matches them into
920/// [`PollPace::Blocked`] first. The fallback exists so that a future
921/// `RefreshState` variant added to the two arms above cannot silently schedule a
922/// zero-second retry against an endpoint that asked for quiet.
923fn retry_floor(state: &RefreshState, now: Timestamp) -> Duration {
924    state.retry_delay(now).unwrap_or(PollSchedule::floor())
925}
926
927// ---------------------------------------------------------------------------
928// Offline
929// ---------------------------------------------------------------------------
930
931/// What an operator is told while GitHub is unreachable.
932///
933/// Flow 3.3 requires four things of an outage — start no new runner, retain
934/// existing runner processes, report `offline`, back off with jitter — and one
935/// thing of the *state*: that it says GitHub cancels queued jobs after 24 hours,
936/// so a prolonged outage loses queued work. That bound is stated here rather
937/// than left for a reader to infer, because an operator who does not know it has
938/// no reason to treat a long outage as urgent.
939#[derive(Debug, Clone, Copy, PartialEq, Eq)]
940pub struct OfflineState {
941    /// The unbroken run of failed polls.
942    pub consecutive: u32,
943    /// How long until the next attempt.
944    pub retry_in: Duration,
945    /// How long this loop has been unable to reach GitHub, when it is known.
946    pub offline_for: Option<Duration>,
947}
948
949impl OfflineState {
950    #[must_use]
951    pub const fn new(consecutive: u32, retry_in: Duration) -> Self {
952        Self {
953            consecutive,
954            retry_in,
955            offline_for: None,
956        }
957    }
958
959    #[must_use]
960    pub const fn since(mut self, offline_for: Duration) -> Self {
961        self.offline_for = Some(offline_for);
962        self
963    }
964
965    /// Whether the outage has already outlasted GitHub's queue.
966    ///
967    /// `false` when the duration is unknown: this reports a fact, and "we cannot
968    /// tell" is not the same fact as "not yet".
969    #[must_use]
970    pub fn has_outlasted_the_queue(&self) -> bool {
971        self.offline_for
972            .is_some_and(|elapsed| elapsed >= GITHUB_CANCELS_QUEUED_JOBS_AFTER)
973    }
974}
975
976impl fmt::Display for OfflineState {
977    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
978        write!(
979            f,
980            "GitHub is unreachable; no new runners are being started and running \
981             runners are left alone. Retrying in {}s",
982            self.retry_in.as_secs()
983        )?;
984        if self.has_outlasted_the_queue() {
985            f.write_str(
986                ". This outage has lasted more than 24 hours, and GitHub cancels a queued \
987                 job after 24 hours, so queued work has been lost",
988            )
989        } else {
990            f.write_str(
991                ". GitHub cancels a queued job after 24 hours, so an outage longer than \
992                 that loses queued work",
993            )
994        }
995    }
996}
997
998// ---------------------------------------------------------------------------
999// The launcher port
1000// ---------------------------------------------------------------------------
1001
1002/// What this loop asks `e3` to create.
1003#[derive(Debug, Clone, Copy)]
1004pub struct LaunchRequest<'a> {
1005    pub host: &'a Host,
1006    pub policy: &'a ScalePolicy,
1007    /// Proof that e1 owns the host allocation lock while e3 reserves the
1008    /// runner and prunes what is obsolete.
1009    // Crate-visible so only this allocator can mint the request that reaches
1010    // package pruning. A caller holding an unrelated public AllocationLock can
1011    // no longer assemble a LaunchRequest and present that guard as authority.
1012    pub(crate) allocation_guard: &'a AllocationGuard,
1013}
1014
1015/// Why one runner could not be started.
1016///
1017/// Carries `b1`'s [`FailureReason`] rather than a taxonomy of this module's own:
1018/// the reasons a runner fails to start are `e3`'s to know and `b1`'s to name,
1019/// and a third vocabulary here would be a third answer to a question the
1020/// operator asks once.
1021#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1022#[error("the runner could not be started: {reason}")]
1023pub struct LaunchFailure {
1024    pub reason: FailureReason,
1025}
1026
1027/// A lifecycle conclusion that must return through ordinary demand and
1028/// capacity allocation before another runner may start.
1029#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1030pub struct ReplacementIntent {
1031    pub policy: PolicyId,
1032    pub previous_attempt: AttemptId,
1033    pub operation: &'static str,
1034}
1035
1036impl LaunchFailure {
1037    #[must_use]
1038    pub const fn new(reason: FailureReason) -> Self {
1039        Self { reason }
1040    }
1041}
1042
1043/// Why the persisted host ceiling could not be read. Closed, non-secret reasons
1044/// remain distinguishable in reports and structured logs.
1045#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1046pub enum HostCapacityError {
1047    MissingHost,
1048    JournalUnreadable,
1049}
1050
1051impl HostCapacityError {
1052    #[must_use]
1053    pub const fn reason(self) -> &'static str {
1054        match self {
1055            Self::MissingHost => "host_missing",
1056            Self::JournalUnreadable => "host_journal_unreadable",
1057        }
1058    }
1059}
1060
1061#[derive(Debug)]
1062enum AllocationFailure {
1063    HostCapacity(HostCapacityError),
1064    Attempts(LaunchFailure),
1065}
1066
1067/// The seam between the decision to start a runner and the act of starting one.
1068///
1069/// `e3` implements this; every test in this file fakes it, which is what makes
1070/// the whole allocator path decidable with no process, no filesystem and no
1071/// network.
1072///
1073/// # Why the attempt set comes through the same port as the launch
1074///
1075/// `b1` makes this argument at [`HostAllocator::from_attempts`] and it applies
1076/// one layer up: the host-wide total (D9) and every per-policy count (D7) are
1077/// two questions asked of **one** set, and a design that let the caller supply
1078/// the set separately from the thing that creates its members is a design in
1079/// which the two can disagree. Worse, it makes `&[]` expressible — and an empty
1080/// attempt set is exactly the shape that drops the `- active_owned_runners`
1081/// term, starts a second runner for a job already being served, and reports no
1082/// error while doing it.
1083///
1084/// So the launcher is asked, under the allocation lock, immediately before each
1085/// runtime is created. There is no second supply point and no cached copy.
1086///
1087/// # The two ways an implementer can say "I hold no attempts"
1088///
1089/// The argument above closes the hole for a *caller*. It stayed open one level
1090/// down for the **implementer**, in two shapes that both oversubscribe the
1091/// machine and neither of which reports anything:
1092///
1093/// * **By failing.** `attempts()` used to be infallible, which left `e3` — which
1094///   reads a journal off a disk — a choice between panicking and answering
1095///   `vec![]` on an I/O error. An empty set is indistinguishable from an idle
1096///   host, so a transient read failure reads as "nothing is running" and the
1097///   next pass allocates the whole machine for jobs already being served. It is
1098///   fallible now, and [`Reconciler`] treats a failure the way it treats a lock
1099///   it could not take: start nothing, say so, try again next pass.
1100/// * **By lagging.** [`Self::launch`] returns the attempt it created rather than
1101///   its identifier, so the caller can carry it. See that method for the
1102///   measurement that made this necessary.
1103#[async_trait::async_trait]
1104pub trait RunnerLauncher: fmt::Debug + Send + Sync {
1105    /// Read this host's current ceiling from the journal, including edits made
1106    /// after daemon startup. An unreadable or missing host is an error, never
1107    /// permission to fall back to the startup ceiling.
1108    async fn host_capacity(&self, host: &Host) -> Result<NonZeroU16, HostCapacityError>;
1109
1110    /// Reconcile this policy's existing processes before demand is read and
1111    /// capacity is recomputed. A concluded pre-acceptance attempt thereby
1112    /// becomes an ordinary allocation candidate in this same pass; replacement
1113    /// never bypasses the allocator.
1114    async fn supervise(
1115        &self,
1116        _policy: &ScalePolicy,
1117    ) -> Result<Vec<ReplacementIntent>, LaunchFailure> {
1118        Ok(Vec::new())
1119    }
1120
1121    /// Every attempt this host holds, across every policy, terminal ones
1122    /// included.
1123    ///
1124    /// Terminal attempts are included rather than filtered out because the
1125    /// caller needs both answers from one set:
1126    /// [`AttemptState::counts_against_capacity`] decides the ceiling, and the
1127    /// terminal ones are what [`RunnerLauncher::clean`] is for.
1128    ///
1129    /// # Errors
1130    /// [`LaunchFailure`] when the set could not be read. **Never answer `Ok`
1131    /// with an empty vector to signal a failure** — the caller cannot tell that
1132    /// from an idle host, and the two lead to opposite actions.
1133    async fn attempts(&self) -> Result<Vec<RunnerAttempt>, LaunchFailure>;
1134
1135    /// Create exactly one runtime and start one runner, and return the attempt
1136    /// that now exists.
1137    ///
1138    /// Called once per grant, with the host-wide allocation lock held.
1139    ///
1140    /// # The attempt is returned, not just its identifier
1141    ///
1142    /// The host ceiling is enforced against a host-wide total, and that total is
1143    /// recomputed from [`Self::attempts`] on every hold. If a launch is not yet
1144    /// visible there when the *next* policy is allocated for — a journal write
1145    /// that has not landed, an asynchronous store, a cache — then that policy's
1146    /// grant is computed from a set missing the previous policy's runners, and
1147    /// it is too large.
1148    ///
1149    /// That is measured, not hypothetical. With a launcher whose attempts never
1150    /// became visible, two policies on a host of **three** started **six**
1151    /// runners, with the allocation lock held correctly throughout:
1152    /// `host_capacity=3, started=6, launches=6`. Serialisation was never the
1153    /// problem; the arithmetic under it was reading a stale set.
1154    ///
1155    /// So an implementer *should* make the new attempt visible to
1156    /// [`Self::attempts`] before returning — and the caller does not depend on
1157    /// it. [`Reconciler`] carries what this pass created and merges it, by
1158    /// [`RunnerAttempt::id`], with whatever the launcher reports. A launcher
1159    /// that honours the contract is not double-counted, and one that lags cannot
1160    /// oversubscribe the host.
1161    ///
1162    /// # Every call must return a **fresh** [`RunnerAttempt::id`]
1163    ///
1164    /// This is a requirement, not a convention, because the merge above is what
1165    /// carries the host ceiling and the merge is keyed on the identifier. Two
1166    /// calls that answer with the same id are two runtimes that the host-wide
1167    /// total counts once, and the machine is then allocated past
1168    /// `host_capacity`: probed at `host_capacity = 3` with one slot already
1169    /// busy and a launcher answering with a duplicate id, the pass started
1170    /// **four** runners for five occupied slots.
1171    ///
1172    /// That is a narrower defect than the lagging launcher above — that one
1173    /// needed no bug at all, this one needs a broken id generator — but `e3` is
1174    /// the implementor and cannot honour a requirement nobody states.
1175    /// [`Reconciler::host_attempts`] carries a `debug_assert` that fires on a
1176    /// collision, so a development build finds it at the first duplicate rather
1177    /// than through an oversubscribed host.
1178    ///
1179    /// # Errors
1180    /// [`LaunchFailure`], carrying the [`FailureReason`] `e3` recorded.
1181    ///
1182    /// Called under the allocation lock, so it stops at what must be decided
1183    /// there: the attempt, journalled, holding its slot. The runner itself is
1184    /// [`Self::finish_launch`], outside the lock.
1185    async fn launch(&self, request: LaunchRequest<'_>) -> Result<RunnerAttempt, LaunchFailure>;
1186
1187    /// Bring up a runner [`Self::launch`] reserved, after the host allocation
1188    /// lock was released: its package, its registration and its process, none
1189    /// of which decides a ceiling, and all of which may take minutes.
1190    ///
1191    /// The reservation is what holds the slot, and it is journalled, so another
1192    /// allocator counts it from the moment the lock is let go, and a crash at
1193    /// any point here leaves a journalled attempt that startup recovery
1194    /// concludes. A launcher whose `launch` does everything keeps the default.
1195    ///
1196    /// # Errors
1197    /// [`LaunchFailure`], carrying the [`FailureReason`] recorded.
1198    async fn finish_launch(
1199        &self,
1200        _policy: &ScalePolicy,
1201        attempt: RunnerAttempt,
1202        _waits: ReservationWaits,
1203    ) -> Result<RunnerAttempt, LaunchFailure> {
1204        Ok(attempt)
1205    }
1206
1207    /// Remove a terminal attempt's runtime and mark it `cleaned`.
1208    ///
1209    /// Never called for a non-terminal attempt: capacity is reclaimed when an
1210    /// attempt reaches a terminal state and at no other time.
1211    ///
1212    /// # Errors
1213    /// [`LaunchFailure`], carrying the [`FailureReason`] `e3` recorded.
1214    async fn clean(&self, attempt: AttemptId) -> Result<(), LaunchFailure>;
1215}
1216
1217/// A [`RunnerLauncher`] that refuses every launch with
1218/// [`FailureReason::HostUnfit`] while `unfit` is set, and passes everything
1219/// else straight through.
1220///
1221/// The daemon sets the flag while a required host check fails (`host
1222/// doctor`). The refusal comes before the inner launcher runs, so nothing is
1223/// registered with GitHub, and the reconciler reports it as a
1224/// `runner_start_failed` event with reason `host_unfit` -- visible, rather than
1225/// a host that silently stopped serving. Supervision, the attempt set and
1226/// cleanup are never gated: what already runs is still looked after.
1227#[derive(Debug)]
1228pub struct FitnessGatedLauncher {
1229    inner: Arc<dyn RunnerLauncher>,
1230    unfit: Arc<AtomicBool>,
1231}
1232
1233impl FitnessGatedLauncher {
1234    #[must_use]
1235    pub const fn new(inner: Arc<dyn RunnerLauncher>, unfit: Arc<AtomicBool>) -> Self {
1236        Self { inner, unfit }
1237    }
1238}
1239
1240#[async_trait::async_trait]
1241impl RunnerLauncher for FitnessGatedLauncher {
1242    async fn host_capacity(&self, host: &Host) -> Result<NonZeroU16, HostCapacityError> {
1243        self.inner.host_capacity(host).await
1244    }
1245
1246    async fn supervise(
1247        &self,
1248        policy: &ScalePolicy,
1249    ) -> Result<Vec<ReplacementIntent>, LaunchFailure> {
1250        self.inner.supervise(policy).await
1251    }
1252
1253    async fn attempts(&self) -> Result<Vec<RunnerAttempt>, LaunchFailure> {
1254        self.inner.attempts().await
1255    }
1256
1257    async fn launch(&self, request: LaunchRequest<'_>) -> Result<RunnerAttempt, LaunchFailure> {
1258        if self.unfit.load(Ordering::Acquire) {
1259            return Err(LaunchFailure::new(FailureReason::HostUnfit));
1260        }
1261        self.inner.launch(request).await
1262    }
1263
1264    async fn finish_launch(
1265        &self,
1266        policy: &ScalePolicy,
1267        attempt: RunnerAttempt,
1268        waits: ReservationWaits,
1269    ) -> Result<RunnerAttempt, LaunchFailure> {
1270        self.inner.finish_launch(policy, attempt, waits).await
1271    }
1272
1273    async fn clean(&self, attempt: AttemptId) -> Result<(), LaunchFailure> {
1274        self.inner.clean(attempt).await
1275    }
1276}
1277
1278// ---------------------------------------------------------------------------
1279// The host-wide allocation lock
1280// ---------------------------------------------------------------------------
1281
1282/// The lock is held for as long as this value lives.
1283///
1284/// Opaque on purpose: what is being held differs between the in-process and the
1285/// file-backed implementation, and a caller that could see which one it has
1286/// would eventually branch on it.
1287pub struct AllocationGuard {
1288    _held: Box<dyn std::any::Any + Send + Sync>,
1289    launch_hold: LaunchHold,
1290}
1291
1292impl AllocationGuard {
1293    /// Wrap whatever the implementation holds. Dropping the guard drops it.
1294    #[must_use]
1295    fn new<T: Send + Sync + 'static>(held: T) -> Self {
1296        Self {
1297            _held: Box::new(held),
1298            launch_hold: LaunchHold::default(),
1299        }
1300    }
1301
1302    /// What a launch keeps after the lock is released; see [`LaunchHold`].
1303    fn launch_hold(&self) -> LaunchHold {
1304        self.launch_hold.clone()
1305    }
1306}
1307
1308/// What must stay held while a runner reserved under the allocation lock is
1309/// brought up outside it. Empty, except where a boundary other than the lock
1310/// must not be crossed by a launch in progress: see
1311/// [`WslRecoveryAllocationLock`].
1312#[derive(Clone, Default)]
1313struct LaunchHold {
1314    _held: Option<Arc<dyn std::any::Any + Send + Sync>>,
1315}
1316
1317impl fmt::Debug for AllocationGuard {
1318    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1319        f.write_str("AllocationGuard")
1320    }
1321}
1322
1323/// The host-wide allocation lock could not be taken.
1324#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
1325#[error("the host-wide allocation lock is held by another allocator; no runtime was created")]
1326pub struct AllocationLockBusy;
1327
1328/// Flow 2.4's *"takes the host-wide allocation lock before creating each local
1329/// runtime"*, as a port.
1330///
1331/// # Why a lock is needed at all, given the allocator already exists
1332///
1333/// [`HostAllocator`] enforces D9 across the policies of **one** pass. It cannot
1334/// enforce anything across two passes running at once, and `f3` runs one
1335/// demand-polling loop per target: without serialisation, two loops read the
1336/// same headroom, each finds it sufficient, and the host ends up with the sum of
1337/// two grants it only ever had room for one of. The lock is what makes the
1338/// read-decide-create sequence atomic, and it is taken once per runtime rather
1339/// than once per pass so that a slow package download in one policy does not
1340/// hold the whole host still.
1341#[async_trait::async_trait]
1342pub trait AllocationLock: fmt::Debug + Send + Sync {
1343    /// Take the lock, waiting briefly for it.
1344    ///
1345    /// # Errors
1346    /// [`AllocationLockBusy`] when it could not be taken. A refused grant is
1347    /// always safe: the next pass re-reads the headroom and tries again.
1348    async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy>;
1349}
1350
1351/// The lock every task inside one agent process contends for.
1352///
1353/// This is the implementation that matters in practice, because the
1354/// single-instance lock (`d1`) already guarantees one agent per host: the
1355/// concurrency the allocation lock actually has to serialise is `f3`'s
1356/// per-target loops inside that one process. A `tokio` mutex rather than a
1357/// `std` one because it is held across the `await` that creates the runtime.
1358#[derive(Debug, Default)]
1359pub struct InProcessAllocationLock {
1360    mutex: Arc<tokio::sync::Mutex<()>>,
1361}
1362
1363impl InProcessAllocationLock {
1364    #[must_use]
1365    pub fn new() -> Self {
1366        Self::default()
1367    }
1368}
1369
1370#[async_trait::async_trait]
1371impl AllocationLock for InProcessAllocationLock {
1372    async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
1373        let mutex = Arc::clone(&self.mutex);
1374        let guard = mutex.lock_owned().await;
1375        Ok(AllocationGuard::new(guard))
1376    }
1377}
1378
1379/// `d1`'s file lock, which is host-wide across processes as well as across
1380/// tasks.
1381///
1382/// Defence in depth behind [`InProcessAllocationLock`], for the configuration
1383/// `d1` documents as the one where two agents can genuinely coexist: the
1384/// platform state directory is per-account, so a service-account daemon and an
1385/// interactive `daemon run` resolve different paths and do not contend for the
1386/// single-instance lock. They do contend here if they share a state directory.
1387///
1388/// [`runner_manager_platform::lock::HostLock::acquire`] blocks the calling
1389/// thread and its own documentation names this caller: *"Async callers must wrap
1390/// it in [`tokio::task::spawn_blocking`]"*. That is what this does, and the
1391/// returned `HostLock` lives inside the guard, because dropping it is the
1392/// release.
1393#[derive(Debug, Clone)]
1394pub struct FileAllocationLock {
1395    paths: Arc<runner_manager_platform::paths::AppPaths>,
1396    wait: Duration,
1397}
1398
1399impl FileAllocationLock {
1400    #[must_use]
1401    pub const fn new(paths: Arc<runner_manager_platform::paths::AppPaths>) -> Self {
1402        Self {
1403            paths,
1404            wait: ALLOCATION_LOCK_WAIT,
1405        }
1406    }
1407
1408    #[must_use]
1409    pub const fn with_wait(mut self, wait: Duration) -> Self {
1410        self.wait = wait;
1411        self
1412    }
1413}
1414
1415#[async_trait::async_trait]
1416impl AllocationLock for FileAllocationLock {
1417    async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
1418        use runner_manager_platform::lock::{HostLock, LockKind};
1419
1420        let paths = Arc::clone(&self.paths);
1421        let wait = self.wait;
1422        let held = tokio::task::spawn_blocking(move || {
1423            HostLock::acquire(&paths, LockKind::Allocation, wait)
1424        })
1425        .await;
1426
1427        match held {
1428            Ok(Ok(lock)) => Ok(AllocationGuard::new(lock)),
1429            // A refused lock and a panicked blocking task are the same outcome
1430            // to this caller: no runtime was created and the next pass will
1431            // re-read the headroom. Neither is allowed to look like a grant.
1432            Ok(Err(_)) | Err(_) => Err(AllocationLockBusy),
1433        }
1434    }
1435}
1436
1437/// Adds the Windows/WSL recovery fence to an ordinary allocation lock, and
1438/// says on disk when allocations keep being refused.
1439///
1440/// A Windows watchdog writes its drain request before attempting the same
1441/// atomic directory claim. Therefore either this process owns the directory and
1442/// finishes the launches already in progress, or Windows owns it and no new
1443/// launch can pass. The claim is shared by every launch of this process, from
1444/// its reservation until its runner is up ([`LaunchHold`]), and released with
1445/// the last: a drain request refuses new reservations, so the launches in
1446/// progress run out and Windows gets the directory, as when there was one.
1447/// A malformed configured fence fails closed. A guest claim
1448/// whose owner is provably gone is reclaimed first; see
1449/// [`runner_manager_platform::wsl::fence`].
1450///
1451/// # Refusals that persist are recorded
1452///
1453/// A refusal is always safe for one pass, and a refusal on every pass is a host
1454/// that starts nothing while it looks healthy -- 13 days of it, once. So after
1455/// [`launch_health::BLOCKED_AFTER_DEFERRALS`] consecutive refusals spanning at
1456/// least [`launch_health::BLOCKED_AFTER`], with no launch of this process in
1457/// progress, the lock writes the `state/` record `status`, `service status`,
1458/// `wsl status` and `host doctor` read. The next granted allocation removes it.
1459/// Refusals while this process is itself launching are its own contention and
1460/// count neither way.
1461///
1462/// [`launch_health::BLOCKED_AFTER_DEFERRALS`]: runner_manager_platform::launch_health::BLOCKED_AFTER_DEFERRALS
1463/// [`launch_health::BLOCKED_AFTER`]: runner_manager_platform::launch_health::BLOCKED_AFTER
1464#[derive(Debug)]
1465pub struct WslRecoveryAllocationLock {
1466    paths: Arc<runner_manager_platform::paths::AppPaths>,
1467    inner: Arc<dyn AllocationLock>,
1468    blocked_after_refusals: u32,
1469    blocked_after: Duration,
1470    /// A quiet spell this long between refusals starts a new run.
1471    streak_gap: Duration,
1472    in_flight: Arc<std::sync::atomic::AtomicUsize>,
1473    /// The claim the launches in progress share; taking it is serialised.
1474    claim: tokio::sync::Mutex<std::sync::Weak<LaunchFenceGuard>>,
1475    refusals: Mutex<Refusals>,
1476}
1477
1478/// The refusals since the last grant.
1479#[derive(Debug, Default)]
1480struct Refusals {
1481    /// The current run of refusals: when it began, the latest one, and how
1482    /// many it holds.
1483    streak: Option<Streak>,
1484    recorded: bool,
1485}
1486
1487#[derive(Debug, Clone, Copy)]
1488struct Streak {
1489    since: chrono::DateTime<chrono::Utc>,
1490    latest: chrono::DateTime<chrono::Utc>,
1491    count: u32,
1492}
1493
1494/// Counts a launch of this process as in progress until dropped.
1495struct InFlight(Arc<std::sync::atomic::AtomicUsize>);
1496
1497impl InFlight {
1498    fn enter(count: &Arc<std::sync::atomic::AtomicUsize>) -> Self {
1499        count.fetch_add(1, Ordering::SeqCst);
1500        Self(Arc::clone(count))
1501    }
1502}
1503
1504impl Drop for InFlight {
1505    fn drop(&mut self) {
1506        self.0.fetch_sub(1, Ordering::SeqCst);
1507    }
1508}
1509
1510/// Releases the guest launch claim when the allocation ends, and says so when
1511/// it cannot: this once failed silently while a distribution started nothing
1512/// for 13 days.
1513struct LaunchFenceGuard(Option<runner_manager_platform::wsl::fence::GuestLaunchClaim>);
1514
1515impl Drop for LaunchFenceGuard {
1516    fn drop(&mut self) {
1517        if let Some(claim) = self.0.take()
1518            && let Err(error) = claim.release()
1519        {
1520            tracing::warn!(
1521                %error,
1522                "the WSL launch fence could not be released; the next launch reclaims it"
1523            );
1524        }
1525    }
1526}
1527
1528impl WslRecoveryAllocationLock {
1529    #[must_use]
1530    pub fn new(
1531        paths: Arc<runner_manager_platform::paths::AppPaths>,
1532        inner: Arc<dyn AllocationLock>,
1533    ) -> Self {
1534        use runner_manager_platform::launch_health::{BLOCKED_AFTER, BLOCKED_AFTER_DEFERRALS};
1535        Self {
1536            paths,
1537            inner,
1538            blocked_after_refusals: BLOCKED_AFTER_DEFERRALS,
1539            blocked_after: BLOCKED_AFTER,
1540            streak_gap: BLOCKED_AFTER,
1541            in_flight: Arc::default(),
1542            claim: tokio::sync::Mutex::default(),
1543            refusals: Mutex::default(),
1544        }
1545    }
1546
1547    /// Record blocked launches after `refusals` consecutive refusals spanning
1548    /// at least `after`, instead of the defaults.
1549    #[cfg(test)]
1550    const fn with_blocked_after(mut self, refusals: u32, after: Duration) -> Self {
1551        self.blocked_after_refusals = refusals;
1552        self.blocked_after = after;
1553        self
1554    }
1555
1556    /// Start a new run of refusals after a quiet spell of `gap`.
1557    #[cfg(test)]
1558    const fn with_streak_gap(mut self, gap: Duration) -> Self {
1559        self.streak_gap = gap;
1560        self
1561    }
1562
1563    fn refusals(&self) -> std::sync::MutexGuard<'_, Refusals> {
1564        self.refusals
1565            .lock()
1566            .unwrap_or_else(std::sync::PoisonError::into_inner)
1567    }
1568
1569    fn note_granted(&self) {
1570        let mut refusals = self.refusals();
1571        refusals.streak = None;
1572        if refusals.recorded {
1573            match runner_manager_platform::launch_health::clear_launches_blocked(&self.paths) {
1574                Ok(()) => refusals.recorded = false,
1575                // Kept, so the next grant tries again.
1576                Err(error) => tracing::warn!(%error, "the blocked-launch record cannot be cleared"),
1577            }
1578        }
1579    }
1580
1581    fn note_refused(&self, cause: &runner_manager_platform::launch_health::BlockCause) {
1582        use runner_manager_platform::launch_health::{Viewpoint, record_launches_blocked};
1583        use runner_manager_platform::wsl::fence::elapsed_at_least;
1584
1585        if self.in_flight.load(Ordering::SeqCst) > 0 {
1586            return;
1587        }
1588        let now = chrono::Utc::now();
1589        let mut refusals = self.refusals();
1590        // A refusal long after the previous one starts a new run: two brief
1591        // contentions days apart are not five minutes of nothing but refusals.
1592        let streak = match refusals.streak {
1593            Some(streak) if !elapsed_at_least(streak.latest, now, self.streak_gap) => Streak {
1594                latest: now,
1595                count: streak.count.saturating_add(1),
1596                ..streak
1597            },
1598            _ => Streak {
1599                since: now,
1600                latest: now,
1601                count: 1,
1602            },
1603        };
1604        refusals.streak = Some(streak);
1605        if streak.count < self.blocked_after_refusals
1606            || !elapsed_at_least(streak.since, now, self.blocked_after)
1607        {
1608            return;
1609        }
1610        let blocked = cause.blocked_since(streak.since, Viewpoint::Guest);
1611        if !refusals.recorded {
1612            tracing::warn!(
1613                refusals = streak.count,
1614                "runner launches are blocked {blocked}: {}",
1615                blocked.remedy
1616            );
1617        }
1618        // Rewritten on every refusal, so readers can tell a record nobody
1619        // refreshes -- no demand any more -- from one still being refused.
1620        match record_launches_blocked(&self.paths, &blocked, now) {
1621            Ok(()) => refusals.recorded = true,
1622            Err(error) => tracing::warn!(%error, "the blocked-launch record cannot be written"),
1623        }
1624    }
1625}
1626
1627/// Claim the guest launch fence under `root`, or say what holds it.
1628fn claim_guest_fence(
1629    root: &std::path::Path,
1630) -> Result<Arc<LaunchFenceGuard>, runner_manager_platform::launch_health::BlockCause> {
1631    use runner_manager_platform::launch_health::BlockCause;
1632    use runner_manager_platform::wsl::fence::{
1633        FENCE_DIRECTORY, FenceClaim, GuestClaimAttempt, try_claim_guest_launch,
1634    };
1635
1636    match try_claim_guest_launch(root) {
1637        Ok(GuestClaimAttempt::Claimed { claim, reclaimed }) => {
1638            if let Some(reclaimed) = reclaimed {
1639                tracing::warn!(
1640                    shared_root = %root.display(),
1641                    %reclaimed,
1642                    "reclaimed a WSL launch fence claim whose owner is gone"
1643                );
1644            }
1645            // Guarded at once, so a claim let go on the drain path is released
1646            // -- and logged when it cannot be -- like any other.
1647            Ok(Arc::new(LaunchFenceGuard(Some(claim))))
1648        }
1649        Ok(GuestClaimAttempt::Busy) => {
1650            let directory = root.join(FENCE_DIRECTORY);
1651            Err(match FenceClaim::owner(root) {
1652                Ok(owner) => BlockCause::FenceHeld { directory, owner },
1653                Err(error) => BlockCause::FenceOwnerUnreadable {
1654                    directory,
1655                    detail: error.to_string(),
1656                },
1657            })
1658        }
1659        Err(error) => {
1660            // An owner record nobody can decode stops the reclaim the same way
1661            // on every pass; name it rather than the config.
1662            Err(match FenceClaim::owner(root) {
1663                Err(owner_error) => BlockCause::FenceOwnerUnreadable {
1664                    directory: root.join(FENCE_DIRECTORY),
1665                    detail: owner_error.to_string(),
1666                },
1667                Ok(_) => BlockCause::FenceUnusable {
1668                    detail: error.to_string(),
1669                },
1670            })
1671        }
1672    }
1673}
1674
1675#[async_trait::async_trait]
1676impl AllocationLock for WslRecoveryAllocationLock {
1677    async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
1678        use runner_manager_platform::launch_health::BlockCause;
1679        use runner_manager_platform::wsl::fence::{DrainRequest, GuestRecoveryConfig};
1680
1681        let paths = Arc::clone(&self.paths);
1682        let mut shared = self.claim.lock().await;
1683        let held = shared.upgrade();
1684        let claim = tokio::task::spawn_blocking(move || {
1685            let unusable = |error: &dyn fmt::Display| BlockCause::FenceUnusable {
1686                detail: error.to_string(),
1687            };
1688            let config = match GuestRecoveryConfig::read(&paths) {
1689                Ok(Some(config)) => config,
1690                Ok(None) => return Ok(Arc::new(LaunchFenceGuard(None))),
1691                Err(error) => return Err(unusable(&error)),
1692            };
1693            let root = config.shared_root;
1694            let claim = match held {
1695                // A launch of this process already owns the directory.
1696                Some(held) => {
1697                    if let Some(Err(error)) = held.0.as_ref().map(|claim| claim.renew()) {
1698                        tracing::warn!(%error, "the WSL launch fence's age could not be renewed");
1699                    }
1700                    held
1701                }
1702                None => claim_guest_fence(&root)?,
1703            };
1704            match DrainRequest::read(&root) {
1705                Ok(None) => Ok(claim),
1706                Ok(Some(_)) => Err(BlockCause::DrainRequested { root }),
1707                Err(error) => Err(unusable(&error)),
1708            }
1709        })
1710        .await
1711        .map_err(|_| AllocationLockBusy)?;
1712
1713        let claim = match claim {
1714            Ok(claim) => claim,
1715            Err(cause) => {
1716                drop(shared);
1717                self.note_refused(&cause);
1718                return Err(AllocationLockBusy);
1719            }
1720        };
1721        if claim.0.is_some() {
1722            *shared = Arc::downgrade(&claim);
1723        }
1724        drop(shared);
1725        let Ok(inner) = self.inner.acquire().await else {
1726            self.note_refused(&BlockCause::AllocationLockBusy {
1727                path: self
1728                    .paths
1729                    .state_dir()
1730                    .join(runner_manager_platform::lock::LockKind::Allocation.file_name()),
1731            });
1732            return Err(AllocationLockBusy);
1733        };
1734        self.note_granted();
1735        let in_flight = InFlight::enter(&self.in_flight);
1736        let mut guard = AllocationGuard::new(inner);
1737        guard.launch_hold = LaunchHold {
1738            _held: Some(Arc::new((claim, in_flight))),
1739        };
1740        Ok(guard)
1741    }
1742}
1743
1744// ---------------------------------------------------------------------------
1745// Lifecycle events
1746// ---------------------------------------------------------------------------
1747
1748/// Which terminal thing happened, as a closed vocabulary.
1749///
1750/// The distinction `g2` renders: an idle exit is the accepted surplus case and
1751/// **not** a failure, and showing it as one sends an operator hunting a fault
1752/// that does not exist.
1753#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1754pub enum OutcomeKind {
1755    CompletedJob,
1756    IdleExit,
1757    Failed,
1758    Orphaned,
1759}
1760
1761impl OutcomeKind {
1762    #[must_use]
1763    pub const fn of(outcome: &AttemptOutcome) -> Self {
1764        match outcome {
1765            AttemptOutcome::CompletedJob => Self::CompletedJob,
1766            AttemptOutcome::ExitedIdleWithoutWork => Self::IdleExit,
1767            AttemptOutcome::Failed { .. } => Self::Failed,
1768            AttemptOutcome::Orphaned => Self::Orphaned,
1769        }
1770    }
1771
1772    #[must_use]
1773    pub const fn is_failure(&self) -> bool {
1774        matches!(self, Self::Failed | Self::Orphaned)
1775    }
1776
1777    #[must_use]
1778    pub const fn as_str(&self) -> &'static str {
1779        match self {
1780            Self::CompletedJob => "completed_job",
1781            Self::IdleExit => "exited_idle_without_work",
1782            Self::Failed => "failed",
1783            Self::Orphaned => "orphaned",
1784        }
1785    }
1786}
1787
1788impl fmt::Display for OutcomeKind {
1789    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1790        f.write_str(self.as_str())
1791    }
1792}
1793
1794/// A [`FailureReason`]'s variant name, with no detail.
1795///
1796/// [`FailureReason::Other`] carries a `String` that `e3` fills in, and an event
1797/// is not the place for it: `07-security.md`'s log scan runs over everything
1798/// this loop emits, and free text is the one shape that can carry a credential
1799/// past a field allow-list. The operator-facing detail reaches the journal
1800/// through `b2` and the screen through `g2`; what reaches an *event* is the
1801/// variant.
1802#[must_use]
1803pub const fn failure_reason_kind(reason: &FailureReason) -> &'static str {
1804    match reason {
1805        FailureReason::JitRequestFailed => "jit_request_failed",
1806        FailureReason::JitExpired => "jit_expired",
1807        FailureReason::RunnerPackageUnverified => "runner_package_unverified",
1808        FailureReason::RunnerVersionRejected => "runner_version_rejected",
1809        FailureReason::ProcessStartFailed => "process_start_failed",
1810        FailureReason::ProcessExitedUnexpectedly => "process_exited_unexpectedly",
1811        FailureReason::RegistrationTimedOut => "registration_timed_out",
1812        FailureReason::TerminatedAfterRegistrationTimeout => {
1813            "terminated_after_registration_timeout"
1814        }
1815        FailureReason::IsolationProvider(category) => match category {
1816            IsolationProviderFailure::Unsupported => "isolation_provider_unsupported",
1817            IsolationProviderFailure::NotInstalled => "isolation_provider_not_installed",
1818            IsolationProviderFailure::PermissionDenied => "isolation_provider_permission_denied",
1819            IsolationProviderFailure::ImageUnavailableOrIncompatible => {
1820                "isolation_image_unavailable"
1821            }
1822            IsolationProviderFailure::DiskQuotaUnavailable => "isolation_disk_quota_unavailable",
1823            IsolationProviderFailure::Degraded => "isolation_provider_degraded",
1824            IsolationProviderFailure::RuntimeOperationFailed => {
1825                "isolation_runtime_operation_failed"
1826            }
1827            IsolationProviderFailure::OwnershipMismatch => "isolation_ownership_mismatch",
1828            IsolationProviderFailure::UnsafeRuntimePath => "isolation_unsafe_runtime_path",
1829            IsolationProviderFailure::JitHandoffRejected => "isolation_jit_handoff_rejected",
1830        },
1831        FailureReason::WorkspaceCleanupDeferred => "ephemeral_workspace_could_not_be_removed",
1832        FailureReason::HostUnfit => "host_unfit",
1833        FailureReason::Other(_) => "other",
1834    }
1835}
1836
1837/// Fixed, credential-free reasons a queued job cannot route to one profile.
1838#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
1839pub enum RoutingRefusal {
1840    OverlappingProfiles,
1841    /// A job asks for a label and for its exclusion (`wsl` with `not-wsl`),
1842    /// or for `not-` alone: no runner can take it.
1843    UnsatisfiableExclusion,
1844}
1845
1846impl RoutingRefusal {
1847    #[must_use]
1848    pub const fn as_str(self) -> &'static str {
1849        match self {
1850            Self::OverlappingProfiles => "overlapping_profile_matches",
1851            Self::UnsatisfiableExclusion => "unsatisfiable_exclusion",
1852        }
1853    }
1854}
1855
1856impl fmt::Display for RoutingRefusal {
1857    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1858        f.write_str(match self {
1859            Self::OverlappingProfiles => {
1860                "repair overlapping profile labels or require a unique profile selector"
1861            }
1862            Self::UnsatisfiableExclusion => {
1863                "a job asks for a label and for not-<that label>, or for `not-` alone; fix its \
1864                 runs-on: no runner can take it"
1865            }
1866        })
1867    }
1868}
1869
1870/// What `g2`'s activity view and the local log sink see.
1871///
1872/// **Every field is an identifier, a count, a duration, or a `&'static str`
1873/// drawn from a closed set.** There is no `String` anywhere in this enum, which
1874/// is what makes "no emitted event contains a token, a JIT blob, or a credential
1875/// header" a property of the type rather than a discipline each call site has to
1876/// keep. `tests::no_emitted_event_can_carry_a_credential` renders every variant
1877/// through `d1`'s scrubber and asserts nothing changes, with a positive control
1878/// so the assertion cannot pass vacuously.
1879#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1880pub enum LifecycleEvent {
1881    /// A demand poll answered for one target.
1882    DemandObserved {
1883        policy: PolicyId,
1884        /// Queued jobs this policy's routing labels match. The number clamped.
1885        demand: u32,
1886        /// Queued jobs whose required labels this policy does not carry.
1887        ///
1888        /// Never demand. Reported because the difference between this and
1889        /// `demand` is the whole value of the label filtering, and an operator
1890        /// wondering why a busy repository started no runners is owed it.
1891        not_matched: u32,
1892        /// Queued jobs whose `runs-on` could not be resolved statically.
1893        ///
1894        /// `b1` requires these be "reported as unresolvable rather than silently
1895        /// counted or silently dropped": counting one would start a runner for a
1896        /// job that may not be ours, and dropping it would hide a workflow this
1897        /// host can never serve. A count rather than the reasons themselves
1898        /// because this type is `Copy`, and `c4` logs the reasons where it
1899        /// builds them.
1900        unresolvable: u32,
1901        /// `false` when the count is a floor rather than a total.
1902        complete: bool,
1903    },
1904    /// A queued job cannot be assigned unambiguously to this target's profiles.
1905    RoutingRefused {
1906        policy: PolicyId,
1907        reason: RoutingRefusal,
1908        count: u32,
1909    },
1910    /// A target could not be polled, so its policies start nothing this pass.
1911    TargetUnreadable {
1912        policy: PolicyId,
1913        reason: &'static str,
1914    },
1915    /// One policy's share of the pass.
1916    Allocated {
1917        policy: PolicyId,
1918        demand: u32,
1919        desired: u16,
1920        active_owned: u16,
1921        headroom: u16,
1922        to_start: u16,
1923        limiting: LimitingFactor,
1924    },
1925    /// A monitor-only policy was skipped entirely, before any demand request
1926    /// was issued for it (D19).
1927    MonitorOnlySkipped { policy: PolicyId },
1928    /// One runtime was created and one runner started.
1929    RunnerStarted {
1930        policy: PolicyId,
1931        attempt: AttemptId,
1932    },
1933    /// One runner could not be started.
1934    RunnerStartFailed {
1935        policy: PolicyId,
1936        reason: &'static str,
1937    },
1938    /// The allocation lock was not free, so `count` runners this policy was
1939    /// granted were not created this pass.
1940    AllocationDeferred { policy: PolicyId, count: u16 },
1941    /// The host lacks the memory for one more runner of this policy: free
1942    /// memory less what its running attempts may still grow into is under
1943    /// the estimate plus the margin. Not `started`: the demand stays queued
1944    /// and a later pass tries again. `started`: nothing runs that could free
1945    /// memory, so the runner was started anyway.
1946    MemoryShort {
1947        policy: PolicyId,
1948        figures: MemoryFigures,
1949        started: bool,
1950    },
1951    /// The host's attempt set could not be read at all.
1952    ///
1953    /// Distinct from an empty set on purpose, and the whole reason
1954    /// [`RunnerLauncher::attempts`] is fallible: the two produce the same
1955    /// *number* and demand opposite actions.
1956    AttemptsUnreadable { reason: &'static str },
1957    /// The ceiling is unknown; this does not imply that the attempt set is unreadable.
1958    HostCapacityUnreadable { reason: HostCapacityError },
1959    /// A terminal attempt's runtime was removed.
1960    AttemptCleaned {
1961        policy: PolicyId,
1962        attempt: AttemptId,
1963        outcome: OutcomeKind,
1964    },
1965    /// A terminal attempt's runtime could not be removed. It will be retried on
1966    /// the next pass, and this is what keeps that retry from being silent.
1967    AttemptCleanFailed {
1968        policy: PolicyId,
1969        attempt: AttemptId,
1970        reason: &'static str,
1971    },
1972    /// Scale-down declined to remove a runner that is executing a job.
1973    ScaleDownRefused {
1974        policy: PolicyId,
1975        attempt: AttemptId,
1976    },
1977    /// When the next poll is, and why then.
1978    PollScheduled { retry_in_ms: u64, pace: PollPace },
1979}
1980
1981impl LifecycleEvent {
1982    /// A fixed name, for the `event` field `d1`'s sink allows verbatim.
1983    #[must_use]
1984    pub const fn name(&self) -> &'static str {
1985        match self {
1986            Self::DemandObserved { .. } => "demand_observed",
1987            Self::RoutingRefused { .. } => "routing_refused",
1988            Self::TargetUnreadable { .. } => "target_unreadable",
1989            Self::Allocated { .. } => "allocated",
1990            Self::MonitorOnlySkipped { .. } => "monitor_only_skipped",
1991            Self::RunnerStarted { .. } => "runner_started",
1992            Self::RunnerStartFailed { .. } => "runner_start_failed",
1993            Self::AllocationDeferred { .. } => "allocation_deferred",
1994            Self::MemoryShort { started: false, .. } => "memory_deferred",
1995            Self::MemoryShort { started: true, .. } => "memory_admitted_alone",
1996            Self::AttemptsUnreadable { .. } => "attempts_unreadable",
1997            Self::HostCapacityUnreadable { .. } => "host_capacity_unreadable",
1998            Self::AttemptCleaned { .. } => "attempt_cleaned",
1999            Self::AttemptCleanFailed { .. } => "attempt_clean_failed",
2000            Self::ScaleDownRefused { .. } => "scale_down_refused",
2001            Self::PollScheduled { .. } => "poll_scheduled",
2002        }
2003    }
2004
2005    /// Which policy this event is about.
2006    #[must_use]
2007    pub const fn policy(&self) -> Option<PolicyId> {
2008        match self {
2009            Self::DemandObserved { policy, .. }
2010            | Self::RoutingRefused { policy, .. }
2011            | Self::TargetUnreadable { policy, .. }
2012            | Self::Allocated { policy, .. }
2013            | Self::MonitorOnlySkipped { policy }
2014            | Self::RunnerStarted { policy, .. }
2015            | Self::RunnerStartFailed { policy, .. }
2016            | Self::AllocationDeferred { policy, .. }
2017            | Self::MemoryShort { policy, .. }
2018            | Self::AttemptCleaned { policy, .. }
2019            | Self::AttemptCleanFailed { policy, .. }
2020            | Self::ScaleDownRefused { policy, .. } => Some(*policy),
2021            Self::PollScheduled { .. }
2022            | Self::AttemptsUnreadable { .. }
2023            | Self::HostCapacityUnreadable { .. } => None,
2024        }
2025    }
2026}
2027
2028impl fmt::Display for LifecycleEvent {
2029    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2030        match self {
2031            Self::DemandObserved {
2032                policy,
2033                demand,
2034                not_matched,
2035                unresolvable,
2036                complete,
2037            } => write!(
2038                f,
2039                "policy {policy}: {demand} queued jobs for this host{}{}{}",
2040                if *not_matched == 0 {
2041                    String::new()
2042                } else {
2043                    format!(", {not_matched} for other labels")
2044                },
2045                if *unresolvable == 0 {
2046                    String::new()
2047                } else {
2048                    format!(", {unresolvable} with an unresolvable `runs-on`")
2049                },
2050                if *complete {
2051                    ""
2052                } else {
2053                    " (a floor, not a total)"
2054                }
2055            ),
2056            Self::TargetUnreadable { policy, reason } => {
2057                write!(f, "policy {policy}: target unreadable ({reason})")
2058            }
2059            Self::RoutingRefused {
2060                policy,
2061                reason,
2062                count,
2063            } => write!(f, "policy {policy}: {count} queued jobs blocked: {reason}"),
2064            Self::Allocated {
2065                policy,
2066                demand,
2067                desired,
2068                active_owned,
2069                headroom,
2070                to_start,
2071                limiting,
2072            } => write!(
2073                f,
2074                "policy {policy}: demand {demand}, desired {desired}, {active_owned} in \
2075                 flight, {headroom} free on this host, starting {to_start} ({limiting})"
2076            ),
2077            Self::MonitorOnlySkipped { policy } => {
2078                write!(f, "policy {policy}: monitor-only, skipped")
2079            }
2080            Self::RunnerStarted { policy, attempt } => {
2081                write!(f, "policy {policy}: started attempt {attempt}")
2082            }
2083            Self::RunnerStartFailed { policy, reason } => {
2084                write!(f, "policy {policy}: could not start a runner ({reason})")
2085            }
2086            Self::AllocationDeferred { policy, count } => write!(
2087                f,
2088                "policy {policy}: the allocation lock was held; {count} granted runners \
2089                 were not created"
2090            ),
2091            Self::MemoryShort {
2092                policy,
2093                figures,
2094                started: false,
2095            } => write!(f, "policy {policy}: waiting for memory: {figures}"),
2096            Self::MemoryShort {
2097                policy,
2098                figures,
2099                started: true,
2100            } => write!(
2101                f,
2102                "policy {policy}: started although the host lacks the memory, because \
2103                 nothing else runs here: {figures}"
2104            ),
2105            Self::AttemptsUnreadable { reason } => write!(
2106                f,
2107                "the host's attempt set could not be read ({reason}); nothing was started, \
2108                 and this is not the same as the host being idle"
2109            ),
2110            Self::HostCapacityUnreadable { reason } => write!(
2111                f,
2112                "the host capacity could not be read ({}); new launches wait for readable host settings",
2113                reason.reason()
2114            ),
2115            Self::AttemptCleaned {
2116                policy,
2117                attempt,
2118                outcome,
2119            } => write!(f, "policy {policy}: cleaned attempt {attempt} ({outcome})"),
2120            Self::AttemptCleanFailed {
2121                policy,
2122                attempt,
2123                reason,
2124            } => write!(
2125                f,
2126                "policy {policy}: attempt {attempt} could not be cleaned ({reason}); it \
2127                 will be retried"
2128            ),
2129            Self::ScaleDownRefused { policy, attempt } => write!(
2130                f,
2131                "policy {policy}: attempt {attempt} is executing a job and was not removed"
2132            ),
2133            Self::PollScheduled { retry_in_ms, pace } => {
2134                write!(f, "next poll in {retry_in_ms}ms ({pace})")
2135            }
2136        }
2137    }
2138}
2139
2140/// Where lifecycle events go.
2141pub trait EventSink: fmt::Debug + Send + Sync {
2142    fn emit(&self, event: LifecycleEvent);
2143}
2144
2145/// Discards everything. For callers that only want the report.
2146#[derive(Debug, Clone, Copy, Default)]
2147pub struct NoEvents;
2148
2149impl EventSink for NoEvents {
2150    fn emit(&self, _event: LifecycleEvent) {}
2151}
2152
2153/// The local log sink, through `d1`'s redacting layer.
2154///
2155/// Every field name below is on
2156/// [`runner_manager_platform::logging::ALLOWED_FIELDS`]; anything else would be
2157/// replaced with `[redacted]` and the line would lose its meaning rather than
2158/// its safety. `tests::every_field_name_this_sink_emits_is_one_d1_allows` keeps
2159/// that true.
2160#[derive(Debug, Clone, Copy, Default)]
2161pub struct TracingEvents;
2162
2163impl EventSink for TracingEvents {
2164    fn emit(&self, event: LifecycleEvent) {
2165        let name = event.name();
2166        match event {
2167            LifecycleEvent::DemandObserved {
2168                policy,
2169                demand,
2170                not_matched,
2171                unresolvable,
2172                complete,
2173            } => {
2174                // An empty reading is the idle steady state, and the idle
2175                // interval repeats it every few seconds per target: at `info`
2176                // it would be most of the log. Anything worth reading is still
2177                // `info`.
2178                if demand == 0 && not_matched == 0 && unresolvable == 0 && complete {
2179                    tracing::debug!(
2180                        event = name,
2181                        policy_id = %policy,
2182                        demand,
2183                        not_matched,
2184                        unresolvable,
2185                        count = u64::from(complete),
2186                    );
2187                } else {
2188                    tracing::info!(
2189                        event = name,
2190                        policy_id = %policy,
2191                        demand,
2192                        not_matched,
2193                        unresolvable,
2194                        count = u64::from(complete),
2195                    );
2196                }
2197                // There is deliberately no `warn!` here for the "demand is zero
2198                // but jobs were not matched" shape, though it is the one this
2199                // change introduced: before demand was filtered, a repository
2200                // with work in it always produced some, and now a policy whose
2201                // labels do not cover its jobs produces none.
2202                //
2203                // The reason is that the shape is indistinguishable from a
2204                // healthy one. A repository served by a Windows host and a macOS
2205                // host has the other host's jobs queued in it constantly, so
2206                // each agent would warn on every poll about work that is being
2207                // served correctly by the other machine. Telling the two apart
2208                // needs to know whether this policy has *ever* matched anything,
2209                // which is state across polls that this loop does not keep.
2210                //
2211                // What an operator gets instead is the `not_matched` count, on
2212                // this event and in its `Display`, which `g2` renders. "0 queued
2213                // jobs for this host, 5 for other labels" is the diagnosis; a
2214                // warning that fired on every healthy minute would be the kind
2215                // nobody reads.
2216            }
2217            LifecycleEvent::TargetUnreadable { policy, reason } => {
2218                tracing::warn!(event = name, policy_id = %policy, reason);
2219            }
2220            LifecycleEvent::RoutingRefused {
2221                policy,
2222                reason,
2223                count,
2224            } => tracing::warn!(
2225                event = name,
2226                policy_id = %policy,
2227                reason = reason.as_str(),
2228                count,
2229                "{reason}"
2230            ),
2231            LifecycleEvent::Allocated {
2232                policy,
2233                demand,
2234                desired,
2235                active_owned,
2236                headroom,
2237                to_start,
2238                limiting,
2239            } if demand == 0 && to_start == 0 && active_owned == 0 => tracing::debug!(
2240                // Nothing wanted, nothing held, nothing started: the idle
2241                // steady state, see `DemandObserved` above.
2242                event = name,
2243                policy_id = %policy,
2244                demand,
2245                desired,
2246                capacity = active_owned,
2247                headroom,
2248                count = to_start,
2249                reason = %limiting,
2250            ),
2251            LifecycleEvent::Allocated {
2252                policy,
2253                demand,
2254                desired,
2255                active_owned,
2256                headroom,
2257                to_start,
2258                limiting,
2259            } => tracing::info!(
2260                event = name,
2261                policy_id = %policy,
2262                demand,
2263                desired,
2264                capacity = active_owned,
2265                headroom,
2266                count = to_start,
2267                reason = %limiting,
2268            ),
2269            LifecycleEvent::MonitorOnlySkipped { policy } => {
2270                tracing::debug!(event = name, policy_id = %policy, mode = "monitor_only");
2271            }
2272            LifecycleEvent::RunnerStarted { policy, attempt } => {
2273                tracing::info!(event = name, policy_id = %policy, attempt_id = %attempt);
2274            }
2275            LifecycleEvent::RunnerStartFailed { policy, reason } => {
2276                tracing::warn!(event = name, policy_id = %policy, reason);
2277            }
2278            LifecycleEvent::AllocationDeferred { policy, count } => {
2279                // Contention is normally brief, but a configured WSL recovery
2280                // fence whose shared root is unwritable reaches the same
2281                // fail-closed result forever. Demand was already observed and
2282                // capacity was already granted, so hiding this at DEBUG makes
2283                // a host claim healthy while it starts nothing.
2284                tracing::warn!(
2285                    event = name,
2286                    policy_id = %policy,
2287                    reason = "allocation_lock_unavailable",
2288                    count
2289                );
2290            }
2291            LifecycleEvent::MemoryShort {
2292                policy,
2293                figures,
2294                started,
2295            } => {
2296                let reason = if started {
2297                    "larger_than_free_memory_nothing_else_running"
2298                } else {
2299                    "insufficient_memory"
2300                };
2301                tracing::warn!(
2302                    event = name,
2303                    policy_id = %policy,
2304                    reason,
2305                    free_bytes = figures.free,
2306                    reserved_bytes = figures.reserved,
2307                    estimate_bytes = figures.estimate.bytes,
2308                    estimate_source = figures.estimate.source.as_str(),
2309                    margin_bytes = figures.margin,
2310                );
2311            }
2312            LifecycleEvent::AttemptsUnreadable { reason } => {
2313                tracing::warn!(event = name, reason);
2314            }
2315            LifecycleEvent::HostCapacityUnreadable { reason } => {
2316                tracing::warn!(event = name, reason = reason.reason());
2317            }
2318            LifecycleEvent::AttemptCleaned {
2319                policy,
2320                attempt,
2321                outcome,
2322            } => tracing::info!(
2323                event = name,
2324                policy_id = %policy,
2325                attempt_id = %attempt,
2326                outcome = outcome.as_str(),
2327            ),
2328            LifecycleEvent::AttemptCleanFailed {
2329                policy,
2330                attempt,
2331                reason,
2332            } => tracing::warn!(
2333                event = name,
2334                policy_id = %policy,
2335                attempt_id = %attempt,
2336                reason,
2337            ),
2338            LifecycleEvent::ScaleDownRefused { policy, attempt } => tracing::info!(
2339                event = name,
2340                policy_id = %policy,
2341                attempt_id = %attempt,
2342                attempt_state = "busy",
2343            ),
2344            LifecycleEvent::PollScheduled { retry_in_ms, pace } => {
2345                if pace == PollPace::Idle {
2346                    tracing::debug!(event = name, retry_in_ms, state = pace.as_str());
2347                } else {
2348                    tracing::info!(event = name, retry_in_ms, state = pace.as_str());
2349                }
2350            }
2351        }
2352    }
2353}
2354
2355/// Keeps every event, in order.
2356///
2357/// `g2`'s activity view is a reader of this, and so is every test below.
2358#[derive(Debug, Default)]
2359pub struct EventLog {
2360    events: Mutex<Vec<LifecycleEvent>>,
2361}
2362
2363impl EventLog {
2364    #[must_use]
2365    pub fn new() -> Self {
2366        Self::default()
2367    }
2368
2369    #[must_use]
2370    pub fn events(&self) -> Vec<LifecycleEvent> {
2371        self.events.lock().map(|e| e.clone()).unwrap_or_default()
2372    }
2373
2374    /// How many events of one name were emitted.
2375    #[must_use]
2376    pub fn count_of(&self, name: &str) -> usize {
2377        self.events()
2378            .iter()
2379            .filter(|event| event.name() == name)
2380            .count()
2381    }
2382}
2383
2384impl EventSink for EventLog {
2385    fn emit(&self, event: LifecycleEvent) {
2386        if let Ok(mut events) = self.events.lock() {
2387            events.push(event);
2388        }
2389    }
2390}
2391
2392/// Both sinks at once: the log sink for the operator's file, the buffer for
2393/// `g2`'s screen.
2394#[derive(Debug)]
2395pub struct TeeEvents(pub Arc<dyn EventSink>, pub Arc<dyn EventSink>);
2396
2397impl EventSink for TeeEvents {
2398    fn emit(&self, event: LifecycleEvent) {
2399        self.0.emit(event);
2400        self.1.emit(event);
2401    }
2402}
2403
2404// ---------------------------------------------------------------------------
2405// The reconciler
2406// ---------------------------------------------------------------------------
2407
2408/// Where a policy's demand comes from when the optional coordinator places
2409/// its runners (coordinator stage 3).
2410///
2411/// A profile carrying a shared pool label (`rm-pool-linux`, ...) on a target
2412/// the coordinator covers starts runners only for the launches the
2413/// coordinator placed on this host and the host accepted — never from its own
2414/// reading of the queue, which every host in the pool sees the same way. This
2415/// is a *count*, not a job: a runner still takes whatever matching job GitHub
2416/// hands it, nothing here reserves one, and the number still goes through
2417/// [`HostAllocator`] and every ceiling, exactly as a polled count does.
2418pub trait DemandDirector: fmt::Debug + Send + Sync {
2419    /// `Some(n)`: `policy`'s demand this pass is `n`, not its reading.
2420    /// `None`: its own reading, as without a coordinator.
2421    fn directed_demand(&self, policy: &ScalePolicy) -> Option<u32>;
2422
2423    /// What the jobs of `policy`'s launches still without a runner exclude
2424    /// (`wsl` for `not-wsl`): their runners register with those exclusions.
2425    fn directed_exclusions(&self, _policy: &ScalePolicy) -> BTreeSet<Label> {
2426        BTreeSet::new()
2427    }
2428
2429    /// A runner was started for `policy` (as soon as it exists, whether or
2430    /// not its demand was directed).
2431    fn launched(&self, policy: &ScalePolicy, attempt: AttemptId);
2432
2433    /// No runner could be started for `policy`, for a real reason: not a
2434    /// runner still being brought up. `attempt` is the one reported through
2435    /// [`Self::launched`] whose bring-up failed, if it got that far: what it was
2436    /// reported for is waiting again, to be retried rather than placed anew.
2437    fn start_failed(&self, _policy: &ScalePolicy, _attempt: Option<AttemptId>) {}
2438
2439    /// Where `policy`'s oldest launch without a runner stands among this host's
2440    /// launches: lower goes first. `None` when it has none.
2441    fn next_waiting(&self, _policy: &ScalePolicy) -> Option<u64> {
2442        None
2443    }
2444
2445    /// How many launches of other targets of this host are older than
2446    /// `policy`'s oldest without a runner and may yet reserve: `policy`'s
2447    /// launch lets them go first.
2448    fn older_waiting(&self, _policy: &ScalePolicy) -> usize {
2449        0
2450    }
2451
2452    /// Those older launches did not reserve in [`OLDER_LAUNCH_TURN`], so nothing
2453    /// waits for them any more, unless they start waiting afresh.
2454    fn pass_over_older(&self, _policy: &ScalePolicy) {}
2455}
2456
2457/// How long a launch waits for older launches of other targets while none of
2458/// them reserves. Every target's loop reserves as soon as it is told of a launch
2459/// (see [`Reconciler::serve_launches`]), so this is not a turn anyone is expected
2460/// to use up: it is for a loop that cannot reserve at all, a target added a moment
2461/// ago that has no loop yet, or a host-wide lock refused. It starts over whenever
2462/// one of them reserves, and costs one launch that one wait, not one per launch.
2463const OLDER_LAUNCH_TURN: Duration = Duration::from_secs(2);
2464const OLDER_LAUNCH_POLL: Duration = Duration::from_millis(10);
2465
2466/// How soon an accepted launch that did not start is tried again.
2467const LAUNCH_RETRY: Duration = Duration::from_secs(30);
2468
2469/// Where a reservation's wait went, for its launch's timings.
2470#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
2471pub struct ReservationWaits {
2472    /// Letting older launches of this host reserve first.
2473    pub order: Duration,
2474    /// For the allocation lock, and from the reservation to its bring-up.
2475    pub lock: Duration,
2476}
2477
2478/// What one round of serving launches has reserved so far.
2479#[derive(Default)]
2480struct ReservationRound {
2481    /// Per policy, how many it reserved and the most launches seen open: a lease
2482    /// closing during the round must not cut short the launches after it.
2483    reserved: BTreeMap<PolicyId, (u32, u32)>,
2484    exhausted: BTreeSet<PolicyId>,
2485}
2486
2487/// One step of a round: what it reserved, the round, and the policies it read.
2488type Reserving<'a> = std::pin::Pin<
2489    Box<
2490        dyn std::future::Future<Output = (Option<Reserved>, ReservationRound, Vec<ScalePolicy>)>
2491            + Send
2492            + 'a,
2493    >,
2494>;
2495
2496/// A runner reserved under the allocation lock, to bring up outside it.
2497struct Reserved {
2498    policy: ScalePolicy,
2499    attempt: RunnerAttempt,
2500    waits: ReservationWaits,
2501    reserved_at: std::time::Instant,
2502    /// Let go when this runner is up or has failed.
2503    _hold: LaunchHold,
2504}
2505
2506/// Whether the host has the memory for one more runner: asked under the
2507/// allocation lock before every start, after every ceiling granted it, so a
2508/// directed launch and a host's own demand meet the same check. See
2509/// [`runner_manager_domain::memory`].
2510pub trait MemoryGate: fmt::Debug + Send + Sync {
2511    /// Whether one more runner of `policy` may start, given every attempt on
2512    /// the host (those this pass reserved included).
2513    fn admit(&self, policy: &ScalePolicy, attempts: &[RunnerAttempt]) -> MemoryVerdict;
2514
2515    /// `policy` was granted a runner and memory did not stop it: a waiting
2516    /// state recorded for it is over.
2517    fn admitted(&self, _policy: &ScalePolicy) {}
2518}
2519
2520/// No memory admission: every start the ceilings grant goes ahead.
2521#[derive(Debug, Default, Clone, Copy)]
2522pub struct NoMemoryGate;
2523
2524impl MemoryGate for NoMemoryGate {
2525    fn admit(&self, _policy: &ScalePolicy, _attempts: &[RunnerAttempt]) -> MemoryVerdict {
2526        MemoryVerdict::Unchecked
2527    }
2528}
2529
2530/// Every policy's demand is its own reading: no coordinator places runners.
2531#[derive(Debug, Default, Clone, Copy)]
2532pub struct OwnDemand;
2533
2534impl DemandDirector for OwnDemand {
2535    fn directed_demand(&self, _policy: &ScalePolicy) -> Option<u32> {
2536        None
2537    }
2538
2539    fn launched(&self, _policy: &ScalePolicy, _attempt: AttemptId) {}
2540}
2541
2542/// Everything one reconciler needs, written down at the call site.
2543///
2544/// A struct rather than seven positional arguments, for the reason `b1` gives at
2545/// `PersistedAttempt`: several of these are `Arc<dyn …>` and transposing two of
2546/// them type-checks. Construct it with a struct literal so every port is named.
2547#[derive(Clone)]
2548pub struct ReconcilerPorts {
2549    pub demand: Arc<dyn DemandSource>,
2550    pub launcher: Arc<dyn RunnerLauncher>,
2551    pub lock: Arc<dyn AllocationLock>,
2552    pub directory: Arc<dyn RepositoryDirectory>,
2553    pub clock: Arc<dyn Clock>,
2554    pub jitter: Arc<dyn Jitter>,
2555    pub events: Arc<dyn EventSink>,
2556}
2557
2558impl fmt::Debug for ReconcilerPorts {
2559    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2560        f.debug_struct("ReconcilerPorts").finish_non_exhaustive()
2561    }
2562}
2563
2564/// What one reconciliation pass did.
2565///
2566/// `started` and the allocations are reported separately on purpose: an
2567/// allocation is what the pass *decided* under the lock, and `started` is what
2568/// actually came up. They differ when a launch fails or when the lock was held,
2569/// and collapsing them would hide both.
2570#[derive(Debug, Clone, Default)]
2571pub struct ReconcileReport {
2572    /// One entry per policy that got as far as being allocated for.
2573    pub allocations: Vec<Allocation>,
2574    /// Policies skipped because they are monitor-only (D19).
2575    pub monitor_only: Vec<PolicyId>,
2576    /// Policies whose target could not be polled this pass.
2577    pub unreadable: Vec<PolicyId>,
2578    /// Policies whose target GitHub actually answered for this pass.
2579    ///
2580    /// The counterpart to [`Self::unreadable`], and the only honest evidence
2581    /// that this host reached GitHub at all. [`Self::allocations`] is not: a
2582    /// policy this host does not own is allocated for with no demand and
2583    /// without any target being polled, so a pass where every poll failed can
2584    /// still end with allocations in it.
2585    pub targets_read: u16,
2586    /// Runners actually started.
2587    pub started: u16,
2588    /// Pre-acceptance attempts routed back through this pass's ordinary
2589    /// demand/capacity decision.
2590    pub replacement_intents: u16,
2591    /// Terminal attempts whose runtime was removed.
2592    pub cleaned: u16,
2593    /// Of those, the surplus case: registered, got no job, exited on its idle
2594    /// timeout. **Not** a failure.
2595    pub idle_exits: u16,
2596    /// Of those, the ones an operator should look at.
2597    pub failures: u16,
2598    /// Runners this pass was granted but did not start because the allocation
2599    /// lock was held.
2600    ///
2601    /// **Grants, not policies.** It used to be incremented once per
2602    /// `start_runners` call that met a held lock, so a policy that launched two
2603    /// of five and then lost the lock reported `1` while three runners went
2604    /// unstarted -- a number that agreed with neither its own name nor its
2605    /// documentation.
2606    pub deferred: u16,
2607    /// Runners this pass was granted but did not start because the host
2608    /// lacked the memory for them. Their demand stays queued.
2609    pub memory_deferred: u16,
2610    /// Times the host's attempt set could not be read this pass.
2611    ///
2612    /// Non-zero means the pass decided less than it looks like it decided: a
2613    /// policy whose attempt set was unreadable started nothing and is *not* in
2614    /// [`Self::allocations`], because there was no set to compute an allocation
2615    /// from. It is not the same as the host being idle, which is the whole
2616    /// reason [`RunnerLauncher::attempts`] is fallible.
2617    ///
2618    /// **A count, where [`Self::unreadable`] is a `Vec<PolicyId>`, and that
2619    /// asymmetry is deliberate.** An unreadable *target* is a fact about one
2620    /// policy's GitHub target; an unreadable *attempt set* is a fact about this
2621    /// host's journal, which no policy owns — two of the three paths that reach
2622    /// it (`clean_terminal_attempts` and `scale_down`) have no policy in hand at
2623    /// all. Naming policies here would mean either inventing an owner for a
2624    /// host-wide failure or reporting a partial list, and both read as more
2625    /// precision than there is. The pass is distinguishable from an idle one,
2626    /// which is what the field exists for; the per-policy attribution is not
2627    /// available, and is recorded as missing rather than faked.
2628    pub attempts_unreadable: u16,
2629    /// Allocation checks blocked by a missing or unreadable host ceiling.
2630    pub host_capacity_unreadable: u16,
2631    /// Terminal attempts whose runtime could not be removed. Retried next pass.
2632    pub clean_failures: u16,
2633    /// The most severe failure across the targets polled, when there was one.
2634    pub failure: Option<RefreshState>,
2635    /// What to display while GitHub is unreachable, including how long the
2636    /// outage has run and therefore whether queued work has already been lost.
2637    pub offline: Option<OfflineState>,
2638    /// When to poll next, and why then.
2639    pub next_poll: NextPoll,
2640    /// Demand requests this pass projected against the shared hourly ceiling.
2641    pub demand_requests: u32,
2642}
2643
2644impl ReconcileReport {
2645    /// Whether this pass actually reached GitHub, which is the only thing that
2646    /// entitles it to write a `last GitHub contact`.
2647    ///
2648    /// # Positive evidence, because the absence of a failure is not evidence
2649    ///
2650    /// The record used to be written whenever [`Self::failure`] was `None`, on
2651    /// the belief that an unauthorized target lands in [`Self::unreadable`]
2652    /// rather than in `failure`. **That belief is wrong.** `unreadable` is
2653    /// pushed only from the `PollOutcome::Failed` arm, `failure` is the maximum
2654    /// over every `Failed` reading, and `RefreshState::Unauthorized` scores 2 —
2655    /// so a non-empty `unreadable` always implies `failure.is_some()`, and
2656    /// guarding on both would have changed nothing at all.
2657    ///
2658    /// The path that really writes a contact record without touching GitHub is
2659    /// a pass that polls **nothing**: every policy draining, owned by another
2660    /// host, or monitor-only. `pollable` is then empty, no reading exists, no
2661    /// failure is computed, and the old guard passed. That is how
2662    /// `service status` can answer `healthy` on a host doing nothing at all.
2663    ///
2664    /// So this asks for evidence rather than for the absence of a complaint. A
2665    /// pass with nothing to ask reaches nobody and records nothing, which is
2666    /// what `never` in `service status` is for.
2667    ///
2668    /// Conservative on purpose: `repositories.scope_for` is a real request that
2669    /// can succeed before a demand poll fails, and it is not counted. Contact
2670    /// that cannot be proven is not claimed.
2671    #[must_use]
2672    pub const fn reached_github(&self) -> bool {
2673        self.targets_read > 0
2674    }
2675}
2676
2677impl Default for NextPoll {
2678    fn default() -> Self {
2679        Self {
2680            delay: PollSchedule::floor(),
2681            pace: PollPace::Nominal,
2682        }
2683    }
2684}
2685
2686impl ReconcileReport {
2687    /// Whether GitHub was unreachable this pass.
2688    #[must_use]
2689    pub fn is_offline(&self) -> bool {
2690        matches!(self.failure, Some(RefreshState::Offline))
2691    }
2692
2693    /// The offline state to display, when this pass was one.
2694    #[must_use]
2695    pub const fn offline_state(&self) -> Option<&OfflineState> {
2696        self.offline.as_ref()
2697    }
2698
2699    /// Attempts this pass created. The idle-host assertion reads this.
2700    #[must_use]
2701    pub const fn starts_nothing(&self) -> bool {
2702        self.started == 0
2703    }
2704}
2705
2706/// What one scale-down request did.
2707#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
2708pub struct ScaleDownReport {
2709    /// Terminal attempts whose runtime was removed.
2710    pub removed: u16,
2711    /// Attempts executing a job. **Removed nothing, left `busy`.**
2712    pub refused_busy: u16,
2713    /// Terminal attempts whose runtime could not be removed.
2714    pub clean_failures: u16,
2715    /// Live attempts that are not yet busy. Also removed nothing: capacity is
2716    /// reclaimed only when an attempt reaches a terminal state.
2717    pub retained: u16,
2718    /// The host's attempt set could not be read, so **every other field here is
2719    /// meaningless** rather than zero.
2720    ///
2721    /// This is the same distinction [`ReconcileReport::attempts_unreadable`]
2722    /// draws, and it is here for the same reason: a default
2723    /// [`ScaleDownReport`] and a scale-down that could not see the machine are
2724    /// both all-zeros, and they mean opposite things — "there was nothing to
2725    /// reclaim" against "we do not know what there was". Check
2726    /// [`Self::is_conclusive`] before reading a zero as an answer.
2727    pub attempts_unreadable: bool,
2728}
2729
2730impl ScaleDownReport {
2731    /// Whether the counts here describe the machine at all.
2732    ///
2733    /// `false` means the attempt set could not be read, so every zero is
2734    /// "unknown" rather than "none".
2735    #[must_use]
2736    pub const fn is_conclusive(&self) -> bool {
2737        !self.attempts_unreadable
2738    }
2739}
2740
2741/// How long a failed cleanup of one attempt waits before it is tried again,
2742/// doubling per consecutive failure up to [`CLEAN_RETRY_MAXIMUM`].
2743///
2744/// A runtime that cannot be removed used to be retried on every pass, about
2745/// every six seconds, and each failure logs a warning: one stuck Windows
2746/// workspace wrote some 15,000 of them a day. The retry is still real; it is
2747/// just no longer a log flood.
2748const CLEAN_RETRY_INITIAL: Duration = Duration::from_secs(30);
2749
2750/// The longest a failing cleanup waits between tries.
2751const CLEAN_RETRY_MAXIMUM: Duration = Duration::from_secs(30 * 60);
2752
2753/// One attempt's consecutive cleanup failures, and when it may be tried again.
2754#[derive(Debug, Clone, Copy)]
2755struct CleanRetry {
2756    failures: u32,
2757    not_before: Timestamp,
2758}
2759
2760/// Per-attempt cleanup backoff. One each in the [`Reconciler`]'s sweep of
2761/// concluded attempts and in the lifecycle launcher's own supervision pass,
2762/// the two places a failed cleanup is retried.
2763#[derive(Debug, Default)]
2764pub(crate) struct CleanBackoff {
2765    retries: BTreeMap<AttemptId, CleanRetry>,
2766}
2767
2768impl CleanBackoff {
2769    /// The doubling-with-a-ceiling schedule; the attempt bound is unused.
2770    const SCHEDULE: crate::lifecycle::RetryPolicy =
2771        crate::lifecycle::RetryPolicy::bounded(u32::MAX, CLEAN_RETRY_INITIAL, CLEAN_RETRY_MAXIMUM);
2772
2773    /// Whether `attempt`'s cleanup should be tried at `now`.
2774    pub(crate) fn is_due(&self, attempt: AttemptId, now: Timestamp) -> bool {
2775        self.retries
2776            .get(&attempt)
2777            .is_none_or(|retry| now >= retry.not_before)
2778    }
2779
2780    /// Records a failed cleanup and schedules the next try.
2781    pub(crate) fn failed(&mut self, attempt: AttemptId, now: Timestamp) {
2782        let failures = self
2783            .retries
2784            .get(&attempt)
2785            .map_or(1, |retry| retry.failures.saturating_add(1));
2786        let delay = Self::SCHEDULE.delay(failures);
2787        self.retries.insert(
2788            attempt,
2789            CleanRetry {
2790                failures,
2791                // At most `CLEAN_RETRY_MAXIMUM`, so always representable.
2792                not_before: now + chrono::Duration::from_std(delay).unwrap_or_default(),
2793            },
2794        );
2795    }
2796
2797    /// Forgets `attempt`: it was cleaned.
2798    pub(crate) fn succeeded(&mut self, attempt: AttemptId) {
2799        self.retries.remove(&attempt);
2800    }
2801
2802    /// Forgets every attempt not in `present`, so the map cannot outgrow the
2803    /// journal.
2804    fn retain(&mut self, present: &BTreeSet<AttemptId>) {
2805        self.retries.retain(|attempt, _| present.contains(attempt));
2806    }
2807}
2808
2809/// The reconciliation loop.
2810///
2811/// One per target, as `f3` runs them; they share a [`RunnerLauncher`] and an
2812/// [`AllocationLock`], which is what keeps the host ceiling true across all of
2813/// them.
2814#[derive(Debug)]
2815pub struct Reconciler {
2816    host: Host,
2817    demand: Arc<dyn DemandSource>,
2818    launcher: Arc<dyn RunnerLauncher>,
2819    lock: Arc<dyn AllocationLock>,
2820    repositories: RepositoryCache,
2821    clock: Arc<dyn Clock>,
2822    jitter: Arc<dyn Jitter>,
2823    events: Arc<dyn EventSink>,
2824    schedule: PollSchedule,
2825    clean_backoff: CleanBackoff,
2826    director: Arc<dyn DemandDirector>,
2827    /// What serves this target's launches beside its passes, when something
2828    /// does: see [`Self::with_launch_side`].
2829    launch_side: Option<Arc<tokio::sync::Notify>>,
2830    memory: Arc<dyn MemoryGate>,
2831    /// [`HostTraits::labels`]: every profile of this host carries them, in
2832    /// matching and in what its runners register with. Never stored.
2833    host_labels: Vec<Label>,
2834    /// Every exclusion a job of each policy named while this process runs.
2835    /// See [`Self::start_runners`].
2836    seen_exclusions: Mutex<BTreeMap<PolicyId, BTreeSet<Label>>>,
2837}
2838
2839impl Reconciler {
2840    /// Build a reconciler polling at the host's configured interval.
2841    #[must_use]
2842    pub fn new(host: Host, ports: ReconcilerPorts) -> Self {
2843        let interval = host.refresh_interval;
2844        let repositories = RepositoryCache::new(
2845            Arc::clone(&ports.directory),
2846            Arc::clone(&ports.clock),
2847            interval,
2848        );
2849        Self {
2850            host,
2851            demand: ports.demand,
2852            launcher: ports.launcher,
2853            lock: ports.lock,
2854            repositories,
2855            clock: ports.clock,
2856            jitter: ports.jitter,
2857            events: ports.events,
2858            schedule: PollSchedule::new(interval),
2859            clean_backoff: CleanBackoff::default(),
2860            director: Arc::new(OwnDemand),
2861            launch_side: None,
2862            memory: Arc::new(NoMemoryGate),
2863            host_labels: Vec::new(),
2864            seen_exclusions: Mutex::default(),
2865        }
2866    }
2867
2868    /// Gives every profile this host's derived labels: `wsl` inside WSL,
2869    /// `not-wsl` elsewhere. See [`HostTraits`].
2870    #[must_use]
2871    pub fn with_host_traits(mut self, traits: HostTraits) -> Self {
2872        self.host_labels = traits.labels();
2873        self
2874    }
2875
2876    /// Checks every start against the host's memory. See [`MemoryGate`].
2877    #[must_use]
2878    pub fn with_memory_gate(mut self, memory: Arc<dyn MemoryGate>) -> Self {
2879        self.memory = memory;
2880        self
2881    }
2882
2883    /// Leaves this reconciler's directed launches to whatever `signal` wakes
2884    /// ([`Self::serve_launches`]). A pass then only reports on them. A pass that
2885    /// brought one up itself would be held for as long as its package takes, and
2886    /// a pass is what concludes a runner that exited and frees its slot.
2887    #[must_use]
2888    pub fn with_launch_side(mut self, signal: Arc<tokio::sync::Notify>) -> Self {
2889        self.launch_side = Some(signal);
2890        self
2891    }
2892
2893    /// Lets `director` replace a policy's polled demand with the launches the
2894    /// coordinator placed here. See [`DemandDirector`].
2895    #[must_use]
2896    pub fn with_director(mut self, director: Arc<dyn DemandDirector>) -> Self {
2897        self.director = director;
2898        self
2899    }
2900
2901    #[must_use]
2902    pub const fn host(&self) -> &Host {
2903        &self.host
2904    }
2905
2906    #[must_use]
2907    pub const fn schedule(&self) -> &PollSchedule {
2908        &self.schedule
2909    }
2910
2911    /// Adopt intervals an operator changed while the loop runs.
2912    pub fn set_intervals(&mut self, active: RefreshInterval, idle: Duration) {
2913        self.host.refresh_interval = active;
2914        self.schedule.set_intervals(active, idle);
2915    }
2916
2917    /// The repository-list cache, so `f1` can report what it has spent.
2918    #[must_use]
2919    pub const fn repositories(&self) -> &RepositoryCache {
2920        &self.repositories
2921    }
2922
2923    /// Starts the runners of `policies`' coordinator launches, and nothing
2924    /// else: no GitHub poll, no supervision. Every launch open at that moment is
2925    /// served by one call. See [`Self::serve_launches`].
2926    #[cfg(test)]
2927    pub async fn start_directed(&self, policies: &[ScalePolicy]) -> ReconcileReport {
2928        let mut report = ReconcileReport::default();
2929        let mut round = ReservationRound::default();
2930        let mut reserved = Vec::new();
2931        while let Some(next) = self
2932            .reserve_next_launch(policies, &mut round, &mut report)
2933            .await
2934        {
2935            reserved.push(next);
2936        }
2937        self.finish_reserved(reserved, &mut report).await;
2938        report
2939    }
2940
2941    /// Serves a target's coordinator launches until `stop`: on `signal`, and
2942    /// [`LAUNCH_RETRY`] after one that did not start, it reserves a runner for
2943    /// every launch open at that moment, one at a time, and brings each up as soon
2944    /// as it is reserved. A launch the coordinator placed here needs no reading of
2945    /// the queue, so this runs beside the target's passes: a launch accepted while
2946    /// one is polling GitHub, or while runners already reserved are coming up, is
2947    /// reserved and brought up at once rather than after them.
2948    ///
2949    /// It goes through the same allocator, ceilings and host-wide lock as
2950    /// [`Self::reconcile`]. Neither needs to know of the other's runners: each
2951    /// reads the journal under the lock, which holds every reservation. What it
2952    /// reserves is the launcher's to keep apart from supervision while it comes
2953    /// up (`LifecycleLauncher::supervise`), and the next full pass supervises it.
2954    /// After `stop` it reserves nothing more and returns once what it reserved is
2955    /// up or has failed.
2956    pub async fn serve_launches(
2957        &self,
2958        policies: &(dyn Fn() -> Vec<ScalePolicy> + Send + Sync),
2959        signal: &tokio::sync::Notify,
2960        mut stop: tokio::sync::watch::Receiver<bool>,
2961    ) {
2962        use futures::StreamExt as _;
2963
2964        let mut bringing_up = futures::stream::FuturesUnordered::new();
2965        let mut reserving: Option<Reserving<'_>> = None;
2966        let mut retry_at: Option<tokio::time::Instant> = None;
2967        let mut known: Vec<ScalePolicy> = Vec::new();
2968        let mut stopping = *stop.borrow();
2969        loop {
2970            if stopping && reserving.is_none() && bringing_up.is_empty() {
2971                return;
2972            }
2973            tokio::select! {
2974                () = signal.notified(), if !stopping && reserving.is_none() => {
2975                    reserving = Some(self.reserve_step(policies(), ReservationRound::default()));
2976                }
2977                () = async {
2978                    match retry_at {
2979                        Some(at) => tokio::time::sleep_until(at).await,
2980                        None => std::future::pending().await,
2981                    }
2982                }, if !stopping && reserving.is_none() => {
2983                    retry_at = None;
2984                    reserving = Some(self.reserve_step(policies(), ReservationRound::default()));
2985                }
2986                (reserved, round, read) = async {
2987                    match reserving.as_mut() {
2988                        Some(reserving) => reserving.await,
2989                        None => std::future::pending().await,
2990                    }
2991                } => {
2992                    reserving = None;
2993                    match reserved {
2994                        Some(reserved) => {
2995                            bringing_up.push(self.bring_up(reserved));
2996                            known = read;
2997                            if !stopping {
2998                                reserving = Some(self.reserve_step(policies(), round));
2999                            }
3000                        }
3001                        None => known = read,
3002                    }
3003                }
3004                Some(_) = bringing_up.next(), if !bringing_up.is_empty() => {}
3005                changed = stop.changed(), if !stopping => {
3006                    stopping = changed.is_err() || *stop.borrow();
3007                }
3008            }
3009            // One that did not start, a registration that failed, is tried again
3010            // well inside its lease's lifetime.
3011            if reserving.is_none()
3012                && retry_at.is_none()
3013                && known
3014                    .iter()
3015                    .any(|policy| self.director.next_waiting(policy).is_some())
3016            {
3017                retry_at = Some(tokio::time::Instant::now() + LAUNCH_RETRY);
3018            }
3019        }
3020    }
3021
3022    /// [`Self::reserve_next_launch`], as a future that owns what it needs.
3023    fn reserve_step(
3024        &self,
3025        policies: Vec<ScalePolicy>,
3026        mut round: ReservationRound,
3027    ) -> Reserving<'_> {
3028        Box::pin(async move {
3029            let mut report = ReconcileReport::default();
3030            let reserved = self
3031                .reserve_next_launch(&policies, &mut round, &mut report)
3032                .await;
3033            (reserved, round, policies)
3034        })
3035    }
3036
3037    /// Reserves one runner for the oldest of `policies`' open launches: a target's
3038    /// own profiles keep the order too. Slow work comes after this, in
3039    /// [`Self::bring_up`], so no launch's package holds up another's reservation.
3040    /// `None` when `round` has served all it can.
3041    async fn reserve_next_launch(
3042        &self,
3043        policies: &[ScalePolicy],
3044        round: &mut ReservationRound,
3045        report: &mut ReconcileReport,
3046    ) -> Option<Reserved> {
3047        loop {
3048            let policy = policies
3049                .iter()
3050                .filter(|policy| {
3051                    policy.owns_runners()
3052                        && policy.is_owned_by(self.host.id)
3053                        && policy.may_start_runners()
3054                        && !round.exhausted.contains(&policy.id)
3055                })
3056                .min_by_key(|policy| self.director.next_waiting(policy).unwrap_or(u64::MAX))?;
3057            let (served, most) = round.reserved.entry(policy.id).or_default();
3058            // Bounded by the launches open, however late the journal shows these.
3059            if let Some(directed) = self.director.directed_demand(policy)
3060                && *served < directed.max(*most)
3061            {
3062                *most = directed.max(*most);
3063                let mut reserved = Vec::new();
3064                let excluded = self.director.directed_exclusions(policy);
3065                self.start_runners(policy, directed, &excluded, 1, report, &mut reserved)
3066                    .await;
3067                if let Some(next) = reserved.pop() {
3068                    *served += 1;
3069                    return Some(next);
3070                }
3071            }
3072            round.exhausted.insert(policy.id);
3073        }
3074    }
3075
3076    /// One reconciliation pass over `policies`.
3077    ///
3078    /// The order of operations is `03-control-flows.md` flow 2, and the two
3079    /// steps most worth naming are the ones that are silent when they are wrong:
3080    ///
3081    /// * **Monitor-only policies are removed before the demand poll**, not
3082    ///   after. D19 says such a policy "is skipped entirely by reconciliation",
3083    ///   and a poll issued on its behalf would spend requests from the shared
3084    ///   ceiling for a policy that can never act on the answer. This is asserted
3085    ///   on [`ScalePolicy::owns_runners`] rather than deduced from
3086    ///   `max_capacity` being absent.
3087    /// * **The attempt set is re-read under the lock, once per runtime.** See
3088    ///   [`RunnerLauncher`] for why it comes from there and nowhere else.
3089    pub async fn reconcile(&mut self, policies: &[ScalePolicy]) -> ReconcileReport {
3090        let mut report = ReconcileReport::default();
3091        // Everything this pass has created, carried across policies so that the
3092        // host-wide total cannot be computed from a set that is missing it. See
3093        // `RunnerLauncher::launch`.
3094        let mut reserved: Vec<Reserved> = Vec::new();
3095
3096        // --- Flow 2.1-2.2: who is even asking, and what did GitHub say -------
3097        let mut pollable: Vec<&ScalePolicy> = Vec::new();
3098        let mut supervision_failed = BTreeSet::new();
3099        for policy in policies {
3100            if !policy.owns_runners() {
3101                report.monitor_only.push(policy.id);
3102                self.events
3103                    .emit(LifecycleEvent::MonitorOnlySkipped { policy: policy.id });
3104                continue;
3105            }
3106            if !policy.is_owned_by(self.host.id) {
3107                // Ownership rule 2 and precedence rule 4. The allocator reports
3108                // both by name below; polling on their behalf would spend
3109                // requests for an answer that cannot be acted on.
3110                continue;
3111            }
3112            match self.launcher.supervise(policy).await {
3113                Ok(intents) => {
3114                    report.replacement_intents = report
3115                        .replacement_intents
3116                        .saturating_add(u16::try_from(intents.len()).unwrap_or(u16::MAX));
3117                }
3118                Err(failure) => {
3119                    supervision_failed.insert(policy.id);
3120                    self.report_unreadable_attempts(&mut report, &failure);
3121                    continue;
3122                }
3123            }
3124            if !policy.may_start_runners() {
3125                continue;
3126            }
3127            pollable.push(policy);
3128        }
3129
3130        let readings = self.poll_targets(&pollable, &mut report).await;
3131        report.targets_read = u16::try_from(
3132            readings
3133                .values()
3134                .filter(|outcome| matches!(outcome, PollOutcome::Ready(_)))
3135                .count(),
3136        )
3137        .unwrap_or(u16::MAX);
3138        let mut routed = BTreeMap::new();
3139        for (target, outcome) in &readings {
3140            let PollOutcome::Ready(reading) = outcome else {
3141                continue;
3142            };
3143            let profiles: Vec<&ScalePolicy> = pollable
3144                .iter()
3145                .copied()
3146                .filter(|policy| &policy.target == target)
3147                .collect();
3148            let (tallies, refusals) = route_demand(policies, &profiles, reading, &self.host_labels);
3149            if let Some(first) = profiles.first() {
3150                for (reason, count) in refusals {
3151                    self.events.emit(LifecycleEvent::RoutingRefused {
3152                        policy: first.id,
3153                        reason,
3154                        count,
3155                    });
3156                }
3157            }
3158            routed.insert(target.clone(), tallies);
3159        }
3160
3161        // --- Flow 2.8: terminal attempts, whatever else this pass does -------
3162        //
3163        // Run before the allocation phase so that a report's `cleaned` count
3164        // describes the same instant its allocations do. It does not change the
3165        // arithmetic: a terminal attempt already stopped counting against
3166        // capacity when it became terminal, which is `b1`'s
3167        // `counts_against_capacity`. It touches no live process, so it is also
3168        // safe during an outage — flow 3.3 requires that running runners be
3169        // retained, and nothing here can reach one.
3170        self.clean_terminal_attempts(&mut report).await;
3171
3172        // --- Flow 2.3-2.6: the allocation -----------------------------------
3173        //
3174        // The predicates are re-tested here rather than the reading being looked
3175        // up by target, and that is not redundancy. **Targets are shared.** A
3176        // monitor-only policy watching `acme/app` alongside an autoscale policy
3177        // on the *same* repository finds a reading in the map that the other
3178        // policy paid for, and a lookup-driven loop then serves it: it emits a
3179        // demand observation on its behalf and clamps a number it has no
3180        // business seeing.
3181        //
3182        // Nothing downstream goes wrong when that happens — `may_start_runners`
3183        // is false for a monitor-only policy, so `HostAllocator` refuses it and
3184        // `to_start` is zero. It simply is not *skipped*, and D19's word is
3185        // "entirely".
3186        for policy in policies {
3187            if !policy.owns_runners() {
3188                // Already recorded and reported above, before any demand request
3189                // was issued. It owns no routing labels, takes no part in
3190                // demand, and can never be the reason a runner starts. Asserted
3191                // on the mode rather than deduced from `max_capacity` being
3192                // absent, which is what the specification requires.
3193                continue;
3194            }
3195            if !policy.is_owned_by(self.host.id) || !policy.may_start_runners() {
3196                // Ownership rule 2 and precedence rule 4. Allocated for with no
3197                // demand, so the refusal is reported by name rather than by
3198                // absence.
3199                match self.allocate_only(policy, 0, &reserved).await {
3200                    Ok(allocation) => {
3201                        self.emit_allocation(&allocation);
3202                        report.allocations.push(allocation);
3203                    }
3204                    Err(failure) => self.report_allocation_failure(&mut report, &failure),
3205                }
3206                continue;
3207            }
3208            if supervision_failed.contains(&policy.id) {
3209                continue;
3210            }
3211            // Coordinated placement: the launches the coordinator placed
3212            // here are the demand, whatever this host's own reading says (or
3213            // whether it could read at all).
3214            if let Some(directed) = self.director.directed_demand(policy) {
3215                let Some(launch_side) = &self.launch_side else {
3216                    let excluded = self.director.directed_exclusions(policy);
3217                    self.start_runners(
3218                        policy,
3219                        directed,
3220                        &excluded,
3221                        u16::MAX,
3222                        &mut report,
3223                        &mut reserved,
3224                    )
3225                    .await;
3226                    continue;
3227                };
3228                match self.allocate_only(policy, directed, &reserved).await {
3229                    Ok(allocation) => {
3230                        if !allocation.starts_nothing() {
3231                            launch_side.notify_one();
3232                        }
3233                        report.allocations.push(allocation);
3234                    }
3235                    Err(failure) => self.report_allocation_failure(&mut report, &failure),
3236                }
3237                continue;
3238            }
3239            let Some(reading) = readings.get(&policy.target) else {
3240                // Unreachable: every policy reaching here was in `pollable`, and
3241                // `poll_targets` inserts an outcome for each of their targets.
3242                debug_assert!(false, "a pollable policy's target has no reading");
3243                continue;
3244            };
3245            match reading {
3246                PollOutcome::Failed(state) => {
3247                    report.unreadable.push(policy.id);
3248                    self.events.emit(LifecycleEvent::TargetUnreadable {
3249                        policy: policy.id,
3250                        reason: unreadable_reason(state),
3251                    });
3252                }
3253                PollOutcome::Ready(demand) => {
3254                    let tally = routed
3255                        .get(&policy.target)
3256                        .and_then(|tallies| tallies.get(&policy.id))
3257                        .expect("every pollable profile has a routed tally");
3258                    let count = tally.demand();
3259                    self.events.emit(LifecycleEvent::DemandObserved {
3260                        policy: policy.id,
3261                        demand: count,
3262                        not_matched: tally.not_matched,
3263                        unresolvable: u32::try_from(tally.unresolvable.len()).unwrap_or(u32::MAX),
3264                        complete: demand.is_complete(),
3265                    });
3266                    self.start_runners(
3267                        policy,
3268                        count,
3269                        &tally.excluded,
3270                        u16::MAX,
3271                        &mut report,
3272                        &mut reserved,
3273                    )
3274                    .await;
3275                }
3276            }
3277        }
3278        self.finish_reserved(reserved, &mut report).await;
3279
3280        // --- Flow 2.1 / 3.3: when to come back ------------------------------
3281        let failure = readings
3282            .values()
3283            .filter_map(PollOutcome::failure)
3284            .max_by_key(|state| severity(state))
3285            .cloned();
3286        let now = self.clock.now();
3287        let conditions = PollConditions {
3288            quiet: is_quiet(&readings, &report),
3289            requests_per_pass: report.demand_requests,
3290            quota: readings
3291                .values()
3292                .filter_map(PollOutcome::reading)
3293                .filter_map(QueuedDemand::rate_limit)
3294                .max_by_key(|quota| quota.observed_at)
3295                .copied(),
3296        };
3297        report.next_poll =
3298            self.schedule
3299                .next_poll_with(failure.as_ref(), conditions, now, self.jitter.as_ref());
3300        report.failure = failure;
3301        // Flow 3.3's fourth obligation: the offline state carries the 24-hour
3302        // bound, and it can only say whether that bound has passed if it is
3303        // given the real elapsed time rather than an estimate from the interval.
3304        if let PollPace::Offline { consecutive } = report.next_poll.pace {
3305            let state = OfflineState::new(consecutive, report.next_poll.delay);
3306            report.offline = Some(match self.schedule.offline_for(now) {
3307                Some(elapsed) => state.since(elapsed),
3308                None => state,
3309            });
3310        }
3311        self.events.emit(LifecycleEvent::PollScheduled {
3312            retry_in_ms: u64::try_from(report.next_poll.delay.as_millis()).unwrap_or(u64::MAX),
3313            pace: report.next_poll.pace,
3314        });
3315
3316        report
3317    }
3318
3319    /// Poll each distinct target once, however many policies share it.
3320    ///
3321    /// Two policies on one repository are one demand request, not two. That is
3322    /// not a micro-optimisation: the budget model in
3323    /// `04-subsystem-contracts.md` prices a *target*, and a loop that spent per
3324    /// policy would quietly exceed the projection `f2` admitted the
3325    /// configuration against.
3326    async fn poll_targets(
3327        &self,
3328        pollable: &[&ScalePolicy],
3329        report: &mut ReconcileReport,
3330    ) -> BTreeMap<ScaleTarget, PollOutcome> {
3331        let targets: BTreeSet<ScaleTarget> = pollable.iter().map(|p| p.target.clone()).collect();
3332
3333        let mut readings = BTreeMap::new();
3334        for target in targets {
3335            let outcome = match self.repositories.scope_for(&target).await {
3336                Ok(scope) => {
3337                    report.demand_requests = report
3338                        .demand_requests
3339                        .saturating_add(demand_requests_per_poll(&scope));
3340                    self.demand.poll(&scope).await
3341                }
3342                // The repository list could not be refreshed, so the scope of
3343                // the poll is unknown. Polling a stale or empty scope would
3344                // report a demand number for a set of repositories nobody
3345                // chose, which is worse than reporting that the target could
3346                // not be read.
3347                Err(error) => PollOutcome::Failed(RefreshState::from_error(&error)),
3348            };
3349            readings.insert(target, outcome);
3350        }
3351        readings
3352    }
3353
3354    /// Compute one policy's allocation without creating anything.
3355    ///
3356    /// # Why this is safe without the lock
3357    ///
3358    /// **Not** because it cannot grant — it can, and
3359    /// [`Reconciler::start_runners`] uses it as a pre-check precisely for the
3360    /// number it returns. That was the original reason and this function
3361    /// outgrew it; the reason now is that it *decides* nothing. Nothing is
3362    /// created here, the headroom it read is re-read under the lock before any
3363    /// runtime exists, and the under-lock allocation may only lower what this
3364    /// one proposed. So there is no read-decide-create sequence here to make
3365    /// atomic, and the worst this can be is optimistic — which the lock then
3366    /// corrects.
3367    ///
3368    /// # Errors
3369    /// A host-ceiling or attempt-journal read failure. Neither permits an
3370    /// allocation, and they remain distinct in diagnostics.
3371    async fn allocate_only(
3372        &self,
3373        policy: &ScalePolicy,
3374        demand: u32,
3375        reserved: &[Reserved],
3376    ) -> Result<Allocation, AllocationFailure> {
3377        self.allocate_over(policy, demand, reserved)
3378            .await
3379            .map(|(allocation, _)| allocation)
3380    }
3381
3382    /// [`Self::allocate_only`], and the attempt set it was decided over.
3383    async fn allocate_over(
3384        &self,
3385        policy: &ScalePolicy,
3386        demand: u32,
3387        reserved: &[Reserved],
3388    ) -> Result<(Allocation, Vec<RunnerAttempt>), AllocationFailure> {
3389        // Read again under the shared launch lock, not just at each target's
3390        // poll boundary: another target must not use an old, higher ceiling.
3391        let mut host = self.host.clone();
3392        host.host_capacity = self
3393            .launcher
3394            .host_capacity(&self.host)
3395            .await
3396            .map_err(AllocationFailure::HostCapacity)?;
3397        let attempts = self
3398            .host_attempts(reserved)
3399            .await
3400            .map_err(AllocationFailure::Attempts)?;
3401        let mut allocator = HostAllocator::from_attempts(&host, &attempts);
3402        let allocation = allocator.allocate(policy, demand);
3403        Ok((allocation, attempts))
3404    }
3405
3406    /// Flow 2.4-2.6: start runners for one policy, one lock hold per runtime.
3407    ///
3408    /// # Two stopping conditions, and both are needed
3409    ///
3410    /// The loop re-reads the attempt set under every hold, so the obvious stop
3411    /// is "the allocator granted nothing". That condition **alone does not
3412    /// terminate**, and the failure is not hypothetical — it was measured.
3413    /// Handing the allocator a set that does not include the runners this loop
3414    /// just started (an empty one, a stale one, or a launcher whose journal
3415    /// write has not landed yet) makes every grant look like the first, and the
3416    /// pass starts runners until something outside it intervenes. With the set
3417    /// dropped entirely, the three-consecutive-polls test below does not report
3418    /// three attempts; it *never returns*.
3419    ///
3420    /// So the grant decided on the first hold is also a **budget**. A later hold
3421    /// may lower it — the host may have filled up meanwhile — and can never
3422    /// raise it, which bounds the pass at the number this policy was actually
3423    /// allocated. That is `c2`'s reasoning for `MAX_PAGES` one layer down: the
3424    /// reconciliation loop is the one place in this product that must not be
3425    /// able to wedge, so the bound is structural rather than a consequence of
3426    /// every input being well behaved.
3427    ///
3428    /// At most `limit` runners: one, when the caller decides who is next.
3429    ///
3430    /// Each registers with the policy's labels, this host's
3431    /// [`HostTraits`] labels, and `not-X` for every `X` in `excluded` (what the
3432    /// jobs it is started for exclude, which GitHub otherwise never hands it)
3433    /// and in every earlier pass's.
3434    async fn start_runners(
3435        &self,
3436        policy: &ScalePolicy,
3437        demand: u32,
3438        excluded: &BTreeSet<Label>,
3439        limit: u16,
3440        report: &mut ReconcileReport,
3441        reserved: &mut Vec<Reserved>,
3442    ) {
3443        // Exclusions are kept for the policy's later runners too: a runner
3444        // already waiting counts as supply for the next job that names one,
3445        // and it can take that job only if it carries it.
3446        let excluded = {
3447            let mut seen = self
3448                .seen_exclusions
3449                .lock()
3450                .unwrap_or_else(std::sync::PoisonError::into_inner);
3451            let kept = seen.entry(policy.id).or_default();
3452            kept.extend(excluded.iter().cloned());
3453            kept.clone()
3454        };
3455        let registered = policy.with_runtime_labels(|labels| {
3456            labels
3457                .with_labels(self.host_labels.iter().cloned())
3458                .excluding(&excluded)
3459        });
3460        let policy = &registered;
3461        // A lock-free pre-check, for one reason only: the host-wide lock should
3462        // not be taken by a policy that is going to be granted nothing. On an
3463        // idle host with P policies that was P lock acquisitions per poll --
3464        // free under `InProcessAllocationLock`, a `spawn_blocking` and a
3465        // filesystem lock apiece under `FileAllocationLock`.
3466        //
3467        // It is safe because it can only be optimistic. Anything it grants is
3468        // re-decided under the lock below and may be lowered there; the only
3469        // thing it can get wrong in the other direction is refusing a grant that
3470        // headroom freed a moment later would have allowed, which the next poll
3471        // picks up.
3472        let intent = match self.allocate_only(policy, demand, reserved).await {
3473            Ok(intent) => intent,
3474            Err(failure) => {
3475                self.report_allocation_failure(report, &failure);
3476                self.director.start_failed(policy, None);
3477                return;
3478            }
3479        };
3480
3481        // The allocation that is *reported* is the one taken under the lock when
3482        // a lock was taken, because that is the one that decided anything. The
3483        // pre-check stands in only when no hold was ever obtained.
3484        let mut decided: Option<Allocation> = None;
3485        let mut budget = intent.to_start.min(limit);
3486
3487        while budget > 0 {
3488            let order_wait = self.let_older_launches_reserve(policy).await;
3489            // A launch may have been cancelled while this one waited.
3490            let demand = if order_wait.is_zero() {
3491                demand
3492            } else {
3493                self.director.directed_demand(policy).unwrap_or(demand)
3494            };
3495            let waiting_since = std::time::Instant::now();
3496            let guard = match self.lock.acquire().await {
3497                Ok(guard) => guard,
3498                Err(_) => {
3499                    // Grants, not policies: this is what the policy was owed and
3500                    // did not get.
3501                    report.deferred = report.deferred.saturating_add(budget);
3502                    self.events.emit(LifecycleEvent::AllocationDeferred {
3503                        policy: policy.id,
3504                        count: budget,
3505                    });
3506                    // The lock is held briefly now, so this is not a turn: a
3507                    // Windows drain, the fence, or another process.
3508                    self.director.start_failed(policy, None);
3509                    break;
3510                }
3511            };
3512            let lock_wait = waiting_since.elapsed();
3513
3514            // The read and the decision are both inside the hold, and so is the
3515            // journalled reservation below. Two concurrent passes therefore serialise on the
3516            // whole sequence rather than on the decision alone -- reading the
3517            // headroom outside the lock is the shape in which two policies both
3518            // find room for the last slot.
3519            let (allocation, attempts) = match self.allocate_over(policy, demand, reserved).await {
3520                Ok(decided) => decided,
3521                Err(failure) => {
3522                    drop(guard);
3523                    self.report_allocation_failure(report, &failure);
3524                    self.director.start_failed(policy, None);
3525                    break;
3526                }
3527            };
3528
3529            if decided.is_none() {
3530                // The under-lock decision may be smaller than the pre-check, and
3531                // never larger: `min` rather than assignment, so a later hold
3532                // cannot raise the bound either.
3533                budget = budget.min(allocation.to_start);
3534                decided = Some(allocation.clone());
3535            }
3536
3537            // Either stop is sufficient on its own in the well-behaved case;
3538            // neither is sufficient when the launcher lags. See the doc comment.
3539            if allocation.starts_nothing() || budget == 0 {
3540                drop(guard);
3541                break;
3542            }
3543
3544            // Memory, last: every ceiling granted this runner. Read under the
3545            // hold with the set the grant was decided over, so a runner this
3546            // pass reserved a moment ago holds its estimate here already.
3547            match self.memory.admit(policy, &attempts) {
3548                MemoryVerdict::Defer(figures) => {
3549                    drop(guard);
3550                    report.memory_deferred = report.memory_deferred.saturating_add(budget);
3551                    self.events.emit(LifecycleEvent::MemoryShort {
3552                        policy: policy.id,
3553                        figures,
3554                        started: false,
3555                    });
3556                    // A directed launch waits like one that could not start:
3557                    // past `START_LIMIT` it is dropped, and the coordinator
3558                    // places its job on another host.
3559                    self.director.start_failed(policy, None);
3560                    break;
3561                }
3562                MemoryVerdict::AdmitAlone(figures) => {
3563                    self.events.emit(LifecycleEvent::MemoryShort {
3564                        policy: policy.id,
3565                        figures,
3566                        started: true,
3567                    });
3568                    self.memory.admitted(policy);
3569                }
3570                MemoryVerdict::Admit(_) | MemoryVerdict::Unchecked => self.memory.admitted(policy),
3571            }
3572
3573            let created = self
3574                .launcher
3575                .launch(LaunchRequest {
3576                    host: &self.host,
3577                    policy,
3578                    allocation_guard: &guard,
3579                })
3580                .await;
3581            let hold = guard.launch_hold();
3582            drop(guard);
3583
3584            match created {
3585                Ok(attempt) => {
3586                    let id = attempt.id;
3587                    // At once, not once it is up: the launch has its runner, and
3588                    // the runner's report names the launch it was started for.
3589                    self.director.launched(policy, id);
3590                    budget -= 1;
3591                    // Carried across policies for the rest of this pass, so the
3592                    // host-wide total cannot be computed from a set that is
3593                    // missing it. See `RunnerLauncher::launch`.
3594                    reserved.push(Reserved {
3595                        policy: policy.clone(),
3596                        attempt,
3597                        waits: ReservationWaits {
3598                            order: order_wait,
3599                            lock: lock_wait,
3600                        },
3601                        reserved_at: std::time::Instant::now(),
3602                        _hold: hold,
3603                    });
3604                }
3605                Err(failure) => {
3606                    self.note_start_failed(policy, None, &failure);
3607                    break;
3608                }
3609            }
3610        }
3611
3612        let allocation = decided.unwrap_or(intent);
3613        self.emit_allocation(&allocation);
3614        report.allocations.push(allocation);
3615    }
3616
3617    /// Oldest first across targets: `policy`'s launch reserves after the older
3618    /// launches of this host's other targets, whose loops are told of them as
3619    /// soon as they are accepted. A reservation is a lock hold and a journal
3620    /// write, so this is short, and only a loop that cannot reserve at all makes
3621    /// it long: see [`OLDER_LAUNCH_TURN`]. Answers how long it waited.
3622    async fn let_older_launches_reserve(&self, policy: &ScalePolicy) -> Duration {
3623        let began = tokio::time::Instant::now();
3624        let mut older = self.director.older_waiting(policy);
3625        let mut limit = began + OLDER_LAUNCH_TURN;
3626        while older > 0 {
3627            if tokio::time::Instant::now() >= limit {
3628                tracing::warn!(
3629                    event = "older_launch_passed_over",
3630                    policy_id = %policy.id,
3631                    count = older,
3632                );
3633                self.director.pass_over_older(policy);
3634                break;
3635            }
3636            tokio::time::sleep(OLDER_LAUNCH_POLL).await;
3637            let still = self.director.older_waiting(policy);
3638            if still < older {
3639                limit = tokio::time::Instant::now() + OLDER_LAUNCH_TURN;
3640            }
3641            older = still;
3642        }
3643        began.elapsed()
3644    }
3645
3646    /// Bring up what this pass reserved, together and outside the allocation
3647    /// lock, so one slow package holds up neither another runner nor another
3648    /// target. How many prepare at once is the launcher's to bound.
3649    ///
3650    /// Awaited within the pass, because supervision is what would otherwise see
3651    /// these attempts half made: one target's attempts are only ever supervised
3652    /// by its own loop, which is here.
3653    async fn finish_reserved(&self, reserved: Vec<Reserved>, report: &mut ReconcileReport) {
3654        let finished =
3655            futures::future::join_all(reserved.into_iter().map(|reserved| self.bring_up(reserved)))
3656                .await;
3657        let started = finished.into_iter().filter(|started| *started).count();
3658        report.started = report
3659            .started
3660            .saturating_add(u16::try_from(started).unwrap_or(u16::MAX));
3661    }
3662
3663    /// One reserved runner, up or failed: whether it is up.
3664    async fn bring_up(&self, reserved: Reserved) -> bool {
3665        let id = reserved.attempt.id;
3666        let mut waits = reserved.waits;
3667        waits.lock += reserved.reserved_at.elapsed();
3668        let result = self
3669            .launcher
3670            .finish_launch(&reserved.policy, reserved.attempt, waits)
3671            .await;
3672        // Told here and not after the others are up: the journal already
3673        // says this one failed, and the attempt reports read it.
3674        match &result {
3675            Ok(_) => self.events.emit(LifecycleEvent::RunnerStarted {
3676                policy: reserved.policy.id,
3677                attempt: id,
3678            }),
3679            Err(failure) => self.note_start_failed(&reserved.policy, Some(id), failure),
3680        }
3681        result.is_ok()
3682    }
3683
3684    fn note_start_failed(
3685        &self,
3686        policy: &ScalePolicy,
3687        attempt: Option<AttemptId>,
3688        failure: &LaunchFailure,
3689    ) {
3690        self.events.emit(LifecycleEvent::RunnerStartFailed {
3691            policy: policy.id,
3692            reason: failure_reason_kind(&failure.reason),
3693        });
3694        self.director.start_failed(policy, attempt);
3695    }
3696
3697    /// The attempt set the host holds, plus everything this pass has already
3698    /// created.
3699    ///
3700    /// The merge is by [`RunnerAttempt::id`], so a launcher that makes its
3701    /// launches visible before returning -- which
3702    /// [`RunnerLauncher::launch`] asks for -- contributes each attempt once, and
3703    /// one that lags still cannot hide a runner from the host-wide total. The
3704    /// ceiling therefore holds on the strength of this function rather than on
3705    /// the strength of an implementer honouring a comment.
3706    ///
3707    /// # Errors
3708    /// Whatever [`RunnerLauncher::attempts`] reported.
3709    async fn host_attempts(
3710        &self,
3711        reserved: &[Reserved],
3712    ) -> Result<Vec<RunnerAttempt>, LaunchFailure> {
3713        let mut attempts = self.launcher.attempts().await?;
3714
3715        // Each `launch` creates one runtime, so each must answer with an
3716        // identifier no other attempt has. Two entries sharing one here are two
3717        // runtimes the host-wide total below counts once, which is the ceiling
3718        // failing silently -- so a development build stops at the first
3719        // duplicate instead. `RunnerLauncher::launch` states the requirement;
3720        // this is what makes it findable.
3721        debug_assert!(
3722            reserved
3723                .iter()
3724                .map(|reserved| reserved.attempt.id)
3725                .collect::<BTreeSet<AttemptId>>()
3726                .len()
3727                == reserved.len(),
3728            "`RunnerLauncher::launch` returned an AttemptId this pass had already seen; \
3729             the host ceiling is enforced against a set keyed on that identifier, so a \
3730             duplicate is two runtimes counted as one"
3731        );
3732
3733        let known: BTreeSet<AttemptId> = attempts.iter().map(|attempt| attempt.id).collect();
3734        attempts.extend(
3735            reserved
3736                .iter()
3737                .filter(|reserved| !known.contains(&reserved.attempt.id))
3738                .map(|reserved| reserved.attempt.clone()),
3739        );
3740        Ok(attempts)
3741    }
3742
3743    fn report_allocation_failure(&self, report: &mut ReconcileReport, failure: &AllocationFailure) {
3744        match failure {
3745            AllocationFailure::HostCapacity(reason) => {
3746                report.host_capacity_unreadable = report.host_capacity_unreadable.saturating_add(1);
3747                self.events
3748                    .emit(LifecycleEvent::HostCapacityUnreadable { reason: *reason });
3749            }
3750            AllocationFailure::Attempts(failure) => {
3751                self.report_unreadable_attempts(report, failure)
3752            }
3753        }
3754    }
3755
3756    /// The attempt set could not be read, so nothing may be decided from it.
3757    ///
3758    /// Counted rather than swallowed for the reason the module documentation
3759    /// gives: an unreadable set and an idle host produce the same *number* and
3760    /// demand opposite actions, so the difference has to survive into the
3761    /// report.
3762    fn report_unreadable_attempts(&self, report: &mut ReconcileReport, failure: &LaunchFailure) {
3763        report.attempts_unreadable = report.attempts_unreadable.saturating_add(1);
3764        // The variant, never a literal and never the detail. A hand-written
3765        // `"attempts_unreadable"` said only what the event's own name already
3766        // said, and threw away the one thing the field is for -- *which* failure
3767        // it was. `FailureReason::Other` carries free text that must not reach
3768        // an event, which is what `failure_reason_kind` is for and what
3769        // `a_cleanup_that_cannot_succeed_...` pins for the sibling path.
3770        self.events.emit(LifecycleEvent::AttemptsUnreadable {
3771            reason: failure_reason_kind(&failure.reason),
3772        });
3773    }
3774
3775    /// Remove the runtimes of attempts that have already concluded.
3776    ///
3777    /// `is_concluded` and not `is_terminal`: `cleaned` is terminal and already
3778    /// done, and `busy` is not terminal at all. That is what makes it impossible
3779    /// for this path to reach a runner executing a job.
3780    async fn clean_terminal_attempts(&mut self, report: &mut ReconcileReport) {
3781        let attempts = match self.launcher.attempts().await {
3782            Ok(attempts) => attempts,
3783            Err(failure) => {
3784                self.report_unreadable_attempts(report, &failure);
3785                return;
3786            }
3787        };
3788        self.clean_backoff
3789            .retain(&attempts.iter().map(|attempt| attempt.id).collect());
3790        let now = self.clock.now();
3791        for attempt in attempts {
3792            if !attempt.state().is_concluded() {
3793                continue;
3794            }
3795            let Some(outcome) = attempt.outcome() else {
3796                continue;
3797            };
3798            // Backed off after failing: not tried, so neither cleaned nor a
3799            // fresh failure to report.
3800            if !self.clean_backoff.is_due(attempt.id, now) {
3801                continue;
3802            }
3803            let kind = OutcomeKind::of(outcome);
3804            match self.launcher.clean(attempt.id).await {
3805                Ok(()) => {
3806                    self.clean_backoff.succeeded(attempt.id);
3807                    report.cleaned = report.cleaned.saturating_add(1);
3808                    if kind.is_failure() {
3809                        report.failures = report.failures.saturating_add(1);
3810                    } else if kind == OutcomeKind::IdleExit {
3811                        // The surplus case. Counted apart from a failure because
3812                        // `g2` renders it apart, and because an operator told
3813                        // that a normal surplus exit is an error goes hunting a
3814                        // fault that does not exist.
3815                        report.idle_exits = report.idle_exits.saturating_add(1);
3816                    }
3817                    self.events.emit(LifecycleEvent::AttemptCleaned {
3818                        policy: attempt.policy_id,
3819                        attempt: attempt.id,
3820                        outcome: kind,
3821                    });
3822                }
3823                // A runtime directory that cannot be removed is retried on every
3824                // poll. Silently, before this arm existed: no event, no counter,
3825                // no report field, so a cleanup that can never succeed was an
3826                // invisible permanent loop. It wedges no capacity -- a terminal
3827                // attempt already stopped counting -- but this module's
3828                // organising principle is the things that go wrong silently, and
3829                // `clean` returns a `Result` precisely so the caller can say
3830                // something. It is retried with per-attempt backoff
3831                // ([`CLEAN_RETRY_INITIAL`]) so the saying is not a flood.
3832                Err(failure) => {
3833                    self.clean_backoff.failed(attempt.id, now);
3834                    report.clean_failures = report.clean_failures.saturating_add(1);
3835                    self.events.emit(LifecycleEvent::AttemptCleanFailed {
3836                        policy: attempt.policy_id,
3837                        attempt: attempt.id,
3838                        reason: failure_reason_kind(&failure.reason),
3839                    });
3840                }
3841            }
3842        }
3843    }
3844
3845    /// Reclaim what can be reclaimed for one policy, and nothing else.
3846    ///
3847    /// **A busy attempt is never removed.** `04-subsystem-contracts.md`:
3848    /// *"`busy` cannot transition to cleanup due to a scale-down request"*.
3849    /// Capacity comes back when an attempt reaches a terminal state and at no
3850    /// other time, so a scale-down against a host full of busy runners removes
3851    /// nothing, changes nothing, and says so.
3852    pub async fn scale_down(&self, policy: &ScalePolicy) -> ScaleDownReport {
3853        let mut report = ScaleDownReport::default();
3854        let attempts = match self.launcher.attempts().await {
3855            Ok(attempts) => attempts,
3856            Err(failure) => {
3857                // The same rule as everywhere else, and this was the one place
3858                // it was still broken: an unreadable set is not an empty one,
3859                // and a bare `default()` here reported all zeros -- byte for
3860                // byte an idle host with nothing to reclaim.
3861                self.events.emit(LifecycleEvent::AttemptsUnreadable {
3862                    reason: failure_reason_kind(&failure.reason),
3863                });
3864                report.attempts_unreadable = true;
3865                return report;
3866            }
3867        };
3868        for attempt in attempts {
3869            if attempt.policy_id != policy.id {
3870                continue;
3871            }
3872            match attempt.state() {
3873                AttemptState::Busy => {
3874                    report.refused_busy = report.refused_busy.saturating_add(1);
3875                    self.events.emit(LifecycleEvent::ScaleDownRefused {
3876                        policy: policy.id,
3877                        attempt: attempt.id,
3878                    });
3879                }
3880                state if state.is_concluded() => {
3881                    let kind = attempt
3882                        .outcome()
3883                        .map_or(OutcomeKind::Failed, OutcomeKind::of);
3884                    match self.launcher.clean(attempt.id).await {
3885                        Ok(()) => {
3886                            report.removed = report.removed.saturating_add(1);
3887                            self.events.emit(LifecycleEvent::AttemptCleaned {
3888                                policy: policy.id,
3889                                attempt: attempt.id,
3890                                outcome: kind,
3891                            });
3892                        }
3893                        Err(failure) => {
3894                            report.clean_failures = report.clean_failures.saturating_add(1);
3895                            self.events.emit(LifecycleEvent::AttemptCleanFailed {
3896                                policy: policy.id,
3897                                attempt: attempt.id,
3898                                reason: failure_reason_kind(&failure.reason),
3899                            });
3900                        }
3901                    }
3902                }
3903                AttemptState::Cleaned => {}
3904                // `allocated`, `jit_received`, `starting`, `idle`: live, holding
3905                // a slot, and not this function's to end.
3906                _ => report.retained = report.retained.saturating_add(1),
3907            }
3908        }
3909        report
3910    }
3911
3912    fn emit_allocation(&self, allocation: &Allocation) {
3913        self.events.emit(LifecycleEvent::Allocated {
3914            policy: allocation.policy_id,
3915            demand: allocation.demand,
3916            desired: allocation.desired,
3917            active_owned: allocation.active_owned,
3918            headroom: allocation.headroom_before,
3919            to_start: allocation.to_start,
3920            limiting: allocation.limiting_factor,
3921        });
3922    }
3923}
3924
3925/// One policy's demand, from the reading its target answered with.
3926///
3927/// A repository target tallies its own repository's queued jobs; an organization
3928/// target tallies every repository its scope covered, because one policy watching
3929/// an organization serves any repository in it.
3930///
3931/// # Why this takes a whole policy rather than a target and a label set
3932///
3933/// Because both halves have to come from the same policy, and a signature that
3934/// took them separately made it possible for them not to. The predecessor took a
3935/// `&ScaleTarget` alone and could not filter at all; the obvious repair was to
3936/// add a `&RoutingLabels` beside it, and at three call sites — two of them in
3937/// tests — nothing would have caught passing one policy's target with another
3938/// policy's labels. It compiles, it runs, and it silently serves the wrong
3939/// repository's queue.
3940///
3941/// # A monitor-only policy has no labels, and cannot reach here
3942///
3943/// [`Reconciler::reconcile`] filters on [`ScalePolicy::owns_runners`] before any
3944/// demand request is issued (D19), so the `None` arm is unreachable rather than
3945/// merely unlikely. It returns an empty tally instead of unwrapping, because a
3946/// panic in the reconciliation loop would take the daemon down over a policy
3947/// that was only ever going to start nothing.
3948fn demand_for(policy: &ScalePolicy, reading: &QueuedDemand, host_labels: &[Label]) -> DemandTally {
3949    let Some(labels) = policy.routing_labels() else {
3950        debug_assert!(
3951            false,
3952            "a monitor-only policy is skipped before the demand poll (D19)"
3953        );
3954        return DemandTally::default();
3955    };
3956    let labels = labels.with_labels(host_labels.iter().cloned());
3957
3958    match &policy.target {
3959        ScaleTarget::Repository(repository) => labels.tally(reading.jobs_for(repository)),
3960        ScaleTarget::Organization(_) => labels.tally(reading.jobs()),
3961    }
3962}
3963
3964/// Tally one shared target reading using GitHub's required-label subset rule.
3965/// Refuse ambiguous ownership, including inactive local profiles: disabling an
3966/// isolated profile must not redirect its broad-label demand to a native sibling.
3967fn route_demand(
3968    all_policies: &[ScalePolicy],
3969    profiles: &[&ScalePolicy],
3970    reading: &QueuedDemand,
3971    host_labels: &[Label],
3972) -> (
3973    BTreeMap<PolicyId, DemandTally>,
3974    BTreeMap<RoutingRefusal, u32>,
3975) {
3976    let mut tallies: BTreeMap<PolicyId, DemandTally> = profiles
3977        .iter()
3978        .map(|policy| (policy.id, demand_for(policy, reading, host_labels)))
3979        .collect();
3980    let mut refusals: BTreeMap<RoutingRefusal, u32> = BTreeMap::new();
3981    let Some(first) = profiles.first() else {
3982        return (tallies, refusals);
3983    };
3984    // Each owner's labels as its runners carry them, host traits included.
3985    let owners: Vec<_> = all_policies
3986        .iter()
3987        .filter(|policy| policy.target == first.target && policy.host_id == first.host_id)
3988        .filter_map(|policy| {
3989            let labels = policy.routing_labels()?;
3990            Some((policy.id, labels.with_labels(host_labels.iter().cloned())))
3991        })
3992        .collect();
3993    let jobs: Vec<&runner_manager_domain::policy::RunsOn> = match &first.target {
3994        ScaleTarget::Repository(repository) => reading.jobs_for(repository).iter().collect(),
3995        ScaleTarget::Organization(_) => reading.jobs().collect(),
3996    };
3997    for job in jobs {
3998        if let Err(unresolvable) = job.required_labels() {
3999            // `demand_for` already preserves this as unresolvable for each
4000            // profile; an exclusion no runner can satisfy is also said, when
4001            // the job is otherwise meant for one of these profiles.
4002            if unresolvable.is_unsatisfiable_exclusion() {
4003                let meant = job.plain_labels();
4004                if !owners
4005                    .iter()
4006                    .any(|(_, labels)| meant.iter().all(|label| labels.contains(label)))
4007                {
4008                    continue;
4009                }
4010                *refusals
4011                    .entry(RoutingRefusal::UnsatisfiableExclusion)
4012                    .or_default() += 1;
4013            }
4014            continue;
4015        }
4016        let matched: Vec<PolicyId> = owners
4017            .iter()
4018            .filter(|(_, labels)| labels.matches(job).is_match())
4019            .map(|(id, _)| *id)
4020            .collect();
4021        if matched.len() > 1 {
4022            *refusals
4023                .entry(RoutingRefusal::OverlappingProfiles)
4024                .or_default() += 1;
4025            for id in matched {
4026                if let Some(tally) = tallies.get_mut(&id) {
4027                    tally.matched -= 1;
4028                    tally.not_matched += 1;
4029                }
4030            }
4031        }
4032    }
4033    (tallies, refusals)
4034}
4035
4036/// How urgently one failure should slow the loop down.
4037///
4038/// Ordering matters only for picking the worst of several targets: an outage
4039/// outranks a rate limit because backing off a socket that is not answering is
4040/// the safer error, and both outrank a per-target rejection that says nothing
4041/// about the credential as a whole.
4042const fn severity(state: &RefreshState) -> u8 {
4043    match state {
4044        RefreshState::Offline => 5,
4045        RefreshState::RateLimited(_) => 4,
4046        RefreshState::LockedOut { .. } => 3,
4047        RefreshState::Unauthorized => 2,
4048        RefreshState::Forbidden { .. } | RefreshState::Failed { .. } => 1,
4049        RefreshState::Cancelled | RefreshState::Ready(_) => 0,
4050    }
4051}
4052
4053/// Why one target could not be read, as a fixed, credential-free name.
4054///
4055/// Deliberately not a [`PollPace`]: a pace describes the *schedule*, which is a
4056/// property of the whole pass, and stamping one onto a single target would have
4057/// meant inventing a `consecutive` count for a target that has none. What an
4058/// event needs here is the reason, and `c3`'s [`RefreshState`] already names it.
4059///
4060/// `RefreshState::Failed` carries GitHub's own message and
4061/// `RefreshState::Forbidden` may carry one too. Neither reaches the event: this
4062/// returns the variant, for the reason [`failure_reason_kind`] states.
4063const fn unreadable_reason(state: &RefreshState) -> &'static str {
4064    match state {
4065        RefreshState::Ready(_) => "ready",
4066        RefreshState::Offline => "offline",
4067        RefreshState::RateLimited(_) => "rate_limited",
4068        RefreshState::LockedOut { .. } => "locked_out",
4069        RefreshState::Unauthorized => "unauthorized",
4070        RefreshState::Forbidden { .. } => "forbidden",
4071        RefreshState::Failed { .. } => "failed",
4072        RefreshState::Cancelled => "cancelled",
4073    }
4074}
4075
4076#[cfg(test)]
4077mod tests {
4078    use super::*;
4079
4080    /// The reading that said `healthy` for 28 hours while nothing worked.
4081    ///
4082    /// A daemon every one of whose targets answered `401` kept writing a fresh
4083    /// `last GitHub contact`, because an unauthorized target is `unreadable`
4084    /// rather than a `failure`. Both that record and the `service status` built
4085    /// on it were used as evidence during the investigation, and both were
4086    /// wrong; see `docs/spikes/token-expiry-and-renewal.md`.
4087    #[test]
4088    fn a_pass_that_reached_no_target_does_not_claim_it_reached_github() {
4089        let mut report = ReconcileReport::default();
4090        assert!(
4091            !report.reached_github(),
4092            "a pass that polled nothing -- every policy draining, owned elsewhere, or \
4093             monitor-only -- reached nobody. This is the case the old guard let through, and \
4094             the only one it ever let through."
4095        );
4096
4097        report.unreadable.push(PolicyId::from_u128(1));
4098        assert!(
4099            !report.reached_github(),
4100            "every target this pass tried was unreadable, so there is no contact to record"
4101        );
4102
4103        report.targets_read = 1;
4104        assert!(
4105            report.reached_github(),
4106            "one target answering is contact, whatever else failed alongside it"
4107        );
4108
4109        // `allocations` deliberately does not count: a policy this host does
4110        // not own is allocated for with no demand and without polling anything,
4111        // so a pass where every poll failed can still carry allocations.
4112        let mut unowned = ReconcileReport::default();
4113        unowned.unreadable.push(PolicyId::from_u128(2));
4114        unowned.allocations.push(Allocation {
4115            policy_id: PolicyId::from_u128(2),
4116            demand: 0,
4117            desired: 0,
4118            active_owned: 0,
4119            headroom_before: 0,
4120            to_start: 0,
4121            limiting_factor: LimitingFactor::Demand,
4122        });
4123        assert!(
4124            !unowned.reached_github(),
4125            "an allocation is not evidence that GitHub answered"
4126        );
4127    }
4128
4129    /// The claim the old guard rested on, checked rather than assumed.
4130    ///
4131    /// `report.failure.is_none()` was believed to be compatible with an
4132    /// all-unauthorized pass. It is not: `unreadable` is pushed only from the
4133    /// `Failed` arm and `failure` is the maximum over every `Failed` reading,
4134    /// so guarding on `failure.is_none() && reached_github()` would have been
4135    /// `failure.is_none()` with extra words. This pins the severity that makes
4136    /// it so, because a future `severity(Unauthorized) == 0` would quietly
4137    /// restore the belief.
4138    #[test]
4139    fn an_unauthorized_target_is_a_failure_and_not_merely_unreadable() {
4140        assert!(
4141            severity(&RefreshState::Unauthorized) > 0,
4142            "an unauthorized reading must survive `max_by_key(severity)` into `report.failure`, \
4143             or a pass where every target was refused would report no failure at all"
4144        );
4145    }
4146
4147    use std::sync::atomic::AtomicUsize;
4148
4149    use std::num::NonZeroU16;
4150
4151    use runner_manager_domain::attempt::PersistedAttempt;
4152    use runner_manager_domain::model::{CachePolicy, HostId};
4153    use runner_manager_domain::policy::PolicyMode;
4154    use runner_manager_domain::workspace::WorkspaceKind;
4155    use runner_manager_github::rest::RateLimited;
4156    use runner_manager_testkit::clock::FakeClock;
4157    use runner_manager_testkit::fixtures;
4158    use runner_manager_testkit::github::FakeGithub;
4159
4160    // =======================================================================
4161    // Fakes
4162    // =======================================================================
4163
4164    fn host_with(capacity: u16) -> Host {
4165        fixtures::host().capacity(capacity).build()
4166    }
4167
4168    fn repo(raw: &str) -> OwnerRepo {
4169        OwnerRepo::parse(raw).expect("a valid OWNER/REPO")
4170    }
4171
4172    /// An `active`, enabled autoscale policy on the fixture host.
4173    use runner_manager_domain::policy::{RoutingLabels, RunsOn};
4174
4175    fn policy(id: u128, target: &str, max: u16) -> ScalePolicy {
4176        fixtures::policy()
4177            .id(PolicyId::from_u128(id))
4178            .repository(target)
4179            .autoscale("home", max)
4180            .active()
4181            .build()
4182    }
4183
4184    /// The host label every policy in these tests carries.
4185    ///
4186    /// `policy` above builds through `fixtures::policy().autoscale("home", …)`,
4187    /// which derives `rm-home-win-x64`. A job fixture that did not carry it
4188    /// would be filtered out as another host's work, so the two are tied
4189    /// together here rather than repeated as a literal at each call site.
4190    const HOST_LABEL: &str = "rm-home-win-x64";
4191
4192    /// `n` queued jobs this host's policies match.
4193    ///
4194    /// The ordinary demand fixture. Since the reversal of the run-counting
4195    /// decision the unit `e1` clamps is a job, so a test wanting demand `n` asks
4196    /// for `n` jobs rather than for `n` runs.
4197    fn jobs(n: usize) -> Vec<RunsOn> {
4198        fixtures::queued_jobs(&[HOST_LABEL], n)
4199    }
4200
4201    /// `e3`, faked: an attempt table and a launch counter, no process anywhere.
4202    #[derive(Debug, Default)]
4203    struct FakeLauncher {
4204        capacity: Mutex<Option<NonZeroU16>>,
4205        capacity_unreadable: AtomicBool,
4206        capacity_after_launch: Mutex<Option<NonZeroU16>>,
4207        attempts: Mutex<Vec<RunnerAttempt>>,
4208        next_id: AtomicU64,
4209        launches: AtomicUsize,
4210        cleaned: Mutex<Vec<AttemptId>>,
4211        /// Yields this many times between reading the attempt set and recording
4212        /// a new one, so an unserialised allocator has a window to be wrong in.
4213        yields_before_recording: usize,
4214        /// Reports success without the attempt ever becoming visible, which is
4215        /// the shape a slow journal write has. Every grant then looks like the
4216        /// first.
4217        forgetful: bool,
4218        fail_next: Mutex<Option<FailureReason>>,
4219        /// Reports that the attempt set cannot be read at all, which is the one
4220        /// answer a caller must never confuse with an idle host.
4221        attempts_fail: Mutex<bool>,
4222        /// Refuses every cleanup, so the silent-retry path has something to be
4223        /// loud about.
4224        clean_fails: bool,
4225        replacements: Mutex<Vec<ReplacementIntent>>,
4226        /// The labels each launch's runner registers with, in launch order.
4227        registered: Mutex<Vec<Vec<String>>>,
4228    }
4229
4230    impl FakeLauncher {
4231        fn new() -> Self {
4232            Self::default()
4233        }
4234
4235        fn with_yields(mut self, yields: usize) -> Self {
4236            self.yields_before_recording = yields;
4237            self
4238        }
4239
4240        fn forgetful() -> Self {
4241            Self {
4242                forgetful: true,
4243                ..Self::default()
4244            }
4245        }
4246
4247        fn seeded(self, attempts: Vec<RunnerAttempt>) -> Self {
4248            *self.attempts.lock().unwrap() = attempts;
4249            self
4250        }
4251
4252        fn launches(&self) -> usize {
4253            self.launches.load(Ordering::SeqCst)
4254        }
4255
4256        fn snapshot(&self) -> Vec<RunnerAttempt> {
4257            self.attempts.lock().unwrap().clone()
4258        }
4259
4260        fn live_count(&self) -> usize {
4261            self.snapshot()
4262                .iter()
4263                .filter(|a| a.counts_against_capacity())
4264                .count()
4265        }
4266
4267        fn fail_next(&self, reason: FailureReason) {
4268            *self.fail_next.lock().unwrap() = Some(reason);
4269        }
4270
4271        fn fail_attempts(&self, failing: bool) {
4272            *self.attempts_fail.lock().unwrap() = failing;
4273        }
4274
4275        fn refusing_cleanup(attempts: Vec<RunnerAttempt>) -> Self {
4276            Self {
4277                clean_fails: true,
4278                ..Self::default()
4279            }
4280            .seeded(attempts)
4281        }
4282
4283        fn cleaned(&self) -> Vec<AttemptId> {
4284            self.cleaned.lock().unwrap().clone()
4285        }
4286
4287        fn replacing(self, intent: ReplacementIntent) -> Self {
4288            self.replacements.lock().unwrap().push(intent);
4289            self
4290        }
4291    }
4292
4293    #[async_trait::async_trait]
4294    impl RunnerLauncher for FakeLauncher {
4295        async fn host_capacity(&self, host: &Host) -> Result<NonZeroU16, HostCapacityError> {
4296            if self.capacity_unreadable.load(Ordering::SeqCst) {
4297                return Err(HostCapacityError::JournalUnreadable);
4298            }
4299            Ok(self.capacity.lock().unwrap().unwrap_or(host.host_capacity))
4300        }
4301
4302        async fn supervise(
4303            &self,
4304            policy: &ScalePolicy,
4305        ) -> Result<Vec<ReplacementIntent>, LaunchFailure> {
4306            let mut replacements = self.replacements.lock().unwrap();
4307            let selected: Vec<_> = replacements
4308                .extract_if(.., |intent| intent.policy == policy.id)
4309                .collect();
4310            if !selected.is_empty() {
4311                let retired: BTreeSet<_> = selected
4312                    .iter()
4313                    .map(|intent| intent.previous_attempt)
4314                    .collect();
4315                self.attempts
4316                    .lock()
4317                    .unwrap()
4318                    .retain(|attempt| !retired.contains(&attempt.id));
4319            }
4320            Ok(selected)
4321        }
4322
4323        async fn attempts(&self) -> Result<Vec<RunnerAttempt>, LaunchFailure> {
4324            if *self.attempts_fail.lock().unwrap() {
4325                return Err(LaunchFailure::new(FailureReason::Other(
4326                    "the journal could not be read".into(),
4327                )));
4328            }
4329            Ok(self.snapshot())
4330        }
4331
4332        async fn launch(&self, request: LaunchRequest<'_>) -> Result<RunnerAttempt, LaunchFailure> {
4333            if let Some(reason) = self.fail_next.lock().unwrap().take() {
4334                return Err(LaunchFailure::new(reason));
4335            }
4336            // The window an unserialised caller would lose the race in.
4337            for _ in 0..self.yields_before_recording {
4338                tokio::task::yield_now().await;
4339            }
4340            let id =
4341                AttemptId::from_u128(u128::from(self.next_id.fetch_add(1, Ordering::SeqCst) + 1));
4342            let created = RunnerAttempt::allocate(
4343                id,
4344                request.policy.id,
4345                "runtime/p/a",
4346                request.host.created_at,
4347            );
4348            self.registered.lock().unwrap().push(
4349                request
4350                    .policy
4351                    .routing_labels()
4352                    .map(RoutingLabels::as_registration_labels)
4353                    .unwrap_or_default(),
4354            );
4355            self.launches.fetch_add(1, Ordering::SeqCst);
4356            if let Some(capacity) = self.capacity_after_launch.lock().unwrap().take() {
4357                *self.capacity.lock().unwrap() = Some(capacity);
4358            }
4359            if !self.forgetful {
4360                self.attempts.lock().unwrap().push(created.clone());
4361            }
4362            Ok(created)
4363        }
4364
4365        async fn clean(&self, attempt: AttemptId) -> Result<(), LaunchFailure> {
4366            if self.clean_fails {
4367                return Err(LaunchFailure::new(FailureReason::Other(
4368                    "the runtime directory is locked".into(),
4369                )));
4370            }
4371            self.cleaned.lock().unwrap().push(attempt);
4372            let mut attempts = self.attempts.lock().unwrap();
4373            attempts.retain(|a| a.id != attempt);
4374            Ok(())
4375        }
4376    }
4377
4378    /// A demand source a test programs directly, with no gateway underneath.
4379    #[derive(Debug, Default)]
4380    struct FakeDemand {
4381        outcome: Mutex<Option<PollOutcome>>,
4382        /// Answers programmed for one target, which beat the blanket one.
4383        per_target: Mutex<BTreeMap<ScaleTarget, PollOutcome>>,
4384        scopes: Mutex<Vec<ActivityScope>>,
4385    }
4386
4387    impl FakeDemand {
4388        fn ready(count: u32, repository: &OwnerRepo) -> Self {
4389            let fake = Self::default();
4390            fake.set(PollOutcome::Ready(QueuedDemand::of(
4391                repository.clone(),
4392                jobs(count as usize),
4393            )));
4394            fake
4395        }
4396
4397        fn failing(state: RefreshState) -> Self {
4398            let fake = Self::default();
4399            fake.set(PollOutcome::Failed(state));
4400            fake
4401        }
4402
4403        fn set(&self, outcome: PollOutcome) {
4404            *self.outcome.lock().unwrap() = Some(outcome);
4405        }
4406
4407        /// Program one target's answer, overriding the blanket one.
4408        fn set_for(&self, target: &ScaleTarget, outcome: PollOutcome) {
4409            self.per_target
4410                .lock()
4411                .unwrap()
4412                .insert(target.clone(), outcome);
4413        }
4414
4415        fn polls(&self) -> Vec<ActivityScope> {
4416            self.scopes.lock().unwrap().clone()
4417        }
4418    }
4419
4420    #[async_trait::async_trait]
4421    impl DemandSource for FakeDemand {
4422        async fn poll(&self, scope: &ActivityScope) -> PollOutcome {
4423            self.scopes.lock().unwrap().push(scope.clone());
4424            if let Some(outcome) = self.per_target.lock().unwrap().get(scope.target()) {
4425                return outcome.clone();
4426            }
4427            self.outcome
4428                .lock()
4429                .unwrap()
4430                .clone()
4431                .unwrap_or(PollOutcome::Ready(QueuedDemand::default()))
4432        }
4433    }
4434
4435    #[derive(Debug, Default)]
4436    struct FakeDirectory {
4437        repositories: Vec<OwnerRepo>,
4438        calls: AtomicUsize,
4439    }
4440
4441    impl FakeDirectory {
4442        fn of(repositories: Vec<OwnerRepo>) -> Self {
4443            Self {
4444                repositories,
4445                calls: AtomicUsize::new(0),
4446            }
4447        }
4448
4449        fn calls(&self) -> usize {
4450            self.calls.load(Ordering::SeqCst)
4451        }
4452    }
4453
4454    #[async_trait::async_trait]
4455    impl RepositoryDirectory for FakeDirectory {
4456        async fn repositories(&self, _org: &Org) -> Result<Vec<OwnerRepo>, InventoryError> {
4457            self.calls.fetch_add(1, Ordering::SeqCst);
4458            Ok(self.repositories.clone())
4459        }
4460    }
4461
4462    /// A lock that grants everything and counts how many holders it had at once.
4463    ///
4464    /// The counter is the assertion: "under simulated lock contention" is only
4465    /// meaningful if something measures that the contention was actually
4466    /// serialised.
4467    #[derive(Debug)]
4468    struct CountingLock {
4469        inner: InProcessAllocationLock,
4470        concurrent: Arc<AtomicUsize>,
4471        peak: Arc<AtomicUsize>,
4472        acquisitions: Arc<AtomicUsize>,
4473    }
4474
4475    impl CountingLock {
4476        fn new() -> Self {
4477            Self {
4478                inner: InProcessAllocationLock::new(),
4479                concurrent: Arc::new(AtomicUsize::new(0)),
4480                peak: Arc::new(AtomicUsize::new(0)),
4481                acquisitions: Arc::new(AtomicUsize::new(0)),
4482            }
4483        }
4484
4485        fn peak(&self) -> usize {
4486            self.peak.load(Ordering::SeqCst)
4487        }
4488
4489        fn acquisitions(&self) -> usize {
4490            self.acquisitions.load(Ordering::SeqCst)
4491        }
4492    }
4493
4494    #[derive(Debug)]
4495    struct CountingGuard {
4496        _inner: AllocationGuard,
4497        concurrent: Arc<AtomicUsize>,
4498    }
4499
4500    impl Drop for CountingGuard {
4501        fn drop(&mut self) {
4502            self.concurrent.fetch_sub(1, Ordering::SeqCst);
4503        }
4504    }
4505
4506    #[async_trait::async_trait]
4507    impl AllocationLock for CountingLock {
4508        async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
4509            let inner = self.inner.acquire().await?;
4510            self.acquisitions.fetch_add(1, Ordering::SeqCst);
4511            let now = self.concurrent.fetch_add(1, Ordering::SeqCst) + 1;
4512            self.peak.fetch_max(now, Ordering::SeqCst);
4513            Ok(AllocationGuard::new(CountingGuard {
4514                _inner: inner,
4515                concurrent: Arc::clone(&self.concurrent),
4516            }))
4517        }
4518    }
4519
4520    /// The lock that is not one: what the host looks like with the serialisation
4521    /// removed. Used only by the control half of the contention test.
4522    #[derive(Debug, Default)]
4523    struct NoLock;
4524
4525    #[async_trait::async_trait]
4526    impl AllocationLock for NoLock {
4527        async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
4528            Ok(AllocationGuard::new(()))
4529        }
4530    }
4531
4532    #[tokio::test]
4533    async fn a_wsl_drain_request_fences_the_exact_pre_launch_boundary() {
4534        use runner_manager_platform::wsl::fence::DrainRequest;
4535
4536        let (_local, shared, paths) = guest_paths();
4537        DrainRequest::new(4, chrono::Utc::now())
4538            .write(shared.path())
4539            .unwrap();
4540        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4541
4542        assert!(lock.acquire().await.is_err());
4543    }
4544
4545    #[tokio::test]
4546    async fn a_guest_launch_claim_is_released_with_its_allocation_guard() {
4547        use runner_manager_platform::wsl::fence::FENCE_DIRECTORY;
4548
4549        let (_local, shared, paths) = guest_paths();
4550        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4551        let guard = lock.acquire().await.unwrap();
4552        assert!(shared.path().join(FENCE_DIRECTORY).exists());
4553        drop(guard);
4554        assert!(!shared.path().join(FENCE_DIRECTORY).exists());
4555    }
4556
4557    /// Captures what `tracing` writes on this thread.
4558    #[derive(Clone, Default)]
4559    struct Logs(Arc<Mutex<Vec<u8>>>);
4560
4561    impl std::io::Write for Logs {
4562        fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
4563            self.0.lock().unwrap().extend_from_slice(buf);
4564            Ok(buf.len())
4565        }
4566        fn flush(&mut self) -> std::io::Result<()> {
4567            Ok(())
4568        }
4569    }
4570
4571    /// The release that once failed with no trace while a distribution
4572    /// started nothing for 13 days is now in the log, with its path.
4573    #[tokio::test]
4574    async fn a_launch_fence_that_cannot_be_released_is_logged_with_its_path() {
4575        use runner_manager_platform::wsl::fence::FENCE_DIRECTORY;
4576
4577        let (_local, shared, paths) = guest_paths();
4578        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4579        let guard = lock.acquire().await.unwrap();
4580        // Something the removal cannot take away: a file where the claim
4581        // directory was.
4582        let fence = shared.path().join(FENCE_DIRECTORY);
4583        std::fs::remove_dir_all(&fence).unwrap();
4584        std::fs::write(&fence, b"not a directory").unwrap();
4585
4586        let logs = Logs::default();
4587        let writer = logs.clone();
4588        let subscriber = tracing_subscriber::fmt()
4589            .with_writer(move || writer.clone())
4590            .with_ansi(false)
4591            .finish();
4592        tracing::subscriber::with_default(subscriber, || drop(guard));
4593
4594        let text = String::from_utf8(logs.0.lock().unwrap().clone()).unwrap();
4595        assert!(text.contains("WARN"), "{text}");
4596        assert!(text.contains("could not be released"), "{text}");
4597        assert!(text.contains(FENCE_DIRECTORY), "the path is named: {text}");
4598    }
4599
4600    fn guest_paths() -> (
4601        tempfile::TempDir,
4602        tempfile::TempDir,
4603        Arc<runner_manager_platform::paths::AppPaths>,
4604    ) {
4605        use runner_manager_platform::paths::AppPaths;
4606        use runner_manager_platform::wsl::fence::GuestRecoveryConfig;
4607
4608        let local = tempfile::tempdir().unwrap();
4609        let shared = tempfile::tempdir().unwrap();
4610        let paths = Arc::new(AppPaths::rooted_at(local.path()));
4611        paths.create_all().unwrap();
4612        GuestRecoveryConfig::new(shared.path().to_path_buf())
4613            .write(&paths)
4614            .unwrap();
4615        (local, shared, paths)
4616    }
4617
4618    /// The incident end to end: a guest claim left by a daemon of an earlier
4619    /// WSL boot no longer stops a launch.
4620    #[tokio::test]
4621    async fn a_stale_guest_claim_no_longer_blocks_the_next_launch() {
4622        use runner_manager_platform::wsl::fence::{FENCE_DIRECTORY, OWNER_FILE};
4623
4624        let (_local, shared, paths) = guest_paths();
4625        let fence = shared.path().join(FENCE_DIRECTORY);
4626        std::fs::create_dir_all(&fence).unwrap();
4627        let pid = std::process::id();
4628        std::fs::write(
4629            fence.join(OWNER_FILE),
4630            format!(
4631                r#"{{"schema_version":1,"kind":"guest_launch","generation":null,"process_id":{pid},"acquired_at":"2026-09-24T00:47:18.724Z","identity":{{"pid":{pid},"start_token":"linux:earlier-boot:1"}}}}"#
4632            ),
4633        )
4634        .unwrap();
4635        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4636
4637        let guard = lock.acquire().await.expect("the stale claim was reclaimed");
4638        drop(guard);
4639        assert!(!fence.exists());
4640    }
4641
4642    #[tokio::test]
4643    async fn refusals_that_persist_are_recorded_and_a_grant_clears_them() {
4644        use runner_manager_platform::launch_health::recorded_launches_blocked;
4645        use runner_manager_platform::wsl::fence::{FenceClaim, FenceOwnerKind};
4646
4647        let (_local, shared, paths) = guest_paths();
4648        let lock = WslRecoveryAllocationLock::new(Arc::clone(&paths), Arc::new(NoLock))
4649            .with_blocked_after(3, Duration::ZERO);
4650        // Windows owns the fence, so every guest launch is refused.
4651        let windows =
4652            FenceClaim::try_claim(shared.path(), FenceOwnerKind::WindowsRecovery, Some(1))
4653                .unwrap()
4654                .unwrap();
4655
4656        for _ in 0..2 {
4657            assert!(lock.acquire().await.is_err());
4658        }
4659        assert_eq!(
4660            recorded_launches_blocked(&paths, chrono::Utc::now()).unwrap(),
4661            None,
4662            "not yet"
4663        );
4664        assert!(lock.acquire().await.is_err());
4665        let blocked = recorded_launches_blocked(&paths, chrono::Utc::now())
4666            .unwrap()
4667            .expect("three refusals in a row are recorded");
4668        assert!(
4669            blocked.reason.contains("Windows WSL recovery"),
4670            "{blocked:?}"
4671        );
4672
4673        windows.release().unwrap();
4674        let guard = lock.acquire().await.unwrap();
4675        assert_eq!(
4676            recorded_launches_blocked(&paths, chrono::Utc::now()).unwrap(),
4677            None
4678        );
4679        drop(guard);
4680    }
4681
4682    #[tokio::test]
4683    async fn refusals_while_this_process_is_launching_are_its_own_contention() {
4684        use runner_manager_platform::launch_health::recorded_launches_blocked;
4685
4686        use runner_manager_platform::wsl::fence::DrainRequest;
4687
4688        let (_local, shared, paths) = guest_paths();
4689        let lock = WslRecoveryAllocationLock::new(Arc::clone(&paths), Arc::new(NoLock))
4690            .with_blocked_after(1, Duration::ZERO);
4691        let launching = lock.acquire().await.unwrap();
4692        DrainRequest::new(1, chrono::Utc::now())
4693            .write(shared.path())
4694            .unwrap();
4695        for _ in 0..3 {
4696            assert!(lock.acquire().await.is_err());
4697        }
4698        assert_eq!(
4699            recorded_launches_blocked(&paths, chrono::Utc::now()).unwrap(),
4700            None
4701        );
4702        drop(launching);
4703    }
4704
4705    /// The launches of this process share the guest claim from reservation to
4706    /// runner: the other target's launch is not refused, and Windows gets the
4707    /// directory only when the last has ended.
4708    #[tokio::test]
4709    async fn launches_in_progress_share_the_fence_until_the_last_ends() {
4710        use runner_manager_platform::wsl::fence::{DrainRequest, FenceClaim, FenceOwnerKind};
4711
4712        let (_local, shared, paths) = guest_paths();
4713        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4714        let claimed = |root: &std::path::Path| FenceClaim::owner(root).unwrap().is_some();
4715
4716        let first = lock.acquire().await.unwrap();
4717        let first_runner = first.launch_hold();
4718        drop(first);
4719        assert!(claimed(shared.path()), "held while its runner comes up");
4720
4721        let claimed_at = FenceClaim::owner(shared.path())
4722            .unwrap()
4723            .unwrap()
4724            .acquired_at;
4725        tokio::time::sleep(Duration::from_millis(5)).await;
4726        let second = lock.acquire().await.expect("this process owns the fence");
4727        assert!(
4728            FenceClaim::owner(shared.path())
4729                .unwrap()
4730                .unwrap()
4731                .acquired_at
4732                > claimed_at,
4733            "a claim launches keep sharing is not one stuck for that long"
4734        );
4735        let second_runner = second.launch_hold();
4736        drop(second);
4737        drop(first_runner);
4738        assert!(claimed(shared.path()), "the other launch is still running");
4739
4740        // A drain stops new launches and lets the one in progress finish.
4741        DrainRequest::new(1, chrono::Utc::now())
4742            .write(shared.path())
4743            .unwrap();
4744        assert!(lock.acquire().await.is_err());
4745        assert!(claimed(shared.path()));
4746        assert!(
4747            FenceClaim::try_claim(shared.path(), FenceOwnerKind::WindowsRecovery, Some(1))
4748                .unwrap()
4749                .is_none()
4750        );
4751        drop(second_runner);
4752        assert!(!claimed(shared.path()), "the last one lets it go");
4753        assert!(
4754            FenceClaim::try_claim(shared.path(), FenceOwnerKind::WindowsRecovery, Some(1))
4755                .unwrap()
4756                .is_some()
4757        );
4758    }
4759
4760    /// Refusals separated by quiet spells -- brief contention days apart --
4761    /// never add up to a blocked host.
4762    #[tokio::test]
4763    async fn refusals_with_quiet_spells_between_them_never_add_up() {
4764        use runner_manager_platform::launch_health::recorded_launches_blocked;
4765        use runner_manager_platform::wsl::fence::{FenceClaim, FenceOwnerKind};
4766
4767        let (_local, shared, paths) = guest_paths();
4768        let lock = WslRecoveryAllocationLock::new(Arc::clone(&paths), Arc::new(NoLock))
4769            .with_blocked_after(3, Duration::ZERO)
4770            .with_streak_gap(Duration::ZERO);
4771        let windows =
4772            FenceClaim::try_claim(shared.path(), FenceOwnerKind::WindowsRecovery, Some(1))
4773                .unwrap()
4774                .unwrap();
4775        for _ in 0..5 {
4776            assert!(lock.acquire().await.is_err());
4777        }
4778        assert_eq!(
4779            recorded_launches_blocked(&paths, chrono::Utc::now()).unwrap(),
4780            None
4781        );
4782        windows.release().unwrap();
4783    }
4784
4785    /// A drain request refuses the launch after the claim was made; that
4786    /// claim is released rather than left to block the next pass.
4787    #[tokio::test]
4788    async fn a_claim_refused_by_a_drain_request_is_released() {
4789        use runner_manager_platform::wsl::fence::{DrainRequest, FENCE_DIRECTORY};
4790
4791        let (_local, shared, paths) = guest_paths();
4792        DrainRequest::new(4, chrono::Utc::now())
4793            .write(shared.path())
4794            .unwrap();
4795        let lock = WslRecoveryAllocationLock::new(paths, Arc::new(NoLock));
4796        assert!(lock.acquire().await.is_err());
4797        assert!(!shared.path().join(FENCE_DIRECTORY).exists());
4798    }
4799
4800    /// A lock nobody can take.
4801    #[derive(Debug, Default)]
4802    struct HeldLock;
4803
4804    #[async_trait::async_trait]
4805    impl AllocationLock for HeldLock {
4806        async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
4807            Err(AllocationLockBusy)
4808        }
4809    }
4810
4811    /// Everything one test needs, wired together.
4812    struct Harness {
4813        launcher: Arc<FakeLauncher>,
4814        demand: Arc<FakeDemand>,
4815        events: Arc<EventLog>,
4816        clock: Arc<FakeClock>,
4817        reconciler: Reconciler,
4818    }
4819
4820    impl Harness {
4821        fn build(
4822            host: Host,
4823            launcher: Arc<FakeLauncher>,
4824            demand: Arc<FakeDemand>,
4825            lock: Arc<dyn AllocationLock>,
4826        ) -> Self {
4827            let events = Arc::new(EventLog::new());
4828            let clock = Arc::new(FakeClock::default());
4829            let reconciler = Reconciler::new(
4830                host,
4831                ReconcilerPorts {
4832                    demand: Arc::clone(&demand) as Arc<dyn DemandSource>,
4833                    launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
4834                    lock,
4835                    directory: Arc::new(FakeDirectory::default()),
4836                    clock: Arc::clone(&clock) as Arc<dyn Clock>,
4837                    jitter: Arc::new(NoJitter) as Arc<dyn Jitter>,
4838                    events: Arc::clone(&events) as Arc<dyn EventSink>,
4839                },
4840            );
4841            Self {
4842                launcher,
4843                demand,
4844                events,
4845                clock,
4846                reconciler,
4847            }
4848        }
4849
4850        fn simple(capacity: u16, demand_count: u32, target: &str) -> Self {
4851            let launcher = Arc::new(FakeLauncher::new());
4852            let demand = Arc::new(FakeDemand::ready(demand_count, &repo(target)));
4853            Self::build(
4854                host_with(capacity),
4855                launcher,
4856                demand,
4857                Arc::new(InProcessAllocationLock::new()),
4858            )
4859        }
4860    }
4861
4862    fn attempt_in(state: AttemptState, id: u128, policy: u128) -> RunnerAttempt {
4863        let outcome = state.is_terminal().then(|| match state {
4864            AttemptState::Failed => {
4865                AttemptOutcome::failed(FailureReason::ProcessExitedUnexpectedly)
4866            }
4867            AttemptState::Orphaned => AttemptOutcome::Orphaned,
4868            _ => AttemptOutcome::CompletedJob,
4869        });
4870        RunnerAttempt::from_persisted(PersistedAttempt {
4871            id: AttemptId::from_u128(id),
4872            policy_id: PolicyId::from_u128(policy),
4873            github_runner_id: None,
4874            state,
4875            outcome,
4876            process_id: None,
4877            execution: runner_manager_domain::execution::AttemptExecution::Native {
4878                process_id: None,
4879            },
4880            runtime_path: "runtime/p/a".into(),
4881            workspace_kind: WorkspaceKind::Ephemeral,
4882            workspace_slot: None,
4883            created_at: fixtures::created_at(),
4884            terminal_at: state.is_terminal().then(fixtures::created_at),
4885            last_state_change_at: fixtures::created_at(),
4886        })
4887        .expect("a state/outcome pair the domain accepts")
4888    }
4889
4890    /// A concluded attempt carrying a specific outcome.
4891    fn concluded(id: u128, policy: u128, outcome: AttemptOutcome) -> RunnerAttempt {
4892        RunnerAttempt::from_persisted(PersistedAttempt {
4893            id: AttemptId::from_u128(id),
4894            policy_id: PolicyId::from_u128(policy),
4895            github_runner_id: None,
4896            state: outcome.terminal_state(),
4897            outcome: Some(outcome),
4898            process_id: None,
4899            execution: runner_manager_domain::execution::AttemptExecution::Native {
4900                process_id: None,
4901            },
4902            runtime_path: "runtime/p/a".into(),
4903            workspace_kind: WorkspaceKind::Ephemeral,
4904            workspace_slot: None,
4905            created_at: fixtures::created_at(),
4906            terminal_at: Some(fixtures::created_at()),
4907            last_state_change_at: fixtures::created_at(),
4908        })
4909        .expect("a state/outcome pair the domain accepts")
4910    }
4911
4912    // =======================================================================
4913    // The in-flight term: the single most likely way this task goes wrong
4914    // =======================================================================
4915
4916    /// `e1`'s Definition of Done, verbatim: *"A job that remains `queued` across
4917    /// three consecutive polls while its attempt is `starting` yields exactly
4918    /// one attempt — the test fails if the in-flight term is dropped from the
4919    /// formula."*
4920    ///
4921    /// `b1` tests the arithmetic underneath this
4922    /// (`capacity::tests::the_same_queued_job_on_two_polls_yields_one_attempt_
4923    /// not_two`). What *this* test covers is the only way `e1` can drop the
4924    /// term without touching `b1` at all: handing the allocator an attempt set
4925    /// that is not the one the host holds.
4926    ///
4927    /// # This was measured, not assumed, and the first measurement was worse
4928    /// # than the failure it was looking for
4929    ///
4930    /// Replacing `self.launcher.attempts().await` in
4931    /// [`Reconciler::start_runners`] with `Vec::new()` compiles and runs. Before
4932    /// that function carried a budget, this test did not go red — it **never
4933    /// returned**: every grant looked like the first, so the pass started
4934    /// runners forever inside poll 1. That is the runaway-runner failure exactly
4935    /// as an operator would meet it, and it is why the budget exists.
4936    ///
4937    /// With the budget in place the same injection fails cleanly and says what
4938    /// happened: `poll 2 … left: 2, right: 1`. Both measurements were run
4939    /// before this assertion was written.
4940    #[tokio::test]
4941    async fn three_polls_of_one_still_queued_run_yield_exactly_one_attempt() {
4942        let mut harness = Harness::simple(4, 1, "acme/app");
4943        let policy = policy(1, "acme/app", 4);
4944
4945        for poll in 1..=3 {
4946            let report = harness
4947                .reconciler
4948                .reconcile(std::slice::from_ref(&policy))
4949                .await;
4950            assert_eq!(
4951                harness.launcher.launches(),
4952                1,
4953                "poll {poll} started another runner for a job already being served; the \
4954                 `- active_owned_runners` term reached `HostAllocator` as a set this host \
4955                 does not hold"
4956            );
4957            assert_eq!(report.allocations.len(), 1);
4958            let allocation = &report.allocations[0];
4959            assert_eq!(allocation.demand, 1, "poll {poll}: still queued at GitHub");
4960            if poll == 1 {
4961                assert_eq!(allocation.to_start, 1);
4962                assert_eq!(report.started, 1);
4963            } else {
4964                assert_eq!(allocation.active_owned, 1, "poll {poll}");
4965                assert_eq!(allocation.to_start, 0, "poll {poll}");
4966                assert_eq!(report.started, 0, "poll {poll}");
4967            }
4968        }
4969        assert_eq!(harness.launcher.live_count(), 1);
4970    }
4971
4972    #[tokio::test]
4973    async fn draining_parallel_workflow_starts_runners_for_the_remaining_queue() {
4974        let mut harness = Harness::simple(10, 8, "acme/app");
4975        let policy = policy(1, "acme/app", 10);
4976        let first = harness
4977            .reconciler
4978            .reconcile(std::slice::from_ref(&policy))
4979            .await;
4980        assert_eq!(first.started, 8);
4981
4982        // Five jobs finish while three longer jobs keep their runners busy.
4983        let attempts = harness.launcher.snapshot();
4984        *harness.launcher.attempts.lock().unwrap() = attempts
4985            .iter()
4986            .take(3)
4987            .map(|attempt| attempt_in(AttemptState::Busy, attempt.id.as_uuid().as_u128(), 1))
4988            .collect();
4989        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
4990            repo("acme/app"),
4991            jobs(2),
4992        )));
4993
4994        for poll in 0..3 {
4995            let report = harness
4996                .reconciler
4997                .reconcile(std::slice::from_ref(&policy))
4998                .await;
4999            assert_eq!(report.started, if poll == 0 { 2 } else { 0 });
5000            assert_eq!(harness.launcher.live_count(), 5);
5001        }
5002    }
5003
5004    /// The other half of the measurement above: the loop must terminate even
5005    /// when the attempt set never catches up with it.
5006    ///
5007    /// Dropping the in-flight term made
5008    /// `three_polls_of_one_still_queued_run_yield_exactly_one_attempt` hang
5009    /// rather than fail — the loop had one stopping condition and it was the one
5010    /// the bug removed. A launcher whose journal write has not landed presents
5011    /// exactly the same shape without any bug at all, so the budget in
5012    /// [`Reconciler::start_runners`] bounds the pass structurally. This is what
5013    /// asserts the bound is really there.
5014    #[tokio::test]
5015    async fn a_launcher_whose_attempts_never_appear_cannot_wedge_the_pass() {
5016        let launcher = Arc::new(FakeLauncher::forgetful());
5017        let mut harness = Harness::build(
5018            host_with(64),
5019            Arc::clone(&launcher),
5020            Arc::new(FakeDemand::ready(3, &repo("acme/app"))),
5021            Arc::new(InProcessAllocationLock::new()),
5022        );
5023
5024        let report = harness
5025            .reconciler
5026            .reconcile(&[policy(1, "acme/app", 8)])
5027            .await;
5028
5029        assert_eq!(
5030            report.started, 3,
5031            "the pass is bounded by the grant it was given, not by the attempt set catching \
5032             up with it"
5033        );
5034        assert_eq!(launcher.launches(), 3);
5035        assert!(
5036            launcher.snapshot().is_empty(),
5037            "the launcher never recorded anything, which is the whole point of the fixture"
5038        );
5039    }
5040
5041    /// The host-wide ceiling must hold across policies even when the launcher
5042    /// lags, and the per-policy budget alone does not reach that case.
5043    ///
5044    /// Review found this, with this file's own `forgetful` fixture and one more
5045    /// policy: the budget bounds *each policy's* loop to its own first grant,
5046    /// but policy B's first grant is computed from a set that does not yet
5047    /// contain policy A's launches, so B's bound is itself too large. Two
5048    /// policies on a host of three started **six** runners --
5049    /// `host_capacity=3, started=6, launches=6` -- with the lock held correctly
5050    /// throughout. Serialisation was never the problem; the arithmetic under it
5051    /// was reading a stale set.
5052    #[tokio::test]
5053    async fn two_policies_cannot_exceed_host_capacity_even_when_the_launcher_lags() {
5054        let launcher = Arc::new(FakeLauncher::forgetful());
5055        let demand = Arc::new(FakeDemand::default());
5056        demand.set_for(
5057            &ScaleTarget::repository("acme/left").unwrap(),
5058            PollOutcome::Ready(QueuedDemand::of(repo("acme/left"), jobs(3))),
5059        );
5060        demand.set_for(
5061            &ScaleTarget::repository("acme/right").unwrap(),
5062            PollOutcome::Ready(QueuedDemand::of(repo("acme/right"), jobs(3))),
5063        );
5064        let mut harness = Harness::build(
5065            host_with(3),
5066            Arc::clone(&launcher),
5067            demand,
5068            Arc::new(InProcessAllocationLock::new()),
5069        );
5070
5071        let report = harness
5072            .reconciler
5073            .reconcile(&[policy(1, "acme/left", 3), policy(2, "acme/right", 3)])
5074            .await;
5075
5076        assert_eq!(
5077            report.started, 3,
5078            "host_capacity is 3 and two policies each allowed 3 started {} runners \
5079             between them; the second policy's grant was computed from a set that did \
5080             not yet contain the first policy's launches",
5081            report.started
5082        );
5083        assert_eq!(launcher.launches(), 3);
5084    }
5085
5086    /// Finding 1: an attempt set that cannot be read is not an empty one.
5087    ///
5088    /// `attempts()` used to be infallible, which left `e3` — reading a journal
5089    /// off a disk — a choice between panicking and answering `vec![]`. The
5090    /// second is silent and catastrophic: an empty set is indistinguishable from
5091    /// an idle host, so a transient read failure reads as "nothing is running"
5092    /// and the pass allocates the whole machine for jobs already being served.
5093    ///
5094    /// The contrast is the assertion. Identical host, identical demand,
5095    /// identical policy; the only difference is whether the launcher can answer.
5096    #[tokio::test]
5097    async fn an_unreadable_attempt_set_starts_nothing_and_is_not_read_as_an_idle_host() {
5098        let launcher = Arc::new(FakeLauncher::new());
5099        let mut harness = Harness::build(
5100            host_with(8),
5101            Arc::clone(&launcher),
5102            Arc::new(FakeDemand::ready(4, &repo("acme/app"))),
5103            Arc::new(InProcessAllocationLock::new()),
5104        );
5105        let policy = policy(1, "acme/app", 8);
5106
5107        launcher.fail_attempts(true);
5108        let unreadable = harness
5109            .reconciler
5110            .reconcile(std::slice::from_ref(&policy))
5111            .await;
5112
5113        assert_eq!(
5114            unreadable.started, 0,
5115            "nothing may be decided from a set that was not read"
5116        );
5117        assert_eq!(launcher.launches(), 0);
5118        assert!(unreadable.attempts_unreadable > 0, "and the pass says so");
5119        assert!(
5120            unreadable.allocations.is_empty(),
5121            "no allocation is reported either: there was no set to compute one from, and \
5122             an allocation of zero would claim a decision nobody made"
5123        );
5124        assert!(harness.events.count_of("attempts_unreadable") > 0);
5125
5126        // The same everything, with a launcher that can answer.
5127        launcher.fail_attempts(false);
5128        let readable = harness
5129            .reconciler
5130            .reconcile(std::slice::from_ref(&policy))
5131            .await;
5132        assert_eq!(
5133            readable.started, 4,
5134            "the difference between the two passes is only whether the set could be read"
5135        );
5136        assert_eq!(readable.attempts_unreadable, 0);
5137    }
5138
5139    /// Finding 3: a cleanup that can never succeed was an invisible permanent
5140    /// loop.
5141    ///
5142    /// `if …clean(…).await.is_ok()` had no `else`, so a runtime directory that
5143    /// could not be removed was retried on every poll with no event, no counter
5144    /// and no report field. It wedges no capacity — a terminal attempt already
5145    /// stopped counting — but `clean` returns a `Result` precisely so the caller
5146    /// can say something, and this module's organising principle is the things
5147    /// that go wrong silently.
5148    #[tokio::test]
5149    async fn a_cleanup_that_cannot_succeed_is_reported_rather_than_retried_in_silence() {
5150        let launcher = Arc::new(FakeLauncher::refusing_cleanup(vec![concluded(
5151            1,
5152            1,
5153            AttemptOutcome::ExitedIdleWithoutWork,
5154        )]));
5155        let mut harness = Harness::build(
5156            host_with(4),
5157            Arc::clone(&launcher),
5158            Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
5159            Arc::new(InProcessAllocationLock::new()),
5160        );
5161
5162        let report = harness
5163            .reconciler
5164            .reconcile(&[policy(1, "acme/app", 4)])
5165            .await;
5166
5167        assert_eq!(report.cleaned, 0);
5168        assert_eq!(report.clean_failures, 1);
5169        assert_eq!(harness.events.count_of("attempt_clean_failed"), 1);
5170        assert_eq!(
5171            harness.events.count_of("attempt_cleaned"),
5172            0,
5173            "and it is not reported as cleaned"
5174        );
5175        assert_eq!(
5176            launcher.snapshot().len(),
5177            1,
5178            "the attempt is still there, so the retry is real -- what changed is that it \
5179             is no longer silent"
5180        );
5181
5182        // The reason is the variant, never the detail: the fixture's failure
5183        // carries free text and none of it reaches the event.
5184        let reasons: Vec<&'static str> = harness
5185            .events
5186            .events()
5187            .into_iter()
5188            .filter_map(|event| match event {
5189                LifecycleEvent::AttemptCleanFailed { reason, .. } => Some(reason),
5190                _ => None,
5191            })
5192            .collect();
5193        assert_eq!(reasons, vec!["other"]);
5194    }
5195
5196    /// A cleanup that keeps failing is retried with per-attempt exponential
5197    /// backoff rather than on every pass, and a success forgets the backoff.
5198    #[tokio::test]
5199    async fn a_failing_cleanup_backs_off_exponentially_per_attempt() {
5200        let launcher = Arc::new(FakeLauncher::refusing_cleanup(vec![concluded(
5201            1,
5202            1,
5203            AttemptOutcome::ExitedIdleWithoutWork,
5204        )]));
5205        let mut harness = Harness::build(
5206            host_with(4),
5207            Arc::clone(&launcher),
5208            Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
5209            Arc::new(InProcessAllocationLock::new()),
5210        );
5211        let policies = [policy(1, "acme/app", 4)];
5212        let start = harness.clock.now();
5213        let at = |offset: Duration| start + chrono::Duration::from_std(offset).unwrap();
5214        let mut failures_at = async |offset: Duration| {
5215            harness.clock.set(at(offset));
5216            harness.reconciler.reconcile(&policies).await.clean_failures
5217        };
5218
5219        assert_eq!(failures_at(Duration::ZERO).await, 1);
5220        // Inside the first delay: not tried, so nothing new to report.
5221        assert_eq!(
5222            failures_at(CLEAN_RETRY_INITIAL - Duration::from_secs(1)).await,
5223            0,
5224            "a failed cleanup was retried on the very next pass"
5225        );
5226        assert_eq!(failures_at(CLEAN_RETRY_INITIAL).await, 1);
5227        // The second delay is twice the first.
5228        let second = CLEAN_RETRY_INITIAL + CLEAN_RETRY_INITIAL * 2;
5229        assert_eq!(
5230            failures_at(second - Duration::from_secs(1)).await,
5231            0,
5232            "the delay did not double after a second failure"
5233        );
5234        assert_eq!(failures_at(second).await, 1);
5235        assert_eq!(harness.events.count_of("attempt_clean_failed"), 3);
5236
5237        // The delay never exceeds the ceiling, however many failures accrue.
5238        let mut backoff = CleanBackoff::default();
5239        let id = AttemptId::from_u128(9);
5240        for _ in 0..40 {
5241            backoff.failed(id, start);
5242        }
5243        assert!(!backoff.is_due(id, at(CLEAN_RETRY_MAXIMUM - Duration::from_secs(1))));
5244        assert!(backoff.is_due(id, at(CLEAN_RETRY_MAXIMUM)));
5245        backoff.succeeded(id);
5246        assert!(
5247            backoff.is_due(id, start),
5248            "a cleaned attempt kept its backoff"
5249        );
5250    }
5251
5252    /// N2: an unreadable attempt set makes a scale-down inconclusive, not empty.
5253    ///
5254    /// Making `attempts()` fallible closed this everywhere the allocation path
5255    /// touches, and left it open in the one place that returns a different type:
5256    /// `scale_down` answered `ScaleDownReport::default()`, which is all zeros
5257    /// and byte-for-byte identical to an idle host with nothing to reclaim. The
5258    /// two mean opposite things — "there was nothing to remove" against "we
5259    /// cannot see what there was".
5260    ///
5261    /// Measured as the sibling test measures it: identical host, identical
5262    /// attempts, identical policy, and the only difference is whether the
5263    /// launcher can answer.
5264    #[tokio::test]
5265    async fn an_unreadable_attempt_set_makes_scale_down_inconclusive_rather_than_empty() {
5266        let launcher = Arc::new(FakeLauncher::new().seeded(vec![
5267            attempt_in(AttemptState::Busy, 1, 1),
5268            concluded(2, 1, AttemptOutcome::CompletedJob),
5269        ]));
5270        let harness = Harness::build(
5271            host_with(4),
5272            Arc::clone(&launcher),
5273            Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
5274            Arc::new(InProcessAllocationLock::new()),
5275        );
5276        let policy = policy(1, "acme/app", 4);
5277
5278        launcher.fail_attempts(true);
5279        let blind = harness.reconciler.scale_down(&policy).await;
5280
5281        assert!(!blind.is_conclusive(), "the machine was never read");
5282        assert_ne!(
5283            blind,
5284            ScaleDownReport::default(),
5285            "a scale-down that could not see the host must not be equal to one that saw \
5286             an idle host; that equality is the whole finding"
5287        );
5288        assert_eq!(blind.removed, 0);
5289        assert_eq!(
5290            blind.refused_busy, 0,
5291            "and this zero means `unknown`, not `none`"
5292        );
5293        assert_eq!(harness.events.count_of("attempts_unreadable"), 1);
5294
5295        // The same everything, with a launcher that can answer.
5296        launcher.fail_attempts(false);
5297        let seeing = harness.reconciler.scale_down(&policy).await;
5298
5299        assert!(seeing.is_conclusive());
5300        assert_eq!(seeing.removed, 1, "the concluded attempt was reclaimed");
5301        assert_eq!(seeing.refused_busy, 1, "and the busy one was left alone");
5302        assert_ne!(
5303            seeing, blind,
5304            "the difference between the two is only whether the set could be read"
5305        );
5306    }
5307
5308    /// Finding 7: the lower arm of the clamp, driven through the reconciler.
5309    ///
5310    /// `demand_below_min_capacity_starts_nothing_in_v1` runs `demand = 0`
5311    /// against `min_capacity = 0`, which is *at* the floor and never raises
5312    /// `desired` — the assertion held for a reason unrelated to the boundary it
5313    /// named. D7 fixes `min` at 0 for v1, but `AutoscaleConfig::new` accepts
5314    /// `min > 0` today, so the path is representable and was undriven.
5315    #[tokio::test]
5316    async fn demand_below_min_capacity_is_raised_to_min_capacity() {
5317        let mut warm = ScalePolicy::new(
5318            PolicyId::from_u128(1),
5319            ScaleTarget::repository("acme/app").unwrap(),
5320            1,
5321            fixtures::HOST_ID,
5322            PolicyMode::autoscale(
5323                fixtures::routing_labels("home"),
5324                2,
5325                NonZeroU16::new(5).expect("non-zero"),
5326            )
5327            .expect("min <= max"),
5328            CachePolicy::default(),
5329        );
5330        warm.activate().expect("pending -> active");
5331
5332        let mut harness = Harness::simple(8, 0, "acme/app");
5333        let report = harness.reconciler.reconcile(&[warm]).await;
5334
5335        assert_eq!(
5336            report.allocations[0].demand, 0,
5337            "GitHub reported no queued runs"
5338        );
5339        assert_eq!(
5340            report.allocations[0].desired, 2,
5341            "min_capacity raised the target above demand"
5342        );
5343        assert_eq!(
5344            report.allocations[0].limiting_factor,
5345            LimitingFactor::MinCapacity
5346        );
5347        assert_eq!(report.started, 2, "and two runners were actually started");
5348        assert_eq!(harness.launcher.live_count(), 2);
5349    }
5350
5351    // =======================================================================
5352    // Memory admission
5353    // =======================================================================
5354
5355    /// The domain rule over a fixed free-memory reading: every attempt on the
5356    /// host is estimated at `estimate` and none has been sampled yet.
5357    #[derive(Debug)]
5358    struct FixedMemory {
5359        free: u64,
5360        estimate: u64,
5361        admitted: std::sync::atomic::AtomicU32,
5362    }
5363
5364    impl MemoryGate for FixedMemory {
5365        fn admit(&self, _policy: &ScalePolicy, attempts: &[RunnerAttempt]) -> MemoryVerdict {
5366            let running: Vec<runner_manager_domain::memory::Running> = attempts
5367                .iter()
5368                .filter(|attempt| attempt.counts_against_capacity())
5369                .map(|_| runner_manager_domain::memory::Running {
5370                    estimate: self.estimate,
5371                    current_rss: None,
5372                })
5373                .collect();
5374            runner_manager_domain::memory::admit(
5375                Some(self.free),
5376                &running,
5377                runner_manager_domain::memory::Estimate::choose(None, Some(self.estimate)),
5378                GIB,
5379            )
5380        }
5381
5382        fn admitted(&self, _policy: &ScalePolicy) {
5383            self.admitted
5384                .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
5385        }
5386    }
5387
5388    const GIB: u64 = 1 << 30;
5389
5390    fn with_memory(harness: Harness, free: u64, estimate: u64) -> (Harness, Arc<FixedMemory>) {
5391        let gate = Arc::new(FixedMemory {
5392            free,
5393            estimate,
5394            admitted: std::sync::atomic::AtomicU32::new(0),
5395        });
5396        let Harness {
5397            launcher,
5398            demand,
5399            events,
5400            clock,
5401            reconciler,
5402        } = harness;
5403        let reconciler = reconciler.with_memory_gate(Arc::clone(&gate) as Arc<dyn MemoryGate>);
5404        (
5405            Harness {
5406                launcher,
5407                demand,
5408                events,
5409                clock,
5410                reconciler,
5411            },
5412            gate,
5413        )
5414    }
5415
5416    #[tokio::test]
5417    async fn a_start_the_memory_cannot_hold_is_deferred_and_the_demand_kept() {
5418        // 10 GiB free, 4 GiB per runner, a 1 GiB margin: the first fits whole,
5419        // the second fits beside the first's 4 GiB still to come, the third
5420        // does not. Every ceiling would have granted five.
5421        let (mut harness, gate) = with_memory(Harness::simple(8, 5, "acme/app"), 10 * GIB, 4 * GIB);
5422        let report = harness
5423            .reconciler
5424            .reconcile(&[policy(1, "acme/app", 5)])
5425            .await;
5426
5427        assert_eq!(
5428            report.allocations[0].to_start, 5,
5429            "the ceilings granted five"
5430        );
5431        assert_eq!(report.started, 2);
5432        assert_eq!(report.memory_deferred, 3, "deferred, not failed");
5433        assert_eq!(report.failures, 0);
5434        assert_eq!(gate.admitted.load(std::sync::atomic::Ordering::Relaxed), 2);
5435        let deferred: Vec<MemoryFigures> = harness
5436            .events
5437            .events()
5438            .into_iter()
5439            .filter_map(|event| match event {
5440                LifecycleEvent::MemoryShort {
5441                    figures,
5442                    started: false,
5443                    ..
5444                } => Some(figures),
5445                _ => None,
5446            })
5447            .collect();
5448        assert_eq!(deferred.len(), 1);
5449        assert_eq!(deferred[0].free, 10 * GIB);
5450        assert_eq!(deferred[0].reserved, 8 * GIB);
5451        assert_eq!(deferred[0].needed(), 5 * GIB);
5452
5453        // The demand is still queued: the next pass asks again, and is
5454        // refused again while nothing has ended.
5455        let again = harness
5456            .reconciler
5457            .reconcile(&[policy(1, "acme/app", 5)])
5458            .await;
5459        assert_eq!(again.started, 0);
5460        assert!(again.memory_deferred > 0);
5461        assert_eq!(harness.launcher.live_count(), 2);
5462    }
5463
5464    #[tokio::test]
5465    async fn a_runner_bigger_than_the_free_memory_starts_when_nothing_else_runs() {
5466        let (mut harness, _) = with_memory(Harness::simple(8, 2, "acme/app"), GIB, 4 * GIB);
5467        let report = harness
5468            .reconciler
5469            .reconcile(&[policy(1, "acme/app", 5)])
5470            .await;
5471
5472        assert_eq!(report.started, 1, "no starvation, but only one");
5473        assert_eq!(report.memory_deferred, 1);
5474        let names: Vec<&str> = harness
5475            .events
5476            .events()
5477            .iter()
5478            .map(LifecycleEvent::name)
5479            .filter(|name| name.starts_with("memory_"))
5480            .collect();
5481        assert_eq!(names, ["memory_admitted_alone", "memory_deferred"]);
5482    }
5483
5484    #[tokio::test]
5485    async fn without_a_memory_gate_every_granted_runner_starts() {
5486        let mut harness = Harness::simple(8, 5, "acme/app");
5487        let report = harness
5488            .reconciler
5489            .reconcile(&[policy(1, "acme/app", 5)])
5490            .await;
5491        assert_eq!(report.started, 5);
5492        assert_eq!(report.memory_deferred, 0);
5493    }
5494
5495    // =======================================================================
5496    // Capacity, at the boundaries
5497    // =======================================================================
5498
5499    #[tokio::test]
5500    async fn demand_above_max_capacity_is_clamped_to_max_capacity() {
5501        let mut harness = Harness::simple(100, 10, "acme/app");
5502        let report = harness
5503            .reconciler
5504            .reconcile(&[policy(1, "acme/app", 3)])
5505            .await;
5506
5507        assert_eq!(report.allocations[0].demand, 10);
5508        assert_eq!(
5509            report.allocations[0].desired, 3,
5510            "max_capacity beats demand"
5511        );
5512        assert_eq!(report.started, 3);
5513        assert_eq!(
5514            report.allocations[0].limiting_factor,
5515            LimitingFactor::MaxCapacity
5516        );
5517    }
5518
5519    #[tokio::test]
5520    async fn demand_below_min_capacity_starts_nothing_in_v1() {
5521        // D7 fixes `min_capacity` at 0, so "below the floor" is "no demand", and
5522        // the product requirement it satisfies is "no idle runners when unused".
5523        let mut harness = Harness::simple(8, 0, "acme/app");
5524        let report = harness
5525            .reconciler
5526            .reconcile(&[policy(1, "acme/app", 4)])
5527            .await;
5528
5529        assert_eq!(report.allocations[0].desired, 0);
5530        assert_eq!(report.started, 0);
5531        assert!(report.starts_nothing());
5532    }
5533
5534    #[tokio::test]
5535    async fn lifecycle_replacement_intent_is_consumed_by_the_ordinary_allocator() {
5536        let policy = policy(1, "octo/repo", 1);
5537        let previous = attempt_in(AttemptState::Starting, 41, 1);
5538        let intent = ReplacementIntent {
5539            policy: policy.id,
5540            previous_attempt: previous.id,
5541            operation: "exit_before_acceptance_replacement",
5542        };
5543        let launcher = Arc::new(FakeLauncher::new().seeded(vec![previous]).replacing(intent));
5544        let demand = Arc::new(FakeDemand::ready(1, &repo("octo/repo")));
5545        let mut harness = Harness::build(
5546            host_with(1),
5547            Arc::clone(&launcher),
5548            demand,
5549            Arc::new(InProcessAllocationLock::new()),
5550        );
5551
5552        let report = harness.reconciler.reconcile(&[policy]).await;
5553
5554        assert_eq!(report.replacement_intents, 1);
5555        assert_eq!(report.started, 1);
5556        assert_eq!(launcher.launches(), 1);
5557        assert_eq!(launcher.live_count(), 1);
5558    }
5559
5560    #[tokio::test]
5561    async fn zero_host_headroom_starts_nothing_at_maximum_demand() {
5562        let launcher = Arc::new(FakeLauncher::new().seeded(vec![
5563            attempt_in(AttemptState::Busy, 1, 1),
5564            attempt_in(AttemptState::Busy, 2, 1),
5565        ]));
5566        let demand = Arc::new(FakeDemand::ready(u32::from(u16::MAX), &repo("acme/app")));
5567        let mut harness = Harness::build(
5568            host_with(2),
5569            launcher,
5570            demand,
5571            Arc::new(InProcessAllocationLock::new()),
5572        );
5573
5574        let report = harness
5575            .reconciler
5576            .reconcile(&[policy(1, "acme/app", 2)])
5577            .await;
5578        assert_eq!(report.started, 0);
5579        assert_eq!(report.allocations[0].headroom_before, 0);
5580        assert_eq!(harness.launcher.launches(), 0);
5581    }
5582
5583    #[tokio::test]
5584    async fn headroom_smaller_than_the_per_policy_allowance_wins() {
5585        // Four slots held by *another* policy on a host of six: this policy is
5586        // allowed five and gets two.
5587        let launcher = Arc::new(FakeLauncher::new().seeded(vec![
5588            attempt_in(AttemptState::Busy, 1, 99),
5589            attempt_in(AttemptState::Busy, 2, 99),
5590            attempt_in(AttemptState::Idle, 3, 99),
5591            attempt_in(AttemptState::Starting, 4, 99),
5592        ]));
5593        let demand = Arc::new(FakeDemand::ready(5, &repo("acme/app")));
5594        let mut harness = Harness::build(
5595            host_with(6),
5596            launcher,
5597            demand,
5598            Arc::new(InProcessAllocationLock::new()),
5599        );
5600
5601        let report = harness
5602            .reconciler
5603            .reconcile(&[policy(1, "acme/app", 5)])
5604            .await;
5605        assert_eq!(
5606            report.allocations[0].desired, 5,
5607            "its own ceiling allows five"
5608        );
5609        assert_eq!(report.started, 2, "the host has two slots free");
5610        assert_eq!(
5611            report.allocations[0].limiting_factor,
5612            LimitingFactor::HostCapacity
5613        );
5614        assert_eq!(harness.launcher.live_count(), 6);
5615    }
5616
5617    #[tokio::test]
5618    async fn the_idle_host_assertion_holds() {
5619        // "No demand means zero runner processes and zero attempts out of
5620        // terminal state."
5621        let mut harness = Harness::simple(8, 0, "acme/app");
5622        let report = harness
5623            .reconciler
5624            .reconcile(&[policy(1, "acme/app", 4), policy(2, "acme/app", 4)])
5625            .await;
5626
5627        assert_eq!(report.started, 0);
5628        assert_eq!(harness.launcher.launches(), 0);
5629        assert!(harness.launcher.snapshot().is_empty());
5630        assert_eq!(
5631            harness
5632                .launcher
5633                .snapshot()
5634                .iter()
5635                .filter(|a| !a.is_terminal())
5636                .count(),
5637            0
5638        );
5639    }
5640
5641    // =======================================================================
5642    // Live host capacity, including changes while a pass is creating runners.
5643    // =======================================================================
5644
5645    #[tokio::test]
5646    async fn live_capacity_increase_is_used_without_rebuilding_the_reconciler() {
5647        let mut harness = Harness::simple(1, 5, "acme/app");
5648        let policies = [policy(1, "acme/app", 5)];
5649        assert_eq!(harness.reconciler.reconcile(&policies).await.started, 1);
5650
5651        *harness.launcher.capacity.lock().unwrap() = NonZeroU16::new(4);
5652        assert_eq!(harness.reconciler.reconcile(&policies).await.started, 3);
5653        assert_eq!(harness.launcher.live_count(), 4);
5654    }
5655
5656    #[tokio::test]
5657    async fn live_capacity_decrease_keeps_busy_runners_and_waits_for_headroom() {
5658        let mut harness = Harness::simple(5, 5, "acme/app");
5659        let busy: Vec<_> = (1..=3)
5660            .map(|id| attempt_in(AttemptState::Busy, id, 1))
5661            .collect();
5662        *harness.launcher.attempts.lock().unwrap() = busy.clone();
5663        *harness.launcher.capacity.lock().unwrap() = NonZeroU16::new(2);
5664        let policies = [policy(1, "acme/app", 5)];
5665
5666        assert_eq!(harness.reconciler.reconcile(&policies).await.started, 0);
5667        assert_eq!(harness.launcher.snapshot(), busy);
5668        assert!(harness.launcher.cleaned().is_empty());
5669
5670        // Two jobs finish; one busy job still owns a slot.
5671        harness.launcher.attempts.lock().unwrap().truncate(1);
5672        assert_eq!(harness.reconciler.reconcile(&policies).await.started, 1);
5673        assert_eq!(harness.launcher.live_count(), 2);
5674    }
5675
5676    #[tokio::test]
5677    async fn live_capacity_is_rechecked_between_launches_in_the_same_pass() {
5678        let mut harness = Harness::simple(5, 5, "acme/app");
5679        *harness.launcher.capacity_after_launch.lock().unwrap() = NonZeroU16::new(1);
5680
5681        let report = harness
5682            .reconciler
5683            .reconcile(&[policy(1, "acme/app", 5)])
5684            .await;
5685        assert_eq!(report.started, 1);
5686        assert_eq!(harness.launcher.live_count(), 1);
5687    }
5688
5689    #[tokio::test]
5690    async fn live_capacity_unreadable_blocks_launches_until_the_journal_recovers() {
5691        let mut harness = Harness::simple(5, 5, "acme/app");
5692        harness
5693            .launcher
5694            .capacity_unreadable
5695            .store(true, Ordering::SeqCst);
5696        let policies = [policy(1, "acme/app", 5)];
5697        let report = harness.reconciler.reconcile(&policies).await;
5698        assert_eq!(report.started, 0);
5699        assert_eq!(report.host_capacity_unreadable, 1);
5700        assert_eq!(report.attempts_unreadable, 0);
5701        assert_eq!(harness.events.count_of("attempts_unreadable"), 0);
5702        assert!(
5703            harness
5704                .events
5705                .events()
5706                .contains(&LifecycleEvent::HostCapacityUnreadable {
5707                    reason: HostCapacityError::JournalUnreadable,
5708                })
5709        );
5710
5711        harness
5712            .launcher
5713            .capacity_unreadable
5714            .store(false, Ordering::SeqCst);
5715        *harness.launcher.capacity.lock().unwrap() = NonZeroU16::new(2);
5716        assert_eq!(harness.reconciler.reconcile(&policies).await.started, 2);
5717    }
5718
5719    #[tokio::test]
5720    async fn unreadable_local_state_does_not_treat_a_busy_host_as_idle() {
5721        for host_failure in [true, false] {
5722            let mut harness = Harness::simple(5, 0, "acme/app");
5723            harness
5724                .reconciler
5725                .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
5726            *harness.launcher.attempts.lock().unwrap() = vec![attempt_in(AttemptState::Busy, 1, 1)];
5727            harness
5728                .launcher
5729                .capacity_unreadable
5730                .store(host_failure, Ordering::SeqCst);
5731            harness.launcher.fail_attempts(!host_failure);
5732            let report = harness
5733                .reconciler
5734                .reconcile(&[policy(1, "acme/app", 5)])
5735                .await;
5736            assert_eq!(report.host_capacity_unreadable, u16::from(host_failure));
5737            assert_eq!(report.next_poll.pace, PollPace::Nominal);
5738            assert_eq!(harness.launcher.live_count(), 1);
5739        }
5740    }
5741
5742    #[derive(Debug)]
5743    struct HostEditOnLock {
5744        inner: InProcessAllocationLock,
5745        launcher: Arc<FakeLauncher>,
5746        unreadable: bool,
5747    }
5748
5749    #[async_trait::async_trait]
5750    impl AllocationLock for HostEditOnLock {
5751        async fn acquire(&self) -> Result<AllocationGuard, AllocationLockBusy> {
5752            let guard = self.inner.acquire().await?;
5753            *self.launcher.capacity.lock().unwrap() = NonZeroU16::new(1);
5754            self.launcher
5755                .capacity_unreadable
5756                .store(self.unreadable, Ordering::SeqCst);
5757            Ok(guard)
5758        }
5759    }
5760
5761    #[tokio::test]
5762    async fn live_capacity_edits_and_read_failures_while_waiting_for_the_lock_block_launches() {
5763        for unreadable in [false, true] {
5764            let launcher =
5765                Arc::new(FakeLauncher::new().seeded(vec![attempt_in(AttemptState::Busy, 1, 1)]));
5766            let lock = Arc::new(HostEditOnLock {
5767                inner: InProcessAllocationLock::new(),
5768                launcher: Arc::clone(&launcher),
5769                unreadable,
5770            });
5771            let mut harness = Harness::build(
5772                host_with(5),
5773                Arc::clone(&launcher),
5774                Arc::new(FakeDemand::ready(5, &repo("acme/app"))),
5775                lock,
5776            );
5777            let report = harness
5778                .reconciler
5779                .reconcile(&[policy(1, "acme/app", 5)])
5780                .await;
5781            assert_eq!(report.started, 0);
5782            assert_eq!(launcher.live_count(), 1);
5783            assert!(launcher.cleaned().is_empty());
5784            assert_eq!(report.host_capacity_unreadable, u16::from(unreadable));
5785            assert_eq!(report.attempts_unreadable, 0);
5786        }
5787    }
5788
5789    // =======================================================================
5790    // D9 under concurrency: the other silent failure
5791    // =======================================================================
5792
5793    /// `e1`'s Definition of Done: *"Two policies on one host with
5794    /// `host_capacity` smaller than the sum of their `max_capacity` values never
5795    /// exceed `host_capacity` under concurrent reconciliation — asserted under
5796    /// simulated lock contention, with no duplicate runners."*
5797    ///
5798    /// The contention is simulated by [`FakeLauncher::with_yields`], which puts
5799    /// executor yield points *between* the launcher reading the attempt set and
5800    /// recording the new one. Without serialisation both tasks read a headroom
5801    /// of three and both spend it.
5802    ///
5803    /// # Watched failing before it was made to pass
5804    ///
5805    /// Granting from this lock without taking the inner mutex — leaving every
5806    /// counter and every yield point exactly as they are — fails this assertion
5807    /// with `left: 4, right: 3`: four runners on a host of three, from two
5808    /// policies each individually inside their own `max_capacity`. The control
5809    /// test below keeps that measurement standing permanently by running the
5810    /// same body against [`NoLock`].
5811    #[tokio::test(flavor = "current_thread")]
5812    async fn two_policies_reconciling_concurrently_never_exceed_host_capacity() {
5813        let lock = Arc::new(CountingLock::new());
5814        let (launches, live) =
5815            two_policies_concurrently(Arc::clone(&lock) as Arc<dyn AllocationLock>, None).await;
5816
5817        assert_eq!(
5818            launches, 3,
5819            "the sum across policies must never exceed host_capacity, and each policy is \
5820             individually within its own max_capacity of 3"
5821        );
5822        assert_eq!(live, 3, "and no duplicate runner survived the race");
5823        assert_eq!(
5824            lock.peak(),
5825            1,
5826            "the allocation lock had one holder at a time; without that the read of the \
5827             headroom and the creation of the runtime are not atomic"
5828        );
5829        assert!(
5830            (3..=5).contains(&lock.acquisitions()),
5831            "the lock is taken before *each* runtime, not once per pass: three runtimes \
5832             means at least three holds, and at most one further hold per policy to \
5833             discover the host filled up underneath it. It was taken {} times",
5834            lock.acquisitions()
5835        );
5836    }
5837
5838    /// The control for the test above: the same body with the lock removed.
5839    ///
5840    /// It exists so that the assertion above cannot pass vacuously. If a future
5841    /// change makes the unserialised path safe by accident — a launcher that
5842    /// records synchronously, say — this test goes red and says so, rather than
5843    /// the other one silently proving nothing.
5844    #[tokio::test(flavor = "current_thread")]
5845    async fn without_the_allocation_lock_two_policies_oversubscribe_the_host() {
5846        let (launches, _) =
5847            two_policies_concurrently(Arc::new(NoLock) as Arc<dyn AllocationLock>, None).await;
5848
5849        assert!(
5850            launches > 3,
5851            "with no serialisation both policies must be able to spend the same headroom; \
5852             they started {launches} runners on a host of 3. If this is ever 3, the \
5853             contention window closed and `two_policies_reconciling_concurrently_never_\
5854             exceed_host_capacity` has stopped proving anything"
5855        );
5856    }
5857
5858    /// Two policies, one host of three, each allowed three, reconciled at once.
5859    ///
5860    /// Returns `(launches, live attempts)`.
5861    async fn two_policies_concurrently(
5862        lock: Arc<dyn AllocationLock>,
5863        live_capacity: Option<NonZeroU16>,
5864    ) -> (usize, usize) {
5865        let launcher = Arc::new(FakeLauncher::new().with_yields(4));
5866        *launcher.capacity.lock().unwrap() = live_capacity;
5867        let host = host_with(3);
5868
5869        let mut left = Harness::build(
5870            host.clone(),
5871            Arc::clone(&launcher),
5872            Arc::new(FakeDemand::ready(3, &repo("acme/left"))),
5873            Arc::clone(&lock),
5874        )
5875        .reconciler;
5876        let mut right = Harness::build(
5877            host,
5878            Arc::clone(&launcher),
5879            Arc::new(FakeDemand::ready(3, &repo("acme/right"))),
5880            Arc::clone(&lock),
5881        )
5882        .reconciler;
5883
5884        let a = policy(1, "acme/left", 3);
5885        let b = policy(2, "acme/right", 3);
5886
5887        let left = tokio::spawn(async move { left.reconcile(&[a]).await });
5888        let right = tokio::spawn(async move { right.reconcile(&[b]).await });
5889        let (_, _) = (left.await.unwrap(), right.await.unwrap());
5890
5891        (launcher.launches(), launcher.live_count())
5892    }
5893
5894    #[tokio::test(flavor = "current_thread")]
5895    async fn live_capacity_is_shared_by_concurrent_targets_with_stale_startup_hosts() {
5896        let (launches, live) =
5897            two_policies_concurrently(Arc::new(InProcessAllocationLock::new()), NonZeroU16::new(2))
5898                .await;
5899        assert_eq!(launches, 2);
5900        assert_eq!(live, 2);
5901    }
5902
5903    // =======================================================================
5904    // D19: monitor-only
5905    // =======================================================================
5906
5907    /// `e1`'s Definition of Done: *"A `MonitorOnly` policy under maximum demand
5908    /// starts zero runners and issues no demand request."*
5909    ///
5910    /// Driven through `c4`'s real gateway fake so that "issued no demand
5911    /// request" is asserted against the thing that would have issued it, rather
5912    /// than against this module's own bookkeeping. `FakeGithub` records every
5913    /// call it is asked to make.
5914    #[tokio::test]
5915    async fn a_monitor_only_policy_under_maximum_demand_starts_nothing_and_polls_nothing() {
5916        let gateway = FakeGithub::new().with_queued_jobs(repo("acme/app"), jobs(10_000));
5917        let gateway = Arc::new(GatewayDemand::new(gateway, CancelToken::new()));
5918        let launcher = Arc::new(FakeLauncher::new());
5919        let events = Arc::new(EventLog::new());
5920
5921        let mut reconciler = Reconciler::new(
5922            host_with(10),
5923            ReconcilerPorts {
5924                demand: Arc::clone(&gateway) as Arc<dyn DemandSource>,
5925                launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
5926                lock: Arc::new(InProcessAllocationLock::new()),
5927                directory: Arc::new(FakeDirectory::default()),
5928                clock: Arc::new(FakeClock::default()),
5929                jitter: Arc::new(NoJitter),
5930                events: Arc::clone(&events) as Arc<dyn EventSink>,
5931            },
5932        );
5933
5934        let monitor = fixtures::policy()
5935            .id(PolicyId::from_u128(1))
5936            .repository("acme/app")
5937            .monitor_only()
5938            .active()
5939            .build();
5940
5941        let report = reconciler.reconcile(&[monitor]).await;
5942
5943        assert_eq!(report.started, 0);
5944        assert_eq!(launcher.launches(), 0);
5945        assert_eq!(report.monitor_only, vec![PolicyId::from_u128(1)]);
5946        assert_eq!(
5947            report.demand_requests, 0,
5948            "a monitor-only policy spends nothing from the shared hourly ceiling"
5949        );
5950        assert!(
5951            gateway.gateway().calls().is_empty(),
5952            "a monitor-only policy issued a demand request: {:?}",
5953            gateway.gateway().calls()
5954        );
5955        assert_eq!(events.count_of("monitor_only_skipped"), 1);
5956        assert_eq!(
5957            events.count_of("demand_observed"),
5958            0,
5959            "and it contributed no demand"
5960        );
5961    }
5962
5963    /// D19 says a monitor-only policy is *"skipped entirely by
5964    /// reconciliation"*, and "entirely" is the load-bearing word once two
5965    /// policies share a target.
5966    ///
5967    /// This defect was found by review rather than by the test above, which
5968    /// cannot see it: there, the monitor-only policy is the *only* policy, so
5969    /// nobody polls its target and the lookup finds nothing. Give it a
5970    /// repository an autoscale policy already polls and the lookup succeeds —
5971    /// and the monitor-only policy was then allocated for and had a demand
5972    /// observation emitted on its behalf. It still started nothing, because
5973    /// `may_start_runners` is false for it and `HostAllocator` refuses it by
5974    /// name, so no ceiling was ever at risk. It simply was not skipped.
5975    ///
5976    /// Removing the `owns_runners` guard from the allocation loop was watched
5977    /// failing this test before it was restored:
5978    /// `a monitor-only policy was allocated for: [… limiting_factor:
5979    /// MonitorOnly]`.
5980    #[tokio::test]
5981    async fn a_monitor_only_policy_sharing_a_target_is_still_skipped_entirely() {
5982        let lock = Arc::new(CountingLock::new());
5983        let launcher = Arc::new(FakeLauncher::new());
5984        let events = Arc::new(EventLog::new());
5985        let mut reconciler = Reconciler::new(
5986            host_with(4),
5987            ReconcilerPorts {
5988                demand: Arc::new(FakeDemand::ready(2, &repo("acme/app"))),
5989                launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
5990                lock: Arc::clone(&lock) as Arc<dyn AllocationLock>,
5991                directory: Arc::new(FakeDirectory::default()),
5992                clock: Arc::new(FakeClock::default()),
5993                jitter: Arc::new(NoJitter),
5994                events: Arc::clone(&events) as Arc<dyn EventSink>,
5995            },
5996        );
5997
5998        let watcher = fixtures::policy()
5999            .id(PolicyId::from_u128(2))
6000            .repository("acme/app")
6001            .monitor_only()
6002            .active()
6003            .build();
6004
6005        let report = reconciler
6006            .reconcile(&[policy(1, "acme/app", 4), watcher])
6007            .await;
6008
6009        assert_eq!(report.started, 2, "the autoscale policy is served normally");
6010        assert_eq!(report.monitor_only, vec![PolicyId::from_u128(2)]);
6011        assert_eq!(
6012            events.count_of("demand_observed"),
6013            1,
6014            "the demand observation belongs to the autoscale policy alone"
6015        );
6016        assert!(
6017            report
6018                .allocations
6019                .iter()
6020                .all(|a| a.policy_id == PolicyId::from_u128(1)),
6021            "a monitor-only policy was allocated for: {:?}",
6022            report.allocations
6023        );
6024        assert_eq!(
6025            lock.acquisitions(),
6026            2,
6027            "one hold per runtime created, and none on behalf of the monitor-only policy. \
6028             It was three before the budget was checked at the top of the loop rather than \
6029             after the re-read, which cost every policy a surplus hold to discover there \
6030             was nothing left to grant"
6031        );
6032    }
6033
6034    #[tokio::test]
6035    async fn the_monitor_only_refusal_is_asserted_on_the_mode_not_on_a_missing_ceiling() {
6036        // The specification requires this to be asserted rather than deduced
6037        // from `max_capacity` being absent. `HostAllocator` reports it by name,
6038        // and this loop reaches that arm through `owns_runners`, which is a
6039        // question about the mode.
6040        let monitor = fixtures::monitor_only_policy();
6041        assert!(!monitor.owns_runners());
6042        assert_eq!(monitor.max_capacity(), None);
6043
6044        let host = host_with(10);
6045        let attempts: Vec<RunnerAttempt> = Vec::new();
6046        let mut allocator = HostAllocator::from_attempts(&host, &attempts);
6047        let allocation = allocator.allocate(&monitor, 10_000);
6048        assert_eq!(allocation.limiting_factor, LimitingFactor::MonitorOnly);
6049        assert_eq!(allocation.to_start, 0);
6050        assert_eq!(
6051            allocator.headroom(),
6052            10,
6053            "and it consumes no headroom, so an autoscale policy on the same host is \
6054             unaffected"
6055        );
6056    }
6057
6058    // =======================================================================
6059    // The surplus runner, and busy protection
6060    // =======================================================================
6061
6062    /// `e1`'s Definition of Done: *"A surplus attempt that receives no job
6063    /// reaches a terminal state recorded as an idle exit, is cleaned, and is not
6064    /// reported as a failure."*
6065    #[tokio::test]
6066    async fn a_surplus_attempt_is_cleaned_as_an_idle_exit_and_not_as_a_failure() {
6067        let launcher = Arc::new(FakeLauncher::new().seeded(vec![
6068            concluded(1, 1, AttemptOutcome::ExitedIdleWithoutWork),
6069            concluded(
6070                2,
6071                1,
6072                AttemptOutcome::failed(FailureReason::JitRequestFailed),
6073            ),
6074            concluded(3, 1, AttemptOutcome::CompletedJob),
6075        ]));
6076        let mut harness = Harness::build(
6077            host_with(4),
6078            Arc::clone(&launcher),
6079            Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
6080            Arc::new(InProcessAllocationLock::new()),
6081        );
6082
6083        let report = harness
6084            .reconciler
6085            .reconcile(&[policy(1, "acme/app", 4)])
6086            .await;
6087
6088        assert_eq!(report.cleaned, 3);
6089        assert_eq!(report.idle_exits, 1, "the surplus case, counted apart");
6090        assert_eq!(
6091            report.failures, 1,
6092            "only the failed attempt is a failure; the idle exit and the completed job are \
6093             not"
6094        );
6095        assert_eq!(launcher.cleaned().len(), 3);
6096        assert!(launcher.snapshot().is_empty());
6097
6098        let cleaned: Vec<OutcomeKind> = harness
6099            .events
6100            .events()
6101            .into_iter()
6102            .filter_map(|event| match event {
6103                LifecycleEvent::AttemptCleaned { outcome, .. } => Some(outcome),
6104                _ => None,
6105            })
6106            .collect();
6107        assert!(cleaned.contains(&OutcomeKind::IdleExit));
6108        assert!(
6109            !OutcomeKind::IdleExit.is_failure(),
6110            "an idle exit rendered as a failure sends an operator hunting a fault that does \
6111             not exist"
6112        );
6113    }
6114
6115    /// `e1`'s Definition of Done: *"A scale-down request with a busy attempt
6116    /// removes nothing and leaves the attempt `busy`."*
6117    #[tokio::test]
6118    async fn scale_down_removes_nothing_from_a_busy_attempt() {
6119        let busy = attempt_in(AttemptState::Busy, 1, 1);
6120        let launcher = Arc::new(FakeLauncher::new().seeded(vec![
6121            busy.clone(),
6122            attempt_in(AttemptState::Starting, 2, 1),
6123            concluded(3, 1, AttemptOutcome::CompletedJob),
6124        ]));
6125        let harness = Harness::build(
6126            host_with(4),
6127            Arc::clone(&launcher),
6128            Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
6129            Arc::new(InProcessAllocationLock::new()),
6130        );
6131
6132        let report = harness
6133            .reconciler
6134            .scale_down(&policy(1, "acme/app", 4))
6135            .await;
6136
6137        assert_eq!(report.refused_busy, 1);
6138        assert_eq!(
6139            report.retained, 1,
6140            "the `starting` attempt is not ended either"
6141        );
6142        assert_eq!(report.removed, 1, "only the concluded attempt is reclaimed");
6143
6144        let after = launcher.snapshot();
6145        let still_busy = after
6146            .iter()
6147            .find(|a| a.id == AttemptId::from_u128(1))
6148            .expect("the busy attempt is still there");
6149        assert_eq!(
6150            still_busy.state(),
6151            AttemptState::Busy,
6152            "scale-down removed nothing from a runner that is executing a job, and left it \
6153             busy"
6154        );
6155        assert!(!launcher.cleaned().contains(&AttemptId::from_u128(1)));
6156
6157        // And the domain refuses it from the other side too, by name, so a
6158        // future caller that tried anyway would not get a generic transition
6159        // error.
6160        let mut busy = busy;
6161        assert!(matches!(
6162            busy.clean(fixtures::created_at()),
6163            Err(runner_manager_domain::attempt::AttemptError::BusyCannotBeCleaned)
6164        ));
6165        assert_eq!(harness.events.count_of("scale_down_refused"), 1);
6166    }
6167
6168    // =======================================================================
6169    // The schedule
6170    // =======================================================================
6171
6172    #[test]
6173    fn the_default_interval_is_sixty_seconds_and_the_floor_is_thirty() {
6174        assert_eq!(RefreshInterval::DEFAULT_SECS, 60);
6175        assert_eq!(RefreshInterval::MIN_SECS, 30);
6176        assert_eq!(PollSchedule::floor(), Duration::from_secs(30));
6177        assert!(
6178            RefreshInterval::from_secs(29).is_err(),
6179            "the floor is a rate-budget constraint, and a caller must not be able to write \
6180             a shorter interval at all"
6181        );
6182
6183        let mut schedule = PollSchedule::new(RefreshInterval::default());
6184        let next = schedule.next_poll(None, fixtures::created_at(), &NoJitter);
6185        assert_eq!(next.delay, Duration::from_secs(60));
6186        assert_eq!(next.pace, PollPace::Nominal);
6187
6188        let mut floored = PollSchedule::new(RefreshInterval::from_secs(30).unwrap());
6189        assert_eq!(
6190            floored
6191                .next_poll(None, fixtures::created_at(), &NoJitter)
6192                .delay,
6193            Duration::from_secs(30)
6194        );
6195    }
6196
6197    /// `e1`'s Definition of Done: *"The poll interval … increases under a
6198    /// rate-limit signal, and the increase is visible in emitted state rather
6199    /// than silent."*
6200    #[test]
6201    fn a_rate_limit_increases_the_delay_and_names_itself() {
6202        let now = fixtures::created_at();
6203        let mut schedule = PollSchedule::new(RefreshInterval::default());
6204
6205        let limited = RefreshState::RateLimited(RateLimited {
6206            kind: RateLimitKind::Secondary,
6207            retry_after: Some(Duration::from_secs(300)),
6208            remaining: None,
6209            reset_unix_secs: None,
6210        });
6211        let next = schedule.next_poll(Some(&limited), now, &NoJitter);
6212
6213        assert_eq!(next.delay, Duration::from_secs(300));
6214        assert_eq!(
6215            next.pace,
6216            PollPace::RateLimited {
6217                kind: RateLimitKind::Secondary
6218            },
6219            "the increase is reported, never hidden"
6220        );
6221        assert!(next.pace.is_throttled());
6222        assert_eq!(next.pace.as_str(), "rate_limited_secondary");
6223    }
6224
6225    /// Constraint on this task: *"Read `RefreshState::retry_delay` as an
6226    /// absolute floor, not an addend."*
6227    #[test]
6228    fn the_retry_delay_is_an_absolute_floor_and_never_an_addend() {
6229        let now = fixtures::created_at();
6230        let mut schedule = PollSchedule::new(RefreshInterval::default());
6231
6232        let limited = RefreshState::RateLimited(RateLimited {
6233            kind: RateLimitKind::Primary,
6234            retry_after: Some(Duration::from_secs(300)),
6235            remaining: Some(0),
6236            reset_unix_secs: None,
6237        });
6238
6239        // Five successive answers, each carrying the window that is *left*.
6240        // An addend would compound: 360, 660, 960 … and look like a hang.
6241        for _ in 0..5 {
6242            let next = schedule.next_poll(Some(&limited), now, &NoJitter);
6243            assert_eq!(
6244                next.delay,
6245                Duration::from_secs(300),
6246                "the delay is `max(interval, retry_delay)`; `interval + retry_delay` would \
6247                 have compounded on every successive retry"
6248            );
6249        }
6250
6251        // And when GitHub asks for less than the interval, the interval wins:
6252        // the floor is never crossed to catch up.
6253        let brief = RefreshState::RateLimited(RateLimited {
6254            kind: RateLimitKind::Secondary,
6255            retry_after: Some(Duration::from_secs(5)),
6256            remaining: None,
6257            reset_unix_secs: None,
6258        });
6259        let next = schedule.next_poll(Some(&brief), now, &NoJitter);
6260        assert_eq!(
6261            next.delay,
6262            Duration::from_secs(60),
6263            "a short `retry-after` may not drop the loop below its own interval"
6264        );
6265        assert!(next.delay >= PollSchedule::floor());
6266    }
6267
6268    #[test]
6269    fn no_branch_of_the_schedule_can_go_below_the_thirty_second_floor() {
6270        let now = fixtures::created_at();
6271        let states = [
6272            None,
6273            Some(RefreshState::Offline),
6274            Some(RefreshState::RateLimited(RateLimited {
6275                kind: RateLimitKind::Secondary,
6276                retry_after: Some(Duration::from_secs(1)),
6277                remaining: None,
6278                reset_unix_secs: None,
6279            })),
6280            Some(RefreshState::LockedOut {
6281                retry_after: Duration::from_secs(1),
6282            }),
6283            Some(RefreshState::Unauthorized),
6284            Some(RefreshState::Forbidden { message: None }),
6285            Some(RefreshState::Failed {
6286                status: Some(500),
6287                message: "server error".into(),
6288            }),
6289            Some(RefreshState::Cancelled),
6290        ];
6291
6292        for state in &states {
6293            let mut schedule = PollSchedule::new(RefreshInterval::from_secs(30).unwrap());
6294            let next = schedule.next_poll(state.as_ref(), now, &NoJitter);
6295            assert!(
6296                next.delay >= PollSchedule::floor(),
6297                "{state:?} scheduled a poll {}ms away, under the 30-second floor",
6298                next.delay.as_millis()
6299            );
6300        }
6301    }
6302
6303    #[test]
6304    fn an_offline_run_backs_off_with_jitter_and_a_recovery_resets_it() {
6305        let now = fixtures::created_at();
6306        let mut schedule = PollSchedule::new(RefreshInterval::default());
6307
6308        // Doubling, from the nominal interval.
6309        let mut previous = Duration::ZERO;
6310        for consecutive in 1..=6_u32 {
6311            let next = schedule.next_poll(Some(&RefreshState::Offline), now, &NoJitter);
6312            assert_eq!(next.pace, PollPace::Offline { consecutive });
6313            assert!(
6314                next.delay >= previous,
6315                "the back-off must not shrink while the outage continues"
6316            );
6317            assert!(next.delay >= Duration::from_secs(60));
6318            previous = next.delay;
6319        }
6320        assert!(previous <= MAX_OFFLINE_BACKOFF, "and it is capped");
6321
6322        // Jitter widens the delay rather than narrowing it, so a fleet of
6323        // agents does not retry in lockstep.
6324        let mut jittered = PollSchedule::new(RefreshInterval::default());
6325        let none = jittered.next_poll(Some(&RefreshState::Offline), now, &NoJitter);
6326        let mut jittered = PollSchedule::new(RefreshInterval::default());
6327        let full = jittered.next_poll(Some(&RefreshState::Offline), now, &FixedJitter(0.999));
6328        assert!(full.delay > none.delay);
6329        assert!(full.delay <= none.delay.mul_f64(1.0 + JITTER_RATIO));
6330
6331        // Recovery resets the run with no bookkeeping of its own.
6332        assert_eq!(schedule.consecutive_offline(), 6);
6333        let recovered = schedule.next_poll(None, now, &NoJitter);
6334        assert_eq!(recovered.pace, PollPace::Nominal);
6335        assert_eq!(recovered.delay, Duration::from_secs(60));
6336        assert_eq!(schedule.consecutive_offline(), 0);
6337    }
6338
6339    #[test]
6340    fn the_offline_state_states_the_twenty_four_hour_bound() {
6341        assert_eq!(
6342            GITHUB_CANCELS_QUEUED_JOBS_AFTER,
6343            Duration::from_secs(24 * 60 * 60)
6344        );
6345
6346        let brief = OfflineState::new(1, Duration::from_secs(120));
6347        let rendered = brief.to_string();
6348        assert!(rendered.contains("24 hours"), "{rendered}");
6349        assert!(rendered.contains("Retrying in 120s"), "{rendered}");
6350        assert!(!brief.has_outlasted_the_queue());
6351
6352        let long = brief.since(GITHUB_CANCELS_QUEUED_JOBS_AFTER + Duration::from_secs(1));
6353        assert!(long.has_outlasted_the_queue());
6354        assert!(
6355            long.to_string().contains("queued work has been lost"),
6356            "{long}"
6357        );
6358
6359        // "We cannot tell" is not "not yet".
6360        assert!(!OfflineState::new(9, Duration::from_secs(60)).has_outlasted_the_queue());
6361    }
6362
6363    // =======================================================================
6364    // Idle polling and the shared quota
6365    // =======================================================================
6366
6367    fn quota(remaining: u64, reset_in_secs: i64, now: Timestamp) -> RateLimitSnapshot {
6368        RateLimitSnapshot {
6369            limit: 5_000,
6370            remaining,
6371            used: Some(5_000 - remaining),
6372            reset_unix_secs: u64::try_from(now.timestamp() + reset_in_secs).expect("positive"),
6373            observed_at: now,
6374        }
6375    }
6376
6377    fn quiet() -> PollConditions {
6378        PollConditions {
6379            quiet: true,
6380            quota: None,
6381            requests_per_pass: 0,
6382        }
6383    }
6384
6385    #[test]
6386    fn a_quiet_pass_polls_at_the_idle_interval_and_a_busy_one_at_the_active_interval() {
6387        let now = fixtures::created_at();
6388        let mut schedule =
6389            PollSchedule::new(RefreshInterval::default()).with_idle(Duration::from_secs(10));
6390
6391        let idle = schedule.next_poll_with(None, quiet(), now, &NoJitter);
6392        assert_eq!(idle.delay, Duration::from_secs(10));
6393        assert_eq!(idle.pace, PollPace::Idle);
6394        assert!(!idle.pace.is_throttled(), "idle is faster, not a slowdown");
6395
6396        let busy = schedule.next_poll_with(None, PollConditions::default(), now, &NoJitter);
6397        assert_eq!(busy.delay, Duration::from_secs(60));
6398        assert_eq!(busy.pace, PollPace::Nominal);
6399    }
6400
6401    #[test]
6402    fn a_schedule_never_told_an_idle_interval_keeps_its_active_one() {
6403        let now = fixtures::created_at();
6404        let mut schedule = PollSchedule::new(RefreshInterval::default());
6405        assert_eq!(
6406            schedule.next_poll_with(None, quiet(), now, &NoJitter).delay,
6407            Duration::from_secs(60)
6408        );
6409    }
6410
6411    #[test]
6412    fn an_idle_interval_is_clamped_between_its_floor_and_the_active_interval() {
6413        let schedule = PollSchedule::new(RefreshInterval::from_secs(30).expect("the floor"))
6414            .with_idle(Duration::from_secs(120));
6415        assert_eq!(
6416            schedule.idle(),
6417            Duration::from_secs(30),
6418            "an idle interval above the active one would make quiet targets slower to react"
6419        );
6420        let schedule =
6421            PollSchedule::new(RefreshInterval::default()).with_idle(Duration::from_secs(1));
6422        assert_eq!(schedule.idle(), PollSchedule::idle_floor());
6423    }
6424
6425    /// The owner's fourth requirement: when the shared quota runs low, stretch
6426    /// the interval automatically, and say so.
6427    #[test]
6428    fn a_low_quota_stretches_polling_and_wins_over_idle() {
6429        let now = fixtures::created_at();
6430        let mut schedule =
6431            PollSchedule::new(RefreshInterval::default()).with_idle(Duration::from_secs(10));
6432
6433        let healthy = schedule.next_poll_with(
6434            None,
6435            PollConditions {
6436                quiet: true,
6437                quota: Some(quota(1_000, 3_000, now)),
6438                requests_per_pass: 0,
6439            },
6440            now,
6441            &NoJitter,
6442        );
6443        assert_eq!(healthy.pace, PollPace::Idle, "a fifth left is still normal");
6444
6445        let low = schedule.next_poll_with(
6446            None,
6447            PollConditions {
6448                quiet: true,
6449                quota: Some(quota(999, 3_000, now)),
6450                requests_per_pass: 0,
6451            },
6452            now,
6453            &NoJitter,
6454        );
6455        assert_eq!(low.delay, Duration::from_secs(120));
6456        assert_eq!(
6457            low.pace,
6458            PollPace::Stretched {
6459                pressure: PrimaryPressure::Low
6460            }
6461        );
6462        assert!(low.pace.is_throttled());
6463        assert_eq!(low.pace.as_str(), "stretched_low_budget");
6464
6465        let critical = schedule.next_poll_with(
6466            None,
6467            PollConditions {
6468                quiet: false,
6469                quota: Some(quota(100, 3_000, now)),
6470                requests_per_pass: 0,
6471            },
6472            now,
6473            &NoJitter,
6474        );
6475        assert_eq!(critical.delay, Duration::from_secs(240));
6476        assert_eq!(critical.pace.as_str(), "stretched_critical_budget");
6477    }
6478
6479    #[test]
6480    fn a_stretch_never_outlasts_the_quotas_reset_nor_undercuts_the_active_interval() {
6481        let now = fixtures::created_at();
6482        let mut schedule = PollSchedule::new(RefreshInterval::default());
6483
6484        let soon = schedule.next_poll_with(
6485            None,
6486            PollConditions {
6487                quiet: false,
6488                quota: Some(quota(10, 90, now)),
6489                requests_per_pass: 0,
6490            },
6491            now,
6492            &NoJitter,
6493        );
6494        assert_eq!(
6495            soon.delay,
6496            Duration::from_secs(90),
6497            "the bucket refills in 90 s; waiting 240 s buys nothing"
6498        );
6499
6500        let imminent = schedule.next_poll_with(
6501            None,
6502            PollConditions {
6503                quiet: false,
6504                quota: Some(quota(10, 5, now)),
6505                requests_per_pass: 0,
6506            },
6507            now,
6508            &NoJitter,
6509        );
6510        assert_eq!(imminent.delay, Duration::from_secs(60));
6511
6512        let expired = schedule.next_poll_with(
6513            None,
6514            PollConditions {
6515                quiet: true,
6516                quota: Some(quota(10, -5, now)),
6517                requests_per_pass: 0,
6518            },
6519            now,
6520            &NoJitter,
6521        );
6522        assert_eq!(
6523            expired.pace,
6524            PollPace::Nominal,
6525            "a reading from a window that has reset says nothing; the schedule here had no \
6526             idle interval, so it is the active one"
6527        );
6528    }
6529
6530    #[test]
6531    fn an_idle_target_too_large_to_poll_that_often_stretches_its_idle_interval() {
6532        let now = fixtures::created_at();
6533        let mut schedule =
6534            PollSchedule::new(RefreshInterval::default()).with_idle(Duration::from_secs(10));
6535        let small = schedule.next_poll_with(
6536            None,
6537            PollConditions {
6538                quiet: true,
6539                quota: None,
6540                requests_per_pass: 40,
6541            },
6542            now,
6543            &NoJitter,
6544        );
6545        assert_eq!(small.delay, Duration::from_secs(10), "ten repositories fit");
6546        let organization = schedule.next_poll_with(
6547            None,
6548            PollConditions {
6549                quiet: true,
6550                quota: None,
6551                requests_per_pass: 400,
6552            },
6553            now,
6554            &NoJitter,
6555        );
6556        assert_eq!(
6557            organization.delay,
6558            Duration::from_secs(80),
6559            "400 requests a pass at 300 a minute is one pass every 80 s"
6560        );
6561        assert_eq!(organization.pace, PollPace::Idle);
6562    }
6563
6564    #[test]
6565    fn a_rate_limit_wait_is_jittered_upward_only() {
6566        let now = fixtures::created_at();
6567        let mut schedule = PollSchedule::new(RefreshInterval::default());
6568        let limited = RefreshState::RateLimited(RateLimited {
6569            kind: RateLimitKind::Secondary,
6570            retry_after: Some(Duration::from_secs(300)),
6571            remaining: None,
6572            reset_unix_secs: None,
6573        });
6574        assert_eq!(
6575            schedule
6576                .next_poll(Some(&limited), now, &FixedJitter(0.5))
6577                .delay,
6578            Duration::from_secs(315),
6579            "every loop shares one quiet period; without jitter they all wake together"
6580        );
6581        assert_eq!(
6582            schedule.next_poll(Some(&limited), now, &NoJitter).delay,
6583            Duration::from_secs(300),
6584            "never shorter than GitHub asked"
6585        );
6586    }
6587
6588    #[tokio::test]
6589    async fn demand_this_host_did_not_serve_keeps_the_target_off_the_idle_pace() {
6590        // Capacity zero would refuse the policy outright; a host already full
6591        // is the ordinary way matched demand goes unserved for a pass.
6592        let launcher =
6593            Arc::new(FakeLauncher::new().seeded(vec![attempt_in(AttemptState::Busy, 9, 9)]));
6594        let demand = Arc::new(FakeDemand::ready(2, &repo("acme/app")));
6595        let mut harness = Harness::build(
6596            host_with(1),
6597            launcher,
6598            demand,
6599            Arc::new(InProcessAllocationLock::new()),
6600        );
6601        harness
6602            .reconciler
6603            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6604        let policy = policy(1, "acme/app", 4);
6605
6606        let report = harness
6607            .reconciler
6608            .reconcile(std::slice::from_ref(&policy))
6609            .await;
6610
6611        assert_eq!(report.started, 0, "the host is full");
6612        assert_eq!(
6613            report.next_poll.pace,
6614            PollPace::Nominal,
6615            "matched demand it could not serve is work waiting, not idle"
6616        );
6617    }
6618
6619    #[tokio::test]
6620    async fn a_target_with_nothing_to_do_is_polled_at_the_idle_interval() {
6621        let mut harness = Harness::simple(4, 0, "acme/app");
6622        harness
6623            .reconciler
6624            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6625        let policy = policy(1, "acme/app", 4);
6626
6627        let report = harness
6628            .reconciler
6629            .reconcile(std::slice::from_ref(&policy))
6630            .await;
6631
6632        assert_eq!(report.next_poll.pace, PollPace::Idle);
6633        assert_eq!(report.next_poll.delay, Duration::from_secs(10));
6634    }
6635
6636    #[tokio::test]
6637    async fn a_target_whose_runs_are_changing_is_polled_at_the_active_interval() {
6638        let mut harness = Harness::simple(4, 0, "acme/app");
6639        harness
6640            .reconciler
6641            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6642        harness.demand.set(PollOutcome::Ready(
6643            QueuedDemand::of(repo("acme/app"), Vec::new()).with_busy(repo("acme/app")),
6644        ));
6645        let policy = policy(1, "acme/app", 4);
6646
6647        let report = harness
6648            .reconciler
6649            .reconcile(std::slice::from_ref(&policy))
6650            .await;
6651
6652        assert_eq!(report.next_poll.pace, PollPace::Nominal);
6653        assert_eq!(report.next_poll.delay, Duration::from_secs(60));
6654    }
6655
6656    #[tokio::test]
6657    async fn a_target_with_a_live_runner_is_polled_at_the_active_interval() {
6658        let launcher =
6659            Arc::new(FakeLauncher::new().seeded(vec![attempt_in(AttemptState::Busy, 1, 1)]));
6660        let demand = Arc::new(FakeDemand::ready(0, &repo("acme/app")));
6661        let mut harness = Harness::build(
6662            host_with(4),
6663            launcher,
6664            demand,
6665            Arc::new(InProcessAllocationLock::new()),
6666        );
6667        harness
6668            .reconciler
6669            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6670        let policy = policy(1, "acme/app", 4);
6671
6672        let report = harness
6673            .reconciler
6674            .reconcile(std::slice::from_ref(&policy))
6675            .await;
6676
6677        assert_eq!(
6678            report.next_poll.pace,
6679            PollPace::Nominal,
6680            "a job is running: its follow-on work is what the active interval watches for"
6681        );
6682    }
6683
6684    #[tokio::test]
6685    async fn a_pass_that_starts_a_runner_is_not_idle() {
6686        let mut harness = Harness::simple(4, 2, "acme/app");
6687        harness
6688            .reconciler
6689            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6690        let policy = policy(1, "acme/app", 4);
6691
6692        let report = harness
6693            .reconciler
6694            .reconcile(std::slice::from_ref(&policy))
6695            .await;
6696
6697        assert!(report.started > 0);
6698        assert_eq!(report.next_poll.pace, PollPace::Nominal);
6699    }
6700
6701    #[tokio::test]
6702    async fn the_quota_reported_with_a_reading_stretches_the_next_poll() {
6703        let mut harness = Harness::simple(4, 0, "acme/app");
6704        harness
6705            .reconciler
6706            .set_intervals(RefreshInterval::default(), Duration::from_secs(10));
6707        let now = harness.clock.now();
6708        harness.demand.set(PollOutcome::Ready(
6709            QueuedDemand::of(repo("acme/app"), Vec::new())
6710                .with_rate_limit(Some(quota(200, 1_800, now))),
6711        ));
6712        let policy = policy(1, "acme/app", 4);
6713
6714        let report = harness
6715            .reconciler
6716            .reconcile(std::slice::from_ref(&policy))
6717            .await;
6718
6719        assert_eq!(
6720            report.next_poll.pace,
6721            PollPace::Stretched {
6722                pressure: PrimaryPressure::Critical
6723            }
6724        );
6725        assert_eq!(report.next_poll.delay, Duration::from_secs(240));
6726    }
6727
6728    // =======================================================================
6729    // Offline, end to end
6730    // =======================================================================
6731
6732    /// `e1`'s Definition of Done: *"An unreachable GitHub yields `offline`, zero
6733    /// new runners, retained existing processes, and jittered backoff; recovery
6734    /// resumes polling and does not double-count a job that was already being
6735    /// served."*
6736    #[tokio::test]
6737    async fn an_unreachable_github_starts_nothing_retains_everything_and_backs_off() {
6738        let live = vec![
6739            attempt_in(AttemptState::Busy, 1, 1),
6740            attempt_in(AttemptState::Starting, 2, 1),
6741        ];
6742        let launcher = Arc::new(FakeLauncher::new().seeded(live.clone()));
6743        let demand = Arc::new(FakeDemand::failing(RefreshState::Offline));
6744        let mut harness = Harness::build(
6745            host_with(8),
6746            Arc::clone(&launcher),
6747            Arc::clone(&demand),
6748            Arc::new(InProcessAllocationLock::new()),
6749        );
6750        let policy = policy(1, "acme/app", 8);
6751
6752        let report = harness
6753            .reconciler
6754            .reconcile(std::slice::from_ref(&policy))
6755            .await;
6756
6757        assert!(report.is_offline());
6758        assert_eq!(report.started, 0, "no new runner during an outage");
6759        assert_eq!(launcher.launches(), 0);
6760        assert_eq!(
6761            launcher.snapshot(),
6762            live,
6763            "existing runner processes are retained, untouched"
6764        );
6765        assert_eq!(report.unreadable, vec![PolicyId::from_u128(1)]);
6766        assert_eq!(report.next_poll.pace, PollPace::Offline { consecutive: 1 });
6767        assert!(report.next_poll.delay >= Duration::from_secs(60));
6768        let offline = report.offline_state().expect("an offline state to display");
6769        assert!(offline.to_string().contains("24 hours"));
6770
6771        // Recovery: two jobs are queued, but only the starting runner can
6772        // cover them. The busy runner consumes capacity and serves other work.
6773        demand.set(PollOutcome::Ready(QueuedDemand::of(
6774            repo("acme/app"),
6775            jobs(2),
6776        )));
6777        let recovered = harness.reconciler.reconcile(&[policy]).await;
6778
6779        assert!(!recovered.is_offline());
6780        assert_eq!(recovered.next_poll.pace, PollPace::Nominal);
6781        assert_eq!(
6782            recovered.started, 1,
6783            "two queued jobs and one starting runner leave one job uncovered"
6784        );
6785        assert_eq!(recovered.allocations[0].active_owned, 2);
6786        assert_eq!(launcher.live_count(), 3);
6787    }
6788
6789    /// One unreachable target must not idle a whole host.
6790    ///
6791    /// The failure that decides the *schedule* is the most severe across every
6792    /// target polled — backing the whole loop off during an outage is the safe
6793    /// error, and `f3` runs one reconciler per target anyway, so in production
6794    /// the two are usually the same thing. What must not follow from that is
6795    /// refusing to serve a policy whose own target answered perfectly well, and
6796    /// the two are easy to conflate because the offline reading is sitting in
6797    /// the same map.
6798    #[tokio::test]
6799    async fn one_offline_target_does_not_stop_a_reachable_one() {
6800        let mut harness = Harness::simple(8, 0, "acme/app");
6801        harness.demand.set_for(
6802            &ScaleTarget::repository("acme/app").unwrap(),
6803            PollOutcome::Ready(QueuedDemand::of(repo("acme/app"), jobs(2))),
6804        );
6805        harness.demand.set_for(
6806            &ScaleTarget::repository("acme/broken").unwrap(),
6807            PollOutcome::Failed(RefreshState::Offline),
6808        );
6809
6810        let report = harness
6811            .reconciler
6812            .reconcile(&[policy(1, "acme/app", 4), policy(2, "acme/broken", 4)])
6813            .await;
6814
6815        assert_eq!(
6816            report.started, 2,
6817            "the reachable target was served; an unreachable sibling repository must not \
6818             idle the host"
6819        );
6820        assert_eq!(report.unreadable, vec![PolicyId::from_u128(2)]);
6821        assert_eq!(harness.demand.polls().len(), 2, "both targets were polled");
6822
6823        // And the schedule takes the worse of the two.
6824        assert!(report.is_offline());
6825        assert_eq!(report.next_poll.pace, PollPace::Offline { consecutive: 1 });
6826    }
6827
6828    /// The 24-hour bound has to be reachable in production, not only in a unit
6829    /// test of [`OfflineState`].
6830    ///
6831    /// This was a real gap: the reconciler built its offline state from the
6832    /// back-off count alone, so `offline_for` was always `None` and
6833    /// [`OfflineState::has_outlasted_the_queue`] could never be true outside a
6834    /// test that constructed the value by hand. An operator whose agent had been
6835    /// offline for two days would have been told that an outage longer than 24
6836    /// hours *would* lose queued work, in the future tense, having already lost
6837    /// it.
6838    ///
6839    /// The elapsed time is measured from the first poll of the run rather than
6840    /// derived from the interval, because the back-off doubles and the two
6841    /// diverge immediately.
6842    #[tokio::test]
6843    async fn a_day_long_outage_says_that_queued_work_has_already_been_lost() {
6844        let clock = Arc::new(FakeClock::default());
6845        let launcher = Arc::new(FakeLauncher::new());
6846        let demand = Arc::new(FakeDemand::failing(RefreshState::Offline));
6847        let mut reconciler = Reconciler::new(
6848            host_with(4),
6849            ReconcilerPorts {
6850                demand: Arc::clone(&demand) as Arc<dyn DemandSource>,
6851                launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
6852                lock: Arc::new(InProcessAllocationLock::new()),
6853                directory: Arc::new(FakeDirectory::default()),
6854                clock: Arc::clone(&clock) as Arc<dyn Clock>,
6855                jitter: Arc::new(NoJitter),
6856                events: Arc::new(NoEvents),
6857            },
6858        );
6859        let policy = policy(1, "acme/app", 4);
6860
6861        // The outage begins.
6862        let first = reconciler.reconcile(std::slice::from_ref(&policy)).await;
6863        let state = first.offline_state().expect("an offline state");
6864        assert!(!state.has_outlasted_the_queue());
6865        assert!(
6866            state
6867                .to_string()
6868                .contains("an outage longer than that loses"),
6869            "{state}"
6870        );
6871
6872        // A day and a minute later, still unreachable.
6873        clock.advance_secs(24 * 60 * 60 + 60);
6874        let later = reconciler.reconcile(std::slice::from_ref(&policy)).await;
6875        let state = later.offline_state().expect("an offline state");
6876        assert!(state.has_outlasted_the_queue());
6877        assert!(
6878            state.to_string().contains("queued work has been lost"),
6879            "{state}"
6880        );
6881        assert_eq!(launcher.launches(), 0, "and still nothing was started");
6882
6883        // Recovery closes the run, so a *later* outage measures from itself
6884        // rather than from the first one.
6885        demand.set(PollOutcome::Ready(QueuedDemand::of(
6886            repo("acme/app"),
6887            jobs(0),
6888        )));
6889        let recovered = reconciler.reconcile(std::slice::from_ref(&policy)).await;
6890        assert!(recovered.offline_state().is_none());
6891        assert_eq!(reconciler.schedule().offline_for(clock.now()), None);
6892
6893        demand.set(PollOutcome::Failed(RefreshState::Offline));
6894        let again = reconciler.reconcile(std::slice::from_ref(&policy)).await;
6895        assert!(
6896            !again
6897                .offline_state()
6898                .expect("an offline state")
6899                .has_outlasted_the_queue(),
6900            "a new outage must not inherit the age of the one before it"
6901        );
6902    }
6903
6904    /// Finding 5: the adapter, not the lock underneath it.
6905    ///
6906    /// `d1` covers `LockKind::Allocation` including a contended `acquire_at`
6907    /// with a wait. What that does not reach is this adapter: the
6908    /// `spawn_blocking` wrapper, the collapse of both a refused lock and a
6909    /// panicked blocking task into `AllocationLockBusy`, and — the one that
6910    /// would be silent — whether [`AllocationGuard`] really holds the
6911    /// `HostLock`, since dropping it is the only release there is. A guard that
6912    /// dropped the lock on the way out would make every acquisition succeed and
6913    /// the ceiling would hold by luck.
6914    ///
6915    /// The original disclosure said this needed a real filesystem and was
6916    /// therefore expensive. `AppPaths::rooted_at` plus `tempfile` — already a
6917    /// non-dev dependency of this crate — makes it about fifteen lines, so the
6918    /// reason was weaker than stated.
6919    #[tokio::test]
6920    async fn the_file_allocation_lock_excludes_a_second_holder_and_releases_on_drop() {
6921        let root = tempfile::tempdir().expect("a temporary directory");
6922        let paths = Arc::new(runner_manager_platform::paths::AppPaths::rooted_at(
6923            root.path(),
6924        ));
6925        let lock = FileAllocationLock::new(paths).with_wait(Duration::from_millis(50));
6926
6927        let held = lock.acquire().await.expect("an uncontended lock is free");
6928        assert!(
6929            matches!(lock.acquire().await, Err(AllocationLockBusy)),
6930            "a second holder was admitted; on Unix the lock is per open file description \
6931             and on Windows the share mode denies write, so this must be refused even \
6932             from inside the same process"
6933        );
6934
6935        drop(held);
6936        let regained = lock.acquire().await;
6937        assert!(
6938            regained.is_ok(),
6939            "dropping the guard is the only release there is, so a guard that does not \
6940             hold the `HostLock` leaves it held forever"
6941        );
6942    }
6943
6944    #[test]
6945    fn tee_events_reaches_both_sinks() {
6946        // `f3` wires the log sink and `g2`'s buffer at once, and an event that
6947        // reached only one of them would be an activity view missing lines the
6948        // log file has, or the reverse.
6949        let left = Arc::new(EventLog::new());
6950        let right = Arc::new(EventLog::new());
6951        let tee = TeeEvents(
6952            Arc::clone(&left) as Arc<dyn EventSink>,
6953            Arc::clone(&right) as Arc<dyn EventSink>,
6954        );
6955
6956        tee.emit(LifecycleEvent::MonitorOnlySkipped {
6957            policy: PolicyId::from_u128(1),
6958        });
6959
6960        assert_eq!(left.count_of("monitor_only_skipped"), 1);
6961        assert_eq!(right.count_of("monitor_only_skipped"), 1);
6962    }
6963
6964    // =======================================================================
6965    // Budget: the repository list, and the per-target poll
6966    // =======================================================================
6967
6968    #[tokio::test]
6969    async fn the_repository_list_refreshes_far_more_slowly_than_the_demand_poll() {
6970        let clock = Arc::new(FakeClock::default());
6971        let directory = Arc::new(FakeDirectory::of(vec![repo("acme/one"), repo("acme/two")]));
6972        let cache = RepositoryCache::new(
6973            Arc::clone(&directory) as Arc<dyn RepositoryDirectory>,
6974            Arc::clone(&clock) as Arc<dyn Clock>,
6975            RefreshInterval::default(),
6976        );
6977        let target = ScaleTarget::organization("acme").unwrap();
6978
6979        assert_eq!(
6980            cache.ttl(),
6981            Duration::from_secs(60 * u64::from(REPOSITORY_LIST_REFRESH_MULTIPLE))
6982        );
6983
6984        // Every poll inside the window reuses the list.
6985        for _ in 0..REPOSITORY_LIST_REFRESH_MULTIPLE {
6986            let scope = cache.scope_for(&target).await.unwrap();
6987            assert_eq!(scope.repositories().len(), 2);
6988            clock.advance_secs(60);
6989        }
6990        assert_eq!(
6991            directory.calls(),
6992            1,
6993            "re-listing an organization at demand-poll frequency is what exhausts the \
6994             shared request budget"
6995        );
6996        assert_eq!(cache.lookups(), 1);
6997
6998        // Past it, exactly one more.
6999        cache.scope_for(&target).await.unwrap();
7000        assert_eq!(directory.calls(), 2);
7001    }
7002
7003    #[tokio::test]
7004    async fn a_repository_target_never_consults_the_directory() {
7005        let directory = Arc::new(FakeDirectory::of(vec![repo("acme/other")]));
7006        let cache = RepositoryCache::new(
7007            Arc::clone(&directory) as Arc<dyn RepositoryDirectory>,
7008            Arc::new(FakeClock::default()) as Arc<dyn Clock>,
7009            RefreshInterval::default(),
7010        );
7011        let target = ScaleTarget::repository("acme/app").unwrap();
7012
7013        let scope = cache.scope_for(&target).await.unwrap();
7014        assert_eq!(scope.repositories(), &[repo("acme/app")]);
7015        assert_eq!(directory.calls(), 0);
7016    }
7017
7018    #[tokio::test]
7019    async fn two_policies_on_one_target_cost_one_demand_poll_not_two() {
7020        // `04-subsystem-contracts.md` prices a *target*. A loop that spent per
7021        // policy would exceed the projection `f2` admitted the configuration
7022        // against, silently.
7023        let mut harness = Harness::simple(8, 4, "o/r");
7024        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7025            repo("o/r"),
7026            [
7027                fixtures::queued_job(&[HOST_LABEL]),
7028                fixtures::queued_job(&[HOST_LABEL]),
7029                fixtures::queued_job(&["rm-home-win-x64-py-isolated"]),
7030                fixtures::queued_job(&["rm-home-win-x64-py-isolated"]),
7031            ],
7032        )));
7033        let mut isolated = fixtures::named_policy("py-isolated", PolicyId::from_u128(2));
7034        isolated.activate().unwrap();
7035        let report = harness
7036            .reconciler
7037            .reconcile(&[policy(1, "o/r", 2), isolated])
7038            .await;
7039
7040        assert_eq!(harness.demand.polls().len(), 1);
7041        assert_eq!(report.targets_read, 1, "profiles share one target reading");
7042        assert_eq!(
7043            report.demand_requests,
7044            runner_manager_github::demand::DEMAND_REQUESTS_PER_REPOSITORY_PER_POLL,
7045            "one repository's worth of demand requests, not two policies' worth. Read              from the constant rather than written as a literal so that repricing the              poll cannot silently turn this into an assertion about the wrong thing"
7046        );
7047        assert_eq!(
7048            report.started, 4,
7049            "native and isolated profiles each get two"
7050        );
7051    }
7052
7053    #[tokio::test]
7054    async fn subset_labels_without_selector_scale_only_the_compatible_local_profile() {
7055        use runner_manager_domain::model::{Arch, HostLabel, Os};
7056        use runner_manager_domain::policy::RoutingLabels;
7057        let mut harness = Harness::build(
7058            fixtures::host()
7059                .os(Os::MacOs)
7060                .architecture(Arch::Arm64)
7061                .capacity(10)
7062                .build(),
7063            Arc::new(FakeLauncher::new()),
7064            Arc::new(FakeDemand::ready(0, &repo("o/r"))),
7065            Arc::new(InProcessAllocationLock::new()),
7066        );
7067        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7068            repo("o/r"),
7069            [
7070                fixtures::queued_job(&["self-hosted", "macOS", "ARM64"]),
7071                fixtures::queued_job(&["SELF-HOSTED", "MACOS", "arm64"]),
7072                fixtures::queued_job(&["self-hosted", "macOS", "X64"]),
7073                fixtures::queued_job(&["self-hosted", "Windows", "ARM64"]),
7074                fixtures::queued_job(&["self-hosted", "macOS", "ARM64", "gpu"]),
7075                fixtures::queued_job(&["rm-other-osx-arm64", "macOS", "ARM64"]),
7076            ],
7077        )));
7078        let mut local = fixtures::policy()
7079            .id(PolicyId::from_u128(1))
7080            .repository("o/r")
7081            .autoscale("macmini", 10)
7082            .routing_labels(RoutingLabels::derive(
7083                &HostLabel::new("macmini").unwrap(),
7084                Os::MacOs,
7085                Arch::Arm64,
7086            ))
7087            .active()
7088            .build();
7089        for label in ["self-hosted", "macos", "arm64", "extra"] {
7090            local.add_routing_label(fixtures::label(label)).unwrap();
7091        }
7092        let mut foreign = local.to_persisted();
7093        foreign.id = PolicyId::from_u128(2);
7094        foreign.host_id = HostId::from_u128(0xdead);
7095        let foreign = ScalePolicy::from_persisted(foreign).unwrap();
7096        let report = harness.reconciler.reconcile(&[local, foreign]).await;
7097        assert_eq!(report.started, 2);
7098        assert_eq!(report.targets_read, 1);
7099        assert!(harness.events.events().iter().any(|event| matches!(
7100            event,
7101            LifecycleEvent::DemandObserved {
7102                demand: 2,
7103                not_matched: 4,
7104                ..
7105            }
7106        )));
7107        assert!(
7108            !harness
7109                .events
7110                .events()
7111                .iter()
7112                .any(|event| matches!(event, LifecycleEvent::RoutingRefused { .. }))
7113        );
7114    }
7115
7116    #[tokio::test]
7117    async fn isolated_overlap_never_falls_back_to_native_in_either_state_or_order() {
7118        use runner_manager_domain::execution::{
7119            Backend, ExecutionPolicy, ImageReference, ResourceLimits,
7120        };
7121        let mut native = policy(1, "o/r", 2);
7122        native
7123            .add_routing_label(fixtures::label("self-hosted"))
7124            .unwrap();
7125        let mut isolated = fixtures::named_policy("py-isolated", PolicyId::from_u128(2));
7126        isolated
7127            .add_routing_label(fixtures::label("self-hosted"))
7128            .unwrap();
7129        isolated
7130            .set_execution_policy(ExecutionPolicy::Isolated {
7131                backend: Backend::Oci,
7132                image: ImageReference::new(format!(
7133                    "registry.example/runner@sha256:{}",
7134                    "a".repeat(64)
7135                ))
7136                .unwrap(),
7137                resources: ResourceLimits {
7138                    cpu_millis: 1000,
7139                    memory_mib: 512,
7140                    disk_mib: 1024,
7141                },
7142            })
7143            .unwrap();
7144        assert!(!isolated.may_start_runners());
7145        let mut active_isolated = isolated.clone();
7146        active_isolated.activate().unwrap();
7147        for profiles in [
7148            [native.clone(), isolated.clone()],
7149            [isolated.clone(), native.clone()],
7150            [native.clone(), active_isolated.clone()],
7151            [active_isolated, native.clone()],
7152        ] {
7153            let mut harness = Harness::simple(4, 0, "o/r");
7154            harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7155                repo("o/r"),
7156                [fixtures::queued_job(&["SELF-HOSTED"])],
7157            )));
7158            let report = harness.reconciler.reconcile(&profiles).await;
7159            assert_eq!(report.started, 0);
7160            assert!(harness.events.events().iter().any(|event| matches!(
7161                event,
7162                LifecycleEvent::RoutingRefused {
7163                    reason: RoutingRefusal::OverlappingProfiles,
7164                    count: 1,
7165                    ..
7166                }
7167            )));
7168        }
7169        // A job explicitly requiring the unavailable isolated selector cannot
7170        // be served by the native sibling either.
7171        let mut harness = Harness::simple(4, 0, "o/r");
7172        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7173            repo("o/r"),
7174            [fixtures::queued_job(&["rm-home-win-x64-py-isolated"])],
7175        )));
7176        assert_eq!(
7177            harness
7178                .reconciler
7179                .reconcile(&[native, isolated])
7180                .await
7181                .started,
7182            0
7183        );
7184    }
7185
7186    #[tokio::test]
7187    async fn shared_optional_labels_do_not_duplicate_native_and_isolated_demand() {
7188        let mut harness = Harness::simple(2, 0, "o/r");
7189        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7190            repo("o/r"),
7191            [
7192                fixtures::queued_job(&[HOST_LABEL, "gpu"]),
7193                fixtures::queued_job(&["rm-home-win-x64-py-isolated", "gpu"]),
7194                fixtures::queued_job(&["gpu"]),
7195                fixtures::unresolvable_job(),
7196            ],
7197        )));
7198        let mut native = policy(1, "o/r", 2);
7199        native.add_routing_label(fixtures::label("gpu")).unwrap();
7200        let mut isolated = fixtures::named_policy("py-isolated", PolicyId::from_u128(2));
7201        isolated.add_routing_label(fixtures::label("gpu")).unwrap();
7202        isolated.activate().unwrap();
7203
7204        let report = harness.reconciler.reconcile(&[native, isolated]).await;
7205        assert_eq!(harness.demand.polls().len(), 1);
7206        assert_eq!(report.targets_read, 1);
7207        assert_eq!(report.started, 2);
7208        assert_eq!(report.allocations.len(), 2);
7209        assert!(
7210            report
7211                .allocations
7212                .iter()
7213                .all(|allocation| allocation.to_start == 1)
7214        );
7215        assert!(harness.events.events().iter().any(|event| matches!(
7216            event,
7217            LifecycleEvent::RoutingRefused {
7218                reason: RoutingRefusal::OverlappingProfiles,
7219                count: 1,
7220                ..
7221            }
7222        )));
7223        assert_eq!(
7224            harness
7225                .events
7226                .events()
7227                .iter()
7228                .filter(|event| matches!(
7229                    event,
7230                    LifecycleEvent::DemandObserved {
7231                        unresolvable: 1,
7232                        ..
7233                    }
7234                ))
7235                .count(),
7236            2,
7237            "an expression stays unresolvable for both profiles"
7238        );
7239    }
7240
7241    #[tokio::test]
7242    async fn an_exclusion_starts_a_runner_registered_with_it_only_where_it_holds() {
7243        let queued = || {
7244            PollOutcome::Ready(QueuedDemand::of(
7245                repo("o/r"),
7246                [
7247                    fixtures::queued_job(&[HOST_LABEL, "not-wsl", "not-gpu"]),
7248                    fixtures::queued_job(&[HOST_LABEL]),
7249                ],
7250            ))
7251        };
7252
7253        // A machine outside WSL: both jobs are demand, and the runners carry
7254        // `not-wsl` (its own) and `not-gpu` (what a job excludes).
7255        let mut native = Harness::simple(4, 0, "o/r");
7256        native.reconciler = native.reconciler.with_host_traits(HostTraits::wsl(false));
7257        native.demand.set(queued());
7258        let report = native.reconciler.reconcile(&[policy(1, "o/r", 4)]).await;
7259        assert_eq!(report.started, 2);
7260        for labels in native.launcher.registered.lock().unwrap().iter() {
7261            assert_eq!(
7262                labels,
7263                &vec![HOST_LABEL.to_string(), "not-gpu".into(), "not-wsl".into()]
7264            );
7265        }
7266
7267        // Kept for the policy's later runners: one already waiting can then
7268        // take the next job that names the exclusion.
7269        native.demand.set(PollOutcome::Ready(QueuedDemand::of(
7270            repo("o/r"),
7271            fixtures::queued_jobs(&[HOST_LABEL], 4),
7272        )));
7273        native.launcher.registered.lock().unwrap().clear();
7274        native.reconciler.reconcile(&[policy(1, "o/r", 6)]).await;
7275        let later = native.launcher.registered.lock().unwrap().clone();
7276        assert!(!later.is_empty());
7277        assert!(
7278            later
7279                .iter()
7280                .all(|labels| labels.contains(&"not-gpu".to_string()))
7281        );
7282
7283        // Inside WSL: the excluding job is not this host's, the other is.
7284        let mut wsl = Harness::simple(4, 0, "o/r");
7285        wsl.reconciler = wsl.reconciler.with_host_traits(HostTraits::wsl(true));
7286        wsl.demand.set(queued());
7287        let report = wsl.reconciler.reconcile(&[policy(1, "o/r", 4)]).await;
7288        assert_eq!(report.started, 1);
7289        assert_eq!(
7290            wsl.launcher.registered.lock().unwrap().as_slice(),
7291            [vec![HOST_LABEL.to_string(), "wsl".into()]]
7292        );
7293
7294        // A profile carrying `gpu` serves neither the exclusion nor registers it.
7295        let mut gpu = Harness::simple(4, 0, "o/r");
7296        gpu.demand.set(queued());
7297        let mut carrying = policy(1, "o/r", 4);
7298        carrying.add_routing_label(fixtures::label("gpu")).unwrap();
7299        let report = gpu.reconciler.reconcile(&[carrying]).await;
7300        assert_eq!(report.started, 1);
7301        assert_eq!(
7302            gpu.launcher.registered.lock().unwrap().as_slice(),
7303            [vec![HOST_LABEL.to_string(), "gpu".into()]]
7304        );
7305    }
7306
7307    #[tokio::test]
7308    async fn without_exclusions_or_traits_a_runner_registers_exactly_its_profile_labels() {
7309        let mut harness = Harness::simple(4, 2, "o/r");
7310        let report = harness.reconciler.reconcile(&[policy(1, "o/r", 4)]).await;
7311        assert_eq!(report.started, 2);
7312        assert_eq!(
7313            harness.launcher.registered.lock().unwrap().as_slice(),
7314            [vec![HOST_LABEL.to_string()], vec![HOST_LABEL.to_string()]]
7315        );
7316    }
7317
7318    #[tokio::test]
7319    async fn a_job_no_runner_can_satisfy_is_refused_by_name_not_counted() {
7320        let mut harness = Harness::simple(4, 0, "o/r");
7321        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7322            repo("o/r"),
7323            [
7324                fixtures::queued_job(&[HOST_LABEL, "not-"]),
7325                // Another machine's job: not this host's to report.
7326                fixtures::queued_job(&["rm-other-linux-x64", "gpu", "not-gpu"]),
7327            ],
7328        )));
7329        let report = harness.reconciler.reconcile(&[policy(1, "o/r", 4)]).await;
7330        assert_eq!(report.started, 0);
7331        assert!(harness.events.events().iter().any(|event| matches!(
7332            event,
7333            LifecycleEvent::RoutingRefused {
7334                reason: RoutingRefusal::UnsatisfiableExclusion,
7335                count: 1,
7336                ..
7337            }
7338        )));
7339        assert!(harness.events.events().iter().any(|event| matches!(
7340            event,
7341            LifecycleEvent::DemandObserved {
7342                demand: 0,
7343                unresolvable: 2,
7344                ..
7345            }
7346        )));
7347    }
7348
7349    #[tokio::test]
7350    async fn missing_required_selector_labels_do_not_match_and_overlaps_show_remedies() {
7351        let mut harness = Harness::simple(4, 0, "o/r");
7352        harness.demand.set(PollOutcome::Ready(QueuedDemand::of(
7353            repo("o/r"),
7354            [fixtures::queued_job(&[
7355                HOST_LABEL,
7356                "rm-home-win-x64-py-isolated",
7357            ])],
7358        )));
7359        let mut isolated = fixtures::named_policy("py-isolated", PolicyId::from_u128(2));
7360        isolated.activate().unwrap();
7361        let report = harness
7362            .reconciler
7363            .reconcile(&[policy(1, "o/r", 2), isolated])
7364            .await;
7365        assert_eq!(report.started, 0);
7366        assert_eq!(
7367            harness
7368                .events
7369                .events()
7370                .iter()
7371                .filter(|event| matches!(
7372                    event,
7373                    LifecycleEvent::DemandObserved {
7374                        demand: 0,
7375                        not_matched: 1,
7376                        ..
7377                    }
7378                ))
7379                .count(),
7380            2
7381        );
7382
7383        // Domain constructors permit extra selector-shaped labels. Routing
7384        // depends on all required labels and unique ownership, not their shape.
7385        // The store separately rejects sibling selector reuse on write/load.
7386        let mut superset = policy(1, "o/r", 2);
7387        assert!(
7388            superset
7389                .add_routing_label(fixtures::label("rm-home-win-x64-py-isolated"))
7390                .unwrap()
7391        );
7392        let mut sibling = fixtures::named_policy("py-isolated", PolicyId::from_u128(2));
7393        sibling.activate().unwrap();
7394        let mut unique = Harness::simple(4, 0, "o/r");
7395        unique.demand.set(PollOutcome::Ready(QueuedDemand::of(
7396            repo("o/r"),
7397            [fixtures::queued_job(&[
7398                HOST_LABEL,
7399                "rm-home-win-x64-py-isolated",
7400            ])],
7401        )));
7402        let report = unique.reconciler.reconcile(&[superset, sibling]).await;
7403        assert_eq!(report.started, 1);
7404        assert_eq!(
7405            report
7406                .allocations
7407                .iter()
7408                .find(|allocation| allocation.to_start == 1)
7409                .unwrap()
7410                .policy_id,
7411            PolicyId::from_u128(1)
7412        );
7413        assert!(
7414            !unique
7415                .events
7416                .events()
7417                .iter()
7418                .any(|event| matches!(event, LifecycleEvent::RoutingRefused { .. }))
7419        );
7420
7421        let mut overlap = Harness::simple(4, 1, "o/r");
7422        let report = overlap
7423            .reconciler
7424            .reconcile(&[policy(1, "o/r", 2), policy(2, "o/r", 2)])
7425            .await;
7426        assert_eq!(report.started, 0);
7427        assert!(overlap.events.events().iter().any(|event| matches!(
7428            event,
7429            LifecycleEvent::RoutingRefused {
7430                reason: RoutingRefusal::OverlappingProfiles,
7431                count: 1,
7432                ..
7433            }
7434        )));
7435        assert!(
7436            RoutingRefusal::OverlappingProfiles
7437                .to_string()
7438                .contains("repair")
7439        );
7440    }
7441
7442    // =======================================================================
7443    // Failure paths
7444    // =======================================================================
7445
7446    #[tokio::test]
7447    async fn a_failed_launch_stops_the_run_and_is_reported_without_free_text() {
7448        let launcher = Arc::new(FakeLauncher::new());
7449        launcher.fail_next(FailureReason::Other("token ghp_0123456789abcdef".into()));
7450        let mut harness = Harness::build(
7451            host_with(4),
7452            Arc::clone(&launcher),
7453            Arc::new(FakeDemand::ready(3, &repo("acme/app"))),
7454            Arc::new(InProcessAllocationLock::new()),
7455        );
7456
7457        let report = harness
7458            .reconciler
7459            .reconcile(&[policy(1, "acme/app", 4)])
7460            .await;
7461        assert_eq!(report.started, 0);
7462        assert_eq!(report.allocations[0].to_start, 3, "the decision stands");
7463
7464        let failures: Vec<&'static str> = harness
7465            .events
7466            .events()
7467            .into_iter()
7468            .filter_map(|event| match event {
7469                LifecycleEvent::RunnerStartFailed { reason, .. } => Some(reason),
7470                _ => None,
7471            })
7472            .collect();
7473        assert_eq!(failures, vec!["other"]);
7474        assert!(
7475            !failures[0].contains("ghp_"),
7476            "an event carried a `FailureReason::Other` detail verbatim"
7477        );
7478    }
7479
7480    /// The host-fitness preflight: while a required host check fails, the pass
7481    /// still decides what it would start, but nothing reaches the inner
7482    /// launcher -- so nothing is registered with GitHub -- and the event names
7483    /// `host_unfit`. Clearing the flag lets the next pass start runners.
7484    #[tokio::test]
7485    async fn an_unfit_host_registers_no_runner_and_reports_host_unfit() {
7486        let launcher = Arc::new(FakeLauncher::new());
7487        let unfit = Arc::new(AtomicBool::new(true));
7488        let events = Arc::new(EventLog::new());
7489        let mut reconciler = Reconciler::new(
7490            host_with(4),
7491            ReconcilerPorts {
7492                demand: Arc::new(FakeDemand::ready(2, &repo("acme/app"))),
7493                launcher: Arc::new(FitnessGatedLauncher::new(
7494                    Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
7495                    Arc::clone(&unfit),
7496                )),
7497                lock: Arc::new(InProcessAllocationLock::new()),
7498                directory: Arc::new(FakeDirectory::default()),
7499                clock: Arc::new(FakeClock::default()) as Arc<dyn Clock>,
7500                jitter: Arc::new(NoJitter) as Arc<dyn Jitter>,
7501                events: Arc::clone(&events) as Arc<dyn EventSink>,
7502            },
7503        );
7504        let policies = [policy(1, "acme/app", 4)];
7505
7506        let report = reconciler.reconcile(&policies).await;
7507        assert_eq!(report.started, 0);
7508        assert_eq!(launcher.launches(), 0, "the inner launcher must not run");
7509        let reasons: Vec<&'static str> = events
7510            .events()
7511            .into_iter()
7512            .filter_map(|event| match event {
7513                LifecycleEvent::RunnerStartFailed { reason, .. } => Some(reason),
7514                _ => None,
7515            })
7516            .collect();
7517        assert_eq!(reasons, ["host_unfit"]);
7518
7519        unfit.store(false, Ordering::Release);
7520        let report = reconciler.reconcile(&policies).await;
7521        assert_eq!(report.started, 2);
7522        assert_eq!(launcher.launches(), 2);
7523    }
7524
7525    #[tokio::test]
7526    async fn a_held_allocation_lock_starts_nothing_and_says_so() {
7527        let launcher = Arc::new(FakeLauncher::new());
7528        let mut harness = Harness::build(
7529            host_with(4),
7530            Arc::clone(&launcher),
7531            Arc::new(FakeDemand::ready(3, &repo("acme/app"))),
7532            Arc::new(HeldLock),
7533        );
7534
7535        let report = harness
7536            .reconciler
7537            .reconcile(&[policy(1, "acme/app", 4)])
7538            .await;
7539        assert_eq!(report.started, 0);
7540        assert_eq!(
7541            report.deferred, 3,
7542            "three runners were granted and none was created; `deferred` counts grants, \
7543             not policies -- it reported `1` when a policy that launched two of five and \
7544             then lost the lock had left three unstarted"
7545        );
7546        assert_eq!(launcher.launches(), 0);
7547        assert_eq!(harness.events.count_of("allocation_deferred"), 1);
7548        assert!(
7549            harness
7550                .events
7551                .events()
7552                .iter()
7553                .any(|event| matches!(event, LifecycleEvent::AllocationDeferred { count: 3, .. })),
7554            "the event carries the same number the report does"
7555        );
7556        assert_eq!(
7557            report.allocations.len(),
7558            1,
7559            "the intent is still reported, so an operator staring at a queue sees why \
7560             nothing started"
7561        );
7562    }
7563
7564    #[tokio::test]
7565    async fn a_foreign_or_draining_policy_is_reported_by_name_and_polls_nothing() {
7566        let mut harness = Harness::simple(8, 5, "acme/app");
7567
7568        let foreign = fixtures::policy()
7569            .id(PolicyId::from_u128(1))
7570            .repository("acme/app")
7571            .host(HostId::from_u128(0xdead))
7572            .autoscale("office", 4)
7573            .active()
7574            .build();
7575        let mut draining = policy(2, "acme/app", 4);
7576        draining.request_disable().unwrap();
7577
7578        let report = harness.reconciler.reconcile(&[foreign, draining]).await;
7579
7580        assert_eq!(report.started, 0);
7581        assert_eq!(
7582            harness.demand.polls().len(),
7583            0,
7584            "neither can act on an answer"
7585        );
7586        let factors: Vec<LimitingFactor> = report
7587            .allocations
7588            .iter()
7589            .map(|a| a.limiting_factor)
7590            .collect();
7591        assert!(factors.contains(&LimitingFactor::ForeignHost));
7592        assert!(factors.contains(&LimitingFactor::NotReconciling));
7593    }
7594
7595    #[tokio::test]
7596    async fn an_unreadable_repository_list_makes_the_target_unreadable_not_empty() {
7597        // Polling a scope nobody chose would report a demand number for the
7598        // wrong set of repositories, which is worse than reporting nothing.
7599        #[derive(Debug)]
7600        struct BrokenDirectory;
7601
7602        #[async_trait::async_trait]
7603        impl RepositoryDirectory for BrokenDirectory {
7604            async fn repositories(&self, _org: &Org) -> Result<Vec<OwnerRepo>, InventoryError> {
7605                Err(InventoryError::Cancelled)
7606            }
7607        }
7608
7609        let launcher = Arc::new(FakeLauncher::new());
7610        let events = Arc::new(EventLog::new());
7611        let mut reconciler = Reconciler::new(
7612            host_with(4),
7613            ReconcilerPorts {
7614                demand: Arc::new(FakeDemand::default()),
7615                launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
7616                lock: Arc::new(InProcessAllocationLock::new()),
7617                directory: Arc::new(BrokenDirectory),
7618                clock: Arc::new(FakeClock::default()),
7619                jitter: Arc::new(NoJitter),
7620                events: Arc::clone(&events) as Arc<dyn EventSink>,
7621            },
7622        );
7623
7624        let org_policy = fixtures::policy()
7625            .id(PolicyId::from_u128(1))
7626            .organization("acme")
7627            .autoscale("home", 4)
7628            .active()
7629            .build();
7630
7631        let report = reconciler.reconcile(&[org_policy]).await;
7632        assert_eq!(report.started, 0);
7633        assert_eq!(report.unreadable, vec![PolicyId::from_u128(1)]);
7634        assert_eq!(events.count_of("target_unreadable"), 1);
7635    }
7636
7637    // =======================================================================
7638    // What the events may carry
7639    // =======================================================================
7640
7641    /// One value of every [`LifecycleEvent`] variant.
7642    ///
7643    /// Hand-written, and what keeps it honest is the wildcard-free `match` in
7644    /// [`LifecycleEvent::name`]: adding a variant stops that compiling and puts
7645    /// the author here. The same residual `b1` records for `FailureReason::ALL`
7646    /// applies — an author who writes the `name` arm and forgets this list gets
7647    /// a green suite with the variant unscanned.
7648    fn every_event() -> Vec<LifecycleEvent> {
7649        let policy = PolicyId::from_u128(0xabcd_ef01);
7650        let attempt = AttemptId::from_u128(0x1234_5678);
7651        vec![
7652            LifecycleEvent::DemandObserved {
7653                policy,
7654                demand: u32::MAX,
7655                not_matched: u32::MAX,
7656                unresolvable: u32::MAX,
7657                complete: false,
7658            },
7659            LifecycleEvent::TargetUnreadable {
7660                policy,
7661                reason: unreadable_reason(&RefreshState::Failed {
7662                    status: Some(500),
7663                    message: "Authorization: Bearer ghp_0123456789abcdefghijklmnopqrstuvwxyz"
7664                        .into(),
7665                }),
7666            },
7667            LifecycleEvent::Allocated {
7668                policy,
7669                demand: u32::MAX,
7670                desired: u16::MAX,
7671                active_owned: 7,
7672                headroom: 9,
7673                to_start: 2,
7674                limiting: LimitingFactor::HostCapacity,
7675            },
7676            LifecycleEvent::MonitorOnlySkipped { policy },
7677            LifecycleEvent::RunnerStarted { policy, attempt },
7678            LifecycleEvent::RunnerStartFailed {
7679                policy,
7680                reason: failure_reason_kind(&FailureReason::Other(
7681                    "Authorization: Bearer ghp_0123456789abcdefghijklmnopqrstuvwxyz".into(),
7682                )),
7683            },
7684            LifecycleEvent::AllocationDeferred { policy, count: 4 },
7685            LifecycleEvent::AttemptsUnreadable {
7686                reason: failure_reason_kind(&FailureReason::Other(
7687                    "x-api-key: ghp_0123456789abcdefghijklmnopqrstuvwxyz".into(),
7688                )),
7689            },
7690            LifecycleEvent::HostCapacityUnreadable {
7691                reason: HostCapacityError::MissingHost,
7692            },
7693            LifecycleEvent::HostCapacityUnreadable {
7694                reason: HostCapacityError::JournalUnreadable,
7695            },
7696            LifecycleEvent::AttemptCleanFailed {
7697                policy,
7698                attempt,
7699                reason: failure_reason_kind(&FailureReason::ProcessExitedUnexpectedly),
7700            },
7701            LifecycleEvent::AttemptCleaned {
7702                policy,
7703                attempt,
7704                outcome: OutcomeKind::IdleExit,
7705            },
7706            LifecycleEvent::ScaleDownRefused { policy, attempt },
7707            LifecycleEvent::PollScheduled {
7708                retry_in_ms: 900_000,
7709                pace: PollPace::RateLimited {
7710                    kind: RateLimitKind::Primary,
7711                },
7712            },
7713        ]
7714    }
7715
7716    /// `e1`'s Definition of Done: *"No emitted event contains a token, a JIT
7717    /// blob, or a credential header."*
7718    ///
7719    /// Asserted by rendering every variant and putting the result through `d1`'s
7720    /// own scrubber: if any of it looked like a credential to the redactor that
7721    /// guards the log file, the round trip would not be the identity. The
7722    /// positive control at the bottom is what stops that assertion passing
7723    /// because the scrubber is asleep.
7724    #[test]
7725    fn no_emitted_event_can_carry_a_credential() {
7726        use runner_manager_platform::logging::redact;
7727
7728        for event in every_event() {
7729            let displayed = event.to_string();
7730            assert_eq!(
7731                redact(&displayed),
7732                displayed,
7733                "`{}` renders something `d1`'s sink would have to redact",
7734                event.name()
7735            );
7736
7737            let debugged = format!("{event:?}");
7738            assert_eq!(
7739                redact(&debugged),
7740                debugged,
7741                "`{}`'s Debug renders something `d1`'s sink would have to redact",
7742                event.name()
7743            );
7744        }
7745
7746        // The control: the scrubber is awake, and would have caught a credential
7747        // had one been there.
7748        let secret = "Authorization: Bearer ghp_0123456789abcdefghijklmnopqrstuvwxyz";
7749        assert_ne!(
7750            redact(secret),
7751            secret,
7752            "the scan above proves nothing if `redact` no longer recognises a credential"
7753        );
7754    }
7755
7756    #[test]
7757    fn every_field_name_this_sink_emits_is_one_d1_allows() {
7758        use runner_manager_platform::logging::is_field_allowed;
7759
7760        // The names `TracingEvents` writes. Kept beside the sink rather than
7761        // derived from it, because a derived list would move with the code and
7762        // assert nothing.
7763        for field in [
7764            "event",
7765            "policy_id",
7766            "attempt_id",
7767            "attempt_state",
7768            "demand",
7769            "desired",
7770            "capacity",
7771            "headroom",
7772            "count",
7773            "reason",
7774            "outcome",
7775            "mode",
7776            "lock",
7777            "retry_in_ms",
7778            "state",
7779        ] {
7780            assert!(
7781                is_field_allowed(field),
7782                "`{field}` is not on `d1`'s allow-list, so this sink would emit \
7783                 `[redacted]` in its place and the line would lose its meaning"
7784            );
7785        }
7786    }
7787
7788    #[test]
7789    fn every_failure_reason_has_a_credential_free_kind() {
7790        for reason in FailureReason::ALL {
7791            let kind = failure_reason_kind(&reason);
7792            assert!(!kind.is_empty());
7793            assert!(
7794                kind.chars().all(|c| c.is_ascii_lowercase() || c == '_'),
7795                "`{kind}` is not a fixed identifier"
7796            );
7797        }
7798        assert_eq!(
7799            failure_reason_kind(&FailureReason::Other("ghp_secret".into())),
7800            "other",
7801            "the detail of an `Other` reason never reaches an event"
7802        );
7803        let categories = [
7804            IsolationProviderFailure::NotInstalled,
7805            IsolationProviderFailure::PermissionDenied,
7806            IsolationProviderFailure::ImageUnavailableOrIncompatible,
7807            IsolationProviderFailure::DiskQuotaUnavailable,
7808            IsolationProviderFailure::RuntimeOperationFailed,
7809        ];
7810        let mut kinds = std::collections::BTreeSet::new();
7811        for category in categories {
7812            let kind = failure_reason_kind(&FailureReason::IsolationProvider(category));
7813            assert_ne!(kind, "other");
7814            assert!(!kind.contains("secret"));
7815            kinds.insert(kind);
7816        }
7817        assert_eq!(kinds.len(), categories.len());
7818    }
7819
7820    // =======================================================================
7821    // The two tripwires
7822    // =======================================================================
7823
7824    /// One source file's production half, with comment lines dropped.
7825    ///
7826    /// Both exclusions are `c4`'s, and load-bearing for the same reasons. The
7827    /// **test module** goes because the tests in it legitimately name the shapes
7828    /// they forbid — this module's own positive control is a literal
7829    /// `async fn acquire_jobs`, which would accuse the file of the thing it is
7830    /// proving it does not do. The **comments** go because this module's
7831    /// documentation explains the seam at length and has to name what does not
7832    /// exist in order to say why; a scan that forbade the explanation is a scan
7833    /// that gets the explanation deleted.
7834    fn production_half_of(source: &str) -> String {
7835        let production = source
7836            .split_once("\n#[cfg(test)]")
7837            .map_or(source, |(production, _)| production);
7838        production
7839            .lines()
7840            .filter(|line| !line.trim_start().starts_with("//"))
7841            .collect::<Vec<_>>()
7842            .join("\n")
7843    }
7844
7845    /// This file's own production half.
7846    fn this_file_above_its_tests_without_prose() -> String {
7847        production_half_of(include_str!("reconcile.rs"))
7848    }
7849
7850    /// The one normalisation both halves of the scan use.
7851    ///
7852    /// # This is a second copy of `crates/github/src/demand.rs`, deliberately
7853    ///
7854    /// `production_half_of`, this function, [`FORBIDDEN`] and
7855    /// `forbidden_shape_in` together duplicate `demand.rs:1530-1619`. Sharing
7856    /// them would mean putting them in `crates/testkit`, which `e1` does not
7857    /// own, so the copy was the only option available to this task.
7858    ///
7859    /// **It is worth consolidating later, and here is the specific hazard.**
7860    /// The last defect in `c4`'s copy was two spellings of "the same"
7861    /// normalisation drifting apart — the haystack lower-cased and the needle
7862    /// not — which made three of its seven assertions vacuously true from the
7863    /// day they were written. Two copies is the same hazard one level up. The
7864    /// mitigation inside *this* copy is that one function serves both the scan
7865    /// and its positive control, so a normaliser that stops matching fails the
7866    /// control loudly rather than passing the scan silently; what that cannot
7867    /// catch is this copy and `c4`'s diverging from each other.
7868    fn normalise_for_scan(text: &str) -> String {
7869        text.to_ascii_lowercase().replace(['_', ' '], "")
7870    }
7871
7872    /// The Actions-service call this design has no equivalent of, plus the
7873    /// shapes an implementer would invent in its place.
7874    ///
7875    /// Spelled in halves so that no needle ever appears whole in the text being
7876    /// scanned, and keyed to `fn`/`struct` so that the prose above may keep
7877    /// explaining why there is no reservation. `c4` records both trades at
7878    /// length; this list is its counterpart one layer up. Note that the
7879    /// allocation lock's own `fn acquire` is deliberately *not* matched: the
7880    /// needle is `acquire`-a-**job**, and a lock is not one.
7881    const FORBIDDEN: &[&str] = &[
7882        concat!("fn ", "acquire", "_job"),
7883        concat!("fn ", "claim", "_job"),
7884        concat!("fn ", "lease", "_job"),
7885        concat!("fn ", "reserve", "_job"),
7886        concat!("fn ", "ack", "nowledge"),
7887        concat!("struct ", "Job", "Lease"),
7888        concat!("struct ", "Job", "Claim"),
7889        concat!("struct ", "Job", "Reservation"),
7890    ];
7891
7892    fn forbidden_shape_in(source: &str) -> Option<&'static str> {
7893        let haystack = normalise_for_scan(source);
7894        FORBIDDEN
7895            .iter()
7896            .copied()
7897            .find(|forbidden| haystack.contains(&normalise_for_scan(forbidden)))
7898    }
7899
7900    /// `e1`'s Definition of Done: *"No reservation, claim, lease, or acquisition
7901    /// call exists in the crate; a test or review note records that this is
7902    /// deliberate rather than missing."*
7903    ///
7904    /// **Deliberate, not missing.** The scale-set model let a listener call
7905    /// `AcquireJobs` to claim an assignment before scaling; the REST path has no
7906    /// equivalent, so demand is advisory and two hosts serving the same labels
7907    /// can both start a runner for one queued run. Adding a local reservation
7908    /// table would not remove that — the other host cannot see it — it would
7909    /// only hide the surplus case from the tests that measure it. The three
7910    /// controls that actually bound it are host-scoped routing labels,
7911    /// `max_capacity`, and `host_capacity`, and the last two are enforced in
7912    /// this file.
7913    ///
7914    /// The scan is a tripwire on the obvious shape rather than a proof: a
7915    /// reservation reached through a trait method or a differently-named helper
7916    /// would walk past it. Review is the primary control, exactly as `c4` states
7917    /// for its own copy.
7918    ///
7919    /// # It scans the crate, because the bullet says "in the crate"
7920    ///
7921    /// It used to scan this file alone while quoting a crate-wide claim, which
7922    /// left `lifecycle.rs` — `e3`, the launcher, and by far the likeliest place
7923    /// for someone to "fix" the surplus-runner case with a local lease — covered
7924    /// by nothing. Reading another owner's file is not editing it, so ownership
7925    /// was never the obstacle.
7926    ///
7927    /// The walk below is `c4`'s, and it **recurses** for the reason `c4`
7928    /// records: a module directory (`src/reconcile/mod.rs`) arrives as an entry
7929    /// that does not end in `.rs`, so a flat filter drops it and takes every
7930    /// file underneath with it, leaving the scan passing over files it covers
7931    /// by nothing at all. The listed-versus-on-disk assertion is what stops
7932    /// `SOURCES` going stale the moment `e2` or `e3` adds a module.
7933    #[test]
7934    fn nothing_in_this_crate_reserves_or_claims_a_job() {
7935        const SOURCES: &[(&str, &str)] = &[
7936            ("dependency_caches.rs", include_str!("dependency_caches.rs")),
7937            ("docker_cleanup.rs", include_str!("docker_cleanup.rs")),
7938            (
7939                "docker_cleanup/http.rs",
7940                include_str!("docker_cleanup/http.rs"),
7941            ),
7942            (
7943                "docker_cleanup/policy.rs",
7944                include_str!("docker_cleanup/policy.rs"),
7945            ),
7946            (
7947                "docker_cleanup/proxy.rs",
7948                include_str!("docker_cleanup/proxy.rs"),
7949            ),
7950            (
7951                "docker_cleanup/tests.rs",
7952                include_str!("docker_cleanup/tests.rs"),
7953            ),
7954            ("lib.rs", include_str!("lib.rs")),
7955            ("lifecycle.rs", include_str!("lifecycle.rs")),
7956            (
7957                "lifecycle/windows_hyperv.rs",
7958                include_str!("lifecycle/windows_hyperv.rs"),
7959            ),
7960            ("oci.rs", include_str!("oci.rs")),
7961            ("package.rs", include_str!("package.rs")),
7962            ("reconcile.rs", include_str!("reconcile.rs")),
7963        ];
7964
7965        fn walk(directory: &std::path::Path, prefix: &str, found: &mut Vec<String>) {
7966            for entry in std::fs::read_dir(directory).expect("the crate's own src/ is readable") {
7967                let entry = entry.expect("a readable directory entry");
7968                let name = entry.file_name().to_string_lossy().into_owned();
7969                // `/`-joined, which is what `include_str!` takes on every
7970                // platform, so the two sides compare directly.
7971                let joined = if prefix.is_empty() {
7972                    name.clone()
7973                } else {
7974                    format!("{prefix}/{name}")
7975                };
7976                if entry.path().is_dir() {
7977                    walk(&entry.path(), &joined, found);
7978                } else if name.ends_with(".rs") {
7979                    found.push(joined);
7980                }
7981            }
7982        }
7983
7984        let mut listed: Vec<&str> = SOURCES.iter().map(|(name, _)| *name).collect();
7985        listed.sort_unstable();
7986        let mut on_disk = Vec::new();
7987        walk(
7988            std::path::Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/src")),
7989            "",
7990            &mut on_disk,
7991        );
7992        on_disk.sort_unstable();
7993        assert_eq!(
7994            listed, on_disk,
7995            "a source file was added or removed; this scan claims to cover the whole crate \
7996             and a stale list makes that claim false"
7997        );
7998
7999        for (name, source) in SOURCES {
8000            assert_eq!(
8001                forbidden_shape_in(&production_half_of(source)),
8002                None,
8003                "{name} names a forbidden shape: there is no `AcquireJobs` equivalent over \
8004                 REST, and a local lease coordinates this host with itself and with nothing \
8005                 else. If an owner decision restored one, that decision belongs in this \
8006                 module's documentation and in this test before it belongs in the code"
8007            );
8008        }
8009
8010        // The control: the scan can see a shape when there is one, through the
8011        // same matcher the loop above uses.
8012        assert!(
8013            forbidden_shape_in("async fn acquire_jobs(&self) -> Vec<Job> { todo!() }").is_some(),
8014            "the scan above proves nothing if the needles no longer match"
8015        );
8016    }
8017
8018    /// This module **applies** `b1`'s label predicate and implements none of it.
8019    ///
8020    /// The counterpart to `c4`'s scan over `crates/github/src/demand.rs`, and it
8021    /// checks the opposite thing, because the two modules sit on opposite sides
8022    /// of the same seam. `c4` builds a `RunsOn` per queued job and must name no
8023    /// `RoutingLabels`; this module holds the policy whose labels decide, so it
8024    /// must call `RoutingLabels::tally` and must not re-derive what that call
8025    /// answers.
8026    ///
8027    /// So the scan is in two halves:
8028    ///
8029    /// * **Present.** `DemandTally` has to appear, because [`demand_for`]
8030    ///   returns one. A production half that named it nowhere would mean the
8031    ///   filtering had been dropped and every queued job in a watched repository
8032    ///   was driving this policy toward `max_capacity` again.
8033    /// * **Absent.** The vocabulary of a *second* implementation. `b1` names the
8034    ///   three outcomes of matching one job; this module consumes the aggregate
8035    ///   and never a single job's verdict, so naming `RunsOnMatch` or
8036    ///   `UnresolvableRunsOn` here means a `match` on an outcome that
8037    ///   `RoutingLabels::tally` has already decided — which is how two copies of
8038    ///   a predicate start.
8039    ///
8040    /// Like the needles in `nothing_in_this_module_reserves_or_claims_a_job`,
8041    /// this is a tripwire on the obvious shape rather than a proof: a hand-rolled
8042    /// comparison of raw label strings that never names a `policy` type would
8043    /// walk past it. Stated rather than implied, for the same reason it is
8044    /// stated there.
8045    #[test]
8046    fn the_label_predicate_is_b1s_and_this_module_only_applies_it() {
8047        let production = this_file_above_its_tests_without_prose();
8048
8049        assert!(
8050            production.contains("DemandTally"),
8051            "the reconciliation loop must tally queued jobs against this policy's routing \
8052             labels. A production half that named `DemandTally` nowhere would mean the \
8053             label filtering had been removed, and a repository whose jobs target \
8054             `ubuntu-latest` would drive its policy toward `max_capacity` again"
8055        );
8056
8057        for second_implementation in ["RunsOnMatch", "UnresolvableRunsOn"] {
8058            assert!(
8059                !production.contains(second_implementation),
8060                "the reconciliation loop names `{second_implementation}`, which is the \
8061                 vocabulary of deciding one job's `runs-on` -- and `RoutingLabels::tally` \
8062                 has already decided it. This module applies the predicate and does not \
8063                 re-implement it; if an owner decision changed that, it belongs in this \
8064                 module's documentation and in this test before it belongs in the code"
8065            );
8066        }
8067    }
8068
8069    /// The demand this module clamps is the *matched* count, and a job this host
8070    /// cannot serve is not demand.
8071    ///
8072    /// The behaviour the whole reversal was for, asserted end to end through
8073    /// `demand_for` rather than through `b1`'s predicate in isolation: a policy
8074    /// carrying this host's labels, a reading holding some of its jobs and some
8075    /// of somebody else's, and the three counts kept apart.
8076    #[test]
8077    fn demand_is_the_queued_jobs_this_policy_can_actually_serve() {
8078        let policy = policy(1, "acme/app", 10);
8079        let reading = QueuedDemand::of(
8080            repo("acme/app"),
8081            [
8082                fixtures::queued_job(&[HOST_LABEL]),
8083                fixtures::queued_job(&[HOST_LABEL]),
8084                fixtures::queued_job(&["ubuntu-latest"]),
8085                fixtures::unresolvable_job(),
8086            ],
8087        );
8088
8089        let tally = demand_for(&policy, &reading, &[]);
8090
8091        assert_eq!(
8092            tally.demand(),
8093            2,
8094            "only the jobs whose required labels this policy carries are demand"
8095        );
8096        assert_eq!(
8097            tally.not_matched, 1,
8098            "a `ubuntu-latest` job is somebody else's work; counting it would start a \
8099             runner that idles until it times out"
8100        );
8101        assert_eq!(
8102            tally.unresolvable.len(),
8103            1,
8104            "an unresolvable `runs-on` is never demand and never discarded"
8105        );
8106    }
8107
8108    /// A repository target reads its own repository; an organization target
8109    /// reads the whole scope.
8110    #[test]
8111    fn an_organization_policy_tallies_every_repository_its_scope_covers() {
8112        let mut per_repository = BTreeMap::new();
8113        per_repository.insert(repo("acme/left"), fixtures::queued_jobs(&[HOST_LABEL], 3));
8114        per_repository.insert(repo("acme/right"), fixtures::queued_jobs(&[HOST_LABEL], 4));
8115        let reading = QueuedDemand::new(per_repository);
8116
8117        let repository_policy = policy(1, "acme/left", 10);
8118        assert_eq!(
8119            demand_for(&repository_policy, &reading, &[]).demand(),
8120            3,
8121            "a repository target reads its own repository's queue and not the aggregate"
8122        );
8123
8124        let org_policy = fixtures::policy()
8125            .id(PolicyId::from_u128(2))
8126            .organization("acme")
8127            .autoscale("home", 10)
8128            .active()
8129            .build();
8130        assert_eq!(
8131            demand_for(&org_policy, &reading, &[]).demand(),
8132            7,
8133            "an organization policy serves any repository in its scope, so its demand is \
8134             the whole aggregate's"
8135        );
8136    }
8137
8138    #[test]
8139    fn the_accepted_over_count_is_bounded_by_the_two_ceilings_and_nothing_else() {
8140        // The owner decision accepts that a repository whose jobs only target
8141        // `ubuntu-latest` still drives its policy toward `max_capacity`. What
8142        // stops that being unbounded is exactly what stops any other demand
8143        // being unbounded, which is asserted here rather than assumed.
8144        let host = host_with(2);
8145        let policy = policy(1, "acme/app", 5);
8146        let attempts: Vec<RunnerAttempt> = Vec::new();
8147        let mut allocator = HostAllocator::from_attempts(&host, &attempts);
8148
8149        let allocation = allocator.allocate(&policy, u32::MAX);
8150        assert_eq!(allocation.desired, 5, "max_capacity beats reported demand");
8151        assert_eq!(allocation.to_start, 2, "host_capacity beats max_capacity");
8152        assert_eq!(allocation.limiting_factor, LimitingFactor::HostCapacity);
8153    }
8154
8155    /// A director standing in for the coordinator's launches: a fixed count
8156    /// per policy, and every attempt it was told about.
8157    #[derive(Debug, Default)]
8158    struct FixedDirector {
8159        directed: Mutex<BTreeMap<PolicyId, u32>>,
8160        started: Mutex<Vec<(PolicyId, AttemptId)>>,
8161        failed: Mutex<Vec<(PolicyId, Option<AttemptId>)>>,
8162        /// What each look at the older launches answers; the last one repeats.
8163        older: Mutex<std::collections::VecDeque<usize>>,
8164        passed_over: AtomicUsize,
8165        /// Each policy's place among the launches.
8166        orders: Mutex<BTreeMap<PolicyId, u64>>,
8167    }
8168
8169    impl DemandDirector for FixedDirector {
8170        fn directed_demand(&self, policy: &ScalePolicy) -> Option<u32> {
8171            self.directed.lock().unwrap().get(&policy.id).copied()
8172        }
8173
8174        fn launched(&self, policy: &ScalePolicy, attempt: AttemptId) {
8175            self.started.lock().unwrap().push((policy.id, attempt));
8176        }
8177
8178        fn start_failed(&self, policy: &ScalePolicy, attempt: Option<AttemptId>) {
8179            self.failed.lock().unwrap().push((policy.id, attempt));
8180        }
8181
8182        fn next_waiting(&self, policy: &ScalePolicy) -> Option<u64> {
8183            self.orders.lock().unwrap().get(&policy.id).copied()
8184        }
8185
8186        fn older_waiting(&self, _policy: &ScalePolicy) -> usize {
8187            let mut older = self.older.lock().unwrap();
8188            if older.len() > 1 {
8189                older.pop_front().unwrap_or(0)
8190            } else {
8191                older.front().copied().unwrap_or(0)
8192            }
8193        }
8194
8195        fn pass_over_older(&self, _policy: &ScalePolicy) {
8196            self.passed_over.fetch_add(1, Ordering::SeqCst);
8197            self.older.lock().unwrap().clear();
8198        }
8199    }
8200
8201    /// A launcher that holds every runner in its bring-up until as many others
8202    /// (or the test) are at the barrier.
8203    #[derive(Debug)]
8204    struct HeldBringUp {
8205        inner: Arc<FakeLauncher>,
8206        barrier: Arc<tokio::sync::Barrier>,
8207        fail: Option<FailureReason>,
8208        waits: Mutex<Vec<ReservationWaits>>,
8209    }
8210
8211    #[async_trait::async_trait]
8212    impl RunnerLauncher for HeldBringUp {
8213        async fn host_capacity(&self, host: &Host) -> Result<NonZeroU16, HostCapacityError> {
8214            self.inner.host_capacity(host).await
8215        }
8216
8217        async fn supervise(
8218            &self,
8219            policy: &ScalePolicy,
8220        ) -> Result<Vec<ReplacementIntent>, LaunchFailure> {
8221            self.inner.supervise(policy).await
8222        }
8223
8224        async fn attempts(&self) -> Result<Vec<RunnerAttempt>, LaunchFailure> {
8225            self.inner.attempts().await
8226        }
8227
8228        async fn launch(&self, request: LaunchRequest<'_>) -> Result<RunnerAttempt, LaunchFailure> {
8229            self.inner.launch(request).await
8230        }
8231
8232        async fn finish_launch(
8233            &self,
8234            _policy: &ScalePolicy,
8235            attempt: RunnerAttempt,
8236            waits: ReservationWaits,
8237        ) -> Result<RunnerAttempt, LaunchFailure> {
8238            self.waits.lock().unwrap().push(waits);
8239            self.barrier.wait().await;
8240            match &self.fail {
8241                Some(reason) => Err(LaunchFailure::new(reason.clone())),
8242                None => Ok(attempt),
8243            }
8244        }
8245
8246        async fn clean(&self, attempt: AttemptId) -> Result<(), LaunchFailure> {
8247            self.inner.clean(attempt).await
8248        }
8249    }
8250
8251    fn directed_reconciler(
8252        capacity: u16,
8253        launcher: Arc<dyn RunnerLauncher>,
8254        lock: Arc<dyn AllocationLock>,
8255        director: Arc<FixedDirector>,
8256    ) -> Reconciler {
8257        Reconciler::new(
8258            host_with(capacity),
8259            ReconcilerPorts {
8260                demand: Arc::new(FakeDemand::ready(0, &repo("acme/app"))),
8261                launcher,
8262                lock,
8263                directory: Arc::new(FakeDirectory::default()),
8264                clock: Arc::new(FakeClock::default()),
8265                jitter: Arc::new(NoJitter),
8266                events: Arc::new(NoEvents),
8267            },
8268        )
8269        .with_director(director as Arc<dyn DemandDirector>)
8270    }
8271
8272    /// Two targets' runners are being brought up at the same time: each is at
8273    /// the barrier with the allocation lock released, or neither gets there.
8274    #[tokio::test]
8275    async fn two_targets_bring_up_their_runners_at_once() {
8276        let fake = Arc::new(FakeLauncher::new());
8277        let lock: Arc<dyn AllocationLock> = Arc::new(InProcessAllocationLock::new());
8278        let barrier = Arc::new(tokio::sync::Barrier::new(2));
8279        let held = Arc::new(HeldBringUp {
8280            inner: Arc::clone(&fake),
8281            barrier,
8282            fail: None,
8283            waits: Mutex::default(),
8284        });
8285        let director = Arc::new(FixedDirector::default());
8286        let (one, two) = (policy(1, "acme/app", 2), policy(2, "acme/other", 2));
8287        director.directed.lock().unwrap().insert(one.id, 1);
8288        director.directed.lock().unwrap().insert(two.id, 1);
8289        let first = directed_reconciler(
8290            2,
8291            Arc::clone(&held) as _,
8292            Arc::clone(&lock),
8293            Arc::clone(&director),
8294        );
8295        let second = directed_reconciler(2, held as _, lock, director);
8296
8297        let (a, b) = tokio::time::timeout(Duration::from_secs(10), async {
8298            tokio::join!(
8299                first.start_directed(std::slice::from_ref(&one)),
8300                second.start_directed(std::slice::from_ref(&two)),
8301            )
8302        })
8303        .await
8304        .expect("neither waits for the other's bring-up");
8305        assert_eq!((a.started, b.started), (1, 1));
8306    }
8307
8308    /// No oversubscription: the slot is held from the reservation, while the
8309    /// runner is still being brought up and the lock is free.
8310    #[tokio::test]
8311    async fn a_runner_coming_up_holds_its_slot_against_another_target() {
8312        let fake = Arc::new(FakeLauncher::new());
8313        let lock: Arc<dyn AllocationLock> = Arc::new(InProcessAllocationLock::new());
8314        let barrier = Arc::new(tokio::sync::Barrier::new(2));
8315        let held = Arc::new(HeldBringUp {
8316            inner: Arc::clone(&fake),
8317            barrier: Arc::clone(&barrier),
8318            fail: None,
8319            waits: Mutex::default(),
8320        });
8321        let director = Arc::new(FixedDirector::default());
8322        let (one, two) = (policy(1, "acme/app", 2), policy(2, "acme/other", 2));
8323        director.directed.lock().unwrap().insert(one.id, 1);
8324        director.directed.lock().unwrap().insert(two.id, 1);
8325        let first = directed_reconciler(
8326            1,
8327            Arc::clone(&held) as _,
8328            Arc::clone(&lock),
8329            Arc::clone(&director),
8330        );
8331        let second = directed_reconciler(1, held as _, lock, director);
8332
8333        let (a, b) = tokio::time::timeout(Duration::from_secs(10), async {
8334            tokio::join!(first.start_directed(std::slice::from_ref(&one)), async {
8335                while fake.live_count() == 0 {
8336                    tokio::task::yield_now().await;
8337                }
8338                let report = second.start_directed(std::slice::from_ref(&two)).await;
8339                barrier.wait().await;
8340                report
8341            })
8342        })
8343        .await
8344        .expect("the first is let go");
8345        assert_eq!((a.started, b.started), (1, 0));
8346        assert_eq!(fake.live_count(), 1);
8347    }
8348
8349    /// The launch was given its runner at the reservation, and a bring-up that
8350    /// fails says so, rather than counting as started.
8351    #[tokio::test]
8352    async fn a_failed_bring_up_is_a_failed_start() {
8353        let fake = Arc::new(FakeLauncher::new());
8354        let held = Arc::new(HeldBringUp {
8355            inner: fake,
8356            barrier: Arc::new(tokio::sync::Barrier::new(1)),
8357            fail: Some(FailureReason::JitRequestFailed),
8358            waits: Mutex::default(),
8359        });
8360        let director = Arc::new(FixedDirector::default());
8361        let pool = policy(1, "acme/app", 2);
8362        director.directed.lock().unwrap().insert(pool.id, 1);
8363        let reconciler = directed_reconciler(
8364            2,
8365            held as _,
8366            Arc::new(InProcessAllocationLock::new()),
8367            Arc::clone(&director),
8368        );
8369
8370        let report = reconciler.start_directed(std::slice::from_ref(&pool)).await;
8371
8372        assert_eq!(report.started, 0);
8373        let started = director.started.lock().unwrap()[0].1;
8374        assert_eq!(
8375            *director.failed.lock().unwrap(),
8376            vec![(pool.id, Some(started))]
8377        );
8378    }
8379
8380    fn scripted_older(director: &FixedDirector, looks: &[(usize, usize)]) {
8381        *director.older.lock().unwrap() = looks
8382            .iter()
8383            .flat_map(|(value, count)| std::iter::repeat_n(*value, *count))
8384            .collect();
8385    }
8386
8387    /// Oldest first across targets: a younger launch reserves after the older
8388    /// ones, however long that takes while they are reserving, and says so in its
8389    /// timings.
8390    #[tokio::test(start_paused = true)]
8391    async fn a_younger_launch_reserves_after_older_ones_while_they_make_progress() {
8392        let held = Arc::new(HeldBringUp {
8393            inner: Arc::new(FakeLauncher::new()),
8394            barrier: Arc::new(tokio::sync::Barrier::new(1)),
8395            fail: None,
8396            waits: Mutex::default(),
8397        });
8398        let director = Arc::new(FixedDirector::default());
8399        let pool = policy(1, "acme/app", 3);
8400        director.directed.lock().unwrap().insert(pool.id, 1);
8401        let reconciler = directed_reconciler(
8402            5,
8403            Arc::clone(&held) as _,
8404            Arc::new(InProcessAllocationLock::new()),
8405            Arc::clone(&director),
8406        );
8407
8408        // Three older launches, each reserving just within the turn: four and a
8409        // half seconds in all, well over one turn, and nothing is passed over.
8410        let looks =
8411            (OLDER_LAUNCH_TURN.as_millis() * 3 / 4 / OLDER_LAUNCH_POLL.as_millis()) as usize;
8412        scripted_older(&director, &[(3, looks), (2, looks), (1, looks), (0, 1)]);
8413        let began = tokio::time::Instant::now();
8414        let report = reconciler.start_directed(std::slice::from_ref(&pool)).await;
8415        assert_eq!(report.started, 1);
8416        assert_eq!(
8417            began.elapsed(),
8418            OLDER_LAUNCH_POLL * u32::try_from(looks * 3).unwrap()
8419        );
8420        assert_eq!(director.passed_over.load(Ordering::SeqCst), 0);
8421        assert_eq!(
8422            held.waits.lock().unwrap()[0].order,
8423            OLDER_LAUNCH_POLL * u32::try_from(looks * 3).unwrap(),
8424            "the wait is in the launch's timings"
8425        );
8426    }
8427
8428    /// A pass concludes runners, so it is not held by a launch's bring-up: with a
8429    /// launch side, it reports on the launch and hands it over.
8430    #[tokio::test]
8431    async fn a_pass_hands_a_directed_launch_to_the_launch_side() {
8432        let fake = Arc::new(FakeLauncher::new());
8433        let director = Arc::new(FixedDirector::default());
8434        let pool = policy(1, "acme/app", 3);
8435        director.directed.lock().unwrap().insert(pool.id, 1);
8436        let signal = Arc::new(tokio::sync::Notify::new());
8437        let mut reconciler = directed_reconciler(
8438            5,
8439            Arc::clone(&fake) as _,
8440            Arc::new(InProcessAllocationLock::new()),
8441            Arc::clone(&director),
8442        )
8443        .with_launch_side(Arc::clone(&signal));
8444
8445        let report = reconciler.reconcile(std::slice::from_ref(&pool)).await;
8446
8447        assert_eq!(report.started, 0);
8448        assert_eq!(fake.live_count(), 0);
8449        assert_eq!(report.allocations[0].to_start, 1);
8450        tokio::time::timeout(Duration::from_secs(1), signal.notified())
8451            .await
8452            .expect("the launch side is told");
8453
8454        // Nothing to start: nothing to tell it.
8455        director.directed.lock().unwrap().insert(pool.id, 0);
8456        reconciler.reconcile(std::slice::from_ref(&pool)).await;
8457        assert!(
8458            tokio::time::timeout(Duration::from_millis(50), signal.notified())
8459                .await
8460                .is_err()
8461        );
8462    }
8463
8464    /// One that never reserves costs one wait, then nothing: a loop that cannot
8465    /// reserve holds no launch up for long, and not every later one again.
8466    #[tokio::test(start_paused = true)]
8467    async fn an_older_launch_that_cannot_reserve_is_passed_over_once() {
8468        let fake = Arc::new(FakeLauncher::new());
8469        let director = Arc::new(FixedDirector::default());
8470        let pool = policy(1, "acme/app", 3);
8471        director.directed.lock().unwrap().insert(pool.id, 1);
8472        let reconciler = directed_reconciler(
8473            5,
8474            Arc::clone(&fake) as _,
8475            Arc::new(InProcessAllocationLock::new()),
8476            Arc::clone(&director),
8477        );
8478
8479        scripted_older(&director, &[(1, 1)]);
8480        let began = tokio::time::Instant::now();
8481        let report = reconciler.start_directed(std::slice::from_ref(&pool)).await;
8482        assert_eq!(report.started, 1, "started anyway");
8483        assert!(began.elapsed() >= OLDER_LAUNCH_TURN);
8484        assert!(began.elapsed() < OLDER_LAUNCH_TURN + Duration::from_secs(1));
8485        assert_eq!(director.passed_over.load(Ordering::SeqCst), 1);
8486
8487        director.directed.lock().unwrap().insert(pool.id, 2);
8488        let began = tokio::time::Instant::now();
8489        let report = reconciler.start_directed(std::slice::from_ref(&pool)).await;
8490        assert_eq!(report.started, 1);
8491        assert_eq!(began.elapsed(), Duration::ZERO);
8492    }
8493
8494    /// A target's own profiles keep the order too: the oldest launch reserves
8495    /// first, one runner at a time.
8496    #[tokio::test]
8497    async fn a_targets_profiles_reserve_oldest_launch_first() {
8498        let director = Arc::new(FixedDirector::default());
8499        let (younger, older) = (policy(1, "acme/app", 3), policy(2, "acme/app", 3));
8500        director.directed.lock().unwrap().insert(younger.id, 1);
8501        director.directed.lock().unwrap().insert(older.id, 1);
8502        director.orders.lock().unwrap().insert(younger.id, 9);
8503        director.orders.lock().unwrap().insert(older.id, 4);
8504        let reconciler = directed_reconciler(
8505            5,
8506            Arc::new(FakeLauncher::new()) as _,
8507            Arc::new(InProcessAllocationLock::new()),
8508            Arc::clone(&director),
8509        );
8510
8511        let report = reconciler
8512            .start_directed(&[younger.clone(), older.clone()])
8513            .await;
8514
8515        assert_eq!(report.started, 2);
8516        let order: Vec<PolicyId> = director
8517            .started
8518            .lock()
8519            .unwrap()
8520            .iter()
8521            .map(|(policy, _)| *policy)
8522            .collect();
8523        assert_eq!(order, vec![older.id, younger.id]);
8524    }
8525
8526    /// Serves `pool` until told to stop, with `signal` and `stop` for the test.
8527    fn serving<'a>(
8528        reconciler: &'a Reconciler,
8529        pool: &ScalePolicy,
8530        signal: &'a tokio::sync::Notify,
8531        stop: tokio::sync::watch::Receiver<bool>,
8532    ) -> impl std::future::Future<Output = ()> + 'a {
8533        let pool = pool.clone();
8534        async move {
8535            let policies = move || vec![pool.clone()];
8536            reconciler.serve_launches(&policies, signal, stop).await;
8537        }
8538    }
8539
8540    /// The batch does not hold a launch back. Each bring-up waits at the barrier
8541    /// for the other, so the second must reach it while the first is coming up, or
8542    /// neither ever gets past.
8543    #[tokio::test]
8544    async fn a_launch_accepted_during_a_batch_starts_without_waiting_for_it() {
8545        let fake = Arc::new(FakeLauncher::new());
8546        let held = Arc::new(HeldBringUp {
8547            inner: Arc::clone(&fake),
8548            barrier: Arc::new(tokio::sync::Barrier::new(2)),
8549            fail: None,
8550            waits: Mutex::default(),
8551        });
8552        let director = Arc::new(FixedDirector::default());
8553        let pool = policy(1, "acme/app", 3);
8554        director.directed.lock().unwrap().insert(pool.id, 1);
8555        let reconciler = directed_reconciler(
8556            5,
8557            held as _,
8558            Arc::new(InProcessAllocationLock::new()),
8559            Arc::clone(&director),
8560        );
8561        let signal = tokio::sync::Notify::new();
8562        let (stop, stopped) = tokio::sync::watch::channel(false);
8563
8564        tokio::time::timeout(Duration::from_secs(10), async {
8565            tokio::join!(serving(&reconciler, &pool, &signal, stopped), async {
8566                signal.notify_one();
8567                while director.started.lock().unwrap().is_empty() {
8568                    tokio::task::yield_now().await;
8569                }
8570                director.directed.lock().unwrap().insert(pool.id, 2);
8571                signal.notify_one();
8572                while director.started.lock().unwrap().len() < 2 {
8573                    tokio::task::yield_now().await;
8574                }
8575                stop.send_replace(true);
8576            })
8577        })
8578        .await
8579        .expect("the second came up beside the first, and stopping ends it");
8580        assert_eq!(fake.live_count(), 2);
8581    }
8582
8583    /// Serving launches beside a batch changes no ceiling: the runner still
8584    /// coming up holds its slot.
8585    #[tokio::test]
8586    async fn a_launch_during_a_batch_takes_no_slot_that_batch_holds() {
8587        let fake = Arc::new(FakeLauncher::new());
8588        let held = Arc::new(HeldBringUp {
8589            inner: Arc::clone(&fake),
8590            barrier: Arc::new(tokio::sync::Barrier::new(2)),
8591            fail: None,
8592            waits: Mutex::default(),
8593        });
8594        let barrier = Arc::clone(&held.barrier);
8595        let director = Arc::new(FixedDirector::default());
8596        let pool = policy(1, "acme/app", 3);
8597        director.directed.lock().unwrap().insert(pool.id, 1);
8598        let reconciler = directed_reconciler(
8599            1,
8600            held as _,
8601            Arc::new(InProcessAllocationLock::new()),
8602            Arc::clone(&director),
8603        );
8604        let signal = tokio::sync::Notify::new();
8605        let (stop, stopped) = tokio::sync::watch::channel(false);
8606
8607        tokio::join!(serving(&reconciler, &pool, &signal, stopped), async {
8608            signal.notify_one();
8609            while director.started.lock().unwrap().is_empty() {
8610                tokio::task::yield_now().await;
8611            }
8612            director.directed.lock().unwrap().insert(pool.id, 2);
8613            signal.notify_one();
8614            for _ in 0..100 {
8615                tokio::task::yield_now().await;
8616            }
8617            assert_eq!(
8618                director.started.lock().unwrap().len(),
8619                1,
8620                "the host is full"
8621            );
8622            assert_eq!(fake.live_count(), 1);
8623            stop.send_replace(true);
8624            barrier.wait().await;
8625        });
8626    }
8627
8628    /// Nothing reserved waits for the rest of the round: here the next reservation
8629    /// cannot start until the first runner's bring-up has run, because an older
8630    /// launch elsewhere holds it for a whole turn.
8631    #[tokio::test(start_paused = true)]
8632    async fn a_reserved_runner_comes_up_before_the_next_reservation_ends() {
8633        let held = Arc::new(HeldBringUp {
8634            inner: Arc::new(FakeLauncher::new()),
8635            barrier: Arc::new(tokio::sync::Barrier::new(1)),
8636            fail: None,
8637            waits: Mutex::default(),
8638        });
8639        let director = Arc::new(FixedDirector::default());
8640        let pool = policy(1, "acme/app", 3);
8641        director.directed.lock().unwrap().insert(pool.id, 2);
8642        let reconciler = directed_reconciler(
8643            5,
8644            Arc::clone(&held) as _,
8645            Arc::new(InProcessAllocationLock::new()),
8646            Arc::clone(&director),
8647        );
8648        let signal = tokio::sync::Notify::new();
8649        let (stop, stopped) = tokio::sync::watch::channel(false);
8650
8651        // Nothing older at the first look, and one that never reserves at the next.
8652        scripted_older(&director, &[(0, 1), (1, 1)]);
8653        tokio::join!(serving(&reconciler, &pool, &signal, stopped), async {
8654            signal.notify_one();
8655            tokio::time::sleep(Duration::from_millis(1)).await;
8656            assert_eq!(
8657                held.waits.lock().unwrap().len(),
8658                1,
8659                "the first is coming up"
8660            );
8661            tokio::time::sleep(OLDER_LAUNCH_TURN + Duration::from_secs(1)).await;
8662            assert_eq!(held.waits.lock().unwrap().len(), 2);
8663            stop.send_replace(true);
8664        });
8665    }
8666
8667    /// A launch whose runner failed coming up is tried again, without a signal
8668    /// and without a pass. One signalled after the stop starts nothing.
8669    #[tokio::test(start_paused = true)]
8670    async fn a_launch_that_did_not_start_is_retried_and_a_stop_ends_it() {
8671        let held = Arc::new(HeldBringUp {
8672            inner: Arc::new(FakeLauncher::new()),
8673            barrier: Arc::new(tokio::sync::Barrier::new(1)),
8674            fail: Some(FailureReason::JitRequestFailed),
8675            waits: Mutex::default(),
8676        });
8677        let director = Arc::new(FixedDirector::default());
8678        let pool = policy(1, "acme/app", 3);
8679        director.directed.lock().unwrap().insert(pool.id, 1);
8680        director.orders.lock().unwrap().insert(pool.id, 1);
8681        let reconciler = directed_reconciler(
8682            5,
8683            held as _,
8684            Arc::new(InProcessAllocationLock::new()),
8685            Arc::clone(&director),
8686        );
8687        let signal = tokio::sync::Notify::new();
8688        let (stop, stopped) = tokio::sync::watch::channel(false);
8689
8690        tokio::join!(serving(&reconciler, &pool, &signal, stopped), async {
8691            signal.notify_one();
8692            tokio::time::sleep(Duration::from_millis(1)).await;
8693            assert_eq!(director.failed.lock().unwrap().len(), 1);
8694            // The fake keeps the failed runner: one more launch needs one more.
8695            director.directed.lock().unwrap().insert(pool.id, 2);
8696            tokio::time::sleep(LAUNCH_RETRY - Duration::from_secs(1)).await;
8697            assert_eq!(director.failed.lock().unwrap().len(), 1, "not yet");
8698            tokio::time::sleep(Duration::from_secs(2)).await;
8699            assert_eq!(director.failed.lock().unwrap().len(), 2, "retried");
8700
8701            stop.send_replace(true);
8702            signal.notify_one();
8703        });
8704        assert_eq!(director.failed.lock().unwrap().len(), 2);
8705    }
8706
8707    /// Coordinated placement: a directed policy starts runners for the
8708    /// coordinator's launches only, through every ceiling, whatever its own
8709    /// reading says; an undirected one keeps its own demand.
8710    #[tokio::test]
8711    async fn a_directed_policy_starts_only_what_it_was_directed_to_within_its_ceilings() {
8712        let demand = Arc::new(FakeDemand::ready(5, &repo("acme/app")));
8713        let launcher = Arc::new(FakeLauncher::new());
8714        let director = Arc::new(FixedDirector::default());
8715        let mut reconciler = Reconciler::new(
8716            host_with(10),
8717            ReconcilerPorts {
8718                demand: Arc::clone(&demand) as Arc<dyn DemandSource>,
8719                launcher: Arc::clone(&launcher) as Arc<dyn RunnerLauncher>,
8720                lock: Arc::new(InProcessAllocationLock::new()),
8721                directory: Arc::new(FakeDirectory::default()),
8722                clock: Arc::new(FakeClock::default()),
8723                jitter: Arc::new(NoJitter),
8724                events: Arc::new(NoEvents),
8725            },
8726        )
8727        .with_director(Arc::clone(&director) as Arc<dyn DemandDirector>);
8728        let pool = policy(1, "acme/app", 2);
8729
8730        // Five queued jobs on the poll, but no launch placed here: nothing.
8731        director.directed.lock().unwrap().insert(pool.id, 0);
8732        let report = reconciler.reconcile(std::slice::from_ref(&pool)).await;
8733        assert_eq!(report.started, 0);
8734
8735        // One launch: one runner, reported back to the director.
8736        director.directed.lock().unwrap().insert(pool.id, 1);
8737        let report = reconciler.reconcile(std::slice::from_ref(&pool)).await;
8738        assert_eq!(report.started, 1);
8739        assert_eq!(director.started.lock().unwrap().len(), 1);
8740
8741        // The same launch again is covered by the runner already starting.
8742        let report = reconciler.reconcile(std::slice::from_ref(&pool)).await;
8743        assert_eq!(report.started, 0);
8744
8745        // Three launches against max_capacity 2: the ceiling holds.
8746        director.directed.lock().unwrap().insert(pool.id, 3);
8747        let report = reconciler.reconcile(std::slice::from_ref(&pool)).await;
8748        assert_eq!(report.started, 1);
8749        assert_eq!(launcher.live_count(), 2);
8750
8751        // A launch-only start: every open launch at once, and no poll.
8752        let polls = demand.polls().len();
8753        director.directed.lock().unwrap().insert(pool.id, 0);
8754        let report = reconciler.start_directed(std::slice::from_ref(&pool)).await;
8755        assert_eq!(report.started, 0);
8756        let fresh = Arc::new(FakeLauncher::new());
8757        let starter = Reconciler::new(
8758            host_with(10),
8759            ReconcilerPorts {
8760                demand: Arc::clone(&demand) as Arc<dyn DemandSource>,
8761                launcher: Arc::clone(&fresh) as Arc<dyn RunnerLauncher>,
8762                lock: Arc::new(InProcessAllocationLock::new()),
8763                directory: Arc::new(FakeDirectory::default()),
8764                clock: Arc::new(FakeClock::default()),
8765                jitter: Arc::new(NoJitter),
8766                events: Arc::new(NoEvents),
8767            },
8768        )
8769        .with_director(Arc::clone(&director) as Arc<dyn DemandDirector>);
8770        let wide = policy(2, "acme/app", 6);
8771        director.directed.lock().unwrap().insert(wide.id, 6);
8772        let report = starter.start_directed(std::slice::from_ref(&wide)).await;
8773        assert_eq!(report.started, 6, "six launches, one call");
8774        assert_eq!(demand.polls().len(), polls, "GitHub was not polled");
8775        // An undirected policy starts nothing this way.
8776        assert_eq!(
8777            starter
8778                .start_directed(&[policy(3, "acme/app", 2)])
8779                .await
8780                .started,
8781            0
8782        );
8783
8784        // Its own reading failed: a directed policy still starts its launch.
8785        let failing = Arc::new(FakeLauncher::new());
8786        let mut reconciler = Reconciler::new(
8787            host_with(10),
8788            ReconcilerPorts {
8789                demand: Arc::new(FakeDemand::failing(RefreshState::Offline)),
8790                launcher: Arc::clone(&failing) as Arc<dyn RunnerLauncher>,
8791                lock: Arc::new(InProcessAllocationLock::new()),
8792                directory: Arc::new(FakeDirectory::default()),
8793                clock: Arc::new(FakeClock::default()),
8794                jitter: Arc::new(NoJitter),
8795                events: Arc::new(NoEvents),
8796            },
8797        )
8798        .with_director(Arc::clone(&director) as Arc<dyn DemandDirector>);
8799        director.directed.lock().unwrap().insert(pool.id, 1);
8800        assert_eq!(reconciler.reconcile(&[pool]).await.started, 1);
8801
8802        // Undirected (fallback): its own five jobs, clamped to max 2.
8803        let own = Arc::new(FakeLauncher::new());
8804        let mut reconciler = Reconciler::new(
8805            host_with(10),
8806            ReconcilerPorts {
8807                demand: Arc::new(FakeDemand::ready(5, &repo("acme/app"))),
8808                launcher: Arc::clone(&own) as Arc<dyn RunnerLauncher>,
8809                lock: Arc::new(InProcessAllocationLock::new()),
8810                directory: Arc::new(FakeDirectory::default()),
8811                clock: Arc::new(FakeClock::default()),
8812                jitter: Arc::new(NoJitter),
8813                events: Arc::new(NoEvents),
8814            },
8815        )
8816        .with_director(Arc::new(OwnDemand));
8817        assert_eq!(
8818            reconciler
8819                .reconcile(&[policy(1, "acme/app", 2)])
8820                .await
8821                .started,
8822            2
8823        );
8824    }
8825}