Commit | Line | Data |
---|---|---|
8114d10e JB |
1 | import { RawData } from 'ws'; |
2 | ||
3 | import BaseError from '../../../exception/BaseError'; | |
4 | import { JsonType } from '../../../types/JsonType'; | |
675fa8e3 | 5 | import { |
32de5a57 | 6 | ProcedureName, |
675fa8e3 JB |
7 | ProtocolRequest, |
8 | ProtocolRequestHandler, | |
32de5a57 | 9 | ProtocolResponse, |
33cea517 | 10 | ProtocolVersion, |
89b7a234 | 11 | RequestPayload, |
32de5a57 LM |
12 | ResponsePayload, |
13 | ResponseStatus, | |
675fa8e3 | 14 | } from '../../../types/UIProtocol'; |
675fa8e3 | 15 | import logger from '../../../utils/Logger'; |
8114d10e | 16 | import Utils from '../../../utils/Utils'; |
32de5a57 LM |
17 | import Bootstrap from '../../Bootstrap'; |
18 | import WorkerBroadcastChannel from '../../WorkerBroadcastChannel'; | |
8114d10e | 19 | import { AbstractUIServer } from '../AbstractUIServer'; |
4198ad5c | 20 | |
32de5a57 LM |
21 | const moduleName = 'AbstractUIService'; |
22 | ||
4198ad5c | 23 | export default abstract class AbstractUIService { |
33cea517 | 24 | protected readonly version: ProtocolVersion; |
fe94fce0 | 25 | protected readonly uiServer: AbstractUIServer; |
32de5a57 LM |
26 | protected readonly messageHandlers: Map<ProcedureName, ProtocolRequestHandler>; |
27 | protected workerBroadcastChannel: WorkerBroadcastChannel; | |
4198ad5c | 28 | |
33cea517 JB |
29 | constructor(uiServer: AbstractUIServer, version: ProtocolVersion) { |
30 | this.version = version; | |
675fa8e3 | 31 | this.uiServer = uiServer; |
32de5a57 LM |
32 | this.messageHandlers = new Map<ProcedureName, ProtocolRequestHandler>([ |
33 | [ProcedureName.LIST_CHARGING_STATIONS, this.handleListChargingStations.bind(this)], | |
34 | [ProcedureName.START_SIMULATOR, this.handleStartSimulator.bind(this)], | |
35 | [ProcedureName.STOP_SIMULATOR, this.handleStopSimulator.bind(this)], | |
4198ad5c | 36 | ]); |
32de5a57 | 37 | this.workerBroadcastChannel = new WorkerBroadcastChannel(); |
4198ad5c JB |
38 | } |
39 | ||
178ac666 | 40 | public async messageHandler(request: RawData): Promise<void> { |
98a5256a | 41 | let messageId: string; |
32de5a57 | 42 | let command: ProcedureName; |
89b7a234 | 43 | let requestPayload: RequestPayload; |
32de5a57 LM |
44 | let responsePayload: ResponsePayload; |
45 | try { | |
46 | [messageId, command, requestPayload] = this.dataValidation(request); | |
47 | ||
48 | if (this.messageHandlers.has(command) === false) { | |
32de5a57 LM |
49 | throw new BaseError( |
50 | `${command} is not implemented to handle message payload ${JSON.stringify( | |
51 | requestPayload, | |
52 | null, | |
53 | 2 | |
54 | )}` | |
55 | ); | |
4198ad5c | 56 | } |
89b7a234 | 57 | |
32de5a57 | 58 | // Call the message handler to build the response payload |
4e3ff94d | 59 | responsePayload = await this.messageHandlers.get(command)(messageId, requestPayload); |
32de5a57 LM |
60 | } catch (error) { |
61 | // Log | |
62 | logger.error( | |
63 | `${this.uiServer.logPrefix(moduleName, 'messageHandler')} Handle message error:`, | |
64 | error | |
e7aeea18 | 65 | ); |
32de5a57 LM |
66 | // Send the message response failure |
67 | this.uiServer.sendResponse( | |
68 | this.buildProtocolResponse(messageId ?? 'error', { | |
69 | status: ResponseStatus.FAILURE, | |
70 | command, | |
71 | requestPayload, | |
72 | errorMessage: (error as Error).message, | |
73 | errorStack: (error as Error).stack, | |
74 | }) | |
75 | ); | |
76 | throw error; | |
4198ad5c | 77 | } |
32de5a57 LM |
78 | |
79 | // Send the message response success | |
80 | this.uiServer.sendResponse(this.buildProtocolResponse(messageId, responsePayload)); | |
4198ad5c JB |
81 | } |
82 | ||
32de5a57 LM |
83 | protected buildProtocolResponse(messageId: string, payload: ResponsePayload): string { |
84 | return JSON.stringify([messageId, payload] as ProtocolResponse); | |
85 | } | |
86 | ||
87 | // Validate the raw data received from the WebSocket | |
88 | // TODO: should probably be moved to the ws verify clients callback | |
89 | private dataValidation(rawData: RawData): ProtocolRequest { | |
4e3ff94d JB |
90 | // logger.debug( |
91 | // `${this.uiServer.logPrefix( | |
92 | // moduleName, | |
93 | // 'dataValidation' | |
94 | // )} Raw data received: ${rawData.toString()}` | |
95 | // ); | |
96 | ||
32de5a57 LM |
97 | const data = JSON.parse(rawData.toString()) as JsonType[]; |
98 | ||
99 | if (Utils.isIterable(data) === false) { | |
100 | throw new BaseError('UI protocol request is not iterable'); | |
101 | } | |
102 | ||
103 | if (data.length !== 3) { | |
104 | throw new BaseError('UI protocol request is malformed'); | |
105 | } | |
106 | ||
107 | return data as ProtocolRequest; | |
4198ad5c JB |
108 | } |
109 | ||
89b7a234 JB |
110 | private handleListChargingStations(): ResponsePayload { |
111 | // TODO: remove cast to unknown | |
32de5a57 LM |
112 | return { |
113 | status: ResponseStatus.SUCCESS, | |
114 | ...Array.from(this.uiServer.chargingStations.values()), | |
89b7a234 | 115 | } as unknown as ResponsePayload; |
32de5a57 LM |
116 | } |
117 | ||
118 | private async handleStartSimulator(): Promise<ResponsePayload> { | |
119 | await Bootstrap.getInstance().start(); | |
120 | return { status: ResponseStatus.SUCCESS }; | |
121 | } | |
122 | ||
123 | private async handleStopSimulator(): Promise<ResponsePayload> { | |
124 | await Bootstrap.getInstance().stop(); | |
125 | return { status: ResponseStatus.SUCCESS }; | |
4198ad5c JB |
126 | } |
127 | } |