Pretty print auto-migration plans

crates/cli/src/subcommands/publish.rs

@@ -170,6 +170,7 @@ pub async fn exec(config: Config, args: &ArgMatches) -> Result<(), anyhow::Error
             domain,
             database_identity,
             op,
+            update_summary,
         } => {
             let op = match op {
                 PublishOp::Created => "Created new",
@@ -180,6 +181,9 @@ pub async fn exec(config: Config, args: &ArgMatches) -> Result<(), anyhow::Error
             } else {
                 println!("{} database with identity: {}", op, database_identity);
             }
+            if let Some(update_summary) = update_summary {
+                println!("{}", update_summary);
+            }
         }
         PublishResult::TldNotRegistered { domain } => {
             return Err(anyhow::anyhow!(

crates/client-api-messages/src/name.rs

@@ -57,6 +57,11 @@ pub enum PublishResult {
         /// or not.
         database_identity: Identity,
         op: PublishOp,
+
+        /// If the database was updated, may contain a string describing the update.
+        /// Contains ANSI escape codes for color.
+        /// Suitable for printing to the console.
+        update_summary: Option<String>,
     },
 
     // TODO: below variants are obsolete with control db module

crates/client-api/src/routes/database.rs

@@ -658,7 +658,7 @@ pub async fn publish<S: NodeDelegate + ControlStateDelegate>(
         .await
         .map_err(log_and_500)?;
 
-    if let Some(updated) = maybe_updated {
+    let update_summary = if let Some(updated) = maybe_updated {
         match updated {
             UpdateDatabaseResult::AutoMigrateError(errs) => {
                 return Err((StatusCode::BAD_REQUEST, format!("Database update rejected: {errs}")).into());
@@ -670,14 +670,18 @@ pub async fn publish<S: NodeDelegate + ControlStateDelegate>(
                 )
                     .into());
             }
-            UpdateDatabaseResult::NoUpdateNeeded | UpdateDatabaseResult::UpdatePerformed => {}
+            UpdateDatabaseResult::NoUpdateNeeded => None,
+            UpdateDatabaseResult::UpdatePerformed(summary) => Some(summary),
         }
-    }
+    } else {
+        None
+    };
 
     Ok(axum::Json(PublishResult::Success {
         domain: db_name.as_ref().map(ToString::to_string),
         database_identity,
         op,
+        update_summary,
     }))
 }
 

crates/core/src/db/update.rs

@@ -7,7 +7,7 @@ use spacetimedb_lib::db::auth::StTableType;
 use spacetimedb_lib::identity::AuthCtx;
 use spacetimedb_lib::AlgebraicValue;
 use spacetimedb_primitives::ColSet;
-use spacetimedb_schema::auto_migrate::{AutoMigratePlan, ManualMigratePlan, MigratePlan};
+use spacetimedb_schema::auto_migrate::{AutoMigratePlan, MigratePlan};
 use spacetimedb_schema::def::TableDef;
 use spacetimedb_schema::schema::{IndexSchema, Schema, SequenceSchema, TableSchema};
 use std::sync::Arc;
@@ -45,22 +45,10 @@ pub fn update_database(
     }
 
     match plan {
-        MigratePlan::Manual(plan) => manual_migrate_database(stdb, tx, plan, system_logger, existing_tables),
         MigratePlan::Auto(plan) => auto_migrate_database(stdb, tx, auth_ctx, plan, system_logger, existing_tables),
     }
 }
 
-/// Manually migrate a database.
-fn manual_migrate_database(
-    _stdb: &RelationalDB,
-    _tx: &mut MutTxId,
-    _plan: ManualMigratePlan,
-    _system_logger: &SystemLogger,
-    _existing_tables: Vec<Arc<TableSchema>>,
-) -> anyhow::Result<()> {
-    unimplemented!("Manual database migrations are not yet implemented")
-}
-
 /// Automatically migrate a database.
 fn auto_migrate_database(
     stdb: &RelationalDB,

crates/core/src/host/host_controller.rs

@@ -426,7 +426,7 @@ impl HostController {
                 )
                 .await?;
             match update_result {
-                UpdateDatabaseResult::NoUpdateNeeded | UpdateDatabaseResult::UpdatePerformed => {
+                UpdateDatabaseResult::NoUpdateNeeded | UpdateDatabaseResult::UpdatePerformed(_) => {
                     *guard = Some(host);
                 }
                 UpdateDatabaseResult::AutoMigrateError(e) => {

crates/core/src/host/module_host.rs

@@ -448,7 +448,9 @@ pub struct WeakModuleHost {
 #[derive(Debug)]
 pub enum UpdateDatabaseResult {
     NoUpdateNeeded,
-    UpdatePerformed,
+    /// The string is a printable summary of the update that happened.
+    /// Contains ANSI escape sequences for color.
+    UpdatePerformed(String),
     AutoMigrateError(ErrorStream<AutoMigrateError>),
     ErrorExecutingMigration(anyhow::Error),
 }
@@ -457,7 +459,7 @@ impl UpdateDatabaseResult {
     pub fn was_successful(&self) -> bool {
         matches!(
             self,
-            UpdateDatabaseResult::UpdatePerformed | UpdateDatabaseResult::NoUpdateNeeded
+            UpdateDatabaseResult::UpdatePerformed(_) | UpdateDatabaseResult::NoUpdateNeeded
         )
     }
 }

crates/core/src/host/wasm_common/module_host_actor.rs

@@ -3,6 +3,7 @@ use bytes::Bytes;
 use spacetimedb_client_api_messages::timestamp::Timestamp;
 use spacetimedb_primitives::TableId;
 use spacetimedb_schema::auto_migrate::ponder_migrate;
+use spacetimedb_schema::auto_migrate::pretty_print::pretty_print;
 use spacetimedb_schema::def::ModuleDef;
 use spacetimedb_schema::schema::{Schema, TableSchema};
 use std::sync::Arc;
@@ -340,6 +341,10 @@ impl<T: WasmInstance> ModuleInstance for WasmModuleInstance<T> {
                 return Ok(UpdateDatabaseResult::AutoMigrateError(errs));
             }
         };
+        let summary = pretty_print(&plan).unwrap_or_else(|_| {
+            log::warn!("Failed to pretty-print migration plan: {plan:#?}");
+            "(plan not rendered, but succeeded)".to_string()
+        });
         let stdb = &*self.replica_context().relational_db;
 
         let program_hash = program.hash;
@@ -361,7 +366,7 @@ impl<T: WasmInstance> ModuleInstance for WasmModuleInstance<T> {
                 stdb.commit_tx(tx)?;
                 self.system_logger().info("Database updated");
                 log::info!("Database updated, {}", stdb.database_identity());
-                Ok(UpdateDatabaseResult::UpdatePerformed)
+                Ok(UpdateDatabaseResult::UpdatePerformed(summary))
             }
         }
     }

crates/schema/Cargo.toml

@@ -16,7 +16,9 @@ spacetimedb-sats.workspace = true
 spacetimedb-data-structures.workspace = true
 spacetimedb-sql-parser.workspace = true
 
+regex.workspace = true
 anyhow.workspace = true
+colored.workspace = true
 indexmap.workspace = true
 itertools.workspace = true
 lazy_static.workspace = true

crates/schema/src/auto_migrate.rs

@@ -6,41 +6,32 @@ use spacetimedb_data_structures::{
 use spacetimedb_lib::db::raw_def::v9::{RawRowLevelSecurityDefV9, TableType};
 use spacetimedb_sats::WithTypespace;
 
+pub mod pretty_print;
+
 pub type Result<T> = std::result::Result<T, ErrorStream<AutoMigrateError>>;
 
 /// A plan for a migration.
 #[derive(Debug)]
 pub enum MigratePlan<'def> {
-    Manual(ManualMigratePlan<'def>),
     Auto(AutoMigratePlan<'def>),
 }
 
 impl<'def> MigratePlan<'def> {
     /// Get the old `ModuleDef` for this migration plan.
     pub fn old_def(&self) -> &'def ModuleDef {
         match self {
-            MigratePlan::Manual(plan) => plan.old,
             MigratePlan::Auto(plan) => plan.old,
         }
     }
 
     /// Get the new `ModuleDef` for this migration plan.
     pub fn new_def(&self) -> &'def ModuleDef {
         match self {
-            MigratePlan::Manual(plan) => plan.new,
             MigratePlan::Auto(plan) => plan.new,
         }
     }
 }
 
-/// A plan for a manual migration.
-/// `new` must have a reducer marked with `Lifecycle::Update`.
-#[derive(Debug)]
-pub struct ManualMigratePlan<'def> {
-    pub old: &'def ModuleDef,
-    pub new: &'def ModuleDef,
-}
-
 /// A plan for an automatic migration.
 #[derive(Debug)]
 pub struct AutoMigratePlan<'def> {