Refactor Websocket code to be reused.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

public/js/plugins.js

@@ -102,7 +102,7 @@ export const officialPlugins = [
   },
   {
     name: 'Validate using OCL',
-    src: '/src/validators/ValidateSchemaWithCompas.js',
+    src: '/src/validators/CompasValidateSchema.js',
     icon: 'rule_folder',
     default: true,
     kind: 'validator',

src/compas-services/CompasValidatorService.ts

@@ -5,6 +5,7 @@ import {
   handleResponse,
   parseXml
 } from "./foundation.js";
+import {Websockets} from "./Websockets";
 
 export const SVS_NAMESPACE = 'https://www.lfenergy.org/compas/SclValidatorService/v1';
 
@@ -22,17 +23,13 @@ export function CompasSclValidatorService() {
 
   function getWebsocketUri(): string {
     const sclValidatorServiceUrl = getCompasSettings().sclValidatorServiceUrl;
-    if (sclValidatorServiceUrl.startsWith("ws://") || sclValidatorServiceUrl.startsWith("wss://")) {
-      return sclValidatorServiceUrl + (sclValidatorServiceUrl.endsWith("/") ? "" : "/");
-    }
     if (sclValidatorServiceUrl.startsWith("http://") || sclValidatorServiceUrl.startsWith("https://")) {
-      return sclValidatorServiceUrl.replace("http://", "ws://").replace("https://", "wss://")
-        + (sclValidatorServiceUrl.endsWith("/") ? "" : "/");
+      return sclValidatorServiceUrl.replace("http://", "ws://").replace("https://", "wss://");
     }
 
     return (document.location.protocol == "http:" ? "ws://" : "wss://")
       + document.location.hostname  + ":" + getWebsocketPort()
-      + sclValidatorServiceUrl + (sclValidatorServiceUrl.endsWith("/") ? "" : "/");
+      + sclValidatorServiceUrl;
   }
 
   function createRequest(doc: Document): string {
@@ -61,30 +58,11 @@ export function CompasSclValidatorService() {
     },
 
     validateSCLUsingWebsockets(type: string, doc: Document, callback: (doc: Document) => void) {
-      const websocket = new WebSocket(getWebsocketUri() + 'validate-ws/v1/' + type);
-
-      websocket.onopen = () => {
-        websocket.send(createRequest(doc));
-      };
-
-      websocket.onmessage = (evt) => {
-        parseXml(evt.data)
-          .then(doc => {
-            callback(doc);
-            websocket.close();
-          })
-          .catch(reason => {
-            createLogEvent(reason);
-            websocket.close();
-          });
-      };
-
-      websocket.onerror = () => {
-        createLogEvent(
-          { message: 'Websocket Error',
-            type: 'Error'})
-        websocket.close();
-      };
+      Websockets('CompasValidatorService')
+        .execute(
+          getWebsocketUri() + '/validate-ws/v1/' + type,
+          createRequest(doc),
+          callback);
     },
 
     listNsdocFiles(): Promise<Document> {

src/compas-services/Websockets.ts

@@ -0,0 +1,52 @@
+import { newPendingStateEvent } from "../foundation.js";
+import { dispatchEventOnOpenScd } from "../compas/foundation.js";
+import { createLogEvent, parseXml } from "./foundation.js";
+
+export function Websockets(serviceName: string) {
+  let websocket: WebSocket | undefined;
+
+  function sleep(sleepTime: number): Promise<unknown> {
+    return new Promise(resolve => setTimeout(resolve, sleepTime));
+  }
+
+  async function waitUntilValidated(): Promise<void> {
+    while (websocket !== undefined) {
+      await sleep(250);
+    }
+  }
+
+  return {
+    execute(url: string, request: string, callback: (doc: Document) => void) {
+      websocket = new WebSocket(url);
+
+      websocket.onopen = () => {
+        websocket?.send(request);
+      };
+
+      websocket.onmessage = (evt) => {
+        parseXml(evt.data)
+          .then(doc => {
+            callback(doc);
+            websocket?.close();
+          })
+          .catch(reason => {
+            createLogEvent(reason);
+            websocket?.close();
+          });
+      };
+
+      websocket.onerror = () => {
+        createLogEvent(
+          { message: `Websocket Error in service "${serviceName}"`,
+            type: 'Error'})
+        websocket?.close();
+      };
+
+      websocket.onclose = () => {
+        websocket = undefined;
+      }
+
+      dispatchEventOnOpenScd(newPendingStateEvent(waitUntilValidated()))
+    }
+  }
+}

src/translations/en.ts

@@ -565,7 +565,7 @@ export const en = {
     noSclVersions: 'No versions found for this project in CoMPAS',
     error: {
       type: 'Unable to determine type from document name!',
-      server: 'Error communicating with CoMPAS Server',
+      server: 'Error communicating with CoMPAS Ecosystem',
       serverDetails: '{{type}}: {{message}}',
     },
     changeset: {

src/validators/ValidateSchemaWithCompas.ts renamed to src/validators/CompasValidateSchema.ts

@@ -29,9 +29,11 @@ export default class ValidateTemplates extends LitElement {
         this.processValidationResponse(doc);
       });
     } else {
-      service.validateSCLUsingRest(docType, this.doc)
-        .then(response => this.processValidationResponse(response))
+      const response = await service.validateSCLUsingRest(docType, this.doc)
         .catch(createLogEvent);
+      if (response instanceof Document) {
+        this.processValidationResponse(response);
+      }
     }
   }