@e22m4u/js-http-static-router 0.1.2 → 0.2.1

package/src/http-static-router.js

@@ -1,6 +1,5 @@
 import path from 'path';
 import mimeTypes from 'mime-types';
-import {IncomingMessage} from 'http';
 import fs, {createReadStream} from 'fs';
 import {StaticRoute} from './static-route.js';
 import {getPathnameFromUrl} from './utils/index.js';
@@ -41,7 +40,7 @@ export class HttpStaticRouter extends DebuggableService {
    */
   constructor(containerOrOptions, options) {
     const debugOptions = {
-      noEnvironmentNamespace: true,
+      noGlobalNamespace: true,
       namespace: 'jsHttpStaticRouter',
     };
     if (isServiceContainer(containerOrOptions)) {
@@ -53,18 +52,18 @@ export class HttpStaticRouter extends DebuggableService {
         Array.isArray(containerOrOptions)
       ) {
         throw new InvalidArgumentError(
-          'Parameter "containerOrOptions" must be an Object ' +
-            'or an instance of ServiceContainer, but %v was given.',
-          options,
+          'First parameter must be an Object or an instance ' +
+            'of ServiceContainer, but %v was given.',
+          containerOrOptions,
         );
       }
-      super(undefined, debugOptions);
+      super(debugOptions);
       if (options === undefined) {
         options = containerOrOptions;
         containerOrOptions = undefined;
       }
     } else {
-      super(undefined, debugOptions);
+      super(debugOptions);
     }
     // options
     if (options !== undefined) {
@@ -98,15 +97,23 @@ export class HttpStaticRouter extends DebuggableService {
    * Define route.
    *
    * @param {import('./static-route.js').StaticRouteDefinition} routeDef
-   * @returns {this}
+   * @returns {import('./static-route.js').StaticRoute}
    */
   defineRoute(routeDef) {
+    // options
     if (!routeDef || typeof routeDef !== 'object' || Array.isArray(routeDef)) {
       throw new InvalidArgumentError(
         'Parameter "routeDef" must be an Object, but %v was given.',
         routeDef,
       );
     }
+    // options.resourcePath
+    if (typeof routeDef.resourcePath !== 'string') {
+      throw new InvalidArgumentError(
+        'Option "resourcePath" must be a String, but %v was given.',
+        routeDef.resourcePath,
+      );
+    }
     if (
       this._options.baseDir !== undefined &&
       !path.isAbsolute(routeDef.resourcePath)
@@ -117,22 +124,37 @@ export class HttpStaticRouter extends DebuggableService {
         routeDef.resourcePath,
       );
     }
+    if (
+      this._options.baseDir === undefined &&
+      !path.isAbsolute(routeDef.resourcePath)
+    ) {
+      throw new InvalidArgumentError(
+        'Option "resourcePath" must be an absolute path when the router ' +
+          'option "basePath" is not specified, but %v was given.',
+        routeDef.resourcePath,
+      );
+    }
     const debug = this.getDebuggerFor(this.defineRoute);
     const route = new StaticRoute(routeDef);
     debug('Adding a new route.');
-    debug('Resource path is %v.', route.resourcePath);
     debug('Remote path is %v.', route.remotePath);
+    debug('Resource path is %v.', route.resourcePath);
     debug('Resource type is %s.', route.isFile ? 'File' : 'Folder');
     this._routes.push(route);
     // самые длинные пути проверяются первыми,
     // чтобы избежать коллизий при поиске маршрута
     this._routes.sort((a, b) => b.remotePath.length - a.remotePath.length);
-    return this;
+    return route;
   }
 
   /**
    * Handle request.
    *
+   * Метод возвращает Promise, который разрешается как:
+   *   - false, если маршрут не совпал, файл не найден
+   *     или метод запроса не поддерживается;
+   *   - true, во всех остальных случаях;
+   *
    * @param {import('http').IncomingMessage} request
    * @param {import('http').ServerResponse} response
    * @returns {Promise<boolean>}
@@ -140,7 +162,7 @@ export class HttpStaticRouter extends DebuggableService {
   async handleRequest(request, response) {
     const fileInfo = await this._findFileForRequest(request);
     if (fileInfo !== undefined) {
-      this._sendFile(request, response, fileInfo);
+      await this._sendFile(request, response, fileInfo);
       return true;
     }
     return false;
@@ -153,13 +175,6 @@ export class HttpStaticRouter extends DebuggableService {
    * @returns {Promise<FileInfo|undefined>|undefined}
    */
   async _findFileForRequest(request) {
-    if (!(request instanceof IncomingMessage)) {
-      throw new InvalidArgumentError(
-        'Parameter "request" must be an instance of IncomingMessage, ' +
-          'but %v was given.',
-        request,
-      );
-    }
     const debug = this.getDebuggerFor(this._findFileForRequest);
     debug('File finding for an incoming request.');
     debug('Incoming request %s %v.', request.method, request.url);
@@ -184,21 +199,22 @@ export class HttpStaticRouter extends DebuggableService {
     }
     debug('Walking through %v routes.', this._routes.length);
     for (const route of this._routes) {
-      const isMatched = route.regexp.test(requestPath);
+      const isMatched = route.regexp.test(requestPath || '/');
       if (isMatched) {
         debug('Matched route %v.', route.remotePath);
         // если ресурс ссылается на папку, то из адреса запроса
         // извлекается дополнительная часть (если присутствует),
         // и формируется целевой путь файловой системы
         let targetPath = route.resourcePath;
+        let extraPath = ''; // дополнительная часть адреса
         if (!route.isFile) {
           // извлечение относительного пути в дополнение к адресу
           // ресурса путем удаления из адреса запроса той части,
           // которая была указана при объявлении маршрута
-          const relativePath = requestPath.replace(route.regexp, '');
+          extraPath = requestPath.replace(route.regexp, '');
           // объединение адреса ресурса
           // с дополнительной частью
-          targetPath = path.join(route.resourcePath, relativePath);
+          targetPath = path.join(route.resourcePath, extraPath);
         }
         // если обнаружена попытка выхода за пределы
         // директории маршрута, то возвращается undefined
@@ -226,17 +242,17 @@ export class HttpStaticRouter extends DebuggableService {
         // если размер файла определен, то поиск
         // прерывается и возвращается информация
         if (fileSize !== undefined) {
-          // если файл найден, но запрос заканчивается
-          // на слеш, то файл должен быть проигнорирован
-          if (requestPath.endsWith('/')) {
+          // если файл найден, и дополнительная часть запроса
+          // заканчивается на слеш, то файл игнорируется
+          if (extraPath && extraPath.endsWith('/')) {
             continue;
           }
-          debug('File found %v.', targetPath);
+          debug('Found file %v.', targetPath);
           return {path: targetPath, size: fileSize};
         }
       }
     }
-    debug('File not found.');
+    debug('File was not found.');
   }
 
   /**
@@ -245,17 +261,16 @@ export class HttpStaticRouter extends DebuggableService {
    * @param {import('http').IncomingMessage} request
    * @param {import('http').ServerResponse} response
    * @param {FileInfo} fileInfo
+   * @returns {Promise<void>}
    */
-  _sendFile(request, response, fileInfo) {
+  async _sendFile(request, response, fileInfo) {
+    let resolve;
+    const promise = new Promise(res => (resolve = res));
     const debug = this.getDebuggerFor(this._sendFile);
     debug('File sending for an incoming request.');
     debug('Incoming request %s %v.', request.method, request.url);
     debug('File path %v.', fileInfo.path);
     debug('File size %v bytes.', fileInfo.size);
-    if (request.method !== 'GET' && request.method !== 'HEAD') {
-      debug('Method not allowed.');
-      return;
-    }
     // формирование заголовка "content-type"
     // в зависимости от расширения файла
     const extname = path.extname(fileInfo.path);
@@ -266,15 +281,24 @@ export class HttpStaticRouter extends DebuggableService {
     const fileStream = createReadStream(fileInfo.path);
     fileStream.on('error', error => {
       debug('Unable to open a file stream.');
-      this._handleFsError(error, response);
+      console.error(error);
+      if (response.headersSent) {
+        response.destroy();
+        resolve();
+        return;
+      }
+      response.statusCode = 500;
+      response.setHeader('Content-Type', 'text/plain; charset=utf-8');
+      response.write('500 Internal Server Error');
+      response.end();
+      resolve();
     });
     // отправка заголовка 200, только после
     // этого начинается отдача файла
     fileStream.on('open', () => {
-      response.writeHead(200, {
-        'Content-Type': contentType,
-        'Content-Length': fileInfo.size,
-      });
+      response.statusCode = 200;
+      response.setHeader('Content-Type', contentType);
+      response.setHeader('Content-Length', fileInfo.size);
       // для HEAD запроса отправляются
       // только заголовки (без тела)
       if (request.method === 'HEAD') {
@@ -288,31 +312,19 @@ export class HttpStaticRouter extends DebuggableService {
       fileStream.pipe(response);
     });
     request.on('close', () => {
-      debug('File has been sent.');
-      fileStream.destroy();
+      // если ответ еще не закончен,
+      // значит клиент оборвал соединение
+      if (!response.writableFinished) {
+        debug('Request closed prematurely by the client.');
+        fileStream.destroy();
+        resolve();
+      }
     });
-  }
-
-  /**
-   * Handle filesystem error.
-   *
-   * @param {object} error
-   * @param {object} response
-   * @returns {undefined}
-   */
-  _handleFsError(error, response) {
-    if (response.headersSent) {
-      response.destroy();
-      return;
-    }
-    if ('code' in error && error.code === 'ENOENT') {
-      response.writeHead(404, {'Content-Type': 'text/plain'});
-      response.write('404 Not Found');
-      response.end();
-    } else {
-      response.writeHead(500, {'Content-Type': 'text/plain'});
-      response.write('500 Internal Server Error');
-      response.end();
-    }
+    // успешное завершение отправки ответа
+    response.on('finish', () => {
+      debug('File has been sent successfully.');
+      resolve();
+    });
+    return promise;
   }
 }