Skip to content
Sign in

flagon-io/g1t

public
0

g1t/services/billing/src/reset.rs

201 lines9,863 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 ai_reload WHERE workspace = ?1",
31 "DELETE FROM ai_reloads WHERE workspace = ?1",
32 "DELETE FROM tax_and_fees WHERE workspace = ?1",
33 "DELETE FROM accounts WHERE workspace = ?1",
34 "DELETE FROM plan_payments WHERE workspace = ?1",
35 "DELETE FROM subscriptions WHERE workspace = ?1",
36 "DELETE FROM limits WHERE workspace = ?1",
37 "DELETE FROM limit_requests WHERE workspace = ?1",
38 "DELETE FROM trial_grants WHERE workspace = ?1",
39 "DELETE FROM credit_grants WHERE workspace = ?1",
40 "DELETE FROM card_checks WHERE workspace = ?1",
41 "DELETE FROM alerts_sent WHERE workspace = ?1",
42 "DELETE FROM price_notices WHERE workspace = ?1",
43 "DELETE FROM pending_usage WHERE workspace = ?1",
44 "DELETE FROM pending_days WHERE workspace = ?1",
45 "DELETE FROM month_closes WHERE workspace = ?1",
46 "DELETE FROM storage_days WHERE workspace = ?1",
47 "DELETE FROM package_storage_days WHERE workspace = ?1",
48 "DELETE FROM token_usage WHERE workspace = ?1",
49 "DELETE FROM spikes WHERE workspace = ?1",
50 "DELETE FROM closed_workspaces WHERE workspace = ?1",
51 "DELETE FROM sales_records WHERE workspace = ?1",
52 "DELETE FROM sales_notes WHERE workspace = ?1",
53 "DELETE FROM workspace_costs WHERE workspace = ?1",
54 "DELETE FROM margin_alerts WHERE kind = 'workspace' AND subject = ?1",
55 // Allowances drawn by the workspace, and its repositories' shares of
56 // the open-source pool (`<slug>/<name>`, compared exactly).
57 "DELETE FROM allowance_use WHERE scope = ?1 OR (kind = 'oss_repo' AND substr(scope, 1, length(?1) + 1) = ?1 || '/')",
58 "DELETE FROM budget_alerts WHERE account = ?2",
59 "DELETE FROM billing_accounts WHERE id = ?2",
60];
61
62impl Billing {
63 pub(crate) async fn admin_reset_billing(&self, env: &worker::Env, a: AdminResetBillingArgs) -> Result<Outcome<BillingReset>> {
64 let workspace = a.workspace.trim().to_lowercase();
65 if workspace.is_empty() || a.by.trim().is_empty() {
66 return Ok(Outcome::fail(FailureCode::Invalid, "A reset needs a workspace and who did it."));
67 }
68 if a.note.trim().len() < 5 {
69 return Ok(Outcome::fail(FailureCode::Invalid, "Say why it is reset, for whoever looks next."));
70 }
71 if a.confirm.trim() != workspace {
72 return Ok(Outcome::fail(FailureCode::Invalid, format!("Type the workspace's slug, {workspace}, exactly, to reset it.")));
73 }
74 if self.stripe.as_ref().is_some_and(|s| s.live()) {
75 return Ok(Outcome::fail(FailureCode::Forbidden, "Billing takes real cards: a workspace's billing is never wiped."));
76 }
77 #[derive(Deserialize)]
78 struct Found {
79 comped: i64,
80 enterprise: i64,
81 }
82 let found = self
83 .db
84 .prepare(format!(
85 "SELECT CASE WHEN ?1 IN ({}) THEN 1 ELSE 0 END AS comped,
86 (SELECT COUNT(*) FROM account_members WHERE workspace = ?1) AS enterprise",
87 crate::sales::INTERNAL_SQL
88 ))
89 .bind(&[workspace.as_str().into()])?
90 .first::<Found>(None)
91 .await?;
92 if let Some(found) = found {
93 if found.comped > 0 {
94 return Ok(Outcome::fail(FailureCode::Forbidden, format!("{workspace} is comped (g1t's own): its spend is a budget, kept.")));
95 }
96 if found.enterprise > 0 {
97 return Ok(Outcome::fail(FailureCode::Forbidden, format!("An enterprise pays for {workspace}: move it off first.")));
98 }
99 }
100 let account = own_account(&workspace);
101 let mut batch = Vec::with_capacity(STATEMENTS.len());
102 for sql in STATEMENTS {
103 let values: Vec<JsValue> =
104 [workspace.as_str(), account.as_str()][..crate::rename::parameters(sql)].iter().map(|v| (*v).into()).collect();
105 batch.push(self.db.prepare(*sql).bind(&values)?);
106 }
107 let mut rows = 0usize;
108 for result in self.db.batch(batch).await? {
109 rows += result.meta()?.and_then(|m| m.changes).unwrap_or(0);
110 }
111 self.audit(&account, "reset", &format!("billing of {workspace} reset ({rows} rows): {}", a.note.trim()), &a.by).await?;
112 // The margin figures still hold the workspace's past usage: redo
113 // them now (the day's analysis: the bill, 31 days, the alerts), so
114 // the pages show the reset at once.
115 let refreshed = match self.costs_daily(env, &crate::keeper::Keeper::from_env(env)).await {
116 Ok(run) => run.problems.is_empty(),
117 Err(error) => {
118 worker::console_error!("costs after a reset of {workspace}: {error}");
119 false
120 }
121 };
122 Ok(Outcome::Ok(BillingReset { workspace, rows: rows as u32, refreshed }))
123 }
124}
125
126#[cfg(test)]
127mod tests {
128 use super::*;
129
130 #[test]
131 fn every_table_with_a_workspace_is_wiped_or_kept_on_purpose() {
132 let all = STATEMENTS.join("\n");
133 // What is kept: the audit log, and g1t's own counts compared with
134 // Cloudflare's bill.
135 let kept = ["admin_actions", "own_counts"];
136 for table in [
137 "ledger", "runs", "checkouts", "workspace_invoices", "workspace_invoice_lines", "sales_notes", "accounts",
138 "pending_usage", "pending_days", "limits", "subscriptions", "month_closes", "sales_records",
139 "billing_accounts", "allowance_use", "trial_grants", "credit_grants", "storage_days", "package_storage_days",
140 "token_usage", "reservations", "spikes", "limit_requests", "plan_payments",
141 "card_checks", "alerts_sent", "price_notices", "closed_workspaces", "workspace_costs",
142 "margin_alerts", "budget_alerts", "ai_reload", "ai_reloads", "tax_and_fees",
143 ] {
144 assert!(!kept.contains(&table));
145 assert!(all.contains(&format!("DELETE FROM {table} WHERE")), "{table}");
146 }
147 }
148
149 /// The tables the migrations leave: every one made, less those dropped.
150 fn live_tables() -> std::collections::BTreeSet<String> {
151 let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("migrations");
152 let mut files: Vec<_> = std::fs::read_dir(dir).unwrap().map(|e| e.unwrap().path()).collect();
153 files.sort();
154 let mut live = std::collections::BTreeSet::new();
155 for file in files {
156 let sql = std::fs::read_to_string(file).unwrap();
157 for line in sql.lines().map(str::trim) {
158 let words: Vec<&str> = line.split(|c: char| c.is_whitespace() || c == '(' || c == ';').filter(|w| !w.is_empty()).collect();
159 let name = |at: usize| words.get(at).map(|w| w.to_string());
160 match words.as_slice() {
161 ["CREATE", "TABLE", "IF", "NOT", "EXISTS", ..] => live.extend(name(5)),
162 ["CREATE", "TABLE", ..] => live.extend(name(2)),
163 ["DROP", "TABLE", "IF", "EXISTS", ..] => {
164 name(4).map(|n| live.remove(&n));
165 }
166 ["DROP", "TABLE", ..] => {
167 name(2).map(|n| live.remove(&n));
168 }
169 _ => {}
170 }
171 }
172 }
173 live
174 }
175
176 #[test]
177 fn every_table_wiped_is_one_the_migrations_leave() {
178 let live = live_tables();
179 assert!(live.contains("ledger") && !live.contains("sandbox_months"), "{live:?}");
180 for sql in STATEMENTS {
181 let table = sql.split_whitespace().nth(2).unwrap();
182 assert!(live.contains(table), "{table} is not a table after the migrations");
183 }
184 }
185
186 #[test]
187 fn a_rename_moves_every_table_a_reset_wipes() {
188 let moved = crate::rename::STATEMENTS.join("\n");
189 // Lines follow their invoice, which carries the workspace.
190 for sql in STATEMENTS.iter().filter(|sql| !sql.contains("workspace_invoice_lines")) {
191 let table = sql.split_whitespace().nth(2).unwrap();
192 assert!(moved.contains(&format!(" {table} ")), "{table} is wiped on a reset but not moved on a rename");
193 }
194 }
195
196 #[test]
197 fn statements_name_at_most_the_workspace_and_its_account() {
198 assert!(STATEMENTS.iter().all(|sql| crate::rename::parameters(sql) <= 2));
199 assert_eq!(crate::rename::parameters(STATEMENTS.last().unwrap()), 2);
200 }
201}