cf-modkit-db 0.7.2

ModKit database library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use sea_orm::{ConnectionTrait, DatabaseBackend, DbErr, Statement};
use sea_orm_migration::prelude::*;

/// Single migration that creates the entire outbox schema from scratch.
///
/// Tables are created in FK dependency order:
/// body → partitions → incoming → outgoing → dead-letters → processor
///
/// # Idempotency
///
/// All `CREATE TABLE` statements use `IF NOT EXISTS` so the migration is safe
/// to re-run (e.g., after a partial failure).  `CREATE INDEX` statements do
/// **not** — `MySQL` has no `IF NOT EXISTS` syntax for indexes, and keeping the
/// Pg/SQLite paths consistent avoids a false sense of safety on only some
/// backends.  Because each index immediately follows its `CREATE TABLE IF NOT
/// EXISTS`, the index can only pre-exist if the migration crashed between the
/// two statements *and* the migration runner retries without rolling back.
/// The sea-orm migration framework tracks completed migrations, so this edge
/// case requires a crash mid-transaction — acceptable for a `preview-outbox`
/// alpha feature with no production deployments.
struct CreateOutboxSchema;

impl MigrationName for CreateOutboxSchema {
    fn name(&self) -> &'static str {
        "m001_create_modkit_outbox_schema"
    }
}

#[async_trait::async_trait]
impl MigrationTrait for CreateOutboxSchema {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        let conn = manager.get_connection();
        let backend = conn.get_database_backend();

        create_body(conn, backend).await?;
        create_partitions(conn, backend).await?;
        create_incoming(conn, backend).await?;
        create_outgoing(conn, backend).await?;
        create_dead_letters(conn, backend).await?;
        create_processor(conn, backend).await?;
        create_vacuum_counter(conn, backend).await?;

        Ok(())
    }

    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        let conn = manager.get_connection();
        let backend = conn.get_database_backend();

        for table in [
            "modkit_outbox_vacuum_counter",
            "modkit_outbox_processor",
            "modkit_outbox_dead_letters",
            "modkit_outbox_outgoing",
            "modkit_outbox_incoming",
            "modkit_outbox_partitions",
            "modkit_outbox_body",
        ] {
            conn.execute(Statement::from_string(
                backend,
                format!("DROP TABLE IF EXISTS {table}"),
            ))
            .await?;
        }
        Ok(())
    }
}

async fn create_body(conn: &dyn ConnectionTrait, backend: DatabaseBackend) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_body (
                id            BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
                payload       BYTEA  NOT NULL,
                payload_type  VARCHAR(1024) NOT NULL,
                created_at    TIMESTAMPTZ NOT NULL DEFAULT now()
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_body (
                id            INTEGER PRIMARY KEY AUTOINCREMENT,
                payload       BLOB   NOT NULL,
                payload_type  TEXT   NOT NULL,
                created_at    TEXT   NOT NULL DEFAULT (datetime('now'))
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_body (
                id            BIGINT AUTO_INCREMENT PRIMARY KEY,
                payload       LONGBLOB NOT NULL,
                payload_type  VARCHAR(1024) NOT NULL,
                created_at    TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6)
            )"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_partitions(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_partitions (
                id        BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
                queue     VARCHAR(1024) NOT NULL,
                partition SMALLINT NOT NULL,
                sequence  BIGINT   NOT NULL DEFAULT 0,
                UNIQUE (queue, partition)
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_partitions (
                id        INTEGER PRIMARY KEY AUTOINCREMENT,
                queue     TEXT    NOT NULL,
                partition INTEGER NOT NULL,
                sequence  INTEGER NOT NULL DEFAULT 0,
                UNIQUE (queue, partition)
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_partitions (
                id        BIGINT AUTO_INCREMENT PRIMARY KEY,
                queue     VARCHAR(1024) CHARACTER SET ascii NOT NULL,
                `partition` SMALLINT NOT NULL,
                sequence  BIGINT   NOT NULL DEFAULT 0,
                UNIQUE KEY (queue, `partition`)
            )"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_incoming(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_incoming (
                id           BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
                partition_id BIGINT   NOT NULL REFERENCES modkit_outbox_partitions(id),
                body_id      BIGINT   NOT NULL REFERENCES modkit_outbox_body(id)
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_incoming (
                id           INTEGER PRIMARY KEY AUTOINCREMENT,
                partition_id INTEGER NOT NULL REFERENCES modkit_outbox_partitions(id),
                body_id      INTEGER NOT NULL REFERENCES modkit_outbox_body(id)
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_incoming (
                id           BIGINT AUTO_INCREMENT PRIMARY KEY,
                partition_id BIGINT NOT NULL,
                body_id      BIGINT NOT NULL,
                FOREIGN KEY (partition_id) REFERENCES modkit_outbox_partitions(id),
                FOREIGN KEY (body_id) REFERENCES modkit_outbox_body(id)
            )"
            }
        },
    ))
    .await?;

    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres | DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE INDEX idx_modkit_outbox_incoming_partition \
             ON modkit_outbox_incoming (partition_id, id)"
            }
        },
    ))
    .await?;

    // Index on body_id to accelerate FK constraint checks during
    // DELETE FROM modkit_outbox_body WHERE id IN (...).
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres | DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE INDEX idx_modkit_outbox_incoming_body_id \
             ON modkit_outbox_incoming (body_id)"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_outgoing(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_outgoing (
                id           BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
                partition_id BIGINT NOT NULL REFERENCES modkit_outbox_partitions(id),
                body_id      BIGINT NOT NULL REFERENCES modkit_outbox_body(id),
                seq          BIGINT NOT NULL,
                sequenced_at TIMESTAMPTZ NOT NULL DEFAULT now()
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_outgoing (
                id           INTEGER PRIMARY KEY AUTOINCREMENT,
                partition_id INTEGER NOT NULL REFERENCES modkit_outbox_partitions(id),
                body_id      INTEGER NOT NULL REFERENCES modkit_outbox_body(id),
                seq          INTEGER NOT NULL,
                sequenced_at TEXT    NOT NULL DEFAULT (datetime('now'))
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_outgoing (
                id           BIGINT AUTO_INCREMENT PRIMARY KEY,
                partition_id BIGINT NOT NULL,
                body_id      BIGINT NOT NULL,
                seq          BIGINT NOT NULL,
                sequenced_at TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
                FOREIGN KEY (partition_id) REFERENCES modkit_outbox_partitions(id),
                FOREIGN KEY (body_id) REFERENCES modkit_outbox_body(id)
            )"
            }
        },
    ))
    .await?;

    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres | DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE UNIQUE INDEX idx_modkit_outbox_outgoing_partition_seq \
             ON modkit_outbox_outgoing (partition_id, seq)"
            }
        },
    ))
    .await?;

    // Index on body_id to accelerate FK constraint checks during
    // DELETE FROM modkit_outbox_body WHERE id IN (...).
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres | DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE INDEX idx_modkit_outbox_outgoing_body_id \
             ON modkit_outbox_outgoing (body_id)"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_dead_letters(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_dead_letters (
                id           BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
                partition_id BIGINT NOT NULL REFERENCES modkit_outbox_partitions(id),
                seq          BIGINT NOT NULL,
                payload      BYTEA  NOT NULL,
                payload_type VARCHAR(1024) NOT NULL,
                created_at   TIMESTAMPTZ NOT NULL,
                failed_at    TIMESTAMPTZ NOT NULL DEFAULT now(),
                last_error   TEXT,
                attempts     SMALLINT NOT NULL,
                status       VARCHAR(32) NOT NULL DEFAULT 'pending',
                completed_at TIMESTAMPTZ,
                deadline     TIMESTAMPTZ
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_dead_letters (
                id           INTEGER PRIMARY KEY AUTOINCREMENT,
                partition_id INTEGER NOT NULL REFERENCES modkit_outbox_partitions(id),
                seq          INTEGER NOT NULL,
                payload      BLOB   NOT NULL,
                payload_type TEXT   NOT NULL,
                created_at   TEXT    NOT NULL,
                failed_at    TEXT    NOT NULL DEFAULT (datetime('now')),
                last_error   TEXT,
                attempts     INTEGER NOT NULL,
                status       TEXT    NOT NULL DEFAULT 'pending',
                completed_at TEXT,
                deadline     TEXT
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_dead_letters (
                id           BIGINT AUTO_INCREMENT PRIMARY KEY,
                partition_id BIGINT NOT NULL,
                seq          BIGINT NOT NULL,
                payload      LONGBLOB NOT NULL,
                payload_type VARCHAR(1024) CHARACTER SET ascii NOT NULL,
                created_at   TIMESTAMP(6) NOT NULL,
                failed_at    TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
                last_error   TEXT,
                attempts     SMALLINT NOT NULL,
                status       VARCHAR(32) NOT NULL DEFAULT 'pending',
                completed_at TIMESTAMP(6) NULL,
                deadline     TIMESTAMP(6) NULL,
                FOREIGN KEY (partition_id) REFERENCES modkit_outbox_partitions(id)
            )"
            }
        },
    ))
    .await?;

    // Index for replay query (status = 'pending' OR (status = 'reprocessing' AND deadline < now()))
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE INDEX idx_modkit_outbox_dl_replayable \
             ON modkit_outbox_dead_letters (status, deadline) \
             WHERE status IN ('pending', 'reprocessing')"
            }
            DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE INDEX idx_modkit_outbox_dl_status_deadline \
             ON modkit_outbox_dead_letters (status, deadline)"
            }
        },
    ))
    .await?;

    // Index for list queries with status filter + ORDER BY failed_at DESC
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE INDEX idx_modkit_outbox_dl_status_failed \
             ON modkit_outbox_dead_letters (status, failed_at DESC)"
            }
            DatabaseBackend::Sqlite | DatabaseBackend::MySql => {
                "CREATE INDEX idx_modkit_outbox_dl_status_failed \
             ON modkit_outbox_dead_letters (status, failed_at)"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_processor(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_processor (
                partition_id  BIGINT PRIMARY KEY REFERENCES modkit_outbox_partitions(id),
                processed_seq BIGINT   NOT NULL DEFAULT 0,
                attempts      SMALLINT NOT NULL DEFAULT 0,
                last_error    TEXT,
                locked_by     VARCHAR(1024),
                locked_until  TIMESTAMPTZ
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_processor (
                partition_id  INTEGER PRIMARY KEY REFERENCES modkit_outbox_partitions(id),
                processed_seq INTEGER NOT NULL DEFAULT 0,
                attempts      INTEGER NOT NULL DEFAULT 0,
                last_error    TEXT,
                locked_by     TEXT,
                locked_until  TEXT
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_processor (
                partition_id  BIGINT PRIMARY KEY,
                processed_seq BIGINT   NOT NULL DEFAULT 0,
                attempts      SMALLINT NOT NULL DEFAULT 0,
                last_error    TEXT,
                locked_by     VARCHAR(1024) CHARACTER SET ascii,
                locked_until  TIMESTAMP(6) NULL,
                FOREIGN KEY (partition_id) REFERENCES modkit_outbox_partitions(id)
            )"
            }
        },
    ))
    .await?;
    Ok(())
}

async fn create_vacuum_counter(
    conn: &dyn ConnectionTrait,
    backend: DatabaseBackend,
) -> Result<(), DbErr> {
    conn.execute(Statement::from_string(
        backend,
        match backend {
            DatabaseBackend::Postgres => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_vacuum_counter (
                partition_id BIGINT PRIMARY KEY
                    REFERENCES modkit_outbox_partitions(id),
                counter      BIGINT NOT NULL DEFAULT 0
            )"
            }
            DatabaseBackend::Sqlite => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_vacuum_counter (
                partition_id INTEGER PRIMARY KEY
                    REFERENCES modkit_outbox_partitions(id),
                counter      INTEGER NOT NULL DEFAULT 0
            )"
            }
            DatabaseBackend::MySql => {
                "CREATE TABLE IF NOT EXISTS modkit_outbox_vacuum_counter (
                partition_id BIGINT PRIMARY KEY,
                counter      BIGINT NOT NULL DEFAULT 0,
                FOREIGN KEY (partition_id) REFERENCES modkit_outbox_partitions(id)
            )"
            }
        },
    ))
    .await?;
    Ok(())
}

/// Returns all outbox migrations in dependency order.
#[must_use]
pub fn outbox_migrations() -> Vec<Box<dyn MigrationTrait>> {
    vec![Box::new(CreateOutboxSchema)]
}