waypoint-core 0.4.0

Lightweight, Flyway-compatible SQL migration library for PostgreSQL and MySQL
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
//! Auto-reversal generation from schema diffs.
//!
//! Captures before/after schema snapshots around migration execution
//! and generates reverse DDL that can undo the migration without
//! requiring manual `U{version}__*.sql` files.

use serde::Serialize;

#[cfg(feature = "postgres")]
use tokio_postgres::Client;

#[cfg(feature = "postgres")]
use crate::db::quote_ident;
use crate::db::DbClient;
use crate::dialect::DialectKind;
use crate::error::Result;
use crate::schema::{self, SchemaDiff, SchemaSnapshot};

/// Configuration for auto-reversal generation.
#[derive(Debug, Clone)]
pub struct ReversalConfig {
    /// Whether auto-reversal generation is enabled.
    pub enabled: bool,
    /// Whether to emit warnings for data-loss operations in reversal SQL.
    pub warn_data_loss: bool,
}

impl Default for ReversalConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            warn_data_loss: true,
        }
    }
}

/// Result of generating a reversal for a migration.
#[derive(Debug, Clone, Serialize)]
pub struct ReversalResult {
    /// The generated reverse SQL, or None if reversal is not possible.
    pub reversal_sql: Option<String>,
    /// Whether the reversal involves data loss (DROP TABLE, DROP COLUMN, etc.).
    pub has_data_loss: bool,
    /// Warnings about the generated reversal.
    pub warnings: Vec<String>,
}

/// Capture a schema snapshot before migration execution (PostgreSQL legacy).
#[cfg(feature = "postgres")]
pub async fn capture_before(client: &Client, schema: &str) -> Result<SchemaSnapshot> {
    schema::introspect(client, schema).await
}

/// Capture a schema snapshot before migration execution (dialect-aware).
pub async fn capture_before_db(client: &DbClient, schema: &str) -> Result<SchemaSnapshot> {
    schema::introspect_db(client, schema).await
}

/// Capture a schema snapshot after migration execution and generate reverse
/// DDL (PostgreSQL legacy).
#[cfg(feature = "postgres")]
pub async fn generate_reversal(
    client: &Client,
    schema_name: &str,
    before: &SchemaSnapshot,
    warn_data_loss: bool,
) -> Result<ReversalResult> {
    let after = schema::introspect(client, schema_name).await?;

    // Compute the reverse diff: diff(after, before) gives us what we need to
    // "undo" the migration (go from after back to before)
    let reverse_diffs = schema::diff(&after, before);

    if reverse_diffs.is_empty() {
        return Ok(ReversalResult {
            reversal_sql: None,
            has_data_loss: false,
            warnings: vec!["No schema changes detected; no reversal generated.".to_string()],
        });
    }

    let mut has_data_loss = false;
    let mut warnings = Vec::new();

    // Check for data-loss operations in the reverse diff
    for d in &reverse_diffs {
        match d {
            SchemaDiff::TableDropped(name) => {
                has_data_loss = true;
                if warn_data_loss {
                    warnings.push(format!(
                        "DATA_LOSS: DROP TABLE {} — original data cannot be restored",
                        name
                    ));
                }
            }
            SchemaDiff::ColumnDropped { table, column } => {
                has_data_loss = true;
                if warn_data_loss {
                    warnings.push(format!(
                        "DATA_LOSS: DROP COLUMN {}.{} — original data cannot be restored",
                        table, column
                    ));
                }
            }
            _ => {}
        }
    }

    // Generate DDL from the reverse diff
    let mut sql = schema::generate_ddl(&reverse_diffs);

    // Prepend data-loss warnings as SQL comments
    if has_data_loss && warn_data_loss {
        let warning_comments: Vec<String> = warnings
            .iter()
            .map(|w| format!("-- WARNING: {}", w))
            .collect();
        sql = format!("{}\n\n{}", warning_comments.join("\n"), sql);
    }

    Ok(ReversalResult {
        reversal_sql: Some(sql),
        has_data_loss,
        warnings,
    })
}

/// Store reversal SQL in the history table for a specific version (PG legacy).
#[cfg(feature = "postgres")]
pub async fn store_reversal(
    client: &Client,
    schema: &str,
    table: &str,
    version: &str,
    reversal_sql: &str,
) -> Result<()> {
    let sql = format!(
        "UPDATE {}.{} SET reversal_sql = $1 WHERE version = $2 AND success = TRUE \
         AND installed_rank = (SELECT MAX(installed_rank) FROM {}.{} WHERE version = $2 AND success = TRUE)",
        quote_ident(schema),
        quote_ident(table),
        quote_ident(schema),
        quote_ident(table),
    );
    client.execute(&sql, &[&reversal_sql, &version]).await?;
    Ok(())
}

/// Retrieve stored reversal SQL for a specific version (PG legacy).
#[cfg(feature = "postgres")]
pub async fn get_reversal(
    client: &Client,
    schema: &str,
    table: &str,
    version: &str,
) -> Result<Option<String>> {
    let sql = format!(
        "SELECT reversal_sql FROM {}.{} WHERE version = $1 AND success = TRUE \
         ORDER BY installed_rank DESC LIMIT 1",
        quote_ident(schema),
        quote_ident(table),
    );
    let rows = client.query(&sql, &[&version]).await?;
    if let Some(row) = rows.first() {
        Ok(row.get::<_, Option<String>>(0))
    } else {
        Ok(None)
    }
}

// ── Dialect-aware reversal generation/storage/retrieval ──────────────────────

/// Capture an after-snapshot, diff against `before`, and produce a reversal
/// SQL string suitable for storing in `waypoint_schema_history.reversal_sql`.
/// Dispatches to the right DDL generator (PG vs MySQL) based on the connection.
pub async fn generate_reversal_db(
    client: &DbClient,
    schema_name: &str,
    before: &SchemaSnapshot,
    warn_data_loss: bool,
) -> Result<ReversalResult> {
    let after = schema::introspect_db(client, schema_name).await?;
    let reverse_diffs = schema::diff(&after, before);

    if reverse_diffs.is_empty() {
        return Ok(ReversalResult {
            reversal_sql: None,
            has_data_loss: false,
            warnings: vec!["No schema changes detected; no reversal generated.".to_string()],
        });
    }

    let mut has_data_loss = false;
    let mut warnings = Vec::new();
    for d in &reverse_diffs {
        match d {
            SchemaDiff::TableDropped(name) => {
                has_data_loss = true;
                if warn_data_loss {
                    warnings.push(format!(
                        "DATA_LOSS: DROP TABLE {} — original data cannot be restored",
                        name
                    ));
                }
            }
            SchemaDiff::ColumnDropped { table, column } => {
                has_data_loss = true;
                if warn_data_loss {
                    warnings.push(format!(
                        "DATA_LOSS: DROP COLUMN {}.{} — original data cannot be restored",
                        table, column
                    ));
                }
            }
            _ => {}
        }
    }

    // Emit DDL in the dialect of the connection.
    let mut sql = match client.dialect_kind() {
        DialectKind::Postgres => schema::generate_ddl(&reverse_diffs),
        DialectKind::Mysql => schema::generate_ddl_mysql(&reverse_diffs),
    };

    if has_data_loss && warn_data_loss {
        let warning_comments: Vec<String> = warnings
            .iter()
            .map(|w| format!("-- WARNING: {}", w))
            .collect();
        sql = format!("{}\n\n{}", warning_comments.join("\n"), sql);
    }

    Ok(ReversalResult {
        reversal_sql: Some(sql),
        has_data_loss,
        warnings,
    })
}

/// Store reversal SQL in the history table (dialect-aware).
pub async fn store_reversal_db(
    client: &DbClient,
    schema: &str,
    table: &str,
    version: &str,
    reversal_sql: &str,
) -> Result<()> {
    let dialect = client.dialect();
    let fq = dialect.qualified_table(schema, table);
    match client {
        #[cfg(feature = "postgres")]
        DbClient::Postgres(c) => {
            let sql = format!(
                "UPDATE {fq} SET reversal_sql = $1 WHERE version = $2 AND success = TRUE \
                 AND installed_rank = (SELECT MAX(installed_rank) FROM {fq} \
                 WHERE version = $2 AND success = TRUE)"
            );
            c.execute(&sql, &[&reversal_sql, &version]).await?;
        }
        #[cfg(feature = "mysql")]
        DbClient::Mysql(pool) => {
            use mysql_async::prelude::*;
            let mut conn = pool.get_conn().await?;
            // MySQL doesn't allow self-referencing the target table in a
            // subquery during UPDATE, so we read the max rank first.
            // SELECT MAX over a filtered set returns a row with NULL when no
            // rows match, so we type as Option<Option<i32>> (outer = row exists,
            // inner = MAX value or NULL) and flatten.
            let max_rank: Option<Option<i32>> = conn
                .exec_first(
                    format!(
                        "SELECT MAX(installed_rank) FROM {fq} \
                         WHERE version = ? AND success = TRUE"
                    ),
                    (version,),
                )
                .await?;
            if let Some(rank) = max_rank.flatten() {
                conn.exec_drop(
                    format!("UPDATE {fq} SET reversal_sql = ? WHERE installed_rank = ?"),
                    (reversal_sql, rank),
                )
                .await?;
            }
        }
    }
    Ok(())
}

/// Retrieve stored reversal SQL for a specific version (dialect-aware).
pub async fn get_reversal_db(
    client: &DbClient,
    schema: &str,
    table: &str,
    version: &str,
) -> Result<Option<String>> {
    let dialect = client.dialect();
    let fq = dialect.qualified_table(schema, table);
    match client {
        #[cfg(feature = "postgres")]
        DbClient::Postgres(c) => {
            let sql = format!(
                "SELECT reversal_sql FROM {fq} WHERE version = $1 AND success = TRUE \
                 ORDER BY installed_rank DESC LIMIT 1"
            );
            let rows = c.query(&sql, &[&version]).await?;
            Ok(rows.first().and_then(|r| r.get::<_, Option<String>>(0)))
        }
        #[cfg(feature = "mysql")]
        DbClient::Mysql(pool) => {
            use mysql_async::prelude::*;
            let mut conn = pool.get_conn().await?;
            let row: Option<Option<String>> = conn
                .exec_first(
                    format!(
                        "SELECT reversal_sql FROM {fq} WHERE version = ? AND success = TRUE \
                         ORDER BY installed_rank DESC LIMIT 1"
                    ),
                    (version,),
                )
                .await?;
            Ok(row.flatten())
        }
    }
}

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

    fn empty_snapshot() -> SchemaSnapshot {
        SchemaSnapshot {
            tables: vec![],
            views: vec![],
            indexes: vec![],
            sequences: vec![],
            functions: vec![],
            enums: vec![],
            constraints: vec![],
            triggers: vec![],
            extensions: vec![],
        }
    }

    #[test]
    fn test_reverse_diff_create_table_generates_drop() {
        let before = empty_snapshot();
        let mut after = empty_snapshot();
        after.tables.push(TableDef {
            schema: "public".to_string(),
            name: "users".to_string(),
            columns: vec![ColumnDef {
                name: "id".to_string(),
                data_type: "integer".to_string(),
                is_nullable: false,
                default: None,
                ordinal_position: 1,
            }],
        });

        // Reverse diff: from after back to before → should generate DROP TABLE
        let diffs = schema::diff(&after, &before);
        assert_eq!(diffs.len(), 1);
        match &diffs[0] {
            SchemaDiff::TableDropped(name) => assert_eq!(name, "users"),
            other => panic!("Expected TableDropped, got {:?}", other),
        }
    }

    #[test]
    fn test_reverse_diff_add_column_generates_drop_column() {
        let mut before = empty_snapshot();
        before.tables.push(TableDef {
            schema: "public".to_string(),
            name: "users".to_string(),
            columns: vec![ColumnDef {
                name: "id".to_string(),
                data_type: "integer".to_string(),
                is_nullable: false,
                default: None,
                ordinal_position: 1,
            }],
        });

        let mut after = empty_snapshot();
        after.tables.push(TableDef {
            schema: "public".to_string(),
            name: "users".to_string(),
            columns: vec![
                ColumnDef {
                    name: "id".to_string(),
                    data_type: "integer".to_string(),
                    is_nullable: false,
                    default: None,
                    ordinal_position: 1,
                },
                ColumnDef {
                    name: "email".to_string(),
                    data_type: "character varying".to_string(),
                    is_nullable: true,
                    default: None,
                    ordinal_position: 2,
                },
            ],
        });

        let diffs = schema::diff(&after, &before);
        assert_eq!(diffs.len(), 1);
        match &diffs[0] {
            SchemaDiff::ColumnDropped { table, column } => {
                assert_eq!(table, "users");
                assert_eq!(column, "email");
            }
            other => panic!("Expected ColumnDropped, got {:?}", other),
        }
    }

    #[test]
    fn test_reverse_diff_drop_table_generates_create() {
        let mut before = empty_snapshot();
        before.tables.push(TableDef {
            schema: "public".to_string(),
            name: "old_table".to_string(),
            columns: vec![ColumnDef {
                name: "id".to_string(),
                data_type: "integer".to_string(),
                is_nullable: false,
                default: None,
                ordinal_position: 1,
            }],
        });

        let after = empty_snapshot();

        let diffs = schema::diff(&after, &before);
        assert_eq!(diffs.len(), 1);
        match &diffs[0] {
            SchemaDiff::TableAdded(t) => {
                assert_eq!(t.name, "old_table");
                assert_eq!(t.columns.len(), 1);
            }
            other => panic!("Expected TableAdded, got {:?}", other),
        }
    }

    #[test]
    fn test_reverse_ddl_generation() {
        let before = empty_snapshot();
        let mut after = empty_snapshot();
        after.tables.push(TableDef {
            schema: "public".to_string(),
            name: "users".to_string(),
            columns: vec![ColumnDef {
                name: "id".to_string(),
                data_type: "integer".to_string(),
                is_nullable: false,
                default: None,
                ordinal_position: 1,
            }],
        });

        let diffs = schema::diff(&after, &before);
        let ddl = schema::generate_ddl(&diffs);
        assert!(ddl.contains("DROP TABLE"));
        assert!(ddl.contains("users"));
    }

    #[test]
    fn test_no_changes_empty_diff() {
        let snapshot = empty_snapshot();
        let diffs = schema::diff(&snapshot, &snapshot);
        assert!(diffs.is_empty());
    }

    #[test]
    fn test_reversal_config_default() {
        let config = ReversalConfig::default();
        assert!(config.enabled);
        assert!(config.warn_data_loss);
    }
}