Skip to content

High performance self-hosted photo and video management solution.

9.3 KB
Raw Blame
import { AdaptiveImageLoader, type QualityList } from '#lib/utils/adaptive-image-loader.svelte.ts';
import { cancelImageUrl } from '#lib/utils/sw-messaging.ts';

vi.mock('#lib/utils/sw-messaging.js', () => ({
  cancelImageUrl: vi.fn(),
}));

function createQualityList(overrides?: {
  onAfterLoad?: Record<string, (loader: AdaptiveImageLoader) => void>;
  onAfterError?: Record<string, (loader: AdaptiveImageLoader) => void>;
}): QualityList {
  return [
    {
      quality: 'thumbnail',
      url: '/thumbnail.jpg',
      onAfterLoad: overrides?.onAfterLoad?.thumbnail,
      onAfterError: overrides?.onAfterError?.thumbnail,
    },
    {
      quality: 'preview',
      url: '/preview.jpg',
      onAfterLoad: overrides?.onAfterLoad?.preview,
      onAfterError: overrides?.onAfterError?.preview,
    },
    {
      quality: 'original',
      url: '/original.jpg',
      onAfterLoad: overrides?.onAfterLoad?.original,
      onAfterError: overrides?.onAfterError?.original,
    },
  ];
}

describe('AdaptiveImageLoader', () => {
  beforeEach(() => {
    vi.clearAllMocks();
  });

  describe('constructor', () => {
    it('initializes with thumbnail URL set', () => {
      const loader = new AdaptiveImageLoader(createQualityList());
      expect(loader.status.urls.thumbnail).toBe('/thumbnail.jpg');
      expect(loader.status.urls.preview).toBeUndefined();
      expect(loader.status.urls.original).toBeUndefined();
    });

    it('initializes all qualities as unloaded', () => {
      const loader = new AdaptiveImageLoader(createQualityList());
      expect(loader.status.quality.thumbnail).toBe('unloaded');
      expect(loader.status.quality.preview).toBe('unloaded');
      expect(loader.status.quality.original).toBe('unloaded');
    });
  });

  describe('onStart', () => {
    it('sets started to true', () => {
      const loader = new AdaptiveImageLoader(createQualityList());
      expect(loader.status.started).toBe(false);
      loader.onStart('thumbnail');
      expect(loader.status.started).toBe(true);
    });

    it('is a no-op after destroy', () => {
      const loader = new AdaptiveImageLoader(createQualityList());
      loader.destroy();
      loader.onStart('thumbnail');
      expect(loader.status.started).toBe(false);
    });
  });

  describe('onLoad', () => {
    it('sets quality to success and calls callbacks', () => {
      const onUrlChange = vi.fn();
      const onImageReady = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onUrlChange, onImageReady });

      loader.onLoad('thumbnail');

      expect(loader.status.quality.thumbnail).toBe('success');
      expect(onUrlChange).toHaveBeenCalledWith('/thumbnail.jpg');
      expect(onImageReady).toHaveBeenCalledOnce();
    });

    it('calls onAfterLoad callback', () => {
      const onAfterLoad = vi.fn();
      const qualityList = createQualityList({ onAfterLoad: { thumbnail: onAfterLoad } });
      const loader = new AdaptiveImageLoader(qualityList);

      loader.onLoad('thumbnail');

      expect(onAfterLoad).toHaveBeenCalledWith(loader);
    });

    it('ignores load if URL is not set', () => {
      const onImageReady = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onImageReady });

      loader.onLoad('preview');

      expect(loader.status.quality.preview).toBe('unloaded');
      expect(onImageReady).not.toHaveBeenCalled();
    });

    it('ignores load if a higher quality is already loaded', () => {
      const onUrlChange = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onUrlChange });

      loader.onLoad('thumbnail');
      loader.trigger('preview');
      loader.onLoad('preview');

      onUrlChange.mockClear();
      loader.onLoad('thumbnail');

      expect(onUrlChange).not.toHaveBeenCalled();
    });

    it('is a no-op after destroy', () => {
      const onImageReady = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onImageReady });

      loader.destroy();
      loader.onLoad('thumbnail');

      expect(onImageReady).not.toHaveBeenCalled();
    });
  });

  describe('onError', () => {
    it('sets quality to error and clears URL', () => {
      const onError = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onError });

      loader.onError('thumbnail');

      expect(loader.status.quality.thumbnail).toBe('error');
      expect(loader.status.urls.thumbnail).toBeUndefined();
      expect(loader.status.hasError).toBe(true);
      expect(onError).toHaveBeenCalledOnce();
    });

    it('calls onAfterError callback', () => {
      const onAfterError = vi.fn();
      const qualityList = createQualityList({ onAfterError: { thumbnail: onAfterError } });
      const loader = new AdaptiveImageLoader(qualityList);

      loader.onError('thumbnail');

      expect(onAfterError).toHaveBeenCalledWith(loader);
    });

    it('is a no-op after destroy', () => {
      const onError = vi.fn();
      const loader = new AdaptiveImageLoader(createQualityList(), { onError });

      loader.destroy();
      loader.onError('thumbnail');

      expect(onError).not.toHaveBeenCalled();
    });
  });

  describe('trigger', () => {
    it('sets the URL for the quality', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      loader.trigger('preview');

      expect(loader.status.urls.preview).toBe('/preview.jpg');
    });

    it('returns true if URL is already set', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      expect(loader.trigger('thumbnail')).toBe(true);
    });

    it('returns false when triggering a new quality', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      expect(loader.trigger('preview')).toBe(false);
    });

    it('clears hasError when triggering', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      loader.onError('thumbnail');
      expect(loader.status.hasError).toBe(true);

      loader.trigger('preview');
      expect(loader.status.hasError).toBe(false);
    });

    it('calls imageLoader when provided', () => {
      const imageLoader = vi.fn(() => vi.fn());
      const loader = new AdaptiveImageLoader(createQualityList(), undefined, imageLoader);

      loader.trigger('preview');

      expect(imageLoader).toHaveBeenCalledWith(
        '/preview.jpg',
        expect.any(Function),
        expect.any(Function),
        expect.any(Function),
      );
    });

    it('returns false after destroy', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      loader.destroy();

      expect(loader.trigger('preview')).toBe(false);
    });

    it('calls onAfterError if URL is empty', () => {
      const onAfterError = vi.fn();
      const qualityList = createQualityList({ onAfterError: { preview: onAfterError } });
      (qualityList[1] as { url: string }).url = '';
      const loader = new AdaptiveImageLoader(qualityList);

      expect(loader.trigger('preview')).toBe(false);
      expect(onAfterError).toHaveBeenCalledWith(loader);
    });
  });

  describe('start', () => {
    it('throws if no imageLoader is provided', () => {
      const loader = new AdaptiveImageLoader(createQualityList());
      expect(() => loader.start()).toThrow('Start requires imageLoader to be specified');
    });

    it('calls imageLoader with thumbnail URL', () => {
      const imageLoader = vi.fn(() => vi.fn());
      const loader = new AdaptiveImageLoader(createQualityList(), undefined, imageLoader);

      loader.start();

      expect(imageLoader).toHaveBeenCalledWith(
        '/thumbnail.jpg',
        expect.any(Function),
        expect.any(Function),
        expect.any(Function),
      );
    });
  });

  describe('destroy', () => {
    it('cancels all image URLs when no imageLoader', () => {
      const loader = new AdaptiveImageLoader(createQualityList());

      loader.destroy();

      expect(cancelImageUrl).toHaveBeenCalledWith('/thumbnail.jpg');
      expect(cancelImageUrl).toHaveBeenCalledWith('/preview.jpg');
      expect(cancelImageUrl).toHaveBeenCalledWith('/original.jpg');
    });

    it('calls destroy functions when imageLoader is provided', () => {
      const destroyFn = vi.fn();
      const imageLoader = vi.fn(() => destroyFn);
      const loader = new AdaptiveImageLoader(createQualityList(), undefined, imageLoader);

      loader.start();
      loader.destroy();

      expect(destroyFn).toHaveBeenCalledOnce();
      expect(cancelImageUrl).not.toHaveBeenCalled();
    });
  });

  describe('progressive loading flow', () => {
    it('thumbnail load triggers preview via onAfterLoad', () => {
      const triggerSpy = vi.fn();
      const qualityList = createQualityList({
        onAfterLoad: {
          thumbnail: (loader) => {
            triggerSpy();
            loader.trigger('preview');
          },
        },
      });
      const loader = new AdaptiveImageLoader(qualityList);

      loader.onLoad('thumbnail');

      expect(triggerSpy).toHaveBeenCalledOnce();
      expect(loader.status.urls.preview).toBe('/preview.jpg');
    });

    it('thumbnail error triggers preview via onAfterError', () => {
      const qualityList = createQualityList({
        onAfterError: {
          thumbnail: (loader) => loader.trigger('preview'),
        },
      });
      const loader = new AdaptiveImageLoader(qualityList);

      loader.onError('thumbnail');

      expect(loader.status.urls.preview).toBe('/preview.jpg');
    });
  });
});