dmx-api 3.0.0 → 3.0.1

package/README.md

@@ -2,6 +2,11 @@
 
 ## Version History
 
+**3.0.1** -- Jun 6, 2023
+
+* Improvement:
+    - In case of a dropped WebSocket connection an alert is shown and the page is reloaded
+
 **3.0** -- May 19, 2023
 
 Version 3.0 of the `dmx-api` library extends/modifies the API in order to support a wider variety of frontend
@@ -30,6 +35,7 @@ library's `init()` function.
     - change `Type`'s `newFormModel()`:
         - `object` parameter is now optional
         - add `allChildren` parameter (optional)
+    - add (optional) `level` parameter to `CompDef`'s `emptyChildInstance()`
     - add `panX`, `panY`, `zoom`, `bgImageUrl` getters to `Topicmap`
     - add `updateTopic()`, `updateAssoc()` to `Topicmap` (part of
       [dmx-topicmap-panel](https://github.com/dmx-systems/dmx-topicmap-panel) protocol)
@@ -46,7 +52,7 @@ library's `init()` function.
 * Utils:
     - add `stripHtml()`
 * Fix:
-    - fixed a bug where nested entities loose their child values while update request
+    - fixed a bug where nested entities loose their child values while update request (thanks to @gevlish)
 
 **2.1** -- Jun 13, 2021
 
@@ -316,4 +322,4 @@ library's `init()` function.
 
 ------------
 Jörg Richter  
-Jun 13, 2021
+Jun 6, 2023

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dmx-api",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "API and utilities for DMX 5 based frontends",
   "author": "Jörg Richter <jri@dmx.berlin>",
   "license": "AGPL-3.0",

package/src/index.js

@@ -6,7 +6,7 @@ import icons        from './icons'
 import DMXWebSocket from './websocket'
 import {default as typeCache, init as initTypeCache, storeModule} from './type-cache'
 
-console.log('[DMX-API] 3.0')
+console.log('[DMX-API] 3.0.1')
 
 let adminWorkspaceId    // promise
 
@@ -42,7 +42,6 @@ export default {
 }
 
 function updateClientIdCookie () {
-  // DEV && console.log('dmx_client_id', clientId)
   utils.setCookie('dmx_client_id', clientId)
 }
 

package/src/websocket.js

@@ -1,5 +1,4 @@
-const IDLE_INTERVAL   = 60 * 1000     // 60s
-const RECONNECT_DELAY =  5 * 1000     // 5s
+const IDLE_INTERVAL = 60 * 1000     // 60s
 
 /**
  * A WebSocket connection to the DMX server.
@@ -48,20 +47,15 @@ export default class DMXWebSocket {
       this.messageHandler(message)
     }
     this.ws.onclose = e => {
-      DEV && console.log('[DMX] Closing WebSocket connection (' + e.reason + '), try reconnect in ' +
-        RECONNECT_DELAY / 1000 + ' seconds')
+      DEV && console.log('[DMX] WebSocket connection closed (' + e.reason + ')')
       this._stopIdling()
-      this._reconnect()
+      this._reload()      // a closed ws connection is regarded an (backend/network) error which requires page reloading
     }
     this.ws.onerror = e => {
       DEV && console.warn('[DMX] WebSocket error')
     }
   }
 
-  _reconnect () {
-    setTimeout(this._connect.bind(this), RECONNECT_DELAY)
-  }
-
   _startIdling () {
     this.idleId = setInterval(this._idle.bind(this), IDLE_INTERVAL)
   }
@@ -74,4 +68,12 @@ export default class DMXWebSocket {
     DEV && console.log('[DMX] WebSocket connection idle')
     this.send({type: 'idle'})
   }
+
+  _reload () {
+    setTimeout(() => {
+      alert('There is a problem with the server or network.\n\nPlease press OK to reload page.\n' +
+        'If it fails try manual page reload.')
+      location.reload()
+    }, 1000)    // timeout to not interfere with interactive page reload (which also closes websocket connection)
+  }
 }