Commit | Line | Data |
---|---|---|
e6159ce8 JB |
1 | import { AsyncResource } from 'async_hooks'; |
2 | ||
d270cc87 | 3 | import Ajv, { type JSONSchemaType } from 'ajv'; |
e3018bc4 JB |
4 | import ajvFormats from 'ajv-formats'; |
5 | ||
268a74bb | 6 | import { OCPPConstants } from './OCPPConstants'; |
78202038 | 7 | import { OCPPServiceUtils } from './OCPPServiceUtils'; |
268a74bb JB |
8 | import { OCPPError } from '../../exception'; |
9 | import type { | |
10 | ClearCacheResponse, | |
11 | HandleErrorParams, | |
12 | IncomingRequestCommand, | |
13 | JsonObject, | |
14 | JsonType, | |
15 | OCPPVersion, | |
16 | } from '../../types'; | |
17 | import { logger } from '../../utils/Logger'; | |
18 | import type { ChargingStation } from '../ChargingStation'; | |
22e0d48e | 19 | import { ChargingStationUtils } from '../ChargingStationUtils'; |
c0560973 | 20 | |
e3018bc4 JB |
21 | const moduleName = 'OCPPIncomingRequestService'; |
22 | ||
268a74bb | 23 | export abstract class OCPPIncomingRequestService extends AsyncResource { |
08f130a0 | 24 | private static instance: OCPPIncomingRequestService | null = null; |
d270cc87 | 25 | private readonly version: OCPPVersion; |
012ae1a9 | 26 | private readonly ajv: Ajv; |
b3fc3ff5 | 27 | protected abstract jsonSchemas: Map<IncomingRequestCommand, JSONSchemaType<JsonObject>>; |
10068088 | 28 | |
d270cc87 | 29 | protected constructor(version: OCPPVersion) { |
27f08ad3 | 30 | super(moduleName); |
d270cc87 | 31 | this.version = version; |
45988780 | 32 | this.ajv = new Ajv({ |
98fc1389 | 33 | keywords: ['javaType'], |
45988780 JB |
34 | multipleOfPrecision: 2, |
35 | }); | |
e3018bc4 | 36 | ajvFormats(this.ajv); |
9952c548 JB |
37 | this.incomingRequestHandler.bind(this); |
38 | this.validateIncomingRequestPayload.bind(this); | |
c0560973 JB |
39 | } |
40 | ||
08f130a0 | 41 | public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T { |
1ca780f9 | 42 | if (OCPPIncomingRequestService.instance === null) { |
08f130a0 | 43 | OCPPIncomingRequestService.instance = new this(); |
9f2e3130 | 44 | } |
08f130a0 | 45 | return OCPPIncomingRequestService.instance as T; |
9f2e3130 JB |
46 | } |
47 | ||
e7aeea18 | 48 | protected handleIncomingRequestError<T>( |
08f130a0 | 49 | chargingStation: ChargingStation, |
e7aeea18 JB |
50 | commandName: IncomingRequestCommand, |
51 | error: Error, | |
52 | params: HandleErrorParams<T> = { throwError: true } | |
51581a20 | 53 | ): T | undefined { |
e7aeea18 | 54 | logger.error( |
60ddad53 | 55 | `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`, |
e7aeea18 JB |
56 | error |
57 | ); | |
717c1e56 JB |
58 | if (!params?.throwError && params?.errorResponse) { |
59 | return params?.errorResponse; | |
e64c0923 | 60 | } |
717c1e56 | 61 | if (params?.throwError && !params?.errorResponse) { |
e0a50bcd JB |
62 | throw error; |
63 | } | |
717c1e56 JB |
64 | if (params?.throwError && params?.errorResponse) { |
65 | return params?.errorResponse; | |
66 | } | |
47e22477 JB |
67 | } |
68 | ||
e3018bc4 JB |
69 | protected validateIncomingRequestPayload<T extends JsonType>( |
70 | chargingStation: ChargingStation, | |
71 | commandName: IncomingRequestCommand, | |
72 | schema: JSONSchemaType<T>, | |
73 | payload: T | |
74 | ): boolean { | |
0638ddd2 | 75 | if (chargingStation.getPayloadSchemaValidation() === false) { |
e3018bc4 JB |
76 | return true; |
77 | } | |
78 | const validate = this.ajv.compile(schema); | |
79 | if (validate(payload)) { | |
80 | return true; | |
81 | } | |
82 | logger.error( | |
45988780 | 83 | `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`, |
e3018bc4 JB |
84 | validate.errors |
85 | ); | |
86 | throw new OCPPError( | |
01a4dcbb | 87 | OCPPServiceUtils.ajvErrorsToErrorType(validate.errors), |
e3018bc4 JB |
88 | 'Incoming request PDU is invalid', |
89 | commandName, | |
90 | JSON.stringify(validate.errors, null, 2) | |
91 | ); | |
92 | } | |
93 | ||
22e0d48e JB |
94 | protected handleRequestClearCache(chargingStation: ChargingStation): ClearCacheResponse { |
95 | chargingStation.authorizedTagsCache.deleteAuthorizedTags( | |
96 | ChargingStationUtils.getAuthorizationFile(chargingStation.stationInfo) | |
97 | ); | |
98 | return OCPPConstants.OCPP_RESPONSE_ACCEPTED; | |
99 | } | |
100 | ||
f7f98c68 | 101 | public abstract incomingRequestHandler( |
08f130a0 | 102 | chargingStation: ChargingStation, |
e7aeea18 JB |
103 | messageId: string, |
104 | commandName: IncomingRequestCommand, | |
5cc4b63b | 105 | commandPayload: JsonType |
e7aeea18 | 106 | ): Promise<void>; |
c0560973 | 107 | } |