| 1 | //! Transactional email through Cloudflare Email Sending. |
| 2 | |
| 3 | use g1t_kit::js; |
| 4 | use serde::Serialize; |
| 5 | use worker::{Env, Result}; |
| 6 | |
| 7 | const FROM: &str = "g1t <noreply@g1t.sh>"; |
| 8 | const SITE: &str = "https://g1t.sh"; |
| 9 | |
| 10 | /// Where links in mail point: SITE_URL, or g1t.sh when it is not set (a |
| 11 | /// self-hosted installation sets it from its PUBLIC_URL). |
| 12 | pub fn site(env: &Env) -> String { |
| 13 | let value = env.var("SITE_URL").map(|value| value.to_string()).unwrap_or_default(); |
| 14 | let value = value.trim().trim_end_matches('/'); |
| 15 | if value.is_empty() { SITE.to_owned() } else { value.to_owned() } |
| 16 | } |
| 17 | |
| 18 | /// Who mail is from: MAIL_FROM, or g1t.sh's address when it is not set. |
| 19 | fn from(env: &Env) -> String { |
| 20 | let value = env.var("MAIL_FROM").map(|value| value.to_string()).unwrap_or_default(); |
| 21 | if value.trim().is_empty() { FROM.to_owned() } else { value.trim().to_owned() } |
| 22 | } |
| 23 | |
| 24 | /// A site's address without its scheme, as mail names it in a sentence. |
| 25 | fn bare(site: &str) -> &str { |
| 26 | site.split_once("://").map_or(site, |(_, rest)| rest) |
| 27 | } |
| 28 | |
| 29 | #[derive(Serialize)] |
| 30 | struct Message<'a> { |
| 31 | to: &'a str, |
| 32 | from: &'a str, |
| 33 | subject: &'a str, |
| 34 | text: String, |
| 35 | html: String, |
| 36 | } |
| 37 | |
| 38 | /// What one email says, before it is laid out as text and HTML. |
| 39 | #[derive(Debug, Default)] |
| 40 | pub struct Letter { |
| 41 | pub paragraphs: Vec<String>, |
| 42 | /// Quoted passages, each with who or what it is from: a note from the |
| 43 | /// person who sent an invite, or what someone asking for access said. |
| 44 | pub quotes: Vec<(String, String)>, |
| 45 | /// A code to type, shown large before the button, with the line that |
| 46 | /// leads from it to the button. |
| 47 | pub code: Option<Code>, |
| 48 | /// The button: what it says, and where it goes. |
| 49 | pub action: Option<(String, String)>, |
| 50 | pub footer: String, |
| 51 | } |
| 52 | |
| 53 | /// A code in a letter, and what joins it to the button after it. |
| 54 | #[derive(Debug, Default, PartialEq, Eq)] |
| 55 | pub struct Code { |
| 56 | pub code: String, |
| 57 | /// Said between the code and the button, such as "or follow the link". |
| 58 | pub then: String, |
| 59 | } |
| 60 | |
| 61 | /// The plain text and HTML of a letter. Everything in it is escaped: |
| 62 | /// names, notes and requests people wrote can reach every line. |
| 63 | pub fn render(letter: &Letter, site: &str) -> (String, String) { |
| 64 | let mut text = String::new(); |
| 65 | let mut html = format!( |
| 66 | "<div style=\"font-family:system-ui,sans-serif;max-width:480px;margin:0 auto;padding:32px 16px;color:#16150f\">\ |
| 67 | <p style=\"margin:0 0 20px\"><img src=\"{site}/brand/g1t-logo.png\" width=\"60\" height=\"28\" alt=\"g1t\" style=\"display:block;border:0\"></p>" |
| 68 | ); |
| 69 | for paragraph in &letter.paragraphs { |
| 70 | text.push_str(paragraph); |
| 71 | text.push_str("\n\n"); |
| 72 | html.push_str(&format!("<p style=\"font-size:15px;line-height:1.6\">{}</p>", escape(paragraph))); |
| 73 | } |
| 74 | for (from, quote) in &letter.quotes { |
| 75 | text.push_str(&format!("{from}:\n")); |
| 76 | for line in quote.lines() { |
| 77 | text.push_str(&format!("> {line}\n")); |
| 78 | } |
| 79 | text.push('\n'); |
| 80 | html.push_str(&format!( |
| 81 | "<p style=\"margin:20px 0 6px;font-size:13px;color:#6e6a5e\">{}</p>\ |
| 82 | <blockquote style=\"margin:0;padding:2px 0 2px 14px;border-left:3px solid #b9a6f2;font-size:15px;line-height:1.6;white-space:pre-line\">{}</blockquote>", |
| 83 | escape(from), |
| 84 | escape(quote) |
| 85 | )); |
| 86 | } |
| 87 | if let Some(code) = &letter.code { |
| 88 | text.push_str(&format!(" {}\n\n{}\n\n", code.code, code.then)); |
| 89 | html.push_str(&format!( |
| 90 | "<p style=\"margin:24px 0;padding:16px 0;text-align:center;background:#f3f1ea;border-radius:8px;font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;font-size:34px;font-weight:600;letter-spacing:10px;color:#16150f\">{}</p>\ |
| 91 | <p style=\"font-size:15px;line-height:1.6\">{}</p>", |
| 92 | escape(&code.code), |
| 93 | escape(&code.then) |
| 94 | )); |
| 95 | } |
| 96 | if let Some((label, link)) = &letter.action { |
| 97 | text.push_str(&format!("{label}: {link}\n\n")); |
| 98 | html.push_str(&format!( |
| 99 | "<p style=\"margin:24px 0\"><a href=\"{}\" style=\"background:#16150f;color:#fff;text-decoration:none;padding:10px 18px;border-radius:6px;font-size:15px\">{}</a></p>", |
| 100 | escape(link), |
| 101 | escape(label) |
| 102 | )); |
| 103 | } |
| 104 | text.push_str(&letter.footer); |
| 105 | text.push('\n'); |
| 106 | html.push_str(&format!( |
| 107 | "<p style=\"font-size:13px;line-height:1.6;color:#6e6a5e\">{}</p></div>", |
| 108 | escape(&letter.footer) |
| 109 | )); |
| 110 | (text, html) |
| 111 | } |
| 112 | |
| 113 | /// Sends a letter. |
| 114 | pub async fn send(env: &Env, to: &str, subject: &str, letter: &Letter) -> Result<()> { |
| 115 | let (text, html) = render(letter, &site(env)); |
| 116 | let from = from(env); |
| 117 | let message = Message { |
| 118 | to, |
| 119 | from: &from, |
| 120 | subject, |
| 121 | text, |
| 122 | html, |
| 123 | }; |
| 124 | let binding = js::binding(env, "EMAIL")?; |
| 125 | js::call(&binding, "send", &[js::to_js(&message)?]).await?; |
| 126 | Ok(()) |
| 127 | } |
| 128 | |
| 129 | /// A short message with one link to follow. |
| 130 | pub async fn send_link( |
| 131 | env: &Env, |
| 132 | to: &str, |
| 133 | subject: &str, |
| 134 | intro: &str, |
| 135 | action: &str, |
| 136 | link: &str, |
| 137 | footer: &str, |
| 138 | ) -> Result<()> { |
| 139 | let letter = Letter { |
| 140 | paragraphs: vec![intro.to_owned()], |
| 141 | quotes: Vec::new(), |
| 142 | code: None, |
| 143 | action: Some((action.to_owned(), link.to_owned())), |
| 144 | footer: footer.to_owned(), |
| 145 | }; |
| 146 | send(env, to, subject, &letter).await |
| 147 | } |
| 148 | |
| 149 | /// Text made safe to put in HTML, in an element or a quoted attribute. |
| 150 | fn escape(text: &str) -> String { |
| 151 | let mut escaped = String::with_capacity(text.len()); |
| 152 | for c in text.chars() { |
| 153 | match c { |
| 154 | '&' => escaped.push_str("&"), |
| 155 | '<' => escaped.push_str("<"), |
| 156 | '>' => escaped.push_str(">"), |
| 157 | '"' => escaped.push_str("""), |
| 158 | '\'' => escaped.push_str("'"), |
| 159 | c => escaped.push(c), |
| 160 | } |
| 161 | } |
| 162 | escaped |
| 163 | } |
| 164 | |
| 165 | /// What a confirmation email is for. |
| 166 | #[derive(Clone, Copy, Debug, PartialEq, Eq)] |
| 167 | pub enum Confirming { |
| 168 | /// The address a new account signed up with (or changed to before |
| 169 | /// confirming any). |
| 170 | NewAccount, |
| 171 | /// An address added to an account in use. |
| 172 | AddedAddress, |
| 173 | } |
| 174 | |
| 175 | /// A confirmation email: the code to type, large, and the link that does |
| 176 | /// the same, either one enough. The code leads the subject, so a phone's |
| 177 | /// notification shows it. |
| 178 | pub fn confirmation_letter(confirming: Confirming, username: &str, code: &str, link: &str) -> (String, Letter) { |
| 179 | let minutes = g1t_contracts::accounts::CONFIRM_TTL_SECONDS / 60; |
| 180 | let (intro, ignore) = match confirming { |
| 181 | Confirming::NewAccount => ( |
| 182 | format!("Welcome to g1t, {username}. To finish creating your account, enter this code on the confirmation page:"), |
| 183 | "If you did not create a g1t account, you can ignore this message.", |
| 184 | ), |
| 185 | Confirming::AddedAddress => ( |
| 186 | format!("To add this address to the g1t account {username}, enter this code on the confirmation page:"), |
| 187 | "If you did not add this address to a g1t account, you can ignore this message.", |
| 188 | ), |
| 189 | }; |
| 190 | let letter = Letter { |
| 191 | paragraphs: vec![intro], |
| 192 | quotes: Vec::new(), |
| 193 | code: Some(Code { |
| 194 | code: code.to_owned(), |
| 195 | then: "Or skip the code and confirm with this link instead. Either one works; you need only one.".to_owned(), |
| 196 | }), |
| 197 | action: Some(("Confirm email".to_owned(), link.to_owned())), |
| 198 | footer: format!( |
| 199 | "The code and the link work for {minutes} minutes, and only once. Asking for a new email ends them both. {ignore}" |
| 200 | ), |
| 201 | }; |
| 202 | (format!("{code} is your g1t confirmation code"), letter) |
| 203 | } |
| 204 | |
| 205 | /// Sends a confirmation email with `code` and the link for `token`. |
| 206 | pub async fn send_confirmation(env: &Env, to: &str, username: &str, confirming: Confirming, token: &str, code: &str) -> Result<()> { |
| 207 | let link = format!("{}/verify?token={token}", site(env)); |
| 208 | let (subject, letter) = confirmation_letter(confirming, username, code, &link); |
| 209 | send(env, to, &subject, &letter).await |
| 210 | } |
| 211 | |
| 212 | pub async fn send_password_reset(env: &Env, to: &str, username: &str, token: &str) -> Result<()> { |
| 213 | send_link( |
| 214 | env, |
| 215 | to, |
| 216 | "Reset your g1t password", |
| 217 | &format!("Someone asked to reset the password for the g1t account {username}."), |
| 218 | "Choose a new password", |
| 219 | &format!("{}/reset?token={token}", site(env)), |
| 220 | "This link works for 1 hour. If this was not you, ignore this message and your password stays the same.", |
| 221 | ) |
| 222 | .await |
| 223 | } |
| 224 | |
| 225 | /// What a security notice says: one sentence about what changed. |
| 226 | pub fn security_wording(username: &str, change: &str) -> (String, String) { |
| 227 | ( |
| 228 | format!("Security notice for your g1t account {username}"), |
| 229 | format!("{change}. This is about your g1t account {username}."), |
| 230 | ) |
| 231 | } |
| 232 | |
| 233 | /// Tells an account's addresses that something about its security changed. |
| 234 | pub async fn send_security_notice(env: &Env, to: &str, username: &str, change: &str) -> Result<()> { |
| 235 | let (subject, intro) = security_wording(username, change); |
| 236 | send_link( |
| 237 | env, |
| 238 | to, |
| 239 | &subject, |
| 240 | &intro, |
| 241 | "Review your email settings", |
| 242 | &format!("{}/settings/emails", site(env)), |
| 243 | &format!( |
| 244 | "If this was you, there is nothing to do. If it was not, reset your password at {}/forgot straight away and remove any address you do not recognise.", |
| 245 | bare(&site(env)) |
| 246 | ), |
| 247 | ) |
| 248 | .await |
| 249 | } |
| 250 | |
| 251 | /// What the email telling an account it was deleted says: its subject and |
| 252 | /// first paragraph. `by_staff` when g1t's staff deleted it. |
| 253 | pub fn deleted_wording(username: &str, by_staff: bool, days: u64) -> (String, String) { |
| 254 | let who = if by_staff { "g1t's staff deleted" } else { "You deleted" }; |
| 255 | ( |
| 256 | format!("Your g1t account {username} was deleted"), |
| 257 | format!( |
| 258 | "{who} your g1t account {username}. It has signed out everywhere, its access tokens and keys no longer work, and it has left every workspace. g1t keeps it for {days} days; after that it is removed for good." |
| 259 | ), |
| 260 | ) |
| 261 | } |
| 262 | |
| 263 | /// Tells an account's primary and backup addresses it was deleted, with how |
| 264 | /// to ask for it back. |
| 265 | pub async fn send_account_deleted(env: &Env, to: &str, username: &str, by_staff: bool, days: u64) -> Result<()> { |
| 266 | let (subject, intro) = deleted_wording(username, by_staff, days); |
| 267 | send_link( |
| 268 | env, |
| 269 | to, |
| 270 | &subject, |
| 271 | &intro, |
| 272 | "Contact support", |
| 273 | &format!("{}/support", site(env)), |
| 274 | &format!( |
| 275 | "If you did not mean to delete it, or did not delete it, write to support within {days} days and g1t can restore it." |
| 276 | ), |
| 277 | ) |
| 278 | .await |
| 279 | } |
| 280 | |
| 281 | /// An invite email: to make an account, or for an existing one to join a |
| 282 | /// workspace. |
| 283 | pub struct InviteEmail<'a> { |
| 284 | pub to: &'a str, |
| 285 | /// Who sent it (a name, or a username); None when g1t staff did. |
| 286 | pub from: Option<&'a str>, |
| 287 | /// The workspace it joins, by name. |
| 288 | pub workspace: Option<&'a str>, |
| 289 | pub joins_existing_account: bool, |
| 290 | pub code: &'a str, |
| 291 | pub days: u64, |
| 292 | /// A line from whoever sent it, such as staff approving a request. |
| 293 | pub note: Option<&'a str>, |
| 294 | } |
| 295 | |
| 296 | /// The subject and letter of an invite email. |
| 297 | pub fn invite_letter(invite: &InviteEmail, site: &str) -> (String, Letter) { |
| 298 | let (subject, intro) = invite_wording(invite.from, invite.workspace, invite.joins_existing_account); |
| 299 | let action = match invite.workspace { |
| 300 | Some(workspace) if invite.joins_existing_account => format!("Join {workspace}"), |
| 301 | _ => "Accept invite".to_owned(), |
| 302 | }; |
| 303 | let quotes = match invite.note.map(str::trim).filter(|note| !note.is_empty()) { |
| 304 | Some(note) => vec![( |
| 305 | match invite.from { |
| 306 | Some(from) => format!("A note from {from}"), |
| 307 | None => "A note from the g1t team".to_owned(), |
| 308 | }, |
| 309 | note.to_owned(), |
| 310 | )], |
| 311 | None => Vec::new(), |
| 312 | }; |
| 313 | let letter = Letter { |
| 314 | paragraphs: vec![intro], |
| 315 | quotes, |
| 316 | code: None, |
| 317 | action: Some((action, format!("{site}/invite/{}", invite.code))), |
| 318 | footer: format!( |
| 319 | "This invite works for {} days, only for this address. If you were not expecting it, you can ignore this message.", |
| 320 | invite.days |
| 321 | ), |
| 322 | }; |
| 323 | (subject, letter) |
| 324 | } |
| 325 | |
| 326 | pub async fn send_invite(env: &Env, invite: &InviteEmail<'_>) -> Result<()> { |
| 327 | let (subject, letter) = invite_letter(invite, &site(env)); |
| 328 | send(env, invite.to, &subject, &letter).await |
| 329 | } |
| 330 | |
| 331 | /// Where staff decide on access requests. |
| 332 | pub const SUDO_WAITLIST: &str = "https://sudo.g1t.sh/invites?tab=waitlist"; |
| 333 | |
| 334 | /// The one confirmation someone gets after asking for access. |
| 335 | pub fn waitlist_confirmation(site: &str) -> (String, Letter) { |
| 336 | ( |
| 337 | "You're on the list for g1t".to_owned(), |
| 338 | Letter { |
| 339 | paragraphs: vec![ |
| 340 | "Thanks for asking to try g1t. You're on the list, and we'll email you an invite at this address when there's a place for you.".to_owned(), |
| 341 | "g1t is invite-only while we open it up a few people at a time, so we can't say exactly when that will be. Someone already on g1t can also invite you sooner.".to_owned(), |
| 342 | ], |
| 343 | quotes: Vec::new(), |
| 344 | code: None, |
| 345 | action: None, |
| 346 | footer: format!("You're getting this because this address asked for access at {}/register. If that wasn't you, ignore this message; nothing more is sent unless you're invited.", bare(site)), |
| 347 | }, |
| 348 | ) |
| 349 | } |
| 350 | |
| 351 | pub async fn send_waitlist_confirmation(env: &Env, to: &str) -> Result<()> { |
| 352 | let (subject, letter) = waitlist_confirmation(&site(env)); |
| 353 | send(env, to, &subject, &letter).await |
| 354 | } |
| 355 | |
| 356 | /// One access request, as a staff summary lists it. |
| 357 | pub struct Requested { |
| 358 | pub email: String, |
| 359 | pub about: Option<String>, |
| 360 | } |
| 361 | |
| 362 | /// The most requests one summary lists; the rest are counted. |
| 363 | pub const SUMMARY_LISTS: usize = 20; |
| 364 | |
| 365 | /// The summary staff get of new access requests: every one since the last |
| 366 | /// summary, and how many are waiting in all. |
| 367 | pub fn waitlist_summary(new: &[Requested], waiting: u32) -> (String, Letter) { |
| 368 | let subject = match new { |
| 369 | [one] => format!("g1t access request from {}", one.email), |
| 370 | _ => format!("{} new g1t access requests", new.len()), |
| 371 | }; |
| 372 | let asked = match new.len() { |
| 373 | 1 => "Someone asked for access to g1t.".to_owned(), |
| 374 | n => format!("{n} people asked for access to g1t since the last summary."), |
| 375 | }; |
| 376 | let in_all = if waiting as usize > new.len() { |
| 377 | format!(" {waiting} requests are waiting in all.") |
| 378 | } else { |
| 379 | String::new() |
| 380 | }; |
| 381 | let mut quotes: Vec<(String, String)> = new |
| 382 | .iter() |
| 383 | .take(SUMMARY_LISTS) |
| 384 | .map(|request| { |
| 385 | ( |
| 386 | request.email.clone(), |
| 387 | request |
| 388 | .about |
| 389 | .as_deref() |
| 390 | .map(str::trim) |
| 391 | .filter(|about| !about.is_empty()) |
| 392 | .unwrap_or("(They did not say what they will build.)") |
| 393 | .to_owned(), |
| 394 | ) |
| 395 | }) |
| 396 | .collect(); |
| 397 | if new.len() > SUMMARY_LISTS { |
| 398 | quotes.push(("And more".to_owned(), format!("{} more requests are on the waitlist.", new.len() - SUMMARY_LISTS))); |
| 399 | } |
| 400 | let letter = Letter { |
| 401 | paragraphs: vec![format!("{asked}{in_all}")], |
| 402 | quotes, |
| 403 | code: None, |
| 404 | action: Some(("Review the waitlist".to_owned(), SUDO_WAITLIST.to_owned())), |
| 405 | footer: "Sent to WAITLIST_NOTIFY_EMAIL at most once every 15 minutes. A request that arrives in between is in the next summary, and every request is in sudo straight away.".to_owned(), |
| 406 | }; |
| 407 | (subject, letter) |
| 408 | } |
| 409 | |
| 410 | pub async fn send_waitlist_summary(env: &Env, to: &str, new: &[Requested], waiting: u32) -> Result<()> { |
| 411 | let (subject, letter) = waitlist_summary(new, waiting); |
| 412 | send(env, to, &subject, &letter).await |
| 413 | } |
| 414 | |
| 415 | /// An invitation to collaborate on one repository. `code` is set when the |
| 416 | /// address has no account yet: the link then makes one and accepts; without |
| 417 | /// it, the link opens the invitation to accept or decline. |
| 418 | pub async fn send_repo_invite( |
| 419 | env: &Env, |
| 420 | to: &str, |
| 421 | from: &str, |
| 422 | repo: &str, |
| 423 | role: &str, |
| 424 | code: Option<&str>, |
| 425 | days: u64, |
| 426 | ) -> Result<()> { |
| 427 | let (subject, intro) = repo_invite_wording(from, repo, role, code.is_some()); |
| 428 | let link = match code { |
| 429 | Some(code) => format!("{}/invite/{code}", site(env)), |
| 430 | None => format!("{}/{repo}/invitations", site(env)), |
| 431 | }; |
| 432 | send_link( |
| 433 | env, |
| 434 | to, |
| 435 | &subject, |
| 436 | &intro, |
| 437 | "View invitation", |
| 438 | &link, |
| 439 | &format!("This invitation works for {days} days. If you were not expecting it, you can ignore this message."), |
| 440 | ) |
| 441 | .await |
| 442 | } |
| 443 | |
| 444 | /// Why a person is emailed about an inbox item, as the end of a sentence. |
| 445 | fn notified_because(reason: g1t_contracts::inbox::Reason) -> &'static str { |
| 446 | use g1t_contracts::inbox::Reason; |
| 447 | match reason { |
| 448 | Reason::Agent => "an agent is waiting on you", |
| 449 | Reason::ReviewRequested => "you were asked to review", |
| 450 | Reason::Assign => "you were assigned", |
| 451 | Reason::Mention => "you were mentioned", |
| 452 | Reason::TeamMention => "a team you are in was mentioned", |
| 453 | Reason::CiActivity => "it is about your work", |
| 454 | Reason::SecurityAlert => "you look after this repository's security", |
| 455 | Reason::StateChange => "you are subscribed to it", |
| 456 | Reason::Author => "you opened it", |
| 457 | Reason::Comment => "you commented on it", |
| 458 | Reason::Manual => "you subscribed to it", |
| 459 | Reason::Subscribed => "you watch this repository", |
| 460 | } |
| 461 | } |
| 462 | |
| 463 | /// An item from the inbox, by email: what happened, what it happened to, |
| 464 | /// and a link to it. |
| 465 | pub fn notification_letter(a: &g1t_contracts::inbox::NotifyByEmailArgs, site: &str) -> Letter { |
| 466 | let path = if a.path.starts_with('/') { a.path.clone() } else { format!("/{}", a.path) }; |
| 467 | Letter { |
| 468 | paragraphs: [a.subject.trim(), a.intro.trim()] |
| 469 | .into_iter() |
| 470 | .filter(|line| !line.is_empty()) |
| 471 | .map(str::to_owned) |
| 472 | .collect(), |
| 473 | quotes: a.quote.iter().cloned().collect(), |
| 474 | code: None, |
| 475 | action: Some(("Open on g1t".to_owned(), format!("{site}{path}"))), |
| 476 | footer: format!( |
| 477 | "You are getting this because {}. Choose what you are emailed for at {site}/settings/notifications.", |
| 478 | notified_because(a.reason) |
| 479 | ), |
| 480 | } |
| 481 | } |
| 482 | |
| 483 | pub async fn send_notification(env: &Env, to: &str, a: &g1t_contracts::inbox::NotifyByEmailArgs) -> Result<()> { |
| 484 | let letter = notification_letter(a, &site(env)); |
| 485 | send(env, to, &a.subject, &letter).await |
| 486 | } |
| 487 | |
| 488 | /// The subject and first line of a repository invitation. |
| 489 | pub fn repo_invite_wording(from: &str, repo: &str, role: &str, new_account: bool) -> (String, String) { |
| 490 | let subject = format!("{from} invited you to {repo} on g1t"); |
| 491 | let intro = if new_account { |
| 492 | format!( |
| 493 | "{from} invited you to collaborate on {repo} on g1t, with the {role} role. Accepting makes your g1t account and gives you access to {repo}." |
| 494 | ) |
| 495 | } else { |
| 496 | format!("{from} invited you to collaborate on {repo} on g1t, with the {role} role.") |
| 497 | }; |
| 498 | (subject, intro) |
| 499 | } |
| 500 | |
| 501 | /// The subject and first line of an invite email. |
| 502 | pub fn invite_wording(from: Option<&str>, workspace: Option<&str>, joins_existing_account: bool) -> (String, String) { |
| 503 | let who = from.unwrap_or("The g1t team"); |
| 504 | match (workspace, joins_existing_account) { |
| 505 | (Some(workspace), true) => ( |
| 506 | format!("{who} invited you to {workspace} on g1t"), |
| 507 | format!("{who} invited you to join the {workspace} workspace on g1t."), |
| 508 | ), |
| 509 | (Some(workspace), false) => ( |
| 510 | format!("{who} invited you to {workspace} on g1t"), |
| 511 | format!( |
| 512 | "{who} invited you to join the {workspace} workspace on g1t, where people and agents ship software together. Accepting makes your account and joins you to {workspace}." |
| 513 | ), |
| 514 | ), |
| 515 | (None, _) => ( |
| 516 | match from { |
| 517 | Some(from) => format!("{from} invited you to g1t"), |
| 518 | None => "Your invite to g1t".to_owned(), |
| 519 | }, |
| 520 | format!("{who} invited you to g1t, where people and agents ship software together. g1t is invite-only for now; this invite lets you make your account."), |
| 521 | ), |
| 522 | } |
| 523 | } |
| 524 | |
| 525 | #[cfg(test)] |
| 526 | mod tests { |
| 527 | use super::*; |
| 528 | |
| 529 | #[test] |
| 530 | fn html_is_escaped() { |
| 531 | assert_eq!( |
| 532 | escape("<a href=\"x\">Tom & Jerry's</a>"), |
| 533 | "<a href="x">Tom & Jerry's</a>" |
| 534 | ); |
| 535 | assert_eq!(escape("https://g1t.sh/verify?token=ab12"), "https://g1t.sh/verify?token=ab12"); |
| 536 | } |
| 537 | |
| 538 | #[test] |
| 539 | fn an_inbox_item_says_what_happened_and_why_it_was_sent() { |
| 540 | let a = g1t_contracts::inbox::NotifyByEmailArgs { |
| 541 | username: "ana".into(), |
| 542 | repo_id: "rep_1".into(), |
| 543 | subject: "bo asked you to review acme/rocket#7".into(), |
| 544 | intro: "Add the inbox".into(), |
| 545 | quote: None, |
| 546 | path: "/acme/rocket/pull/7".into(), |
| 547 | reason: g1t_contracts::inbox::Reason::ReviewRequested, |
| 548 | }; |
| 549 | let letter = notification_letter(&a, SITE); |
| 550 | assert_eq!(letter.paragraphs, vec!["bo asked you to review acme/rocket#7", "Add the inbox"]); |
| 551 | assert_eq!(letter.action.unwrap().1, "https://g1t.sh/acme/rocket/pull/7"); |
| 552 | assert!(letter.footer.starts_with("You are getting this because you were asked to review.")); |
| 553 | assert!(letter.footer.ends_with("https://g1t.sh/settings/notifications.")); |
| 554 | } |
| 555 | |
| 556 | #[test] |
| 557 | fn invites_say_who_sent_them_and_what_they_are_for() { |
| 558 | let (subject, intro) = invite_wording(Some("ada"), None, false); |
| 559 | assert_eq!(subject, "ada invited you to g1t"); |
| 560 | assert!(intro.starts_with("ada invited you to g1t")); |
| 561 | let (subject, _) = invite_wording(None, None, false); |
| 562 | assert_eq!(subject, "Your invite to g1t"); |
| 563 | let (subject, intro) = invite_wording(Some("ada"), Some("acme"), true); |
| 564 | assert_eq!(subject, "ada invited you to acme on g1t"); |
| 565 | assert_eq!(intro, "ada invited you to join the acme workspace on g1t."); |
| 566 | let (_, intro) = invite_wording(Some("ada"), Some("acme"), false); |
| 567 | assert!(intro.contains("makes your account and joins you to acme")); |
| 568 | } |
| 569 | |
| 570 | fn invite<'a>(note: Option<&'a str>, from: Option<&'a str>) -> InviteEmail<'a> { |
| 571 | InviteEmail { |
| 572 | to: "ada@example.com", |
| 573 | from, |
| 574 | workspace: Some("Flagon, Inc."), |
| 575 | joins_existing_account: false, |
| 576 | code: "g1t-abcd", |
| 577 | days: 30, |
| 578 | note, |
| 579 | } |
| 580 | } |
| 581 | |
| 582 | #[test] |
| 583 | fn an_invite_links_to_its_page_and_carries_a_note() { |
| 584 | let (subject, letter) = invite_letter(&invite(Some("Welcome aboard <3"), None), SITE); |
| 585 | assert_eq!(subject, "The g1t team invited you to Flagon, Inc. on g1t"); |
| 586 | assert_eq!(letter.action.as_ref().unwrap().1, "https://g1t.sh/invite/g1t-abcd"); |
| 587 | assert_eq!(letter.quotes, vec![("A note from the g1t team".to_owned(), "Welcome aboard <3".to_owned())]); |
| 588 | let (text, html) = render(&letter, SITE); |
| 589 | assert!(text.contains("> Welcome aboard <3")); |
| 590 | assert!(html.contains("Welcome aboard <3")); |
| 591 | assert!(!html.contains("<3")); |
| 592 | // No note, no quote; a blank note is no note. |
| 593 | assert!(invite_letter(&invite(None, Some("Chase Pierce")), SITE).1.quotes.is_empty()); |
| 594 | assert!(invite_letter(&invite(Some(" "), Some("Chase Pierce")), SITE).1.quotes.is_empty()); |
| 595 | assert_eq!(invite_letter(&invite(Some("hi"), Some("Chase Pierce")), SITE).1.quotes[0].0, "A note from Chase Pierce"); |
| 596 | } |
| 597 | |
| 598 | #[test] |
| 599 | fn links_point_at_the_site_they_are_given() { |
| 600 | let (_, letter) = invite_letter(&invite(None, None), "http://localhost:8787"); |
| 601 | assert_eq!(letter.action.as_ref().unwrap().1, "http://localhost:8787/invite/g1t-abcd"); |
| 602 | let (text, html) = render(&letter, "http://localhost:8787"); |
| 603 | assert!(html.contains("http://localhost:8787/brand/g1t-logo.png")); |
| 604 | assert!(!text.contains("g1t.sh/") && !html.contains("https://g1t.sh")); |
| 605 | let (_, letter) = waitlist_confirmation("http://localhost:8787"); |
| 606 | assert!(letter.footer.contains("localhost:8787/register")); |
| 607 | assert_eq!(bare("https://git.example.com"), "git.example.com"); |
| 608 | } |
| 609 | |
| 610 | #[test] |
| 611 | fn the_waitlist_confirmation_promises_no_date() { |
| 612 | let (subject, letter) = waitlist_confirmation(SITE); |
| 613 | assert_eq!(subject, "You're on the list for g1t"); |
| 614 | let (text, _) = render(&letter, SITE); |
| 615 | assert!(text.contains("g1t.sh/register")); |
| 616 | assert!(text.contains("we'll email you an invite")); |
| 617 | assert!(text.contains("can't say exactly when")); |
| 618 | assert!(letter.action.is_none()); |
| 619 | } |
| 620 | |
| 621 | #[test] |
| 622 | fn staff_summaries_list_each_request_and_link_to_sudo() { |
| 623 | let one = [Requested { email: "ada@example.com".into(), about: Some("A compiler <for> fun".into()) }]; |
| 624 | let (subject, letter) = waitlist_summary(&one, 1); |
| 625 | assert_eq!(subject, "g1t access request from ada@example.com"); |
| 626 | assert_eq!(letter.paragraphs, vec!["Someone asked for access to g1t."]); |
| 627 | assert_eq!(letter.action.as_ref().unwrap().1, SUDO_WAITLIST); |
| 628 | let (_, html) = render(&letter, SITE); |
| 629 | assert!(html.contains("A compiler <for> fun")); |
| 630 | |
| 631 | let many: Vec<Requested> = (0..25).map(|n| Requested { email: format!("p{n}@example.com"), about: None }).collect(); |
| 632 | let (subject, letter) = waitlist_summary(&many, 40); |
| 633 | assert_eq!(subject, "25 new g1t access requests"); |
| 634 | assert_eq!( |
| 635 | letter.paragraphs[0], |
| 636 | "25 people asked for access to g1t since the last summary. 40 requests are waiting in all." |
| 637 | ); |
| 638 | assert_eq!(letter.quotes.len(), SUMMARY_LISTS + 1); |
| 639 | assert_eq!(letter.quotes[0].1, "(They did not say what they will build.)"); |
| 640 | assert!(letter.quotes.last().unwrap().1.starts_with("5 more")); |
| 641 | } |
| 642 | |
| 643 | #[test] |
| 644 | fn a_confirmation_email_shows_the_code_large_and_the_link_as_the_other_way() { |
| 645 | let (subject, letter) = confirmation_letter(Confirming::NewAccount, "ada", "482913", "https://g1t.sh/verify?token=ab12"); |
| 646 | assert_eq!(subject, "482913 is your g1t confirmation code"); |
| 647 | assert!(letter.paragraphs[0].starts_with("Welcome to g1t, ada.")); |
| 648 | assert_eq!(letter.action.as_ref().unwrap().1, "https://g1t.sh/verify?token=ab12"); |
| 649 | assert!(letter.footer.contains("60 minutes, and only once")); |
| 650 | let (text, html) = render(&letter, SITE); |
| 651 | // The code comes before the link, and says either one works. |
| 652 | let code_at = text.find(" 482913").unwrap(); |
| 653 | let link_at = text.find("Confirm email: https://g1t.sh/verify?token=ab12").unwrap(); |
| 654 | assert!(code_at < link_at); |
| 655 | assert!(text.contains("Either one works")); |
| 656 | assert!(html.contains("font-size:34px")); |
| 657 | assert!(html.contains(">482913</p>")); |
| 658 | assert!(html.find("482913").unwrap() < html.find("verify?token=ab12").unwrap()); |
| 659 | let (_, added) = confirmation_letter(Confirming::AddedAddress, "ada", "000001", "x"); |
| 660 | assert!(added.paragraphs[0].contains("add this address to the g1t account ada")); |
| 661 | assert!(added.footer.contains("did not add this address")); |
| 662 | } |
| 663 | |
| 664 | /// Writes each email as HTML for a look in a browser: |
| 665 | /// `G1T_WRITE_EMAILS=<dir> cargo test -p g1t-identity write_emails`. |
| 666 | #[test] |
| 667 | fn write_emails() { |
| 668 | let Ok(dir) = std::env::var("G1T_WRITE_EMAILS") else { return }; |
| 669 | let page = |name: &str, subject: &str, letter: &Letter| { |
| 670 | let (_, html) = render(letter, SITE); |
| 671 | std::fs::write( |
| 672 | format!("{dir}/{name}.html"), |
| 673 | format!("<!doctype html><meta charset=utf-8><title>{}</title><body style=\"margin:0;background:#fff\">{html}", escape(subject)), |
| 674 | ) |
| 675 | .unwrap(); |
| 676 | }; |
| 677 | let (subject, letter) = waitlist_confirmation(SITE); |
| 678 | page("waitlist-confirmation", &subject, &letter); |
| 679 | let requests = [ |
| 680 | Requested { email: "ada@example.com".into(), about: Some("A compiler for a teaching language, with agents writing the test suite.".into()) }, |
| 681 | Requested { email: "linus@example.com".into(), about: None }, |
| 682 | ]; |
| 683 | let (subject, letter) = waitlist_summary(&requests, 7); |
| 684 | page("waitlist-summary", &subject, &letter); |
| 685 | let (subject, letter) = invite_letter(&InviteEmail { |
| 686 | to: "margaret@example.com", |
| 687 | from: Some("Chase Pierce"), |
| 688 | workspace: Some("Flagon, Inc."), |
| 689 | joins_existing_account: false, |
| 690 | code: "g1t-k7m2-q9xd-4hpw-abcd-0123-4567-89ef-ghjk", |
| 691 | days: 30, |
| 692 | note: None, |
| 693 | }, SITE); |
| 694 | page("workspace-invite", &subject, &letter); |
| 695 | let (subject, letter) = invite_letter(&InviteEmail { |
| 696 | to: "ada@example.com", |
| 697 | from: None, |
| 698 | workspace: None, |
| 699 | joins_existing_account: false, |
| 700 | code: "g1t-k7m2-q9xd-4hpw-abcd-0123-4567-89ef-ghjk", |
| 701 | days: 30, |
| 702 | note: Some("Thanks for waiting. We would love to see the compiler."), |
| 703 | }, SITE); |
| 704 | page("waitlist-approved", &subject, &letter); |
| 705 | let (subject, letter) = |
| 706 | confirmation_letter(Confirming::NewAccount, "ada", "482913", "https://g1t.sh/verify?token=4f9c2a7e0b13d5c8"); |
| 707 | page("confirm-email", &subject, &letter); |
| 708 | } |
| 709 | } |