WebSocketSubscription2021.test.ts

import { AccessMode } from '../../../../../src/authorization/permissions/Permissions';
import {
  AbsolutePathInteractionRoute,
} from '../../../../../src/identity/interaction/routing/AbsolutePathInteractionRoute';
import type { Subscription } from '../../../../../src/server/notifications/Subscription';
import type { SubscriptionStorage } from '../../../../../src/server/notifications/SubscriptionStorage';
import {
  WebSocketSubscription2021,
} from '../../../../../src/server/notifications/WebSocketSubscription2021/WebSocketSubscription2021';
import { IdentifierSetMultiMap } from '../../../../../src/util/map/IdentifierMap';
import { readJsonStream } from '../../../../../src/util/StreamUtil';

describe('A WebSocketSubscription2021', (): void => {
  let subscription: Subscription;
  let storage: jest.Mocked<SubscriptionStorage>;
  const route = new AbsolutePathInteractionRoute('http://example.com/foo');
  let subscriptionType: WebSocketSubscription2021;

  beforeEach(async(): Promise<void> => {
    subscription = {
      '@context': [ 'https://www.w3.org/ns/solid/notification/v1' ],
      type: 'WebSocketSubscription2021',
      topic: 'https://storage.example/resource',
      state: undefined,
      startAt: undefined,
      endAt: undefined,
      accept: undefined,
      rate: undefined,
    };

    storage = {
      create: jest.fn().mockReturnValue({
        id: '123',
        topic: 'http://example.com/foo',
        type: 'WebSocketSubscription2021',
        lastEmit: 0,
        features: {},
      }),
      add: jest.fn(),
    } as any;

    subscriptionType = new WebSocketSubscription2021(storage, route);
  });

  it('has the correct type.', async(): Promise<void> => {
    expect(subscriptionType.type).toBe('WebSocketSubscription2021');
  });

  it('correctly parses subscriptions.', async(): Promise<void> => {
    await expect(subscriptionType.schema.isValid(subscription)).resolves.toBe(true);

    subscription.type = 'something else';
    await expect(subscriptionType.schema.isValid(subscription)).resolves.toBe(false);
  });

  it('requires Read permissions on the topic.', async(): Promise<void> => {
    await expect(subscriptionType.extractModes(subscription)).resolves
      .toEqual(new IdentifierSetMultiMap([[{ path: subscription.topic }, AccessMode.read ]]));
  });

  it('stores the info and returns a valid response when subscribing.', async(): Promise<void> => {
    const { response } = await subscriptionType.subscribe(subscription);
    expect(response.metadata.contentType).toBe('application/ld+json');
    await expect(readJsonStream(response.data)).resolves.toEqual({
      '@context': [ 'https://www.w3.org/ns/solid/notification/v1' ],
      type: 'WebSocketSubscription2021',
      source: expect.stringMatching(/^ws:\/\/example.com\/foo\?auth=.+/u),
    });
  });
});