CommunitySolidServer/test/unit/server/notifications/KeyValueSubscriptionStorage.test.ts

import { v4 } from 'uuid';
import type { ResourceIdentifier } from '../../../../src/http/representation/ResourceIdentifier';
import type { Logger } from '../../../../src/logging/Logger';
import { getLoggerFor } from '../../../../src/logging/LogUtil';
import { KeyValueSubscriptionStorage } from '../../../../src/server/notifications/KeyValueSubscriptionStorage';
import type { Subscription } from '../../../../src/server/notifications/Subscription';
import type { SubscriptionInfo } from '../../../../src/server/notifications/SubscriptionStorage';
import type { KeyValueStorage } from '../../../../src/storage/keyvalue/KeyValueStorage';
import type { ReadWriteLocker } from '../../../../src/util/locking/ReadWriteLocker';
import resetAllMocks = jest.resetAllMocks;

jest.mock('uuid', (): any => ({ v4: (): string => '4c9b88c1-7502-4107-bb79-2a3a590c7aa3' }));
jest.mock('../../../../src/logging/LogUtil', (): any => {
  const logger: Logger = { info: jest.fn(), error: jest.fn() } as any;
  return { getLoggerFor: (): Logger => logger };
});

describe('A KeyValueSubscriptionStorage', (): void => {
  const logger = getLoggerFor('mock');
  const topic = 'http://example.com/foo';
  const identifier = { path: topic };
  const subscription = {
    '@context': [ 'https://www.w3.org/ns/solid/notification/v1' ],
    type: 'WebSocketSubscription2021',
    topic,
  } as Subscription;
  const features = { aa: 'bb' };
  let info: SubscriptionInfo<Record<string, string>>;
  let internalMap: Map<string, any>;
  let internalStorage: KeyValueStorage<string, any>;
  let locker: ReadWriteLocker;
  let storage: KeyValueSubscriptionStorage<Record<string, string>>;

  beforeEach(async(): Promise<void> => {
    resetAllMocks();
    info = {
      id: `WebSocketSubscription2021:${v4()}:http://example.com/foo`,
      topic,
      type: 'WebSocketSubscription2021',
      features,
      lastEmit: 0,
    };

    internalMap = new Map();
    internalStorage = internalMap as any;

    locker = {
      withWriteLock: jest.fn(async <T,>(id: ResourceIdentifier, whileLocked: () => T | Promise<T>):
      Promise<T> => whileLocked()),
      withReadLock: jest.fn(),
    };

    storage = new KeyValueSubscriptionStorage(internalStorage, locker);
  });

  describe('#create', (): void => {
    it('creates info based on a subscription.', async(): Promise<void> => {
      expect(storage.create(subscription, features)).toEqual(info);
    });
  });

  describe('#get', (): void => {
    it('returns undefined if there is no match.', async(): Promise<void> => {
      await expect(storage.get('notexists')).resolves.toBeUndefined();
    });

    it('returns the matching info.', async(): Promise<void> => {
      await storage.add(info);
      await expect(storage.get(info.id)).resolves.toEqual(info);
    });

    it('deletes expired info.', async(): Promise<void> => {
      info.expiration = 0;
      await storage.add(info);
      await expect(storage.get(info.id)).resolves.toBeUndefined();
      expect(internalMap.size).toBe(0);
    });
  });

  describe('#getAll', (): void => {
    it('returns an empty array if there is no match.', async(): Promise<void> => {
      await expect(storage.getAll(identifier)).resolves.toEqual([]);
    });

    it('returns the identifiers of all the matching infos.', async(): Promise<void> => {
      await storage.add(info);
      await expect(storage.getAll(identifier)).resolves.toEqual([ info.id ]);
    });
  });

  describe('#add', (): void => {
    it('adds the info and adds its id to the topic collection.', async(): Promise<void> => {
      await expect(storage.add(info)).resolves.toBeUndefined();
      expect(internalMap.size).toBe(2);
      expect([ ...internalMap.values() ]).toEqual(expect.arrayContaining([
        [ info.id ],
        info,
      ]));
    });
  });

  describe('#update', (): void => {
    it('changes the info.', async(): Promise<void> => {
      await storage.add(info);
      const newInfo = {
        ...info,
        state: '123456',
      };
      await expect(storage.update(newInfo)).resolves.toBeUndefined();
      expect([ ...internalMap.values() ]).toEqual(expect.arrayContaining([
        [ info.id ],
        newInfo,
      ]));
    });

    it('rejects update requests that change the topic.', async(): Promise<void> => {
      await storage.add(info);
      const newInfo = {
        ...info,
        topic: 'http://example.com/other',
      };
      await expect(storage.update(newInfo)).rejects.toThrow(`Trying to change the topic of subscription ${info.id}`);
    });

    it('rejects update request targeting a non-info value.', async(): Promise<void> => {
      await storage.add(info);
      // Looking for the key so this test doesn't depend on the internal keys used
      const id = [ ...internalMap.entries() ].find((entry): boolean => Array.isArray(entry[1]))![0];
      const newInfo = {
        ...info,
        id,
      };
      await expect(storage.update(newInfo)).rejects.toThrow(`Trying to update ${id} which is not a SubscriptionInfo.`);
    });
  });

  describe('#delete', (): void => {
    it('removes the info and its reference.', async(): Promise<void> => {
      const info2 = {
        ...info,
        id: 'differentId',
      };
      await storage.add(info);
      await storage.add(info2);
      expect(internalMap.size).toBe(3);
      await expect(storage.delete(info.id)).resolves.toBeUndefined();
      expect(internalMap.size).toBe(2);
      expect([ ...internalMap.values() ]).toEqual(expect.arrayContaining([
        [ info2.id ],
        info2,
      ]));
    });

    it('removes the references for an identifier if the array is empty.', async(): Promise<void> => {
      await storage.add(info);
      await expect(storage.delete(info.id)).resolves.toBeUndefined();
      expect(internalMap.size).toBe(0);
    });

    it('does nothing if the target does not exist.', async(): Promise<void> => {
      await expect(storage.delete(info.id)).resolves.toBeUndefined();
    });

    it('logs an error if the target can not be found in the list of references.', async(): Promise<void> => {
      await storage.add(info);
      // Looking for the key so this test doesn't depend on the internal keys used
      const id = [ ...internalMap.entries() ].find((entry): boolean => Array.isArray(entry[1]))![0];
      internalMap.set(id, []);
      await expect(storage.delete(info.id)).resolves.toBeUndefined();
      expect(logger.error).toHaveBeenCalledTimes(2);
    });
  });
});