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