src/charging-station/ui-server/UIHttpServer.ts

   1 import type { IncomingMessage, RequestListener, ServerResponse } from 'http';
   2
   3 import { StatusCodes } from 'http-status-codes';
   4
   5 import BaseError from '../../exception/BaseError';
   6 import type { UIServerConfiguration } from '../../types/ConfigurationData';
   7 import {
   8   ProcedureName,
   9   Protocol,
  10   ProtocolRequest,
  11   ProtocolResponse,
  12   ProtocolVersion,
  13   RequestPayload,
  14   ResponseStatus,
  15 } from '../../types/UIProtocol';
  16 import logger from '../../utils/Logger';
  17 import Utils from '../../utils/Utils';
  18 import { AbstractUIServer } from './AbstractUIServer';
  19 import { UIServiceUtils } from './ui-services/UIServiceUtils';
  20
  21 const moduleName = 'UIHttpServer';
  22
  23 export default class UIHttpServer extends AbstractUIServer {
  24   public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
  25     super(uiServerConfiguration);
  26   }
  27
  28   public start(): void {
  29     this.httpServer.on('request', this.requestListener.bind(this) as RequestListener);
  30     if (this.httpServer.listening === false) {
  31       this.httpServer.listen(this.uiServerConfiguration.options);
  32     }
  33   }
  34
  35   // eslint-disable-next-line @typescript-eslint/no-unused-vars
  36   public sendRequest(request: ProtocolRequest): void {
  37     // This is intentionally left blank
  38   }
  39
  40   public sendResponse(response: ProtocolResponse): void {
  41     const [uuid, payload] = response;
  42     try {
  43       if (this.responseHandlers.has(uuid) === true) {
  44         const res = this.responseHandlers.get(uuid) as ServerResponse;
  45         res
  46           .writeHead(this.responseStatusToStatusCode(payload.status), {
  47             'Content-Type': 'application/json',
  48           })
  49           .end(JSON.stringify(payload));
  50       } else {
  51         logger.error(
  52           `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}`
  53         );
  54       }
  55     } catch (error) {
  56       logger.error(
  57         `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`,
  58         error
  59       );
  60     } finally {
  61       this.responseHandlers.delete(uuid);
  62     }
  63   }
  64
  65   public logPrefix(modName?: string, methodName?: string, prefixSuffix?: string): string {
  66     const logMsgPrefix = prefixSuffix ? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server';
  67     const logMsg =
  68       modName && methodName ? ` ${logMsgPrefix} | ${modName}.${methodName}:` : ` ${logMsgPrefix} |`;
  69     return Utils.logPrefix(logMsg);
  70   }
  71
  72   private requestListener(req: IncomingMessage, res: ServerResponse): void {
  73     this.authenticate(req, (err) => {
  74       if (err) {
  75         res
  76           .writeHead(StatusCodes.UNAUTHORIZED, {
  77             'Content-Type': 'text/plain',
  78             'WWW-Authenticate': 'Basic realm=users',
  79           })
  80           .end(`${StatusCodes.UNAUTHORIZED} Unauthorized`)
  81           .destroy();
  82         req.destroy();
  83       }
  84     });
  85     // Expected request URL pathname: /ui/:version/:procedureName
  86     const [protocol, version, procedureName] = req.url?.split('/').slice(1) as [
  87       Protocol,
  88       ProtocolVersion,
  89       ProcedureName
  90     ];
  91     const uuid = Utils.generateUUID();
  92     this.responseHandlers.set(uuid, res);
  93     try {
  94       if (UIServiceUtils.isProtocolAndVersionSupported(protocol, version) === false) {
  95         throw new BaseError(`Unsupported UI protocol version: '/${protocol}/${version}'`);
  96       }
  97       this.registerProtocolVersionUIService(version);
  98       req.on('error', (error) => {
  99         logger.error(
 100           `${this.logPrefix(moduleName, 'requestListener.req.onerror')} Error on HTTP request:`,
 101           error
 102         );
 103       });
 104       if (req.method === 'POST') {
 105         const bodyBuffer = [];
 106         req
 107           .on('data', (chunk) => {
 108             bodyBuffer.push(chunk);
 109           })
 110           .on('end', () => {
 111             const body = JSON.parse(Buffer.concat(bodyBuffer).toString()) as RequestPayload;
 112             this.uiServices
 113               .get(version)
 114               .requestHandler(this.buildProtocolRequest(uuid, procedureName, body ?? {}))
 115               .catch(() => {
 116                 /* Error caught by AbstractUIService */
 117               });
 118           });
 119       } else {
 120         throw new BaseError(`Unsupported HTTP method: '${req.method}'`);
 121       }
 122     } catch (error) {
 123       logger.error(
 124         `${this.logPrefix(moduleName, 'requestListener')} Handle HTTP request error:`,
 125         error
 126       );
 127       this.sendResponse(this.buildProtocolResponse(uuid, { status: ResponseStatus.FAILURE }));
 128     }
 129   }
 130
 131   private responseStatusToStatusCode(status: ResponseStatus): StatusCodes {
 132     switch (status) {
 133       case ResponseStatus.SUCCESS:
 134         return StatusCodes.OK;
 135       case ResponseStatus.FAILURE:
 136         return StatusCodes.BAD_REQUEST;
 137       default:
 138         return StatusCodes.INTERNAL_SERVER_ERROR;
 139     }
 140   }
 141 }