@e22m4u/js-trie-router 0.2.0 → 0.3.0

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

@@ -4,7 +4,7 @@ import {TLSSocket} from 'tls';
 import {expect} from '../chai.js';
 import {format} from '@e22m4u/js-format';
 import {createRequestMock} from './create-request-mock.js';
-import {BUFFER_ENCODING_LIST} from './fetch-request-body.js';
+import {CHARACTER_ENCODING_LIST} from './fetch-request-body.js';
 
 describe('createRequestMock', function () {
   it('requires the first argument to be an Object', function () {
@@ -12,7 +12,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The first parameter of "createRequestMock" ' +
-          'should be an Object, but %s given.',
+          'should be an Object, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -32,7 +32,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "host" of "createRequestMock" ' +
-          'should be a String, but %s given.',
+          'should be a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -52,7 +52,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "method" of "createRequestMock" ' +
-          'should be a String, but %s given.',
+          'should be a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -72,7 +72,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "secure" of "createRequestMock" ' +
-          'should be a Boolean, but %s given.',
+          'should be a Boolean, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -92,7 +92,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "path" of "createRequestMock" ' +
-          'should be a String, but %s given.',
+          'should be a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -112,7 +112,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "query" of "createRequestMock" ' +
-          'should be a String or Object, but %s given.',
+          'should be a String or Object, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -128,12 +128,12 @@ describe('createRequestMock', function () {
     throwable(null)();
   });
 
-  it('requires the parameter "cookie" to be a String or Object', function () {
-    const throwable = v => () => createRequestMock({cookie: v});
+  it('requires the parameter "cookies" to be a String or Object', function () {
+    const throwable = v => () => createRequestMock({cookies: v});
     const error = v =>
       format(
-        'The parameter "cookie" of "createRequestMock" ' +
-          'should be a String or Object, but %s given.',
+        'The parameter "cookies" of "createRequestMock" ' +
+          'should be a String or Object, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -154,7 +154,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "headers" of "createRequestMock" ' +
-          'should be an Object, but %s given.',
+          'should be an Object, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -175,7 +175,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "stream" of "createRequestMock" ' +
-          'should be a Stream, but %s given.',
+          'should be a Stream, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -196,7 +196,7 @@ describe('createRequestMock', function () {
     const error = v =>
       format(
         'The parameter "encoding" of "createRequestMock" ' +
-          'should be a String, but %s given.',
+          'should be a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -212,10 +212,10 @@ describe('createRequestMock', function () {
 
   it('requires the parameter "encoding" to be the BufferEncoding', function () {
     const throwable = v => () => createRequestMock({encoding: v});
-    const error = v => format('Buffer encoding %s is not supported.', v);
+    const error = v => format('Character encoding %s is not supported.', v);
     expect(throwable('str')).to.throw(error('"str"'));
     expect(throwable('')).to.throw(error('""'));
-    BUFFER_ENCODING_LIST.forEach(v => throwable(v)());
+    CHARACTER_ENCODING_LIST.forEach(v => throwable(v)());
   });
 
   it('does not allow the option "secure" with the "stream"', function () {
@@ -389,12 +389,12 @@ describe('createRequestMock', function () {
   });
 
   it('sets the header "cookie" from a String', function () {
-    const req = createRequestMock({cookie: 'test'});
+    const req = createRequestMock({cookies: 'test'});
     expect(req.headers['cookie']).to.be.eq('test');
   });
 
   it('sets the header "cookie" from an Object', function () {
-    const req = createRequestMock({cookie: {p1: 'foo', p2: 'bar'}});
+    const req = createRequestMock({cookies: {p1: 'foo', p2: 'bar'}});
     expect(req.headers['cookie']).to.be.eq('p1=foo; p2=bar;');
   });
 

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

@@ -1,9 +1,18 @@
 import {IncomingMessage} from 'http';
 
 /**
- * Buffer encoding list.
+ * Character encoding list.
  */
-export type BUFFER_ENCODING_LIST = BufferEncoding[];
+export const CHARACTER_ENCODING_LIST: (
+  | 'ascii'
+  | 'utf8'
+  | 'utf-8'
+  | 'utf16le'
+  | 'utf-16le'
+  | 'ucs2'
+  | 'ucs-2'
+  | 'latin1'
+)[];
 
 /**
  * Fetch request body.

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

@@ -1,15 +1,13 @@
 import HttpErrors from 'http-errors';
+import {IncomingMessage} from 'http';
+import {Errorf} from '@e22m4u/js-format';
 import {createError} from './create-error.js';
 import {parseContentType} from './parse-content-type.js';
-import {Errorf} from '@e22m4u/js-format';
-import {IncomingMessage} from 'http';
 
 /**
- * Buffer encoding.
- *
- * @type {import('buffer').BufferEncoding[]}
+ * Character encoding list.
  */
-export const BUFFER_ENCODING_LIST = [
+export const CHARACTER_ENCODING_LIST = [
   'ascii',
   'utf8',
   'utf-8',
@@ -17,11 +15,7 @@ export const BUFFER_ENCODING_LIST = [
   'utf-16le',
   'ucs2',
   'ucs-2',
-  'base64',
-  'base64url',
   'latin1',
-  'binary',
-  'hex',
 ];
 
 /**
@@ -35,13 +29,13 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
   if (!(req instanceof IncomingMessage))
     throw new Errorf(
       'The first parameter of "fetchRequestBody" should be ' +
-        'an IncomingMessage instance, but %v given.',
+        'an IncomingMessage instance, but %v was given.',
       req,
     );
   if (typeof bodyBytesLimit !== 'number')
     throw new Errorf(
       'The parameter "bodyBytesLimit" of "fetchRequestBody" ' +
-        'should be a number, but %v given.',
+        'should be a number, but %v was given.',
       bodyBytesLimit,
     );
   return new Promise((resolve, reject) => {
@@ -64,7 +58,7 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
       const parsedContentType = parseContentType(contentType);
       if (parsedContentType && parsedContentType.charset) {
         encoding = parsedContentType.charset.toLowerCase();
-        if (!BUFFER_ENCODING_LIST.includes(encoding))
+        if (!CHARACTER_ENCODING_LIST.includes(encoding))
           throw createError(
             HttpErrors.UnsupportedMediaType,
             'Request encoding %v is not supported.',
@@ -106,12 +100,11 @@ export function fetchRequestBody(req, bodyBytesLimit = 0) {
         reject(error);
         return;
       }
-      // объединение массива байтов в буфер,
-      // кодирование результата в строку,
-      // и передача полученных данных
+      // объединение массива байтов в буфер, кодирование
+      // результата в строку, и передача полученных данных
       // в ожидающий Promise
       const buffer = Buffer.concat(data);
-      const body = Buffer.from(buffer, encoding).toString();
+      const body = buffer.toString(encoding);
       resolve(body || undefined);
     };
     // при ошибке загрузки тела запроса,

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

@@ -9,7 +9,7 @@ describe('fetchRequestBody', function () {
     const error = v =>
       format(
         'The first parameter of "fetchRequestBody" should be ' +
-          'an IncomingMessage instance, but %s given.',
+          'an IncomingMessage instance, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -31,7 +31,7 @@ describe('fetchRequestBody', function () {
     const error = v =>
       format(
         'The parameter "bodyBytesLimit" of "fetchRequestBody" ' +
-          'should be a number, but %s given.',
+          'should be a number, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));
@@ -83,16 +83,15 @@ describe('fetchRequestBody', function () {
       expect(result).to.be.eq(body);
     });
 
-    it('decodes non-standard encoding', async function () {
-      const body = 'Lorem Ipsum is simply dummy text.';
-      const encoding = 'base64';
-      const encodedBody = Buffer.from(body).toString(encoding);
+    it('decodes non-UTF-8 encoding to a plain text', async function () {
+      const originalBody = 'Hello, world!';
       const req = createRequestMock({
-        body: Buffer.from(encodedBody, encoding),
-        headers: {'content-type': `text/plain; charset=${encoding}`},
+        body: originalBody,
+        encoding: 'latin1',
+        headers: {'content-type': `text/plain; charset=latin1`},
       });
       const result = await fetchRequestBody(req);
-      expect(result).to.be.eq(body);
+      expect(result).to.be.eq(originalBody);
     });
   });
 

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

@@ -15,7 +15,7 @@ export function getRequestPathname(req) {
   ) {
     throw new Errorf(
       'The first argument of "getRequestPathname" should be ' +
-        'an instance of IncomingMessage, but %v given.',
+        'an instance of IncomingMessage, but %v was given.',
       req,
     );
   }

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

@@ -8,7 +8,7 @@ describe('getRequestPathname', function () {
     const error = v =>
       format(
         'The first argument of "getRequestPathname" should be ' +
-          'an instance of IncomingMessage, but %s given.',
+          'an instance of IncomingMessage, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));

package/src/utils/index.d.ts

@@ -1,6 +1,6 @@
 export * from './is-promise.js';
-export * from './parse-cookie.js';
 export * from './create-error.js';
+export * from './parse-cookies.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
@@ -10,5 +10,5 @@ export * from './is-writable-stream.js';
 export * from './fetch-request-body.js';
 export * from './create-request-mock.js';
 export * from './create-response-mock.js';
-export * from './create-cookie-string.js';
+export * from './create-cookies-string.js';
 export * from './get-request-pathname.js';

package/src/utils/index.js

@@ -1,6 +1,6 @@
 export * from './is-promise.js';
-export * from './parse-cookie.js';
 export * from './create-error.js';
+export * from './parse-cookies.js';
 export * from './to-camel-case.js';
 export * from './create-debugger.js';
 export * from './is-response-sent.js';
@@ -10,5 +10,5 @@ export * from './is-writable-stream.js';
 export * from './fetch-request-body.js';
 export * from './create-request-mock.js';
 export * from './create-response-mock.js';
-export * from './create-cookie-string.js';
+export * from './create-cookies-string.js';
 export * from './get-request-pathname.js';

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

@@ -1,6 +1,5 @@
 /**
- * Check whether a value has a pipe
- * method.
+ * Check whether a value has a pipe method.
  *
  * @param {*} value
  * @returns {boolean}

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

@@ -15,7 +15,7 @@ export function isResponseSent(res) {
   ) {
     throw new Errorf(
       'The first argument of "isResponseSent" should be ' +
-        'an instance of ServerResponse, but %v given.',
+        'an instance of ServerResponse, but %v was given.',
       res,
     );
   }

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

@@ -8,7 +8,7 @@ describe('isResponseSent', function () {
     const error = v =>
       format(
         'The first argument of "isResponseSent" should be ' +
-          'an instance of ServerResponse, but %s given.',
+          'an instance of ServerResponse, but %s was given.',
         v,
       );
     expect(throwable('str')).to.throw(error('"str"'));

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

@@ -14,7 +14,7 @@ export function parseContentType(input) {
   if (typeof input !== 'string')
     throw new Errorf(
       'The parameter "input" of "parseContentType" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       input,
     );
   const res = {mediaType: undefined, charset: undefined, boundary: undefined};

package/src/utils/parse-cookies.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Parsed cookies.
+ */
+type ParsedCookies = {
+  [key: string]: string | undefined;
+};
+
+/**
+ * Parse cookies.
+ *
+ * @example
+ * ```ts
+ * parseCookies('pkg=math; equation=E%3Dmc%5E2');
+ * // {pkg: 'math', equation: 'E=mc^2'}
+ * ```
+ *
+ * @param input
+ */
+export declare function parseCookies(input: string): ParsedCookies;

package/src/utils/{parse-cookie.js → parse-cookies.js}

@@ -1,21 +1,22 @@
 import {Errorf} from '@e22m4u/js-format';
 
 /**
- * Parse cookie.
+ * Parse cookies.
  *
  * @example
  * ```ts
- * parseCookie('pkg=math; equation=E%3Dmc%5E2');
+ * parseCookies('pkg=math; equation=E%3Dmc%5E2');
  * // {pkg: 'math', equation: 'E=mc^2'}
  * ```
  *
  * @param {string} input
  * @returns {object}
  */
-export function parseCookie(input) {
+export function parseCookies(input) {
   if (typeof input !== 'string')
     throw new Errorf(
-      'The first parameter of "parseCookie" should be a String, but %v given.',
+      'The first parameter of "parseCookies" should be a String, ' +
+        'but %v was given.',
       input,
     );
   return input
@@ -24,7 +25,9 @@ export function parseCookie(input) {
     .map(v => v.split('='))
     .reduce((cookies, tuple) => {
       const key = decodeURIComponent(tuple[0]).trim();
-      cookies[key] = decodeURIComponent(tuple[1]).trim();
+      const value =
+        tuple[1] !== undefined ? decodeURIComponent(tuple[1]).trim() : '';
+      cookies[key] = value;
       return cookies;
     }, {});
 }

package/src/utils/{parse-cookie.spec.js → parse-cookies.spec.js}

@@ -1,14 +1,14 @@
 import {expect} from '../chai.js';
 import {format} from '@e22m4u/js-format';
-import {parseCookie} from './parse-cookie.js';
+import {parseCookies} from './parse-cookies.js';
 
-describe('parseCookie', function () {
+describe('parseCookies', function () {
   it('requires the first parameter to be an IncomingMessage instance', function () {
-    const throwable = v => () => parseCookie(v);
+    const throwable = v => () => parseCookies(v);
     const error = v =>
       format(
-        'The first parameter of "parseCookie" should be ' +
-          'a String, but %s given.',
+        'The first parameter of "parseCookies" should be ' +
+          'a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));
@@ -23,15 +23,20 @@ describe('parseCookie', function () {
     throwable('')();
   });
 
-  it('returns cookie parameters', function () {
+  it('returns cookies as a plain object', function () {
     const value = 'pkg=math; equation=E%3Dmc%5E2';
-    const result = parseCookie(value);
+    const result = parseCookies(value);
     expect(result).to.have.property('pkg', 'math');
     expect(result).to.have.property('equation', 'E=mc^2');
   });
 
   it('returns an empty object for an empty string', function () {
-    const result = parseCookie('');
+    const result = parseCookies('');
     expect(result).to.be.eql({});
   });
+
+  it('parses an empty cookie as an empty string', function () {
+    const result = parseCookies('foo=bar; baz');
+    expect(result).to.be.eql({foo: 'bar', baz: ''});
+  });
 });

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

@@ -10,7 +10,7 @@ export function toCamelCase(input) {
   if (typeof input !== 'string')
     throw new Errorf(
       'The first argument of "toCamelCase" ' +
-        'should be a String, but %v given.',
+        'should be a String, but %v was given.',
       input,
     );
   return input

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

@@ -8,7 +8,7 @@ describe('toCamelCase', function () {
     const error = v =>
       format(
         'The first argument of "toCamelCase" ' +
-          'should be a String, but %s given.',
+          'should be a String, but %s was given.',
         v,
       );
     expect(throwable(10)).to.throw(error('10'));

package/src/parsers/cookie-parser.d.ts

@@ -1,15 +0,0 @@
-import {IncomingMessage} from 'http';
-import {ParsedCookie} from '../utils/index.js';
-import {DebuggableService} from '../debuggable-service.js';
-
-/**
- * Cookie parser.
- */
-export declare class CookieParser extends DebuggableService {
-  /**
-   * Parse.
-   *
-   * @param req
-   */
-  parse(req: IncomingMessage): ParsedCookie;
-}

package/src/parsers/cookie-parser.js

@@ -1,32 +0,0 @@
-import {parseCookie} from '../utils/index.js';
-import {getRequestPathname} from '../utils/index.js';
-import {DebuggableService} from '../debuggable-service.js';
-
-/**
- * Cookie parser.
- */
-export class CookieParser extends DebuggableService {
-  /**
-   * Parse
-   *
-   * @param {import('http').IncomingMessage} req
-   * @returns {object}
-   */
-  parse(req) {
-    const cookieString = req.headers['cookie'] || '';
-    const cookie = parseCookie(cookieString);
-    const cookieKeys = Object.keys(cookie);
-    if (cookieKeys.length) {
-      cookieKeys.forEach(key => {
-        this.debug('The cookie %v has the value %v.', key, cookie[key]);
-      });
-    } else {
-      this.debug(
-        'The request %s %v has no cookie.',
-        req.method,
-        getRequestPathname(req),
-      );
-    }
-    return cookie;
-  }
-}

package/src/utils/create-cookie-string.d.ts

@@ -1,6 +0,0 @@
-/**
- * Create cookie string.
- *
- * @param data
- */
-export declare function createCookieString(data: object): string;

package/src/utils/parse-cookie.d.ts

@@ -1,19 +0,0 @@
-/**
- * Parsed cookie.
- */
-type ParsedCookie = {
-  [key: string]: string | undefined;
-};
-
-/**
- * Parse cookie.
- *
- * @example
- * ```ts
- * parseCookie('pkg=math; equation=E%3Dmc%5E2');
- * // {pkg: 'math', equation: 'E=mc^2'}
- * ```
- *
- * @param input
- */
-export declare function parseCookie(input: string): ParsedCookie;