Ian/reset

.github/workflows/node.js.yml

@@ -1,20 +1,38 @@
-name: Run tests
+name: Test and lint
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 on:
   push:
-    branches: ["main"]
+    branches: [main]
   pull_request:
-    branches: ["main"]
+    branches: ["**"]
+
 jobs:
-  build:
+  check:
+    name: Test and lint
     runs-on: ubuntu-latest
+    timeout-minutes: 30
+
     steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Node setup
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
         with:
-          node-version: "18.x"
+          cache-dependency-path: package.json
+          node-version: "20.x"
           cache: "npm"
-      - run: npm i
-      - run: npm ci
-      - run: cd example && npm i && cd ..
-      - run: npm test
+
+      - name: Install and build
+        run: |
+          npm i
+          npm run build
+      - name: Publish package for testing branch
+        run: npx pkg-pr-new publish
+      - name: Test
+        run: |
+          npm run test
+          npm run typecheck
+          npm run lint

.gitignore

@@ -14,3 +14,4 @@ node_modules
 frontend/package.json
 # npm pack output
 *.tgz
+*.tsbuildinfo

README.md

@@ -195,9 +195,11 @@ await migrations.runOne(ctx, internal.example.setDefaultValue);
 
 - If it is already running it will refuse to start another duplicate worker.
 - If it had previously failed on some batch, it will continue from that batch
-  unless you manually specify `cursor`.
+  unless you manually specify `cursor` or `reset`.
 - If you provide an explicit `cursor` (`null` means to start at the beginning),
   it will start from there.
+- If you pass `reset: true`, it will restart the migration from the beginning
+  for all migrations in the group (including any `next` migrations).
 - If you pass `true` for `dryRun` then it will run one batch and then throw,
   so no changes are committed, and you can see what it would have done.
   See [below](#test-a-migration-with-dryrun)
@@ -277,7 +279,15 @@ npx convex run migrations:runIt '{dryRun: true}'
 
 ### Restart a migration
 
-Pass `null` for the `cursor` to force a migration to start over.
+Pass `reset: true` to force a migration to start over from the beginning.
+This will reset the cursor for all migrations in the group.
+
+```sh
+npx convex run migrations:runIt '{reset: true}'
+```
+
+Alternatively, you can pass `null` for the `cursor` to restart just the
+current migration:
 
 ```sh
 npx convex run migrations:runIt '{cursor: null}'

convex.json

@@ -0,0 +1,3 @@
+{
+  "functions": "example/convex"
+}

eslint.config.js

@@ -8,6 +8,7 @@ export default [
     ignores: [
       "dist/**",
       "eslint.config.js",
+      "vitest.config.ts",
       "**/_generated/",
       "node10stubs.mjs",
     ],
@@ -19,7 +20,7 @@ export default [
 
       parserOptions: {
         project: true,
-        tsconfigRootDir: ".",
+        tsconfigRootDir: import.meta.dirname,
       },
     },
   },

example/convex/_generated/api.d.ts

@@ -107,6 +107,7 @@ export declare const components: {
           fnHandle: string;
           name: string;
           next?: Array<{ fnHandle: string; name: string }>;
+          reset?: boolean;
         },
         {
           batchSize?: number;

example/convex/example.ts

@@ -1,7 +1,7 @@
-import { Migrations, MigrationStatus } from "@convex-dev/migrations";
+import { Migrations, type MigrationStatus } from "@convex-dev/migrations";
 import { v } from "convex/values";
 import { components, internal } from "./_generated/api.js";
-import { DataModel } from "./_generated/dataModel.js";
+import type { DataModel } from "./_generated/dataModel.js";
 import { internalMutation, internalQuery } from "./_generated/server.js";
 
 export const migrations = new Migrations<DataModel>(components.migrations);