node-red-contrib-room-tools 1.8.4 → 1.8.8

package/control-policy.js

@@ -1,50 +1,11 @@
 const acorn = require('acorn')
 const escodegen = require('escodegen')
 const { initializeVisualBinding, disposeVisualBinding } = require('./panel-binding-editor')
+const { fetchWithTimeout } = require('./panel-http')
+const { createTargetMatcher } = require('./control-type-model')
 
 const CONTROL_POLICY_MARKER = '/* ui-control-panel-control-api-v1 */'
-const FEEDBACK_TOPIC_FIELDS = Object.freeze({
-  'display/power': 'display',
-  'display/source': 'source',
-  'audio/volume': 'volume',
-  'audio/mute': 'muted',
-  'lighting/brightness': 'light',
-  'room/curtain': 'curtains',
-  'climate/temperature': 'temperature',
-  'room/scene': 'scene',
-  'room/meeting': 'meeting'
-})
 
-function normalizeControlFeedback (message, expectedRoom, topicFields) {
-  if (!message || typeof message !== 'object' || Array.isArray(message)) {
-    throw new Error('Control feedback must be an object')
-  }
-  if (message.kind !== 'state') throw new Error('Control feedback must have kind=state')
-  if (expectedRoom && message.room !== expectedRoom) throw new Error('Control feedback room mismatch')
-  if (typeof message.topic !== 'string' || !message.topic) throw new Error('Control feedback needs a topic')
-
-  let state = message.state && typeof message.state === 'object' && !Array.isArray(message.state)
-    ? { ...message.state }
-    : {}
-  if (message.topic === 'room/state') {
-    if (!message.payload || typeof message.payload !== 'object' || Array.isArray(message.payload)) {
-      throw new Error('room/state feedback needs an object payload')
-    }
-    state = { ...state, ...message.payload }
-  } else if (topicFields[message.topic]) {
-    state[topicFields[message.topic]] = message.payload
-  }
-
-  return {
-    room: message.room,
-    kind: 'state',
-    topic: message.topic,
-    payload: message.payload,
-    state,
-    revision: Number.isInteger(message.revision) && message.revision >= 0 ? message.revision : null,
-    controlKey: typeof message.controlKey === 'string' ? message.controlKey : null
-  }
-}
 
 function createControlPanelPolicy ({
   dispatch,
@@ -189,226 +150,6 @@ function createControlPanelPolicy ({
   }
 }
 
-function buildControlPolicyMixinSource () {
-  return `
-${CONTROL_POLICY_MARKER}
-const __controlPanelCreatePolicy = ${createControlPanelPolicy.toString()}
-const __controlPanelFeedbackFields = ${JSON.stringify(FEEDBACK_TOPIC_FIELDS)}
-const __controlPanelNormalizeFeedback = ${normalizeControlFeedback.toString()}
-const __controlPanelPolicyMixin = {
-  data () {
-    return {
-      deviceState: {},
-      deviceFeedbackRevision: 0,
-      deviceFeedbackConnected: false,
-      controlPending: {},
-      controlTargets: {}
-    }
-  },
-  created () {
-    this.__controlPanelSession = null
-    this.__controlPanelFeedbackSource = null
-    this.__controlPanelRequests = new Map()
-    this.__resetControlPolicy()
-  },
-  methods: {
-    __resetControlPolicy () {
-      this.__controlPanelPolicy?.dispose()
-      this.__controlPanelPolicy = __controlPanelCreatePolicy({
-        intervalMs: 40,
-        dispatch: (command) => this.__dispatchControl(command),
-        onError: (error, command) => {
-          if (command?.controlKey) this.__clearControlPending(command.controlKey)
-          if (typeof this.onControlError === 'function') this.onControlError(error, command)
-          else console.error('ControlPanel command failed', error)
-        }
-      })
-    },
-    __setControlPending (key, pending) {
-      const next = { ...this.controlPending }
-      if (pending) next[key] = true
-      else delete next[key]
-      this.controlPending = next
-    },
-    __setControlTarget (key, value) {
-      this.controlTargets = { ...this.controlTargets, [key]: value }
-    },
-    __clearControlPending (key) {
-      this.__controlPanelRequests.delete(String(key))
-      this.__setControlPending(String(key), false)
-      const targets = { ...this.controlTargets }
-      delete targets[String(key)]
-      this.controlTargets = targets
-    },
-    __setFeedbackConnected (connected) {
-      const next = connected === true
-      if (this.deviceFeedbackConnected === next) return
-      this.deviceFeedbackConnected = next
-      if (typeof this.onControlFeedbackStatus === 'function') this.onControlFeedbackStatus(next)
-    },
-    __closeControlFeedback () {
-      this.__controlPanelFeedbackSource?.close()
-      this.__controlPanelFeedbackSource = null
-      this.__setFeedbackConnected(false)
-    },
-    __connectControlFeedback () {
-      this.__closeControlFeedback()
-      const session = this.__controlPanelSession
-      if (!session || typeof EventSource === 'undefined') return
-      const source = new EventSource('/room-panel-api/regions/' + encodeURIComponent(session.room) + '/events')
-      this.__controlPanelFeedbackSource = source
-      source.onopen = () => {
-        if (this.__controlPanelFeedbackSource === source) this.__setFeedbackConnected(true)
-      }
-      source.onmessage = (event) => {
-        if (this.__controlPanelFeedbackSource !== source) return
-        try {
-          this.applyControlFeedback(JSON.parse(event.data))
-        } catch (error) {
-          if (typeof this.onControlError === 'function') this.onControlError(error)
-          else console.error('ControlPanel feedback failed', error)
-        }
-      }
-      source.onerror = () => {
-        if (this.__controlPanelFeedbackSource === source) this.__setFeedbackConnected(false)
-      }
-    },
-    __acknowledgeControlFeedback (feedback) {
-      for (const [key, request] of this.__controlPanelRequests) {
-        let matched = request.topic === 'room/reset'
-        let value
-        if (!matched && feedback.topic === request.topic) {
-          matched = true
-          value = feedback.payload
-        } else if (!matched && feedback.topic === 'room/state') {
-          const field = __controlPanelFeedbackFields[request.topic]
-          if (field && Object.prototype.hasOwnProperty.call(feedback.state, field)) {
-            matched = true
-            value = feedback.state[field]
-          }
-        }
-        if (!matched) continue
-
-        const sameTopicRequests = [...this.__controlPanelRequests.values()]
-          .filter(candidate => candidate.topic === request.topic).length
-        const correlated = !feedback.controlKey || feedback.controlKey === key || sameTopicRequests === 1
-        if (!correlated) continue
-
-        const continuous = ['level', 'dimmer', 'position'].includes(request.type)
-        if (!continuous || request.topic === 'room/reset' || Object.is(value, request.value)) {
-          this.__clearControlPending(key)
-        }
-      }
-    },
-    setControlSession (session) {
-      if (!session || typeof session !== 'object' || !session.room || !session.csrf) {
-        throw new Error('ControlPanel session needs room and csrf')
-      }
-      const next = { room: String(session.room), csrf: String(session.csrf) }
-      if (this.__controlPanelSession &&
-        (this.__controlPanelSession.room !== next.room || this.__controlPanelSession.csrf !== next.csrf)) {
-        this.__resetControlPolicy()
-        this.__controlPanelRequests.clear()
-        this.controlPending = {}
-        this.controlTargets = {}
-        this.deviceState = {}
-        this.deviceFeedbackRevision = 0
-      }
-      this.__controlPanelSession = next
-      this.__connectControlFeedback()
-    },
-    clearControlSession () {
-      this.__closeControlFeedback()
-      this.__controlPanelSession = null
-      this.__resetControlPolicy()
-      this.__controlPanelRequests.clear()
-      this.controlPending = {}
-      this.controlTargets = {}
-      this.deviceState = {}
-      this.deviceFeedbackRevision = 0
-    },
-    sendControl (command) {
-      const key = String(command?.key ?? command?.controlKey ?? '')
-      const type = String(command?.type ?? command?.controlType ?? '').toLowerCase()
-      const value = Object.prototype.hasOwnProperty.call(command || {}, 'value') ? command.value : command?.payload
-      if (key) {
-        this.__controlPanelRequests.set(key, {
-          topic: String(command.topic ?? ''),
-          type,
-          value
-        })
-        this.__setControlPending(key, true)
-        if (['level', 'dimmer', 'position'].includes(type)) this.__setControlTarget(key, value)
-      }
-      try {
-        return this.__controlPanelPolicy.send(command)
-      } catch (error) {
-        if (key) this.__clearControlPending(key)
-        throw error
-      }
-    },
-    flushControl (key) {
-      return this.__controlPanelPolicy.flush(key)
-    },
-    applyControlFeedback (message) {
-      const room = this.__controlPanelSession?.room || this.authorizedRoom
-      const feedback = __controlPanelNormalizeFeedback(message, room, __controlPanelFeedbackFields)
-      this.deviceState = { ...this.deviceState, ...feedback.state }
-      if (feedback.revision !== null) this.deviceFeedbackRevision = feedback.revision
-      this.__acknowledgeControlFeedback(feedback)
-      if (typeof this.onDeviceFeedback === 'function') this.onDeviceFeedback(feedback, this.deviceState)
-      return feedback
-    },
-    hasDeviceState (field) {
-      return Object.prototype.hasOwnProperty.call(this.deviceState, String(field))
-    },
-    deviceValue (field, fallback = null) {
-      return this.hasDeviceState(field) ? this.deviceState[String(field)] : fallback
-    },
-    isControlPending (key) {
-      return this.controlPending[String(key)] === true
-    },
-    controlDisplayValue (key, field, fallback = null) {
-      const controlKey = String(key)
-      if (this.isControlPending(controlKey) &&
-        Object.prototype.hasOwnProperty.call(this.controlTargets, controlKey)) {
-        return this.controlTargets[controlKey]
-      }
-      return this.deviceValue(field, fallback)
-    },
-    async __dispatchControl (command) {
-      if (typeof this.controlTransport === 'function') return this.controlTransport(command)
-
-      const session = this.__controlPanelSession
-      const room = session?.room || this.authorizedRoom
-      if (typeof this.postControl === 'function') {
-        return this.postControl(room ? { ...command, room } : command, this.sessionGeneration)
-      }
-      if (!session) throw new Error('Call setControlSession() after login, or define controlTransport(command)')
-
-      const response = await fetch('/room-panel-api/regions/' + encodeURIComponent(session.room) + '/command', {
-        method: 'POST',
-        credentials: 'same-origin',
-        headers: { 'Content-Type': 'application/json', 'X-Room-CSRF': session.csrf },
-        body: JSON.stringify({ room: session.room, ...command }),
-        signal: AbortSignal.timeout(8000)
-      })
-      if (!response.ok) throw new Error('Control command failed (' + response.status + ')')
-      return response
-    }
-  },
-  unmounted () {
-    this.__closeControlFeedback()
-    this.__controlPanelPolicy?.dispose()
-    this.__controlPanelPolicy = null
-    this.__controlPanelRequests?.clear()
-    this.controlPending = {}
-    this.controlTargets = {}
-    this.__controlPanelSession = null
-  }
-}
-`
-}
 
 // Dashboard 2.0 1.31 parses ui-template scripts itself. It only treats a script
 // as component options when the script contains one `export default { ... }`
@@ -417,7 +158,8 @@ const __controlPanelPolicyMixin = {
 function buildDashboardPolicyOptionsSource (controls = [], boundPanel = null) {
   const boundControls = controls.map(({ id, type, mode }) => ({ id, type, mode }))
   const visualMethods = boundPanel?.visual
-    ? `__initializeVisualBinding: ${initializeVisualBinding.toString()},
+    ? `__createTargetMatcher: ${createTargetMatcher.toString()},
+    __initializeVisualBinding: ${initializeVisualBinding.toString()},
     __disposeVisualBinding: ${disposeVisualBinding.toString()},`
     : ''
   const visualMounted = boundPanel?.visual
@@ -435,15 +177,11 @@ export default {
       boundFeedbackRevision: 0,
       boundFeedbackConnected: false,
       boundAuthenticated: false,
-      deviceState: {},
-      deviceFeedbackRevision: 0,
-      deviceFeedbackConnected: false,
-      controlPending: {},
-      controlTargets: {}
     }
   },
   methods: {
     ${visualMethods}
+    __panelFetch: ${fetchWithTimeout.toString()},
     __boundPanelConfig () {
       return ${JSON.stringify(boundPanel)}
     },
@@ -555,14 +293,7 @@ export default {
       }
     },
     __controlPanelCreatePolicy: ${createControlPanelPolicy.toString()},
-    __controlPanelNormalizeFeedback: ${normalizeControlFeedback.toString()},
-    __controlPanelFeedbackFields () {
-      return ${JSON.stringify(FEEDBACK_TOPIC_FIELDS)}
-    },
     __initializeControlPanelPolicy () {
-      this.__controlPanelSession = null
-      this.__controlPanelFeedbackSource = null
-      this.__controlPanelRequests = new Map()
       this.__boundPanelSession = null
       this.__boundPanelSource = null
       this.__boundAuthGeneration = 0
@@ -576,14 +307,9 @@ export default {
       this.__boundUnwatch?.()
       this.__boundUnwatch = null
       this.__clearAllBoundSettlements()
-      this.__closeControlFeedback()
       this.__closeBoundFeedback()
       this.__controlPanelPolicy?.dispose()
       this.__controlPanelPolicy = null
-      this.__controlPanelRequests?.clear()
-      this.controlPending = {}
-      this.controlTargets = {}
-      this.__controlPanelSession = null
       this.__boundPanelSession = null
     },
     __resetControlPolicy () {
@@ -595,116 +321,11 @@ export default {
           if (command?.topic === '__bound' && command.controlKey) {
             this.__clearBoundPending(command.controlKey)
           }
-          if (command?.controlKey) this.__clearControlPending(command.controlKey)
           if (typeof this.onControlError === 'function') this.onControlError(error, command)
           else console.error('ControlPanel command failed', error)
         }
       })
     },
-    __setControlPending (key, pending) {
-      const next = { ...this.controlPending }
-      if (pending) next[key] = true
-      else delete next[key]
-      this.controlPending = next
-    },
-    __setControlTarget (key, value) {
-      this.controlTargets = { ...this.controlTargets, [key]: value }
-    },
-    __clearControlPending (key) {
-      this.__controlPanelRequests.delete(String(key))
-      this.__setControlPending(String(key), false)
-      const targets = { ...this.controlTargets }
-      delete targets[String(key)]
-      this.controlTargets = targets
-    },
-    __setFeedbackConnected (connected) {
-      const next = connected === true
-      if (this.deviceFeedbackConnected === next) return
-      this.deviceFeedbackConnected = next
-      if (typeof this.onControlFeedbackStatus === 'function') this.onControlFeedbackStatus(next)
-    },
-    __closeControlFeedback () {
-      this.__controlPanelFeedbackSource?.close()
-      this.__controlPanelFeedbackSource = null
-      this.__setFeedbackConnected(false)
-    },
-    __connectControlFeedback () {
-      this.__closeControlFeedback()
-      const session = this.__controlPanelSession
-      if (!session || typeof EventSource === 'undefined') return
-      const source = new EventSource('/room-panel-api/regions/' + encodeURIComponent(session.room) + '/events')
-      this.__controlPanelFeedbackSource = source
-      source.onopen = () => {
-        if (this.__controlPanelFeedbackSource === source) this.__setFeedbackConnected(true)
-      }
-      source.onmessage = (event) => {
-        if (this.__controlPanelFeedbackSource !== source) return
-        try {
-          this.applyControlFeedback(JSON.parse(event.data))
-        } catch (error) {
-          if (typeof this.onControlError === 'function') this.onControlError(error)
-          else console.error('ControlPanel feedback failed', error)
-        }
-      }
-      source.onerror = () => {
-        if (this.__controlPanelFeedbackSource === source) this.__setFeedbackConnected(false)
-      }
-    },
-    __acknowledgeControlFeedback (feedback) {
-      const feedbackFields = this.__controlPanelFeedbackFields()
-      for (const [key, request] of this.__controlPanelRequests) {
-        let matched = request.topic === 'room/reset'
-        let value
-        if (!matched && feedback.topic === request.topic) {
-          matched = true
-          value = feedback.payload
-        } else if (!matched && feedback.topic === 'room/state') {
-          const field = feedbackFields[request.topic]
-          if (field && Object.prototype.hasOwnProperty.call(feedback.state, field)) {
-            matched = true
-            value = feedback.state[field]
-          }
-        }
-        if (!matched) continue
-
-        const sameTopicRequests = [...this.__controlPanelRequests.values()]
-          .filter(candidate => candidate.topic === request.topic).length
-        const correlated = !feedback.controlKey || feedback.controlKey === key || sameTopicRequests === 1
-        if (!correlated) continue
-
-        const continuous = ['level', 'dimmer', 'position'].includes(request.type)
-        if (!continuous || request.topic === 'room/reset' || Object.is(value, request.value)) {
-          this.__clearControlPending(key)
-        }
-      }
-    },
-    setControlSession (session) {
-      if (!session || typeof session !== 'object' || !session.room || !session.csrf) {
-        throw new Error('ControlPanel session needs room and csrf')
-      }
-      const next = { room: String(session.room), csrf: String(session.csrf) }
-      if (this.__controlPanelSession &&
-        (this.__controlPanelSession.room !== next.room || this.__controlPanelSession.csrf !== next.csrf)) {
-        this.__resetControlPolicy()
-        this.__controlPanelRequests.clear()
-        this.controlPending = {}
-        this.controlTargets = {}
-        this.deviceState = {}
-        this.deviceFeedbackRevision = 0
-      }
-      this.__controlPanelSession = next
-      this.__connectControlFeedback()
-    },
-    clearControlSession () {
-      this.__closeControlFeedback()
-      this.__controlPanelSession = null
-      this.__resetControlPolicy()
-      this.__controlPanelRequests.clear()
-      this.controlPending = {}
-      this.controlTargets = {}
-      this.deviceState = {}
-      this.deviceFeedbackRevision = 0
-    },
     __closeBoundFeedback () {
       this.__boundPanelSource?.close()
       this.__boundPanelSource = null
@@ -760,7 +381,7 @@ export default {
       if (!config) throw new Error('This panel has no bound login endpoint')
       this.clearBoundPanelSession()
       const generation = this.__boundAuthGeneration
-      const response = await fetch(config.endpoint + '/login', {
+      const response = await this.__panelFetch(config.endpoint + '/login', {
         method: 'POST', credentials: 'same-origin',
         headers: { 'Content-Type': 'application/json' },
         body: JSON.stringify({ username, password })
@@ -775,7 +396,7 @@ export default {
       const config = this.__boundPanelConfig()
       if (!config) return null
       const generation = this.__boundAuthGeneration
-      const response = await fetch(config.endpoint + '/session', { credentials: 'same-origin' })
+      const response = await this.__panelFetch(config.endpoint + '/session', { credentials: 'same-origin' })
       if (generation !== this.__boundAuthGeneration) return this.__boundPanelSession
       if (!response.ok) {
         this.clearBoundPanelSession()
@@ -791,106 +412,46 @@ export default {
       const session = this.__boundPanelSession
       this.clearBoundPanelSession()
       if (!config || !session) return
-      const response = await fetch(config.endpoint + '/logout', {
+      const response = await this.__panelFetch(config.endpoint + '/logout', {
         method: 'POST', credentials: 'same-origin',
         headers: { 'Content-Type': 'application/json', 'X-Room-CSRF': session.csrf },
         body: '{}'
       })
       if (!response.ok) throw new Error('Panel logout failed (' + response.status + ')')
     },
-    sendControl (command) {
-      if (command && Object.prototype.hasOwnProperty.call(command, 'id')) {
-        return this.sendBoundControl(command)
-      }
-      const key = String(command?.key ?? command?.controlKey ?? '')
-      const type = String(command?.type ?? command?.controlType ?? '').toLowerCase()
-      const value = Object.prototype.hasOwnProperty.call(command || {}, 'value') ? command.value : command?.payload
-      if (key) {
-        this.__controlPanelRequests.set(key, {
-          topic: String(command.topic ?? ''),
-          type,
-          value
-        })
-        this.__setControlPending(key, true)
-        if (['level', 'dimmer', 'position'].includes(type)) this.__setControlTarget(key, value)
-      }
-      try {
-        return this.__controlPanelPolicy.send(command)
-      } catch (error) {
-        if (key) this.__clearControlPending(key)
-        throw error
-      }
-    },
     flushControl (key) {
       return this.__controlPanelPolicy.flush(key)
     },
-    applyControlFeedback (message) {
-      const room = this.__controlPanelSession?.room || this.authorizedRoom
-      const feedback = this.__controlPanelNormalizeFeedback(
-        message,
-        room,
-        this.__controlPanelFeedbackFields()
-      )
-      this.deviceState = { ...this.deviceState, ...feedback.state }
-      if (feedback.revision !== null) this.deviceFeedbackRevision = feedback.revision
-      this.__acknowledgeControlFeedback(feedback)
-      if (typeof this.onDeviceFeedback === 'function') this.onDeviceFeedback(feedback, this.deviceState)
-      return feedback
-    },
-    hasDeviceState (field) {
-      return Object.prototype.hasOwnProperty.call(this.deviceState, String(field))
-    },
-    deviceValue (field, fallback = null) {
-      return this.hasDeviceState(field) ? this.deviceState[String(field)] : fallback
-    },
-    isControlPending (key) {
-      return this.controlPending[String(key)] === true
-    },
-    controlDisplayValue (key, field, fallback = null) {
-      const controlKey = String(key)
-      if (this.isControlPending(controlKey) &&
-        Object.prototype.hasOwnProperty.call(this.controlTargets, controlKey)) {
-        return this.controlTargets[controlKey]
-      }
-      return this.deviceValue(field, fallback)
-    },
-    async __dispatchControl (command) {
-      if (command.topic === '__bound') {
-        const config = this.__boundPanelConfig()
-        const session = this.__boundPanelSession
-        if (!config || !session) throw new Error('Bound panel login required')
-        const response = await fetch(config.endpoint + '/bound-command', {
-          method: 'POST', credentials: 'same-origin',
-          headers: { 'Content-Type': 'application/json', 'X-Room-CSRF': session.csrf },
-          body: JSON.stringify({ room: session.room, _controlPanel: {
-            kind: 'command', id: command.controlKey, value: command.payload, final: command.final
-          } }),
-          signal: AbortSignal.timeout(8000)
-        })
-        if (!response.ok) {
-          if (response.status === 401) this.clearBoundPanelSession()
-          throw new Error('Bound command failed (' + response.status + ')')
-        }
-        return response
-      }
-      if (typeof this.controlTransport === 'function') return this.controlTransport(command)
-
-      const session = this.__controlPanelSession
-      const room = session?.room || this.authorizedRoom
-      if (typeof this.postControl === 'function') {
-        return this.postControl(room ? { ...command, room } : command, this.sessionGeneration)
-      }
-      if (!session) throw new Error('Call setControlSession() after login, or define controlTransport(command)')
-
-      const response = await fetch('/room-panel-api/regions/' + encodeURIComponent(session.room) + '/command', {
+    async __dispatchControl(command) {
+      if (command.topic !== '__bound')
+        throw new Error('Unsupported control command');
+      const config = this.__boundPanelConfig();
+      const session = this.__boundPanelSession;
+      if (!config || !session)
+        throw new Error('Bound panel login required');
+      const response = await this.__panelFetch(config.endpoint + '/bound-command', {
         method: 'POST',
         credentials: 'same-origin',
-        headers: { 'Content-Type': 'application/json', 'X-Room-CSRF': session.csrf },
-        body: JSON.stringify({ room: session.room, ...command }),
-        signal: AbortSignal.timeout(8000)
-      })
-      if (!response.ok) throw new Error('Control command failed (' + response.status + ')')
-      return response
+        headers: {
+          'Content-Type': 'application/json',
+          'X-Room-CSRF': session.csrf
+        },
+        body: JSON.stringify({
+          room: session.room,
+          _controlPanel: {
+            kind: 'command',
+            id: command.controlKey,
+            value: command.payload,
+            final: command.final
+          }
+        }),
+      }, 8000);
+      if (!response.ok) {
+        if (response.status === 401)
+          this.clearBoundPanelSession();
+        throw new Error('Bound command failed (' + response.status + ')');
+      }
+      return response;
     }
   },
   mounted () {
@@ -1026,11 +587,8 @@ function injectControlPolicy (format, controls = [], boundPanel = null) {
 
 module.exports = {
   CONTROL_POLICY_MARKER,
-  FEEDBACK_TOPIC_FIELDS,
-  buildControlPolicyMixinSource,
   buildDashboardPolicyOptionsSource,
   createControlPanelPolicy,
   injectControlPolicy,
   mergeDashboardOptions,
-  normalizeControlFeedback
 }