SShotService.js

Filename	Percent	Threshold	Total	Covered	Uncovered
src/screenshots/SShotService.js	83.33%	80%	102	85	17

// @ts-check
// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: 2024 CERN (home.cern)
// SPDX-FileContributor: Author: Sylvain Fargier <sylvain.fargier@cern.ch>

import axios from "axios";
import d from "debug";

const debug = d("cam:sshot");

/**
 * @typedef {import('express').IRouter} expressIRouter
 * @typedef {import('express-ws').WithWebsocketMethod & expressIRouter} IRouter
 *
 * @typedef {import('express').Request} Request
 * @typedef {import('express').Response} Response
 */

class SShotService {
  /**
   * @param {CamExpress.InternalGroupConfig} groups
   * @param {CamExpress.Credentials} credentials
   */
  constructor(groups, credentials) {
    this.groups = groups;
    this.creds = credentials;
  }

  /** @param {IRouter} router */
  register(router) {
    /**
     * @swagger
     * /cameras/{group}/{camera}/screenshot:
     *   get:
     *     tags: ['screenshot']
     *     summary: get a camera screenshot
     *     description: |
     *       Take a screenshot of the current video stream, highest quality possible
     *     parameters:
     *      - in: path
     *        name: group
     *        schema:
     *           type: string
     *        description: name of the group defined in the config
     *        required: true
     *      - in: path
     *        name: camera
     *        schema:
     *           type: string
     *        description: name of the camera defined in the config
     *        required: true
     *     produces:
     *       - image/jpeg
     *     responses:
     *       200:
     *         description: video stream screenshot
     *       500:
     *         description: error message
     */
    router.get("/cameras/:group/:camera/screenshot",
      this.getSShot.bind(this));
  }

  /**
   * @param {Request} req
   * @param {Response} res
   */
  getSShot(req, res) {
    const camera = this.getCamera(req);
    if (!camera) {
      res.status(404).send("no such camera");
    }
    else if (!camera.screenshot) {
      res.status(500).send("no screenshot for camera");
    }
    else {
      debug("taking screenshot for %s", camera.name);
      const opts = { timeout: 10000, responseType: "stream" };
      const auth = this.creds[camera.name];
      if (auth) {
        opts.auth = { username: auth.user, password: auth.password };
      }

      axios.get(camera.screenshot, opts)
      .then(
        (response) => response.data.pipe(res),
        (err) => {
          const msg = err?.response?.statusText || err?.message;
          debug("screenshot error: %s", msg ?? "?");
          res.status(err?.response?.status ?? 500)
          .send(msg ? ("internal error: " + msg) : "internal error");
        });
    }
  }

  /**
   * @param {Request} req
   * @return {CamExpress.CameraConfig&{id:string|number}|undefined}
   */
  getCamera(req) {
    const group = req?.params?.group;
    const camera = req?.params?.camera;
    return this.groups?.[group]?.cameras?.[camera];
  }

  release() {}
}

export default SShotService;

[{"file":"src/screenshots/SShotService.js","line":24,"character":9,"text":"groups","kind":1},{"file":"src/screenshots/SShotService.js","line":25,"character":9,"text":"creds","kind":1},{"file":"src/screenshots/SShotService.js","line":85,"character":31,"text":"data","kind":1},{"file":"src/screenshots/SShotService.js","line":85,"character":36,"text":"pipe","kind":1},{"file":"src/screenshots/SShotService.js","line":86,"character":9,"text":"err","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":16,"text":"msg","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":22,"text":"err","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":27,"text":"response","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":37,"text":"statusText","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":51,"text":"err","kind":1},{"file":"src/screenshots/SShotService.js","line":87,"character":56,"text":"message","kind":1},{"file":"src/screenshots/SShotService.js","line":88,"character":40,"text":"msg","kind":1},{"file":"src/screenshots/SShotService.js","line":89,"character":21,"text":"err","kind":1},{"file":"src/screenshots/SShotService.js","line":89,"character":26,"text":"response","kind":1},{"file":"src/screenshots/SShotService.js","line":89,"character":36,"text":"status","kind":1},{"file":"src/screenshots/SShotService.js","line":90,"character":16,"text":"msg","kind":1},{"file":"src/screenshots/SShotService.js","line":90,"character":44,"text":"msg","kind":1}]

TypeScript coverage report