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