shlink-web-client/test/api/services/ShlinkApiClient.test.ts

import { AxiosError, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Mock } from 'ts-mockery';
import { ShlinkApiClient } from '../../../src/api/services/ShlinkApiClient';
import { OptionalString } from '../../../src/utils/utils';
import { ShlinkDomain, ShlinkVisitsOverview } from '../../../src/api/types';
import { ShortUrl, ShortUrlsOrder } from '../../../src/short-urls/data';
import { Visit } from '../../../src/visits/types';

describe('ShlinkApiClient', () => {
  const createAxios = (data: AxiosRequestConfig) => (async () => Promise.resolve(data)) as unknown as AxiosInstance;
  const createAxiosMock = (data: AxiosRequestConfig = {}) => jest.fn(createAxios(data)) as unknown as AxiosInstance;
  const createApiClient = (data: AxiosRequestConfig) => new ShlinkApiClient(createAxios(data), '', '');
  const shortCodesWithDomainCombinations: [ string, OptionalString ][] = [
    ['abc123', null],
    ['abc123', undefined],
    ['abc123', 'example.com'],
  ];

  describe('listShortUrls', () => {
    const expectedList = ['foo', 'bar'];

    it('properly returns short URLs list', async () => {
      const { listShortUrls } = createApiClient({
        data: {
          shortUrls: expectedList,
        },
      });

      const actualList = await listShortUrls();

      expect(expectedList).toEqual(actualList);
    });

    it.each([
      [{ field: 'visits', dir: 'DESC' } as ShortUrlsOrder, 'visits-DESC'],
      [{ field: 'longUrl', dir: 'ASC' } as ShortUrlsOrder, 'longUrl-ASC'],
      [{ field: 'longUrl', dir: undefined } as ShortUrlsOrder, undefined],
    ])('parses orderBy in params', async (orderBy, expectedOrderBy) => {
      const axiosSpy = createAxiosMock({
        data: expectedList,
      });
      const { listShortUrls } = new ShlinkApiClient(axiosSpy, '', '');

      await listShortUrls({ orderBy });

      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        params: { orderBy: expectedOrderBy },
      }));
    });
  });

  describe('createShortUrl', () => {
    const shortUrl = {
      bar: 'foo',
    };

    it('returns create short URL', async () => {
      const { createShortUrl } = createApiClient({ data: shortUrl });
      const result = await createShortUrl({ longUrl: '' });

      expect(result).toEqual(shortUrl);
    });

    it('removes all empty options', async () => {
      const axiosSpy = createAxiosMock({ data: shortUrl });
      const { createShortUrl } = new ShlinkApiClient(axiosSpy, '', '');

      await createShortUrl({ longUrl: 'bar', customSlug: undefined, maxVisits: null });

      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({ data: { longUrl: 'bar' } }));
    });
  });

  describe('getShortUrlVisits', () => {
    it('properly returns short URL visits', async () => {
      const expectedVisits = ['foo', 'bar'];
      const axiosSpy = createAxiosMock({
        data: {
          visits: {
            data: expectedVisits,
          },
        },
      });
      const { getShortUrlVisits } = new ShlinkApiClient(axiosSpy, '', '');

      const actualVisits = await getShortUrlVisits('abc123', {});

      expect({ data: expectedVisits }).toEqual(actualVisits);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/short-urls/abc123/visits'),
        method: 'GET',
      }));
    });
  });

  describe('getTagVisits', () => {
    it('properly returns tag visits', async () => {
      const expectedVisits = ['foo', 'bar'];
      const axiosSpy = createAxiosMock({
        data: {
          visits: {
            data: expectedVisits,
          },
        },
      });
      const { getTagVisits } = new ShlinkApiClient(axiosSpy, '', '');

      const actualVisits = await getTagVisits('foo', {});

      expect({ data: expectedVisits }).toEqual(actualVisits);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/tags/foo/visits'),
        method: 'GET',
      }));
    });
  });

  describe('getDomainVisits', () => {
    it('properly returns domain visits', async () => {
      const expectedVisits = ['foo', 'bar'];
      const axiosSpy = createAxiosMock({
        data: {
          visits: {
            data: expectedVisits,
          },
        },
      });
      const { getDomainVisits } = new ShlinkApiClient(axiosSpy, '', '');

      const actualVisits = await getDomainVisits('foo.com', {});

      expect({ data: expectedVisits }).toEqual(actualVisits);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/domains/foo.com/visits'),
        method: 'GET',
      }));
    });
  });

  describe('getShortUrl', () => {
    it.each(shortCodesWithDomainCombinations)('properly returns short URL', async (shortCode, domain) => {
      const expectedShortUrl = { foo: 'bar' };
      const axiosSpy = createAxiosMock({
        data: expectedShortUrl,
      });
      const { getShortUrl } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await getShortUrl(shortCode, domain);

      expect(expectedShortUrl).toEqual(result);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining(`/short-urls/${shortCode}`),
        method: 'GET',
        params: domain ? { domain } : {},
      }));
    });
  });

  describe('updateShortUrl', () => {
    it.each(shortCodesWithDomainCombinations)('properly updates short URL meta', async (shortCode, domain) => {
      const meta = {
        maxVisits: 50,
        validSince: '2025-01-01T10:00:00+01:00',
      };
      const expectedResp = Mock.of<ShortUrl>();
      const axiosSpy = createAxiosMock({ data: expectedResp });
      const { updateShortUrl } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await updateShortUrl(shortCode, domain, meta);

      expect(expectedResp).toEqual(result);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining(`/short-urls/${shortCode}`),
        method: 'PATCH',
        params: domain ? { domain } : {},
      }));
    });
  });

  describe('listTags', () => {
    it('properly returns list of tags', async () => {
      const expectedTags = ['foo', 'bar'];
      const axiosSpy = createAxiosMock({
        data: {
          tags: { data: expectedTags },
        },
      });
      const { listTags } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await listTags();

      expect({ tags: expectedTags }).toEqual(result);
      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/tags'),
        method: 'GET',
      }));
    });
  });

  describe('deleteTags', () => {
    it('properly deletes provided tags', async () => {
      const tags = ['foo', 'bar'];
      const axiosSpy = createAxiosMock();
      const { deleteTags } = new ShlinkApiClient(axiosSpy, '', '');

      await deleteTags(tags);

      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/tags'),
        method: 'DELETE',
        params: { tags },
      }));
    });
  });

  describe('editTag', () => {
    it('properly edits provided tag', async () => {
      const oldName = 'foo';
      const newName = 'bar';
      const axiosSpy = createAxiosMock();
      const { editTag } = new ShlinkApiClient(axiosSpy, '', '');

      await editTag(oldName, newName);

      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining('/tags'),
        method: 'PUT',
        data: { oldName, newName },
      }));
    });
  });

  describe('deleteShortUrl', () => {
    it.each(shortCodesWithDomainCombinations)('properly deletes provided short URL', async (shortCode, domain) => {
      const axiosSpy = createAxiosMock({});
      const { deleteShortUrl } = new ShlinkApiClient(axiosSpy, '', '');

      await deleteShortUrl(shortCode, domain);

      expect(axiosSpy).toHaveBeenCalledWith(expect.objectContaining({
        url: expect.stringContaining(`/short-urls/${shortCode}`),
        method: 'DELETE',
        params: domain ? { domain } : {},
      }));
    });
  });

  describe('health', () => {
    it('returns health data', async () => {
      const expectedData = {
        status: 'pass',
        version: '1.19.0',
      };
      const axiosSpy = createAxiosMock({ data: expectedData });
      const { health } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await health();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('mercureInfo', () => {
    it('returns mercure info', async () => {
      const expectedData = {
        token: 'abc.123.def',
        mercureHubUrl: 'http://example.com/.well-known/mercure',
      };
      const axiosSpy = createAxiosMock({ data: expectedData });
      const { mercureInfo } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await mercureInfo();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('listDomains', () => {
    it('returns domains', async () => {
      const expectedData = { data: [Mock.all<ShlinkDomain>(), Mock.all<ShlinkDomain>()] };
      const resp = { domains: expectedData };
      const axiosSpy = createAxiosMock({ data: resp });
      const { listDomains } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await listDomains();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('getVisitsOverview', () => {
    it('returns visits overview', async () => {
      const expectedData = Mock.all<ShlinkVisitsOverview>();
      const resp = { visits: expectedData };
      const axiosSpy = createAxiosMock({ data: resp });
      const { getVisitsOverview } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await getVisitsOverview();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('getOrphanVisits', () => {
    it('returns orphan visits', async () => {
      const expectedData: Visit[] = [];
      const resp = { visits: expectedData };
      const axiosSpy = createAxiosMock({ data: resp });
      const { getOrphanVisits } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await getOrphanVisits();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('getNonOrphanVisits', () => {
    it('returns non-orphan visits', async () => {
      const expectedData: Visit[] = [];
      const resp = { visits: expectedData };
      const axiosSpy = createAxiosMock({ data: resp });
      const { getNonOrphanVisits } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await getNonOrphanVisits();

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(expectedData);
    });
  });

  describe('editDomainRedirects', () => {
    it('returns the redirects', async () => {
      const resp = { baseUrlRedirect: null, regular404Redirect: 'foo', invalidShortUrlRedirect: 'bar' };
      const axiosSpy = createAxiosMock({ data: resp });
      const { editDomainRedirects } = new ShlinkApiClient(axiosSpy, '', '');

      const result = await editDomainRedirects({ domain: 'foo' });

      expect(axiosSpy).toHaveBeenCalled();
      expect(result).toEqual(resp);
    });

    it('retries request if API version is not supported', async () => {
      const axiosSpy = jest.fn()
        .mockImplementationOnce(() => Promise.reject(Mock.of<AxiosError>({
          response: {
            data: { type: 'NOT_FOUND', status: 404 },
          },
        })))
        .mockImplementation(createAxios({})) as unknown as AxiosInstance;
      const { editDomainRedirects } = new ShlinkApiClient(axiosSpy, '', '');

      await editDomainRedirects({ domain: 'foo' });

      expect(axiosSpy).toHaveBeenCalledTimes(2);
      expect(axiosSpy).toHaveBeenNthCalledWith(1, expect.objectContaining({
        url: expect.stringContaining('/v3/'),
      }));
      expect(axiosSpy).toHaveBeenNthCalledWith(2, expect.objectContaining({
        url: expect.stringContaining('/v2/'),
      }));
    });
  });
});