refactor(setup): allow notes added into setup message (#793)

georgeh0 · web-flow · commit 7bc6a7062404 · 2025-07-23T10:36:38.000-07:00
diff --git a/src/execution/db_tracking_setup.rs b/src/execution/db_tracking_setup.rs
@@ -103,38 +103,43 @@ impl TrackingTableSetupStatus {
 }
 
 impl ResourceSetupStatus for TrackingTableSetupStatus {
-    fn describe_changes(&self) -> Vec<String> {
-        let mut changes: Vec<String> = vec![];
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
+        let mut changes: Vec<setup::ChangeDescription> = vec![];
         if self.desired_state.is_some() && !self.legacy_table_names.is_empty() {
-            changes.push(format!(
+            changes.push(setup::ChangeDescription::Action(format!(
                 "Rename legacy tracking tables: {}. ",
                 self.legacy_table_names.join(", ")
-            ));
+            )));
         }
         match (self.min_existing_version_id, &self.desired_state) {
             (None, Some(state)) => {
-                changes.push(format!("Create the tracking table: {}. ", state.table_name))
+                changes.push(setup::ChangeDescription::Action(format!(
+                    "Create the tracking table: {}. ",
+                    state.table_name
+                )));
             }
             (Some(min_version_id), Some(desired)) => {
                 if min_version_id < desired.version_id {
-                    changes.push("Update the tracking table. ".into());
+                    changes.push(setup::ChangeDescription::Action(
+                        "Update the tracking table. ".into(),
+                    ));
                 }
             }
-            (Some(_), None) => changes.push(format!(
+            (Some(_), None) => changes.push(setup::ChangeDescription::Action(format!(
                 "Drop existing tracking table: {}. ",
                 self.legacy_table_names.join(", ")
-            )),
+            ))),
             (None, None) => (),
         }
         if !self.source_ids_to_delete.is_empty() {
-            changes.push(format!(
+            changes.push(setup::ChangeDescription::Action(format!(
                 "Delete source IDs: {}. ",
                 self.source_ids_to_delete
                     .iter()
                     .map(|id| id.to_string())
                     .collect::<Vec<String>>()
                     .join(", ")
-            ));
+            )));
         }
         changes
     }
diff --git a/src/ops/targets/kuzu.rs b/src/ops/targets/kuzu.rs
@@ -187,7 +187,7 @@ struct GraphElementDataSetupStatus {
 }
 
 impl setup::ResourceSetupStatus for GraphElementDataSetupStatus {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         self.actions.describe_changes()
     }
 
diff --git a/src/ops/targets/neo4j.rs b/src/ops/targets/neo4j.rs
@@ -840,7 +840,7 @@ impl GraphElementDataSetupStatus {
 }
 
 impl ResourceSetupStatus for GraphElementDataSetupStatus {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         let mut result = vec![];
         if let Some(data_clear) = &self.data_clear {
             let mut desc = "Clear data".to_string();
@@ -856,7 +856,7 @@ impl ResourceSetupStatus for GraphElementDataSetupStatus {
                 )
                 .unwrap();
             }
-            result.push(desc);
+            result.push(setup::ChangeDescription::Action(desc));
         }
         result
     }
diff --git a/src/ops/targets/postgres.rs b/src/ops/targets/postgres.rs
@@ -504,26 +504,28 @@ fn describe_index_spec(index_name: &str, index_spec: &VectorIndexDef) -> String
 }
 
 impl setup::ResourceSetupStatus for SetupStatus {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         let mut descriptions = self.actions.table_action.describe_changes();
         if self.create_pgvector_extension {
-            descriptions.push("Create pg_vector extension (if not exists)".to_string());
+            descriptions.push(setup::ChangeDescription::Action(
+                "Create pg_vector extension (if not exists)".to_string(),
+            ));
         }
         if !self.actions.indexes_to_delete.is_empty() {
-            descriptions.push(format!(
+            descriptions.push(setup::ChangeDescription::Action(format!(
                 "Delete indexes from table: {}",
                 self.actions.indexes_to_delete.iter().join(",  "),
-            ));
+            )));
         }
         if !self.actions.indexes_to_create.is_empty() {
-            descriptions.push(format!(
+            descriptions.push(setup::ChangeDescription::Action(format!(
                 "Create indexes in table: {}",
                 self.actions
                     .indexes_to_create
                     .iter()
                     .map(|(index_name, index_spec)| describe_index_spec(index_name, index_spec))
                     .join(",  "),
-            ));
+            )));
         }
         descriptions
     }
diff --git a/src/ops/targets/qdrant.rs b/src/ops/targets/qdrant.rs
@@ -104,10 +104,12 @@ struct SetupStatus {
 }
 
 impl setup::ResourceSetupStatus for SetupStatus {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         let mut result = vec![];
         if self.delete_collection {
-            result.push("Delete collection".to_string());
+            result.push(setup::ChangeDescription::Action(
+                "Delete collection".to_string(),
+            ));
         }
         if let Some(add_collection) = &self.add_collection {
             let vector_descriptions = add_collection
@@ -121,14 +123,14 @@ impl setup::ResourceSetupStatus for SetupStatus {
                 })
                 .collect::<Vec<_>>()
                 .join("; ");
-            result.push(format!(
+            result.push(setup::ChangeDescription::Action(format!(
                 "Create collection{}",
                 if vector_descriptions.is_empty() {
                     "".to_string()
                 } else {
                     format!(" with vectors: {vector_descriptions}")
                 }
-            ));
+            )));
         }
         result
     }
diff --git a/src/ops/targets/shared/table_columns.rs b/src/ops/targets/shared/table_columns.rs
@@ -104,41 +104,41 @@ impl<T: Eq + Serialize + DeserializeOwned> TableMainSetupAction<T> {
         }
     }
 
-    pub fn describe_changes(&self) -> Vec<String>
+    pub fn describe_changes(&self) -> Vec<setup::ChangeDescription>
     where
         T: std::fmt::Display,
     {
         let mut descriptions = vec![];
         if self.drop_existing {
-            descriptions.push("Drop table".to_string());
+            descriptions.push(setup::ChangeDescription::Action("Drop table".to_string()));
         }
         if let Some(table_upsertion) = &self.table_upsertion {
             match table_upsertion {
                 TableUpsertionAction::Create { keys, values } => {
-                    descriptions.push(format!(
+                    descriptions.push(setup::ChangeDescription::Action(format!(
                         "Create table:\n  key columns: {}\n  value columns: {}\n",
                         keys.iter().map(|(k, v)| format!("{k} {v}")).join(",  "),
                         values.iter().map(|(k, v)| format!("{k} {v}")).join(",  "),
-                    ));
+                    )));
                 }
                 TableUpsertionAction::Update {
                     columns_to_delete,
                     columns_to_upsert,
                 } => {
                     if !columns_to_delete.is_empty() {
-                        descriptions.push(format!(
+                        descriptions.push(setup::ChangeDescription::Action(format!(
                             "Delete column from table: {}",
                             columns_to_delete.iter().join(",  "),
-                        ));
+                        )));
                     }
                     if !columns_to_upsert.is_empty() {
-                        descriptions.push(format!(
+                        descriptions.push(setup::ChangeDescription::Action(format!(
                             "Add / update columns in table: {}",
                             columns_to_upsert
                                 .iter()
                                 .map(|(k, v)| format!("{k} {v}"))
                                 .join(",  "),
-                        ));
+                        )));
                     }
                 }
             }
diff --git a/src/setup/components.rs b/src/setup/components.rs
@@ -110,23 +110,26 @@ impl<D: SetupOperator> SetupStatus<D> {
 }
 
 impl<D: SetupOperator + Send + Sync> ResourceSetupStatus for SetupStatus<D> {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         let mut result = vec![];
 
         for key in &self.keys_to_delete {
-            result.push(format!("Delete {}", self.desc.describe_key(key)));
+            result.push(setup::ChangeDescription::Action(format!(
+                "Delete {}",
+                self.desc.describe_key(key)
+            )));
         }
 
         for state in &self.states_to_upsert {
-            result.push(format!(
+            result.push(setup::ChangeDescription::Action(format!(
                 "{} {}",
                 if state.already_exists {
                     "Update"
                 } else {
                     "Create"
                 },
                 self.desc.describe_state(&state.state)
-            ));
+            )));
         }
 
         result
@@ -171,7 +174,7 @@ pub async fn apply_component_changes<D: SetupOperator>(
 }
 
 impl<A: ResourceSetupStatus, B: ResourceSetupStatus> ResourceSetupStatus for (A, B) {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         let mut result = vec![];
         result.extend(self.0.describe_changes());
         result.extend(self.1.describe_changes());
diff --git a/src/setup/db_metadata.rs b/src/setup/db_metadata.rs
@@ -331,11 +331,11 @@ impl MetadataTableSetup {
 }
 
 impl ResourceSetupStatus for MetadataTableSetup {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<setup::ChangeDescription> {
         if self.metadata_table_missing {
-            vec![format!(
+            vec![setup::ChangeDescription::Action(format!(
                 "Create the cocoindex metadata table {SETUP_METADATA_TABLE_NAME}"
-            )]
+            ))]
         } else {
             vec![]
         }
diff --git a/src/setup/driver.rs b/src/setup/driver.rs
@@ -387,7 +387,12 @@ async fn maybe_update_resource_setup<
                 });
                 writeln!(write, "{}:", resource.description)?;
                 for change in setup_status.describe_changes() {
-                    writeln!(write, "  - {change}")?;
+                    match change {
+                        setup::ChangeDescription::Action(action) => {
+                            writeln!(write, "  - {action}")?;
+                        }
+                        setup::ChangeDescription::Note(_) => {}
+                    }
                 }
             }
         }
diff --git a/src/setup/states.rs b/src/setup/states.rs
@@ -244,14 +244,19 @@ pub enum SetupChangeType {
     Invalid,
 }
 
+pub enum ChangeDescription {
+    Action(String),
+    Note(String),
+}
+
 pub trait ResourceSetupStatus: Send + Sync + Debug + Any + 'static {
-    fn describe_changes(&self) -> Vec<String>;
+    fn describe_changes(&self) -> Vec<ChangeDescription>;
 
     fn change_type(&self) -> SetupChangeType;
 }
 
 impl ResourceSetupStatus for Box<dyn ResourceSetupStatus> {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<ChangeDescription> {
         self.as_ref().describe_changes()
     }
 
@@ -261,7 +266,7 @@ impl ResourceSetupStatus for Box<dyn ResourceSetupStatus> {
 }
 
 impl ResourceSetupStatus for std::convert::Infallible {
-    fn describe_changes(&self) -> Vec<String> {
+    fn describe_changes(&self) -> Vec<ChangeDescription> {
         unreachable!()
     }
 
@@ -302,7 +307,19 @@ impl<K, S, C: ResourceSetupStatus> std::fmt::Display for ResourceSetupInfo<K, S,
                 let mut f = indented(f).with_str(INDENT);
                 writeln!(f, "{}", "TODO:".color(AnsiColors::BrightBlack))?;
                 for change in changes {
-                    writeln!(f, "  - {}", change.color(AnsiColors::BrightBlack))?;
+                    match change {
+                        ChangeDescription::Action(action) => {
+                            writeln!(f, "  - {}", action.color(AnsiColors::BrightBlack))?;
+                        }
+                        ChangeDescription::Note(note) => {
+                            writeln!(
+                                f,
+                                "  {} {}",
+                                "NOTE:".color(AnsiColors::Yellow).bold(),
+                                note.color(AnsiColors::Yellow)
+                            )?;
+                        }
+                    }
                 }
                 writeln!(f)?;
             }

Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,7 @@ struct GraphElementDataSetupStatus {`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`impl setup::ResourceSetupStatus for GraphElementDataSetupStatus {`
`190`		`- fn describe_changes(&self) -> Vec<String> {`
	`190`	`+ fn describe_changes(&self) -> Vec<setup::ChangeDescription> {`
`191`	`191`	`self.actions.describe_changes()`
`192`	`192`	`}`
`193`	`193`
Original file line number	Diff line number	Diff line change
`@@ -840,7 +840,7 @@ impl GraphElementDataSetupStatus {`
`840`	`840`	`}`
`841`	`841`
`842`	`842`	`impl ResourceSetupStatus for GraphElementDataSetupStatus {`
`843`		`- fn describe_changes(&self) -> Vec<String> {`
	`843`	`+ fn describe_changes(&self) -> Vec<setup::ChangeDescription> {`
`844`	`844`	`let mut result = vec![];`
`845`	`845`	`if let Some(data_clear) = &self.data_clear {`
`846`	`846`	`let mut desc = "Clear data".to_string();`
`@@ -856,7 +856,7 @@ impl ResourceSetupStatus for GraphElementDataSetupStatus {`
`856`	`856`	`)`
`857`	`857`	`.unwrap();`
`858`	`858`	`}`
`859`		`- result.push(desc);`
	`859`	`+ result.push(setup::ChangeDescription::Action(desc));`
`860`	`860`	`}`
`861`	`861`	`result`
`862`	`862`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,41 +104,41 @@ impl<T: Eq + Serialize + DeserializeOwned> TableMainSetupAction<T> {`
`104`	`104`	`}`
`105`	`105`	`}`
`106`	`106`
`107`		`- pub fn describe_changes(&self) -> Vec<String>`
	`107`	`+ pub fn describe_changes(&self) -> Vec<setup::ChangeDescription>`
`108`	`108`	`where`
`109`	`109`	`T: std::fmt::Display,`
`110`	`110`	`{`
`111`	`111`	`let mut descriptions = vec![];`
`112`	`112`	`if self.drop_existing {`
`113`		`- descriptions.push("Drop table".to_string());`
	`113`	`+ descriptions.push(setup::ChangeDescription::Action("Drop table".to_string()));`
`114`	`114`	`}`
`115`	`115`	`if let Some(table_upsertion) = &self.table_upsertion {`
`116`	`116`	`match table_upsertion {`
`117`	`117`	`TableUpsertionAction::Create { keys, values } => {`
`118`		`- descriptions.push(format!(`
	`118`	`+ descriptions.push(setup::ChangeDescription::Action(format!(`
`119`	`119`	`"Create table:\n key columns: {}\n value columns: {}\n",`
`120`	`120`	`keys.iter().map(\|(k, v)\| format!("{k} {v}")).join(", "),`
`121`	`121`	`values.iter().map(\|(k, v)\| format!("{k} {v}")).join(", "),`
`122`		`- ));`
	`122`	`+ )));`
`123`	`123`	`}`
`124`	`124`	`TableUpsertionAction::Update {`
`125`	`125`	`columns_to_delete,`
`126`	`126`	`columns_to_upsert,`
`127`	`127`	`} => {`
`128`	`128`	`if !columns_to_delete.is_empty() {`
`129`		`- descriptions.push(format!(`
	`129`	`+ descriptions.push(setup::ChangeDescription::Action(format!(`
`130`	`130`	`"Delete column from table: {}",`
`131`	`131`	`columns_to_delete.iter().join(", "),`
`132`		`- ));`
	`132`	`+ )));`
`133`	`133`	`}`
`134`	`134`	`if !columns_to_upsert.is_empty() {`
`135`		`- descriptions.push(format!(`
	`135`	`+ descriptions.push(setup::ChangeDescription::Action(format!(`
`136`	`136`	`"Add / update columns in table: {}",`
`137`	`137`	`columns_to_upsert`
`138`	`138`	`.iter()`
`139`	`139`	`.map(\|(k, v)\| format!("{k} {v}"))`
`140`	`140`	`.join(", "),`
`141`		`- ));`
	`141`	`+ )));`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`	`}`
Original file line number	Diff line number	Diff line change
`@@ -331,11 +331,11 @@ impl MetadataTableSetup {`
`331`	`331`	`}`
`332`	`332`
`333`	`333`	`impl ResourceSetupStatus for MetadataTableSetup {`
`334`		`- fn describe_changes(&self) -> Vec<String> {`
	`334`	`+ fn describe_changes(&self) -> Vec<setup::ChangeDescription> {`
`335`	`335`	`if self.metadata_table_missing {`
`336`		`- vec![format!(`
	`336`	`+ vec![setup::ChangeDescription::Action(format!(`
`337`	`337`	`"Create the cocoindex metadata table {SETUP_METADATA_TABLE_NAME}"`
`338`		`- )]`
	`338`	`+ ))]`
`339`	`339`	`} else {`
`340`	`340`	`vec![]`
`341`	`341`	`}`
Original file line number	Diff line number	Diff line change
`@@ -387,7 +387,12 @@ async fn maybe_update_resource_setup<`
`387`	`387`	`});`
`388`	`388`	`writeln!(write, "{}:", resource.description)?;`
`389`	`389`	`for change in setup_status.describe_changes() {`
`390`		`- writeln!(write, " - {change}")?;`
	`390`	`+ match change {`
	`391`	`+ setup::ChangeDescription::Action(action) => {`
	`392`	`+ writeln!(write, " - {action}")?;`
	`393`	`+ }`
	`394`	`+ setup::ChangeDescription::Note(_) => {}`
	`395`	`+ }`
`391`	`396`	`}`
`392`	`397`	`}`
`393`	`398`	`}`