api: миграции TypeORM и снимки состояния БД
DataSource для CLI, генерация статического списка миграций для webpack, отдельная сборка data-source.js для деплоя, скрипты снимка и восстановления данных БД.
This commit is contained in:
1 parent
94f9b06527
commit
80808a1e75
7 files changed
+648
No files matched your search
@@ -0,0 +1,184 @@
|
||||
import { existsSync, readdirSync, readFileSync, writeFileSync } from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
import { format, resolveConfig } from 'prettier';
|
||||
|
||||
export const workspaceRoot = path.resolve(__dirname, '..');
|
||||
const migrationsDir = path.join(workspaceRoot, 'apps', 'api', 'src', 'database', 'migrations');
|
||||
const outputFile = path.join(workspaceRoot, 'apps', 'api', 'src', 'database', 'migrations.ts');
|
||||
|
||||
const HEADER =
|
||||
'// Файл сгенерирован автоматически (tools/buildDataSource.ts). Не редактировать вручную.';
|
||||
|
||||
// Только именованный экспорт: render() строит именованный импорт, поэтому
|
||||
// `export default class` всё равно дал бы не компилирующийся файл — пусть лучше
|
||||
// падает на понятном "не найден export class".
|
||||
const EXPORT_CLASS_RE = /export\s+class\s+(\w+)/g;
|
||||
// Ровно 13 цифр: TypeORM берёт timestamp как parseInt(className.substr(-13))
|
||||
// (MigrationExecutor.getMigrations) и падает, если там не число.
|
||||
const TIMESTAMP_PREFIX_RE = /^(\d{13})-/;
|
||||
// Файлы-спутники, которые могут лежать рядом с миграциями и миграциями не являются.
|
||||
const COMPANION_FILE_RE = /\.(d|spec|test)\.ts$/;
|
||||
|
||||
export interface MigrationEntry {
|
||||
file: string;
|
||||
className: string;
|
||||
}
|
||||
|
||||
export function fail(prefix: string, message: string): never {
|
||||
console.error(`[${prefix}] ОШИБКА: ${message}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// Объявление, а не стрелочная константа: сужение типов по never-возврату
|
||||
// (files после catch, timestampMatch после проверки) работает только для function.
|
||||
function failBuild(message: string): never {
|
||||
fail('buildDataSource', message);
|
||||
}
|
||||
|
||||
// Порядок — лексикографический по имени файла. Отдельная числовая сортировка не
|
||||
// нужна: ниже гарантируется, что имя каждого файла начинается ровно с 13 цифр,
|
||||
// а при фиксированной длине лексикографический порядок совпадает с числовым.
|
||||
export function readMigrations(): MigrationEntry[] {
|
||||
let files: string[];
|
||||
|
||||
try {
|
||||
files = readdirSync(migrationsDir);
|
||||
} catch {
|
||||
failBuild(`директория миграций не найдена: ${migrationsDir}`);
|
||||
}
|
||||
|
||||
const migrationFiles = files
|
||||
.filter((file) => file.endsWith('.ts') && !COMPANION_FILE_RE.test(file))
|
||||
.sort();
|
||||
|
||||
if (migrationFiles.length === 0) {
|
||||
failBuild(`в ${migrationsDir} не найдено ни одного .ts файла миграции`);
|
||||
}
|
||||
|
||||
const entries = migrationFiles.map((file): MigrationEntry => {
|
||||
const timestampMatch = TIMESTAMP_PREFIX_RE.exec(file);
|
||||
|
||||
if (!timestampMatch) {
|
||||
failBuild(
|
||||
`имя файла "${file}" не начинается с 13-значного timestamp ` +
|
||||
'(ожидается формат "<13 цифр>-<name>.ts")',
|
||||
);
|
||||
}
|
||||
|
||||
const source = readFileSync(path.join(migrationsDir, file), 'utf8');
|
||||
const classNames = [...source.matchAll(EXPORT_CLASS_RE)].map((match) => match[1]);
|
||||
|
||||
if (classNames.length === 0) {
|
||||
failBuild(`в файле "${file}" не найден "export class"`);
|
||||
}
|
||||
|
||||
// Брать первый попавшийся нельзя: TypeORM выводит timestamp из имени класса,
|
||||
// и вспомогательный экспорт выше миграции молча подменил бы порядок.
|
||||
if (classNames.length > 1) {
|
||||
failBuild(
|
||||
`в файле "${file}" найдено несколько "export class" (${classNames.join(', ')}); ` +
|
||||
'в файле миграции должен быть ровно один экспортируемый класс',
|
||||
);
|
||||
}
|
||||
|
||||
const className = classNames[0];
|
||||
|
||||
// Инвариант TypeORM: он игнорирует порядок массива и сортирует по
|
||||
// parseInt(className.substr(-13)). Если суффикс класса расходится с префиксом
|
||||
// файла, миграции применяются не в том порядке, а в таблице migrations
|
||||
// оказывается чужой timestamp.
|
||||
if (className.slice(-13) !== timestampMatch[1]) {
|
||||
failBuild(
|
||||
`в файле "${file}" класс "${className}" оканчивается на ` +
|
||||
`"${className.slice(-13)}", а имя файла — на "${timestampMatch[1]}"; ` +
|
||||
'TypeORM берёт timestamp из имени класса, суффиксы обязаны совпадать',
|
||||
);
|
||||
}
|
||||
|
||||
return { file, className };
|
||||
});
|
||||
|
||||
const seen = new Map<string, string>();
|
||||
|
||||
for (const entry of entries) {
|
||||
const duplicate = seen.get(entry.className);
|
||||
|
||||
if (duplicate) {
|
||||
failBuild(
|
||||
`класс "${entry.className}" объявлен дважды: "${duplicate}" и "${entry.file}"`,
|
||||
);
|
||||
}
|
||||
|
||||
seen.set(entry.className, entry.file);
|
||||
}
|
||||
|
||||
return entries;
|
||||
}
|
||||
|
||||
function render(entries: MigrationEntry[]): string {
|
||||
const imports = entries
|
||||
.map(
|
||||
(entry) =>
|
||||
`import { ${entry.className} } from './migrations/${entry.file.slice(0, -'.ts'.length)}';`,
|
||||
)
|
||||
.join('\n');
|
||||
|
||||
const list = entries.map((entry) => ` ${entry.className},`).join('\n');
|
||||
|
||||
return `${HEADER}\n\n${imports}\n\nexport const migrations = [\n${list}\n];\n`;
|
||||
}
|
||||
|
||||
async function main(): Promise<void> {
|
||||
const entries = readMigrations();
|
||||
const prettierConfig = await resolveConfig(outputFile);
|
||||
|
||||
const formatted = await format(render(entries), {
|
||||
...prettierConfig,
|
||||
filepath: outputFile,
|
||||
parser: 'typescript',
|
||||
});
|
||||
|
||||
const relativeOutput = path.relative(workspaceRoot, outputFile);
|
||||
const current = existsSync(outputFile) ? readFileSync(outputFile, 'utf8') : null;
|
||||
const upToDate = current === formatted;
|
||||
|
||||
console.log(`[buildDataSource] миграций найдено: ${entries.length}`);
|
||||
|
||||
// --check ничего не пишет и падает при расхождении. Сравнение идёт с тем же
|
||||
// отформатированным текстом, что и запись, поэтому CI не нужно поднимать
|
||||
// git diff и отличать «список устарел» от «git не смог прочитать репозиторий».
|
||||
if (process.argv.includes('--check')) {
|
||||
if (!upToDate) {
|
||||
failBuild(
|
||||
`${relativeOutput} расходится со списком файлов миграций. ` +
|
||||
'Перегенерируйте: yarn nx run api:db-migrations-list — и закоммитьте результат',
|
||||
);
|
||||
}
|
||||
|
||||
console.log(`[buildDataSource] актуален: ${relativeOutput}`);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Пишем только при реальном изменении: build зависит от этого таргета, а
|
||||
// api:serve следит за src/ — перезапись с тем же содержимым дёргает mtime
|
||||
// и загоняет watch-режим в бесконечный цикл пересборок.
|
||||
if (upToDate) {
|
||||
console.log(`[buildDataSource] без изменений: ${relativeOutput}`);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
writeFileSync(outputFile, formatted, 'utf8');
|
||||
|
||||
console.log(`[buildDataSource] записано: ${relativeOutput}`);
|
||||
}
|
||||
|
||||
// Модуль импортируется из tools/checkDataSource.ts ради readMigrations(),
|
||||
// поэтому генерация запускается только при прямом вызове файла.
|
||||
if (require.main === module) {
|
||||
main().catch((error) => {
|
||||
failBuild(error instanceof Error ? error.message : String(error));
|
||||
});
|
||||
}
|
||||
Reference in new issue
Block a user