angular/packages/common/http/test/client_spec.ts

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */

import {HttpClient} from '@angular/common/http/src/client';
import {HttpErrorResponse, HttpEventType, HttpResponse, HttpStatusCode} from '@angular/common/http/src/response';
import {HttpClientTestingBackend} from '@angular/common/http/testing/src/backend';
import {toArray} from 'rxjs/operators';

describe('HttpClient', () => {
  let client: HttpClient = null!;
  let backend: HttpClientTestingBackend = null!;
  beforeEach(() => {
    backend = new HttpClientTestingBackend();
    client = new HttpClient(backend);
  });
  afterEach(() => {
    backend.verify();
  });
  describe('makes a basic request', () => {
    it('for JSON data', done => {
      client.get('/test').subscribe(res => {
        expect((res as any)['data']).toEqual('hello world');
        done();
      });
      backend.expectOne('/test').flush({'data': 'hello world'});
    });
    it('should allow flushing requests with a boolean value', (done: DoneFn) => {
      client.get('/test').subscribe(res => {
        expect((res as any)).toEqual(true);
        done();
      });
      backend.expectOne('/test').flush(true);
    });
    it('for text data', done => {
      client.get('/test', {responseType: 'text'}).subscribe(res => {
        expect(res).toEqual('hello world');
        done();
      });
      backend.expectOne('/test').flush('hello world');
    });
    it('with headers', done => {
      client.get('/test', {headers: {'X-Option': 'true'}}).subscribe(() => done());
      const req = backend.expectOne('/test');
      expect(req.request.headers.get('X-Option')).toEqual('true');
      req.flush({});
    });
    it('with string params', done => {
      client.get('/test', {params: {'test': 'true'}}).subscribe(() => done());
      backend.expectOne('/test?test=true').flush({});
    });
    it('with an array of string params', done => {
      client.get('/test', {params: {'test': ['a', 'b']}}).subscribe(() => done());
      backend.expectOne('/test?test=a&test=b').flush({});
    });
    it('with number params', done => {
      client.get('/test', {params: {'test': 2}}).subscribe(() => done());
      backend.expectOne('/test?test=2').flush({});
    });
    it('with an array of number params', done => {
      client.get('/test', {params: {'test': [2, 3]}}).subscribe(() => done());
      backend.expectOne('/test?test=2&test=3').flush({});
    });
    it('with boolean params', done => {
      client.get('/test', {params: {'test': true}}).subscribe(() => done());
      backend.expectOne('/test?test=true').flush({});
    });
    it('with an array of boolean params', done => {
      client.get('/test', {params: {'test': [true, false]}}).subscribe(() => done());
      backend.expectOne('/test?test=true&test=false').flush({});
    });
    it('with an array of params of different types', done => {
      client.get('/test', {params: {'test': [true, 'a', 2] as const}}).subscribe(() => done());
      backend.expectOne('/test?test=true&test=a&test=2').flush({});
    });
    it('for an arraybuffer', done => {
      const body = new ArrayBuffer(4);
      client.get('/test', {responseType: 'arraybuffer'}).subscribe(res => {
        expect(res).toBe(body);
        done();
      });
      backend.expectOne('/test').flush(body);
    });
    if (typeof Blob !== 'undefined') {
      it('for a blob', done => {
        const body = new Blob([new ArrayBuffer(4)]);
        client.get('/test', {responseType: 'blob'}).subscribe(res => {
          expect(res).toBe(body);
          done();
        });
        backend.expectOne('/test').flush(body);
      });
    }
    it('that returns a response', done => {
      const body = {'data': 'hello world'};
      client.get('/test', {observe: 'response'}).subscribe(res => {
        expect(res instanceof HttpResponse).toBe(true);
        expect(res.body).toBe(body);
        done();
      });
      backend.expectOne('/test').flush(body);
    });
    it('that returns a stream of events', done => {
      client.get('/test', {observe: 'events'}).pipe(toArray()).toPromise().then(events => {
        expect(events!.length).toBe(2);
        let x = HttpResponse;
        expect(events![0].type).toBe(HttpEventType.Sent);
        expect(events![1].type).toBe(HttpEventType.Response);
        expect(events![1] instanceof HttpResponse).toBeTruthy();
        done();
      });
      backend.expectOne('/test').flush({'data': 'hello world'});
    });
    it('with progress events enabled', done => {
      client.get('/test', {reportProgress: true}).subscribe(() => done());
      const req = backend.expectOne('/test');
      expect(req.request.reportProgress).toEqual(true);
      req.flush({});
    });
  });
  describe('makes a POST request', () => {
    it('with text data', done => {
      client.post('/test', 'text body', {observe: 'response', responseType: 'text'})
          .subscribe(res => {
            expect(res.ok).toBeTruthy();
            expect(res.status).toBe(HttpStatusCode.Ok);
            done();
          });
      backend.expectOne('/test').flush('hello world');
    });
    it('with json data', done => {
      const body = {data: 'json body'};
      client.post('/test', body, {observe: 'response', responseType: 'text'}).subscribe(res => {
        expect(res.ok).toBeTruthy();
        expect(res.status).toBe(HttpStatusCode.Ok);
        done();
      });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(body);
      testReq.flush('hello world');
    });
    it('with a json body of false', done => {
      client.post('/test', false, {observe: 'response', responseType: 'text'}).subscribe(res => {
        expect(res.ok).toBeTruthy();
        expect(res.status).toBe(HttpStatusCode.Ok);
        done();
      });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(false);
      testReq.flush('hello world');
    });
    it('with a json body of 0', done => {
      client.post('/test', 0, {observe: 'response', responseType: 'text'}).subscribe(res => {
        expect(res.ok).toBeTruthy();
        expect(res.status).toBe(HttpStatusCode.Ok);
        done();
      });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(0);
      testReq.flush('hello world');
    });
    it('with an arraybuffer', done => {
      const body = new ArrayBuffer(4);
      client.post('/test', body, {observe: 'response', responseType: 'text'}).subscribe(res => {
        expect(res.ok).toBeTruthy();
        expect(res.status).toBe(HttpStatusCode.Ok);
        done();
      });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(body);
      testReq.flush('hello world');
    });
  });
  describe('makes a DELETE request', () => {
    it('with body', done => {
      const body = {data: 'json body'};
      client.delete('/test', {observe: 'response', responseType: 'text', body: body})
          .subscribe(res => {
            expect(res.ok).toBeTruthy();
            expect(res.status).toBe(200);
            done();
          });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(body);
      testReq.flush('hello world');
    });
    it('without body', done => {
      client.delete('/test', {observe: 'response', responseType: 'text'}).subscribe(res => {
        expect(res.ok).toBeTruthy();
        expect(res.status).toBe(200);
        done();
      });
      const testReq = backend.expectOne('/test');
      expect(testReq.request.body).toBe(null);
      testReq.flush('hello world');
    });
  });
  describe('makes a JSONP request', () => {
    it('with properly set method and callback', done => {
      client.jsonp('/test', 'myCallback').subscribe(() => done());
      backend.expectOne({method: 'JSONP', url: '/test?myCallback=JSONP_CALLBACK'})
          .flush('hello world');
    });
  });
  describe('makes a request for an error response', () => {
    it('with a JSON body', done => {
      client.get('/test').subscribe(() => {}, (res: HttpErrorResponse) => {
        expect(res.error.data).toEqual('hello world');
        done();
      });
      backend.expectOne('/test').flush(
          {'data': 'hello world'},
          {status: HttpStatusCode.InternalServerError, statusText: 'Server error'});
    });
  });
  describe('throws an error', () => {
    it('for a request with nullish header', () => {
      client.request('GET', '/test', {headers: {foo: null!}}).subscribe();
      expect(() => backend.expectOne('/test').request.headers.has('random-header'))
          .toThrowError(
              'Unexpected value of the `foo` header provided. ' +
              'Expecting either a string, a number or an array, but got: `null`.');
    });
  });
});