chore: use force instead of forceRefresh (#4394)

This commit is contained in:
Jason Rasmussen 2023-10-08 23:16:13 -04:00 committed by GitHub
parent 687d896c63
commit d8e66acd02
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 23 deletions

View file

@ -23,7 +23,6 @@ export interface IOfflineLibraryFileJob extends IEntityJob {
export interface ILibraryFileJob extends IEntityJob { export interface ILibraryFileJob extends IEntityJob {
ownerId: string; ownerId: string;
assetPath: string; assetPath: string;
forceRefresh: boolean;
} }
export interface ILibraryRefreshJob extends IEntityJob { export interface ILibraryRefreshJob extends IEntityJob {

View file

@ -99,7 +99,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: libraryStub.externalLibrary1.owner.id, ownerId: libraryStub.externalLibrary1.owner.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}, },
}, },
], ],
@ -174,7 +174,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/file.xyz', assetPath: '/data/user1/file.xyz',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);
@ -187,7 +187,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/file.xyz', assetPath: '/data/user1/file.xyz',
forceRefresh: false, force: false,
}; };
await expect(sut.handleAssetRefresh(mockLibraryJob)).rejects.toBeInstanceOf(BadRequestException); await expect(sut.handleAssetRefresh(mockLibraryJob)).rejects.toBeInstanceOf(BadRequestException);
@ -198,7 +198,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);
@ -245,7 +245,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);
@ -293,7 +293,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/video.mp4', assetPath: '/data/user1/video.mp4',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);
@ -348,7 +348,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);
@ -365,7 +365,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
storageMock.stat.mockResolvedValue({ storageMock.stat.mockResolvedValue({
@ -386,7 +386,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image);
@ -417,7 +417,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false); expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false);
@ -431,7 +431,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false); expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false);
@ -445,7 +445,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/etc/rootpassword.jpg', assetPath: '/etc/rootpassword.jpg',
forceRefresh: false, force: false,
}; };
expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false); expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false);
@ -459,7 +459,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/../../etc/rootpassword.jpg', assetPath: '/data/user1/../../etc/rootpassword.jpg',
forceRefresh: false, force: false,
}; };
expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false); expect(sut.handleAssetRefresh(mockLibraryJob)).resolves.toBe(false);
@ -472,7 +472,7 @@ describe(LibraryService.name, () => {
id: assetStub.image.id, id: assetStub.image.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image);
@ -489,7 +489,7 @@ describe(LibraryService.name, () => {
id: assetStub.offline.id, id: assetStub.offline.id,
ownerId: mockUser.id, ownerId: mockUser.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.offline); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.offline);
@ -520,7 +520,7 @@ describe(LibraryService.name, () => {
id: assetStub.image.id, id: assetStub.image.id,
ownerId: assetStub.image.ownerId, ownerId: assetStub.image.ownerId,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image);
@ -536,7 +536,7 @@ describe(LibraryService.name, () => {
id: assetStub.image.id, id: assetStub.image.id,
ownerId: assetStub.image.ownerId, ownerId: assetStub.image.ownerId,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: true, force: true,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(assetStub.image);
@ -558,7 +558,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: userStub.admin.id, ownerId: userStub.admin.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
storageMock.stat.mockResolvedValue({ storageMock.stat.mockResolvedValue({
@ -585,7 +585,7 @@ describe(LibraryService.name, () => {
id: libraryStub.externalLibrary1.id, id: libraryStub.externalLibrary1.id,
ownerId: userStub.admin.id, ownerId: userStub.admin.id,
assetPath: '/data/user1/photo.jpg', assetPath: '/data/user1/photo.jpg',
forceRefresh: false, force: false,
}; };
assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null); assetMock.getByLibraryIdAndOriginalPath.mockResolvedValue(null);

View file

@ -186,7 +186,7 @@ export class LibraryService {
let doImport = false; let doImport = false;
let doRefresh = false; let doRefresh = false;
if (job.forceRefresh) { if (job.force) {
doRefresh = true; doRefresh = true;
} }
@ -200,7 +200,7 @@ export class LibraryService {
`File modification time has changed, re-importing asset: ${assetPath}. Old mtime: ${existingAssetEntity.fileModifiedAt}. New mtime: ${stats.mtime}`, `File modification time has changed, re-importing asset: ${assetPath}. Old mtime: ${existingAssetEntity.fileModifiedAt}. New mtime: ${stats.mtime}`,
); );
doRefresh = true; doRefresh = true;
} else if (!job.forceRefresh && stats && !existingAssetEntity.isOffline) { } else if (!job.force && stats && !existingAssetEntity.isOffline) {
// Asset exists on disk and in db and mtime has not changed. Also, we are not forcing refresn. Therefore, do nothing // Asset exists on disk and in db and mtime has not changed. Also, we are not forcing refresn. Therefore, do nothing
this.logger.debug(`Asset already exists in database and on disk, will not import: ${assetPath}`); this.logger.debug(`Asset already exists in database and on disk, will not import: ${assetPath}`);
} }
@ -410,7 +410,7 @@ export class LibraryService {
id: job.id, id: job.id,
assetPath: path.normalize(assetPath), assetPath: path.normalize(assetPath),
ownerId: library.ownerId, ownerId: library.ownerId,
forceRefresh: job.refreshAllFiles ?? false, force: job.refreshAllFiles ?? false,
}; };
await this.jobRepository.queue({ name: JobName.LIBRARY_SCAN_ASSET, data: libraryJobData }); await this.jobRepository.queue({ name: JobName.LIBRARY_SCAN_ASSET, data: libraryJobData });