feat(ui): add set supervision url action
[e-mobility-charging-stations-simulator.git] / ui / web / src / composables / UIClient.ts
index c2f1b0c21bff809e568ef386b612c3fba5812e02..ce459f1b253504abbb478fa54b5aef5544646a22 100644 (file)
@@ -1,71 +1,97 @@
-import Utils from './Utils';
 import {
+  ApplicationProtocol,
+  AuthenticationType,
+  type ConfigurationData,
   ProcedureName,
   type ProtocolResponse,
   type RequestPayload,
   type ResponsePayload,
-  ResponseStatus,
-} from '@/types';
-import config from '@/assets/config';
+  ResponseStatus
+} from '@/types'
 
 type ResponseHandler = {
-  procedureName: ProcedureName;
-  resolve: (value: ResponsePayload | PromiseLike<ResponsePayload>) => void;
-  reject: (reason?: unknown) => void;
-};
+  procedureName: ProcedureName
+  resolve: (value: ResponsePayload | PromiseLike<ResponsePayload>) => void
+  reject: (reason?: unknown) => void
+}
 
-export default class UIClient {
-  private static instance: UIClient | null = null;
+export class UIClient {
+  private static instance: UIClient | null = null
 
-  private ws!: WebSocket;
-  private responseHandlers: Map<string, ResponseHandler>;
+  private ws!: WebSocket
+  private responseHandlers: Map<string, ResponseHandler>
 
-  private constructor() {
-    this.openWS();
-    this.responseHandlers = new Map<string, ResponseHandler>();
+  private constructor(private configuration: ConfigurationData) {
+    this.openWS()
+    this.responseHandlers = new Map<string, ResponseHandler>()
   }
 
-  public static getInstance() {
+  public static getInstance(configuration: ConfigurationData) {
     if (UIClient.instance === null) {
-      UIClient.instance = new UIClient();
+      UIClient.instance = new UIClient(configuration)
     }
-    return UIClient.instance;
+    return UIClient.instance
   }
 
-  public registerWSonOpenListener(listener: (event: Event) => void) {
-    this.ws.addEventListener('open', listener);
+  public registerWSEventListener<K extends keyof WebSocketEventMap>(
+    event: K,
+    listener: (event: WebSocketEventMap[K]) => void
+  ) {
+    this.ws.addEventListener(event, listener)
   }
 
   public async startSimulator(): Promise<ResponsePayload> {
-    return this.sendRequest(ProcedureName.START_SIMULATOR, {});
+    return this.sendRequest(ProcedureName.START_SIMULATOR, {})
   }
 
   public async stopSimulator(): Promise<ResponsePayload> {
-    return this.sendRequest(ProcedureName.STOP_SIMULATOR, {});
+    return this.sendRequest(ProcedureName.STOP_SIMULATOR, {})
+  }
+
+  public async listTemplates(): Promise<ResponsePayload> {
+    return this.sendRequest(ProcedureName.LIST_TEMPLATES, {})
   }
 
   public async listChargingStations(): Promise<ResponsePayload> {
-    return this.sendRequest(ProcedureName.LIST_CHARGING_STATIONS, {});
+    return this.sendRequest(ProcedureName.LIST_CHARGING_STATIONS, {})
+  }
+
+  public async addChargingStations(
+    template: string,
+    numberOfStations: number
+  ): Promise<ResponsePayload> {
+    return this.sendRequest(ProcedureName.ADD_CHARGING_STATIONS, { template, numberOfStations })
+  }
+
+  public async deleteChargingStation(hashId: string): Promise<ResponsePayload> {
+    return this.sendRequest(ProcedureName.DELETE_CHARGING_STATIONS, { hashIds: [hashId] })
+  }
+
+  public async setSupervisionUrl(hashId: string, supervisionUrl: string): Promise<ResponsePayload> {
+    return this.sendRequest(ProcedureName.SET_SUPERVISION_URL, {
+      hashIds: [hashId],
+      url: supervisionUrl
+    })
   }
 
   public async startChargingStation(hashId: string): Promise<ResponsePayload> {
-    return this.sendRequest(ProcedureName.START_CHARGING_STATION, { hashIds: [hashId] });
+    return this.sendRequest(ProcedureName.START_CHARGING_STATION, { hashIds: [hashId] })
   }
 
   public async stopChargingStation(hashId: string): Promise<ResponsePayload> {
-    return this.sendRequest(ProcedureName.STOP_CHARGING_STATION, { hashIds: [hashId] });
+    return this.sendRequest(ProcedureName.STOP_CHARGING_STATION, { hashIds: [hashId] })
   }
 
   public async openConnection(hashId: string): Promise<ResponsePayload> {
     return this.sendRequest(ProcedureName.OPEN_CONNECTION, {
-      hashIds: [hashId],
-    });
+      hashIds: [hashId]
+    })
   }
 
   public async closeConnection(hashId: string): Promise<ResponsePayload> {
     return this.sendRequest(ProcedureName.CLOSE_CONNECTION, {
-      hashIds: [hashId],
-    });
+      hashIds: [hashId]
+    })
   }
 
   public async startTransaction(
@@ -76,8 +102,8 @@ export default class UIClient {
     return this.sendRequest(ProcedureName.START_TRANSACTION, {
       hashIds: [hashId],
       connectorId,
-      idTag,
-    });
+      idTag
+    })
   }
 
   public async stopTransaction(
@@ -86,8 +112,8 @@ export default class UIClient {
   ): Promise<ResponsePayload> {
     return this.sendRequest(ProcedureName.STOP_TRANSACTION, {
       hashIds: [hashId],
-      transactionId,
-    });
+      transactionId
+    })
   }
 
   public async startAutomaticTransactionGenerator(
@@ -96,8 +122,8 @@ export default class UIClient {
   ): Promise<ResponsePayload> {
     return this.sendRequest(ProcedureName.START_AUTOMATIC_TRANSACTION_GENERATOR, {
       hashIds: [hashId],
-      connectorIds: [connectorId],
-    });
+      connectorIds: [connectorId]
+    })
   }
 
   public async stopAutomaticTransactionGenerator(
@@ -106,93 +132,88 @@ export default class UIClient {
   ): Promise<ResponsePayload> {
     return this.sendRequest(ProcedureName.STOP_AUTOMATIC_TRANSACTION_GENERATOR, {
       hashIds: [hashId],
-      connectorIds: [connectorId],
-    });
+      connectorIds: [connectorId]
+    })
   }
 
   private openWS(): void {
+    const protocols =
+      this.configuration.uiServer.authentication?.enabled === true &&
+      this.configuration.uiServer.authentication?.type === AuthenticationType.PROTOCOL_BASIC_AUTH
+        ? [
+            `${this.configuration.uiServer.protocol}${this.configuration.uiServer.version}`,
+            `authorization.basic.${btoa(`${this.configuration.uiServer.authentication.username}:${this.configuration.uiServer.authentication.password}`).replace(/={1,2}$/, '')}`
+          ]
+        : `${this.configuration.uiServer.protocol}${this.configuration.uiServer.version}`
     this.ws = new WebSocket(
-      `ws://${config.uiServer.host}:${config.uiServer.port}`,
-      config.uiServer.protocol
-    );
-    this.ws.onmessage = this.responseHandler.bind(this);
-    this.ws.onerror = (errorEvent) => {
-      console.error('WebSocket error: ', errorEvent);
-    };
-    this.ws.onclose = (closeEvent) => {
-      console.info('WebSocket closed: ', closeEvent);
-    };
-  }
-
-  private setResponseHandler(
-    id: string,
-    procedureName: ProcedureName,
-    resolve: (value: ResponsePayload | PromiseLike<ResponsePayload>) => void,
-    reject: (reason?: any) => void
-  ): void {
-    this.responseHandlers.set(id, { procedureName, resolve, reject });
-  }
-
-  private getResponseHandler(id: string): ResponseHandler | undefined {
-    return this.responseHandlers.get(id);
-  }
-
-  private deleteResponseHandler(id: string): boolean {
-    return this.responseHandlers.delete(id);
+      `${this.configuration.uiServer.secure === true ? ApplicationProtocol.WSS : ApplicationProtocol.WS}://${this.configuration.uiServer.host}:${this.configuration.uiServer.port}`,
+      protocols
+    )
+    this.ws.onopen = openEvent => {
+      console.info('WebSocket opened', openEvent)
+    }
+    this.ws.onmessage = this.responseHandler.bind(this)
+    this.ws.onerror = errorEvent => {
+      console.error('WebSocket error: ', errorEvent)
+    }
+    this.ws.onclose = closeEvent => {
+      console.info('WebSocket closed: ', closeEvent)
+    }
   }
 
   private async sendRequest(
-    command: ProcedureName,
-    data: RequestPayload
+    procedureName: ProcedureName,
+    payload: RequestPayload
   ): Promise<ResponsePayload> {
-    let uuid: string;
-    return Utils.promiseWithTimeout(
-      new Promise((resolve, reject) => {
-        uuid = crypto.randomUUID();
-        const msg = JSON.stringify([uuid, command, data]);
-
-        if (this.ws.readyState !== WebSocket.OPEN) {
-          this.openWS();
-        }
-        if (this.ws.readyState === WebSocket.OPEN) {
-          this.ws.send(msg);
-        } else {
-          throw new Error(`Send request '${command}' message: connection not opened`);
+    return new Promise<ResponsePayload>((resolve, reject) => {
+      if (this.ws.readyState === WebSocket.OPEN) {
+        const uuid = crypto.randomUUID()
+        const msg = JSON.stringify([uuid, procedureName, payload])
+        const sendTimeout = setTimeout(() => {
+          this.responseHandlers.delete(uuid)
+          return reject(new Error(`Send request '${procedureName}' message: connection timeout`))
+        }, 60000)
+        try {
+          this.ws.send(msg)
+          this.responseHandlers.set(uuid, { procedureName, resolve, reject })
+        } catch (error) {
+          this.responseHandlers.delete(uuid)
+          reject(error)
+        } finally {
+          clearTimeout(sendTimeout)
         }
-
-        this.setResponseHandler(uuid, command, resolve, reject);
-      }),
-      120 * 1000,
-      Error(`Send request '${command}' message timeout`),
-      () => {
-        this.responseHandlers.delete(uuid);
+      } else {
+        reject(new Error(`Send request '${procedureName}' message: connection closed`))
       }
-    );
+    })
   }
 
   private responseHandler(messageEvent: MessageEvent<string>): void {
-    const response = JSON.parse(messageEvent.data) as ProtocolResponse;
+    const response = JSON.parse(messageEvent.data) as ProtocolResponse
 
     if (Array.isArray(response) === false) {
-      throw new Error(`Response not an array: ${JSON.stringify(response, null, 2)}`);
+      throw new Error(`Response not an array: ${JSON.stringify(response, undefined, 2)}`)
     }
 
-    const [uuid, responsePayload] = response;
+    const [uuid, responsePayload] = response
 
     if (this.responseHandlers.has(uuid) === true) {
+      const { procedureName, resolve, reject } = this.responseHandlers.get(uuid)!
       switch (responsePayload.status) {
         case ResponseStatus.SUCCESS:
-          this.getResponseHandler(uuid)?.resolve(responsePayload);
-          break;
+          resolve(responsePayload)
+          break
         case ResponseStatus.FAILURE:
-          this.getResponseHandler(uuid)?.reject(responsePayload);
-          break;
+          reject(responsePayload)
+          break
         default:
-          console.error(`Response status not supported: ${responsePayload.status}`);
+          console.error(
+            `Response status for procedure '${procedureName}' not supported: '${responsePayload.status}'`
+          )
       }
-      this.deleteResponseHandler(uuid);
+      this.responseHandlers.delete(uuid)
     } else {
-      throw new Error(`Not a response to a request: ${JSON.stringify(response, null, 2)}`);
+      throw new Error(`Not a response to a request: ${JSON.stringify(response, undefined, 2)}`)
     }
   }
 }