Commit | Line | Data |
---|---|---|
a19b897d | 1 | // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. |
953d6b02 | 2 | |
24d15716 | 3 | import type { ValidateFunction } from 'ajv' |
953d6b02 | 4 | |
66a7748d JB |
5 | import type { ChargingStation } from '../../../charging-station/index.js' |
6 | import { OCPPError } from '../../../exception/index.js' | |
d270cc87 | 7 | import { |
268a74bb JB |
8 | ErrorType, |
9 | type IncomingRequestHandler, | |
268a74bb | 10 | type JsonType, |
81533a20 | 11 | type OCPP20ClearCacheRequest, |
d270cc87 | 12 | OCPP20IncomingRequestCommand, |
66a7748d JB |
13 | OCPPVersion |
14 | } from '../../../types/index.js' | |
bcf95df1 | 15 | import { isAsyncFunction, logger } from '../../../utils/index.js' |
66a7748d | 16 | import { OCPPIncomingRequestService } from '../OCPPIncomingRequestService.js' |
4c3f6c20 | 17 | import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' |
953d6b02 | 18 | |
66a7748d | 19 | const moduleName = 'OCPP20IncomingRequestService' |
953d6b02 | 20 | |
268a74bb | 21 | export class OCPP20IncomingRequestService extends OCPPIncomingRequestService { |
d5490a13 | 22 | protected payloadValidateFunctions: Map<OCPP20IncomingRequestCommand, ValidateFunction<JsonType>> |
24d15716 | 23 | |
66a7748d JB |
24 | private readonly incomingRequestHandlers: Map< |
25 | OCPP20IncomingRequestCommand, | |
26 | IncomingRequestHandler | |
27 | > | |
953d6b02 | 28 | |
66a7748d | 29 | public constructor () { |
5199f9fd JB |
30 | // if (new.target.name === moduleName) { |
31 | // throw new TypeError(`Cannot construct ${new.target.name} instances directly`) | |
b768993d | 32 | // } |
1feac591 | 33 | super(OCPPVersion.VERSION_201) |
d270cc87 | 34 | this.incomingRequestHandlers = new Map<OCPP20IncomingRequestCommand, IncomingRequestHandler>([ |
66a7748d JB |
35 | [OCPP20IncomingRequestCommand.CLEAR_CACHE, this.handleRequestClearCache.bind(this)] |
36 | ]) | |
d5490a13 | 37 | this.payloadValidateFunctions = new Map< |
24d15716 JB |
38 | OCPP20IncomingRequestCommand, |
39 | ValidateFunction<JsonType> | |
40 | >([ | |
d270cc87 JB |
41 | [ |
42 | OCPP20IncomingRequestCommand.CLEAR_CACHE, | |
24d15716 JB |
43 | this.ajv |
44 | .compile( | |
45 | OCPP20ServiceUtils.parseJsonSchemaFile<OCPP20ClearCacheRequest>( | |
46 | 'assets/json-schemas/ocpp/2.0/ClearCacheRequest.json', | |
47 | moduleName, | |
48 | 'constructor' | |
49 | ) | |
50 | ) | |
51 | .bind(this) | |
66a7748d JB |
52 | ] |
53 | ]) | |
ba9a56a6 | 54 | this.validatePayload = this.validatePayload.bind(this) |
953d6b02 JB |
55 | } |
56 | ||
9429aa42 | 57 | public async incomingRequestHandler<ReqType extends JsonType, ResType extends JsonType>( |
953d6b02 JB |
58 | chargingStation: ChargingStation, |
59 | messageId: string, | |
60 | commandName: OCPP20IncomingRequestCommand, | |
66a7748d | 61 | commandPayload: ReqType |
953d6b02 | 62 | ): Promise<void> { |
66a7748d | 63 | let response: ResType |
953d6b02 | 64 | if ( |
5398cecf | 65 | chargingStation.stationInfo?.ocppStrictCompliance === true && |
66a7748d | 66 | chargingStation.inPendingState() && |
81533a20 JB |
67 | (commandName === OCPP20IncomingRequestCommand.REQUEST_START_TRANSACTION || |
68 | commandName === OCPP20IncomingRequestCommand.REQUEST_STOP_TRANSACTION) | |
953d6b02 JB |
69 | ) { |
70 | throw new OCPPError( | |
71 | ErrorType.SECURITY_ERROR, | |
72 | `${commandName} cannot be issued to handle request PDU ${JSON.stringify( | |
73 | commandPayload, | |
4ed03b6e | 74 | undefined, |
66a7748d | 75 | 2 |
953d6b02 JB |
76 | )} while the charging station is in pending state on the central server`, |
77 | commandName, | |
66a7748d JB |
78 | commandPayload |
79 | ) | |
953d6b02 JB |
80 | } |
81 | if ( | |
66a7748d | 82 | chargingStation.isRegistered() || |
5398cecf | 83 | (chargingStation.stationInfo?.ocppStrictCompliance === false && |
66a7748d | 84 | chargingStation.inUnknownState()) |
953d6b02 JB |
85 | ) { |
86 | if ( | |
66a7748d JB |
87 | this.incomingRequestHandlers.has(commandName) && |
88 | OCPP20ServiceUtils.isIncomingRequestCommandSupported(chargingStation, commandName) | |
953d6b02 JB |
89 | ) { |
90 | try { | |
66a7748d | 91 | this.validatePayload(chargingStation, commandName, commandPayload) |
953d6b02 | 92 | // Call the method to build the response |
66a7748d | 93 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
bcf95df1 JB |
94 | const incomingRequestHandler = this.incomingRequestHandlers.get(commandName)! |
95 | if (isAsyncFunction(incomingRequestHandler)) { | |
96 | response = (await incomingRequestHandler(chargingStation, commandPayload)) as ResType | |
97 | } else { | |
98 | response = incomingRequestHandler(chargingStation, commandPayload) as ResType | |
99 | } | |
953d6b02 JB |
100 | } catch (error) { |
101 | // Log | |
102 | logger.error( | |
103 | `${chargingStation.logPrefix()} ${moduleName}.incomingRequestHandler: Handle incoming request error:`, | |
66a7748d JB |
104 | error |
105 | ) | |
106 | throw error | |
953d6b02 JB |
107 | } |
108 | } else { | |
109 | // Throw exception | |
110 | throw new OCPPError( | |
111 | ErrorType.NOT_IMPLEMENTED, | |
240fa4da | 112 | `'${commandName}' is not implemented to handle request PDU ${JSON.stringify( |
953d6b02 | 113 | commandPayload, |
4ed03b6e | 114 | undefined, |
66a7748d | 115 | 2 |
953d6b02 JB |
116 | )}`, |
117 | commandName, | |
66a7748d JB |
118 | commandPayload |
119 | ) | |
953d6b02 JB |
120 | } |
121 | } else { | |
122 | throw new OCPPError( | |
123 | ErrorType.SECURITY_ERROR, | |
124 | `${commandName} cannot be issued to handle request PDU ${JSON.stringify( | |
125 | commandPayload, | |
4ed03b6e | 126 | undefined, |
66a7748d | 127 | 2 |
412cece8 | 128 | )} while the charging station is not registered on the central server`, |
953d6b02 | 129 | commandName, |
66a7748d JB |
130 | commandPayload |
131 | ) | |
953d6b02 JB |
132 | } |
133 | // Send the built response | |
134 | await chargingStation.ocppRequestService.sendResponse( | |
135 | chargingStation, | |
136 | messageId, | |
137 | response, | |
66a7748d JB |
138 | commandName |
139 | ) | |
868c6830 | 140 | // Emit command name event to allow delayed handling |
1b7eb386 | 141 | this.emit(commandName, chargingStation, commandPayload, response) |
953d6b02 JB |
142 | } |
143 | ||
66a7748d | 144 | private validatePayload ( |
953d6b02 JB |
145 | chargingStation: ChargingStation, |
146 | commandName: OCPP20IncomingRequestCommand, | |
66a7748d | 147 | commandPayload: JsonType |
953d6b02 | 148 | ): boolean { |
d5490a13 | 149 | if (this.payloadValidateFunctions.has(commandName)) { |
24d15716 | 150 | return this.validateIncomingRequestPayload(chargingStation, commandName, commandPayload) |
953d6b02 JB |
151 | } |
152 | logger.warn( | |
24d15716 | 153 | `${chargingStation.logPrefix()} ${moduleName}.validatePayload: No JSON schema validation function found for command '${commandName}' PDU validation` |
66a7748d JB |
154 | ) |
155 | return false | |
953d6b02 JB |
156 | } |
157 | } |