Review pass
This commit is contained in:
@@ -20,7 +20,7 @@ Calls `self.tick` in a loop every hour.
|
||||
|
||||
Iterates over `repo.list_activity` since last run and does the following:
|
||||
|
||||
- For any `relay_created|relay_updated|relay_activated` activity if this is the first non-free relay for the tenant, update tenant's billing anchor to the time the relay was created.
|
||||
- For any `create_relay|update_relay|activate_relay` activity if this is the first non-free relay for the tenant, update tenant's billing anchor to the time the relay was created.
|
||||
|
||||
Also iterates over `repo.list_tenants()` and for each tenant calls `self.generate_invoice_if_due(tenant)` and `self.collect_outstanding(tenant)`.
|
||||
|
||||
|
||||
@@ -19,6 +19,6 @@ Calls `self.tick` in a loop every 10 seconds.
|
||||
|
||||
Iterates over `repo.list_activity` since last run and does the following:
|
||||
|
||||
- For any `relay_created|relay_updated` activity, sync relay config to zooid.
|
||||
- For any `relay_deactivated` activity, sync relay config to zooid.
|
||||
- For any `create_relay|update_relay` activity, sync relay config to zooid.
|
||||
- For any `deactivate_relay` activity, sync relay config to zooid.
|
||||
- If unsuccessful, call `repo.fail_relay_sync`.
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
- Configures logging
|
||||
- Creates instances of `Repo`, `Robot`, `Billing`, `Api`, and `Infra`
|
||||
- Calls `repo.migrate`
|
||||
- Spawns `billing.start`
|
||||
- Spawns `infra.start`
|
||||
- Calls `api.serve`
|
||||
|
||||
+17
-13
@@ -1,5 +1,8 @@
|
||||
This file describes the domain model. This description should be translated into standard structs and sqlite schemas in a way that makes sense.
|
||||
|
||||
- Fields marked as private should use `#[serde(skip_serializing)]` in their definition.
|
||||
- Fields marked as readonly should use `#[serde(skip_deserializing)]` in their definition.
|
||||
|
||||
# Activity
|
||||
|
||||
Activity is an audit log of all actions performed by a user or a worker process. This allows us to trace history to create invoices, synchronize actions to external services, and debug system behavior.
|
||||
@@ -7,18 +10,19 @@ Activity is an audit log of all actions performed by a user or a worker process.
|
||||
- `id` - a random activity ID
|
||||
- `created_at` - unix timestamp when the activity was created
|
||||
- `activity_type` is one of:
|
||||
- `tenant_created`
|
||||
- `tenant_billing_anchor_updated`
|
||||
- `relay_created`
|
||||
- `relay_updated`
|
||||
- `relay_activated`
|
||||
- `relay_deactivated`
|
||||
- `relay_sync_failed`
|
||||
- `invoice_created`
|
||||
- `invoice_paid`
|
||||
- `invoice_attempted`
|
||||
- `invoice_sent`
|
||||
- `invoice_closed`
|
||||
- `create_tenant`
|
||||
- `update_tenant_billing_anchor`
|
||||
- `update_tenant_nwc_url`
|
||||
- `create_relay`
|
||||
- `update_relay`
|
||||
- `activate_relay`
|
||||
- `deactivate_relay`
|
||||
- `fail_relay_sync`
|
||||
- `create_invoice`
|
||||
- `mark_invoice_paid`
|
||||
- `mark_invoice_attempted`
|
||||
- `mark_invoice_sent`
|
||||
- `mark_invoice_closed`
|
||||
- `identifier` is a string identifying the resource being modified. This id in interpreted depending on what the `activity_type` is.
|
||||
|
||||
# Tenant
|
||||
@@ -26,7 +30,7 @@ Activity is an audit log of all actions performed by a user or a worker process.
|
||||
Tenants are customers of the service, identified by a nostr `pubkey`. Public metadata like name etc are pulled from the nostr network. They also have associated billing information.
|
||||
|
||||
- `pubkey` is the nostr public key identifying the tenant
|
||||
- `nwc_url` a nostr wallet connect URL used for **paying** invoices generated by the system
|
||||
- `nwc_url` (private) a nostr wallet connect URL used for **paying** invoices generated by the system
|
||||
- `created_at` unix timestamp identifying tenant creation time
|
||||
- `billing_anchor` unix timestamp identifying billing cycle anchor. This gets reset when the tenant has no paid relays and adds (or reactivates) one.
|
||||
|
||||
|
||||
+22
-15
@@ -17,11 +17,13 @@ Notes:
|
||||
- Reads `DATABASE_URL` from environment
|
||||
- Ensures that any directories referred to in `DATABASE_URL` exist
|
||||
- Initializes its sqlx `pool`
|
||||
|
||||
## `pub fn migrate(&self) -> Result<()>`
|
||||
|
||||
- Runs migrations found in the `migrations` directory.
|
||||
|
||||
## `fn insert_activity(activity_type, identifier) -> Result<()>`
|
||||
|
||||
- Private helper that inserts one row into `activity`
|
||||
- Used by write methods to avoid repeating audit-log SQL
|
||||
|
||||
## `pub fn list_tenants(&self) -> Result<Vec<Tenant>>`
|
||||
|
||||
- Returns all tenants
|
||||
@@ -33,12 +35,17 @@ Notes:
|
||||
## `pub fn create_tenant(&self, tenant: &Tenant) -> Result<()>`
|
||||
|
||||
- Creates tenant, may throw sqlite uniqueness error on pubkey
|
||||
- Logs activity as `(tenant_created, tenant_id)`
|
||||
- Logs activity as `(create_tenant, tenant_id)`
|
||||
|
||||
## `pub fn update_tenant_billing_anchor(&self, pubkey: &str, billing_anchor: i64) -> Result<()>`
|
||||
|
||||
- Updates the tenant's `billing_anchor`
|
||||
- Logs activity as `(tenant_billing_anchor_updated, tenant_id)`
|
||||
- Logs activity as `(update_tenant_billing_anchor, tenant_id)`
|
||||
|
||||
## `pub fn update_tenant_nwc_url(&self, pubkey: &str, nwc_url: &str) -> Result<()>`
|
||||
|
||||
- Updates tenant `nwc_url`
|
||||
- Logs activity as `(update_tenant_nwc_url, tenant_id)`
|
||||
|
||||
## `pub fn list_relays(&self, tenant_id: Option<&str>) -> Result<Vec<Relay>>`
|
||||
|
||||
@@ -52,32 +59,32 @@ Notes:
|
||||
|
||||
- Creates relay, may throw sqlite uniqueness error on subdomain
|
||||
- Sets relay status to `new`
|
||||
- Logs activity as `(relay_created, relay_id)`
|
||||
- Logs activity as `(create_relay, relay_id)`
|
||||
|
||||
## `pub fn update_relay(&self, relay: &Relay) -> Result<()>`
|
||||
|
||||
- Updates relay, may throw sqlite uniqueness error on subdomain
|
||||
- Logs activity as `(relay_updated, relay_id)`
|
||||
- Logs activity as `(update_relay, relay_id)`
|
||||
|
||||
## `pub fn deactivate_relay(&self, relay: &Relay) -> Result<()>`
|
||||
|
||||
- Sets relay status to `inactive`
|
||||
- Logs activity as `(relay_deactivated, relay_id)`
|
||||
- Logs activity as `(deactivate_relay, relay_id)`
|
||||
|
||||
## `pub fn activate_relay(&self, relay: &Relay) -> Result<()>`
|
||||
|
||||
- Sets relay status to `active`
|
||||
- Logs activity as `(relay_activated, relay_id)`
|
||||
- Logs activity as `(activate_relay, relay_id)`
|
||||
|
||||
## `pub fn fail_relay_sync(&self, relay: &Relay, sync_error: String) -> Result<()>`
|
||||
|
||||
- Sets relay status to `inactive`, sets `sync_error`
|
||||
- Logs activity as `(relay_sync_failed, relay_id)`
|
||||
- Logs activity as `(fail_relay_sync, relay_id)`
|
||||
|
||||
## `pub fn create_invoice(&self, invoice: &Invoice, invoice_items: [&InvoiceItem]) -> Result<()>`
|
||||
|
||||
- Saves an `invoice` row and related `invoice_item` rows
|
||||
- Logs activity as `(invoice_created, invoice_id)`
|
||||
- Logs activity as `(create_invoice, invoice_id)`
|
||||
|
||||
## `pub fn list_invoices(tenant_id: Option<&str>) -> Result<Vec<Invoice>>`
|
||||
|
||||
@@ -88,26 +95,26 @@ Notes:
|
||||
- Sets invoice status to `paid`
|
||||
- Sets `paid_at` to now
|
||||
- Clears `error` if set
|
||||
- Logs activity as `(invoice_paid, invoice_id)`
|
||||
- Logs activity as `(mark_invoice_paid, invoice_id)`
|
||||
|
||||
## `pub fn mark_invoice_attempted(&self, invoice_id: &str, error: Option<&str>) -> Result<()>`
|
||||
|
||||
- Sets `attempted_at` to now
|
||||
- Updates `error` if provided
|
||||
- Leaves status as `pending`
|
||||
- Logs activity as `(invoice_attempted, invoice_id)`
|
||||
- Logs activity as `(mark_invoice_attempted, invoice_id)`
|
||||
|
||||
## `pub fn mark_invoice_sent(&self, invoice_id: &str) -> Result<()>`
|
||||
|
||||
- Sets `sent_at` to now
|
||||
- Leaves status as `pending`
|
||||
- Logs activity as `(invoice_sent, invoice_id)`
|
||||
- Logs activity as `(mark_invoice_sent, invoice_id)`
|
||||
|
||||
## `pub fn mark_invoice_closed(&self, invoice_id: &str) -> Result<()>`
|
||||
|
||||
- Sets invoice status to `closed`
|
||||
- Sets `closed_at` to now
|
||||
- Logs activity as `(invoice_closed, invoice_id)`
|
||||
- Logs activity as `(mark_invoice_closed, invoice_id)`
|
||||
|
||||
## `pub fn list_activity(&self, since: &i64, tenant: Option<&str>) -> Result<Vec<Activity>>`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user