dspace-angular/src/app/core/shared/operators.spec.ts

import { cold, getTestScheduler, hot } from 'jasmine-marbles';
import { TestScheduler } from 'rxjs/testing';
import { getMockRequestService } from '../../shared/mocks/request.service.mock';
import { GetRequest } from '../data/request.models';
import { RequestEntry } from '../data/request.reducer';
import { RequestService } from '../data/request.service';
import {
  configureRequest,
  filterSuccessfulResponses,
  getAllSucceededRemoteData,
  getRemoteDataPayload,
  getRequestFromRequestHref,
  getRequestFromRequestUUID,
  getResourceLinksFromResponse,
  getResponseFromEntry,
  getSucceededRemoteData,
  redirectOn404Or401
} from './operators';
import { RemoteData } from '../data/remote-data';
import { RemoteDataError } from '../data/remote-data-error';
import { of as observableOf } from 'rxjs';
import {
  createFailedRemoteDataObject,
  createSuccessfulRemoteDataObject
} from '../../shared/remote-data.utils';

fdescribe('Core Module - RxJS Operators', () => {
  let scheduler: TestScheduler;
  let requestService: RequestService;
  const testRequestHref = 'https://rest.api/';
  const testRequestUUID = 'https://rest.api/';

  const testRCEs = {
    a: { response: { isSuccessful: true, resourceSelfLinks: ['a', 'b', 'c', 'd'] } },
    b: { response: { isSuccessful: false, resourceSelfLinks: ['e', 'f'] } },
    c: { response: { isSuccessful: undefined, resourceSelfLinks: ['g', 'h', 'i'] } },
    d: { response: { isSuccessful: true, resourceSelfLinks: ['j', 'k', 'l', 'm', 'n'] } },
    e: { response: { isSuccessful: 1, resourceSelfLinks: [] } },
    f: { response: undefined },
    g: undefined
  };

  const testResponses = {
    a: testRCEs.a.response,
    b: testRCEs.b.response,
    c: testRCEs.c.response,
    d: testRCEs.d.response,
    e: testRCEs.e.response
  };

  beforeEach(() => {
    scheduler = getTestScheduler();
  });

  describe('getRequestFromRequestHref', () => {

    it('should return the RequestEntry corresponding to the self link in the source', () => {
      requestService = getMockRequestService();

      const source = hot('a', { a: testRequestHref });
      const result = source.pipe(getRequestFromRequestHref(requestService));
      const expected = cold('a', { a: new RequestEntry() });

      expect(result).toBeObservable(expected);
    });

    it('should use the requestService to fetch the request by its self link', () => {
      requestService = getMockRequestService();

      const source = hot('a', { a: testRequestHref });
      scheduler.schedule(() => source.pipe(getRequestFromRequestHref(requestService)).subscribe());
      scheduler.flush();

      expect(requestService.getByHref).toHaveBeenCalledWith(testRequestHref);
    });

    it('shouldn\'t return anything if there is no request matching the self link', () => {
      requestService = getMockRequestService(cold('a', { a: undefined }));

      const source = hot('a', { a: testRequestUUID });
      const result = source.pipe(getRequestFromRequestHref(requestService));
      const expected = cold('-');

      expect(result).toBeObservable(expected);
    });
  });

  describe('getRequestFromRequestUUID', () => {

    it('should return the RequestEntry corresponding to the request uuid in the source', () => {
      requestService = getMockRequestService();

      const source = hot('a', { a: testRequestUUID });
      const result = source.pipe(getRequestFromRequestUUID(requestService));
      const expected = cold('a', { a: new RequestEntry() });

      expect(result).toBeObservable(expected);
    });

    it('should use the requestService to fetch the request by its request uuid', () => {
      requestService = getMockRequestService();

      const source = hot('a', { a: testRequestUUID });
      scheduler.schedule(() => source.pipe(getRequestFromRequestUUID(requestService)).subscribe());
      scheduler.flush();

      expect(requestService.getByUUID).toHaveBeenCalledWith(testRequestUUID);
    });

    it('shouldn\'t return anything if there is no request matching the request uuid', () => {
      requestService = getMockRequestService(cold('a', { a: undefined }));

      const source = hot('a', { a: testRequestUUID });
      const result = source.pipe(getRequestFromRequestUUID(requestService));
      const expected = cold('-');

      expect(result).toBeObservable(expected);
    });
  });

  describe('filterSuccessfulResponses', () => {
    it('should only return responses for which isSuccessful === true', () => {
      const source = hot('abcde', testRCEs);
      const result = source.pipe(filterSuccessfulResponses());
      const expected = cold('a--d-', testResponses);

      expect(result).toBeObservable(expected);
    });
  });

  describe('getResourceLinksFromResponse', () => {
    it('should return the resourceSelfLinks for all successful responses', () => {
      const source = hot('abcde', testRCEs);
      const result = source.pipe(getResourceLinksFromResponse());
      const expected = cold('a--d-', {
        a: testRCEs.a.response.resourceSelfLinks,
        d: testRCEs.d.response.resourceSelfLinks
      });

      expect(result).toBeObservable(expected);
    });
  });

  describe('configureRequest', () => {
    it('should call requestService.configure with the source request', () => {
      requestService = getMockRequestService();
      const testRequest = new GetRequest('6b789e31-f026-4ff8-8993-4eb3b730c841', testRequestHref);
      const source = hot('a', { a: testRequest });
      scheduler.schedule(() => source.pipe(configureRequest(requestService)).subscribe());
      scheduler.flush();

      expect(requestService.configure).toHaveBeenCalledWith(testRequest);
    });
  });

  describe('getRemoteDataPayload', () => {
    it('should return the payload of the source RemoteData', () => {
      const testRD = { a: { payload: 'a' } };
      const source = hot('a', testRD);
      const result = source.pipe(getRemoteDataPayload());
      const expected = cold('a', {
        a: testRD.a.payload,
      });

      expect(result).toBeObservable(expected);
    });
  });

  describe('getResponseFromEntry', () => {
    it('should return the response for all not empty request entries, when they have a value', () => {
      const source = hot('abcdefg', testRCEs);
      const result = source.pipe(getResponseFromEntry());
      const expected = cold('abcde--', {
        a: testRCEs.a.response,
        b: testRCEs.b.response,
        c: testRCEs.c.response,
        d: testRCEs.d.response,
        e: testRCEs.e.response
      });

      expect(result).toBeObservable(expected)
    });
  });

  describe('getSucceededRemoteData', () => {
    it('should return the first() hasSucceeded RemoteData Observable', () => {
      const testRD = {
        a: createSuccessfulRemoteDataObject(undefined),
        b: createFailedRemoteDataObject( 'b'),
        c: new RemoteData(false, false, undefined, null, 'c'),
        d: createSuccessfulRemoteDataObject('d'),
        e: createSuccessfulRemoteDataObject('e'),
      };
      const source = hot('abcde', testRD);
      const result = source.pipe(getSucceededRemoteData());

      result.subscribe((value) => expect(value)
        .toEqual(createSuccessfulRemoteDataObject('d')));

    });
  });

  describe('redirectOn404Or401', () => {
    let router;
    beforeEach(() => {
      router = jasmine.createSpyObj('router', ['navigateByUrl']);
    });

    it('should call navigateByUrl to a 404 page, when the remote data contains a 404 error', () => {
      const testRD = createFailedRemoteDataObject(undefined, new RemoteDataError(404, 'Not Found', 'Object was not found'));

      observableOf(testRD).pipe(redirectOn404Or401(router)).subscribe();
      expect(router.navigateByUrl).toHaveBeenCalledWith('/404', { skipLocationChange: true });
    });

    it('should call navigateByUrl to a 401 page, when the remote data contains a 401 error', () => {
      const testRD = createFailedRemoteDataObject(undefined, new RemoteDataError(401, 'Unauthorized', 'The current user is unauthorized'));

      observableOf(testRD).pipe(redirectOn404Or401(router)).subscribe();
      expect(router.navigateByUrl).toHaveBeenCalledWith('/401', { skipLocationChange: true });
    });

    it('should not call navigateByUrl to a 404 or 401 page, when the remote data contains another error than a 404 or 401', () => {
      const testRD = createFailedRemoteDataObject(undefined, new RemoteDataError(500, 'Server Error', 'Something went wrong'));

      observableOf(testRD).pipe(redirectOn404Or401(router)).subscribe();
      expect(router.navigateByUrl).not.toHaveBeenCalled();
    });

    it('should not call navigateByUrl to a 404 or 401 page, when the remote data contains no error', () => {
      const testRD = createSuccessfulRemoteDataObject(undefined);

      observableOf(testRD).pipe(redirectOn404Or401(router)).subscribe();
      expect(router.navigateByUrl).not.toHaveBeenCalled();
    });
  });

  describe('getResponseFromEntry', () => {
    it('should return the response for all not empty request entries, when they have a value', () => {
      const source = hot('abcdefg', testRCEs);
      const result = source.pipe(getResponseFromEntry());
      const expected = cold('abcde--', {
        a: testRCEs.a.response,
        b: testRCEs.b.response,
        c: testRCEs.c.response,
        d: testRCEs.d.response,
        e: testRCEs.e.response
      });

      expect(result).toBeObservable(expected)
    });
  });

  describe('getAllSucceededRemoteData', () => {
    it('should return all hasSucceeded RemoteData Observables', () => {
      const testRD = {
        a: createSuccessfulRemoteDataObject(undefined),
        b: createFailedRemoteDataObject('b'),
        c: new RemoteData(false, false, undefined, null, 'c'),
        d: createSuccessfulRemoteDataObject('d'),
        e: createSuccessfulRemoteDataObject('e'),
      };
      const source = hot('abcde', testRD);
      const result = source.pipe(getAllSucceededRemoteData());
      const expected = cold('---de', testRD);

      expect(result).toBeObservable(expected);

    });

  });
});