X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2F2.0%2FOCPP20RequestService.ts;h=6673b9b43813d8cbf0985bed82001ef085d6b5d1;hb=ea32ea059bfdd7134abe2ba349985e5b15bc1d06;hp=ccacc0fa541a06efba86a58f763229297623e837;hpb=18bf82749012da310723996912f5239c20bdc4e7;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts index ccacc0fa..6673b9b4 100644 --- a/src/charging-station/ocpp/2.0/OCPP20RequestService.ts +++ b/src/charging-station/ocpp/2.0/OCPP20RequestService.ts @@ -1,60 +1,75 @@ -// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; +import type { ValidateFunction } from 'ajv' -import type { JSONSchemaType } from 'ajv'; - -import { OCPP20ServiceUtils } from './OCPP20ServiceUtils'; -import OCPPError from '../../../exception/OCPPError'; -import type { JsonObject, JsonType } from '../../../types/JsonType'; +import type { ChargingStation } from '../../../charging-station/index.js' +import { OCPPError } from '../../../exception/index.js' import { + ErrorType, + type JsonObject, + type JsonType, type OCPP20BootNotificationRequest, type OCPP20HeartbeatRequest, OCPP20RequestCommand, type OCPP20StatusNotificationRequest, -} from '../../../types/ocpp/2.0/Requests'; -import { ErrorType } from '../../../types/ocpp/ErrorType'; -import { OCPPVersion } from '../../../types/ocpp/OCPPVersion'; -import type { RequestParams } from '../../../types/ocpp/Requests'; -import Utils from '../../../utils/Utils'; -import type ChargingStation from '../../ChargingStation'; -import OCPPConstants from '../OCPPConstants'; -import OCPPRequestService from '../OCPPRequestService'; -import type OCPPResponseService from '../OCPPResponseService'; + OCPPVersion, + type RequestParams +} from '../../../types/index.js' +import { generateUUID } from '../../../utils/index.js' +import { OCPPRequestService } from '../OCPPRequestService.js' +import type { OCPPResponseService } from '../OCPPResponseService.js' +import { OCPP20Constants } from './OCPP20Constants.js' +import { OCPP20ServiceUtils } from './OCPP20ServiceUtils.js' -const moduleName = 'OCPP20RequestService'; +const moduleName = 'OCPP20RequestService' -export default class OCPP20RequestService extends OCPPRequestService { - protected jsonSchemas: Map>; +export class OCPP20RequestService extends OCPPRequestService { + protected payloadValidateFunctions: Map> - public constructor(ocppResponseService: OCPPResponseService) { - if (new.target?.name === moduleName) { - throw new TypeError(`Cannot construct ${new.target?.name} instances directly`); - } - super(OCPPVersion.VERSION_20, ocppResponseService); - this.jsonSchemas = new Map>([ + public constructor (ocppResponseService: OCPPResponseService) { + // if (new.target.name === moduleName) { + // throw new TypeError(`Cannot construct ${new.target.name} instances directly`) + // } + super(OCPPVersion.VERSION_201, ocppResponseService) + this.payloadValidateFunctions = new Map>([ [ OCPP20RequestCommand.BOOT_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/2.0/BootNotificationRequest.json' - ), + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/BootNotificationRequest.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP20RequestCommand.HEARTBEAT, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/2.0/HeartbeatRequest.json' - ), + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/HeartbeatRequest.json', + moduleName, + 'constructor' + ) + ) + .bind(this) ], [ OCPP20RequestCommand.STATUS_NOTIFICATION, - this.parseJsonSchemaFile( - '../../../assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json' - ), - ], - ]); - this.buildRequestPayload.bind(this); + this.ajv + .compile( + OCPP20ServiceUtils.parseJsonSchemaFile( + 'assets/json-schemas/ocpp/2.0/StatusNotificationRequest.json', + moduleName, + 'constructor' + ) + ) + .bind(this) + ] + ]) + this.buildRequestPayload = this.buildRequestPayload.bind(this) } public async requestHandler( @@ -63,14 +78,15 @@ export default class OCPP20RequestService extends OCPPRequestService { commandParams?: JsonType, params?: RequestParams ): Promise { - if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName) === true) { + // FIXME?: add sanity checks on charging station availability, connector availability, connector status, etc. + if (OCPP20ServiceUtils.isRequestCommandSupported(chargingStation, commandName)) { return (await this.sendMessage( chargingStation, - Utils.generateUUID(), + generateUUID(), this.buildRequestPayload(chargingStation, commandName, commandParams), commandName, params - )) as unknown as ResponseType; + )) as ResponseType } // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). throw new OCPPError( @@ -78,7 +94,7 @@ export default class OCPP20RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } private buildRequestPayload( @@ -86,17 +102,17 @@ export default class OCPP20RequestService extends OCPPRequestService { commandName: OCPP20RequestCommand, commandParams?: JsonType ): Request { - commandParams = commandParams as JsonObject; + commandParams = commandParams as JsonObject switch (commandName) { case OCPP20RequestCommand.BOOT_NOTIFICATION: - return commandParams as unknown as Request; + return commandParams as unknown as Request case OCPP20RequestCommand.HEARTBEAT: - return OCPPConstants.OCPP_RESPONSE_EMPTY as unknown as Request; + return OCPP20Constants.OCPP_RESPONSE_EMPTY as unknown as Request case OCPP20RequestCommand.STATUS_NOTIFICATION: return { timestamp: new Date(), - ...commandParams, - } as unknown as Request; + ...commandParams + } as unknown as Request default: // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError(). throw new OCPPError( @@ -105,16 +121,7 @@ export default class OCPP20RequestService extends OCPPRequestService { `Unsupported OCPP command '${commandName}'`, commandName, commandParams - ); + ) } } - - private parseJsonSchemaFile(relativePath: string): JSONSchemaType { - return JSON.parse( - fs.readFileSync( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), relativePath), - 'utf8' - ) - ) as JSONSchemaType; - } }