Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions core/util/paths.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,18 +308,31 @@ export async function migrate(

const migrationsPath = getMigrationsFolderPath();
const migrationPath = path.join(migrationsPath, id);
let markerCreated = false;

if (!fs.existsSync(migrationPath)) {
try {
console.log(`Running migration: ${id}`);
try {
fs.writeFileSync(migrationPath, "", { flag: "wx" });
markerCreated = true;
console.log(`Running migration: ${id}`);

await Promise.resolve(callback());
} catch (e) {
if (!markerCreated && (e as NodeJS.ErrnoException).code === "EEXIST") {
onAlreadyComplete?.();
return;
}

fs.writeFileSync(migrationPath, "");
await Promise.resolve(callback());
} catch (e) {
console.warn(`Migration ${id} failed`, e);
if (markerCreated) {
try {
fs.rmSync(migrationPath, { force: true });
} catch (cleanupError) {
console.warn(
`Failed to remove migration marker after ${id} failed`,
cleanupError,
);
}
}
} else if (onAlreadyComplete) {
onAlreadyComplete();
console.warn(`Migration ${id} failed`, e);
}
}

Expand Down
88 changes: 88 additions & 0 deletions core/util/paths.vitest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import * as fs from "node:fs";
import * as os from "node:os";
import * as path from "node:path";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";

describe("migrate", () => {
let continueGlobalDir: string | undefined;

beforeEach(() => {
continueGlobalDir = fs.mkdtempSync(
path.join(os.tmpdir(), "continue-migration-test-"),
);
vi.stubEnv("CONTINUE_GLOBAL_DIR", continueGlobalDir);
vi.stubEnv("NODE_ENV", "development");
vi.spyOn(console, "warn").mockImplementation(() => {});
});

afterEach(() => {
vi.restoreAllMocks();
vi.unstubAllEnvs();
vi.resetModules();

if (continueGlobalDir) {
fs.rmSync(continueGlobalDir, { recursive: true, force: true });
continueGlobalDir = undefined;
}
});

it("retries a migration when its previous attempt failed", async () => {
const { migrate } = await import("./paths.js");
const migration = vi
.fn<() => Promise<void>>()
.mockRejectedValueOnce(new Error("temporary failure"))
.mockResolvedValueOnce(undefined);
const migrationPath = path.join(
continueGlobalDir!,
".migrations",
"retry-after-failure",
);

await migrate("retry-after-failure", migration);
expect(fs.existsSync(migrationPath)).toBe(false);

await migrate("retry-after-failure", migration);

expect(migration).toHaveBeenCalledTimes(2);
expect(fs.existsSync(migrationPath)).toBe(true);

const onAlreadyComplete = vi.fn();
await migrate("retry-after-failure", migration, onAlreadyComplete);
expect(migration).toHaveBeenCalledTimes(2);
expect(onAlreadyComplete).toHaveBeenCalledOnce();
});

it("does not run the same migration while it is already in progress", async () => {
const { migrate } = await import("./paths.js");
let resolveFirstMigration: (() => void) | undefined;
const firstMigration = vi.fn(
() =>
new Promise<void>((resolve) => {
resolveFirstMigration = resolve;
}),
);
const skippedMigration = vi.fn();
const onConcurrentMigration = vi.fn();

const firstRun = migrate("concurrent-migration", firstMigration);
await migrate(
"concurrent-migration",
skippedMigration,
onConcurrentMigration,
);

expect(skippedMigration).not.toHaveBeenCalled();
expect(onConcurrentMigration).toHaveBeenCalledOnce();

if (!resolveFirstMigration) {
throw new Error("The first migration did not start");
}
resolveFirstMigration();
await firstRun;
expect(
fs.existsSync(
path.join(continueGlobalDir!, ".migrations", "concurrent-migration"),
),
).toBe(true);
});
});
Loading