Print out enabled/disabled indexes on CLI of components push (#40165)

GitOrigin-RevId: eaa87bb3a7b55975ab807711deaf5d0764e07aac

Author: nipunn1313

crates/common/src/types/index.rs

@@ -27,7 +27,6 @@ use crate::{
     bootstrap_model::index::{
         index_validation_error,
         DeveloperIndexMetadata,
-        IndexMetadata,
     },
     document::ParsedDocument,
     index::IndexKey,
@@ -187,7 +186,7 @@ impl<T: IndexTableIdentifier + FromStr<Err = anyhow::Error>> FromStr for Generic
 pub struct IndexDiff {
     /// missing -> exists
     /// missing -> staged
-    pub added: Vec<IndexMetadata<TableName>>,
+    pub added: Vec<DeveloperIndexMetadata>,
     /// staged -> staged
     /// exist -> exist
     pub identical: Vec<ParsedDocument<DeveloperIndexMetadata>>,

crates/model/src/deployment_audit_log/types.rs

@@ -85,6 +85,20 @@ pub struct AuditLogIndexDiff {
         )
     )]
     pub removed_indexes: Vec<(IndexName, DeveloperIndexConfig)>,
+    #[cfg_attr(
+        any(test, feature = "testing"),
+        proptest(
+            strategy = "prop::collection::vec(any::<(IndexName, DeveloperIndexConfig)>(), 0..4)"
+        )
+    )]
+    pub enabled_indexes: Vec<(IndexName, DeveloperIndexConfig)>,
+    #[cfg_attr(
+        any(test, feature = "testing"),
+        proptest(
+            strategy = "prop::collection::vec(any::<(IndexName, DeveloperIndexConfig)>(), 0..4)"
+        )
+    )]
+    pub disabled_indexes: Vec<(IndexName, DeveloperIndexConfig)>,
 }
 
 impl From<IndexDiff> for AuditLogIndexDiff {
@@ -99,9 +113,21 @@ impl From<IndexDiff> for AuditLogIndexDiff {
             .into_iter()
             .map(|index| (index.name.clone(), index.into_value().config.into()))
             .collect();
+        let enabled_indexes = diff
+            .enabled
+            .into_iter()
+            .map(|index| (index.name.clone(), index.into_value().config.into()))
+            .collect();
+        let disabled_indexes = diff
+            .disabled
+            .into_iter()
+            .map(|index| (index.name.clone(), index.into_value().config.into()))
+            .collect();
         Self {
             added_indexes,
             removed_indexes,
+            enabled_indexes,
+            disabled_indexes,
         }
     }
 }
@@ -525,6 +551,20 @@ pub struct SerializedIndexDiff {
                              SerializedNamedDeveloperIndexConfig>(), 0..4)")
     )]
     pub removed_indexes: Vec<SerializedNamedDeveloperIndexConfig>,
+    #[cfg_attr(
+        any(test, feature = "testing"),
+        proptest(strategy = "prop::collection::vec(any::<
+                             SerializedNamedDeveloperIndexConfig>(), 0..4)")
+    )]
+    #[serde(default)]
+    pub disabled_indexes: Vec<SerializedNamedDeveloperIndexConfig>,
+    #[cfg_attr(
+        any(test, feature = "testing"),
+        proptest(strategy = "prop::collection::vec(any::<
+                             SerializedNamedDeveloperIndexConfig>(), 0..4)")
+    )]
+    #[serde(default)]
+    pub enabled_indexes: Vec<SerializedNamedDeveloperIndexConfig>,
 }
 
 impl From<AuditLogIndexDiff> for SerializedIndexDiff {
@@ -542,9 +582,13 @@ impl From<AuditLogIndexDiff> for SerializedIndexDiff {
             };
         let added_indexes = convert_to_serialized(diff.added_indexes);
         let removed_indexes = convert_to_serialized(diff.removed_indexes);
+        let disabled_indexes = convert_to_serialized(diff.disabled_indexes);
+        let enabled_indexes = convert_to_serialized(diff.enabled_indexes);
         Self {
             added_indexes,
             removed_indexes,
+            disabled_indexes,
+            enabled_indexes,
         }
     }
 }
@@ -565,9 +609,13 @@ impl TryFrom<SerializedIndexDiff> for AuditLogIndexDiff {
         };
         let added_indexes = convert_to_index_metadata(diff.added_indexes)?;
         let removed_indexes = convert_to_index_metadata(diff.removed_indexes)?;
+        let disabled_indexes = convert_to_index_metadata(diff.disabled_indexes)?;
+        let enabled_indexes = convert_to_index_metadata(diff.enabled_indexes)?;
         Ok(Self {
             added_indexes,
             removed_indexes,
+            disabled_indexes,
+            enabled_indexes,
         })
     }
 }

npm-packages/convex/src/cli/lib/components.ts

@@ -447,44 +447,53 @@ function printDiff(
   if (rootDiff) {
     if (rootDiff.removed_indexes.length > 0) {
       let msg = `${opts.dryRun ? "Would delete" : "Deleted"} table indexes:\n`;
-      for (let i = 0; i < rootDiff.removed_indexes.length; i++) {
-        const index = rootDiff.removed_indexes[i];
-        if (i > 0) {
-          msg += "\n";
-        }
-        msg += `  [-] ${formatIndex(index)}`;
+      for (const index of rootDiff.removed_indexes) {
+        msg += `  [-] ${formatIndex(index)}\n`;
       }
+      msg = msg.slice(0, -1); // strip last new line
       logFinishedStep(msg);
     }
-    const addedStaged = rootDiff.added_indexes.filter((index) => index.staged);
-    const addedEnabled = rootDiff.added_indexes.filter(
-      (index) => !index.staged,
-    );
+    const addedStaged = rootDiff.added_indexes.filter((i) => i.staged);
+    const addedEnabled = rootDiff.added_indexes.filter((i) => !i.staged);
     if (addedEnabled.length > 0) {
       let msg = `${opts.dryRun ? "Would add" : "Added"} table indexes:\n`;
-      for (let i = 0; i < addedEnabled.length; i++) {
-        const index = addedEnabled[i];
-        if (i > 0) {
-          msg += "\n";
-        }
-        msg += `  [+] ${formatIndex(index)}`;
+      for (const index of addedEnabled) {
+        msg += `  [+] ${formatIndex(index)}\n`;
       }
+      msg = msg.slice(0, -1); // strip last new line
       logFinishedStep(msg);
     }
     if (addedStaged.length > 0) {
       let msg = `${opts.dryRun ? "Would add" : "Added"} staged table indexes:\n`;
-      for (let i = 0; i < addedStaged.length; i++) {
-        const index = addedStaged[i];
-        if (i > 0) {
-          msg += "\n";
-        }
+      for (const index of addedStaged) {
         const table = index.name.split(".")[0];
         const progressLink = deploymentDashboardUrlPage(
           opts.deploymentName,
           `/data?table=${table}&showIndexes=true`,
         );
-        msg += `  [+] ${formatIndex(index)}, see progress: ${progressLink}`;
+        msg += `  [+] ${formatIndex(index)}, see progress: ${progressLink}\n`;
+      }
+      msg = msg.slice(0, -1); // strip last new line
+      logFinishedStep(msg);
+    }
+    if (rootDiff.enabled_indexes?.length > 0) {
+      let msg = opts.dryRun
+        ? `These indexes would be enabled:\n`
+        : `These indexes are now enabled:\n`;
+      for (const index of rootDiff.enabled_indexes) {
+        msg += `  [*] ${formatIndex(index)}\n`;
+      }
+      msg = msg.slice(0, -1); // strip last new line
+      logFinishedStep(msg);
+    }
+    if (rootDiff.disabled_indexes?.length > 0) {
+      let msg = opts.dryRun
+        ? `These indexes would be staged:\n`
+        : `These indexes are now staged:\n`;
+      for (const index of rootDiff.disabled_indexes) {
+        msg += `  [*] ${formatIndex(index)}\n`;
       }
+      msg = msg.slice(0, -1); // strip last new line
       logFinishedStep(msg);
     }
   }

npm-packages/convex/src/cli/lib/deployApi/finishPush.ts

@@ -73,6 +73,8 @@ export type DeveloperIndexConfig = z.infer<typeof developerIndexConfig>;
 export const indexDiff = looseObject({
   added_indexes: z.array(developerIndexConfig),
   removed_indexes: z.array(developerIndexConfig),
+  enabled_indexes: z.array(developerIndexConfig),
+  disabled_indexes: z.array(developerIndexConfig),
 });
 export type IndexDiff = z.infer<typeof indexDiff>;