Files
it-smi/tools/buildDataSource.ts
T
arswarog 1d80630fb2 ci: перенос миграций к модулям, деплой стендов через jt4d-lab/ssh-action и caddy-лейблы
- миграции лежат по модулям в `apps/api/src/<module>/migrations/`; `tools/buildDataSource.ts`
  сканирует `apps/api/src/**/migrations/` и генерирует список в `apps/api/src/migrations.ts`
- `deploy-staging` накатывает миграции шагами `migration:show` и `migration:run -t each`
- стенды получают маршрутизацию через лейблы `caddy` и `caddy.reverse_proxy`, web-образ стенда
  собирается с `CADDYFILE=Caddyfile.staging`

## Мотивация

Миграции нужно накатывать на стендах автоматически и держать рядом с модулем, которому они
принадлежат, а деплой — сводить к одному шагу, который сам копирует компоуз-файл на хост и выполняет
скрипт.

## Ключевые моменты реализации

- `Caddyfile.staging` слушает `:80` без хостового матчера и HTTPS: имена стендов динамические,
  маршрутизацию и TLS берёт внешний caddy-docker-proxy по лейблам

Reviewed-on: jt4d/jt4d#2
Co-authored-by: Arswarog <arswarog@yandex.ru>
2026-10-31 16:13:13 +03:00

222 lines
9.6 KiB
TypeScript

import { type Dirent, existsSync, readdirSync, readFileSync, writeFileSync } from 'fs';
import * as path from 'path';
import { format, resolveConfig } from 'prettier';
export const workspaceRoot = path.resolve(__dirname, '..');
const apiSrcDir = path.join(workspaceRoot, 'apps', 'api', 'src');
const outputFile = path.join(apiSrcDir, 'migrations.ts');
// Миграции лежат по модулям: apps/api/src/<module>/migrations/<timestamp>-<name>.ts.
const MIGRATIONS_DIR_NAME = 'migrations';
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 {
/** Путь относительно apps/api/src, с расширением .ts */
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);
}
// Список каталогов миграций: любой apps/api/src/**/migrations.
function findMigrationsDirs(dir: string): string[] {
let entries: Dirent[];
try {
entries = readdirSync(dir, { withFileTypes: true });
} catch {
failBuild(`не удалось прочитать директорию: ${dir}`);
}
const found: string[] = [];
for (const entry of entries) {
if (!entry.isDirectory() || entry.name === 'node_modules') {
continue;
}
const fullPath = path.join(dir, entry.name);
if (entry.name === MIGRATIONS_DIR_NAME) {
found.push(fullPath);
continue;
}
found.push(...findMigrationsDirs(fullPath));
}
return found;
}
// Порядок — по timestamp из имени файла (возрастание): имя файла начинается ровно с
// 13 цифр, поэтому лексикографическая сортировка совпадает с числовой. Одинаковые
// имена файлов в разных модулях упорядочиваются по пути.
export function readMigrations(): MigrationEntry[] {
const migrationFiles = findMigrationsDirs(apiSrcDir)
.flatMap((dir) =>
readdirSync(dir, { withFileTypes: true })
.filter((entry) => entry.isFile())
.map((entry) => path.posix.join(path.relative(apiSrcDir, dir), entry.name))
.filter((file) => file.endsWith('.ts') && !COMPANION_FILE_RE.test(file)),
)
.sort((a, b) => {
const byName = path.posix.basename(a).localeCompare(path.posix.basename(b));
return byName !== 0 ? byName : a.localeCompare(b);
});
// Каталогов migrations может не быть ни одного: проект может ещё не иметь
// миграций. Тогда список пустой, а сборка не падает.
const entries = migrationFiles.map((file): MigrationEntry => {
const timestampMatch = TIMESTAMP_PREFIX_RE.exec(path.posix.basename(file));
if (!timestampMatch) {
failBuild(
`имя файла "${file}" не начинается с 13-значного timestamp ` +
'(ожидается формат "<13 цифр>-<name>.ts")',
);
}
const source = readFileSync(path.join(apiSrcDir, 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 {
if (entries.length === 0) {
return `${HEADER}\n\nexport const migrations = [];\n`;
}
const imports = entries
.map(
(entry) =>
`import { ${entry.className} } from './${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));
});
}