CamServer.js

Filename	Percent	Threshold	Total	Covered	Uncovered
test/utils/CamServer.js	90.13%	80%	152	137	15

// @ts-check
// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: 2024 CERN (home.cern)

import express from "express";
import path from "node:path";
import { makeDeferred } from "@cern/nodash";
import ews from "express-ws";

import { CamService } from "../../src/index.js";
import { fileURLToPath } from "node:url";

/**
 * @typedef {import('express').Request} Request
 * @typedef {import('express').Response} Response
 * @typedef {import('express').NextFunction} NextFunction
 * @typedef {{
 *   camApp: CamExpress.Config
 *   basePath: string
 * }} Config
 */

const dirname = path.dirname(fileURLToPath(import.meta.url));

class Server {
  /**
   * @param {Config} config
   */
  constructor(config) {
    this.config = config;
    this.app = express();
    this.camService = null;
    this._prom = this.prepare(config);
  }

  /**
   * @param {Config} config
   */
  async prepare(config) {
    ews(this.app);

    this.router = express.Router();

    this.app.set("view engine", "pug");
    this.app.set("views", path.join(dirname, "views"));

    this.router.get("/", (req, res) => res.render("index", config));

    /* NOTE: declare your additional endpoints here */
    this.camService = new CamService(config.camApp);
    this.camService.register(this.router);

    this.app.use(config.basePath, this.router);

    // default route
    this.app.use(function(req, res, next) {
      next({ status: 404, message: "Not Found" });
    });

    // error handler
    this.app.use(function(
      /** @type {any} */ err,
      /** @type {Request} */ req,
      /** @type {Response} */res,
      /** @type {NextFunction} */ next) { /* eslint-disable-line */ /* jshint ignore:line */
      res.locals.message = err.message;
      res.locals.error = req.app.get("env") === "development" ? err : {};
      res.locals.status = err.status || 500;
      res.status(err.status || 500);
      res.render("error", config);
    });
  }

  close() {
    if (this.camService) {
      this.camService.release();
      this.camService = null;
    }
    if (this.server) {
      this.server.close();
      this.server = null;
    }
  }

  /**
   * @param {() => any} cb
   */
  async listen(cb) {
    await this._prom;
    const def = makeDeferred();
    /* we're called as a main, let's listen */
    // @ts-ignore
    var server = this.app.listen(this.config.port, () => {
      this.server = server;
      def.resolve(undefined);
      return cb?.();
    });
    return def.promise;
  }

  address() {
    return this.server?.address() ?? null;
  }
}

export default Server;

[{"file":"test/utils/CamServer.js","line":29,"character":9,"text":"config","kind":1},{"file":"test/utils/CamServer.js","line":30,"character":9,"text":"app","kind":1},{"file":"test/utils/CamServer.js","line":31,"character":9,"text":"camService","kind":1},{"file":"test/utils/CamServer.js","line":32,"character":9,"text":"_prom","kind":1},{"file":"test/utils/CamServer.js","line":61,"character":25,"text":"err","kind":1},{"file":"test/utils/CamServer.js","line":65,"character":17,"text":"message","kind":1},{"file":"test/utils/CamServer.js","line":65,"character":27,"text":"err","kind":1},{"file":"test/utils/CamServer.js","line":65,"character":31,"text":"message","kind":1},{"file":"test/utils/CamServer.js","line":66,"character":17,"text":"error","kind":1},{"file":"test/utils/CamServer.js","line":66,"character":64,"text":"err","kind":1},{"file":"test/utils/CamServer.js","line":67,"character":17,"text":"status","kind":1},{"file":"test/utils/CamServer.js","line":67,"character":26,"text":"err","kind":1},{"file":"test/utils/CamServer.js","line":67,"character":30,"text":"status","kind":1},{"file":"test/utils/CamServer.js","line":68,"character":17,"text":"err","kind":1},{"file":"test/utils/CamServer.js","line":68,"character":21,"text":"status","kind":1}]

TypeScript coverage report