High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
refactor(server): filter on-event handlers by worker (#14085)
Jason Rasmussen876893c823ba
diff --git a/server/src/decorators.ts b/server/src/decorators.tsindex be379bf64e..c2bbe19b28 100644--- a/server/src/decorators.ts+++ b/server/src/decorators.ts@@ -2,7 +2,7 @@ import { SetMetadata, applyDecorators } from '@nestjs/common';import { ApiExtension, ApiOperation, ApiProperty, ApiTags } from '@nestjs/swagger';import _ from 'lodash';import { ADDED_IN_PREFIX, DEPRECATED_IN_PREFIX, LIFECYCLE_EXTENSION } from 'src/constants';-import { MetadataKey } from 'src/enum';+import { ImmichWorker, MetadataKey } from 'src/enum';import { EmitEvent } from 'src/interfaces/event.interface';import { JobName, QueueName } from 'src/interfaces/job.interface';import { setUnion } from 'src/utils/set';@@ -120,6 +120,8 @@ export type EventConfig = {server?: boolean;/** lower value has higher priority, defaults to 0 */priority?: number;+ /** register events for these workers, defaults to all workers */+ workers?: ImmichWorker[];};export const OnEvent = (config: EventConfig) => SetMetadata(MetadataKey.EVENT_CONFIG, config);diff --git a/server/src/repositories/event.repository.ts b/server/src/repositories/event.repository.tsindex 4451ee09c5..96df72e43f 100644--- a/server/src/repositories/event.repository.ts+++ b/server/src/repositories/event.repository.ts@@ -11,7 +11,8 @@ import { ClassConstructor } from 'class-transformer';import _ from 'lodash';import { Server, Socket } from 'socket.io';import { EventConfig } from 'src/decorators';-import { MetadataKey } from 'src/enum';+import { ImmichWorker, MetadataKey } from 'src/enum';+import { IConfigRepository } from 'src/interfaces/config.interface';import {ArgsOf,ClientEventMap,@@ -23,6 +24,7 @@ import {ServerEvents,} from 'src/interfaces/event.interface';import { ILoggerRepository } from 'src/interfaces/logger.interface';+import { ConfigRepository } from 'src/repositories/config.repository';import { AuthService } from 'src/services/auth.service';import { handlePromiseError } from 'src/utils/misc';@@ -50,6 +52,7 @@ export class EventRepository implements OnGatewayConnection, OnGatewayDisconnectconstructor(private moduleRef: ModuleRef,+ @Inject(IConfigRepository) private configRepository: ConfigRepository,@Inject(ILoggerRepository) private logger: ILoggerRepository,) {this.logger.setContext(EventRepository.name);@@ -58,6 +61,10 @@ export class EventRepository implements OnGatewayConnection, OnGatewayDisconnectsetup({ services }: { services: ClassConstructor<unknown>[] }) {const reflector = this.moduleRef.get(Reflector, { strict: false });const items: Item<EmitEvent>[] = [];+ const worker = this.configRepository.getWorker();+ if (!worker) {+ throw new Error('Unable to determine worker type');+ }// discoveryfor (const Service of services) {@@ -79,6 +86,11 @@ export class EventRepository implements OnGatewayConnection, OnGatewayDisconnectcontinue;}+ const workers = event.workers ?? Object.values(ImmichWorker);+ if (!workers.includes(worker)) {+ continue;+ }+items.push({event: event.name,priority: event.priority || 0,@@ -133,7 +145,7 @@ export class EventRepository implements OnGatewayConnection, OnGatewayDisconnectawait client.leave(client.nsp.name);}- private addHandler<T extends EmitEvent>(item: EventItem<T>): void {+ private addHandler<T extends EmitEvent>(item: Item<T>): void {const event = item.event;if (!this.emitHandlers[event]) {diff --git a/server/src/services/backup.service.ts b/server/src/services/backup.service.tsindex daa7d180f1..b3bc1dd8d1 100644--- a/server/src/services/backup.service.ts+++ b/server/src/services/backup.service.ts@@ -14,16 +14,12 @@ import { handlePromiseError } from 'src/utils/misc';export class BackupService extends BaseService {private backupLock = false;- @OnEvent({ name: 'config.init' })+ @OnEvent({ name: 'config.init', workers: [ImmichWorker.MICROSERVICES] })async onConfigInit({newConfig: {backup: { database },},}: ArgOf<'config.init'>) {- if (this.worker !== ImmichWorker.API) {- return;- }-this.backupLock = await this.databaseRepository.tryLock(DatabaseLock.BackupDatabase);if (this.backupLock) {diff --git a/server/src/services/job.service.ts b/server/src/services/job.service.tsindex 0528a4a925..2faed0a516 100644--- a/server/src/services/job.service.ts+++ b/server/src/services/job.service.ts@@ -38,12 +38,8 @@ const asJobItem = (dto: JobCreateDto): JobItem => {@Injectable()export class JobService extends BaseService {- @OnEvent({ name: 'config.init' })+ @OnEvent({ name: 'config.init', workers: [ImmichWorker.MICROSERVICES] })onConfigInit({ newConfig: config }: ArgOf<'config.init'>) {- if (this.worker !== ImmichWorker.MICROSERVICES) {- return;- }-this.logger.debug(`Updating queue concurrency settings`);for (const queueName of Object.values(QueueName)) {let concurrency = 1;diff --git a/server/src/services/library.service.spec.ts b/server/src/services/library.service.spec.tsindex 96fa127e3c..43d6662d65 100644--- a/server/src/services/library.service.spec.ts+++ b/server/src/services/library.service.spec.ts@@ -122,13 +122,6 @@ describe(LibraryService.name, () => {expect(cronMock.create).not.toHaveBeenCalled();});-- it('should not initialize watcher or library scan job when running on api', async () => {- configMock.getWorker.mockReturnValue(ImmichWorker.API);- await sut.onConfigInit({ newConfig: systemConfigStub.libraryScan as SystemConfig });-- expect(cronMock.create).not.toHaveBeenCalled();- });});describe('onConfigUpdateEvent', () => {diff --git a/server/src/services/library.service.ts b/server/src/services/library.service.tsindex 6c5d400c84..c0d24fea9e 100644--- a/server/src/services/library.service.ts+++ b/server/src/services/library.service.ts@@ -31,16 +31,12 @@ export class LibraryService extends BaseService {private lock = false;private watchers: Record<string, () => Promise<void>> = {};- @OnEvent({ name: 'config.init' })+ @OnEvent({ name: 'config.init', workers: [ImmichWorker.MICROSERVICES] })async onConfigInit({newConfig: {library: { watch, scan },},}: ArgOf<'config.init'>) {- if (this.worker !== ImmichWorker.MICROSERVICES) {- return;- }-// This ensures that library watching only occurs in one microservicethis.lock = await this.databaseRepository.tryLock(DatabaseLock.Library);diff --git a/server/src/services/metadata.service.spec.ts b/server/src/services/metadata.service.spec.tsindex e3dc19111b..390f18b777 100644--- a/server/src/services/metadata.service.spec.ts+++ b/server/src/services/metadata.service.spec.ts@@ -94,15 +94,6 @@ describe(MetadataService.name, () => {expect(mapMock.init).toHaveBeenCalledTimes(1);expect(jobMock.resume).toHaveBeenCalledTimes(1);});-- it('should return if running on api', async () => {- configMock.getWorker.mockReturnValue(ImmichWorker.API);- await sut.onBootstrap();-- expect(jobMock.pause).not.toHaveBeenCalled();- expect(mapMock.init).not.toHaveBeenCalled();- expect(jobMock.resume).not.toHaveBeenCalled();- });});describe('handleLivePhotoLinking', () => {diff --git a/server/src/services/metadata.service.ts b/server/src/services/metadata.service.tsindex d8da095abf..79a7d519d6 100644--- a/server/src/services/metadata.service.ts+++ b/server/src/services/metadata.service.ts@@ -68,11 +68,8 @@ const validateRange = (value: number | undefined, min: number, max: number): Non@Injectable()export class MetadataService extends BaseService {- @OnEvent({ name: 'app.bootstrap' })+ @OnEvent({ name: 'app.bootstrap', workers: [ImmichWorker.MICROSERVICES] })async onBootstrap() {- if (this.worker !== ImmichWorker.MICROSERVICES) {- return;- }this.logger.log('Bootstrapping metadata service');await this.init();}diff --git a/server/src/services/smart-info.service.spec.ts b/server/src/services/smart-info.service.spec.tsindex 4ae5959194..250f9326f9 100644--- a/server/src/services/smart-info.service.spec.ts+++ b/server/src/services/smart-info.service.spec.ts@@ -67,19 +67,6 @@ describe(SmartInfoService.name, () => {});describe('onConfigInit', () => {- it('should return if not microservices', async () => {- configMock.getWorker.mockReturnValue(ImmichWorker.API);- await sut.onConfigInit({ newConfig: systemConfigStub.machineLearningEnabled as SystemConfig });-- expect(searchMock.getDimensionSize).not.toHaveBeenCalled();- expect(searchMock.setDimensionSize).not.toHaveBeenCalled();- expect(searchMock.deleteAllSearchEmbeddings).not.toHaveBeenCalled();- expect(jobMock.getQueueStatus).not.toHaveBeenCalled();- expect(jobMock.pause).not.toHaveBeenCalled();- expect(jobMock.waitForQueueCompletion).not.toHaveBeenCalled();- expect(jobMock.resume).not.toHaveBeenCalled();- });-it('should return if machine learning is disabled', async () => {await sut.onConfigInit({ newConfig: systemConfigStub.machineLearningDisabled as SystemConfig });@@ -136,22 +123,6 @@ describe(SmartInfoService.name, () => {});describe('onConfigUpdateEvent', () => {- it('should return if not microservices', async () => {- configMock.getWorker.mockReturnValue(ImmichWorker.API);- await sut.onConfigUpdate({- newConfig: systemConfigStub.machineLearningEnabled as SystemConfig,- oldConfig: systemConfigStub.machineLearningEnabled as SystemConfig,- });-- expect(searchMock.getDimensionSize).not.toHaveBeenCalled();- expect(searchMock.setDimensionSize).not.toHaveBeenCalled();- expect(searchMock.deleteAllSearchEmbeddings).not.toHaveBeenCalled();- expect(jobMock.getQueueStatus).not.toHaveBeenCalled();- expect(jobMock.pause).not.toHaveBeenCalled();- expect(jobMock.waitForQueueCompletion).not.toHaveBeenCalled();- expect(jobMock.resume).not.toHaveBeenCalled();- });-it('should return if machine learning is disabled', async () => {systemMock.get.mockResolvedValue(systemConfigStub.machineLearningDisabled);diff --git a/server/src/services/smart-info.service.ts b/server/src/services/smart-info.service.tsindex 9e1eb5b31b..9122a48658 100644--- a/server/src/services/smart-info.service.ts+++ b/server/src/services/smart-info.service.ts@@ -13,12 +13,12 @@ import { usePagination } from 'src/utils/pagination';@Injectable()export class SmartInfoService extends BaseService {- @OnEvent({ name: 'config.init' })+ @OnEvent({ name: 'config.init', workers: [ImmichWorker.MICROSERVICES] })async onConfigInit({ newConfig }: ArgOf<'config.init'>) {await this.init(newConfig);}- @OnEvent({ name: 'config.update', server: true })+ @OnEvent({ name: 'config.update', workers: [ImmichWorker.MICROSERVICES], server: true })async onConfigUpdate({ oldConfig, newConfig }: ArgOf<'config.update'>) {await this.init(newConfig, oldConfig);}@@ -35,7 +35,7 @@ export class SmartInfoService extends BaseService {}private async init(newConfig: SystemConfig, oldConfig?: SystemConfig) {- if (this.worker !== ImmichWorker.MICROSERVICES || !isSmartSearchEnabled(newConfig.machineLearning)) {+ if (!isSmartSearchEnabled(newConfig.machineLearning)) {return;}