Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(server): domain and infra modules #6301

Merged
merged 1 commit into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion cli/test/e2e/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ export default async () => {
}

process.env.NODE_ENV = 'development';
process.env.IMMICH_TEST_ENV = 'true';
process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/test/e2e/immich-e2e-config.json`);
process.env.TZ = 'Z';
};
23 changes: 9 additions & 14 deletions server/src/domain/domain.module.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ImmichLogger } from '@app/infra/logger';
import { DynamicModule, Global, Module, ModuleMetadata, Provider } from '@nestjs/common';
import { Global, Module, Provider } from '@nestjs/common';
import { ActivityService } from './activity';
import { AlbumService } from './album';
import { APIKeyService } from './api-key';
Expand Down Expand Up @@ -31,10 +31,11 @@ const providers: Provider[] = [
AuditService,
AuthService,
DatabaseService,
ImmichLogger,
JobService,
LibraryService,
MediaService,
MetadataService,
LibraryService,
PersonService,
PartnerService,
SearchService,
Expand All @@ -46,18 +47,12 @@ const providers: Provider[] = [
SystemConfigService,
TagService,
UserService,
ImmichLogger,
];

@Global()
@Module({})
export class DomainModule {
static register(options: Pick<ModuleMetadata, 'imports'>): DynamicModule {
return {
module: DomainModule,
imports: options.imports,
providers: [...providers],
exports: [...providers],
};
}
}
@Module({
imports: [],
providers: [...providers],
exports: [...providers],
})
export class DomainModule {}
2 changes: 1 addition & 1 deletion server/src/immich-admin/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { DisablePasswordLoginCommand, EnablePasswordLoginCommand } from './comma
import { PromptPasswordQuestions, ResetAdminPasswordCommand } from './commands/reset-admin-password.command';

@Module({
imports: [DomainModule.register({ imports: [InfraModule] })],
imports: [InfraModule, DomainModule],
providers: [
ResetAdminPasswordCommand,
PromptPasswordQuestions,
Expand Down
3 changes: 2 additions & 1 deletion server/src/immich/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ import { ErrorInterceptor, FileUploadInterceptor } from './interceptors';
@Module({
imports: [
//
DomainModule.register({ imports: [InfraModule] }),
InfraModule,
DomainModule,
ScheduleModule.forRoot(),
TypeOrmModule.forFeature([AssetEntity]),
],
Expand Down
9 changes: 1 addition & 8 deletions server/src/infra/infra.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ import { QueueOptions } from 'bullmq';
import { RedisOptions } from 'ioredis';

function parseRedisConfig(): RedisOptions {
if (process.env.IMMICH_TEST_ENV == 'true') {
// Currently running e2e tests, do not use redis
return {};
}

const redisUrl = process.env.REDIS_URL;
if (redisUrl && redisUrl.startsWith('ioredis://')) {
try {
Expand All @@ -28,11 +23,9 @@ function parseRedisConfig(): RedisOptions {
};
}

export const redisConfig: RedisOptions = parseRedisConfig();

export const bullConfig: QueueOptions = {
prefix: 'immich_bull',
connection: redisConfig,
connection: parseRedisConfig(),
defaultJobOptions: {
attempts: 3,
removeOnComplete: true,
Expand Down
40 changes: 22 additions & 18 deletions server/src/infra/infra.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,26 +94,30 @@ const providers: Provider[] = [
SchedulerRegistry,
];

const imports = [
ConfigModule.forRoot(immichAppConfig),
TypeOrmModule.forRoot(databaseConfig),
TypeOrmModule.forFeature(databaseEntities),
ScheduleModule,
];

const moduleExports = [...providers];

if (process.env.IMMICH_TEST_ENV !== 'true') {
// Currently not running e2e tests, set up redis and bull queues
imports.push(BullModule.forRoot(bullConfig));
imports.push(BullModule.registerQueue(...bullQueues));
moduleExports.push(BullModule);
}

@Global()
@Module({
imports,
imports: [
ConfigModule.forRoot(immichAppConfig),
TypeOrmModule.forRoot(databaseConfig),
TypeOrmModule.forFeature(databaseEntities),
ScheduleModule,
BullModule.forRoot(bullConfig),
BullModule.registerQueue(...bullQueues),
],
providers: [...providers],
exports: moduleExports,
exports: [...providers, BullModule],
})
export class InfraModule {}

@Global()
@Module({
imports: [
ConfigModule.forRoot(immichAppConfig),
TypeOrmModule.forRoot(databaseConfig),
TypeOrmModule.forFeature(databaseEntities),
ScheduleModule,
],
providers: [...providers],
exports: [...providers],
})
export class InfraTestModule {}
2 changes: 1 addition & 1 deletion server/src/microservices/microservices.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Module, OnModuleInit } from '@nestjs/common';
import { AppService } from './app.service';

@Module({
imports: [DomainModule.register({ imports: [InfraModule] })],
imports: [InfraModule, DomainModule],
providers: [AppService],
})
export class MicroservicesModule implements OnModuleInit {
Expand Down
1 change: 0 additions & 1 deletion server/test/e2e/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ export default async () => {
}

process.env.NODE_ENV = 'development';
process.env.IMMICH_TEST_ENV = 'true';
process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/immich-e2e-config.json`);
process.env.TZ = 'Z';
};
5 changes: 3 additions & 2 deletions server/test/test-utils.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { AssetCreate, IJobRepository, JobItem, JobItemHandler, LibraryResponseDto, QueueName } from '@app/domain';
import { AppModule } from '@app/immich';
import { dataSource } from '@app/infra';
import { InfraModule, InfraTestModule, dataSource } from '@app/infra';
import { AssetEntity, AssetType, LibraryType } from '@app/infra/entities';
import { INestApplication } from '@nestjs/common';
import { Test } from '@nestjs/testing';

import { randomBytes } from 'crypto';
import * as fs from 'fs';
import { DateTime } from 'luxon';
Expand Down Expand Up @@ -69,6 +68,8 @@ export const testApp = {
const { jobs } = options || { jobs: false };

const moduleFixture = await Test.createTestingModule({ imports: [AppModule], providers: [AppService] })
.overrideModule(InfraModule)
.useModule(InfraTestModule)
.overrideProvider(IJobRepository)
.useValue({
addHandler: (_queueName: QueueName, _concurrency: number, handler: JobItemHandler) => (_handler = handler),
Expand Down
Loading