Add basic UI for snapshot import progress to the dashboard (#27272)

We currently show progress messages in the CLI, but if you disconnect or kill the CLI command you can no longer see the status of your import.

This is a minimal UI in the dashboard and put behind a flag. We probably want to slightly change the backend to make this sort of UI easier to build (e.g. split out the import summary from the confirmation message, potentially back this with a deployment audit log so we can know who performed it, potentially save the file name), but that's a more involved change.

We can also change the CLI to list the ongoing imports before starting a new one to prevent developers from inadvertently starting two overlapping imports as a separate change.

GitOrigin-RevId: 64106f597705b0fba1c4f226e62f850f87c560d2

Author: sshader

npm-packages/system-udfs/convex/_generated/api.d.ts

@@ -48,6 +48,7 @@ import type * as _system_frontend_paginatedScheduledJobs from "../_system/fronte
 import type * as _system_frontend_paginatedTableDocuments from "../_system/frontend/paginatedTableDocuments.js";
 import type * as _system_frontend_patchDocumentsFields from "../_system/frontend/patchDocumentsFields.js";
 import type * as _system_frontend_replaceDocument from "../_system/frontend/replaceDocument.js";
+import type * as _system_frontend_snapshotImport from "../_system/frontend/snapshotImport.js";
 import type * as _system_frontend_tableSize from "../_system/frontend/tableSize.js";
 import type * as _system_paginationLimits from "../_system/paginationLimits.js";
 import type * as _system_repl_wrappers from "../_system/repl/wrappers.js";
@@ -99,6 +100,7 @@ declare const fullApi: ApiFromModules<{
   "_system/frontend/paginatedTableDocuments": typeof _system_frontend_paginatedTableDocuments;
   "_system/frontend/patchDocumentsFields": typeof _system_frontend_patchDocumentsFields;
   "_system/frontend/replaceDocument": typeof _system_frontend_replaceDocument;
+  "_system/frontend/snapshotImport": typeof _system_frontend_snapshotImport;
   "_system/frontend/tableSize": typeof _system_frontend_tableSize;
   "_system/paginationLimits": typeof _system_paginationLimits;
   "_system/repl/wrappers": typeof _system_repl_wrappers;

npm-packages/system-udfs/convex/_system/cli/queryImport.ts

@@ -1,9 +1,17 @@
 import { v } from "convex/values";
 import { queryPrivateSystem } from "../secretSystemTables";
+import { Doc } from "../../_generated/dataModel";
 
 export default queryPrivateSystem({
   args: { importId: v.id("_snapshot_imports") },
   handler: async ({ db }, args) => {
     return await db.get(args.importId);
   },
 });
+
+export const list = queryPrivateSystem({
+  args: {},
+  handler: async function ({ db }): Promise<Doc<"_snapshot_imports">[]> {
+    return await db.query("_snapshot_imports").order("desc").take(20);
+  },
+});

npm-packages/system-udfs/convex/_system/frontend/snapshotImport.ts

@@ -0,0 +1,9 @@
+import { queryPrivateSystem } from "../secretSystemTables";
+import { Doc } from "../../_generated/dataModel";
+
+export const list = queryPrivateSystem({
+  args: {},
+  handler: async function ({ db }): Promise<Doc<"_snapshot_imports">[]> {
+    return await db.query("_snapshot_imports").order("desc").take(20);
+  },
+});

npm-packages/system-udfs/convex/schema.ts

@@ -244,9 +244,13 @@ const snapshotImportsTable = defineTable({
     }),
     v.object({
       state: v.literal("waiting_for_confirmation"),
+      message_to_confirm: v.string(),
+      require_manual_confirmation: v.boolean(),
     }),
     v.object({
       state: v.literal("in_progress"),
+      progress_message: v.string(),
+      checkpoint_messages: v.array(v.string()),
     }),
     v.object({
       state: v.literal("completed"),