Server.js

Filename	Percent	Threshold	Total	Covered	Uncovered
src/Server.js	94.12%	80%	255	240	15

// @ts-check
const
  express = require('express'),
  helmet = require('helmet'),
  serveStatic = require('express-static-gzip'),
  path = require('path'),
  { attempt, noop } = require('lodash'),
  { makeDeferred } = require('@cern/nodash'),
  ews = require('express-ws'),

  { CamService } = require('@cern/cam-express'),
  logger = require('./httpLogger'),
  auth = require('./auth');

/**
 * @typedef {import('express').Request} Request
 * @typedef {import('express').Response} Response
 * @typedef {import('express').NextFunction} NextFunction
 */

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

  /**
   * @param {AppServer.Config} config
   */
  async prepare(config) {
    if (process.env.NODE_ENV === 'production') {
      this.app.use(helmet.contentSecurityPolicy({
        useDefaults: true,
        directives: {
          imgSrc: [ "'self'", "data:", "blob:" ]
        }
      }));
    }
    logger.register(this.app);
    ews(this.app);

    this.router = express.Router();
    const dist = path.join(__dirname, '..', 'www', 'dist');
    this.router.use('/dist', serveStatic(dist, { enableBrotli: true }));

    /* everything after this point is authenticated */
    if (config.auth) {
      await auth.register(this.router, config);
      this.router.use(this.runAuth.bind(this, 'user'));
    }

    this.app.set('view engine', 'pug');
    this.app.set('views', path.join(__dirname, 'views'));

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

    if (config.auth) {
      // protected admin path for admin role only
      this.router.use('/admin', this.runAuth.bind(this, [ 'admin' ]));
    }

    /* NOTE: declare your additional endpoints here */
    const swaggerOpts = {
      definition: {
        info: {
          title: config.title,
          description: 'Web App API to interact with the back-end',
          contact: config.contact,
          license: config.license
        },
        basePath: config.basePath
      }
    };
    this.camService = new CamService(config.camApp, swaggerOpts);

    if (config.auth) {
      this.router?.put("/*",
        auth.roleCheck.bind(null, [ "expert", "operator" ]));
    }

    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 {string|string[]} role
   * @param {Request} req
   * @param {Response} res
   * @param {NextFunction} next
   */
  runAuth(role, req, res, next) {
    if (req.path.startsWith('/dist')) {
      return next();
    }
    return auth.roleCheck(role, req, res, next);
  }

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

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

module.exports = Server;

[{"file":"src/Server.js","line":25,"character":9,"text":"config","kind":1},{"file":"src/Server.js","line":26,"character":9,"text":"app","kind":1},{"file":"src/Server.js","line":27,"character":9,"text":"camService","kind":1},{"file":"src/Server.js","line":28,"character":9,"text":"_prom","kind":1},{"file":"src/Server.js","line":96,"character":25,"text":"err","kind":1},{"file":"src/Server.js","line":100,"character":17,"text":"message","kind":1},{"file":"src/Server.js","line":100,"character":27,"text":"err","kind":1},{"file":"src/Server.js","line":100,"character":31,"text":"message","kind":1},{"file":"src/Server.js","line":101,"character":17,"text":"error","kind":1},{"file":"src/Server.js","line":101,"character":64,"text":"err","kind":1},{"file":"src/Server.js","line":102,"character":17,"text":"status","kind":1},{"file":"src/Server.js","line":102,"character":26,"text":"err","kind":1},{"file":"src/Server.js","line":102,"character":30,"text":"status","kind":1},{"file":"src/Server.js","line":103,"character":17,"text":"err","kind":1},{"file":"src/Server.js","line":103,"character":21,"text":"status","kind":1}]

TypeScript coverage report