runToCompletion

Author: ianmacartney

README.md

@@ -445,22 +445,22 @@ await migrations.cancel(ctx, "myNewMutation");
 ## Running migrations synchronously
 
 If you want to run a migration synchronously from a test or action, you can use
-`runSynchronously`. Note that if the action crashes or is canceled, it will not
+`runToCompletion`. Note that if the action crashes or is canceled, it will not
 continue migrating in the background.
 
 From an action:
 
 ```ts
 import { components, internal } from "./_generated/api";
 import { internalAction } from "./_generated/server";
-import { runSynchronously } from "@convex-dev/migrations";
+import { runToCompletion } from "@convex-dev/migrations";
 
 export const myAction = internalAction({
   args: {},
   handler: async (ctx) => {
     //...
     const toRun = internal.example.setDefaultValue;
-    await runSynchronously(ctx, components.migrations, toRun);
+    await runToCompletion(ctx, components.migrations, toRun);
   },
 });
 ```
@@ -471,7 +471,7 @@ In a test:
 import { test } from "vitest";
 import { convexTest } from "convex-test";
 import component from "@convex-dev/migrations/test";
-import { runSynchronously } from "@convex-dev/migrations";
+import { runToCompletion } from "@convex-dev/migrations";
 import { components, internal } from "./_generated/api";
 import schema from "./schema";
 
@@ -486,7 +486,7 @@ test("test setDefaultValue migration", async () => {
 
     // Run the migration to completion
     const migrationToTest = internal.example.setDefaultValue;
-    await runSynchronously(ctx, components.migrations, migrationToTest);
+    await runToCompletion(ctx, components.migrations, migrationToTest);
 
     // Assert that the migration was successful by checking the data
     const docs = await ctx.db.query("myTable").collect();

example/convex/example.test.ts

@@ -1,7 +1,7 @@
 import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
 import { initConvexTest } from "./setup.test";
 import { components, internal } from "./_generated/api";
-import { runSynchronously } from "@convex-dev/migrations";
+import { runToCompletion } from "@convex-dev/migrations";
 
 describe("example", () => {
   beforeEach(async () => {
@@ -21,7 +21,7 @@ describe("example", () => {
       expect(docs.some((doc) => doc.optionalField === undefined)).toBe(true);
     });
     await t.run(async (ctx) => {
-      await runSynchronously(
+      await runToCompletion(
         ctx,
         components.migrations,
         internal.example.setDefaultValue,
@@ -40,7 +40,7 @@ describe("example", () => {
     await t.mutation(internal.example.seed, { count: 10 });
     await expect(
       t.run(async (ctx) => {
-        await runSynchronously(
+        await runToCompletion(
           ctx,
           components.migrations,
           internal.example.failingMigration,

src/client/index.ts

@@ -616,7 +616,7 @@ export type MigrationFunctionReference = FunctionReference<
  * ```ts
  * // In an action
  * const toRun = internal.migrations.myMigration;
- * await runSynchronously(ctx, components.migrations, toRun);
+ * await runToCompletion(ctx, components.migrations, toRun);
  * ```
  *
  * If it's already in progress, it will no-op.
@@ -634,7 +634,7 @@ export type MigrationFunctionReference = FunctionReference<
  * @param opts Options to start the migration.
  *   It's helpful to see what it would do without committing the transaction.
  */
-export async function runSynchronously(
+export async function runToCompletion(
   ctx: ActionCtx,
   component: ComponentApi,
   fnRef: MigrationFunctionReference,