@e22m4u/js-trie-router 0.4.0 → 0.4.2

package/src/utils/create-request-mock.js

@@ -136,11 +136,11 @@ export function createRequestMock(patch) {
   // если передан поток, он будет использован
   // в качестве объекта запроса, в противном
   // случае создается новый
-  const req =
+  const request =
     patch.stream ||
     createRequestStream(patch.secure, patch.body, patch.encoding);
-  req.url = createRequestUrl(patch.path || '/', patch.query);
-  req.headers = createRequestHeaders(
+  request.url = createRequestUrl(patch.path || '/', patch.query);
+  request.headers = createRequestHeaders(
     patch.host,
     patch.secure,
     patch.body,
@@ -148,8 +148,8 @@ export function createRequestMock(patch) {
     patch.encoding,
     patch.headers,
   );
-  req.method = (patch.method || 'get').toUpperCase();
-  return req;
+  request.method = (patch.method || 'get').toUpperCase();
+  return request;
 }
 
 /**
@@ -172,22 +172,22 @@ function createRequestStream(secure, body, encoding) {
   // использует обертка TLSSocket
   let socket = new Socket();
   if (secure) socket = new TLSSocket(socket);
-  const req = new IncomingMessage(socket);
+  const request = new IncomingMessage(socket);
   // тело запроса должно являться
   // строкой или бинарными данными
   if (body != null) {
     if (typeof body === 'string') {
-      req.push(body, encoding);
+      request.push(body, encoding);
     } else if (Buffer.isBuffer(body)) {
-      req.push(body);
+      request.push(body);
     } else {
-      req.push(JSON.stringify(body));
+      request.push(JSON.stringify(body));
     }
   }
   // передача "null" определяет
   // конец данных
-  req.push(null);
-  return req;
+  request.push(null);
+  return request;
 }
 
 /**

package/src/utils/create-request-mock.spec.js

@@ -1,7 +1,7 @@
 import {Socket} from 'net';
 import {Stream} from 'stream';
 import {TLSSocket} from 'tls';
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {createRequestMock} from './create-request-mock.js';
 import {CHARACTER_ENCODING_LIST} from './fetch-request-body.js';

package/src/utils/create-response-mock.d.ts

@@ -6,7 +6,8 @@ import {ServerResponse} from 'http';
 export type ServerResponseMock = ServerResponse & {
   _headersSent: boolean;
   _headers: {[name: string]: string | undefined};
-  getEncoding(encoding: BufferEncoding): ServerResponseMock;
+  setEncoding(encoding: string): ServerResponseMock;
+  getEncoding(): string | undefined;
   getBody(): Promise<string>;
 };
 

package/src/utils/create-response-mock.js

@@ -6,32 +6,32 @@ import {PassThrough} from 'stream';
  * @returns {import('http').ServerResponse}
  */
 export function createResponseMock() {
-  const res = new PassThrough();
-  patchEncoding(res);
-  patchHeaders(res);
-  patchBody(res);
-  return res;
+  const response = new PassThrough();
+  patchEncoding(response);
+  patchHeaders(response);
+  patchBody(response);
+  return response;
 }
 
 /**
  * Patch encoding.
  *
- * @param {object} res
+ * @param {object} response
  */
-function patchEncoding(res) {
-  Object.defineProperty(res, '_encoding', {
+function patchEncoding(response) {
+  Object.defineProperty(response, '_encoding', {
     configurable: true,
     writable: true,
     value: undefined,
   });
-  Object.defineProperty(res, 'setEncoding', {
+  Object.defineProperty(response, 'setEncoding', {
     configurable: true,
     value: function (enc) {
       this._encoding = enc;
       return this;
     },
   });
-  Object.defineProperty(res, 'getEncoding', {
+  Object.defineProperty(response, 'getEncoding', {
     configurable: true,
     value: function () {
       return this._encoding;
@@ -42,26 +42,26 @@ function patchEncoding(res) {
 /**
  * Patch headers.
  *
- * @param {object} res
+ * @param {object} response
  */
-function patchHeaders(res) {
-  Object.defineProperty(res, '_headersSent', {
+function patchHeaders(response) {
+  Object.defineProperty(response, '_headersSent', {
     configurable: true,
     writable: true,
     value: false,
   });
-  Object.defineProperty(res, 'headersSent', {
+  Object.defineProperty(response, 'headersSent', {
     configurable: true,
     get() {
       return this._headersSent;
     },
   });
-  Object.defineProperty(res, '_headers', {
+  Object.defineProperty(response, '_headers', {
     configurable: true,
     writable: true,
     value: {},
   });
-  Object.defineProperty(res, 'setHeader', {
+  Object.defineProperty(response, 'setHeader', {
     configurable: true,
     value: function (name, value) {
       if (this.headersSent)
@@ -74,13 +74,13 @@ function patchHeaders(res) {
       return this;
     },
   });
-  Object.defineProperty(res, 'getHeader', {
+  Object.defineProperty(response, 'getHeader', {
     configurable: true,
     value: function (name) {
       return this._headers[name.toLowerCase()];
     },
   });
-  Object.defineProperty(res, 'getHeaders', {
+  Object.defineProperty(response, 'getHeaders', {
     configurable: true,
     value: function () {
       return JSON.parse(JSON.stringify(this._headers));
@@ -91,30 +91,30 @@ function patchHeaders(res) {
 /**
  * Patch body.
  *
- * @param {object} res
+ * @param {object} response
  */
-function patchBody(res) {
+function patchBody(response) {
   let resolve, reject;
-  const promise = new Promise((res, rej) => {
-    resolve = res;
+  const promise = new Promise((rsv, rej) => {
+    resolve = rsv;
     reject = rej;
   });
   const data = [];
-  res.on('data', c => data.push(c));
-  res.on('error', e => reject(e));
-  res.on('end', () => {
+  response.on('data', c => data.push(c));
+  response.on('error', e => reject(e));
+  response.on('end', () => {
     resolve(Buffer.concat(data));
   });
   // флаг _headersSent должен быть установлен синхронно
-  // после вызова метода res.end, так как асинхронная
-  // установка (к примеру в res.on('end')) не позволит
+  // после вызова метода response.end, так как асинхронная
+  // установка (к примеру в response.on('end')) не позволит
   // отследить отправку ответа при синхронном выполнении
-  const originalEnd = res.end.bind(res);
-  res.end = function (...args) {
+  const originalEnd = response.end.bind(response);
+  response.end = function (...args) {
     this._headersSent = true;
     return originalEnd(...args);
   };
-  Object.defineProperty(res, 'getBody', {
+  Object.defineProperty(response, 'getBody', {
     configurable: true,
     value: function () {
       return promise.then(buffer => {

package/src/utils/create-response-mock.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {PassThrough} from 'stream';
 import {createResponseMock} from './create-response-mock.js';
 

package/src/utils/create-route-mock.d.ts

@@ -0,0 +1,19 @@
+import {Route, HttpMethod} from '../route.js';
+import type {RouteHandler} from '../route.js';
+
+/**
+ * Route mock options.
+ */
+type RouteMockOptions = {
+  method?: HttpMethod;
+  path?: string;
+  handler?: RouteHandler;
+};
+
+/**
+ * Create route mock.
+ *
+ * @param {Route} options
+ * @returns {Route}
+ */
+export function createRouteMock(options: RouteMockOptions): Route;

package/src/utils/create-route-mock.js

@@ -0,0 +1,22 @@
+import {Route, HttpMethod} from '../route.js';
+
+/**
+ * @typedef {object} RouteMockOptions
+ * @property {HttpMethod} method
+ * @property {string} path
+ * @property {import('../route.js').RouteHandler} handler
+ */
+
+/**
+ * Create route mock.
+ *
+ * @param {Route} options
+ * @returns {Route}
+ */
+export function createRouteMock(options = {}) {
+  return new Route({
+    method: options.method || HttpMethod.GET,
+    path: options.path || '/',
+    handler: options.handler || (() => 'OK'),
+  });
+}

package/src/utils/create-route-mock.spec.js

@@ -0,0 +1,28 @@
+import {expect} from 'chai';
+import {HttpMethod, Route} from '../route.js';
+import {createRouteMock} from './create-route-mock.js';
+
+describe('createRouteMock', function () {
+  it('returns an instance of Route with default options', function () {
+    const res = createRouteMock();
+    expect(res).to.be.instanceof(Route);
+    expect(res.method).to.be.eq(HttpMethod.GET);
+    expect(res.path).to.be.eq('/');
+    expect(res.handler()).to.be.eq('OK');
+  });
+
+  it('sets the "method" option', function () {
+    const res = createRouteMock({method: HttpMethod.POST});
+    expect(res.method).to.be.eq(HttpMethod.POST);
+  });
+
+  it('sets the "path" option', function () {
+    const res = createRouteMock({path: 'test'});
+    expect(res.path).to.be.eq('test');
+  });
+
+  it('sets the "handler" option', function () {
+    const res = createRouteMock({handler: () => 'Hey!'});
+    expect(res.handler()).to.be.eq('Hey!');
+  });
+});

package/src/utils/fetch-request-body.d.ts

@@ -17,10 +17,10 @@ export const CHARACTER_ENCODING_LIST: (
 /**
  * Fetch request body.
  *
- * @param req
+ * @param request
  * @param bodyBytesLimit
  */
 export declare function fetchRequestBody(
-  req: IncomingMessage,
+  request: IncomingMessage,
   bodyBytesLimit?: number,
 ): Promise<string>;

package/src/utils/fetch-request-body.js

@@ -21,16 +21,16 @@ export const CHARACTER_ENCODING_LIST = [
 /**
  * Fetch request body.
  *
- * @param {IncomingMessage} req
+ * @param {IncomingMessage} request
  * @param {number} bodyBytesLimit
  * @returns {Promise<string|undefined>}
  */
-export function fetchRequestBody(req, bodyBytesLimit = 0) {
-  if (!(req instanceof IncomingMessage))
+export function fetchRequestBody(request, bodyBytesLimit = 0) {
+  if (!(request instanceof IncomingMessage))
     throw new Errorf(
       'The first parameter of "fetchRequestBody" should be ' +
         'an IncomingMessage instance, but %v was given.',
-      req,
+      request,
     );
   if (typeof bodyBytesLimit !== 'number')
     throw new Errorf(
@@ -42,7 +42,10 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
     // сравнение внутреннего ограничения
     // размера тела запроса с заголовком
     // "content-length"
-    const contentLength = parseInt(req.headers['content-length'] || '0', 10);
+    const contentLength = parseInt(
+      request.headers['content-length'] || '0',
+      10,
+    );
     if (bodyBytesLimit && contentLength && contentLength > bodyBytesLimit)
       throw createError(
         HttpErrors.PayloadTooLarge,
@@ -53,7 +56,7 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
     // определение кодировки
     // по заголовку "content-type"
     let encoding = 'utf-8';
-    const contentType = req.headers['content-type'] || '';
+    const contentType = request.headers['content-type'] || '';
     if (contentType) {
       const parsedContentType = parseContentType(contentType);
       if (parsedContentType && parsedContentType.charset) {
@@ -75,7 +78,7 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
     const onData = chunk => {
       receivedLength += chunk.length;
       if (bodyBytesLimit && receivedLength > bodyBytesLimit) {
-        req.removeAllListeners();
+        request.removeAllListeners();
         const error = createError(
           HttpErrors.PayloadTooLarge,
           'Request body limit is %v bytes, but %v bytes given.',
@@ -91,7 +94,7 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
     // обработчики событий, и сравнить полученный объем
     // данных с заявленным в заголовке "content-length"
     const onEnd = () => {
-      req.removeAllListeners();
+      request.removeAllListeners();
       if (contentLength && contentLength !== receivedLength) {
         const error = createError(
           HttpErrors.BadRequest,
@@ -112,15 +115,15 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
     // и отклоняется ожидающий Promise
     // ошибкой с кодом 400
     const onError = error => {
-      req.removeAllListeners();
+      request.removeAllListeners();
       reject(HttpErrors(400, error));
     };
     // добавление обработчиков прослушивающих
     // события входящего запроса и возобновление
     // потока данных
-    req.on('data', onData);
-    req.on('end', onEnd);
-    req.on('error', onError);
-    req.resume();
+    request.on('data', onData);
+    request.on('end', onEnd);
+    request.on('error', onError);
+    request.resume();
   });
 }

package/src/utils/fetch-request-body.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {fetchRequestBody} from './fetch-request-body.js';
 import {createRequestMock} from './create-request-mock.js';

package/src/utils/get-request-pathname.d.ts

@@ -3,6 +3,6 @@ import {IncomingMessage} from 'http';
 /**
  * Get request pathname.
  *
- * @param req
+ * @param request
  */
-export declare function getRequestPathname(req: IncomingMessage): string;
+export declare function getRequestPathname(request: IncomingMessage): string;

package/src/utils/get-request-pathname.js

@@ -3,21 +3,21 @@ import {Errorf} from '@e22m4u/js-format';
 /**
  * Get request pathname.
  *
- * @param {import('http').IncomingMessage} req
+ * @param {import('http').IncomingMessage} request
  * @returns {string}
  */
-export function getRequestPathname(req) {
+export function getRequestPathname(request) {
   if (
-    !req ||
-    typeof req !== 'object' ||
-    Array.isArray(req) ||
-    typeof req.url !== 'string'
+    !request ||
+    typeof request !== 'object' ||
+    Array.isArray(request) ||
+    typeof request.url !== 'string'
   ) {
     throw new Errorf(
       'The first argument of "getRequestPathname" should be ' +
         'an instance of IncomingMessage, but %v was given.',
-      req,
+      request,
     );
   }
-  return (req.url || '/').replace(/\?.*$/, '');
+  return (request.url || '/').replace(/\?.*$/, '');
 }

package/src/utils/get-request-pathname.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {getRequestPathname} from './get-request-pathname.js';
 

package/src/utils/index.d.ts

@@ -5,6 +5,7 @@ export * from './parse-cookies.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
+export * from './create-route-mock.js';
 export * from './is-readable-stream.js';
 export * from './parse-content-type.js';
 export * from './is-writable-stream.js';

package/src/utils/index.js

@@ -5,6 +5,7 @@ export * from './parse-cookies.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
+export * from './create-route-mock.js';
 export * from './is-readable-stream.js';
 export * from './parse-content-type.js';
 export * from './is-writable-stream.js';

package/src/utils/is-promise.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {isPromise} from './is-promise.js';
 
 describe('isPromise', function () {

package/src/utils/is-readable-stream.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {Readable} from 'stream';
 import {isReadableStream} from './is-readable-stream.js';
 

package/src/utils/is-response-sent.d.ts

@@ -3,6 +3,6 @@ import {ServerResponse} from 'http';
 /**
  * Is response sent.
  *
- * @param res
+ * @param response
  */
-export declare function isResponseSent(res: ServerResponse): boolean;
+export declare function isResponseSent(response: ServerResponse): boolean;

package/src/utils/is-response-sent.js

@@ -3,21 +3,21 @@ import {Errorf} from '@e22m4u/js-format';
 /**
  * Is response sent.
  *
- * @param {import('http').ServerResponse} res
+ * @param {import('http').ServerResponse} response
  * @returns {boolean}
  */
-export function isResponseSent(res) {
+export function isResponseSent(response) {
   if (
-    !res ||
-    typeof res !== 'object' ||
-    Array.isArray(res) ||
-    typeof res.headersSent !== 'boolean'
+    !response ||
+    typeof response !== 'object' ||
+    Array.isArray(response) ||
+    typeof response.headersSent !== 'boolean'
   ) {
     throw new Errorf(
       'The first argument of "isResponseSent" should be ' +
         'an instance of ServerResponse, but %v was given.',
-      res,
+      response,
     );
   }
-  return res.headersSent;
+  return response.headersSent;
 }

package/src/utils/is-response-sent.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {isResponseSent} from './is-response-sent.js';
 

package/src/utils/is-writable-stream.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {Writable} from 'stream';
 import {isWritableStream} from './is-writable-stream.js';
 

package/src/utils/parse-content-type.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {parseContentType} from './parse-content-type.js';
 
 describe('parseContentType', function () {

package/src/utils/parse-cookies.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {parseCookies} from './parse-cookies.js';
 

package/src/utils/to-camel-case.spec.js

@@ -1,4 +1,4 @@
-import {expect} from '../chai.js';
+import {expect} from 'chai';
 import {format} from '@e22m4u/js-format';
 import {toCamelCase} from './to-camel-case.js';
 

package/src/chai.js

@@ -1,7 +0,0 @@
-import * as chaiModule from 'chai';
-import chaiAsPromised from 'chai-as-promised';
-const chai = {...chaiModule};
-
-chaiAsPromised(chai, chai.util);
-
-export const expect = chai.expect;