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 | ||
6 | import OCPPError from '../../exception/OCPPError'; | |
6c1761d4 JB |
7 | import type { HandleErrorParams } from '../../types/Error'; |
8 | import type { JsonType } from '../../types/JsonType'; | |
b0342994 | 9 | import type { OCPPVersion } from '../../types/ocpp/OCPPVersion'; |
6c1761d4 | 10 | import type { IncomingRequestCommand } from '../../types/ocpp/Requests'; |
9f2e3130 | 11 | import logger from '../../utils/Logger'; |
8114d10e | 12 | import type ChargingStation from '../ChargingStation'; |
cbb3711f | 13 | import { OCPPServiceUtils } from './OCPPServiceUtils'; |
c0560973 | 14 | |
e3018bc4 JB |
15 | const moduleName = 'OCPPIncomingRequestService'; |
16 | ||
c0560973 | 17 | export default abstract class OCPPIncomingRequestService { |
08f130a0 | 18 | private static instance: OCPPIncomingRequestService | null = null; |
e6159ce8 | 19 | protected asyncResource: AsyncResource; |
d270cc87 | 20 | private readonly version: OCPPVersion; |
012ae1a9 | 21 | private readonly ajv: Ajv; |
10068088 | 22 | |
d270cc87 JB |
23 | protected constructor(version: OCPPVersion) { |
24 | this.version = version; | |
45988780 JB |
25 | this.ajv = new Ajv({ |
26 | multipleOfPrecision: 2, | |
27 | }); | |
e3018bc4 | 28 | ajvFormats(this.ajv); |
d270cc87 | 29 | this.asyncResource = new AsyncResource(moduleName); |
9952c548 JB |
30 | this.incomingRequestHandler.bind(this); |
31 | this.validateIncomingRequestPayload.bind(this); | |
c0560973 JB |
32 | } |
33 | ||
08f130a0 | 34 | public static getInstance<T extends OCPPIncomingRequestService>(this: new () => T): T { |
1ca780f9 | 35 | if (OCPPIncomingRequestService.instance === null) { |
08f130a0 | 36 | OCPPIncomingRequestService.instance = new this(); |
9f2e3130 | 37 | } |
08f130a0 | 38 | return OCPPIncomingRequestService.instance as T; |
9f2e3130 JB |
39 | } |
40 | ||
e7aeea18 | 41 | protected handleIncomingRequestError<T>( |
08f130a0 | 42 | chargingStation: ChargingStation, |
e7aeea18 JB |
43 | commandName: IncomingRequestCommand, |
44 | error: Error, | |
45 | params: HandleErrorParams<T> = { throwError: true } | |
51581a20 | 46 | ): T | undefined { |
e7aeea18 | 47 | logger.error( |
60ddad53 | 48 | `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`, |
e7aeea18 JB |
49 | error |
50 | ); | |
717c1e56 JB |
51 | if (!params?.throwError && params?.errorResponse) { |
52 | return params?.errorResponse; | |
e64c0923 | 53 | } |
717c1e56 | 54 | if (params?.throwError && !params?.errorResponse) { |
e0a50bcd JB |
55 | throw error; |
56 | } | |
717c1e56 JB |
57 | if (params?.throwError && params?.errorResponse) { |
58 | return params?.errorResponse; | |
59 | } | |
47e22477 JB |
60 | } |
61 | ||
e3018bc4 JB |
62 | protected validateIncomingRequestPayload<T extends JsonType>( |
63 | chargingStation: ChargingStation, | |
64 | commandName: IncomingRequestCommand, | |
65 | schema: JSONSchemaType<T>, | |
66 | payload: T | |
67 | ): boolean { | |
0638ddd2 | 68 | if (chargingStation.getPayloadSchemaValidation() === false) { |
e3018bc4 JB |
69 | return true; |
70 | } | |
71 | const validate = this.ajv.compile(schema); | |
72 | if (validate(payload)) { | |
73 | return true; | |
74 | } | |
75 | logger.error( | |
45988780 | 76 | `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Command '${commandName}' incoming request PDU is invalid: %j`, |
e3018bc4 JB |
77 | validate.errors |
78 | ); | |
79 | throw new OCPPError( | |
01a4dcbb | 80 | OCPPServiceUtils.ajvErrorsToErrorType(validate.errors), |
e3018bc4 JB |
81 | 'Incoming request PDU is invalid', |
82 | commandName, | |
83 | JSON.stringify(validate.errors, null, 2) | |
84 | ); | |
85 | } | |
86 | ||
f7f98c68 | 87 | public abstract incomingRequestHandler( |
08f130a0 | 88 | chargingStation: ChargingStation, |
e7aeea18 JB |
89 | messageId: string, |
90 | commandName: IncomingRequestCommand, | |
5cc4b63b | 91 | commandPayload: JsonType |
e7aeea18 | 92 | ): Promise<void>; |
c0560973 | 93 | } |