/** * PGMOVENUL-001..005: the move into Postgres (`src/db/engine/postgres/sqlite-move/`) * changes nothing silently, on the lane's server. A plugin value holding a NUL * or bytes that are not UTF-8 refuses the move before anything is written; a * NUL in TREK's own text refuses it unless `dropNul` (`--drop-nul`) is given; * a unique key that dropping a NUL breaks is named as that, with the * constraint Postgres reports; a move with `dropNul` lists every value it * changed and stores the value TREK would have written, JSON with nothing * else changed; and TREK's own text that is not UTF-8 is refused either way. */ import { buildOrmConfig, resolveEngine } from '../../src/db/engine'; import { readPostgresBaseline } from '../../src/db/engine/postgres/baseline'; import { MoveRefusal, moveSqliteToPostgres, type MoveSummary } from '../../src/db/engine/postgres/sqlite-move/move'; import { SqliteEngine } from '../../src/db/engine/sqlite/sqlite-engine'; import { knownMigrationNames } from '../../src/db/known-migrations'; import { runSchemaBootstrap, type AnyOrm } from '../../src/db/orm'; import { createBoundSqliteDriver } from '../../src/db/orm-driver'; import { makeUser } from '../helpers/factories/users'; import { withAdmin } from './databases'; import { MikroORM, type Options } from '@mikro-orm/core'; import Database from 'better-sqlite3'; import fs from 'node:fs'; import os from 'node:os'; import path from 'node:path'; import { afterAll, beforeAll, describe, expect, it } from 'vitest'; let dir: string; let handle: Database.Database; let sqliteOrm: AnyOrm; let movedId: number; /** An ORM on its own SQLite file, migrated the way the SQLite engine brings a file to head. */ async function migratedSqlite(file: string): Promise { handle = new Database(file); handle.pragma('foreign_keys = ON'); const config = buildOrmConfig(new SqliteEngine()); const options: Options = { ...config, driver: createBoundSqliteDriver(() => handle), dbName: file, migrations: { ...config.migrations, silent: true }, }; const orm = await MikroORM.init(options); await runSchemaBootstrap(orm, { snapshot: false }); return orm; } /** Runs the move into the worker's database, which the lane hands over empty of tables until a move commits. */ async function move(dropNul = false): Promise { const config = buildOrmConfig(resolveEngine()); const orm = await MikroORM.init({ ...config, entities: [], entitiesTs: [], discovery: { warnWhenNoEntities: false }, migrations: { ...config.migrations, silent: true }, }); try { return await moveSqliteToPostgres({ sqliteFile: path.join(dir, 'travel.db'), pluginsDataDir: path.join(dir, 'plugins-data'), orm, known: knownMigrationNames(), baseline: readPostgresBaseline, log: () => undefined, dropNul, }); } finally { await orm.close(true); } } /** The tables of the worker database's current schema. */ async function tablesInTarget(): Promise { return withAdmin(process.env.TREK_DB_URL as string, async (run) => { const [row] = await run<{ count: string | number }>( 'select count(*) as count from information_schema.tables where table_schema = current_schema()', ); return Number(row.count); }); } /** The worker's database, emptied: the lane hands each file a migrated copy, and the move fills an empty one only. */ async function emptyTarget(): Promise { const name = new URL(process.env.TREK_DB_URL as string).pathname.slice(1); await withAdmin(process.env.TREK_TEST_DB_URL as string, async (run) => { await run(`DROP DATABASE IF EXISTS "${name}" WITH (FORCE)`); await run(`CREATE DATABASE "${name}"`); }); } beforeAll(async () => { dir = fs.mkdtempSync(path.join(os.tmpdir(), 'trek-pg-move-nul-')); sqliteOrm = await migratedSqlite(path.join(dir, 'travel.db')); await makeUser(sqliteOrm, { username: 'movera' }); const { user } = await makeUser(sqliteOrm, { username: 'mover-two' }); movedId = user.id; // A value an older TREK stored with a NUL, which the ORM would no longer write. handle.exec(`update users set username = 'mover' || char(0) || 'a' where id = ${movedId}`); fs.mkdirSync(path.join(dir, 'plugins-data', 'nul-notes'), { recursive: true }); const plugin = new Database(path.join(dir, 'plugins-data', 'nul-notes', 'plugin.db')); plugin.exec( 'create table notes (k text primary key, v text);' + "insert into notes values ('team' || char(0) || 'a', 'one'), ('teama', 'two'), ('bytes', cast(x'ff41' as text));", ); plugin.close(); await emptyTarget(); }, 180_000); afterAll(async () => { await sqliteOrm?.close(true); if (handle?.open) handle.close(); fs.rmSync(dir, { recursive: true, force: true }); }); describe('the move changes nothing silently', () => { it("PGMOVENUL-001: a plugin's NUL or bytes that are not UTF-8 refuse the move before anything is written", async () => { const failure = move(true); await expect(failure).rejects.toBeInstanceOf(MoveRefusal); await expect(failure).rejects.toThrow( /2 value\(s\) in plugin data cannot move to Postgres unchanged; nothing was written:\n {2}- plugin nul-notes: notes row k=team\\u0000a, column k: the text "team\\u0000a" holds a NUL character/, ); await expect(failure).rejects.toThrow( 'plugin nul-notes: notes row k=bytes, column v: the text "\uFFFDA" holds bytes that are not valid UTF-8 (ff41)', ); expect(await tablesInTarget()).toBe(0); fs.rmSync(path.join(dir, 'plugins-data'), { recursive: true, force: true }); }); it("PGMOVENUL-002: a NUL in TREK's own text refuses the move by default and names --drop-nul", async () => { const failure = move(); await expect(failure).rejects.toBeInstanceOf(MoveRefusal); await expect(failure).rejects.toThrow( new RegExp( `users row id=${movedId}, column username: the text "mover\\\\u0000a" holds a NUL character \\(U\\+0000\\)` + '[\\s\\S]*Run the move again with --drop-nul', ), ); expect(await tablesInTarget()).toBe(0); }); it('PGMOVENUL-003: with --drop-nul, a unique key the dropped NUL breaks is named, with the constraint', async () => { await expect(move(true)).rejects.toThrow( new RegExp( 'Postgres refused rows of users: .*constraint users_username_unique[\\s\\S]*' + 'The key is broken because --drop-nul removed NUL characters \\(U\\+0000\\) from 1 value\\(s\\) of its ' + `column\\(s\\) username,[\\s\\S]* - users row id=${movedId}, column username\\n`, ), ); expect(await tablesInTarget()).toBe(0); }); it('PGMOVENUL-004: with --drop-nul and no collision, each changed value is listed and stored without the NUL', async () => { handle.exec(`update users set username = 'mover' || char(0) || 'b' where id = ${movedId}`); // JSON loses the escaped NUL and nothing else: the digits of a large number and the spelling 1.0 stay. handle.exec( `update addons set config = '{"note":"a\\u0000b","big":12345678901234567890,"ratio":1.0}' where id = 'collab'`, ); const summary = await move(true); expect([...summary.nulDropped].sort()).toEqual([ 'addons row id=collab, column config', `users row id=${movedId}, column username`, ]); const stored = await withAdmin(process.env.TREK_DB_URL as string, (run) => run<{ username: string }>('select username from users where id = ?', [movedId]), ); expect(stored).toEqual([{ username: 'moverb' }]); const config = await withAdmin(process.env.TREK_DB_URL as string, (run) => run<{ config: string }>("select config::text as config from addons where id = 'collab'"), ); expect(config).toEqual([{ config: '{"big": 12345678901234567890, "note": "ab", "ratio": 1.0}' }]); }); it("PGMOVENUL-005: TREK's own text whose bytes are not UTF-8 is refused, with --drop-nul too", async () => { await emptyTarget(); handle.exec("insert into app_settings (key, value) values ('move-bytes', cast(x'ff41' as text))"); const failure = move(true); await expect(failure).rejects.toBeInstanceOf(MoveRefusal); await expect(failure).rejects.toThrow( 'app_settings row key=move-bytes, column value: the text "\uFFFDA" holds bytes that are not valid UTF-8 (ff41)', ); expect(await tablesInTarget()).toBe(0); }); });