Add index_diff to start push response (#40159)

Add index_diff to start push response

Allows us to print progress + understand the staged state whether
new vs preexisting. At finish_push time, we don't have enough information to know if a staged index is new vs preexisting. At start_push time we do.

Add to CLI too

GitOrigin-RevId: 7efaaedb40ebbf9cd99a44683ac4e157d8b0d97e

Author: nipunn1313

crates/model/src/components/config.rs

@@ -272,6 +272,7 @@ impl<'a, RT: Runtime> ComponentConfigModel<'a, RT> {
 
         let mut allocated_component_ids = BTreeMap::new();
         let mut schema_ids = BTreeMap::new();
+        let mut index_diffs = BTreeMap::new();
 
         let existing_root = existing_components_by_parent.get(&None);
         let mut stack = vec![(ComponentPath::root(), existing_root, Some(app))];
@@ -304,7 +305,7 @@ impl<'a, RT: Runtime> ComponentConfigModel<'a, RT> {
                     .get(&new_node.definition_path)
                     .context("Missing definition for component")?;
                 let schema_id = if let Some(ref schema) = definition.schema {
-                    IndexModel::new(self.tx)
+                    let index_diff = IndexModel::new(self.tx)
                         .prepare_new_and_mutated_indexes(namespace, schema)
                         .await?;
 
@@ -319,6 +320,7 @@ impl<'a, RT: Runtime> ComponentConfigModel<'a, RT> {
                             );
                         },
                     };
+                    index_diffs.insert(path.clone(), index_diff.into());
                     Some(schema_id.into())
                 } else {
                     None
@@ -338,6 +340,7 @@ impl<'a, RT: Runtime> ComponentConfigModel<'a, RT> {
         Ok(SchemaChange {
             allocated_component_ids,
             schema_ids,
+            index_diffs,
         })
     }
 
@@ -913,7 +916,7 @@ impl TryFrom<ComponentDiff> for SerializedComponentDiff {
             module_diff: value.module_diff,
             udf_config_diff: value.udf_config_diff,
             cron_diff: value.cron_diff,
-            index_diff: Some(value.index_diff.try_into()?),
+            index_diff: Some(value.index_diff.into()),
             schema_diff: value.schema_diff.map(|diff| diff.try_into()).transpose()?,
         })
     }
@@ -941,13 +944,16 @@ impl TryFrom<SerializedComponentDiff> for ComponentDiff {
 pub struct SchemaChange {
     pub allocated_component_ids: BTreeMap<ComponentPath, DeveloperDocumentId>,
     pub schema_ids: BTreeMap<ComponentPath, Option<InternalDocumentId>>,
+    pub index_diffs: BTreeMap<ComponentPath, AuditLogIndexDiff>,
 }
 
 #[derive(Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct SerializedSchemaChange {
     allocated_component_ids: BTreeMap<String, String>,
     schema_ids: BTreeMap<String, Option<String>>,
+    #[serde(default)]
+    index_diffs: BTreeMap<String, SerializedIndexDiff>,
 }
 
 impl TryFrom<SchemaChange> for SerializedSchemaChange {
@@ -965,6 +971,11 @@ impl TryFrom<SchemaChange> for SerializedSchemaChange {
                 .into_iter()
                 .map(|(k, v)| (String::from(k), v.map(String::from)))
                 .collect(),
+            index_diffs: value
+                .index_diffs
+                .into_iter()
+                .map(|(k, v)| (String::from(k), v.into()))
+                .collect(),
         })
     }
 }
@@ -984,6 +995,11 @@ impl TryFrom<SerializedSchemaChange> for SchemaChange {
                 .into_iter()
                 .map(|(k, v)| Ok((k.parse()?, v.map(|v| v.parse()).transpose()?)))
                 .collect::<anyhow::Result<_>>()?,
+            index_diffs: value
+                .index_diffs
+                .into_iter()
+                .map(|(k, v)| Ok((k.parse()?, v.try_into()?)))
+                .collect::<anyhow::Result<_>>()?,
         })
     }
 }

crates/model/src/deployment_audit_log/types.rs

@@ -527,27 +527,25 @@ pub struct SerializedIndexDiff {
     pub removed_indexes: Vec<SerializedNamedDeveloperIndexConfig>,
 }
 
-impl TryFrom<AuditLogIndexDiff> for SerializedIndexDiff {
-    type Error = anyhow::Error;
-
-    fn try_from(diff: AuditLogIndexDiff) -> anyhow::Result<Self> {
+impl From<AuditLogIndexDiff> for SerializedIndexDiff {
+    fn from(diff: AuditLogIndexDiff) -> Self {
         let convert_to_serialized =
             |indexes: Vec<(GenericIndexName<TableName>, DeveloperIndexConfig)>| {
                 indexes
                     .into_iter()
                     .map(|(name, config)| {
                         let name = name.to_string();
                         let index_config = SerializedDeveloperIndexConfig::from(config);
-                        anyhow::Ok(SerializedNamedDeveloperIndexConfig { name, index_config })
+                        SerializedNamedDeveloperIndexConfig { name, index_config }
                     })
-                    .try_collect()
+                    .collect()
             };
-        let added_indexes = convert_to_serialized(diff.added_indexes)?;
-        let removed_indexes = convert_to_serialized(diff.removed_indexes)?;
-        Ok(Self {
+        let added_indexes = convert_to_serialized(diff.added_indexes);
+        let removed_indexes = convert_to_serialized(diff.removed_indexes);
+        Self {
             added_indexes,
             removed_indexes,
-        })
+        }
     }
 }
 

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

@@ -420,7 +420,7 @@ export async function runComponentsPush(
   const finishPushResponse = await pushSpan.enterAsync("finishPush", (span) =>
     finishPush(ctx, span, startPushResponse, options),
   );
-  printDiff(finishPushResponse, options);
+  printDiff(startPushResponse, finishPushResponse, options);
   pushSpan.end();
 
   // Asynchronously report that the push completed.
@@ -430,6 +430,7 @@ export async function runComponentsPush(
 }
 
 function printDiff(
+  startPushResponse: StartPushResponse,
   finishPushResponse: FinishPushDiff,
   opts: { verbose: boolean; dryRun: boolean; deploymentName: string | null },
 ) {
@@ -438,26 +439,25 @@ function printDiff(
     logMessage(diffString);
     return;
   }
+  const indexDiffs = startPushResponse.schemaChange.indexDiffs;
   const { componentDiffs } = finishPushResponse;
 
   // Print out index diffs for the root component.
-  let rootDiff = componentDiffs[""];
-  if (rootDiff && rootDiff.indexDiff) {
-    if (rootDiff.indexDiff.removed_indexes.length > 0) {
+  let rootDiff = indexDiffs[""] || componentDiffs[""]?.indexDiff;
+  if (rootDiff) {
+    if (rootDiff.removed_indexes.length > 0) {
       let msg = `${opts.dryRun ? "Would delete" : "Deleted"} table indexes:\n`;
-      for (let i = 0; i < rootDiff.indexDiff.removed_indexes.length; i++) {
-        const index = rootDiff.indexDiff.removed_indexes[i];
+      for (let i = 0; i < rootDiff.removed_indexes.length; i++) {
+        const index = rootDiff.removed_indexes[i];
         if (i > 0) {
           msg += "\n";
         }
         msg += `  [-] ${formatIndex(index)}`;
       }
       logFinishedStep(msg);
     }
-    const addedStaged = rootDiff.indexDiff.added_indexes.filter(
-      (index) => index.staged,
-    );
-    const addedEnabled = rootDiff.indexDiff.added_indexes.filter(
+    const addedStaged = rootDiff.added_indexes.filter((index) => index.staged);
+    const addedEnabled = rootDiff.added_indexes.filter(
       (index) => !index.staged,
     );
     if (addedEnabled.length > 0) {

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

@@ -9,6 +9,7 @@ import {
 } from "./definitionConfig.js";
 import { authInfo } from "./types.js";
 import { looseObject } from "./utils.js";
+import { indexDiff } from "./finishPush.js";
 
 export const startPushRequest = looseObject({
   adminKey: z.string(),
@@ -26,6 +27,7 @@ export type StartPushRequest = z.infer<typeof startPushRequest>;
 export const schemaChange = looseObject({
   allocatedComponentIds: z.any(),
   schemaIds: z.any(),
+  indexDiffs: z.record(componentDefinitionPath, indexDiff),
 });
 export type SchemaChange = z.infer<typeof schemaChange>;