axios-cache-interceptor/test/storage/storages.ts

import type { AxiosStorage, CachedStorageValue } from '../../src/storage/types';
import { EMPTY_RESPONSE } from '../utils';

export function testStorage(name: string, Storage: () => AxiosStorage): void {
  it(`tests ${name} storage methods`, async () => {
    const storage = Storage();

    const result = await storage.get('key');

    expect(result).not.toBeNull();
    expect(result.state).toBe('empty');

    await storage.set('key', {
      state: 'cached',
      createdAt: Date.now(),
      ttl: 1000 * 60 * 5,
      data: { ...EMPTY_RESPONSE, data: 'data' }
    });

    const result2 = await storage.get('key');

    expect(result2).not.toBeNull();
    expect(result2.state).toBe('cached');
    expect(result2.data?.data).toBe('data');

    await storage.remove('key');

    const result3 = await storage.get('key');

    expect(result3).not.toBeNull();
    expect(result3.state).toBe('empty');
  });

  it(`tests ${name} storage staling`, async () => {
    jest.useFakeTimers('modern');
    const storage = Storage();

    await storage.set('key', {
      state: 'cached',
      createdAt: Date.now(),
      ttl: 1000 * 60 * 5, // 5 Minutes
      data: { ...EMPTY_RESPONSE, data: 'data' }
    });

    const result = await storage.get('key');

    expect(result).not.toBeNull();
    expect(result.state).toBe('cached');
    expect(result.data?.data).toBe('data');

    // Advance 6 minutes in time
    jest.setSystemTime(Date.now() + 1000 * 60 * 6);

    const result2 = await storage.get('key');

    expect(result2).not.toBeNull();
    expect(result2.state).toBe('empty');

    jest.useRealTimers();
  });

  // Expects that when a result returned by storage.get() has his inner properties updated,
  // a new request to storage.get() should maintain the same value.
  //
  // https://github.com/arthurfiorette/axios-cache-interceptor/issues/163
  it(`tests ${name} to not allow changes by value reference`, async () => {
    const storage = Storage();

    await storage.set('key', {
      state: 'cached',
      createdAt: Date.now(),
      ttl: 1000 * 60 * 5, // 5 Minutes
      data: { ...EMPTY_RESPONSE, data: 'data' }
    });

    const result = (await storage.get('key')) as CachedStorageValue;

    expect(result).not.toBeNull();
    expect(result.state).toBe('cached');
    expect(result.data.data).toBe('data');

    // Deletes the value
    delete result.data.data;

    // Check if the value has been modified
    const result2 = await storage.get('key');

    expect(result2).not.toBeNull();
    expect(result2.state).toBe('cached');
    expect(result2.data?.data).toBe('data');
  });
}