Support websockets to Validator Service.

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

Author: Dennis Labordus

src/Logging.ts

@@ -168,7 +168,7 @@ export function Logging<TBase extends LitElementConstructor>(Base: TBase) {
     private onIssue(de: IssueEvent): void {
       const issues = this.diagnoses.get(de.detail.validatorId);
 
-      if (!issues) this.diagnoses.set(de.detail.validatorId, [de.detail]);
+      if (!issues || de.detail.resetList === true) this.diagnoses.set(de.detail.validatorId, [de.detail]);
       else issues?.push(de.detail);
 
       this.latestIssue = de.detail;

src/compas-services/CompasValidatorService.ts

@@ -1,5 +1,10 @@
-import {CompasSettings} from "../compas/CompasSettings.js";
-import {handleError, handleResponse, parseXml} from "./foundation.js";
+import { CompasSettings } from "../compas/CompasSettings.js";
+import {
+  createLogEvent,
+  handleError,
+  handleResponse,
+  parseXml
+} from "./foundation.js";
 
 export const SVS_NAMESPACE = 'https://www.lfenergy.org/compas/SclValidatorService/v1';
 
@@ -8,23 +13,77 @@ export function CompasSclValidatorService() {
     return CompasSettings().compasSettings;
   }
 
+  function getWebsocketPort(): string {
+    if (document.location.port === "") {
+      return (document.location.protocol == "http:" ? "80" : "443")
+    }
+    return document.location.port;
+  }
+
+  function getWebsocketUri(): string {
+    const sclValidatorServiceUrl = getCompasSettings().sclValidatorServiceUrl;
+    if (sclValidatorServiceUrl.startsWith("ws://") || sclValidatorServiceUrl.startsWith("wss://")) {
+      return sclValidatorServiceUrl + (sclValidatorServiceUrl.endsWith("/") ? "" : "/");
+    }
+
+    return (document.location.protocol == "http:" ? "ws://" : "wss://")
+      + document.location.hostname  + ":" + getWebsocketPort()
+      + sclValidatorServiceUrl + (sclValidatorServiceUrl.endsWith("/") ? "" : "/");
+  }
+
+  function createRequest(doc: Document): string {
+    return `<?xml version="1.0" encoding="UTF-8"?>
+            <svs:SclValidateRequest xmlns:svs="${SVS_NAMESPACE}">
+              <svs:SclData><![CDATA[${new XMLSerializer().serializeToString(doc.documentElement)}]]></svs:SclData>
+            </svs:SclValidateRequest>`;
+  }
+
   return {
-    validateSCL(type: string, doc: Document): Promise<Document> {
+    useWebsocket(): boolean {
+      const sclValidatorServiceUrl = getCompasSettings().sclValidatorServiceUrl;
+      return !sclValidatorServiceUrl.startsWith("http");
+    },
+
+    validateSCLUsingRest(type: string, doc: Document): Promise<Document> {
       const svsUrl = getCompasSettings().sclValidatorServiceUrl + '/validate/v1/' + type;
       return fetch(svsUrl, {
         method: 'POST',
         headers: {
           'Content-Type': 'application/xml'
         },
-        body: `<?xml version="1.0" encoding="UTF-8"?>
-               <svs:SclValidateRequest xmlns:svs="${SVS_NAMESPACE}">
-                 <svs:SclData><![CDATA[${new XMLSerializer().serializeToString(doc.documentElement)}]]></svs:SclData>
-               </svs:SclValidateRequest>`
+        body: createRequest(doc)
       }).catch(handleError)
         .then(handleResponse)
         .then(parseXml);
     },
 
+    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();
+      };
+    },
+
     listNsdocFiles(): Promise<Document> {
       const svsUrl = getCompasSettings().sclValidatorServiceUrl + '/nsdoc/v1';
       return fetch(svsUrl).catch(handleError)

src/foundation.ts

@@ -411,6 +411,7 @@ export function newLogEvent(
 
 export interface IssueDetail extends LogDetailBase {
   validatorId: string;
+  resetList?: boolean;
 }
 export type IssueEvent = CustomEvent<IssueDetail>;
 export function newIssueEvent(

src/validators/ValidateSchemaWithCompas.ts

@@ -1,10 +1,10 @@
-import {LitElement, property} from "lit-element";
+import { LitElement, property } from "lit-element";
 
-import {newIssueEvent} from "../foundation.js";
+import { newIssueEvent } from "../foundation.js";
 
-import {CompasSclValidatorService, SVS_NAMESPACE} from "../compas-services/CompasValidatorService.js";
-import {createLogEvent} from "../compas-services/foundation.js";
-import {dispatchEventOnOpenScd, getTypeFromDocName} from "../compas/foundation.js";
+import { CompasSclValidatorService, SVS_NAMESPACE } from "../compas-services/CompasValidatorService.js";
+import { createLogEvent } from "../compas-services/foundation.js";
+import { dispatchEventOnOpenScd, getTypeFromDocName } from "../compas/foundation.js";
 
 export default class ValidateTemplates extends LitElement {
   @property({ attribute: false })
@@ -23,22 +23,31 @@ export default class ValidateTemplates extends LitElement {
     }
 
     const docType = getTypeFromDocName(this.docName);
-    await CompasSclValidatorService().validateSCL(docType, this.doc)
-      .then(document => {
-        const validationErrors = Array.from(document.querySelectorAll('SclValidateResponse > ValidationErrors') ?? []);
-        // Check if there are validation errors, if there are we will process them.
-        if (validationErrors.length > 0) {
-          validationErrors.forEach(validationError => {
-            const message = validationError.getElementsByTagNameNS(SVS_NAMESPACE, "Message")!.item(0)!.textContent;
-            dispatchEventOnOpenScd(
-              newIssueEvent({
-                validatorId: this.pluginId,
-                title: message ?? 'No message'
-              })
-            );
+    const service = CompasSclValidatorService();
+    if (service.useWebsocket()) {
+      service.validateSCLUsingWebsockets(docType, this.doc, (doc) => {
+        this.processValidationResponse(doc);
+      });
+    } else {
+      service.validateSCLUsingRest(docType, this.doc)
+        .then(response => this.processValidationResponse(response))
+        .catch(createLogEvent);
+    }
+  }
+
+  private processValidationResponse(response: Document): void {
+    const validationErrors = Array.from(response.querySelectorAll('SclValidateResponse > ValidationErrors') ?? []);
+    // Check if there are validation errors, if there are we will process them.
+    if (validationErrors.length > 0) {
+      validationErrors.forEach(validationError => {
+        const message = validationError.getElementsByTagNameNS(SVS_NAMESPACE, "Message")!.item(0)!.textContent;
+        dispatchEventOnOpenScd(
+          newIssueEvent({
+            validatorId: this.pluginId,
+            title: message ?? 'No message'
           })
-        }
+        );
       })
-      .catch(createLogEvent);
+    }
   }
 }