js-trie-router/src/request-context.spec.js

import {expect} from 'chai';
import {format} from '@e22m4u/js-format';
import {RequestContext} from './request-context.js';
import {ServiceContainer} from '@e22m4u/js-service';

import {
  createRouteMock,
  createRequestMock,
  createResponseMock,
} from './utils/index.js';

describe('RequestContext', function () {
  describe('constructor', function () {
    it('requires the parameter "container" to be a ServiceContainer instance', function () {
      const req = createRequestMock();
      const res = createResponseMock();
      const route = createRouteMock();
      const throwable = v => () => new RequestContext(v, req, res, route);
      const error = v =>
        format(
          'The parameter "container" of RequestContext.constructor ' +
            'must be an instance of ServiceContainer, but %s was given.',
          v,
        );
      expect(throwable('str')).to.throw(error('"str"'));
      expect(throwable('')).to.throw(error('""'));
      expect(throwable(10)).to.throw(error('10'));
      expect(throwable(0)).to.throw(error('0'));
      expect(throwable(true)).to.throw(error('true'));
      expect(throwable(false)).to.throw(error('false'));
      expect(throwable(null)).to.throw(error('null'));
      expect(throwable({})).to.throw(error('Object'));
      expect(throwable([])).to.throw(error('Array'));
      expect(throwable(undefined)).to.throw(error('undefined'));
      throwable(new ServiceContainer())();
    });

    it('requires the parameter "request" to be an IncomingMessage instance', function () {
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const throwable = v => () => new RequestContext(cont, v, res, route);
      const error = v =>
        format(
          'The parameter "request" of RequestContext.constructor ' +
            'must be an instance of IncomingMessage, but %s was given.',
          v,
        );
      expect(throwable('str')).to.throw(error('"str"'));
      expect(throwable('')).to.throw(error('""'));
      expect(throwable(10)).to.throw(error('10'));
      expect(throwable(0)).to.throw(error('0'));
      expect(throwable(true)).to.throw(error('true'));
      expect(throwable(false)).to.throw(error('false'));
      expect(throwable(null)).to.throw(error('null'));
      expect(throwable({})).to.throw(error('Object'));
      expect(throwable([])).to.throw(error('Array'));
      expect(throwable(undefined)).to.throw(error('undefined'));
      throwable(createRequestMock())();
    });

    it('requires the parameter "response" to be a ServerResponse instance', function () {
      const req = createRequestMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const throwable = v => () => new RequestContext(cont, req, v, route);
      const error = v =>
        format(
          'The parameter "response" of RequestContext.constructor ' +
            'must be an instance of ServerResponse, but %s was given.',
          v,
        );
      expect(throwable('str')).to.throw(error('"str"'));
      expect(throwable('')).to.throw(error('""'));
      expect(throwable(10)).to.throw(error('10'));
      expect(throwable(0)).to.throw(error('0'));
      expect(throwable(true)).to.throw(error('true'));
      expect(throwable(false)).to.throw(error('false'));
      expect(throwable(null)).to.throw(error('null'));
      expect(throwable({})).to.throw(error('Object'));
      expect(throwable([])).to.throw(error('Array'));
      expect(throwable(undefined)).to.throw(error('undefined'));
      throwable(createResponseMock())();
    });

    it('requires the parameter "route" to be a Route instance', function () {
      const req = createRequestMock();
      const res = createResponseMock();
      const cont = new ServiceContainer();
      const throwable = v => () => new RequestContext(cont, req, res, v);
      const error = v =>
        format(
          'The parameter "route" of RequestContext.constructor ' +
            'must be an instance of Route, but %s was given.',
          v,
        );
      expect(throwable('str')).to.throw(error('"str"'));
      expect(throwable('')).to.throw(error('""'));
      expect(throwable(10)).to.throw(error('10'));
      expect(throwable(0)).to.throw(error('0'));
      expect(throwable(true)).to.throw(error('true'));
      expect(throwable(false)).to.throw(error('false'));
      expect(throwable(null)).to.throw(error('null'));
      expect(throwable({})).to.throw(error('Object'));
      expect(throwable([])).to.throw(error('Array'));
      expect(throwable(undefined)).to.throw(error('undefined'));
      throwable(createRouteMock())();
    });

    it('sets properties from given arguments', function () {
      const req = createRequestMock();
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(ctx.container).to.be.eq(cont);
      expect(ctx.request).to.be.eq(req);
      expect(ctx.response).to.be.eq(res);
    });
  });

  describe('method', function () {
    it('returns the method name in upper case', function () {
      const req = createRequestMock({method: 'post'});
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(ctx.method).to.be.eq('POST');
    });
  });

  describe('path', function () {
    it('returns the request pathname with the query string', function () {
      const req = createRequestMock({path: '/pathname?foo=bar'});
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(req.url).to.be.eq('/pathname?foo=bar');
      expect(ctx.path).to.be.eq('/pathname?foo=bar');
    });
  });

  describe('pathname', function () {
    it('returns the request pathname without the query string', function () {
      const req = createRequestMock({path: '/pathname?foo=bar'});
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(req.url).to.be.eq('/pathname?foo=bar');
      expect(ctx.pathname).to.be.eq('/pathname');
    });

    it('sets the cache to the "_pathname" property and uses is for next accesses', function () {
      const req = createRequestMock({path: '/pathname'});
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(ctx._pathname).to.be.undefined;
      expect(ctx.pathname).to.be.eq('/pathname');
      expect(ctx._pathname).to.be.eq('/pathname');
      ctx._pathname = '/overridden';
      expect(ctx.pathname).to.be.eq('/overridden');
    });
  });

  describe('state', function () {
    it('has an empty object by default', function () {
      const req = createRequestMock({path: '/pathname'});
      const res = createResponseMock();
      const route = createRouteMock();
      const cont = new ServiceContainer();
      const ctx = new RequestContext(cont, req, res, route);
      expect(ctx.state).to.be.eql({});
    });
  });
});