import { Kysely } from 'kysely'; import { CommandFactory } from 'nest-commander'; import { ChildProcess, fork } from 'node:child_process'; import { dirname, join } from 'node:path'; import { Worker } from 'node:worker_threads'; import { PostgresError } from 'postgres'; import { ImmichAdminModule } from 'src/app.module'; import { ExitCode, ImmichWorker, LogLevel, SystemMetadataKey } from 'src/enum'; import { ConfigRepository } from 'src/repositories/config.repository'; import { SystemMetadataRepository } from 'src/repositories/system-metadata.repository'; import { type DB } from 'src/schema'; import { getKyselyConfig } from 'src/utils/database'; /** * Manages worker lifecycle */ class Workers { /** * Currently running workers */ workers: Partial Promise | void }>> = {}; /** * Fail-safe in case anything dies during restart */ restarting = false; /** * Boot all enabled workers */ async bootstrap() { const isMaintenanceMode = await this.isMaintenanceMode(); const { workers } = new ConfigRepository().getEnv(); if (isMaintenanceMode) { this.startWorker(ImmichWorker.Maintenance); } else { for (const worker of workers) { this.startWorker(worker); } } } /** * Initialise a short-lived Nest application to build configuration * @returns System configuration */ private async isMaintenanceMode(): Promise { const { database } = new ConfigRepository().getEnv(); const kysely = new Kysely(getKyselyConfig(database.config)); const systemMetadataRepository = new SystemMetadataRepository(kysely); try { const value = await systemMetadataRepository.get(SystemMetadataKey.MaintenanceMode); return value?.isMaintenanceMode || false; } catch (error) { // Table doesn't exist (migrations haven't run yet) if (error instanceof PostgresError && error.code === '42P01') { return false; } throw error; } finally { await kysely.destroy(); } } /** * Start an individual worker * @param name Worker */ private startWorker(name: ImmichWorker) { console.log(`Starting ${name} worker`); // eslint-disable-next-line unicorn/prefer-module const basePath = dirname(__filename); const workerFile = join(basePath, 'workers', `${name}.js`); let anyWorker: Worker | ChildProcess; let kill: (signal?: NodeJS.Signals) => Promise | void; if (name === ImmichWorker.Api) { const worker = fork(workerFile, [], { execArgv: process.execArgv.map((arg) => (arg.startsWith('--inspect') ? '--inspect=0.0.0.0:9231' : arg)), }); kill = (signal) => void worker.kill(signal); anyWorker = worker; } else { const worker = new Worker(workerFile); kill = async () => void (await worker.terminate()); anyWorker = worker; } anyWorker.on('error', (error) => this.onError(name, error)); anyWorker.on('exit', (exitCode) => this.onExit(name, exitCode)); this.workers[name] = { kill }; } onError(name: ImmichWorker, error: Error) { console.error(`${name} worker error: ${error}, stack: ${error.stack}`); } onExit(name: ImmichWorker, exitCode: number | null) { // restart immich server if (exitCode === ExitCode.AppRestart || this.restarting) { this.restarting = true; console.info(`${name} worker shutdown for restart`); delete this.workers[name]; // once all workers shut down, bootstrap again if (Object.keys(this.workers).length === 0) { void this.bootstrap(); this.restarting = false; } return; } // shutdown the entire process delete this.workers[name]; if (exitCode !== 0) { console.error(`${name} worker exited with code ${exitCode}`); if (this.workers[ImmichWorker.Api] && name !== ImmichWorker.Api) { console.error('Killing api process'); void this.workers[ImmichWorker.Api].kill('SIGTERM'); } } process.exit(exitCode); } } function main() { const immichApp = process.argv[2]; if (immichApp) { process.argv.splice(2, 1); } if (immichApp === 'immich-admin') { process.title = 'immich_admin_cli'; process.env.IMMICH_LOG_LEVEL = LogLevel.Warn; return CommandFactory.run(ImmichAdminModule); } if (immichApp === 'immich' || immichApp === 'microservices') { console.error( `Using "start.sh ${immichApp}" has been deprecated. See https://github.com/immich-app/immich/releases/tag/v1.118.0 for more information.`, ); process.exit(1); } if (immichApp) { console.error(`Unknown command: "${immichApp}"`); process.exit(1); } process.title = 'immich'; void new Workers().bootstrap(); } void main();