| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253 |
- /* oxlint-disable */
- import type { TablesRelationalConfig } from "drizzle-orm/_relations"
- import type { MigrationMeta } from "drizzle-orm/migrator"
- import type { AnyRelations } from "drizzle-orm/relations"
- import { type SQL, sql } from "drizzle-orm/sql/sql"
- import type { BaseSQLiteDatabase } from "drizzle-orm/sqlite-core"
- import type { SQLiteSession } from "drizzle-orm/sqlite-core/session"
- import { GET_VERSION_FOR, MIGRATIONS_TABLE_VERSIONS, type UpgradeResult } from "./utils"
- /** @internal */
- export type SQLiteMigrationTableRow = { id: number | null; hash: string; created_at: number }
- type AsyncSQLiteDatabaseWithSession = BaseSQLiteDatabase<"async", unknown, Record<string, unknown>> & {
- session: {
- all<T>(query: SQL): Promise<T[]>
- }
- transaction<T>(transaction: (tx: { run(query: SQL): Promise<unknown> }) => Promise<T>): Promise<T>
- }
- type SQLiteMigrationBackfillEntry = {
- name: string
- selector:
- | { column: "id"; value: number }
- | { column: "created_at"; value: number }
- | { column: "hash"; value: string }
- }
- function unmatchedMigrationError(unmatched: SQLiteMigrationTableRow[]) {
- return new Error(
- `While upgrading your database migrations table we found ${unmatched.length} (${unmatched
- .map((it) => `[id: ${it.id}, created_at: ${it.created_at}]`)
- .join(
- ", ",
- )}) migrations in the database that do not match any local migration. This means that some migrations were applied to the database but are missing from the local environment`,
- )
- }
- /** @internal */
- export function prepareSQLiteMigrationBackfill(
- dbRows: SQLiteMigrationTableRow[],
- localMigrations: MigrationMeta[],
- ): SQLiteMigrationBackfillEntry[] {
- const sortedLocalMigrations = [...localMigrations].sort((a, b) =>
- a.folderMillis !== b.folderMillis ? a.folderMillis - b.folderMillis : (a.name ?? "").localeCompare(b.name ?? ""),
- )
- const byMillis = new Map<number, MigrationMeta[]>()
- const byHash = new Map<string, MigrationMeta>()
- for (const migration of sortedLocalMigrations) {
- if (!byMillis.has(migration.folderMillis)) {
- byMillis.set(migration.folderMillis, [])
- }
- byMillis.get(migration.folderMillis)!.push(migration)
- byHash.set(migration.hash, migration)
- }
- const toApply: SQLiteMigrationBackfillEntry[] = []
- const unmatched: SQLiteMigrationTableRow[] = []
- for (const dbRow of dbRows) {
- const stringified = String(dbRow.created_at)
- const millis = Number(stringified.substring(0, stringified.length - 3) + "000")
- const candidates = byMillis.get(millis)
- const matchedByMillis = candidates?.length === 1 ? candidates[0] : undefined
- const matchedByCandidateHash =
- candidates && candidates.length > 1
- ? candidates.find((candidate) => candidate.hash && dbRow.hash && candidate.hash === dbRow.hash)
- : undefined
- const matchedByHash = matchedByMillis || matchedByCandidateHash ? undefined : byHash.get(dbRow.hash)
- const matched = matchedByMillis ?? matchedByCandidateHash ?? matchedByHash
- if (matched) {
- toApply.push({
- name: matched.name,
- selector:
- dbRow.id !== null
- ? { column: "id", value: dbRow.id }
- : matchedByMillis
- ? { column: "created_at", value: dbRow.created_at }
- : { column: "hash", value: dbRow.hash },
- })
- continue
- }
- unmatched.push(dbRow)
- }
- if (unmatched.length > 0) {
- throw unmatchedMigrationError(unmatched)
- }
- return toApply
- }
- /** @internal */
- export function buildSQLiteMigrationBackfillStatements(
- migrationsTable: string,
- backfillEntries: SQLiteMigrationBackfillEntry[],
- ) {
- const table = sql`${sql.identifier(migrationsTable)}`
- const statements: SQL[] = [
- sql`ALTER TABLE ${table} ADD COLUMN ${sql.identifier("name")} text`,
- sql`ALTER TABLE ${table} ADD COLUMN ${sql.identifier("applied_at")} TEXT`,
- ]
- for (const backfillEntry of backfillEntries) {
- const updateQuery = sql`UPDATE ${table} SET ${sql.identifier("name")} = ${backfillEntry.name}, ${sql.identifier(
- "applied_at",
- )} = NULL WHERE`
- updateQuery.append(sql` ${sql.identifier(backfillEntry.selector.column)} = ${backfillEntry.selector.value}`)
- statements.push(updateQuery)
- }
- return statements
- }
- /**
- * Detects the current version of the migrations table schema and upgrades it if needed.
- *
- * Version 0: Original schema (id, hash, created_at)
- * Version 1: Extended schema (id, hash, created_at, name, applied_at)
- */
- export function upgradeSyncIfNeeded(
- migrationsTable: string,
- session: SQLiteSession<"sync", unknown, Record<string, unknown>, AnyRelations, TablesRelationalConfig>,
- localMigrations: MigrationMeta[],
- ): UpgradeResult {
- const tableExists = session.all(sql`SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ${migrationsTable}`)
- if (tableExists.length === 0) {
- return { newDb: true }
- }
- // Table exists, check table shape
- const rows = session.all<{ column_name: string }>(
- sql`SELECT name as column_name FROM pragma_table_info(${migrationsTable})`,
- )
- const version = GET_VERSION_FOR.sqlite(rows.map((r) => r.column_name))
- for (let v = version; v < MIGRATIONS_TABLE_VERSIONS.sqlite; v++) {
- const upgradeFn = upgradeSyncFunctions[v]
- if (!upgradeFn) {
- throw new Error(`No upgrade path from migration table version ${v} to ${v + 1}`)
- }
- upgradeFn(migrationsTable, session, localMigrations)
- }
- return { newDb: false }
- }
- const upgradeSyncFunctions: Record<
- number,
- (
- migrationsTable: string,
- session: SQLiteSession<"sync", unknown, Record<string, unknown>, AnyRelations, TablesRelationalConfig>,
- localMigrations: MigrationMeta[],
- ) => void
- > = {
- /**
- * Upgrade from version 0 to version 1:
- * 1. Read all existing DB migrations
- * 2. Sort localMigrations ASC by millis and if the same - sort by name
- * 3. Match each DB row to a local migration
- * If multiple migrations share the same second, use hash matching as a tiebreaker
- * Not implemented for now -> If hash matching fails, fall back to serial id ordering
- * 5. Create extra column and backfill names for matched migrations
- */
- 0: (migrationsTable, session, localMigrations) => {
- const table = sql`${sql.identifier(migrationsTable)}`
- const dbRows = session.all<SQLiteMigrationTableRow>(sql`SELECT id, hash, created_at FROM ${table} ORDER BY id ASC`)
- const statements = buildSQLiteMigrationBackfillStatements(
- migrationsTable,
- prepareSQLiteMigrationBackfill(dbRows, localMigrations),
- )
- session.transaction((tx) => {
- for (const statement of statements) {
- tx.run(statement)
- }
- })
- },
- }
- /**
- * Detects the current version of the migrations table schema and upgrades it if needed.
- *
- * Version 0: Original schema (id, hash, created_at)
- * Version 1: Extended schema (id, hash, created_at, name, applied_at)
- */
- export async function upgradeAsyncIfNeeded(
- migrationsTable: string,
- db: AsyncSQLiteDatabaseWithSession,
- localMigrations: MigrationMeta[],
- ): Promise<UpgradeResult> {
- // Check if the table exists at all
- const tableExists = await db.session.all(
- sql`SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ${migrationsTable}`,
- )
- if (tableExists.length === 0) {
- return { newDb: true }
- }
- const rows = await db.session.all<{ column_name: string }>(
- sql`SELECT name as column_name FROM pragma_table_info(${migrationsTable})`,
- )
- const version = GET_VERSION_FOR.sqlite(rows.map((r) => r.column_name))
- for (let v = version; v < MIGRATIONS_TABLE_VERSIONS.sqlite; v++) {
- const upgradeFn = upgradeAsyncFunctions[v]
- if (!upgradeFn) {
- throw new Error(`No upgrade path from migration table version ${v} to ${v + 1}`)
- }
- await upgradeFn(migrationsTable, db, localMigrations)
- }
- return { newDb: false }
- }
- const upgradeAsyncFunctions: Record<
- number,
- (migrationsTable: string, db: AsyncSQLiteDatabaseWithSession, localMigrations: MigrationMeta[]) => Promise<void>
- > = {
- /**
- * Upgrade from version 0 to version 1:
- * 1. Read all existing DB migrations
- * 2. Sort localMigrations ASC by millis and if the same - sort by name
- * 3. Match each DB row to a local migration
- * If multiple migrations share the same second, use hash matching as a tiebreaker
- * Not implemented for now -> If hash matching fails, fall back to serial id ordering
- * 5. Create extra column and backfill names for matched migrations
- */
- 0: async (migrationsTable, db, localMigrations) => {
- const table = sql`${sql.identifier(migrationsTable)}`
- const dbRows = await db.session.all<SQLiteMigrationTableRow>(
- sql`SELECT id, hash, created_at FROM ${table} ORDER BY id ASC`,
- )
- const statements = buildSQLiteMigrationBackfillStatements(
- migrationsTable,
- prepareSQLiteMigrationBackfill(dbRows, localMigrations),
- )
- await db.transaction(async (tx) => {
- for (const statement of statements) {
- await tx.run(statement)
- }
- })
- },
- }
|