X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=ui%2Fweb%2Fsrc%2Fcomposables%2FUIClient.ts;h=9522c59213c666a526d48927447024f3e8fc065a;hb=9312c9d319ab997598eb1fe198f0615f12e766f4;hp=9848fac0b03fd136c5fea25a9ed84fa42d282702;hpb=217db0589a326b179780002c076e9ec7fca59d8c;p=e-mobility-charging-stations-simulator.git diff --git a/ui/web/src/composables/UIClient.ts b/ui/web/src/composables/UIClient.ts index 9848fac0..9522c592 100644 --- a/ui/web/src/composables/UIClient.ts +++ b/ui/web/src/composables/UIClient.ts @@ -1,14 +1,18 @@ +import { useToast } from 'vue-toast-notification' + import { ApplicationProtocol, + AuthenticationType, + type ChargingStationOptions, ProcedureName, type ProtocolResponse, type RequestPayload, type ResponsePayload, - ResponseStatus + ResponseStatus, + type UIServerConfigurationSection } from '@/types' -// @ts-expect-error: configuration file can be non existent -// eslint-disable-next-line import/no-unresolved -import configuration from '@/assets/config' + +import { randomUUID, validateUUID } from './Utils' type ResponseHandler = { procedureName: ProcedureName @@ -19,23 +23,57 @@ type ResponseHandler = { export class UIClient { private static instance: UIClient | null = null - private ws!: WebSocket - private responseHandlers: Map + private ws?: WebSocket + private responseHandlers: Map< + `${string}-${string}-${string}-${string}-${string}`, + ResponseHandler + > - private constructor() { + private constructor(private uiServerConfiguration: UIServerConfigurationSection) { this.openWS() - this.responseHandlers = new Map() + this.responseHandlers = new Map< + `${string}-${string}-${string}-${string}-${string}`, + ResponseHandler + >() } - public static getInstance() { + public static getInstance(uiServerConfiguration?: UIServerConfigurationSection): UIClient { if (UIClient.instance === null) { - UIClient.instance = new UIClient() + if (uiServerConfiguration == null) { + throw new Error('Cannot initialize UIClient if no configuration is provided') + } + UIClient.instance = new UIClient(uiServerConfiguration) } return UIClient.instance } - public registerWSonOpenListener(listener: (event: Event) => void) { - this.ws.addEventListener('open', listener) + public setConfiguration(uiServerConfiguration: UIServerConfigurationSection): void { + if (this.ws?.readyState === WebSocket.OPEN) { + this.ws.close() + delete this.ws + } + this.uiServerConfiguration = uiServerConfiguration + this.openWS() + } + + public registerWSEventListener( + event: K, + listener: (event: WebSocketEventMap[K]) => void, + options?: boolean | AddEventListenerOptions + ) { + this.ws?.addEventListener(event, listener, options) + } + + public unregisterWSEventListener( + event: K, + listener: (event: WebSocketEventMap[K]) => void, + options?: boolean | AddEventListenerOptions + ) { + this.ws?.removeEventListener(event, listener, options) + } + + public async simulatorState(): Promise { + return this.sendRequest(ProcedureName.SIMULATOR_STATE, {}) } public async startSimulator(): Promise { @@ -46,10 +84,37 @@ export class UIClient { return this.sendRequest(ProcedureName.STOP_SIMULATOR, {}) } + public async listTemplates(): Promise { + return this.sendRequest(ProcedureName.LIST_TEMPLATES, {}) + } + public async listChargingStations(): Promise { return this.sendRequest(ProcedureName.LIST_CHARGING_STATIONS, {}) } + public async addChargingStations( + template: string, + numberOfStations: number, + options?: ChargingStationOptions + ): Promise { + return this.sendRequest(ProcedureName.ADD_CHARGING_STATIONS, { + template, + numberOfStations, + options + }) + } + + public async deleteChargingStation(hashId: string): Promise { + return this.sendRequest(ProcedureName.DELETE_CHARGING_STATIONS, { hashIds: [hashId] }) + } + + public async setSupervisionUrl(hashId: string, supervisionUrl: string): Promise { + return this.sendRequest(ProcedureName.SET_SUPERVISION_URL, { + hashIds: [hashId], + url: supervisionUrl + }) + } + public async startChargingStation(hashId: string): Promise { return this.sendRequest(ProcedureName.START_CHARGING_STATION, { hashIds: [hashId] }) } @@ -113,16 +178,33 @@ export class UIClient { } private openWS(): void { + const protocols = + this.uiServerConfiguration.authentication?.enabled === true && + this.uiServerConfiguration.authentication?.type === AuthenticationType.PROTOCOL_BASIC_AUTH + ? [ + `${this.uiServerConfiguration.protocol}${this.uiServerConfiguration.version}`, + `authorization.basic.${btoa(`${this.uiServerConfiguration.authentication.username}:${this.uiServerConfiguration.authentication.password}`).replace(/={1,2}$/, '')}` + ] + : `${this.uiServerConfiguration.protocol}${this.uiServerConfiguration.version}` this.ws = new WebSocket( - `${configuration.uiServer.secure === true ? ApplicationProtocol.WSS : ApplicationProtocol.WS}://${configuration.uiServer.host}:${configuration.uiServer.port}`, - `${configuration.uiServer.protocol}${configuration.uiServer.version}` + `${this.uiServerConfiguration.secure === true ? ApplicationProtocol.WSS : ApplicationProtocol.WS}://${this.uiServerConfiguration.host}:${this.uiServerConfiguration.port}`, + protocols ) + this.ws.onopen = () => { + useToast().success( + `WebSocket to UI server '${this.uiServerConfiguration.host}' successfully opened` + ) + } this.ws.onmessage = this.responseHandler.bind(this) this.ws.onerror = errorEvent => { - console.error('WebSocket error: ', errorEvent) + useToast().error(`Error in WebSocket to UI server '${this.uiServerConfiguration.host}'`) + console.error( + `Error in WebSocket to UI server '${this.uiServerConfiguration.host}'`, + errorEvent + ) } - this.ws.onclose = closeEvent => { - console.info('WebSocket closed: ', closeEvent) + this.ws.onclose = () => { + useToast().info(`WebSocket to UI server closed`) } } @@ -131,16 +213,13 @@ export class UIClient { payload: RequestPayload ): Promise { return new Promise((resolve, reject) => { - if (this.ws.readyState !== WebSocket.OPEN) { - this.openWS() - } - if (this.ws.readyState === WebSocket.OPEN) { - const uuid = crypto.randomUUID() + if (this.ws?.readyState === WebSocket.OPEN) { + const uuid = randomUUID() const msg = JSON.stringify([uuid, procedureName, payload]) const sendTimeout = setTimeout(() => { this.responseHandlers.delete(uuid) - return reject(new Error(`Send request '${procedureName}' message timeout`)) - }, 60 * 1000) + return reject(new Error(`Send request '${procedureName}' message: connection timeout`)) + }, 60000) try { this.ws.send(msg) this.responseHandlers.set(uuid, { procedureName, resolve, reject }) @@ -151,21 +230,36 @@ export class UIClient { clearTimeout(sendTimeout) } } else { - throw new Error(`Send request '${procedureName}' message: connection not opened`) + reject(new Error(`Send request '${procedureName}' message: connection closed`)) } }) } private responseHandler(messageEvent: MessageEvent): void { - const response = JSON.parse(messageEvent.data) as ProtocolResponse + let response: ProtocolResponse + try { + response = JSON.parse(messageEvent.data) + } catch (error) { + useToast().error('Invalid response JSON format') + console.error('Invalid response JSON format', error) + return + } - if (Array.isArray(response) === false) { - throw new Error(`Response not an array: ${JSON.stringify(response, undefined, 2)}`) + if (!Array.isArray(response)) { + useToast().error('Response not an array') + console.error('Response not an array:', response) + return } const [uuid, responsePayload] = response - if (this.responseHandlers.has(uuid) === true) { + if (!validateUUID(uuid)) { + useToast().error('Response UUID field is invalid') + console.error('Response UUID field is invalid:', response) + return + } + + if (this.responseHandlers.has(uuid)) { const { procedureName, resolve, reject } = this.responseHandlers.get(uuid)! switch (responsePayload.status) { case ResponseStatus.SUCCESS: @@ -175,8 +269,10 @@ export class UIClient { reject(responsePayload) break default: - console.error( - `Response status for procedure '${procedureName}' not supported: '${responsePayload.status}'` + reject( + new Error( + `Response status for procedure '${procedureName}' not supported: '${responsePayload.status}'` + ) ) } this.responseHandlers.delete(uuid)