refactor(db): split the Postgres schema adjustments by concern

schema-adjust.ts mixed the statement splitter, the trigger ports and the
column adjustments, and every caller repeated `meta.props as EntityProperty[]
as ColumnMeta[]` to reach them. Now:

- sql-split.ts holds splitStatements. Its scope is written down: `;` outside
  quotes, '/" quoted text and the $$ body, and the session-setting lines it
  drops. A tagged dollar quote ($tag$) is refused with an error instead of
  being split inside, which the splitter could not do correctly.
- postgres-triggers.ts holds the hand-written trigger ports, which the
  baseline and the parity test read by name.
- schema-adjust.ts holds the column adjustments. applyPostgresColumnAdjustments
  (renamed from adjustColumns, which hid that it mutates its input) takes an
  entity's props directly: ColumnMeta now reads customType as unknown, so
  the entity's property metadata satisfies it without a cast. Each adjustment
  is a small function that returns whether it changed the column.

The timestamp check is now `instanceof DbTimestampType` rather than a compare
on the constructor's name, which would have broken silently on a rename.
This commit is contained in:
Isaias Tavares
2026-11-05 00:32:18 -03:00
parent d498fe2bea
commit 33a18f29dd
8 changed files with 193 additions and 133 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
import { splitStatements } from './schema-adjust';
import { splitStatements } from './sql-split';
import fs from 'node:fs';
import path from 'node:path';
@@ -0,0 +1,32 @@
/**
* The SQLite schema's triggers as Postgres writes them. The entities describe
* tables only, so the baseline (`scripts/generate-pg-baseline.ts`) adds these
* after the tables, and `check:pg-baseline` fails while a trigger in the
* migrated SQLite schema has no entry here. Each entry is the trigger's
* function and the trigger that runs it, under the SQLite trigger's name.
*/
export const POSTGRES_TRIGGERS: Readonly<Record<string, readonly string[]>> = {
// A deleted stay releases the day stops it claimed (no foreign key holds the link).
trg_release_stop_on_stay_delete: [
`CREATE FUNCTION trg_release_stop_on_stay_delete() RETURNS trigger LANGUAGE plpgsql AS $$
BEGIN
UPDATE day_assignments SET accommodation_id = NULL WHERE accommodation_id = OLD.id;
RETURN OLD;
END
$$`,
'CREATE TRIGGER trg_release_stop_on_stay_delete AFTER DELETE ON day_accommodations ' +
'FOR EACH ROW EXECUTE FUNCTION trg_release_stop_on_stay_delete()',
],
// A place that moved or was renamed drops the region it was resolved to (#2527).
trg_place_regions_follow_place: [
`CREATE FUNCTION trg_place_regions_follow_place() RETURNS trigger LANGUAGE plpgsql AS $$
BEGIN
DELETE FROM place_regions WHERE place_id = NEW.id;
RETURN NEW;
END
$$`,
'CREATE TRIGGER trg_place_regions_follow_place AFTER UPDATE OF lat, lng, address ON places FOR EACH ROW ' +
'WHEN (OLD.lat IS DISTINCT FROM NEW.lat OR OLD.lng IS DISTINCT FROM NEW.lng OR OLD.address IS DISTINCT FROM NEW.address) ' +
'EXECUTE FUNCTION trg_place_regions_follow_place()',
],
};
+46 -101
View File
@@ -22,9 +22,11 @@
*
* The baseline keeps the foreign keys; the probe leaves them out, so a
* statement it sends is never refused only because the sample row it writes
* points at nothing.
* points at nothing. The triggers the SQLite schema has are in
* `postgres-triggers.ts`.
*/
import { pgTimestampText, PG_UTC_NOW } from '../../dialect/platform';
import { DbTimestampType } from '../../types';
/** SQLite's timestamp text on Postgres, for a column default. */
export const PG_NOW_TEXT_DEFAULT = pgTimestampText(PG_UTC_NOW);
@@ -45,120 +47,63 @@ export function portableDefault(raw: string): string {
return raw;
}
/**
* The SQLite schema's triggers, as Postgres writes them: a trigger function
* and the trigger that runs it, under the SQLite trigger's name. The entities
* describe tables only, so the baseline adds these after the tables, and
* `check:pg-baseline` fails while a trigger in the migrated SQLite schema has
* no entry here.
*/
export const POSTGRES_TRIGGERS: Readonly<Record<string, readonly string[]>> = {
// A deleted stay releases the day stops it claimed (no foreign key holds the link).
trg_release_stop_on_stay_delete: [
`CREATE FUNCTION trg_release_stop_on_stay_delete() RETURNS trigger LANGUAGE plpgsql AS $$
BEGIN
UPDATE day_assignments SET accommodation_id = NULL WHERE accommodation_id = OLD.id;
RETURN OLD;
END
$$`,
'CREATE TRIGGER trg_release_stop_on_stay_delete AFTER DELETE ON day_accommodations ' +
'FOR EACH ROW EXECUTE FUNCTION trg_release_stop_on_stay_delete()',
],
// A place that moved or was renamed drops the region it was resolved to (#2527).
trg_place_regions_follow_place: [
`CREATE FUNCTION trg_place_regions_follow_place() RETURNS trigger LANGUAGE plpgsql AS $$
BEGIN
DELETE FROM place_regions WHERE place_id = NEW.id;
RETURN NEW;
END
$$`,
'CREATE TRIGGER trg_place_regions_follow_place AFTER UPDATE OF lat, lng, address ON places FOR EACH ROW ' +
'WHEN (OLD.lat IS DISTINCT FROM NEW.lat OR OLD.lng IS DISTINCT FROM NEW.lng OR OLD.address IS DISTINCT FROM NEW.address) ' +
'EXECUTE FUNCTION trg_place_regions_follow_place()',
],
};
/**
* Splits generated DDL into single statements on `;` outside quotes and
* `$$` bodies, so one statement Postgres refuses does not take the rest of the
* schema with it.
*/
export function splitStatements(sql: string): string[] {
const statements: string[] = [];
let current = '';
let quote: '"' | "'" | '$$' | null = null;
for (let i = 0; i < sql.length; i++) {
const char = sql[i];
const dollar = sql.startsWith('$$', i);
if (quote === '$$') {
if (dollar) {
quote = null;
current += '$';
i++;
}
current += char;
} else if (quote) {
if (char === quote) quote = null;
current += char;
} else if (dollar) {
quote = '$$';
current += '$$';
i++;
} else if (char === "'" || char === '"') {
quote = char;
current += char;
} else if (char === ';') {
if (current.trim()) statements.push(current.trim());
current = '';
} else {
current += char;
}
}
if (current.trim()) statements.push(current.trim());
return statements.filter((statement) => !/^set\s/i.test(statement));
}
/** A column type SQLite stores as its 64-bit INTEGER. */
const INTEGER_TYPE = /^(integer|int)$/i;
/** The subset of MikroORM's property metadata the schema adjustments touch. */
/**
* The subset of MikroORM's property metadata the adjustments read and write.
* An entity's `props` satisfy it as they are, so no cast is needed.
*/
export interface ColumnMeta {
name: string;
defaultRaw?: string;
collation?: string;
columnTypes?: string[];
customType?: { constructor: { name: string } };
customType?: unknown;
}
/** A timestamp column becomes text. Returns whether it changed. */
function timestampAsText(column: ColumnMeta): boolean {
if (!(column.customType instanceof DbTimestampType) || !column.columnTypes) return false;
column.columnTypes = column.columnTypes.map(() => 'text');
return true;
}
/** An integer column becomes bigint. Returns whether it changed. */
function integerAsBigint(column: ColumnMeta): boolean {
if (!column.columnTypes?.some((type) => INTEGER_TYPE.test(type))) return false;
column.columnTypes = column.columnTypes.map((type) => (INTEGER_TYPE.test(type) ? 'bigint' : type));
return true;
}
/** A SQLite-only default gets its Postgres spelling. Returns whether it changed. */
function defaultAsPostgres(column: ColumnMeta): boolean {
if (typeof column.defaultRaw !== 'string') return false;
const next = portableDefault(column.defaultRaw);
if (next === column.defaultRaw) return false;
column.defaultRaw = next;
return true;
}
/** A NOCASE column uses the `nocase` collation. Returns whether it changed. */
function nocaseAsCollation(column: ColumnMeta): boolean {
if (column.collation?.toUpperCase() !== 'NOCASE') return false;
column.collation = 'nocase';
return true;
}
/**
* Applies the adjustments above to one entity's properties in place:
* timestamp columns become `text`, integer columns `bigint`, SQLite-only defaults and the NOCASE
* collation their Postgres spelling. Returns the names of the properties
* it changed, for the log.
* Applies the adjustments above to an entity's properties, in place, and
* returns the names of the properties it changed, for the log. A timestamp
* column is text, so the integer adjustment never sees it.
*/
export function adjustColumns(properties: readonly ColumnMeta[]): string[] {
export function applyPostgresColumnAdjustments(properties: readonly ColumnMeta[]): string[] {
const changed: string[] = [];
for (const property of properties) {
let touched = false;
if (property.customType?.constructor.name === 'DbTimestampType' && property.columnTypes) {
property.columnTypes = property.columnTypes.map(() => 'text');
touched = true;
} else if (property.columnTypes?.some((type) => INTEGER_TYPE.test(type))) {
property.columnTypes = property.columnTypes.map((type) => (INTEGER_TYPE.test(type) ? 'bigint' : type));
touched = true;
}
if (typeof property.defaultRaw === 'string') {
const next = portableDefault(property.defaultRaw);
if (next !== property.defaultRaw) {
property.defaultRaw = next;
touched = true;
}
}
if (property.collation?.toUpperCase() === 'NOCASE') {
property.collation = 'nocase';
touched = true;
}
if (touched) changed.push(property.name);
const typeChanged = timestampAsText(property) || integerAsBigint(property);
const defaultChanged = defaultAsPostgres(property);
const collationChanged = nocaseAsCollation(property);
if (typeChanged || defaultChanged || collationChanged) changed.push(property.name);
}
return changed;
}
@@ -0,0 +1,59 @@
/**
* Splits generated DDL into single statements, so one statement Postgres
* refuses does not take the rest of the schema with it.
*
* Understood: `;` outside quotes, `'` and `"` quoted text, and the `$$` dollar
* quote a function body is written in, which is the only dollar quote TREK's
* generated DDL and baseline contain. A tagged dollar quote (`$tag$`) is not
* understood, so it is refused rather than split inside.
*/
/** A tagged dollar quote (`$tag$`), matched where the scan stands. */
const TAGGED_DOLLAR_QUOTE = /\$[A-Za-z_]\w*\$/y;
function refuseTaggedDollarQuote(sql: string, at: number): void {
TAGGED_DOLLAR_QUOTE.lastIndex = at;
const tag = TAGGED_DOLLAR_QUOTE.exec(sql)?.[0];
if (tag) throw new Error(`splitStatements understands only the $$ dollar quote, not ${tag} (at ${at})`);
}
/**
* The statements in `sql`, trimmed and in order. A statement that sets a
* session parameter (`SET ...`) is dropped: a dump's preamble, which a schema
* the entities generate never needs.
*/
export function splitStatements(sql: string): string[] {
const statements: string[] = [];
let current = '';
let quote: '"' | "'" | '$$' | null = null;
for (let i = 0; i < sql.length; i++) {
const char = sql[i];
const dollar = sql.startsWith('$$', i);
if (quote === '$$') {
if (dollar) {
quote = null;
current += '$';
i++;
}
current += char;
} else if (quote) {
if (char === quote) quote = null;
current += char;
} else if (dollar) {
quote = '$$';
current += '$$';
i++;
} else if (char === "'" || char === '"') {
quote = char;
current += char;
} else if (char === ';') {
if (current.trim()) statements.push(current.trim());
current = '';
} else {
if (char === '$') refuseTaggedDollarQuote(sql, i);
current += char;
}
}
if (current.trim()) statements.push(current.trim());
return statements.filter((statement) => !/^set\s/i.test(statement));
}