Sign in

flagon-io/g1t

public

g1t/services/billing/src/reset.rs

141 lines6,927 bytesCodeBlame
1//! A test workspace's billing, wiped: `admin_reset_billing`.
2//!
3//! While billing runs on Stripe's test key, staff can return a workspace
4//! used for testing to how a new customer starts: no ledger, balance,
5//! plan, limits, trial grant, invoices, holds, signals or cost rows. Its
6//! workspace, members and repositories are not billing's and stay. Never
7//! with a live Stripe key, never for a comped workspace, and never for one
8//! an enterprise pays for. The reset itself is kept in the audit log, and
9//! g1t's own counts of the workspace's git operations stay: they are what
10//! Cloudflare's bill is compared with, not what the workspace owes.
11
12use g1t_contracts::billing::{AdminResetBillingArgs, BillingReset};
13use g1t_contracts::{FailureCode, Outcome};
14use serde::Deserialize;
15use worker::Result;
16use worker::wasm_bindgen::JsValue;
17
18use crate::Billing;
19use crate::accounts::own_account;
20
21/// The statements, in order. Parameters: `?1` the workspace, `?2` its own
22/// billing account (`ws_<slug>`).
23pub(crate) const STATEMENTS: &[&str] = &[
24 "DELETE FROM workspace_invoice_lines WHERE invoice_id IN (SELECT invoice_id FROM workspace_invoices WHERE workspace = ?1)",
25 "DELETE FROM workspace_invoices WHERE workspace = ?1",
26 "DELETE FROM ledger WHERE workspace = ?1",
27 "DELETE FROM runs WHERE workspace = ?1",
28 "DELETE FROM reservations WHERE workspace = ?1",
29 "DELETE FROM checkouts WHERE workspace = ?1",
30 "DELETE FROM accounts WHERE workspace = ?1",
31 "DELETE FROM plan_payments WHERE workspace = ?1",
32 "DELETE FROM subscriptions WHERE workspace = ?1",
33 "DELETE FROM limits WHERE workspace = ?1",
34 "DELETE FROM limit_requests WHERE workspace = ?1",
35 "DELETE FROM trial_grants WHERE workspace = ?1",
36 "DELETE FROM card_checks WHERE workspace = ?1",
37 "DELETE FROM alerts_sent WHERE workspace = ?1",
38 "DELETE FROM price_notices WHERE workspace = ?1",
39 "DELETE FROM pending_usage WHERE workspace = ?1",
40 "DELETE FROM pending_days WHERE workspace = ?1",
41 "DELETE FROM month_closes WHERE workspace = ?1",
42 "DELETE FROM storage_days WHERE workspace = ?1",
43 "DELETE FROM package_storage_days WHERE workspace = ?1",
44 "DELETE FROM sandbox_months WHERE workspace = ?1",
45 "DELETE FROM token_usage WHERE workspace = ?1",
46 "DELETE FROM spikes WHERE workspace = ?1",
47 "DELETE FROM closed_workspaces WHERE workspace = ?1",
48 "DELETE FROM sales_records WHERE workspace = ?1",
49 "DELETE FROM sales_notes WHERE workspace = ?1",
50 "DELETE FROM workspace_costs WHERE workspace = ?1",
51 "DELETE FROM margin_alerts WHERE kind = 'workspace' AND subject = ?1",
52 // Allowances drawn by the workspace, and its repositories' shares of
53 // the open-source pool (`<slug>/<name>`, compared exactly).
54 "DELETE FROM allowance_use WHERE scope = ?1 OR (kind = 'oss_repo' AND substr(scope, 1, length(?1) + 1) = ?1 || '/')",
55 "DELETE FROM budget_alerts WHERE account = ?2",
56 "DELETE FROM billing_accounts WHERE id = ?2",
57];
58
59impl Billing {
60 pub(crate) async fn admin_reset_billing(&self, a: AdminResetBillingArgs) -> Result<Outcome<BillingReset>> {
61 let workspace = a.workspace.trim().to_lowercase();
62 if workspace.is_empty() || a.by.trim().is_empty() {
63 return Ok(Outcome::fail(FailureCode::Invalid, "A reset needs a workspace and who did it."));
64 }
65 if a.note.trim().len() < 5 {
66 return Ok(Outcome::fail(FailureCode::Invalid, "Say why it is reset, for whoever looks next."));
67 }
68 if a.confirm.trim() != workspace {
69 return Ok(Outcome::fail(FailureCode::Invalid, format!("Type the workspace's slug, {workspace}, exactly, to reset it.")));
70 }
71 if self.stripe.as_ref().is_some_and(|s| s.live()) {
72 return Ok(Outcome::fail(FailureCode::Forbidden, "Billing takes real cards: a workspace's billing is never wiped."));
73 }
74 #[derive(Deserialize)]
75 struct Found {
76 comped: i64,
77 enterprise: i64,
78 }
79 let found = self
80 .db
81 .prepare(format!(
82 "SELECT CASE WHEN ?1 IN ({}) THEN 1 ELSE 0 END AS comped,
83 (SELECT COUNT(*) FROM account_members WHERE workspace = ?1) AS enterprise",
84 crate::sales::INTERNAL_SQL
85 ))
86 .bind(&[workspace.as_str().into()])?
87 .first::<Found>(None)
88 .await?;
89 if let Some(found) = found {
90 if found.comped > 0 {
91 return Ok(Outcome::fail(FailureCode::Forbidden, format!("{workspace} is comped (g1t's own): its spend is a budget, kept.")));
92 }
93 if found.enterprise > 0 {
94 return Ok(Outcome::fail(FailureCode::Forbidden, format!("An enterprise pays for {workspace}: move it off first.")));
95 }
96 }
97 let account = own_account(&workspace);
98 let mut batch = Vec::with_capacity(STATEMENTS.len());
99 for sql in STATEMENTS {
100 let values: Vec<JsValue> =
101 [workspace.as_str(), account.as_str()][..crate::rename::parameters(sql)].iter().map(|v| (*v).into()).collect();
102 batch.push(self.db.prepare(*sql).bind(&values)?);
103 }
104 let mut rows = 0usize;
105 for result in self.db.batch(batch).await? {
106 rows += result.meta()?.and_then(|m| m.changes).unwrap_or(0);
107 }
108 self.audit(&account, "reset", &format!("billing of {workspace} reset ({rows} rows): {}", a.note.trim()), &a.by).await?;
109 Ok(Outcome::Ok(BillingReset { workspace, rows: rows as u32 }))
110 }
111}
112
113#[cfg(test)]
114mod tests {
115 use super::*;
116
117 #[test]
118 fn every_table_with_a_workspace_is_wiped_or_kept_on_purpose() {
119 let all = STATEMENTS.join("\n");
120 // What is kept: the audit log, and g1t's own counts compared with
121 // Cloudflare's bill.
122 let kept = ["admin_actions", "own_counts"];
123 for table in [
124 "ledger", "runs", "checkouts", "workspace_invoices", "workspace_invoice_lines", "sales_notes", "accounts",
125 "pending_usage", "pending_days", "limits", "subscriptions", "month_closes", "sales_records",
126 "billing_accounts", "allowance_use", "trial_grants", "storage_days", "package_storage_days",
127 "sandbox_months", "token_usage", "reservations", "spikes", "limit_requests", "plan_payments",
128 "card_checks", "alerts_sent", "price_notices", "closed_workspaces", "workspace_costs",
129 "margin_alerts", "budget_alerts",
130 ] {
131 assert!(!kept.contains(&table));
132 assert!(all.contains(&format!("DELETE FROM {table} WHERE")), "{table}");
133 }
134 }
135
136 #[test]
137 fn statements_name_at_most_the_workspace_and_its_account() {
138 assert!(STATEMENTS.iter().all(|sql| crate::rename::parameters(sql) <= 2));
139 assert_eq!(crate::rename::parameters(STATEMENTS.last().unwrap()), 2);
140 }
141}