refactor: improve error reporting in the UI server code

[e-mobility-charging-stations-simulator.git] / src / charging-station / ui-server / AbstractUIServer.ts

import { type IncomingMessage, Server, type ServerResponse } from 'node:http'
import { type Http2Server, createServer } from 'node:http2'

import type { WebSocket } from 'ws'

import type { AbstractUIService } from './ui-services/AbstractUIService.js'
import { UIServiceFactory } from './ui-services/UIServiceFactory.js'
import { getUsernameAndPasswordFromAuthorizationToken } from './UIServerUtils.js'
import { BaseError } from '../../exception/index.js'
import {
  ApplicationProtocolVersion,
  AuthenticationType,
  type ChargingStationData,
  type ProcedureName,
  type ProtocolRequest,
  type ProtocolResponse,
  ProtocolVersion,
  type RequestPayload,
  type ResponsePayload,
  type UIServerConfiguration
} from '../../types/index.js'
import { logger } from '../../utils/index.js'

const moduleName = 'AbstractUIServer'

export abstract class AbstractUIServer {
  public readonly chargingStations: Map<string, ChargingStationData>
  public readonly chargingStationTemplates: Set<string>
  protected readonly httpServer: Server | Http2Server
  protected readonly responseHandlers: Map<string, ServerResponse | WebSocket>
  protected readonly uiServices: Map<ProtocolVersion, AbstractUIService>

  public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) {
    this.chargingStations = new Map<string, ChargingStationData>()
    this.chargingStationTemplates = new Set<string>()
    switch (this.uiServerConfiguration.version) {
      case ApplicationProtocolVersion.VERSION_11:
        this.httpServer = new Server()
        break
      case ApplicationProtocolVersion.VERSION_20:
        this.httpServer = createServer()
        break
      default:
        throw new BaseError(
          `Unsupported application protocol version ${this.uiServerConfiguration.version}`
        )
    }
    this.responseHandlers = new Map<string, ServerResponse | WebSocket>()
    this.uiServices = new Map<ProtocolVersion, AbstractUIService>()
  }

  public buildProtocolRequest (
    id: string,
    procedureName: ProcedureName,
    requestPayload: RequestPayload
  ): ProtocolRequest {
    return [id, procedureName, requestPayload]
  }

  public buildProtocolResponse (id: string, responsePayload: ResponsePayload): ProtocolResponse {
    return [id, responsePayload]
  }

  public stop (): void {
    this.stopHttpServer()
    for (const uiService of this.uiServices.values()) {
      uiService.stop()
    }
    this.clearCaches()
  }

  public clearCaches (): void {
    this.chargingStations.clear()
    this.chargingStationTemplates.clear()
  }

  public async sendInternalRequest (request: ProtocolRequest): Promise<ProtocolResponse> {
    const protocolVersion = ProtocolVersion['0.0.1']
    this.registerProtocolVersionUIService(protocolVersion)
    return await (this.uiServices
      .get(protocolVersion)
      ?.requestHandler(request) as Promise<ProtocolResponse>)
  }

  public hasResponseHandler (id: string): boolean {
    return this.responseHandlers.has(id)
  }

  protected startHttpServer (): void {
    this.httpServer.on('error', error => {
      logger.error(
        `${this.logPrefix(moduleName, 'start.httpServer.on.error')} HTTP server error:`,
        error
      )
    })
    if (!this.httpServer.listening) {
      this.httpServer.listen(this.uiServerConfiguration.options)
    }
  }

  protected registerProtocolVersionUIService (version: ProtocolVersion): void {
    if (!this.uiServices.has(version)) {
      this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this))
    }
  }

  protected authenticate (req: IncomingMessage, next: (err?: Error) => void): void {
    const authorizationError = new BaseError('Unauthorized')
    if (this.isBasicAuthEnabled()) {
      if (!this.isValidBasicAuth(req, next)) {
        next(authorizationError)
      }
      next()
    } else if (this.isProtocolBasicAuthEnabled()) {
      if (!this.isValidProtocolBasicAuth(req, next)) {
        next(authorizationError)
      }
      next()
    } else if (this.uiServerConfiguration.authentication?.enabled === true) {
      next(authorizationError)
    }
    next()
  }

  private stopHttpServer (): void {
    if (this.httpServer.listening) {
      this.httpServer.close()
      this.httpServer.removeAllListeners()
    }
  }

  private isBasicAuthEnabled (): boolean {
    return (
      this.uiServerConfiguration.authentication?.enabled === true &&
      this.uiServerConfiguration.authentication.type === AuthenticationType.BASIC_AUTH
    )
  }

  private isProtocolBasicAuthEnabled (): boolean {
    return (
      this.uiServerConfiguration.authentication?.enabled === true &&
      this.uiServerConfiguration.authentication.type === AuthenticationType.PROTOCOL_BASIC_AUTH
    )
  }

  private isValidBasicAuth (req: IncomingMessage, next: (err?: Error) => void): boolean {
    const [username, password] = getUsernameAndPasswordFromAuthorizationToken(
      req.headers.authorization?.split(/\s+/).pop() ?? '',
      next
    )
    return this.isValidUsernameAndPassword(username, password)
  }

  private isValidProtocolBasicAuth (req: IncomingMessage, next: (err?: Error) => void): boolean {
    const authorizationProtocol = req.headers['sec-websocket-protocol']?.split(/,\s+/).pop()
    const [username, password] = getUsernameAndPasswordFromAuthorizationToken(
      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
      `${authorizationProtocol}${Array(((4 - (authorizationProtocol!.length % 4)) % 4) + 1).join('=')}`
        .split('.')
        .pop() ?? '',
      next
    )
    return this.isValidUsernameAndPassword(username, password)
  }

  private isValidUsernameAndPassword (username: string, password: string): boolean {
    return (
      this.uiServerConfiguration.authentication?.username === username &&
      this.uiServerConfiguration.authentication.password === password
    )
  }

  public abstract start (): void
  public abstract sendRequest (request: ProtocolRequest): void
  public abstract sendResponse (response: ProtocolResponse): void
  public abstract logPrefix (moduleName?: string, methodName?: string, prefixSuffix?: string): string
}