Skip to content
997 linesCodeBlameRaw
1//! Whether a workspace may start compute, and holding what it may cost.
2//!
3//! Every service that starts something that costs g1t real money asks
4//! here first (see `g1t_contracts::billing::ReserveArgs`):
5//!
6//! - **`entitlements`**: the workspace's plan, whether it may start compute
7//! at all, its caps (agents at once, a run's time and spend, an issue's
8//! spend), its ceiling and exposure, and whether compute is paused.
9//! - **`reserve`**: holds the work's estimated cost against what may pay
10//! for it (the plan's included usage, the trial, the open-source pool,
11//! then on-demand room under the ceiling and the spend limit), so starts
12//! at the same moment cannot overshoot together. Answers who pays first,
13//! or refuses with a stable code and a message for the owner.
14//! - **`settle`**: releases the hold. The charge itself goes on the ledger
15//! the usual way; a hold never settled lapses after three hours.
16//!
17//! **No card, no compute.** A free workspace's forge is free, but compute
18//! needs the plan, or a card check: it unlocks the one-time trial and g1t's
19//! open-source pool (checks, workflows and the merge queue on public
20//! repositories). The card check is what keeps g1t's free compute from
21//! being mined: one trial per card, and a real person behind each.
22//!
23//! **Spikes.** An hour's spend above `SPIKE_FACTOR` (5) times the
24//! workspace's usual hour over the last week, and at least
25//! `SPIKE_FLOOR_MICROS` ($5), pauses new compute until an owner answers:
26//! keep going (for 24 hours, or until the hour's spend doubles again) or
27//! stop. Runs already under way finish. g1t's own workspaces are watched
28//! but never paused.
29
30use futures_util::future::{try_join, try_join4};
31use g1t_contracts::billing::{
32 BillingAccount, ComputeKind, ConfirmSpikeArgs, Entitlements, EntitlementsArgs, LimitState, PaidBy, PlanKind, Reservation,
33 ReserveArgs, SettleArgs, Spike, UNLIMITED_MICROS, UsageAlert, RESERVATION_HOURS,
34};
35use g1t_contracts::time::rfc3339;
36use g1t_contracts::{FailureCode, Outcome, new_id};
37use g1t_kit::now_ms;
38use serde::Deserialize;
39use worker::Result;
40use worker::wasm_bindgen::JsValue;
41
42use crate::Billing;
43use crate::credits::{self, left};
44use crate::features::dollars;
45use crate::limits::alert_level;
46
47/// Sandboxes (workflow jobs, checks, the queue, deploy builds) a workspace
48/// runs at once in the first month, on the free plan or the trial, and
49/// after: room for a workflow's matrix and a deploy side by side, where 2
50/// and 10, sized for g1t's former hosted agents, held CI behind one another.
51pub(crate) const FIRST_MONTH_AGENTS: u32 = 20;
52pub(crate) const AGENTS: u32 = 40;
53/// The longest run in the first month or on the trial, in minutes.
54pub(crate) const FIRST_MONTH_MINUTES: u32 = 60;
55/// How long "keep going" lifts a spike's pause.
56const KEEP_GOING_MS: u64 = 24 * 60 * 60 * 1000;
57/// The week a usual hour is measured over.
58const WEEK_HOURS: i64 = 7 * 24;
59
60/// What may pay for reserved work, at price, in the order it pays.
61#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
62pub(crate) struct Room {
63 pub credit: i64,
64 pub trial: i64,
65 pub oss: i64,
66 /// Under the ceiling and the spend limit; None: no bound (g1t's own).
67 pub on_demand: Option<i64>,
68}
69
70/// Why `place` could not hold an estimate.
71#[derive(Clone, Copy, Debug, PartialEq, Eq)]
72pub(crate) enum Short {
73 /// Nothing left that pays for it.
74 Empty,
75 /// Some room, but less than a paid workspace's whole estimate.
76 TooSmall,
77}
78
79/// Where a new hold of `estimate` goes, given what open holds take
80/// (`held`): the source that pays first, and what to hold. Holds fill the
81/// sources in order, so the first source with room after them pays first.
82/// A paid workspace's whole estimate must fit, so the ceiling cannot be
83/// overshot; a free workspace may use its last bit of trial, and what the
84/// run costs past it is g1t's.
85pub(crate) fn place(room: &Room, held: i64, estimate: i64, whole: bool) -> std::result::Result<(PaidBy, i64), Short> {
86 let sources = [
87 (PaidBy::Credit, room.credit.max(0)),
88 (PaidBy::Trial, room.trial.max(0)),
89 (PaidBy::Oss, room.oss.max(0)),
90 ];
91 let pools: i64 = sources.iter().map(|(_, room)| room).sum();
92 let remaining = match room.on_demand {
93 None => i64::MAX,
94 Some(on_demand) => pools + on_demand.max(0) - held.max(0),
95 };
96 if remaining <= 0 {
97 return Err(Short::Empty);
98 }
99 let estimate = estimate.max(0);
100 if whole && estimate > remaining {
101 return Err(Short::TooSmall);
102 }
103 let hold = estimate.min(remaining);
104 let mut end = 0;
105 for (source, size) in sources {
106 end += size;
107 if held.max(0) < end {
108 return Ok((source, hold));
109 }
110 }
111 Ok((PaidBy::OnDemand, hold))
112}
113
114/// Whether the last hour is a spike: above `factor` times the usual hour,
115/// and at least `floor`.
116pub(crate) fn is_spike(last_hour: i64, usual_hour: i64, factor: i64, floor: i64) -> bool {
117 last_hour >= floor.max(1) && last_hour > usual_hour.max(0) * factor
118}
119
120/// Whether a spike an owner said to keep going on still lets work start:
121/// within its 24 hours, and the hour's spend not doubled again.
122pub(crate) fn still_continued(until: Option<&str>, now: &str, hour_at_spike: i64, last_hour: i64) -> bool {
123 until.is_some_and(|until| now < until) && last_hour < hour_at_spike.max(1) * 2
124}
125
126/// A workspace's caps, from its plan.
127pub(crate) fn caps(plan: PlanKind, first_month: bool, on_trial: bool, agents: Option<u32>) -> (u32, u32) {
128 let tight = first_month || (plan == PlanKind::Free && on_trial) || plan == PlanKind::Free;
129 let default_agents = if tight { FIRST_MONTH_AGENTS } else { AGENTS };
130 let minutes = if tight { FIRST_MONTH_MINUTES } else { g1t_contracts::guardrails::MAX_MINUTES };
131 (agents.unwrap_or(default_agents), minutes)
132}
133
134/// The refusal for a start that cannot be held, with what to do.
135pub(crate) fn refusal(code: FailureCode, workspace: &str, kind: ComputeKind, detail: &str) -> Outcome<Reservation> {
136 let link = format!("/{workspace}/-/billing");
137 let what = match kind {
138 ComputeKind::Agent => "Agents",
139 ComputeKind::Check => "Checks",
140 ComputeKind::Workflow => "Workflows",
141 ComputeKind::Queue => "The merge queue",
142 ComputeKind::Deploy => "Deployments",
143 ComputeKind::Embedding => "Semantic search",
144 };
145 let message = match code {
146 FailureCode::NotPaid if kind.open_source_pool() => format!(
147 "{what} run in g1t's sandboxes, which cost real money, so they need the g1t plan ($20 a month) or a card check. A card check gives public repositories g1t's open-source pool and starts the $5 trial; it is never charged. Both are at {link}."
148 ),
149 FailureCode::NotPaid => format!(
150 "{what} cost real money to run, so they need the g1t plan ($20 a month, with $10 of usage included) or the one-time $5 trial, which starts with a card check that is never charged. Both are at {link}."
151 ),
152 FailureCode::TrialUsed => format!(
153 "This workspace has used its $5 trial. Start the g1t plan ($20 a month, with $10 of usage included) to keep going: {link}."
154 ),
155 FailureCode::OssPoolEmpty => format!(
156 "g1t's open-source pool for this month is used up{detail}, so checks and workflows on public repositories wait until the 1st. The g1t plan runs them now: {link}."
157 ),
158 FailureCode::Limit => format!("{detail} An owner can raise the limit, prepay, or ask g1t for more at {link}."),
159 FailureCode::Paused => format!("New compute is paused: {detail} An owner can see why and answer at {link}."),
160 _ => detail.to_owned(),
161 };
162 Outcome::fail(code, message)
163}
164
165#[derive(Deserialize)]
166struct SpikeRow {
167 id: String,
168 status: String,
169 hour_micros: i64,
170 average_micros: i64,
171 detected_at: String,
172 decided_by: Option<String>,
173 decided_at: Option<String>,
174 until: Option<String>,
175}
176
177impl From<SpikeRow> for Spike {
178 fn from(row: SpikeRow) -> Self {
179 Spike {
180 id: row.id,
181 status: row.status,
182 hour_micros: row.hour_micros,
183 average_micros: row.average_micros,
184 detected_at: row.detected_at,
185 decided_by: row.decided_by,
186 decided_at: row.decided_at,
187 until: row.until,
188 }
189 }
190}
191
192/// A workspace's pace: the last hour, the usual hour over the last week,
193/// the last day, at price (what was charged plus what paid for it first).
194#[derive(Clone, Copy, Debug, Default)]
195pub(crate) struct Pace {
196 pub last_hour: i64,
197 pub usual_hour: i64,
198 pub last_day: i64,
199}
200
201impl Billing {
202 /// Spend at price over the last hour, day and week.
203 pub(crate) async fn pace(&self, workspace: &str) -> Result<Pace> {
204 #[derive(Deserialize)]
205 struct Row {
206 hour: Option<i64>,
207 day: Option<i64>,
208 week: Option<i64>,
209 }
210 let now = now_ms();
211 let hour_ago = rfc3339(now - 60 * 60 * 1000);
212 let day_ago = rfc3339(now - 24 * 60 * 60 * 1000);
213 let week_ago = rfc3339(now - 7 * 24 * 60 * 60 * 1000);
214 let gross = "(-amount_micros + credit_micros + trial_micros + oss_micros + given_micros)";
215 let row = self
216 .db
217 .prepare(format!(
218 "SELECT SUM(CASE WHEN created_at >= ?2 THEN {gross} END) AS hour,
219 SUM(CASE WHEN created_at >= ?3 THEN {gross} END) AS day,
220 SUM(CASE WHEN created_at < ?2 THEN {gross} END) AS week
221 FROM ledger WHERE workspace = ?1 AND kind = 'usage' AND created_at >= ?4"
222 ))
223 .bind(&[workspace.into(), hour_ago.into(), day_ago.into(), week_ago.into()])?
224 .first::<Row>(None)
225 .await?;
226 Ok(row.map_or_else(Pace::default, |r| Pace {
227 last_hour: r.hour.unwrap_or(0).max(0),
228 usual_hour: r.week.unwrap_or(0).max(0) / (WEEK_HOURS - 1),
229 last_day: r.day.unwrap_or(0).max(0),
230 }))
231 }
232
233 /// The workspace's latest spike, if any.
234 pub(crate) async fn latest_spike(&self, workspace: &str) -> Result<Option<Spike>> {
235 Ok(self
236 .db
237 .prepare(
238 "SELECT id, status, hour_micros, average_micros, detected_at, decided_by, decided_at, until
239 FROM spikes WHERE workspace = ? ORDER BY detected_at DESC LIMIT 1",
240 )
241 .bind(&[workspace.into()])?
242 .first::<SpikeRow>(None)
243 .await?
244 .map(Spike::from))
245 }
246
247 /// The spike pausing the workspace now, found or new. Never for g1t's
248 /// own workspaces, which are watched in sudo but never paused.
249 async fn spike_pause(&self, workspace: &str, plan: PlanKind) -> Result<Option<Spike>> {
250 let latest = self.latest_spike(workspace).await?;
251 if let Some(spike) = &latest
252 && (spike.status == "open" || spike.status == "stopped") {
253 return Ok(latest);
254 }
255 if plan == PlanKind::Internal || self.stripe.is_none() {
256 return Ok(None);
257 }
258 let pace = self.pace(workspace).await?;
259 let now = rfc3339(now_ms());
260 if let Some(spike) = &latest
261 && spike.status == "continued" && still_continued(spike.until.as_deref(), &now, spike.hour_micros, pace.last_hour) {
262 return Ok(None);
263 }
264 if !is_spike(pace.last_hour, pace.usual_hour, self.plans.spike_factor, self.plans.spike_floor_micros) {
265 return Ok(None);
266 }
267 let id = new_id("spk", now_ms());
268 self.db
269 .prepare(
270 "INSERT INTO spikes (id, workspace, status, hour_micros, average_micros, detected_at)
271 SELECT ?1, ?2, 'open', ?3, ?4, ?5
272 WHERE NOT EXISTS (SELECT 1 FROM spikes WHERE workspace = ?2 AND status = 'open')",
273 )
274 .bind(&[id.as_str().into(), workspace.into(), (pace.last_hour as f64).into(), (pace.usual_hour as f64).into(), now.as_str().into()])?
275 .run()
276 .await?;
277 self.latest_spike(workspace).await
278 }
279
280 /// The alerts a workspace has reached this month: its plan's included
281 /// usage, its spend limit and g1t's ceiling, from 50%.
282 pub(crate) async fn alerts_for(&self, workspace: &str) -> Result<Vec<UsageAlert>> {
283 let account = self.account_of(workspace).await?;
284 let plan = self.plan_kind_for(workspace, &account).await?;
285 let has_plan = plan != PlanKind::Free;
286 let month = credits::month_of(&rfc3339(now_ms()));
287 let (limit, used) = try_join(self.limit_with(workspace, &account, plan), async {
288 if has_plan { self.allowance_used("plan_credit", workspace, &month).await } else { Ok(0) }
289 })
290 .await?;
291 Ok(alerts_from(workspace, &limit, has_plan, used, self.plans.plan_included_micros))
292 }
293}
294
295/// The alerts reached, from a limit already worked out, whether the
296/// workspace has the plan, and what of its included usage it has used.
297fn alerts_from(
298 workspace: &str,
299 limit: &g1t_contracts::billing::Limit,
300 has_plan: bool,
301 used: i64,
302 included: i64,
303) -> Vec<UsageAlert> {
304 let mut alerts = vec![];
305 if has_plan && limit.trust != g1t_contracts::billing::Trust::Internal {
306 let level = alert_level(used, included);
307 if level > 0 {
308 alerts.push(UsageAlert {
309 meter: "included".into(),
310 level,
311 used_micros: used,
312 limit_micros: included,
313 message: if level >= 100 {
314 format!("{workspace} has used all {} of this month's included usage. Usage from here is charged at cost plus 20%, up to your spend limit.", dollars(included))
315 } else {
316 format!("{workspace} has used {} of this month's {} included usage ({level}%). Past it, usage is charged at cost plus 20%, up to your spend limit.", dollars(used), dollars(included))
317 },
318 });
319 }
320 }
321 if let Some(spend_limit) = limit.spend_limit_micros {
322 let level = crate::limits::alert_level_in(limit.spent_micros, spend_limit, &limit.alert_levels);
323 if level > 0 {
324 alerts.push(UsageAlert {
325 meter: "spend_limit".into(),
326 level,
327 used_micros: limit.spent_micros,
328 limit_micros: spend_limit,
329 message: format!(
330 "{workspace} has spent {} of its {} monthly spend limit ({level}%). At the limit, new sandboxes, builds and agents stop until the month turns or an owner raises it.",
331 dollars(limit.spent_micros),
332 dollars(spend_limit)
333 ),
334 });
335 }
336 }
337 if let Some(ceiling) = limit.ceiling_micros.filter(|_| limit.trust != g1t_contracts::billing::Trust::New) {
338 let level = alert_level(limit.exposure_micros, ceiling);
339 if level > 0 {
340 alerts.push(UsageAlert {
341 meter: "ceiling".into(),
342 level,
343 used_micros: limit.exposure_micros,
344 limit_micros: ceiling,
345 message: format!(
346 "{workspace} has {} of usage not yet paid for, of the {} g1t allows ({level}%). With a card on file g1t charges it as the limit nears; prepaying raises it at once.",
347 dollars(limit.exposure_micros),
348 dollars(ceiling)
349 ),
350 });
351 }
352 }
353 alerts
354}
355
356impl Billing {
357 /// Whether a card check was done for the workspace.
358 pub(crate) async fn card_checked(&self, workspace: &str) -> Result<bool> {
359 Ok(self
360 .db
361 .prepare("SELECT workspace FROM card_checks WHERE workspace = ?")
362 .bind(&[workspace.into()])?
363 .first::<serde_json::Value>(None)
364 .await?
365 .is_some())
366 }
367
368 /// What open reservations hold across `members`, at price.
369 async fn held(&self, members: &[String]) -> Result<i64> {
370 #[derive(Deserialize)]
371 struct Row {
372 held: Option<i64>,
373 }
374 let marks = vec!["?"; members.len().max(1)].join(", ");
375 let mut values: Vec<JsValue> = members.iter().map(|m| JsValue::from(m.as_str())).collect();
376 if values.is_empty() {
377 values.push("".into());
378 }
379 values.push(rfc3339(now_ms()).into());
380 Ok(self
381 .db
382 .prepare(format!(
383 "SELECT SUM(hold_micros) AS held FROM reservations
384 WHERE workspace IN ({marks}) AND settled_at IS NULL AND expires_at > ?"
385 ))
386 .bind(&values)?
387 .first::<Row>(None)
388 .await?
389 .and_then(|r| r.held)
390 .unwrap_or(0))
391 }
392
393 /// Why new compute is paused, if it is: a staff hold, a spike waiting
394 /// for an owner (or stopped by one), or the limit reached.
395 async fn pause_reason(
396 &self,
397 workspace: &str,
398 account: &BillingAccount,
399 plan: PlanKind,
400 limit: Option<&g1t_contracts::billing::Limit>,
401 ) -> Result<(Option<String>, Option<Spike>, Option<FailureCode>)> {
402 if let Some(hold) = account.allowances.hold.as_deref().filter(|h| !h.trim().is_empty()) {
403 return Ok((Some(format!("g1t staff put a hold on new compute ({}).", hold.trim())), None, Some(FailureCode::Paused)));
404 }
405 // A comped account past its monthly budget (`budget`).
406 if let Some(why) = self.comped_stop(account).await? {
407 return Ok((Some(why), None, Some(FailureCode::Paused)));
408 }
409 let spike = self.spike_pause(workspace, plan).await?;
410 if let Some(spike) = &spike {
411 let why = if spike.status == "stopped" {
412 format!(
413 "an owner stopped new compute after a spend spike ({} in an hour). An owner can choose Keep going.",
414 dollars(spike.hour_micros)
415 )
416 } else {
417 format!(
418 "{} was spent in an hour, more than {} times the usual {} an hour, so new compute waits for an owner to confirm.",
419 dollars(spike.hour_micros),
420 self.plans.spike_factor,
421 dollars(spike.average_micros)
422 )
423 };
424 return Ok((Some(why), Some(spike.clone()), Some(FailureCode::Paused)));
425 }
426 let latest = self.latest_spike(workspace).await?;
427 if plan != PlanKind::Internal && self.stripe.is_some() {
428 let worked_out;
429 let limit = match limit {
430 Some(limit) => limit,
431 None => {
432 worked_out = self.limit_of(workspace).await?;
433 &worked_out
434 }
435 };
436 if limit.state == LimitState::Stopped {
437 return Ok((limit.message.clone(), latest, Some(FailureCode::Limit)));
438 }
439 }
440 Ok((None, latest, None))
441 }
442
443 /// `entitlements`: what the workspace may do now.
444 pub(crate) async fn entitlements(&self, a: EntitlementsArgs) -> Result<Entitlements> {
445 let workspace = a.workspace.to_lowercase();
446 let account = self.account_of(&workspace).await?;
447 let plan = self.plan_kind_for(&workspace, &account).await?;
448 let has_plan = plan != PlanKind::Free;
449 let now = rfc3339(now_ms());
450 let month = credits::month_of(&now);
451 // Every signed-in page asks for this, so what does not need another
452 // answer is read at once: the limit (and the pause, from it), the
453 // trial, and the month's counts.
454 let standing = async {
455 let limit = self.limit_with(&workspace, &account, plan).await?;
456 let pause = self.pause_reason(&workspace, &account, plan, Some(&limit)).await?;
457 Ok::<_, worker::Error>((limit, pause))
458 };
459 let trial = async {
460 let (checked, grant) = try_join(
461 async {
462 if matches!(plan, PlanKind::Internal | PlanKind::Enterprise) { Ok(true) } else { self.card_checked(&workspace).await }
463 },
464 self.grant_of(&workspace),
465 )
466 .await?;
467 // A card checked while the month's pool was empty: granted once
468 // it has room.
469 let grant = match grant {
470 Some(grant) => Some(grant),
471 None if checked && plan == PlanKind::Free && self.trial_allowed(&workspace).await? => self.ensure_grant(&workspace).await?,
472 None => None,
473 };
474 Ok::<_, worker::Error>((checked, grant))
475 };
476 let counts = try_join4(
477 self.private_storage(&workspace),
478 self.oss_paid(&workspace, &month),
479 self.held(&account.workspaces),
480 async { if has_plan { self.allowance_used("plan_credit", &workspace, &month).await } else { Ok(0) } },
481 );
482 let more = try_join(self.allowance_used("build_seconds", &workspace, &month), self.git_operations_this_month(&workspace));
483 let ((limit, (paused, spike, _)), (verified, grant), (stored, oss, held, included_used), (build_seconds, git_operations)) =
484 try_join4(standing, trial, counts, more).await?;
485 let trial_left = grant.as_ref().map_or(0, |g| left(g.granted_micros, g.used_micros));
486 let first_month = limit.first_month;
487 let (max_agents, max_minutes) = caps(plan, first_month, trial_left > 0, account.allowances.max_concurrent_agents);
488 let ceiling = match plan {
489 PlanKind::Free => 0,
490 PlanKind::Internal => UNLIMITED_MICROS,
491 _ => limit.ceiling_micros.unwrap_or(UNLIMITED_MICROS),
492 };
493 let alerts = alerts_from(&workspace, &limit, has_plan, included_used, self.plans.plan_included_micros);
494 Ok(Entitlements {
495 plan,
496 compute: has_plan || trial_left > 0,
497 trial_micros_left: trial_left,
498 trial_verified: verified,
499 first_month,
500 max_concurrent_agents: max_agents,
501 max_run_minutes: max_minutes,
502 ceiling_micros: ceiling,
503 exposure_micros: limit.exposure_micros,
504 paused,
505 held: account.allowances.hold.as_deref().is_some_and(|hold| !hold.trim().is_empty()),
506 held_micros: held,
507 prepaid_micros: limit.prepaid_micros,
508 included_micros: if has_plan { self.plans.plan_included_micros } else { 0 },
509 included_used_micros: included_used,
510 audit_retention_days: crate::retention::effective_days(&self.plans, plan, account.allowances.audit_retention_days),
511 audit_retention_custom: account.allowances.audit_retention_days.is_some(),
512 free_private_storage_bytes: self.plans.free_storage_bytes,
513 // For the packages service: on the plan nothing is refused; without it,
514 // pushes past these amounts are.
515 has_plan,
516 package_public_free_bytes: self.plans.public_package_free_bytes,
517 package_private_free_bytes: self.plans.private_package_free_bytes,
518 private_storage_bytes: stored,
519 oss_paid_micros: oss,
520 build_seconds_used: build_seconds.max(0) as u32,
521 git_operations,
522 git_operations_included: self.plans.git_included,
523 min_charge_micros: self.plans.min_charge_micros,
524 spike,
525 alerts,
526 workspace,
527 })
528 }
529
530 /// `reserve`: holds a start's estimated cost, or says why not.
531 pub(crate) async fn reserve(&self, a: ReserveArgs) -> Result<Outcome<Reservation>> {
532 let workspace = a.workspace.to_lowercase();
533 let now = now_ms();
534 let expires_at = rfc3339(now + RESERVATION_HOURS * 60 * 60 * 1000);
535 let repo = format!("{}/{}", a.repo.namespace, a.repo.name).to_lowercase();
536 // A platform pause holds for everyone, a g1t that does not charge
537 // included (platform.rs): kept 30 seconds in the isolate.
538 if let Some(why) = self.platform_refuses(a.kind).await {
539 return Ok(Outcome::fail(FailureCode::Paused, why));
540 }
541 // A g1t that does not charge holds nothing.
542 if self.stripe.is_none() {
543 return Ok(Outcome::Ok(Reservation { id: new_id("rsv", now), paid_by: PaidBy::OnDemand, held_micros: 0, expires_at }));
544 }
545 let account = self.account_of(&workspace).await?;
546 let plan = self.plan_kind_for(&workspace, &account).await?;
547 // g1t's own caps (`budget`), in their own words: a comped account's
548 // monthly budget, and the daily breaker.
549 if let Some(why) = self.comped_stop(&account).await? {
550 return Ok(Outcome::fail(FailureCode::Paused, why));
551 }
552 if let Some(why) = self.breaker_refuses(plan, &account, a.kind).await? {
553 return Ok(Outcome::fail(FailureCode::Paused, why));
554 }
555 let limit = if plan == PlanKind::Internal { None } else { Some(self.limit_with(&workspace, &account, plan).await?) };
556 let (paused, _, code) = self.pause_reason(&workspace, &account, plan, limit.as_ref()).await?;
557 if let (Some(why), Some(code)) = (paused, code) {
558 return Ok(refusal(code, &workspace, a.kind, &why));
559 }
560 let month = credits::month_of(&rfc3339(now));
561 let estimate = credits::with_margin(a.estimate_micros, self.margin_percent);
562 let verified = matches!(plan, PlanKind::Internal | PlanKind::Enterprise | PlanKind::Paid) || self.card_checked(&workspace).await?;
563 let has_plan = plan != PlanKind::Free;
564 let credit = if has_plan {
565 left(self.plans.plan_included_micros, self.allowance_used("plan_credit", &workspace, &month).await?)
566 } else {
567 0
568 };
569 let trial = if a.kind == ComputeKind::Deploy || !verified {
570 0
571 } else {
572 self.grant_of(&workspace).await?.map_or(0, |g| left(g.granted_micros, g.used_micros))
573 };
574 let oss_eligible = a.public && a.kind.open_source_pool() && verified;
575 let oss = if oss_eligible { self.oss_left(&workspace, &repo, &month).await? } else { 0 };
576 let on_demand = match plan {
577 PlanKind::Free => Some(0),
578 PlanKind::Internal => None,
579 _ => {
580 let Some(limit) = &limit else { unreachable!("only g1t's own workspaces skip the limit") };
581 let under_ceiling = limit.ceiling_micros.map(|c| (c - limit.exposure_micros).max(0));
582 let under_spend = limit.spend_limit_micros.map(|s| (s - limit.spent_micros).max(0));
583 match (under_ceiling, under_spend) {
584 (Some(c), Some(s)) => Some(c.min(s)),
585 (c, s) => c.or(s),
586 }
587 }
588 };
589 let room = Room { credit, trial, oss, on_demand };
590 // Optimistic: what was held is read, and the hold is written only if
591 // nothing was held meanwhile; otherwise read again.
592 for _ in 0..4 {
593 let held = self.held(&account.workspaces).await?;
594 let (paid_by, hold) = match place(&room, held, estimate, has_plan) {
595 Ok(placed) => placed,
596 Err(short) => return self.short(&workspace, plan, &a, verified, &room, short).await,
597 };
598 let id = new_id("rsv", now);
599 let mut values: Vec<JsValue> = vec![
600 id.as_str().into(),
601 workspace.as_str().into(),
602 repo.as_str().into(),
603 a.kind.as_str().into(),
604 u8::from(a.public).into(),
605 (a.estimate_micros.max(0) as f64).into(),
606 (hold as f64).into(),
607 paid_by_text(paid_by).into(),
608 rfc3339(now).into(),
609 expires_at.as_str().into(),
610 (held as f64).into(),
611 ];
612 values.extend(account.workspaces.iter().map(|w| JsValue::from(w.as_str())));
613 if account.workspaces.is_empty() {
614 values.push("".into());
615 }
616 let placed = self
617 .db
618 .prepare(format!(
619 "INSERT INTO reservations (id, workspace, repo, kind, public, estimate_micros, hold_micros, paid_by, created_at, expires_at)
620 SELECT ?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10
621 WHERE (SELECT COALESCE(SUM(hold_micros), 0) FROM reservations
622 WHERE workspace IN ({marks}) AND settled_at IS NULL AND expires_at > ?9) = ?11
623 RETURNING id",
624 marks = (12..12 + account.workspaces.len().max(1)).map(|i| format!("?{i}")).collect::<Vec<_>>().join(", ")
625 ))
626 .bind(&values)?
627 .first::<serde_json::Value>(None)
628 .await?;
629 if placed.is_some() {
630 // What is held, at cost, as it was asked.
631 let held_cost = if hold >= estimate { a.estimate_micros.max(0) } else { hold * 100 / i64::from(100 + self.margin_percent) };
632 return Ok(Outcome::Ok(Reservation { id, paid_by, held_micros: held_cost, expires_at }));
633 }
634 }
635 Ok(refusal(FailureCode::Limit, &workspace, a.kind, "Too many starts at once to hold this one; try again in a moment."))
636 }
637
638 /// The refusal for a start nothing pays for.
639 async fn short(
640 &self,
641 workspace: &str,
642 plan: PlanKind,
643 a: &ReserveArgs,
644 verified: bool,
645 room: &Room,
646 short: Short,
647 ) -> Result<Outcome<Reservation>> {
648 if plan != PlanKind::Free {
649 let limit = self.limit_of(workspace).await?;
650 let detail = match short {
651 Short::TooSmall => format!(
652 "This would take the workspace past its limit: about {} more could start now ({} spent of a {} spend limit, {} not yet paid of the {} g1t allows).",
653 dollars(room.credit + room.trial + room.oss + room.on_demand.unwrap_or(0)),
654 dollars(limit.spent_micros),
655 dollars(limit.spend_limit_micros.unwrap_or_default()),
656 dollars(limit.exposure_micros),
657 dollars(limit.ceiling_micros.unwrap_or_default()),
658 ),
659 Short::Empty => limit.message.unwrap_or_else(|| "The workspace reached its limit for this month.".to_owned()),
660 };
661 return Ok(refusal(FailureCode::Limit, workspace, a.kind, &detail));
662 }
663 if !verified {
664 return Ok(refusal(FailureCode::NotPaid, workspace, a.kind, ""));
665 }
666 let oss_eligible = a.public && a.kind.open_source_pool();
667 let trial = self.grant_of(workspace).await?;
668 if oss_eligible && room.oss == 0 {
669 let month = credits::month_of(&rfc3339(now_ms()));
670 let repo = format!("{}/{}", a.repo.namespace, a.repo.name).to_lowercase();
671 let pool = left(self.plans.oss_pool_micros, self.allowance_used("oss_pool", "", &month).await?);
672 let detail = if pool > 0 { format!(" for {repo} (its share is {})", dollars(self.oss_repo_cap(workspace).await?)) } else { String::new() };
673 if trial.as_ref().is_none_or(|g| g.used_micros >= g.granted_micros) {
674 return Ok(refusal(FailureCode::OssPoolEmpty, workspace, a.kind, &detail));
675 }
676 }
677 match trial {
678 Some(grant) if grant.used_micros >= grant.granted_micros => Ok(refusal(FailureCode::TrialUsed, workspace, a.kind, "")),
679 _ => Ok(refusal(FailureCode::NotPaid, workspace, a.kind, "")),
680 }
681 }
682
683 /// `settle`: releases a hold.
684 pub(crate) async fn settle_reservation(&self, a: SettleArgs) -> Result<Outcome<bool>> {
685 let now = rfc3339(now_ms());
686 let settled = self
687 .db
688 .prepare(
689 "UPDATE reservations SET settled_at = ?1, actual_micros = ?2
690 WHERE id = ?3 AND settled_at IS NULL AND expires_at > ?1 RETURNING id",
691 )
692 .bind(&[now.as_str().into(), (a.actual_micros.max(0) as f64).into(), a.reservation_id.as_str().into()])?
693 .first::<serde_json::Value>(None)
694 .await?;
695 Ok(Outcome::Ok(settled.is_some()))
696 }
697
698 /// Clears reservations long settled or lapsed.
699 pub(crate) async fn sweep_reservations(&self) -> Result<()> {
700 let week_ago = rfc3339(now_ms() - 7 * 24 * 60 * 60 * 1000);
701 self.db
702 .prepare("DELETE FROM reservations WHERE expires_at < ?1")
703 .bind(&[week_ago.into()])?
704 .run()
705 .await?;
706 Ok(())
707 }
708
709 /// `confirm_spike`: an owner keeps going, or stops.
710 pub(crate) async fn confirm_spike(&self, a: ConfirmSpikeArgs) -> Result<Outcome<Entitlements>> {
711 let workspace = a.workspace.to_lowercase();
712 if !a.actor.manages_billing(&workspace) {
713 return Ok(Outcome::fail(FailureCode::Forbidden, "Only an owner or a billing manager can answer a spend spike."));
714 }
715 let Some(spike) = self.latest_spike(&workspace).await? else {
716 return Ok(Outcome::fail(FailureCode::NotFound, "There is no spend spike to answer."));
717 };
718 let now = now_ms();
719 let (status, until) = if a.keep_going { ("continued", Some(rfc3339(now + KEEP_GOING_MS))) } else { ("stopped", None) };
720 self.db
721 .prepare("UPDATE spikes SET status = ?1, decided_by = ?2, decided_at = ?3, until = ?4 WHERE id = ?5")
722 .bind(&[
723 status.into(),
724 a.actor.username.as_str().into(),
725 rfc3339(now).into(),
726 crate::optional(until.as_deref()),
727 spike.id.as_str().into(),
728 ])?
729 .run()
730 .await?;
731 let account = self.account_of(&workspace).await?;
732 self.audit(
733 &account.id,
734 "spike",
735 &format!("{workspace}: {} after {} in an hour", if a.keep_going { "kept going" } else { "stopped" }, dollars(spike.hour_micros)),
736 &a.actor.username,
737 )
738 .await?;
739 Ok(Outcome::Ok(self.entitlements(EntitlementsArgs { workspace }).await?))
740 }
741
742 /// Emails owners about spikes that paused their workspace, once each.
743 pub(crate) async fn tell_spikes(&self, identity: &worker::Fetcher) -> Result<()> {
744 #[derive(Deserialize)]
745 struct Open {
746 id: String,
747 workspace: String,
748 hour_micros: i64,
749 average_micros: i64,
750 }
751 let open = self
752 .db
753 .prepare("SELECT id, workspace, hour_micros, average_micros FROM spikes WHERE status = 'open' AND told_at IS NULL LIMIT 20")
754 .all()
755 .await?
756 .results::<Open>()?;
757 for spike in open {
758 let workspace = &spike.workspace;
759 let intro = format!(
760 "{workspace} spent {} in the last hour, more than {} times its usual {} an hour, so g1t paused new sandboxes, agents and builds until an owner confirms. Runs already going finish. If this was meant, choose Keep going and nothing pauses for 24 hours unless the hour's spend doubles again. If not, choose Stop; and if it was a mistake, tell g1t from the billing page.",
761 dollars(spike.hour_micros),
762 self.plans.spike_factor,
763 dollars(spike.average_micros)
764 );
765 let link = format!("https://g1t.sh/{workspace}/-/billing");
766 if crate::limits::notify(identity, workspace, &format!("g1t: spending on {workspace} spiked, so new work is paused"), &intro, "Keep going or stop", &link).await {
767 self.db
768 .prepare("UPDATE spikes SET told_at = ? WHERE id = ?")
769 .bind(&[rfc3339(now_ms()).into(), spike.id.as_str().into()])?
770 .run()
771 .await?;
772 }
773 }
774 Ok(())
775 }
776
777 /// What the workspace's private repositories held at the last measure.
778 pub(crate) async fn private_storage(&self, workspace: &str) -> Result<i64> {
779 #[derive(Deserialize)]
780 struct Stored {
781 private_bytes: Option<i64>,
782 }
783 Ok(self
784 .db
785 .prepare("SELECT private_bytes FROM storage_days WHERE workspace = ? ORDER BY day DESC LIMIT 1")
786 .bind(&[workspace.into()])?
787 .first::<Stored>(None)
788 .await?
789 .and_then(|s| s.private_bytes)
790 .unwrap_or(0))
791 }
792
793 /// What g1t's open-source pool paid for the workspace in `month`.
794 async fn oss_paid(&self, workspace: &str, month: &str) -> Result<i64> {
795 #[derive(Deserialize)]
796 struct Sum {
797 micros: Option<i64>,
798 }
799 Ok(self
800 .db
801 .prepare("SELECT SUM(oss_micros) AS micros FROM ledger WHERE workspace = ? AND created_at >= ?")
802 .bind(&[workspace.into(), format!("{month}-01").into()])?
803 .first::<Sum>(None)
804 .await?
805 .and_then(|s| s.micros)
806 .unwrap_or(0))
807 }
808}
809
810/// Whether owners' caps are in bounds: a run $0.10 to $100 (the
811/// guardrails' most), an issue $1 to $1,000.
812pub(crate) fn paid_by_text(paid_by: PaidBy) -> &'static str {
813 match paid_by {
814 PaidBy::Credit => "credit",
815 PaidBy::Trial => "trial",
816 PaidBy::Oss => "oss",
817 PaidBy::OnDemand => "on_demand",
818 }
819}
820
821#[cfg(test)]
822mod tests {
823 use super::*;
824
825 fn limit(trust: g1t_contracts::billing::Trust, spent: i64, spend_limit: Option<i64>, exposure: i64, ceiling: Option<i64>) -> g1t_contracts::billing::Limit {
826 g1t_contracts::billing::Limit {
827 workspace: "acme".into(),
828 account: "acc_acme".into(),
829 account_name: "acme".into(),
830 trust,
831 exposure_micros: exposure,
832 ceiling_micros: ceiling,
833 trust_ceiling_micros: ceiling,
834 spend_limit_micros: spend_limit,
835 state: LimitState::Ok,
836 message: None,
837 spent_micros: spent,
838 default_spend_limit: false,
839 available_micros: None,
840 growth: None,
841 prepaid_micros: 0,
842 max_ceiling_micros: None,
843 raise_once_micros: None,
844 raised_at: None,
845 first_month: false,
846 alert_levels: crate::limits::ALERT_LEVELS.to_vec(),
847 pause_at_limit: true,
848 budget_webhook: None,
849 }
850 }
851
852 #[test]
853 fn alerts_come_from_the_answers_already_read() {
854 use g1t_contracts::billing::Trust;
855 let meters = |alerts: Vec<UsageAlert>| alerts.into_iter().map(|a| (a.meter, a.level)).collect::<Vec<_>>();
856 // On the plan: included usage at 90%, the spend limit at 50%, the ceiling at 75%.
857 let paid = limit(Trust::Paid, 100_000_000, Some(200_000_000), 75_000_000, Some(100_000_000));
858 assert_eq!(
859 meters(alerts_from("acme", &paid, true, 9_000_000, 10_000_000)),
860 vec![("included".to_owned(), 90), ("spend_limit".to_owned(), 50), ("ceiling".to_owned(), 75)]
861 );
862 // Without the plan, what was used of the included usage is not an alert.
863 assert_eq!(meters(alerts_from("acme", &paid, false, 9_000_000, 10_000_000)).len(), 2);
864 // g1t's own workspaces have no included usage to warn of, and a new
865 // workspace's ceiling is not one either.
866 let internal = limit(Trust::Internal, 0, None, 0, None);
867 assert!(alerts_from("acme", &internal, true, 10_000_000, 10_000_000).is_empty());
868 let new = limit(Trust::New, 0, None, 3_000_000, Some(3_000_000));
869 assert!(alerts_from("acme", &new, false, 0, 10_000_000).is_empty());
870 }
871
872 fn paid(credit: i64, on_demand: i64) -> Room {
873 Room { credit, trial: 0, oss: 0, on_demand: Some(on_demand) }
874 }
875
876 #[test]
877 fn included_usage_pays_first_then_on_demand() {
878 // $10 included, $100 under the ceiling, nothing held: included pays first.
879 assert_eq!(place(&paid(10_000_000, 100_000_000), 0, 2_400_000, true), Ok((PaidBy::Credit, 2_400_000)));
880 // Holds already cover the included usage: on demand.
881 assert_eq!(place(&paid(10_000_000, 100_000_000), 10_000_000, 2_400_000, true), Ok((PaidBy::OnDemand, 2_400_000)));
882 // A free workspace on its trial.
883 let trial = Room { trial: 5_000_000, on_demand: Some(0), ..Room::default() };
884 assert_eq!(place(&trial, 0, 2_400_000, false), Ok((PaidBy::Trial, 2_400_000)));
885 // A public repository's checks, from the pool.
886 let pool = Room { oss: 2_000_000, on_demand: Some(0), ..Room::default() };
887 assert_eq!(place(&pool, 0, 600_000, false), Ok((PaidBy::Oss, 600_000)));
888 }
889
890 #[test]
891 fn a_paid_workspace_is_stopped_only_by_its_limit_never_by_a_count() {
892 // The included $10 is gone and the workspace has already built,
893 // served and stored far past what used to be quotas: the next start
894 // still goes on demand, as long as its spend limit has room.
895 let room = paid(0, 250_000_000);
896 let held = 0;
897 for start in 0..1_000 {
898 let placed = place(&room, held + start * 100_000, 100_000, true);
899 assert_eq!(placed, Ok((PaidBy::OnDemand, 100_000)));
900 }
901 // Only at its limit does it stop, with the limit's refusal.
902 assert_eq!(place(&room, 250_000_000, 100_000, true), Err(Short::Empty));
903 // A free workspace has no on-demand room at all: with no trial or
904 // pool left, nothing starts (`short` says NotPaid or TrialUsed).
905 let free = Room { on_demand: Some(0), ..Room::default() };
906 assert_eq!(place(&free, 0, 100_000, false), Err(Short::Empty));
907 // g1t's own workspaces: no limit.
908 let internal = Room { on_demand: None, ..Room::default() };
909 assert_eq!(place(&internal, i64::MAX / 2, 100_000, true), Ok((PaidBy::OnDemand, 100_000)));
910 }
911
912 #[test]
913 fn concurrent_starts_cannot_overshoot_the_ceiling() {
914 // $5 of room in all, and each start may cost up to $2.40.
915 let room = paid(0, 5_000_000);
916 let mut held = 0;
917 let mut started = 0;
918 for _ in 0..5 {
919 match place(&room, held, 2_400_000, true) {
920 Ok((_, hold)) => {
921 held += hold;
922 started += 1;
923 }
924 Err(short) => assert_eq!(short, Short::TooSmall),
925 }
926 }
927 assert_eq!(started, 2);
928 assert!(held <= 5_000_000);
929 // Once the first settles, a third fits.
930 assert!(place(&room, held - 2_400_000, 2_400_000, true).is_ok());
931 // Nothing left at all.
932 assert_eq!(place(&room, 5_000_000, 1, true), Err(Short::Empty));
933 }
934
935 #[test]
936 fn a_free_workspace_may_use_its_last_bit_of_trial() {
937 let room = Room { trial: 300_000, on_demand: Some(0), ..Room::default() };
938 // The whole estimate does not fit, but what is left is held.
939 assert_eq!(place(&room, 0, 2_400_000, false), Ok((PaidBy::Trial, 300_000)));
940 // Once it is held, nothing more starts.
941 assert_eq!(place(&room, 300_000, 2_400_000, false), Err(Short::Empty));
942 // Nothing at all: no plan, no trial, no pool.
943 assert_eq!(place(&Room { on_demand: Some(0), ..Room::default() }, 0, 1, false), Err(Short::Empty));
944 }
945
946 #[test]
947 fn g1ts_own_workspaces_are_never_short() {
948 let room = Room { credit: 10_000_000, on_demand: None, ..Room::default() };
949 assert_eq!(place(&room, 50_000_000_000, 2_400_000, true), Ok((PaidBy::OnDemand, 2_400_000)));
950 assert_eq!(place(&room, 0, 2_400_000, true), Ok((PaidBy::Credit, 2_400_000)));
951 }
952
953 #[test]
954 fn a_spike_is_five_times_the_usual_hour_and_at_least_five_dollars() {
955 let (factor, floor) = (5, 5_000_000);
956 // A new workspace with no history: $5 in an hour is a spike, $4 is not.
957 assert!(is_spike(5_000_000, 0, factor, floor));
958 assert!(!is_spike(4_000_000, 0, factor, floor));
959 // Usually $2 an hour: $10 is not above five times, $10.01 is.
960 assert!(!is_spike(10_000_000, 2_000_000, factor, floor));
961 assert!(is_spike(10_010_000, 2_000_000, factor, floor));
962 // A busy workspace at its usual pace is never a spike.
963 assert!(!is_spike(40_000_000, 30_000_000, factor, floor));
964 }
965
966 #[test]
967 fn keep_going_lasts_a_day_or_until_spend_doubles() {
968 let until = "2026-10-06T12:00:00Z";
969 assert!(still_continued(Some(until), "2026-10-06T11:00:00Z", 6_000_000, 8_000_000));
970 // Doubled again: paused again.
971 assert!(!still_continued(Some(until), "2026-10-06T11:00:00Z", 6_000_000, 12_000_000));
972 // A day later: watched afresh.
973 assert!(!still_continued(Some(until), "2026-10-06T12:00:01Z", 6_000_000, 1_000_000));
974 assert!(!still_continued(None, "2026-10-06T11:00:00Z", 6_000_000, 1));
975 }
976
977 #[test]
978 fn caps_are_tight_in_the_first_month_and_on_the_trial() {
979 assert_eq!(caps(PlanKind::Paid, true, false, None), (20, 60));
980 assert_eq!(caps(PlanKind::Free, false, true, None), (20, 60));
981 assert_eq!(caps(PlanKind::Paid, false, false, None), (40, g1t_contracts::guardrails::MAX_MINUTES));
982 assert_eq!(caps(PlanKind::Internal, false, false, None).0, 40);
983 // Staff can set agents at once.
984 assert_eq!(caps(PlanKind::Paid, true, false, Some(6)).0, 6);
985 }
986
987 #[test]
988 fn every_refusal_says_what_to_do_and_where() {
989 for code in [FailureCode::NotPaid, FailureCode::TrialUsed, FailureCode::OssPoolEmpty, FailureCode::Limit, FailureCode::Paused] {
990 let Outcome::Fail(failure) = refusal(code, "acme", ComputeKind::Check, "Detail.") else { panic!() };
991 assert_eq!(failure.code, code);
992 assert!(failure.message.contains("/acme/-/billing"), "{}", failure.message);
993 }
994 let Outcome::Fail(failure) = refusal(FailureCode::NotPaid, "acme", ComputeKind::Agent, "") else { panic!() };
995 assert!(failure.message.contains("$5 trial") && failure.message.contains("never charged"));
996 }
997}