cratefield_module_waitlist/

lib.rs

//! `cratefield-module-waitlist`: per-product waitlist with confirm,
//! position, referral codes and status (issue #11, architecture section
//! 6).
//!
//! ```no_run
//! use cratefield_module_waitlist::Waitlist;
//!
//! let module = Waitlist::new()
//!     .products(["kontinuum", "undercover-rockstars"])
//!     .confirm_ttl_days(7)
//!     .referrals(true);
//! ```
//!
//! **Positions are atomic.** Confirmation reads the product's position
//! from a per-product counter on `waitlist_position_lock` that the
//! lock-taking UPDATE increments in the same statement, and that UPDATE
//! plus the flip and the referrer credit run in one
//! [`cratefield_core::Database::batch_atomic`] — atomic on D1, a
//! transaction on the sqlite and Postgres adapters — so concurrent
//! confirms of one product serialize on every engine and a UNIQUE
//! (product, position) index means a duplicate position cannot survive
//! even if the allocation raced (issues #20, #173, #126). Positions are
//! dense at assign time per product
//! and never recomputed on delete.
//!
//! **No enumeration** (section 11): `POST /v1/waitlist` answers the same
//! `202 {"ok":true}` bytes whatever the row state; an unknown `ref` code
//! is silently ignored.

#![doc = include_str!("../README.md")]
#![forbid(unsafe_code)]

mod handlers;
mod mail;
mod store;

pub use mail::{ConfirmMailData, ConfirmedMailData, default_templates, themed_templates};

use cratefield_core::{
    AnyError, BoxFuture, Config, ConfigError, DataKind, Disposition, Migrations, Module,
    ModuleConfig, ModuleContext, PersonalDataSet, Port, SqlMigration,
};
use serde_json::Value;
use std::sync::Arc;

use handlers::{Products, Settings};

/// A venture's validation for the free-form `answers` field of a join.
/// `Err(detail)` becomes a `400 validation-failed` problem.
pub type AnswersSchema = Arc<dyn Fn(&Value) -> Result<(), String> + Send + Sync>;

fn accept_any_answers() -> AnswersSchema {
    Arc::new(|_answers| Ok(()))
}

/// The module's migrations: the `waitlist_entries` table in the portable
/// SQL subset (issue #11), plus the entry generation that confirm tokens
/// bind to (issue #127).
const MIGRATION_INIT: SqlMigration = SqlMigration::new(
    "0001",
    "init",
    include_str!("../migrations/sqlite/0001_init.sql"),
);

const MIGRATION_ENTRY_GENERATION: SqlMigration = SqlMigration::new(
    "0002",
    "entry_generation",
    include_str!("../migrations/sqlite/0002_entry_generation.sql"),
);

/// The durable send-cooldown table backing the one-mail-per-window claim
/// (issue #133). Name must match `handlers::SEND_COOLDOWN_TABLE`.
const MIGRATION_MAIL_COOLDOWN: SqlMigration = SqlMigration::new(
    "0003",
    "mail_cooldown",
    include_str!("../migrations/sqlite/0003_mail_cooldown.sql"),
);

/// The single-row per-product position mutex used by `confirm_entry`
/// (issue #173). Name must match the table in `store::confirm_entry`.
const MIGRATION_POSITION_LOCK: SqlMigration = SqlMigration::new(
    "0004",
    "position_lock",
    include_str!("../migrations/sqlite/0004_position_lock.sql"),
);

/// The address columns made nullable so an entry can be anonymised rather
/// than deleted (issue #265). See the migration for why deleting the row is
/// the wrong answer here.
const MIGRATION_ANONYMISABLE_ENTRY: SqlMigration = SqlMigration::new(
    "0005",
    "anonymisable_entry",
    include_str!("../migrations/sqlite/0005_anonymisable_entry.sql"),
);

/// The per-product position counter and its UNIQUE backstop (issue #126).
const MIGRATION_POSITION_COUNTER: SqlMigration = SqlMigration::new(
    "0006",
    "position_counter",
    include_str!("../migrations/sqlite/0006_position_counter.sql"),
);

/// A per-product waitlist.
pub struct Waitlist {
    settings: Settings,
}

impl Default for Waitlist {
    fn default() -> Self {
        Self::new()
    }
}

impl Waitlist {
    /// No products allowed until [`Waitlist::products`] or
    /// [`Waitlist::any_product`] says otherwise; 7-day confirm TTL;
    /// referrals on.
    pub fn new() -> Self {
        Self {
            settings: Settings {
                products: Products::List(Vec::new()),
                confirm_ttl_days: 7,
                retention_days_pending: 30,
                status_redirect: None,
                referrals: true,
                require_answers: false,
                answers_schema: accept_any_answers(),
            },
        }
    }

    /// Exactly these product slugs may be joined.
    #[must_use]
    pub fn products(mut self, products: impl IntoIterator<Item = impl Into<String>>) -> Self {
        self.settings.products = Products::List(products.into_iter().map(Into::into).collect());
        self
    }

    /// Accept any product slug (single-product ventures that do not want
    /// an allowlist).
    #[must_use]
    pub fn any_product(mut self) -> Self {
        self.settings.products = Products::Any;
        self
    }

    /// How long a confirmation link stays valid (default 7 days).
    #[must_use]
    pub fn confirm_ttl_days(mut self, days: u32) -> Self {
        self.settings.confirm_ttl_days = days;
        self
    }

    /// Purge `pending` entries untouched for this many days from the
    /// scheduled handler (default 30; issue #13 retention rule).
    #[must_use]
    pub fn retention_days_pending(mut self, days: u32) -> Self {
        self.settings.retention_days_pending = days;
        self
    }

    /// Where confirmation redirects to, as
    /// `<url>?token=<status token>` (default
    /// `<public_url>/waitlist/status`).
    #[must_use]
    pub fn status_redirect(mut self, url: impl Into<String>) -> Self {
        self.settings.status_redirect = Some(url.into());
        self
    }

    /// Whether `ref` codes credit referrers (default `true`).
    #[must_use]
    pub fn referrals(mut self, enabled: bool) -> Self {
        self.settings.referrals = enabled;
        self
    }

    /// Validates the free-form `answers` JSON of a join (default: accept
    /// anything). Only runs when the join carries answers; pair with
    /// [`Self::require_answers`] to also reject joins without them.
    #[must_use]
    pub fn answers_schema(
        mut self,
        validate: impl Fn(&Value) -> Result<(), String> + Send + Sync + 'static,
    ) -> Self {
        self.settings.answers_schema = Arc::new(validate);
        self
    }

    /// Whether a join must carry `answers` (default `false`): with
    /// `true`, a body without the field — absent or `null` — is
    /// rejected as `validation-failed`.
    #[must_use]
    pub fn require_answers(mut self, required: bool) -> Self {
        self.settings.require_answers = required;
        self
    }
}

impl Module for Waitlist {
    fn name(&self) -> &'static str {
        "waitlist"
    }

    fn version(&self) -> &'static str {
        env!("CARGO_PKG_VERSION")
    }

    fn requires(&self) -> &'static [Port] {
        &[Port::Db, Port::Mailer, Port::Signer]
    }

    fn optional(&self) -> &'static [Port] {
        &[Port::Captcha, Port::RateLimiter]
    }

    fn tables(&self) -> &'static [&'static str] {
        &[
            "waitlist_entries",
            "waitlist_send_cooldown",
            "waitlist_position_lock",
        ]
    }

    /// The entry is anonymised, not deleted; the other two tables have no
    /// subject column at all (issue #265).
    ///
    /// **Why `Anonymise` and not `Erase`.** A confirmed entry carries two
    /// numbers that belong to other people as much as to its owner:
    /// `position` is a dense per-product join order that is deliberately
    /// never recomputed, and `referrals` is a credit already granted. Delete
    /// the row and the queue acquires a hole nobody can explain and every
    /// `referred_by` pointing at its code orphans; keep it and null the
    /// person out of it, and the request is answered without rewriting
    /// anybody else's place in the line. Migration `0005` exists for exactly
    /// this: `email` and `email_normalized` were `NOT NULL`, so the `SET … =
    /// NULL` this declaration promises could not have run.
    ///
    /// `referral_code` is deliberately **kept**. It is a random 8-character
    /// string that names nobody once the address is gone, and it is what the
    /// referrals other people were credited for still resolve against.
    ///
    /// **Why `id` and not the address.** `GET /v1/privacy/export?subject=…`
    /// puts the subject value in a URL, and URLs outlive their request in
    /// access logs, proxies and browser history — which is why this module's
    /// own links carry the opaque row id and never the address (issue #135).
    /// Declaring `email_normalized` as the subject would have made a subject
    /// access request the one operation that writes an address into those
    /// logs.
    ///
    /// **Why the other two have no subject column.** `waitlist_position_lock`
    /// is one row per product, genuinely names nobody, and is `none`.
    /// `waitlist_send_cooldown` is the harder case, declared `unreachable`,
    /// and its reason says so plainly: its primary key is the
    /// address and product the mail throttle counts against, so the address
    /// is inside a key rather than in a column of its own, and
    /// `… WHERE <column> = ?` cannot reach it. That is the same shape issue
    /// #266 describes for `Outbox`, and the table is core's
    /// [`SendCooldown`](cratefield_core::SendCooldown) shape rather than this
    /// module's, so giving it a column of its own is a change to every module
    /// that has one. Saying so is the honest answer available here; inventing
    /// a subject column that matched nothing would not be.
    fn personal_data(&self) -> &'static [PersonalDataSet] {
        const SETS: &[PersonalDataSet] = &[
            PersonalDataSet {
                table: "waitlist_entries",
                subject: "id",
                kind: DataKind::Contact,
                disposition: Disposition::Anonymise(&["email", "email_normalized", "answers"]),
                description: "Your place on a waitlist: the address you joined with, which \
                              product, when you joined and confirmed, your number in the queue, \
                              your referral code and how many people joined through it, and any \
                              answers you gave on the way in.",
                redacted: &[],
                subject_via: None,
            },
            // Not `PersonalDataSet::none`: the row does hold the address, and
            // bucketing it under "not personal" would tell the subject a
            // table with their address in it holds nothing about anybody
            // (issue #274). Declaring the `subject` column is not an option
            // either: it holds `<email>:<product>`, so `WHERE subject = ?`
            // with a bare address never matches — the value's *format* is
            // the problem, not a missing hop, and widening `subject_via` to
            // a prefix match would be a different mechanism. Core's
            // `SendCooldown` shape is the change that closes it properly.
            PersonalDataSet::unreachable(
                "waitlist_send_cooldown",
                DataKind::Contact,
                "When we last emailed you about a waitlist, so the same address is not \
                 mailed again within the hour.",
                "The row is keyed on your address and the product together, so an erasure \
                 request cannot match it with an address alone. Nothing else about you is \
                 in the row, and it stops mattering once the queue does.",
            ),
            PersonalDataSet::none(
                "waitlist_position_lock",
                "One row per product, holding the lock that stops two people confirming in the \
                 same instant from being given the same number in the queue. A product name and \
                 a timestamp; nobody is named in it.",
            ),
        ];
        SETS
    }

    fn emits(&self) -> &'static [&'static str] {
        &[handlers::EVENT_JOINED, handlers::EVENT_CONFIRMED]
    }

    fn public_writes(&self) -> bool {
        true
    }

    fn migrations(&self) -> Migrations {
        const MIGRATIONS: [SqlMigration; 6] = [
            MIGRATION_INIT,
            MIGRATION_ENTRY_GENERATION,
            MIGRATION_MAIL_COOLDOWN,
            MIGRATION_POSITION_LOCK,
            MIGRATION_ANONYMISABLE_ENTRY,
            MIGRATION_POSITION_COUNTER,
        ];
        // The array is the apply order; this refuses a gap, a duplicate
        // or an entry out of order at build time (issue #27).
        const _: () = cratefield_core::assert_migration_set(&MIGRATIONS);
        Migrations {
            sqlite: &MIGRATIONS,
            postgres: &[],
        }
    }

    fn validate_config(&self, cfg: &dyn Config) -> Result<(), ConfigError> {
        let module = ModuleConfig::new("waitlist", cfg);
        let mut errors = ConfigError::default();

        if let Some(raw) = cfg
            .get(&module.key("CONFIRM_TTL_DAYS"))
            .map(|raw| raw.parse::<u32>())
        {
            let invalid = match raw {
                Ok(days) => days == 0,
                Err(_) => true,
            };
            if invalid {
                errors.push(format!(
                    "waitlist: {} must be a positive integer",
                    module.key("CONFIRM_TTL_DAYS")
                ));
            }
        }
        for key in ["STATUS_REDIRECT", "EXPIRED_REDIRECT", "API_BASE"] {
            if let Some(raw) = cfg.get(&module.key(key))
                && !(raw.starts_with("https://") || raw.starts_with("http://"))
            {
                errors.push(format!(
                    "waitlist: {} must be an absolute http(s) URL, got {raw:?}",
                    module.key(key)
                ));
            }
        }
        if let Some(list) = cfg.get(&module.key("PRODUCTS"))
            && list != "*"
            && list
                .split(',')
                .map(str::trim)
                .all(|slug| !is_product_slug(slug))
        {
            errors.push(format!(
                "waitlist: {} must be a comma-separated list of kebab-case slugs or `*`",
                module.key("PRODUCTS")
            ));
        }

        errors.into_result()
    }

    fn router(&self, ctx: ModuleContext) -> axum::Router {
        handlers::router(Arc::new(ctx), self.settings.clone())
    }

    fn surface(&self) -> cratefield_core::Surface {
        handlers::surface(&self.settings)
    }

    fn scheduled<'a>(
        &'a self,
        ctx: &'a ModuleContext,
        cron: &'a str,
    ) -> BoxFuture<'a, Result<(), AnyError>> {
        Box::pin(async move {
            let Some(db) = ctx.ports.db.clone() else {
                return Ok(());
            };
            let cfg = ModuleConfig::new("waitlist", &*ctx.config);
            let days = i64::from(cfg.get_u32(
                "RETENTION_DAYS_PENDING",
                self.settings.retention_days_pending,
            ));
            let cutoff = handlers::iso_ago(days.saturating_mul(86_400));
            let deleted = store::purge_pending_older_than(&*db, &cutoff)
                .await
                .map_err(|err| Box::new(err) as AnyError)?;
            if deleted > 0 {
                tracing::info!(deleted, cron, "purged stale pending waitlist entries");
            }
            // Claims whose window has closed are dead rows (issue #133).
            let claims = cratefield_core::SendCooldown::new(handlers::SEND_COOLDOWN_TABLE)
                .prune(
                    &*db,
                    &handlers::iso_ago(handlers::REMAIL_AFTER_SECS.saturating_mul(2)),
                )
                .await
                .map_err(|err| Box::new(err) as AnyError)?;
            if claims > 0 {
                tracing::info!(claims, cron, "pruned expired waitlist send claims");
            }
            Ok(())
        })
    }
}

fn is_product_slug(slug: &str) -> bool {
    !slug.is_empty()
        && slug
            .chars()
            .all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-')
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn defaults_match_the_issue() {
        let module = Waitlist::new();
        assert_eq!(module.settings.confirm_ttl_days, 7);
        assert_eq!(module.settings.retention_days_pending, 30);
        assert!(module.settings.referrals);
        assert_eq!(module.name(), "waitlist");
        assert_eq!(
            module.tables(),
            [
                "waitlist_entries",
                "waitlist_send_cooldown",
                "waitlist_position_lock"
            ]
        );
        assert!(module.public_writes());
        assert_eq!(module.requires(), [Port::Db, Port::Mailer, Port::Signer]);
        assert_eq!(module.optional(), [Port::Captcha, Port::RateLimiter]);
        assert_eq!(module.emits(), ["waitlist.joined", "waitlist.confirmed"]);
    }

    #[test]
    fn referral_codes_are_8_char_crockford() {
        for _ in 0..64 {
            let code = handlers::referral_code();
            assert_eq!(code.len(), 8);
            assert!(
                code.chars()
                    .all(|c| c.is_ascii_digit() || c.is_ascii_lowercase()),
                "{code}"
            );
        }
    }
}