Support Websocket also for Get and GetVersion. Also changed the request bodies for Websocket.

Dennis Labordus · Dennis Labordus · commit e7de36e5bd16 · 2022-11-10T13:54:15.000+01:00
Signed-off-by: Dennis Labordus &lt;dennis.labordus@alliander.com&gt;
diff --git a/src/compas-editors/CompasVersions.ts b/src/compas-editors/CompasVersions.ts
@@ -130,25 +130,40 @@ export default class CompasVersionsPlugin extends LitElement {
 
   private confirmRestoreVersionWizard(version: string): Wizard {
     function openScl(plugin: CompasVersionsPlugin) {
-      return function () {
-        const type = getTypeFromDocName(plugin.docName);
-
-        CompasSclDataService()
-          .getSclDocumentVersion(type, plugin.docId, version)
-          .then(sclDocument => {
-            updateDocumentInOpenSCD(plugin, sclDocument);
+      function updateDocument(sclDocument: Document): void {
+        updateDocumentInOpenSCD(plugin, sclDocument);
 
-            plugin.dispatchEvent(
-              newLogEvent({
-                kind: 'info',
-                title: get('compas.versions.restoreVersionSuccess', {
-                  version: version,
-                }),
-              })
-            );
+        plugin.dispatchEvent(
+          newLogEvent({
+            kind: 'info',
+            title: get('compas.versions.restoreVersionSuccess', {
+              version: version,
+            }),
           })
-          .catch(reason => createLogEvent(plugin, reason));
+        );
+      }
 
+      return function () {
+        const type = getTypeFromDocName(plugin.docName);
+
+        const service = CompasSclDataService();
+        if (service.useWebsocket()) {
+          service.getSclDocumentVersionUsingWebsockets(
+            plugin,
+            type,
+            plugin.docId,
+            version,
+            (sclDocument) => {
+              updateDocument(sclDocument);
+            })
+        } else {
+          service
+            .getSclDocumentVersionUsingRest(type, plugin.docId, version)
+            .then(sclDocument => {
+              updateDocument(sclDocument);
+            })
+            .catch(reason => createLogEvent(plugin, reason));
+        }
         // Close the Restore Dialog.
         plugin.dispatchEvent(newWizardEvent());
 
@@ -285,15 +300,17 @@ export default class CompasVersionsPlugin extends LitElement {
       const oldScl = await this.getVersion(oldVersion);
       const newScl = this.doc.documentElement;
 
-      this.dispatchEvent(
-        newWizardEvent(
-          compareWizard(this, oldScl, newScl, {
-            title: get('compas.compare.titleCurrent', {
-              oldVersion: oldVersion,
-            }),
-          })
-        )
-      );
+      if (oldScl && newScl) {
+        this.dispatchEvent(
+          newWizardEvent(
+            compareWizard(this, oldScl, newScl, {
+              title: get('compas.compare.titleCurrent', {
+                oldVersion: oldVersion,
+              }),
+            })
+          )
+        );
+      }
     } else {
       this.dispatchEvent(
         newWizardEvent(
@@ -318,16 +335,18 @@ export default class CompasVersionsPlugin extends LitElement {
       const oldScl = await this.getVersion(oldVersion);
       const newScl = await this.getVersion(newVersion);
 
-      this.dispatchEvent(
-        newWizardEvent(
-          compareWizard(this, oldScl, newScl, {
-            title: get('compas.compare.title', {
-              oldVersion: oldVersion,
-              newVersion: newVersion,
-            }),
-          })
-        )
-      );
+      if (oldScl && newScl) {
+        this.dispatchEvent(
+          newWizardEvent(
+            compareWizard(this, oldScl, newScl, {
+              title: get('compas.compare.title', {
+                oldVersion: oldVersion,
+                newVersion: newVersion,
+              }),
+            })
+          )
+        );
+      }
     } else {
       this.dispatchEvent(
         newWizardEvent(
@@ -351,13 +370,31 @@ export default class CompasVersionsPlugin extends LitElement {
     ];
   }
 
-  private async getVersion(version: string) {
+  private async getVersion(version: string): Promise<void | Element> {
     const type = getTypeFromDocName(this.docName);
-    return CompasSclDataService()
-      .getSclDocumentVersion(type, this.docId, version)
-      .then(sclDocument => {
-        return Promise.resolve(sclDocument.documentElement);
+    const service = CompasSclDataService();
+
+    if (service.useWebsocket()) {
+      return new Promise((resolve) => {
+        service.getSclDocumentVersionUsingWebsockets(
+          this,
+          type,
+          this.docId,
+          version,
+          (sclDocument) => {
+            resolve(sclDocument.documentElement);
+          })
       });
+    } else {
+      return service
+        .getSclDocumentVersionUsingRest(type, this.docId, version)
+        .then(sclDocument => {
+          return Promise.resolve(<Element>sclDocument.documentElement);
+        })
+        .catch(reason => {
+          createLogEvent(this, reason)
+        });
+    }
   }
 
   private openEditWizard(): void {
diff --git a/src/compas-services/CompasSclDataService.ts b/src/compas-services/CompasSclDataService.ts
@@ -35,36 +35,6 @@ export function CompasSclDataService() {
     return CompasSettings().compasSettings.sclDataServiceUrl;
   }
 
-  function createCreateRequest(
-    sclName: string,
-    comment: string | null,
-    doc: Document
-  ): string {
-    return `<?xml version="1.0" encoding="UTF-8"?>
-               <sds:CreateRequest xmlns:sds="${SDS_NAMESPACE}">
-                   <sds:Name>${sclName}</sds:Name>
-                   <sds:Comment>${comment ?? ''}</sds:Comment>
-                   <sds:SclData><![CDATA[${formatXml(
-                     new XMLSerializer().serializeToString(
-                       doc.documentElement))}]]></sds:SclData>
-               </sds:CreateRequest>`;
-  }
-
-  function createUpdateRequest(
-    changeSet: ChangeSet,
-    comment: string | null,
-    doc: Document
-  ): string {
-    return `<?xml version="1.0" encoding="UTF-8"?>
-               <sds:UpdateRequest xmlns:sds="${SDS_NAMESPACE}">
-                   <sds:ChangeSet>${changeSet}</sds:ChangeSet>
-                   <sds:Comment>${comment ?? ''}</sds:Comment>
-                   <sds:SclData><![CDATA[${formatXml(
-                     new XMLSerializer().serializeToString(
-                       doc.documentElement))}]]></sds:SclData>
-               </sds:UpdateRequest>`;
-  }
-
   return {
     useWebsocket(): boolean {
       return CompasSettings().useWebsockets();
@@ -120,7 +90,10 @@ export function CompasSclDataService() {
         .then(parseXml);
     },
 
-    getSclDocument(type: string, id: string): Promise<Document> {
+    getSclDocumentUsingRest(
+      type: string,
+      id: string
+    ): Promise<Document> {
       const sclUrl =
         getSclDataServiceUrl() + '/scl/v1/' + type + '/' + id;
       return fetch(sclUrl)
@@ -130,7 +103,30 @@ export function CompasSclDataService() {
         .then(extractSclFromResponse);
     },
 
-    getSclDocumentVersion(
+    getSclDocumentUsingWebsockets(
+      element: Element,
+      type: string,
+      id: string,
+      callback: (scl: Document) => void,
+    ) {
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:GetWsRequest xmlns:sds="${SDS_NAMESPACE}">
+           <sds:Id>${id}</sds:Id>
+         </sds:GetWsRequest>`;
+
+      const sclUrl = getSclDataServiceUrl() + '/scl-ws/v1/' + type + '/get';
+      Websockets(element, 'CompasSclDataService').execute(
+        getWebsocketUri(sclUrl),
+        request,
+        async (response: Document) => {
+          const scl = await extractSclFromResponse(response);
+          callback(scl);
+        }
+      );
+    },
+
+    getSclDocumentVersionUsingRest(
       type: string,
       id: string,
       version: string
@@ -150,6 +146,31 @@ export function CompasSclDataService() {
         .then(extractSclFromResponse);
     },
 
+    getSclDocumentVersionUsingWebsockets(
+      element: Element,
+      type: string,
+      id: string,
+      version: string,
+      callback: (scl: Document) => void,
+    ) {
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:GetVersionWsRequest xmlns:sds="${SDS_NAMESPACE}">
+           <sds:Id>${id}</sds:Id>
+           <sds:Version>${version}</sds:Version>
+         </sds:GetVersionWsRequest>`;
+
+      const sclUrl = getSclDataServiceUrl() + '/scl-ws/v1/' + type + '/get-version';
+      Websockets(element, 'CompasSclDataService').execute(
+        getWebsocketUri(sclUrl),
+        request,
+        async (response: Document) => {
+          const scl = await extractSclFromResponse(response);
+          callback(scl);
+        }
+      );
+    },
+
     deleteSclDocumentVersion(
       type: string,
       id: string,
@@ -177,13 +198,23 @@ export function CompasSclDataService() {
     },
 
     addSclDocumentUsingRest(type: string, body: CreateRequestBody): Promise<Document> {
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:CreateRequest xmlns:sds="${SDS_NAMESPACE}">
+            <sds:Name>${body.sclName}</sds:Name>
+            <sds:Comment>${body.comment ?? ''}</sds:Comment>
+            <sds:SclData><![CDATA[${formatXml(
+               new XMLSerializer().serializeToString(
+                 body.doc.documentElement))}]]></sds:SclData>
+         </sds:CreateRequest>`;
+
       const sclUrl = getSclDataServiceUrl() + '/scl/v1/' + type;
       return fetch(sclUrl, {
         method: 'POST',
         headers: {
           'Content-Type': 'application/xml',
         },
-        body: createCreateRequest(body.sclName, body.comment, body.doc),
+        body: request,
       })
         .catch(handleError)
         .then(handleResponse)
@@ -197,10 +228,20 @@ export function CompasSclDataService() {
       body: CreateRequestBody,
       callback: (scl: Document) => void,
     ) {
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:CreateWsRequest xmlns:sds="${SDS_NAMESPACE}">
+           <sds:Name>${body.sclName}</sds:Name>
+           <sds:Comment>${body.comment ?? ''}</sds:Comment>
+           <sds:SclData><![CDATA[${formatXml(
+             new XMLSerializer().serializeToString(
+               body.doc.documentElement))}]]></sds:SclData>
+         </sds:CreateWsRequest>`;
+
       const sclUrl = getSclDataServiceUrl() + '/scl-ws/v1/' + type + '/create';
       Websockets(element, 'CompasSclDataService').execute(
         getWebsocketUri(sclUrl),
-        createCreateRequest(body.sclName, body.comment, body.doc),
+        request,
         async (response: Document) => {
           const scl = await extractSclFromResponse(response);
           callback(scl);
@@ -213,14 +254,24 @@ export function CompasSclDataService() {
       id: string,
       body: UpdateRequestBody
     ): Promise<Document> {
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:UpdateRequest xmlns:sds="${SDS_NAMESPACE}">
+           <sds:ChangeSet>${body.changeSet}</sds:ChangeSet>
+           <sds:Comment>${body.comment ?? ''}</sds:Comment>
+           <sds:SclData><![CDATA[${formatXml(
+             new XMLSerializer().serializeToString(
+               body.doc.documentElement))}]]></sds:SclData>
+         </sds:UpdateRequest>`;
+
       const sclUrl =
         getSclDataServiceUrl() + '/scl/v1/' + type + '/' + id;
       return fetch(sclUrl, {
         method: 'PUT',
         headers: {
           'Content-Type': 'application/xml',
         },
-        body: createUpdateRequest(body.changeSet, body.comment, body.doc),
+        body: request,
       })
         .catch(handleError)
         .then(handleResponse)
@@ -235,10 +286,21 @@ export function CompasSclDataService() {
       body: UpdateRequestBody,
       callback: (scl: Document) => void,
     ) {
-      const sclUrl = getSclDataServiceUrl() + '/scl-ws/v1/' + type + '/update/' + id;
+      const request =
+        `<?xml version="1.0" encoding="UTF-8"?>
+         <sds:UpdateWsRequest xmlns:sds="${SDS_NAMESPACE}">
+           <sds:Id>${id}</sds:Id>
+           <sds:ChangeSet>${body.changeSet}</sds:ChangeSet>
+           <sds:Comment>${body.comment ?? ''}</sds:Comment>
+           <sds:SclData><![CDATA[${formatXml(
+          new XMLSerializer().serializeToString(
+            body.doc.documentElement))}]]></sds:SclData>
+         </sds:UpdateWsRequest>`
+
+      const sclUrl = getSclDataServiceUrl() + '/scl-ws/v1/' + type + '/update';
       Websockets(element, 'CompasSclDataService').execute(
         getWebsocketUri(sclUrl),
-        createUpdateRequest(body.changeSet, body.comment, body.doc),
+        request,
         async (response: Document) => {
           const scl = await extractSclFromResponse(response);
           callback(scl);
diff --git a/src/compas/CompasOpen.ts b/src/compas/CompasOpen.ts
@@ -56,9 +56,20 @@ export default class CompasOpenElement extends LitElement {
   private sclFileUI!: HTMLInputElement;
 
   private async getSclDocument(docId?: string): Promise<void> {
-    const doc = await CompasSclDataService()
-      .getSclDocument(this.selectedType ?? '', docId ?? '')
-      .catch(reason => createLogEvent(this, reason));
+    const service = CompasSclDataService();
+    const doc = service.useWebsocket()
+      ? await new Promise((resolve) => {
+          service.getSclDocumentUsingWebsockets(
+            this,
+            this.selectedType ?? '',
+            docId ?? '',
+            (doc) => resolve(doc)
+          )
+        })
+      : await service
+        .getSclDocumentUsingRest(this.selectedType ?? '', docId ?? '')
+        .catch(reason => createLogEvent(this, reason));
+
     if (doc instanceof Document) {
       const docName = buildDocName(doc.documentElement);
       this.dispatchEvent(newDocRetrievedEvent(false, doc, docName, docId));
