test calling with function handles

Author: ianmacartney

example/convex/example.test.ts

@@ -2,6 +2,7 @@ import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
 import { initConvexTest } from "./setup.test";
 import { components, internal } from "./_generated/api";
 import { runToCompletion } from "@convex-dev/migrations";
+import { createFunctionHandle, getFunctionName } from "convex/server";
 
 describe("example", () => {
   beforeEach(async () => {
@@ -48,4 +49,28 @@ describe("example", () => {
       }),
     ).rejects.toThrow("This migration fails after the first");
   });
+
+  test("test migrating with function handle", async () => {
+    const t = initConvexTest();
+    await t.mutation(internal.example.seed, { count: 10 });
+    await t.run(async (ctx) => {
+      const docs = await ctx.db.query("myTable").collect();
+      expect(docs).toHaveLength(10);
+      expect(docs.some((doc) => doc.optionalField === undefined)).toBe(true);
+    });
+    await t.run(async (ctx) => {
+      const fnHandle = await createFunctionHandle(
+        internal.example.setDefaultValue,
+      );
+      await runToCompletion(ctx, components.migrations, fnHandle, {
+        name: getFunctionName(internal.example.setDefaultValue),
+        batchSize: 2,
+      });
+    });
+    await t.run(async (ctx) => {
+      const after = await ctx.db.query("myTable").collect();
+      expect(after).toHaveLength(10);
+      expect(after.every((doc) => doc.optionalField !== undefined)).toBe(true);
+    });
+  });
 });