@underpostnet/underpost/src/server/peer.js

Underpost Platform — end-to-end CI/CD and application-delivery toolchain CLI. Covers bare metal, Kubernetes, K3s, kubeadm, LXD, container/image orchestration, secrets, databases, cron jobs, monitoring, SSH, runners, PWA + Workbox delivery, and release orc

/**
 * Module for peerjs server management.
 * Initializes and configures the PeerJS server instance, typically running
 * alongside a main Node.js application.
 *
 * @module src/server/peer.js
 * @namespace Peer
 */

import { PeerServer } from 'peer';
import dotenv from 'dotenv';
import { loggerFactory } from './logger.js';
import Underpost from '../index.js';

/**
 * Logger instance for this module, utilizing the framework's factory.
 * @type {function(*): void}
 * @memberof Peer
 * @private
 */
const logger = loggerFactory(import.meta);

// Documentation references:
// https://github.com/peers/peerjs
// https://github.com/peers/peerjs-server

/**
 * Creates and starts a configured PeerJS server instance.
 *
 * This function handles port configuration, CORS origins, and paths, then uses
 * a listener factory to start the server.
 *
 * @async
 * @function createPeerServer
 * @memberof Peer
 * @param {object} config - Configuration object for the PeerJS server setup.
 * @param {number} config.port - The primary port on which the PeerJS server will listen.
 * @param {string[]} config.origins - An array of allowed domain origins for Cross-Origin Resource Sharing (CORS).
 * @param {string} config.path - The base path for the API. The PeerJS path ('/peer') will be appended to this.
 * @returns {Promise<object>} A promise that resolves to an object containing the final configuration and the server instance.
 * @returns {import('peer').IConfig} return.options - The final options object used to create the PeerServer.
 * @returns {import('peer').Server} return.peerServer - The created and listening PeerServer instance (wrapped by the listening server factory).
 * @returns {object} return.meta - The module's import meta object (`import.meta`).
 */
const createPeerServer = async ({ port, origins, path }) => {
  logger.info('origins', origins);

  // In development, allow the local client origin (peer runs on port+1 relative to the client)
  if (process.env.NODE_ENV === 'development') {
    const clientPort = port - 1;
    const devOrigin = `http://localhost:${clientPort}`;
    if (!origins.includes(devOrigin)) origins.push(devOrigin);
  }

  /** @type {import('peer').IConfig} */
  const options = {
    port,
    // Ensure the path is correctly formatted, handling the root path case
    path: `${path === '/' ? '' : path}/peer`,
    corsOptions: {
      origin: origins,
    },
    proxied: true,
    // key: fs.readFileSync(''), // Example for HTTPS/SSL
    // cert: fs.readFileSync(''), // Example for HTTPS/SSL
    // ca: fs.readFileSync(''),   // Example for HTTPS/SSL
  };

  // Use the framework's factory to listen on the server, ensuring graceful startup/shutdown
  const peerServer = Underpost.start.listenServerFactory(async () => PeerServer(options));

  return { options, peerServer, meta: import.meta };
};

export { createPeerServer };