@loopback/http-server 2.5.3

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2018,2019.
+Node module: @loopback/http-server
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# @loopback/http-server
+
+This package implements the HTTP / HTTPS server endpoint for LoopBack 4 apps.
+
+## Overview
+
+This is an internal package used by LoopBack 4 for creating HTTP / HTTPS server.
+
+## Installation
+
+To use this package, you'll need to install `@loopback/http-server`.
+
+```sh
+npm i @loopback/http-server
+```
+
+## Usage
+
+`@loopback/http-server` should be instantiated with a request handler function,
+and an HTTP / HTTPS options object.
+
+```js
+const httpServer = new HttpServer(
+  (req, res) => {
+    res.end('Hello world');
+  },
+  {port: 3000, host: ''},
+);
+```
+
+Instance methods of `HttpServer`.
+
+| Method    | Description       |
+| --------- | ----------------- |
+| `start()` | Starts the server |
+| `stop()`  | Stops the server  |
+
+Instance properties of `HttpServer`.
+
+| Property   | Description            |
+| ---------- | ---------------------- |
+| `address`  | Address details        |
+| `host`     | host of the server     |
+| `port`     | port of the server     |
+| `protocol` | protocol of the server |
+| `url`      | url the server         |
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/wiki/Contributing#guidelines)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+MIT

package/dist/http-server.d.ts

@@ -0,0 +1,103 @@
+/// <reference types="node" />
+import http, { IncomingMessage, Server, ServerResponse } from 'http';
+import https from 'https';
+import { AddressInfo, ListenOptions } from 'net';
+/**
+ * Request listener function for http/https requests
+ */
+export declare type RequestListener = (req: IncomingMessage, res: ServerResponse) => void;
+/**
+ * The following are for configuring properties which are directly set on
+ * https://nodejs.org/api/http.html#http_class_http_server and
+ * https://nodejs.org/api/net.html#net_class_net_server
+ */
+export declare type HttpServerProperties = Pick<Server, 'keepAliveTimeout' | 'headersTimeout' | 'maxConnections' | 'maxHeadersCount' | 'timeout'>;
+/**
+ * Base options that are common to http and https servers
+ */
+export interface BaseHttpOptions extends ListenOptions, Partial<HttpServerProperties> {
+    /**
+     * The `gracePeriodForClose` property controls how to stop the server
+     * gracefully. Its value is the number of milliseconds to wait before
+     * in-flight requests finish when the server is being stopped. With this
+     * setting, we also reject new requests from existing keep-alive connections
+     * in addition to stopping accepting new connections.
+     *
+     * Defaults to Infinity (don't force-close). If you want to immediately
+     * destroy all sockets set its value to `0`.
+     *
+     * See {@link https://www.npmjs.com/package/stoppable | stoppable}
+     */
+    gracePeriodForClose?: number;
+}
+/**
+ * HTTP server options
+ */
+export interface HttpOptions extends BaseHttpOptions {
+    protocol?: 'http';
+}
+/**
+ * HTTPS server options
+ */
+export interface HttpsOptions extends BaseHttpOptions, https.ServerOptions {
+    protocol: 'https';
+}
+/**
+ * Possible server options
+ *
+ */
+export declare type HttpServerOptions = HttpOptions | HttpsOptions;
+/**
+ * Supported protocols
+ *
+ */
+export declare type HttpProtocol = 'http' | 'https';
+/**
+ * HTTP / HTTPS server used by LoopBack's RestServer
+ */
+export declare class HttpServer {
+    private _listening;
+    private _protocol;
+    private _address;
+    private requestListener;
+    readonly server: http.Server | https.Server;
+    private _stoppable;
+    readonly serverOptions: HttpServerOptions;
+    /**
+     * @param requestListener
+     * @param serverOptions
+     */
+    constructor(requestListener: RequestListener, serverOptions?: HttpServerOptions);
+    /**
+     * Starts the HTTP / HTTPS server
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the HTTP / HTTPS server
+     */
+    stop(): Promise<void>;
+    /**
+     * Protocol of the HTTP / HTTPS server
+     */
+    get protocol(): HttpProtocol;
+    /**
+     * Port number of the HTTP / HTTPS server
+     */
+    get port(): number;
+    /**
+     * Host of the HTTP / HTTPS server
+     */
+    get host(): string | undefined;
+    /**
+     * URL of the HTTP / HTTPS server
+     */
+    get url(): string;
+    /**
+     * State of the HTTP / HTTPS server
+     */
+    get listening(): boolean;
+    /**
+     * Address of the HTTP / HTTPS server
+     */
+    get address(): string | AddressInfo | undefined;
+}

package/dist/http-server.js

@@ -0,0 +1,184 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/http-server
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpServer = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = tslib_1.__importDefault(require("assert"));
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const events_1 = require("events");
+const http_1 = tslib_1.__importDefault(require("http"));
+const https_1 = tslib_1.__importDefault(require("https"));
+const os_1 = tslib_1.__importDefault(require("os"));
+const stoppable_1 = tslib_1.__importDefault(require("stoppable"));
+const debug = debug_1.default('loopback:http-server');
+/**
+ * HTTP / HTTPS server used by LoopBack's RestServer
+ */
+class HttpServer {
+    /**
+     * @param requestListener
+     * @param serverOptions
+     */
+    constructor(requestListener, serverOptions) {
+        var _a;
+        this._listening = false;
+        debug('Http server options', serverOptions);
+        this.requestListener = requestListener;
+        this.serverOptions = {
+            port: 0,
+            host: undefined,
+            ...serverOptions,
+        };
+        if (this.serverOptions.path) {
+            debug('Http server with IPC path %s', this.serverOptions.path);
+            const ipcPath = this.serverOptions.path;
+            checkNamedPipe(ipcPath);
+            // Remove `port` so that `path` is honored
+            delete this.serverOptions.port;
+        }
+        this._protocol = serverOptions ? (_a = serverOptions.protocol) !== null && _a !== void 0 ? _a : 'http' : 'http';
+        if (this._protocol === 'https') {
+            this.server = https_1.default.createServer(this.serverOptions, this.requestListener);
+        }
+        else {
+            this.server = http_1.default.createServer(this.requestListener);
+        }
+        // Apply server properties
+        const { keepAliveTimeout, headersTimeout, maxConnections, maxHeadersCount, timeout, } = this.serverOptions;
+        if (keepAliveTimeout) {
+            this.server.keepAliveTimeout = keepAliveTimeout;
+        }
+        if (headersTimeout) {
+            this.server.headersTimeout = headersTimeout;
+        }
+        if (maxConnections) {
+            this.server.maxConnections = maxConnections;
+        }
+        if (maxHeadersCount) {
+            this.server.maxHeadersCount = maxHeadersCount;
+        }
+        if (timeout) {
+            this.server.timeout = timeout;
+        }
+        // Set up graceful stop for http server
+        if (typeof this.serverOptions.gracePeriodForClose === 'number') {
+            debug('Http server gracePeriodForClose %d', this.serverOptions.gracePeriodForClose);
+            this._stoppable = stoppable_1.default(this.server, this.serverOptions.gracePeriodForClose);
+        }
+    }
+    /**
+     * Starts the HTTP / HTTPS server
+     */
+    async start() {
+        debug('Starting http server', this.serverOptions);
+        this.server.listen(this.serverOptions);
+        await events_1.once(this.server, 'listening');
+        this._listening = true;
+        const address = this.server.address();
+        assert_1.default(address != null);
+        this._address = address;
+        debug('Http server is listening on', this.url);
+    }
+    /**
+     * Stops the HTTP / HTTPS server
+     */
+    async stop() {
+        if (!this._listening)
+            return;
+        debug('Stopping http server');
+        if (this._stoppable != null) {
+            debug('Stopping http server with graceful close');
+            this._stoppable.stop();
+        }
+        else {
+            this.server.close();
+        }
+        await events_1.once(this.server, 'close');
+        this._listening = false;
+        debug('Http server is stopped');
+    }
+    /**
+     * Protocol of the HTTP / HTTPS server
+     */
+    get protocol() {
+        return this._protocol;
+    }
+    /**
+     * Port number of the HTTP / HTTPS server
+     */
+    get port() {
+        var _a;
+        if (typeof this._address === 'string')
+            return 0;
+        return ((_a = this._address) === null || _a === void 0 ? void 0 : _a.port) || this.serverOptions.port;
+    }
+    /**
+     * Host of the HTTP / HTTPS server
+     */
+    get host() {
+        var _a;
+        if (typeof this._address === 'string')
+            return undefined;
+        return ((_a = this._address) === null || _a === void 0 ? void 0 : _a.address) || this.serverOptions.host;
+    }
+    /**
+     * URL of the HTTP / HTTPS server
+     */
+    get url() {
+        if (typeof this._address === 'string') {
+            /* istanbul ignore if */
+            if (isWin32()) {
+                return this._address;
+            }
+            const basePath = encodeURIComponent(this._address);
+            return `${this.protocol}+unix://${basePath}`;
+        }
+        let host = this.host;
+        if (this._address.family === 'IPv6') {
+            if (host === '::')
+                host = '::1';
+            host = `[${host}]`;
+        }
+        else if (host === '0.0.0.0') {
+            host = '127.0.0.1';
+        }
+        return `${this._protocol}://${host}:${this.port}`;
+    }
+    /**
+     * State of the HTTP / HTTPS server
+     */
+    get listening() {
+        return this._listening;
+    }
+    /**
+     * Address of the HTTP / HTTPS server
+     */
+    get address() {
+        return this._listening ? this._address : undefined;
+    }
+}
+exports.HttpServer = HttpServer;
+/**
+ * Makes sure `path` conform to named pipe naming requirement on Windows
+ *
+ * See https://nodejs.org/api/net.html#net_identifying_paths_for_ipc_connections
+ *
+ * @param ipcPath - Named pipe path
+ */
+function checkNamedPipe(ipcPath) {
+    /* istanbul ignore if */
+    if (isWin32()) {
+        const pipes = ['\\\\?\\pipe\\', '\\\\.\\pipe\\'];
+        assert_1.default(pipes.some(p => ipcPath.startsWith(p)), `Named pipe ${ipcPath} does NOT start with + ${pipes.join(' or ')}`);
+    }
+}
+/**
+ * Check if it's Windows OS
+ */
+function isWin32() {
+    return os_1.default.platform() === 'win32';
+}
+//# sourceMappingURL=http-server.js.map

package/dist/http-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-server.js","sourceRoot":"","sources":["../src/http-server.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,qCAAqC;AACrC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,4DAA4B;AAC5B,0DAAiC;AACjC,mCAA4B;AAC5B,wDAAmE;AACnE,0DAA0B;AAE1B,oDAAoB;AACpB,kEAAkC;AAClC,MAAM,KAAK,GAAG,eAAY,CAAC,sBAAsB,CAAC,CAAC;AAuEnD;;GAEG;AACH,MAAa,UAAU;IASrB;;;OAGG;IACH,YACE,eAAgC,EAChC,aAAiC;;QAd3B,eAAU,GAAG,KAAK,CAAC;QAgBzB,KAAK,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG;YACnB,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,SAAS;YACf,GAAG,aAAa;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE;YAC3B,KAAK,CAAC,8BAA8B,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACxC,cAAc,CAAC,OAAO,CAAC,CAAC;YACxB,0CAA0C;YAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;SAChC;QACD,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,MAAA,aAAa,CAAC,QAAQ,mCAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3E,IAAI,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,YAAY,CAC9B,IAAI,CAAC,aAAoC,EACzC,IAAI,CAAC,eAAe,CACrB,CAAC;SACH;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SACvD;QAED,0BAA0B;QAC1B,MAAM,EACJ,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,eAAe,EACf,OAAO,GACR,GAAG,IAAI,CAAC,aAAa,CAAC;QACvB,IAAI,gBAAgB,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;SACjD;QACD,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;SAC7C;QACD,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;SAC7C;QACD,IAAI,eAAe,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;SAC/C;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;SAC/B;QAED,uCAAuC;QACvC,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,KAAK,QAAQ,EAAE;YAC9D,KAAK,CACH,oCAAoC,EACpC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CACvC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,mBAAS,CACzB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,aAAa,CAAC,mBAAmB,CACvC,CAAC;SACH;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,KAAK,CAAC,sBAAsB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACvC,MAAM,aAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtC,gBAAM,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAQ,CAAC;QACzB,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAC7B,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE;YAC3B,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAClD,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;SACrB;QACD,MAAM,aAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;;QACb,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO,CAAC,CAAC;QAChD,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,IAAI,KAAI,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;;QACb,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACxD,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,KAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACZ,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACrC,wBAAwB;YACxB,IAAI,OAAO,EAAE,EAAE;gBACb,OAAO,IAAI,CAAC,QAAQ,CAAC;aACtB;YACD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO,GAAG,IAAI,CAAC,QAAQ,WAAW,QAAQ,EAAE,CAAC;SAC9C;QACD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,EAAE;YACnC,IAAI,IAAI,KAAK,IAAI;gBAAE,IAAI,GAAG,KAAK,CAAC;YAChC,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC;SACpB;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE;YAC7B,IAAI,GAAG,WAAW,CAAC;SACpB;QACD,OAAO,GAAG,IAAI,CAAC,SAAS,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;CACF;AAxKD,gCAwKC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,OAAe;IACrC,wBAAwB;IACxB,IAAI,OAAO,EAAE,EAAE;QACb,MAAM,KAAK,GAAG,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACjD,gBAAM,CACJ,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACtC,cAAc,OAAO,0BAA0B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACpE,CAAC;KACH;AACH,CAAC;AAED;;GAEG;AACH,SAAS,OAAO;IACd,OAAO,YAAE,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC;AACnC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * HTTP / HTTPS server endpoints for LoopBack 4 apps.
+ *
+ * @remarks
+ * A package used by LoopBack 4 for creating HTTP / HTTPS server.
+ *
+ * @packageDocumentation
+ */
+export * from './http-server';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/http-server
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * HTTP / HTTPS server endpoints for LoopBack 4 apps.
+ *
+ * @remarks
+ * A package used by LoopBack 4 for creating HTTP / HTTPS server.
+ *
+ * @packageDocumentation
+ */
+tslib_1.__exportStar(require("./http-server"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,qCAAqC;AACrC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;GAOG;AAEH,wDAA8B"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@loopback/http-server",
+  "description": "A wrapper for creating HTTP/HTTPS servers",
+  "version": "2.5.3",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/http-server"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-http-server*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "verify": "npm pack && tar xf loopback-http-server*.tgz && tree package && npm run clean"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "dist",
+    "src",
+    "!*/__tests__"
+  ],
+  "dependencies": {
+    "debug": "^4.3.2",
+    "stoppable": "^1.1.0",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/core": "^2.17.0",
+    "@loopback/eslint-config": "^11.0.1",
+    "@loopback/testlab": "^3.4.3",
+    "@types/debug": "^4.1.7",
+    "@types/node": "^10.17.60",
+    "@types/stoppable": "^1.1.1"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/src/http-server.ts

@@ -0,0 +1,281 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/http-server
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import assert from 'assert';
+import debugFactory from 'debug';
+import {once} from 'events';
+import http, {IncomingMessage, Server, ServerResponse} from 'http';
+import https from 'https';
+import {AddressInfo, ListenOptions} from 'net';
+import os from 'os';
+import stoppable from 'stoppable';
+const debug = debugFactory('loopback:http-server');
+
+/**
+ * Request listener function for http/https requests
+ */
+export type RequestListener = (
+  req: IncomingMessage,
+  res: ServerResponse,
+) => void;
+
+/**
+ * The following are for configuring properties which are directly set on
+ * https://nodejs.org/api/http.html#http_class_http_server and
+ * https://nodejs.org/api/net.html#net_class_net_server
+ */
+export type HttpServerProperties = Pick<
+  Server,
+  | 'keepAliveTimeout'
+  | 'headersTimeout'
+  | 'maxConnections'
+  | 'maxHeadersCount'
+  | 'timeout'
+>;
+
+/**
+ * Base options that are common to http and https servers
+ */
+export interface BaseHttpOptions
+  extends ListenOptions,
+    Partial<HttpServerProperties> {
+  /**
+   * The `gracePeriodForClose` property controls how to stop the server
+   * gracefully. Its value is the number of milliseconds to wait before
+   * in-flight requests finish when the server is being stopped. With this
+   * setting, we also reject new requests from existing keep-alive connections
+   * in addition to stopping accepting new connections.
+   *
+   * Defaults to Infinity (don't force-close). If you want to immediately
+   * destroy all sockets set its value to `0`.
+   *
+   * See {@link https://www.npmjs.com/package/stoppable | stoppable}
+   */
+  gracePeriodForClose?: number;
+}
+
+/**
+ * HTTP server options
+ */
+export interface HttpOptions extends BaseHttpOptions {
+  protocol?: 'http';
+}
+
+/**
+ * HTTPS server options
+ */
+export interface HttpsOptions extends BaseHttpOptions, https.ServerOptions {
+  protocol: 'https';
+}
+
+/**
+ * Possible server options
+ *
+ */
+export type HttpServerOptions = HttpOptions | HttpsOptions;
+
+/**
+ * Supported protocols
+ *
+ */
+export type HttpProtocol = 'http' | 'https'; // Will be extended to `http2` in the future
+
+/**
+ * HTTP / HTTPS server used by LoopBack's RestServer
+ */
+export class HttpServer {
+  private _listening = false;
+  private _protocol: HttpProtocol;
+  private _address: string | AddressInfo;
+  private requestListener: RequestListener;
+  readonly server: http.Server | https.Server;
+  private _stoppable: stoppable.StoppableServer;
+  readonly serverOptions: HttpServerOptions;
+
+  /**
+   * @param requestListener
+   * @param serverOptions
+   */
+  constructor(
+    requestListener: RequestListener,
+    serverOptions?: HttpServerOptions,
+  ) {
+    debug('Http server options', serverOptions);
+    this.requestListener = requestListener;
+    this.serverOptions = {
+      port: 0,
+      host: undefined,
+      ...serverOptions,
+    };
+    if (this.serverOptions.path) {
+      debug('Http server with IPC path %s', this.serverOptions.path);
+      const ipcPath = this.serverOptions.path;
+      checkNamedPipe(ipcPath);
+      // Remove `port` so that `path` is honored
+      delete this.serverOptions.port;
+    }
+    this._protocol = serverOptions ? serverOptions.protocol ?? 'http' : 'http';
+    if (this._protocol === 'https') {
+      this.server = https.createServer(
+        this.serverOptions as https.ServerOptions,
+        this.requestListener,
+      );
+    } else {
+      this.server = http.createServer(this.requestListener);
+    }
+
+    // Apply server properties
+    const {
+      keepAliveTimeout,
+      headersTimeout,
+      maxConnections,
+      maxHeadersCount,
+      timeout,
+    } = this.serverOptions;
+    if (keepAliveTimeout) {
+      this.server.keepAliveTimeout = keepAliveTimeout;
+    }
+    if (headersTimeout) {
+      this.server.headersTimeout = headersTimeout;
+    }
+    if (maxConnections) {
+      this.server.maxConnections = maxConnections;
+    }
+    if (maxHeadersCount) {
+      this.server.maxHeadersCount = maxHeadersCount;
+    }
+    if (timeout) {
+      this.server.timeout = timeout;
+    }
+
+    // Set up graceful stop for http server
+    if (typeof this.serverOptions.gracePeriodForClose === 'number') {
+      debug(
+        'Http server gracePeriodForClose %d',
+        this.serverOptions.gracePeriodForClose,
+      );
+      this._stoppable = stoppable(
+        this.server,
+        this.serverOptions.gracePeriodForClose,
+      );
+    }
+  }
+
+  /**
+   * Starts the HTTP / HTTPS server
+   */
+  public async start() {
+    debug('Starting http server', this.serverOptions);
+    this.server.listen(this.serverOptions);
+    await once(this.server, 'listening');
+    this._listening = true;
+
+    const address = this.server.address();
+    assert(address != null);
+    this._address = address!;
+    debug('Http server is listening on', this.url);
+  }
+
+  /**
+   * Stops the HTTP / HTTPS server
+   */
+  public async stop() {
+    if (!this._listening) return;
+    debug('Stopping http server');
+    if (this._stoppable != null) {
+      debug('Stopping http server with graceful close');
+      this._stoppable.stop();
+    } else {
+      this.server.close();
+    }
+    await once(this.server, 'close');
+    this._listening = false;
+    debug('Http server is stopped');
+  }
+
+  /**
+   * Protocol of the HTTP / HTTPS server
+   */
+  public get protocol(): HttpProtocol {
+    return this._protocol;
+  }
+
+  /**
+   * Port number of the HTTP / HTTPS server
+   */
+  public get port(): number {
+    if (typeof this._address === 'string') return 0;
+    return this._address?.port || this.serverOptions.port!;
+  }
+
+  /**
+   * Host of the HTTP / HTTPS server
+   */
+  public get host(): string | undefined {
+    if (typeof this._address === 'string') return undefined;
+    return this._address?.address || this.serverOptions.host;
+  }
+
+  /**
+   * URL of the HTTP / HTTPS server
+   */
+  public get url(): string {
+    if (typeof this._address === 'string') {
+      /* istanbul ignore if */
+      if (isWin32()) {
+        return this._address;
+      }
+      const basePath = encodeURIComponent(this._address);
+      return `${this.protocol}+unix://${basePath}`;
+    }
+    let host = this.host;
+    if (this._address.family === 'IPv6') {
+      if (host === '::') host = '::1';
+      host = `[${host}]`;
+    } else if (host === '0.0.0.0') {
+      host = '127.0.0.1';
+    }
+    return `${this._protocol}://${host}:${this.port}`;
+  }
+
+  /**
+   * State of the HTTP / HTTPS server
+   */
+  public get listening(): boolean {
+    return this._listening;
+  }
+
+  /**
+   * Address of the HTTP / HTTPS server
+   */
+  public get address(): string | AddressInfo | undefined {
+    return this._listening ? this._address : undefined;
+  }
+}
+
+/**
+ * Makes sure `path` conform to named pipe naming requirement on Windows
+ *
+ * See https://nodejs.org/api/net.html#net_identifying_paths_for_ipc_connections
+ *
+ * @param ipcPath - Named pipe path
+ */
+function checkNamedPipe(ipcPath: string) {
+  /* istanbul ignore if */
+  if (isWin32()) {
+    const pipes = ['\\\\?\\pipe\\', '\\\\.\\pipe\\'];
+    assert(
+      pipes.some(p => ipcPath.startsWith(p)),
+      `Named pipe ${ipcPath} does NOT start with + ${pipes.join(' or ')}`,
+    );
+  }
+}
+
+/**
+ * Check if it's Windows OS
+ */
+function isWin32() {
+  return os.platform() === 'win32';
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/http-server
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * HTTP / HTTPS server endpoints for LoopBack 4 apps.
+ *
+ * @remarks
+ * A package used by LoopBack 4 for creating HTTP / HTTPS server.
+ *
+ * @packageDocumentation
+ */
+
+export * from './http-server';