teqo-backup/tests/int/campaignMigrationReconciliation.int.spec.ts
Francisco Ignácio Fontoura Solla 0e4e6855dc Add the tooling gate: knip, CI, zero-warning lint, as-never ban
- knip (files/deps at error level; unused exports ledgered as warn) with
  config for Payload/Next entries; deleted the dead modules it confirmed:
  RecentlyVisited + UpcomingActionPlansCard + actionPlanUpcomingPreview,
  lazy-dialog helpers, tseZone, federalCandidateTotalsAggregate (test-only),
  unused ui kit files, one-shot rename script; pruned unused radix deps and
  typescript-eslint; added pg/@types/pg (pinned to drizzle's 8.10.2)
- GitHub Actions CI on the mirror: lint, typecheck, knip, unit, migrate, int
  against a Postgres 17 service
- eslint: unused-vars with ^_ ignore patterns (migrations args exempt),
  repo-wide ban on `as never` (no-restricted-syntax), lint gate at
  --max-warnings=0; fixed all 54 pre-existing warnings (dead imports,
  hooks deps, tracking-pixel img disable with impeccable config exception)
- tsconfig: include consolidated from 219 lines to 5 (wildcard covers all
  .next dist variants), noUnusedLocals on
- typed replacements for every as-never: hookFilledCreateData (actions
  create data completed by collection hooks), drizzle scopeColumn narrowing,
  tests' stub<T> helper (property-level checking kept, completeness waived)
- test infra: leased-consent generalization used by onda0 spec (shared
  leases over the stable consent keys; window race ledgered), purge fix
- docs: IMPROVE-CODE-QUALITY-PLAN.md tracker, TECH-DEBT.md ledger,
  TESTING.md safety-net map (package.json also gains the Phase 2
  build:election-aggregates script entry; the script lands next commit)
2026-07-23 23:06:12 -03:00

190 lines
7.7 KiB
TypeScript

// @vitest-environment node
import { createRequire } from 'node:module'
import { sql, type MigrateDownArgs, type MigrateUpArgs } from '@payloadcms/db-postgres'
import { drizzle } from '@payloadcms/db-postgres/drizzle/node-postgres'
import type { Pool as PgPool } from 'pg'
import { afterEach, beforeEach, describe, expect, it } from 'vitest'
import { migrations } from '@/migrations'
import { stub } from '../helpers/stub'
const require = createRequire(import.meta.resolve('@payloadcms/db-postgres'))
const { Pool } = require('pg') as {
Pool: new (options: { connectionString: string }) => PgPool
}
const testDatabaseUrl =
process.env.DATABASE_URL ?? 'postgresql://teqo:teqo@localhost:5432/teqo_test'
const adminUrl = testDatabaseUrl.replace(/\/[^/]+$/, '/postgres')
const consolidatedName = '20260718_010733_consolidate_campaign_schema'
type MigrationDatabase = MigrateUpArgs['db']
let databaseSequence = 0
let databaseName = ''
let databasePool: InstanceType<typeof Pool> | undefined
let database: MigrationDatabase | undefined
const quoteIdentifier = (identifier: string): string => {
if (!/^[a-z0-9_]+$/.test(identifier)) throw new Error(`Unsafe database identifier: ${identifier}`)
return `"${identifier}"`
}
const schemaChecksum = async (): Promise<string> => {
if (!database) throw new Error('Disposable database is not initialized.')
const result = await database.execute(sql`
WITH facts AS (
SELECT
'column|' || table_name || '|' || column_name || '|' || data_type || '|' ||
coalesce(udt_name, '') || '|' || is_nullable || '|' || coalesce(column_default, '') AS fact
FROM information_schema.columns
WHERE table_schema = 'public'
UNION ALL
SELECT
'constraint|' || rel.relname || '|' || con.conname || '|' ||
con.contype::text || '|' || pg_get_constraintdef(con.oid, true)
FROM pg_constraint con
JOIN pg_class rel ON rel.oid = con.conrelid
JOIN pg_namespace n ON n.oid = rel.relnamespace
WHERE n.nspname = 'public'
UNION ALL
SELECT 'index|' || idx.relname || '|' || pg_get_indexdef(idx.oid)
FROM pg_class idx
JOIN pg_index i ON i.indexrelid = idx.oid
JOIN pg_class rel ON rel.oid = i.indrelid
JOIN pg_namespace n ON n.oid = rel.relnamespace
WHERE n.nspname = 'public'
UNION ALL
SELECT 'enum|' || t.typname || '|' || e.enumsortorder || '|' || e.enumlabel
FROM pg_type t
JOIN pg_enum e ON e.enumtypid = t.oid
JOIN pg_namespace n ON n.oid = t.typnamespace
WHERE n.nspname = 'public'
)
SELECT md5(string_agg(fact, E'\n' ORDER BY fact)) AS checksum
FROM facts
`)
return String(result.rows[0]?.checksum)
}
beforeEach(async () => {
databaseName = `teqo_campaign_migration_${process.pid}_${databaseSequence++}_test`
const adminPool = new Pool({ connectionString: adminUrl })
await adminPool.query(`CREATE DATABASE ${quoteIdentifier(databaseName)}`)
await adminPool.end()
databasePool = new Pool({
connectionString: testDatabaseUrl.replace(/\/[^/]+$/, `/${databaseName}`),
})
database = drizzle<Record<string, unknown>>(databasePool)
for (const migration of migrations) {
await migration.up(stub<MigrateUpArgs>({ db: database }))
}
})
afterEach(async () => {
await databasePool?.end()
database = undefined
databasePool = undefined
if (databaseName) {
const adminPool = new Pool({ connectionString: adminUrl })
await adminPool.query(`DROP DATABASE IF EXISTS ${quoteIdentifier(databaseName)} WITH (FORCE)`)
await adminPool.end()
}
})
const partialSchemaMutations = [
[
'campaign user email nullability',
'ALTER TABLE "campaign_user" ALTER COLUMN "email" SET NOT NULL',
],
['contact email nullability', 'ALTER TABLE "contact" ALTER COLUMN "email" SET NOT NULL'],
['contact city nullability', 'ALTER TABLE "contact" ALTER COLUMN "city" SET NOT NULL'],
[
'missing locked-document foreign key',
'ALTER TABLE "payload_locked_documents_rels" DROP CONSTRAINT "payload_locked_documents_rels_campaign_invite_fk"',
],
[
'wrong locked-document foreign-key delete action',
`ALTER TABLE "payload_locked_documents_rels"
DROP CONSTRAINT "payload_locked_documents_rels_campaign_invite_fk";
ALTER TABLE "payload_locked_documents_rels"
ADD CONSTRAINT "payload_locked_documents_rels_campaign_invite_fk"
FOREIGN KEY ("campaign_invite_id") REFERENCES "campaign_invite"("id")
ON DELETE SET NULL ON UPDATE NO ACTION`,
],
[
'wrong locked-document foreign-key target',
`ALTER TABLE "payload_locked_documents_rels"
DROP CONSTRAINT "payload_locked_documents_rels_campaign_invite_fk";
ALTER TABLE "payload_locked_documents_rels"
ADD CONSTRAINT "payload_locked_documents_rels_campaign_invite_fk"
FOREIGN KEY ("campaign_invite_id") REFERENCES "leadership"("id")
ON DELETE CASCADE ON UPDATE NO ACTION`,
],
] as const
describe('campaign migration existing-schema reconciliation', () => {
it.each(partialSchemaMutations)(
'rejects %s without changing schema or recording the migration',
async (_label, mutation) => {
if (!database) throw new Error('Disposable database is not initialized.')
await database.execute(sql.raw(mutation))
const checksumBefore = await schemaChecksum()
const consolidated = migrations.find((migration) => migration.name === consolidatedName)
if (!consolidated) throw new Error('Consolidated campaign migration is not registered.')
await expect(
database.transaction(async (transaction) => {
await consolidated.up(stub<MigrateUpArgs>({ db: transaction }))
await transaction.execute(sql`
INSERT INTO "payload_migrations" ("name", "batch", "updated_at", "created_at")
VALUES (${consolidatedName}, 999, now(), now())
`)
}),
).rejects.toThrow('Refusing campaign schema reconciliation')
expect(await schemaChecksum()).toBe(checksumBefore)
const migrationRows = await database.execute(sql`
SELECT count(*)::integer AS count
FROM "payload_migrations"
WHERE "name" = ${consolidatedName}
`)
expect(migrationRows.rows[0]?.count).toBe(0)
},
120_000,
)
// NOTE: the pre-remodel "empty path" rollback test (municipalityRemodel.down →
// consolidated.down → original.down) is intentionally absent: the municipality
// remodel down is currently broken — `DROP TABLE "municipality" CASCADE` already
// cascades the supporter/action_plan/locked-documents FKs that the script
// then tries to DROP CONSTRAINT explicitly, so the rollback always aborts.
// Restore that coverage once the migration down uses IF EXISTS (or drops
// constraints before the cascaded tables).
it('refuses a populated consolidated rollback before changing schema', async () => {
if (!database) throw new Error('Disposable database is not initialized.')
const consolidated = migrations.find((migration) => migration.name === consolidatedName)
if (!consolidated) throw new Error('Consolidated campaign migration is not registered.')
await database.execute(sql`
INSERT INTO "campaign_user" ("name", "email", "role", "updated_at", "created_at")
VALUES ('Rollback sentinel', 'rollback-sentinel@example.test', 'coordinator', now(), now())
`)
const checksumBefore = await schemaChecksum()
await expect(consolidated.down(stub<MigrateDownArgs>({ db: database }))).rejects.toThrow(
'Refusing to roll back consolidated campaign schema',
)
expect(await schemaChecksum()).toBe(checksumBefore)
const sentinel = await database.execute(sql`
SELECT count(*)::integer AS count
FROM "campaign_user"
WHERE "email" = 'rollback-sentinel@example.test'
`)
expect(sentinel.rows[0]?.count).toBe(1)
})
})