Skip to content

High performance self-hosted photo and video management solution.

refactor: rename image cancel method (#26381)

Min Idzelis062546c16822
diff --git a/web/src/lib/components/Image.svelte b/web/src/lib/components/Image.svelte
index 801a466ca8..417af56192 100644
--- a/web/src/lib/components/Image.svelte
+++ b/web/src/lib/components/Image.svelte
@@ -1,5 +1,5 @@
<script lang="ts">
- import { imageManager } from '$lib/managers/ImageManager.svelte';
+ import { cancelImageUrl } from '$lib/utils/sw-messaging';
import { onDestroy, untrack } from 'svelte';
import type { HTMLImgAttributes } from 'svelte/elements';
@@ -28,7 +28,7 @@
onDestroy(() => {
destroyed = true;
if (capturedSource !== undefined) {
- imageManager.cancelPreloadUrl(capturedSource);
+ cancelImageUrl(capturedSource);
}
});
diff --git a/web/src/lib/components/asset-viewer/photo-viewer.svelte b/web/src/lib/components/asset-viewer/photo-viewer.svelte
index 61181acbc8..95f3d7a73c 100644
--- a/web/src/lib/components/asset-viewer/photo-viewer.svelte
+++ b/web/src/lib/components/asset-viewer/photo-viewer.svelte
@@ -159,7 +159,7 @@
imageError = imageLoaded = true;
};
- onDestroy(() => imageManager.cancelPreloadUrl(imageLoaderUrl));
+ onDestroy(() => imageManager.cancel(asset, targetImageSize));
let imageLoaderUrl = $derived(
getAssetUrl({ asset, sharedLink, forceOriginal: originalImageLoaded || assetViewerManager.zoom > 1 }),
diff --git a/web/src/lib/managers/ImageManager.spec.ts b/web/src/lib/managers/ImageManager.spec.ts
new file mode 100644
index 0000000000..6147b3ac6f
--- /dev/null
+++ b/web/src/lib/managers/ImageManager.spec.ts
@@ -0,0 +1,99 @@
+import { imageManager } from '$lib/managers/ImageManager.svelte';
+import { getAssetMediaUrl } from '$lib/utils';
+import { cancelImageUrl } from '$lib/utils/sw-messaging';
+import { AssetMediaSize } from '@immich/sdk';
+import { assetFactory } from '@test-data/factories/asset-factory';
+
+vi.mock('$lib/utils/sw-messaging', () => ({
+ cancelImageUrl: vi.fn(),
+}));
+
+vi.mock('$lib/utils', () => ({
+ getAssetMediaUrl: vi.fn(),
+}));
+
+describe('ImageManager', () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ });
+
+ describe('preload', () => {
+ it('creates an Image with the correct URL', () => {
+ vi.mocked(getAssetMediaUrl).mockReturnValue('/api/assets/123/media');
+ const asset = assetFactory.build();
+
+ imageManager.preload(asset);
+
+ expect(getAssetMediaUrl).toHaveBeenCalledWith({
+ id: asset.id,
+ size: AssetMediaSize.Preview,
+ cacheKey: asset.thumbhash,
+ });
+ });
+
+ it('does nothing for undefined asset', () => {
+ imageManager.preload(undefined);
+ expect(getAssetMediaUrl).not.toHaveBeenCalled();
+ });
+
+ it('does nothing when getAssetMediaUrl returns falsy', () => {
+ vi.mocked(getAssetMediaUrl).mockReturnValue('');
+ const asset = assetFactory.build();
+
+ imageManager.preload(asset);
+
+ expect(getAssetMediaUrl).toHaveBeenCalled();
+ });
+
+ it('uses the specified size', () => {
+ vi.mocked(getAssetMediaUrl).mockReturnValue('/api/assets/123/media');
+ const asset = assetFactory.build();
+
+ imageManager.preload(asset, AssetMediaSize.Thumbnail);
+
+ expect(getAssetMediaUrl).toHaveBeenCalledWith({
+ id: asset.id,
+ size: AssetMediaSize.Thumbnail,
+ cacheKey: asset.thumbhash,
+ });
+ });
+ });
+
+ describe('cancel', () => {
+ it('calls cancelImageUrl with the correct URL', () => {
+ vi.mocked(getAssetMediaUrl).mockReturnValue('/api/assets/123/media');
+ const asset = assetFactory.build();
+
+ imageManager.cancel(asset, AssetMediaSize.Preview);
+
+ expect(cancelImageUrl).toHaveBeenCalledWith('/api/assets/123/media');
+ });
+
+ it('does nothing for undefined asset', () => {
+ imageManager.cancel(undefined);
+ expect(getAssetMediaUrl).not.toHaveBeenCalled();
+ expect(cancelImageUrl).not.toHaveBeenCalled();
+ });
+
+ it('cancels all sizes when size is "all"', () => {
+ vi.mocked(getAssetMediaUrl).mockImplementation(({ size }) => `/api/assets/123/${size}`);
+ const asset = assetFactory.build();
+
+ imageManager.cancel(asset, 'all');
+
+ expect(getAssetMediaUrl).toHaveBeenCalledTimes(Object.values(AssetMediaSize).length);
+ for (const size of Object.values(AssetMediaSize)) {
+ expect(cancelImageUrl).toHaveBeenCalledWith(`/api/assets/123/${size}`);
+ }
+ });
+
+ it('does not call cancelImageUrl when URL is falsy', () => {
+ vi.mocked(getAssetMediaUrl).mockReturnValue('');
+ const asset = assetFactory.build();
+
+ imageManager.cancel(asset, AssetMediaSize.Preview);
+
+ expect(cancelImageUrl).not.toHaveBeenCalled();
+ });
+ });
+});
diff --git a/web/src/lib/managers/ImageManager.svelte.ts b/web/src/lib/managers/ImageManager.svelte.ts
index e75b5bc971..004974d677 100644
--- a/web/src/lib/managers/ImageManager.svelte.ts
+++ b/web/src/lib/managers/ImageManager.svelte.ts
@@ -32,12 +32,6 @@ class ImageManager {
}
}
}
-
- cancelPreloadUrl(url: string | undefined) {
- if (url) {
- cancelImageUrl(url);
- }
- }
}
export const imageManager = new ImageManager();