tests & plain formatter

Author: Shubham8287

Cargo.lock

@@ -32,6 +32,7 @@ enum-as-inner.workspace = true
 enum-map.workspace = true
 colored.workspace = true
 regex.workspace = true
+insta.workspace = true
 
 [dev-dependencies]
 spacetimedb-lib = { path = "../lib", features = ["test"] }

crates/schema/Cargo.toml

@@ -789,20 +789,19 @@ mod tests {
     use v9::{RawModuleDefV9Builder, TableAccess};
     use validate::tests::expect_identifier;
 
-    #[test]
-    fn successful_auto_migration() {
-        let mut old_builder = RawModuleDefV9Builder::new();
-        let old_schedule_at = old_builder.add_type::<ScheduleAt>();
-        let old_sum_ty = AlgebraicType::sum([("v1", AlgebraicType::U64)]);
-        let old_sum_refty = old_builder.add_algebraic_type([], "sum", old_sum_ty, true);
-        old_builder
+    fn initial_module_def() -> ModuleDef {
+        let mut builder = RawModuleDefV9Builder::new();
+        let schedule_at = builder.add_type::<ScheduleAt>();
+        let sum_ty = AlgebraicType::sum([("v1", AlgebraicType::U64)]);
+        let sum_refty = builder.add_algebraic_type([], "sum", sum_ty, true);
+        builder
             .build_table_with_new_type(
                 "Apples",
                 ProductType::from([
                     ("id", AlgebraicType::U64),
                     ("name", AlgebraicType::String),
                     ("count", AlgebraicType::U16),
-                    ("sum", old_sum_refty.into()),
+                    ("sum", sum_refty.into()),
                 ]),
                 true,
             )
@@ -812,7 +811,7 @@ mod tests {
             .with_index(btree([0, 1]), "id_name_index")
             .finish();
 
-        old_builder
+        builder
             .build_table_with_new_type(
                 "Bananas",
                 ProductType::from([
@@ -825,59 +824,61 @@ mod tests {
             .with_access(TableAccess::Public)
             .finish();
 
-        let old_deliveries_type = old_builder
+        let deliveries_type = builder
             .build_table_with_new_type(
                 "Deliveries",
                 ProductType::from([
                     ("scheduled_id", AlgebraicType::U64),
-                    ("scheduled_at", old_schedule_at.clone()),
-                    ("sum", AlgebraicType::array(old_sum_refty.into())),
+                    ("scheduled_at", schedule_at.clone()),
+                    ("sum", AlgebraicType::array(sum_refty.into())),
                 ]),
                 true,
             )
             .with_auto_inc_primary_key(0)
             .with_index_no_accessor_name(btree(0))
             .with_schedule("check_deliveries", 1)
             .finish();
-        old_builder.add_reducer(
+        builder.add_reducer(
             "check_deliveries",
-            ProductType::from([("a", AlgebraicType::Ref(old_deliveries_type))]),
+            ProductType::from([("a", AlgebraicType::Ref(deliveries_type))]),
             None,
         );
 
-        old_builder
+        builder
             .build_table_with_new_type(
                 "Inspections",
                 ProductType::from([
                     ("scheduled_id", AlgebraicType::U64),
-                    ("scheduled_at", old_schedule_at.clone()),
+                    ("scheduled_at", schedule_at.clone()),
                 ]),
                 true,
             )
             .with_auto_inc_primary_key(0)
             .with_index_no_accessor_name(btree(0))
             .finish();
 
-        old_builder.add_row_level_security("SELECT * FROM Apples");
+        builder.add_row_level_security("SELECT * FROM Apples");
 
-        let old_def: ModuleDef = old_builder
+        builder
             .finish()
             .try_into()
-            .expect("old_def should be a valid database definition");
+            .expect("old_def should be a valid database definition")
+    }
 
-        let mut new_builder = RawModuleDefV9Builder::new();
-        let _ = new_builder.add_type::<u32>(); // reposition ScheduleAt in the typespace, should have no effect.
-        let new_schedule_at = new_builder.add_type::<ScheduleAt>();
-        let new_sum_ty = AlgebraicType::sum([("v1", AlgebraicType::U64), ("v2", AlgebraicType::Bool)]);
-        let new_sum_refty = new_builder.add_algebraic_type([], "sum", new_sum_ty, true);
-        new_builder
+    fn updated_module_def() -> ModuleDef {
+        let mut builder = RawModuleDefV9Builder::new();
+        let _ = builder.add_type::<u32>(); // reposition ScheduleAt in the typespace, should have no effect.
+        let schedule_at = builder.add_type::<ScheduleAt>();
+        let sum_ty = AlgebraicType::sum([("v1", AlgebraicType::U64), ("v2", AlgebraicType::Bool)]);
+        let sum_refty = builder.add_algebraic_type([], "sum", sum_ty, true);
+        builder
             .build_table_with_new_type(
                 "Apples",
                 ProductType::from([
                     ("id", AlgebraicType::U64),
                     ("name", AlgebraicType::String),
                     ("count", AlgebraicType::U16),
-                    ("sum", new_sum_refty.into()),
+                    ("sum", sum_refty.into()),
                 ]),
                 true,
             )
@@ -889,7 +890,7 @@ mod tests {
             .with_index(btree([0, 2]), "id_count_index")
             .finish();
 
-        new_builder
+        builder
             .build_table_with_new_type(
                 "Bananas",
                 ProductType::from([
@@ -907,13 +908,13 @@ mod tests {
             .with_access(TableAccess::Private)
             .finish();
 
-        let new_deliveries_type = new_builder
+        let deliveries_type = builder
             .build_table_with_new_type(
                 "Deliveries",
                 ProductType::from([
                     ("scheduled_id", AlgebraicType::U64),
-                    ("scheduled_at", new_schedule_at.clone()),
-                    ("sum", AlgebraicType::array(new_sum_refty.into())),
+                    ("scheduled_at", schedule_at.clone()),
+                    ("sum", AlgebraicType::array(sum_refty.into())),
                 ]),
                 true,
             )
@@ -922,18 +923,18 @@ mod tests {
             // remove schedule def
             .finish();
 
-        new_builder.add_reducer(
+        builder.add_reducer(
             "check_deliveries",
-            ProductType::from([("a", AlgebraicType::Ref(new_deliveries_type))]),
+            ProductType::from([("a", AlgebraicType::Ref(deliveries_type))]),
             None,
         );
 
-        let new_inspections_type = new_builder
+        let new_inspections_type = builder
             .build_table_with_new_type(
                 "Inspections",
                 ProductType::from([
                     ("scheduled_id", AlgebraicType::U64),
-                    ("scheduled_at", new_schedule_at.clone()),
+                    ("scheduled_at", schedule_at.clone()),
                 ]),
                 true,
             )
@@ -944,28 +945,33 @@ mod tests {
             .finish();
 
         // add reducer.
-        new_builder.add_reducer(
+        builder.add_reducer(
             "perform_inspection",
             ProductType::from([("a", AlgebraicType::Ref(new_inspections_type))]),
             None,
         );
 
         // Add new table
-        new_builder
+        builder
             .build_table_with_new_type("Oranges", ProductType::from([("id", AlgebraicType::U32)]), true)
             .with_index(btree(0), "id_index")
             .with_column_sequence(0)
             .with_unique_constraint(0)
             .with_primary_key(0)
             .finish();
 
-        new_builder.add_row_level_security("SELECT * FROM Bananas");
+        builder.add_row_level_security("SELECT * FROM Bananas");
 
-        let new_def: ModuleDef = new_builder
+        builder
             .finish()
             .try_into()
-            .expect("new_def should be a valid database definition");
+            .expect("new_def should be a valid database definition")
+    }
 
+    #[test]
+    fn successful_auto_migration() {
+        let old_def = initial_module_def();
+        let new_def = updated_module_def();
         let plan = ponder_auto_migrate(&old_def, &new_def).expect("auto migration should succeed");
 
         let apples = expect_identifier("Apples");
@@ -1413,4 +1419,45 @@ mod tests {
         // but different columns from an old one.
         // We've left the check in, just in case this changes in the future.
     }
+    #[test]
+    fn print_empty_to_populated_schema_migration() {
+        // Start with completely empty schema
+        let old_builder = RawModuleDefV9Builder::new();
+        let old_def: ModuleDef = old_builder
+            .finish()
+            .try_into()
+            .expect("old_def should be a valid database definition");
+
+        let new_def = initial_module_def();
+        let plan = ponder_migrate(&old_def, &new_def).expect("auto migration should succeed");
+
+        insta::assert_snapshot!(
+            "empty_to_populated_migration",
+            plan.pretty_print(false).expect("should pretty print")
+        );
+    }
+
+    #[test]
+    fn print_supervised_migration() {
+        let old_def = initial_module_def();
+        let new_def = updated_module_def();
+        let plan = ponder_migrate(&old_def, &new_def).expect("auto migration should succeed");
+
+        insta::assert_snapshot!(
+            "updated pretty print",
+            plan.pretty_print(false).expect("should pretty print")
+        );
+    }
+
+    #[test]
+    fn no_color_print_supervised_migration() {
+        let old_def = initial_module_def();
+        let new_def = updated_module_def();
+        let plan = ponder_migrate(&old_def, &new_def).expect("auto migration should succeed");
+
+        insta::assert_snapshot!(
+            "updated pretty print no color",
+            plan.pretty_print(true).expect("should pretty print")
+        );
+    }
 }

crates/schema/src/auto_migrate.rs

@@ -1,6 +1,6 @@
 use std::fmt;
 
-use colored::{Color, ColoredString, Colorize as _};
+use colored::{Color, Colorize as _};
 use spacetimedb_lib::{db::raw_def::v9::TableAccess, AlgebraicType};
 use spacetimedb_sats::algebraic_type::fmt::fmt_algebraic_type;
 
@@ -19,24 +19,22 @@ pub struct ColorScheme {
     pub table_name: Color,
     pub column_type: Color,
     pub section_header: Color,
-    pub private_access: Color,
-    pub public_access: Color,
+    pub access: Color,
     pub warning: Color,
 }
 
 impl Default for ColorScheme {
     fn default() -> Self {
         Self {
-            created: Color::Green,              // Green = success/new (calmer than bright)
-            removed: Color::Red,                // Red = deletion/removal
-            changed: Color::Yellow,             // Yellow = caution/change
-            header: Color::BrightBlue,          // Bright Blue = strong visual separation
-            table_name: Color::Cyan,            // Cyan = neutral identifier
-            column_type: Color::Magenta,        // Magenta = type hints (visually distinct)
-            section_header: Color::Blue,        // Blue = soft structural sections
-            private_access: Color::BrightBlack, // Grey = restricted/internal
-            public_access: Color::BrightGreen,  // Bright Green = accessible, open
-            warning: Color::BrightYellow,       // Bright Yellow = strong caution
+            created: Color::Green,
+            removed: Color::BrightRed,
+            changed: Color::Yellow,
+            header: Color::BrightBlue,
+            table_name: Color::Cyan,
+            column_type: Color::Magenta,
+            section_header: Color::Blue,
+            access: Color::BrightGreen,
+            warning: Color::Red,
         }
     }
 }
@@ -67,6 +65,7 @@ impl AnsiFormatter {
     /// Add a line with proper indentation
     fn add_line(&mut self, text: impl AsRef<str>) {
         let indent = "    ".repeat(self.indent_level);
+
         self.buffer.push_str(&format!("{}{}\n", indent, text.as_ref()));
     }
 
@@ -83,21 +82,26 @@ impl AnsiFormatter {
     }
 
     /// Format a type name with consistent coloring
-    fn format_type_name(&self, type_name: &AlgebraicType) -> ColoredString {
-        fmt_algebraic_type(type_name).to_string().color(self.colors.column_type)
+    fn format_type_name(&self, type_name: &AlgebraicType) -> String {
+        fmt_algebraic_type(type_name)
+            .to_string()
+            .color(self.colors.column_type)
+            .to_string()
     }
 
     /// Format table access with consistent coloring
-    fn format_access(&self, access: TableAccess) -> ColoredString {
+    fn format_access(&self, access: TableAccess) -> String {
         match access {
-            TableAccess::Private => "private".color(self.colors.private_access),
-            TableAccess::Public => "public".color(self.colors.public_access),
+            TableAccess::Private => "private",
+            TableAccess::Public => "public",
         }
+        .color(self.colors.access)
+        .to_string()
     }
 
     /// Format a section header
-    fn format_section_header(&self, text: &str) -> ColoredString {
-        text.color(self.colors.section_header).bold()
+    fn format_section_header(&self, text: &str) -> String {
+        text.color(self.colors.section_header).bold().to_string()
     }
 
     /// Format an item bullet point
@@ -121,9 +125,8 @@ impl MigrationFormatter for AnsiFormatter {
     fn format_header(&mut self) {
         let header_line = "━".repeat(60);
         let title = "Database Migration Plan".color(self.colors.header).bold();
-
         self.add_line(&header_line);
-        self.add_line(&*title);
+        self.add_line(title.to_string());
         self.add_line(&header_line);
         self.add_line("");
     }
@@ -267,7 +270,7 @@ impl MigrationFormatter for AnsiFormatter {
             "▸ {} access for table {} ({})",
             Action::Changed.format_with_color(&self.colors),
             access_info.table_name.color(self.colors.table_name).bold(),
-            direction.dimmed()
+            direction.color(self.colors.access)
         );
         self.add_line(&text);
     }
@@ -350,10 +353,11 @@ impl MigrationFormatter for AnsiFormatter {
     }
 
     fn format_disconnect_warning(&mut self) {
-        self.add_line(format!(
-            "▸ {} All clients will be {} due to breaking schema changes",
-            "Warning".color(self.colors.warning).bold(),
-            "disconnected".color(self.colors.removed).bold()
-        ));
+        self.add_line(
+            "!!! Warning: All clients will be disconnected due to breaking schema changes"
+                .bold()
+                .on_color(self.colors.warning)
+                .to_string(),
+        );
     }
 }