helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-11-14 17:36:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(server): introduce proper job status (#7932)

Browse source 
* introduce proper job status

* fix condition for onDone jobs

* fix tests
This commit is contained in:
Daniel Dietzler 2024-03-15 14:16:54 +01:00 • committed by GitHub
parent 07e8f79563
commit a46366d336
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 241 additions and 216 deletions
Download patch file Download diff file Expand all files Collapse all files

37
server/src/domain/library/library.service.ts
View file

@ -22,6 +22,7 @@ import {
ILibraryRepository,
IStorageRepository,
ISystemConfigRepository,
JobStatus,
StorageEventType,
WithProperty,
} from '../repositories';
@ -241,13 +242,13 @@ export class LibraryService extends EventEmitter {
return libraries.map((library) => mapLibrary(library));
}
async handleQueueCleanup(): Promise<boolean> {
async handleQueueCleanup(): Promise<JobStatus> {
this.logger.debug('Cleaning up any pending library deletions');
const pendingDeletion = await this.repository.getAllDeleted();
await this.jobRepository.queueAll(
pendingDeletion.map((libraryToDelete) => ({ name: JobName.LIBRARY_DELETE, data: { id: libraryToDelete.id } })),
);
return true;
return JobStatus.SUCCESS;
}
async create(auth: AuthDto, dto: CreateLibraryDto): Promise<LibraryResponseDto> {
@ -410,10 +411,10 @@ export class LibraryService extends EventEmitter {
await this.jobRepository.queue({ name: JobName.LIBRARY_DELETE, data: { id } });
}
async handleDeleteLibrary(job: IEntityJob): Promise<boolean> {
async handleDeleteLibrary(job: IEntityJob): Promise<JobStatus> {
const library = await this.repository.get(job.id, true);
if (!library) {
return false;
return JobStatus.FAILED;
}
// TODO use pagination
@ -427,10 +428,10 @@ export class LibraryService extends EventEmitter {
this.logger.log(`Deleting library ${job.id}`);
await this.repository.delete(job.id);
}
return true;
return JobStatus.SUCCESS;
}
async handleAssetRefresh(job: ILibraryFileJob) {
async handleAssetRefresh(job: ILibraryFileJob): Promise<JobStatus> {
const assetPath = path.normalize(job.assetPath);
const existingAssetEntity = await this.assetRepository.getByLibraryIdAndOriginalPath(job.id, assetPath);
@ -445,7 +446,7 @@ export class LibraryService extends EventEmitter {
this.logger.debug(`Marking asset as offline: ${assetPath}`);
await this.assetRepository.save({ id: existingAssetEntity.id, isOffline: true });
return true;
return JobStatus.SUCCESS;
} else {
// File can't be accessed and does not already exist in db
throw new BadRequestException('Cannot access file', { cause: error });
@ -483,7 +484,7 @@ export class LibraryService extends EventEmitter {
if (!doImport && !doRefresh) {
// If we don't import, exit here
return true;
return JobStatus.SKIPPED;
}
let assetType: AssetType;
@ -509,7 +510,7 @@ export class LibraryService extends EventEmitter {
const library = await this.repository.get(job.id, true);
if (library?.deletedAt) {
this.logger.error('Cannot import asset into deleted library');
return false;
return JobStatus.FAILED;
}
const pathHash = this.cryptoRepository.hashSha1(`path:${assetPath}`);
@ -540,7 +541,7 @@ export class LibraryService extends EventEmitter {
});
} else {
// Not importing and not refreshing, do nothing
return true;
return JobStatus.SKIPPED;
}
this.logger.debug(`Queuing metadata extraction for: ${assetPath}`);
@ -551,7 +552,7 @@ export class LibraryService extends EventEmitter {
await this.jobRepository.queue({ name: JobName.VIDEO_CONVERSION, data: { id: assetId } });
}
return true;
return JobStatus.SUCCESS;
}
async queueScan(auth: AuthDto, id: string, dto: ScanLibraryDto) {
@ -584,7 +585,7 @@ export class LibraryService extends EventEmitter {
});
}
async handleQueueAllScan(job: IBaseJob): Promise<boolean> {
async handleQueueAllScan(job: IBaseJob): Promise<JobStatus> {
this.logger.debug(`Refreshing all external libraries: force=${job.force}`);
// Queue cleanup
@ -602,10 +603,10 @@ export class LibraryService extends EventEmitter {
},
})),
);
return true;
return JobStatus.SUCCESS;
}
async handleOfflineRemoval(job: IEntityJob): Promise<boolean> {
async handleOfflineRemoval(job: IEntityJob): Promise<JobStatus> {
const assetPagination = usePagination(JOBS_ASSET_PAGINATION_SIZE, (pagination) =>
this.assetRepository.getWith(pagination, WithProperty.IS_OFFLINE, job.id),
);
@ -617,14 +618,14 @@ export class LibraryService extends EventEmitter {
);
}
return true;
return JobStatus.SUCCESS;
}
async handleQueueAssetRefresh(job: ILibraryRefreshJob): Promise<boolean> {
async handleQueueAssetRefresh(job: ILibraryRefreshJob): Promise<JobStatus> {
const library = await this.repository.get(job.id);
if (!library || library.type !== LibraryType.EXTERNAL) {
this.logger.warn('Can only refresh external libraries');
return false;
return JobStatus.FAILED;
}
this.logger.log(`Refreshing library: ${job.id}`);
@ -694,7 +695,7 @@ export class LibraryService extends EventEmitter {
await this.repository.update({ id: job.id, refreshedAt: new Date() });
return true;
return JobStatus.SUCCESS;
}
private async getPathTrie(library: LibraryEntity): Promise<Trie<string>> {