System UDF for reading schema validation progress (#40551)

Adds system table `_schema_validation_progress` and a system UDF for reading progress of pending schemas getting validated.

GitOrigin-RevId: 23a6d7201590438f54742c67d350cc90877efae3

Author: emmaling27

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

@@ -34,3 +34,28 @@ export default queryPrivateSystem({
     };
   },
 });
+
+export const schemaValidationProgress = queryPrivateSystem({
+  args: { componentId: v.optional(v.union(v.string(), v.null())) },
+  handler: async function ({
+    db,
+  }): Promise<{ numDocsValidated: number; totalDocs: number | null } | null> {
+    const pending = await getSchemaByState(db, "pending");
+    if (!pending) {
+      return null;
+    }
+    const schemaValidationProgressDoc = await db
+      .query("_schema_validation_progress")
+      .withIndex("by_schema_id", (q) => q.eq("schemaId", pending._id))
+      .unique();
+    if (!schemaValidationProgressDoc) {
+      return null;
+    }
+    return {
+      numDocsValidated: Number(schemaValidationProgressDoc.numDocsValidated),
+      totalDocs: schemaValidationProgressDoc.totalDocs
+        ? Number(schemaValidationProgressDoc.totalDocs)
+        : null,
+    };
+  },
+});

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

@@ -430,6 +430,11 @@ export default defineSchema({
   }).index("by_name_and_ts", ["name", "ts"]),
   _udf_config: defineTable({ serverVersion: v.string() }),
   _schemas: defineTable(schemaMetadata).index("by_state", ["state"]),
+  _schema_validation_progress: defineTable({
+    schemaId: v.id("_schemas"),
+    numDocsValidated: v.int64(),
+    totalDocs: v.union(v.int64(), v.null()),
+  }).index("by_schema_id", ["schemaId"]),
   _log_sinks: logSinksTable,
   _backend_state: backendStateTable,
   _snapshot_imports: snapshotImportsTable,