1 import { AsyncResource
} from
'async_hooks';
3 import Ajv
, { type JSONSchemaType
} from
'ajv';
4 import AjvDraft04 from
'ajv-draft-04';
5 import ajvFormats from
'ajv-formats';
7 import OCPPError from
'../../exception/OCPPError';
8 import type { HandleErrorParams
} from
'../../types/Error';
9 import type { JsonType
} from
'../../types/JsonType';
10 import { OCPPVersion
} from
'../../types/ocpp/OCPPVersion';
11 import type { IncomingRequestCommand
} from
'../../types/ocpp/Requests';
12 import logger from
'../../utils/Logger';
13 import type ChargingStation from
'../ChargingStation';
14 import { OCPPServiceUtils
} from
'./OCPPServiceUtils';
16 const moduleName
= 'OCPPIncomingRequestService';
18 export default abstract class OCPPIncomingRequestService
{
19 private static instance
: OCPPIncomingRequestService
| null = null;
20 protected asyncResource
: AsyncResource
;
21 private readonly version
: OCPPVersion
;
22 private readonly ajv
: Ajv
;
24 protected constructor(version
: OCPPVersion
) {
25 this.version
= version
;
26 switch (this.version
) {
27 case OCPPVersion
.VERSION_16
:
28 this.ajv
= new AjvDraft04();
30 case OCPPVersion
.VERSION_20
:
31 case OCPPVersion
.VERSION_201
:
36 this.asyncResource
= new AsyncResource(moduleName
);
37 this.incomingRequestHandler
.bind(this);
38 this.validateIncomingRequestPayload
.bind(this);
41 public static getInstance
<T
extends OCPPIncomingRequestService
>(this: new () => T
): T
{
42 if (OCPPIncomingRequestService
.instance
=== null) {
43 OCPPIncomingRequestService
.instance
= new this();
45 return OCPPIncomingRequestService
.instance
as T
;
48 protected handleIncomingRequestError
<T
>(
49 chargingStation
: ChargingStation
,
50 commandName
: IncomingRequestCommand
,
52 params
: HandleErrorParams
<T
> = { throwError
: true }
55 `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
58 if (!params
?.throwError
&& params
?.errorResponse
) {
59 return params
?.errorResponse
;
61 if (params
?.throwError
&& !params
?.errorResponse
) {
64 if (params
?.throwError
&& params
?.errorResponse
) {
65 return params
?.errorResponse
;
69 protected validateIncomingRequestPayload
<T
extends JsonType
>(
70 chargingStation
: ChargingStation
,
71 commandName
: IncomingRequestCommand
,
72 schema
: JSONSchemaType
<T
>,
75 if (chargingStation
.getPayloadSchemaValidation() === false) {
78 const validate
= this.ajv
.compile(schema
);
79 if (validate(payload
)) {
83 `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestPayload: Incoming request PDU is invalid: %j`,
87 OCPPServiceUtils
.ajvErrorsToErrorType(validate
.errors
),
88 'Incoming request PDU is invalid',
90 JSON
.stringify(validate
.errors
, null, 2)
94 public abstract incomingRequestHandler(
95 chargingStation
: ChargingStation
,
97 commandName
: IncomingRequestCommand
,
98 commandPayload
: JsonType