X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Focpp%2FOCPPRequestService.ts;h=4e456963798a6f121b1bd89594dd956f59c49bce;hb=08b58f0020986c0ad1b55e562aaf325a47b9d58c;hp=aba9bfd00edc28949779c23eaac079f116324ca6;hpb=8ec8e3d00ee6b2dca0760dd77973e338ea5a23a7;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/ocpp/OCPPRequestService.ts b/src/charging-station/ocpp/OCPPRequestService.ts
index aba9bfd0..4e456963 100644
--- a/src/charging-station/ocpp/OCPPRequestService.ts
+++ b/src/charging-station/ocpp/OCPPRequestService.ts
@@ -1,34 +1,45 @@
 import Ajv, { type JSONSchemaType } from 'ajv';
 import ajvFormats from 'ajv-formats';
 
-import OCPPError from '../../exception/OCPPError';
-import PerformanceStatistics from '../../performance/PerformanceStatistics';
-import type { EmptyObject } from '../../types/EmptyObject';
-import type { HandleErrorParams } from '../../types/Error';
-import type { JsonObject, JsonType } from '../../types/JsonType';
-import { ErrorType } from '../../types/ocpp/ErrorType';
-import { MessageType } from '../../types/ocpp/MessageType';
-import type { OCPPVersion } from '../../types/ocpp/OCPPVersion';
+import { OCPPConstants } from './OCPPConstants';
+import type { OCPPResponseService } from './OCPPResponseService';
+import { OCPPServiceUtils } from './OCPPServiceUtils';
+import type { ChargingStation } from '../../charging-station';
+import { OCPPError } from '../../exception';
+import { PerformanceStatistics } from '../../performance';
 import {
   type ErrorCallback,
+  type ErrorResponse,
+  ErrorType,
   type IncomingRequestCommand,
+  type JsonObject,
+  type JsonType,
+  MessageType,
+  type OCPPVersion,
   type OutgoingRequest,
   RequestCommand,
   type RequestParams,
+  type Response,
   type ResponseCallback,
   type ResponseType,
-} from '../../types/ocpp/Requests';
-import type { ErrorResponse, Response } from '../../types/ocpp/Responses';
-import Constants from '../../utils/Constants';
-import logger from '../../utils/Logger';
-import Utils from '../../utils/Utils';
-import type ChargingStation from '../ChargingStation';
-import type OCPPResponseService from './OCPPResponseService';
-import { OCPPServiceUtils } from './OCPPServiceUtils';
+} from '../../types';
+import {
+  Constants,
+  cloneObject,
+  handleSendMessageError,
+  logger,
+  promiseWithTimeout,
+} from '../../utils';
 
 const moduleName = 'OCPPRequestService';
 
-export default abstract class OCPPRequestService {
+const defaultRequestParams: RequestParams = {
+  skipBufferingOnError: false,
+  triggerMessage: false,
+  throwError: false,
+};
+
+export abstract class OCPPRequestService {
   private static instance: OCPPRequestService | null = null;
   private readonly version: OCPPVersion;
   private readonly ajv: Ajv;
@@ -43,19 +54,69 @@ export default abstract class OCPPRequestService {
     });
     ajvFormats(this.ajv);
     this.ocppResponseService = ocppResponseService;
-    this.requestHandler.bind(this);
-    this.sendMessage.bind(this);
-    this.sendResponse.bind(this);
-    this.sendError.bind(this);
-    this.internalSendMessage.bind(this);
-    this.buildMessageToSend.bind(this);
-    this.validateRequestPayload.bind(this);
-    this.validateIncomingRequestResponsePayload.bind(this);
+    this.requestHandler = this.requestHandler.bind(this) as <
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      ReqType extends JsonType,
+      ResType extends JsonType,
+    >(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand,
+      commandParams?: JsonType,
+      params?: RequestParams,
+    ) => Promise<ResType>;
+    this.sendMessage = this.sendMessage.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType,
+      commandName: RequestCommand,
+      params?: RequestParams,
+    ) => Promise<ResponseType>;
+    this.sendResponse = this.sendResponse.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType,
+      commandName: IncomingRequestCommand,
+    ) => Promise<ResponseType>;
+    this.sendError = this.sendError.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      ocppError: OCPPError,
+      commandName: RequestCommand | IncomingRequestCommand,
+    ) => Promise<ResponseType>;
+    this.internalSendMessage = this.internalSendMessage.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType | OCPPError,
+      messageType: MessageType,
+      commandName: RequestCommand | IncomingRequestCommand,
+      params?: RequestParams,
+    ) => Promise<ResponseType>;
+    this.buildMessageToSend = this.buildMessageToSend.bind(this) as (
+      chargingStation: ChargingStation,
+      messageId: string,
+      messagePayload: JsonType | OCPPError,
+      messageType: MessageType,
+      commandName: RequestCommand | IncomingRequestCommand,
+      responseCallback: ResponseCallback,
+      errorCallback: ErrorCallback,
+    ) => string;
+    this.validateRequestPayload = this.validateRequestPayload.bind(this) as <T extends JsonObject>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand | IncomingRequestCommand,
+      payload: T,
+    ) => boolean;
+    this.validateIncomingRequestResponsePayload = this.validateIncomingRequestResponsePayload.bind(
+      this,
+    ) as <T extends JsonObject>(
+      chargingStation: ChargingStation,
+      commandName: RequestCommand | IncomingRequestCommand,
+      payload: T,
+    ) => boolean;
   }
 
   public static getInstance<T extends OCPPRequestService>(
     this: new (ocppResponseService: OCPPResponseService) => T,
-    ocppResponseService: OCPPResponseService
+    ocppResponseService: OCPPResponseService,
   ): T {
     if (OCPPRequestService.instance === null) {
       OCPPRequestService.instance = new this(ocppResponseService);
@@ -67,7 +128,7 @@ export default abstract class OCPPRequestService {
     chargingStation: ChargingStation,
     messageId: string,
     messagePayload: JsonType,
-    commandName: IncomingRequestCommand
+    commandName: IncomingRequestCommand,
   ): Promise<ResponseType> {
     try {
       // Send response message
@@ -76,12 +137,13 @@ export default abstract class OCPPRequestService {
         messageId,
         messagePayload,
         MessageType.CALL_RESULT_MESSAGE,
-        commandName
+        commandName,
       );
     } catch (error) {
-      this.handleSendMessageError(chargingStation, commandName, error as Error, {
+      handleSendMessageError(chargingStation, commandName, error as Error, {
         throwError: true,
       });
+      return null;
     }
   }
 
@@ -89,7 +151,7 @@ export default abstract class OCPPRequestService {
     chargingStation: ChargingStation,
     messageId: string,
     ocppError: OCPPError,
-    commandName: RequestCommand | IncomingRequestCommand
+    commandName: RequestCommand | IncomingRequestCommand,
   ): Promise<ResponseType> {
     try {
       // Send error message
@@ -98,10 +160,11 @@ export default abstract class OCPPRequestService {
         messageId,
         ocppError,
         MessageType.CALL_ERROR_MESSAGE,
-        commandName
+        commandName,
       );
     } catch (error) {
-      this.handleSendMessageError(chargingStation, commandName, error as Error);
+      handleSendMessageError(chargingStation, commandName, error as Error);
+      return null;
     }
   }
 
@@ -110,12 +173,12 @@ export default abstract class OCPPRequestService {
     messageId: string,
     messagePayload: JsonType,
     commandName: RequestCommand,
-    params: RequestParams = {
-      skipBufferingOnError: false,
-      triggerMessage: false,
-      throwError: false,
-    }
+    params: RequestParams = defaultRequestParams,
   ): Promise<ResponseType> {
+    params = {
+      ...defaultRequestParams,
+      ...params,
+    };
     try {
       return await this.internalSendMessage(
         chargingStation,
@@ -123,86 +186,87 @@ export default abstract class OCPPRequestService {
         messagePayload,
         MessageType.CALL_MESSAGE,
         commandName,
-        params
+        params,
       );
     } catch (error) {
-      this.handleSendMessageError(chargingStation, commandName, error as Error, {
+      handleSendMessageError(chargingStation, commandName, error as Error, {
         throwError: params.throwError,
       });
+      return null;
     }
   }
 
   private validateRequestPayload<T extends JsonObject>(
     chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.getOcppStrictCompliance() === false) {
       return true;
     }
     if (this.jsonSchemas.has(commandName as RequestCommand) === false) {
       logger.warn(
-        `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`
+        `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: No JSON schema found for command '${commandName}' PDU validation`,
       );
       return true;
     }
-    const validate = this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand));
-    payload = Utils.cloneObject<T>(payload);
+    const validate = this.ajv.compile(this.jsonSchemas.get(commandName as RequestCommand)!);
+    payload = cloneObject<T>(payload);
     OCPPServiceUtils.convertDateToISOString<T>(payload);
     if (validate(payload)) {
       return true;
     }
     logger.error(
       `${chargingStation.logPrefix()} ${moduleName}.validateRequestPayload: Command '${commandName}' request PDU is invalid: %j`,
-      validate.errors
+      validate.errors,
     );
     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
     throw new OCPPError(
-      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors!),
       'Request PDU is invalid',
       commandName,
-      JSON.stringify(validate.errors, null, 2)
+      JSON.stringify(validate.errors, null, 2),
     );
   }
 
   private validateIncomingRequestResponsePayload<T extends JsonObject>(
     chargingStation: ChargingStation,
     commandName: RequestCommand | IncomingRequestCommand,
-    payload: T
+    payload: T,
   ): boolean {
-    if (chargingStation.getPayloadSchemaValidation() === false) {
+    if (chargingStation.getOcppStrictCompliance() === false) {
       return true;
     }
     if (
       this.ocppResponseService.jsonIncomingRequestResponseSchemas.has(
-        commandName as IncomingRequestCommand
+        commandName as IncomingRequestCommand,
       ) === false
     ) {
       logger.warn(
-        `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`
+        `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: No JSON schema found for command '${commandName}' PDU validation`,
       );
       return true;
     }
     const validate = this.ajv.compile(
       this.ocppResponseService.jsonIncomingRequestResponseSchemas.get(
-        commandName as IncomingRequestCommand
-      )
+        commandName as IncomingRequestCommand,
+      )!,
     );
-    payload = Utils.cloneObject<T>(payload);
+    payload = cloneObject<T>(payload);
     OCPPServiceUtils.convertDateToISOString<T>(payload);
     if (validate(payload)) {
       return true;
     }
     logger.error(
       `${chargingStation.logPrefix()} ${moduleName}.validateIncomingRequestResponsePayload: Command '${commandName}' reponse PDU is invalid: %j`,
-      validate.errors
+      validate.errors,
     );
     // OCPPError usage here is debatable: it's an error in the OCPP stack but not targeted to sendError().
     throw new OCPPError(
-      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors),
+      OCPPServiceUtils.ajvErrorsToErrorType(validate.errors!),
       'Response PDU is invalid',
       commandName,
-      JSON.stringify(validate.errors, null, 2)
+      JSON.stringify(validate.errors, null, 2),
     );
   }
 
@@ -211,98 +275,38 @@ export default abstract class OCPPRequestService {
     messageId: string,
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
-    commandName?: RequestCommand | IncomingRequestCommand,
-    params: RequestParams = {
-      skipBufferingOnError: false,
-      triggerMessage: false,
-    }
+    commandName: RequestCommand | IncomingRequestCommand,
+    params: RequestParams = defaultRequestParams,
   ): Promise<ResponseType> {
+    params = {
+      ...defaultRequestParams,
+      ...params,
+    };
     if (
-      (chargingStation.isInUnknownState() === true &&
+      (chargingStation.inUnknownState() === true &&
         commandName === RequestCommand.BOOT_NOTIFICATION) ||
       (chargingStation.getOcppStrictCompliance() === false &&
-        chargingStation.isInUnknownState() === true) ||
-      chargingStation.isInAcceptedState() === true ||
-      (chargingStation.isInPendingState() === true &&
+        chargingStation.inUnknownState() === true) ||
+      chargingStation.inAcceptedState() === true ||
+      (chargingStation.inPendingState() === true &&
         (params.triggerMessage === true || messageType === MessageType.CALL_RESULT_MESSAGE))
     ) {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const self = this;
       // Send a message through wsConnection
-      return Utils.promiseWithTimeout(
-        new Promise((resolve, reject) => {
-          const messageToSend = this.buildMessageToSend(
-            chargingStation,
-            messageId,
-            messagePayload,
-            messageType,
-            commandName,
-            responseCallback,
-            errorCallback
-          );
-          if (chargingStation.getEnableStatistics() === true) {
-            chargingStation.performanceStatistics.addRequestStatistic(commandName, messageType);
-          }
-          let sendError = false;
-          // Check if wsConnection opened
-          if (chargingStation.isWebSocketConnectionOpened() === true) {
-            const beginId = PerformanceStatistics.beginMeasure(commandName as string);
-            try {
-              chargingStation.wsConnection.send(messageToSend);
-            } catch (error) {
-              sendError = true;
-            }
-            PerformanceStatistics.endMeasure(commandName as string, beginId);
-            logger.debug(
-              `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${this.getMessageTypeString(
-                messageType
-              )} payload: ${messageToSend}`
-            );
-          }
-          const wsClosedOrErrored =
-            chargingStation.isWebSocketConnectionOpened() === false || sendError === true;
-          if (wsClosedOrErrored && params.skipBufferingOnError === false) {
-            // Buffer
-            chargingStation.bufferMessage(messageToSend);
-            // Reject and keep request in the cache
-            return reject(
-              new OCPPError(
-                ErrorType.GENERIC_ERROR,
-                `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
-                commandName,
-                (messagePayload as JsonObject)?.details ?? {}
-              )
-            );
-          } else if (wsClosedOrErrored) {
-            const ocppError = new OCPPError(
-              ErrorType.GENERIC_ERROR,
-              `WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`,
-              commandName,
-              (messagePayload as JsonObject)?.details ?? {}
-            );
-            // Reject response
-            if (messageType !== MessageType.CALL_MESSAGE) {
-              return reject(ocppError);
-            }
-            // Reject and remove request from the cache
-            return errorCallback(ocppError, false);
-          }
-          // Resolve response
-          if (messageType !== MessageType.CALL_MESSAGE) {
-            return resolve(messagePayload);
-          }
-
+      return promiseWithTimeout(
+        new Promise<ResponseType>((resolve, reject) => {
           /**
            * Function that will receive the request's response
            *
            * @param payload -
            * @param requestPayload -
            */
-          function responseCallback(payload: JsonType, requestPayload: JsonType): void {
+          const responseCallback = (payload: JsonType, requestPayload: JsonType): void => {
             if (chargingStation.getEnableStatistics() === true) {
-              chargingStation.performanceStatistics.addRequestStatistic(
+              chargingStation.performanceStatistics?.addRequestStatistic(
                 commandName,
-                MessageType.CALL_RESULT_MESSAGE
+                MessageType.CALL_RESULT_MESSAGE,
               );
             }
             // Handle the request's response
@@ -311,7 +315,7 @@ export default abstract class OCPPRequestService {
                 chargingStation,
                 commandName as RequestCommand,
                 payload,
-                requestPayload
+                requestPayload,
               )
               .then(() => {
                 resolve(payload);
@@ -322,7 +326,7 @@ export default abstract class OCPPRequestService {
               .finally(() => {
                 chargingStation.requests.delete(messageId);
               });
-          }
+          };
 
           /**
            * Function that will receive the request's error response
@@ -330,40 +334,107 @@ export default abstract class OCPPRequestService {
            * @param error -
            * @param requestStatistic -
            */
-          function errorCallback(error: OCPPError, requestStatistic = true): void {
+          const errorCallback = (error: OCPPError, requestStatistic = true): void => {
             if (requestStatistic === true && chargingStation.getEnableStatistics() === true) {
-              chargingStation.performanceStatistics.addRequestStatistic(
+              chargingStation.performanceStatistics?.addRequestStatistic(
                 commandName,
-                MessageType.CALL_ERROR_MESSAGE
+                MessageType.CALL_ERROR_MESSAGE,
               );
             }
             logger.error(
-              `${chargingStation.logPrefix()} Error occurred at ${self.getMessageTypeString(
-                messageType
+              `${chargingStation.logPrefix()} Error occurred at ${OCPPServiceUtils.getMessageTypeString(
+                messageType,
               )} command ${commandName} with PDU %j:`,
               messagePayload,
-              error
+              error,
             );
             chargingStation.requests.delete(messageId);
             reject(error);
+          };
+
+          if (chargingStation.getEnableStatistics() === true) {
+            chargingStation.performanceStatistics?.addRequestStatistic(commandName, messageType);
+          }
+          const messageToSend = this.buildMessageToSend(
+            chargingStation,
+            messageId,
+            messagePayload,
+            messageType,
+            commandName,
+            responseCallback,
+            errorCallback,
+          );
+          let sendError = false;
+          // Check if wsConnection opened
+          const wsOpened = chargingStation.isWebSocketConnectionOpened() === true;
+          if (wsOpened) {
+            const beginId = PerformanceStatistics.beginMeasure(commandName);
+            try {
+              chargingStation.wsConnection?.send(messageToSend);
+              logger.debug(
+                `${chargingStation.logPrefix()} >> Command '${commandName}' sent ${OCPPServiceUtils.getMessageTypeString(
+                  messageType,
+                )} payload: ${messageToSend}`,
+              );
+            } catch (error) {
+              logger.error(
+                `${chargingStation.logPrefix()} >> Command '${commandName}' failed to send ${OCPPServiceUtils.getMessageTypeString(
+                  messageType,
+                )} payload: ${messageToSend}:`,
+                error,
+              );
+              sendError = true;
+            }
+            PerformanceStatistics.endMeasure(commandName, beginId);
+          }
+          const wsClosedOrErrored = !wsOpened || sendError === true;
+          if (wsClosedOrErrored && params.skipBufferingOnError === false) {
+            // Buffer
+            chargingStation.bufferMessage(messageToSend);
+            // Reject and keep request in the cache
+            return reject(
+              new OCPPError(
+                ErrorType.GENERIC_ERROR,
+                `WebSocket closed or errored for buffered message id '${messageId}' with content '${messageToSend}'`,
+                commandName,
+                (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT,
+              ),
+            );
+          } else if (wsClosedOrErrored) {
+            const ocppError = new OCPPError(
+              ErrorType.GENERIC_ERROR,
+              `WebSocket closed or errored for non buffered message id '${messageId}' with content '${messageToSend}'`,
+              commandName,
+              (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT,
+            );
+            // Reject response
+            if (messageType !== MessageType.CALL_MESSAGE) {
+              return reject(ocppError);
+            }
+            // Reject and remove request from the cache
+            return errorCallback(ocppError, false);
+          }
+          // Resolve response
+          if (messageType !== MessageType.CALL_MESSAGE) {
+            return resolve(messagePayload);
           }
         }),
-        Constants.OCPP_WEBSOCKET_TIMEOUT,
+        OCPPConstants.OCPP_WEBSOCKET_TIMEOUT,
         new OCPPError(
           ErrorType.GENERIC_ERROR,
           `Timeout for message id '${messageId}'`,
           commandName,
-          (messagePayload as JsonObject)?.details ?? {}
+          (messagePayload as JsonObject)?.details ?? Constants.EMPTY_FREEZED_OBJECT,
         ),
         () => {
           messageType === MessageType.CALL_MESSAGE && chargingStation.requests.delete(messageId);
-        }
+        },
       );
     }
     throw new OCPPError(
       ErrorType.SECURITY_ERROR,
       `Cannot send command ${commandName} PDU when the charging station is in ${chargingStation.getRegistrationStatus()} state on the central server`,
-      commandName
+      commandName,
     );
   }
 
@@ -372,9 +443,9 @@ export default abstract class OCPPRequestService {
     messageId: string,
     messagePayload: JsonType | OCPPError,
     messageType: MessageType,
-    commandName?: RequestCommand | IncomingRequestCommand,
-    responseCallback?: ResponseCallback,
-    errorCallback?: ErrorCallback
+    commandName: RequestCommand | IncomingRequestCommand,
+    responseCallback: ResponseCallback,
+    errorCallback: ErrorCallback,
   ): string {
     let messageToSend: string;
     // Type of message
@@ -382,13 +453,13 @@ export default abstract class OCPPRequestService {
       // Request
       case MessageType.CALL_MESSAGE:
         // Build request
+        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
         chargingStation.requests.set(messageId, [
           responseCallback,
           errorCallback,
           commandName,
           messagePayload as JsonType,
         ]);
-        this.validateRequestPayload(chargingStation, commandName, messagePayload as JsonObject);
         messageToSend = JSON.stringify([
           messageType,
           messageId,
@@ -402,7 +473,7 @@ export default abstract class OCPPRequestService {
         this.validateIncomingRequestResponsePayload(
           chargingStation,
           commandName,
-          messagePayload as JsonObject
+          messagePayload as JsonObject,
         );
         messageToSend = JSON.stringify([messageType, messageId, messagePayload] as Response);
         break;
@@ -421,34 +492,12 @@ export default abstract class OCPPRequestService {
     return messageToSend;
   }
 
-  private getMessageTypeString(messageType: MessageType): string {
-    switch (messageType) {
-      case MessageType.CALL_MESSAGE:
-        return 'request';
-      case MessageType.CALL_RESULT_MESSAGE:
-        return 'response';
-      case MessageType.CALL_ERROR_MESSAGE:
-        return 'error';
-    }
-  }
-
-  private handleSendMessageError(
-    chargingStation: ChargingStation,
-    commandName: RequestCommand | IncomingRequestCommand,
-    error: Error,
-    params: HandleErrorParams<EmptyObject> = { throwError: false }
-  ): void {
-    logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error);
-    if (params?.throwError === true) {
-      throw error;
-    }
-  }
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public abstract requestHandler<ReqType extends JsonType, ResType extends JsonType>(
     chargingStation: ChargingStation,
     commandName: RequestCommand,
+    // FIXME: should be ReqType
     commandParams?: JsonType,
-    params?: RequestParams
+    params?: RequestParams,
   ): Promise<ResType>;
 }