feat: adding support for platform sockets

Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>

Author: jarrodek

src/Server.d.ts

@@ -14,6 +14,27 @@ export class Server {
   opts: ServerConfiguration;
   apiHandler: ApiRoutes;
 
+  /**
+   * This function can be used to create a temporary directory where a socket will be put.
+   * @returns A path to a temporary folder where the socket path can be created.
+   */
+  static createSocketPath(): Promise<string>;
+
+  /**
+   * Use this with combination with the `Server.createSocketPath()`.
+   * 
+   * ```javascript
+   * const socketName = 'my-socket.sock';
+   * const socketPath = await Server.createSocketPath();
+   * const socketLocation = Server.createPlatformSocket(socketPath, socketName);
+   * ```
+   * 
+   * @param socketPath The path to the socket.
+   * @param socketName The socket name.
+   * @returns The platform specific socket path.,
+   */
+  static createPlatformSocket(socketPath: string, socketName: string): string;
+
   /**
    * @param opts Optional server configuration options.
    */
@@ -34,38 +55,38 @@ export class Server {
 
   /**
    * Starts the www server on a given port.
-   * @param port The port number to use.
+   * @param portOrSocket The port number to use or a socket path
    */
-  startHttp(port: number): Promise<void>;
+  startHttp(portOrSocket: number|string): Promise<void>;
 
   /**
    * Stops a running www server, if any.
    * 
-   * @param port When specified it closes a www server on a specific port. When not it stops all running http servers.
+   * @param portOrSocket When specified it closes a www server on a specific port/socket. When not it stops all running http servers.
    */
-  stopHttp(port?: number): Promise<void[]>;
+  stopHttp(portOrSocket?: number|string): Promise<void[]>;
 
   /**
    * Starts the www over SSL server on a given port.
    * 
    * @param sslOptions The SSL options to use when creating the server.
-   * @param port The port number to use.
+   * @param port The port number to use or a socket path
    */
   startSsl(sslOptions: https.ServerOptions, port: number): Promise<void>;
 
   /**
    * Stops a running www over SSL server, if any.
    * 
-   * @param port When specified it closes an ssl server on a specific port. When not it stops all running https servers.
+   * @param portOrSocket When specified it closes an ssl server on a specific port/socket. When not it stops all running https servers.
    */
-  stopSsl(port?: number): Promise<void[]>;
+  stopSsl(portOrSocket?: number|string): Promise<void[]>;
 
   /**
    * 
    * @param type The server type to stop.
-   * @param port The optional port of the server.
+   * @param portOrSocket The optional port of the server.
    */
-  _stop(type: SupportedServer, port: number): Promise<void[]>;
+  _stop(type: SupportedServer, portOrSocket: number|string): Promise<void[]>;
 
   _stopServer(server: https.Server | http.Server): Promise<void>;
 }

src/Server.js

@@ -2,6 +2,9 @@ import Koa from 'koa';
 import http from 'http';
 import https from 'https';
 import cors from '@koa/cors';
+import { dir } from 'tmp-promise';
+import { platform } from 'os';
+import path from 'path';
 import { ApiRoutes } from './ApiRoutes.js';
 
 /** @typedef {import('@koa/cors').Options} CorsOptions */
@@ -14,6 +17,35 @@ import { ApiRoutes } from './ApiRoutes.js';
  * A web server that exposes an API to parse API projects with the AMF parser.
  */
 export class Server {
+  /**
+   * This function can be used to create a temporary directory where a socket will be put.
+   * @returns {Promise<string>} A path to a temporary folder where the socket path can be created.
+   */
+  static async createSocketPath() {
+    const tmpObj = await dir({ unsafeCleanup: true });
+    return tmpObj.path;
+  }
+
+  /**
+   * Use this with combination with the `Server.createSocketPath()`.
+   * 
+   * ```javascript
+   * const socketName = 'my-socket.sock';
+   * const socketPath = await Server.createSocketPath();
+   * const socketLocation = Server.createPlatformSocket(socketPath, socketName);
+   * ```
+   * 
+   * @param {string} socketPath The path to the socket.
+   * @param {string} socketName The socket name.
+   * @returns {string} The platform specific socket path.,
+   */
+  static createPlatformSocket(socketPath, socketName) {
+    if (platform() === 'win32') {
+      return path.join('\\\\?\\pipe', socketPath, socketName);
+    }
+    return path.join(socketPath, socketName)
+  }
+
   /**
    * @param {ServerConfiguration=} opts Optional server configuration options.
    */
@@ -55,18 +87,18 @@ export class Server {
 
   /**
    * Starts the www server on a given port.
-   * @param {number} port The port number to use.
+   * @param {number|string} portOrSocket The port number to use or a socket path
    * @returns {Promise<void>}
    */
-  startHttp(port) {
+  startHttp(portOrSocket) {
     return new Promise((resolve) => {
       const server = http.createServer(this.app.callback());
       this.servers.push({
         server,
         type: 'http',
-        port,
+        portOrSocket,
       });
-      server.listen(port, () => {
+      server.listen(portOrSocket, () => {
         resolve();
       });
     });
@@ -75,28 +107,28 @@ export class Server {
   /**
    * Stops a running www server, if any.
    * 
-   * @param {number=} port When specified it closes a www server on a specific port. When not it stops all running http servers.
+   * @param {number|string=} portOrSocket When specified it closes a www server on a specific port/socket. When not it stops all running http servers.
    * @returns {Promise<void[]>}
    */
-  stopHttp(port) {
-    return this._stop('http', port);
+  stopHttp(portOrSocket) {
+    return this._stop('http', portOrSocket);
   }
 
   /**
    * Starts the www over SSL server on a given port.
    * 
    * @param {https.ServerOptions} sslOptions The SSL options to use when creating the server.
-   * @param {number} port The port number to use.
+   * @param {number|string} portOrSocket The port number to use or a socket path
    */
-  startSsl(sslOptions, port) {
+  startSsl(sslOptions, portOrSocket) {
     return new Promise((resolve) => {
       const server = https.createServer(sslOptions, this.app.callback());
       this.servers.push({
         server,
         type: 'https',
-        port,
+        portOrSocket,
       });
-      server.listen(port, () => {
+      server.listen(portOrSocket, () => {
         resolve();
       });
     });
@@ -105,25 +137,25 @@ export class Server {
   /**
    * Stops a running www over SSL server, if any.
    * 
-   * @param {number=} port When specified it closes an ssl server on a specific port. When not it stops all running https servers.
+   * @param {number|string=} portOrSocket When specified it closes an ssl server on a specific port/socket. When not it stops all running https servers.
    * @returns {Promise<void[]>}
    */
-  stopSsl(port) {
-    return this._stop('https', port);
+  stopSsl(portOrSocket) {
+    return this._stop('https', portOrSocket);
   }
 
   /**
    * 
    * @param {SupportedServer} type The server type to stop.
-   * @param {number} port The optional port of the server.
+   * @param {number|string=} portOrSocket The optional port of the server.
    * @returns {Promise<void[]>}
    * @private
    */
-  _stop(type, port) {
+  _stop(type, portOrSocket) {
     const toStop = this.servers.filter((s) => {
       if (s.type === type) {
-        if (port) {
-          return port === s.port;
+        if (portOrSocket) {
+          return portOrSocket === s.portOrSocket;
         }
         return true;
       }