node-red-contrib-room-tools 1.9.1 → 1.9.4

package/control-panel.js

@@ -12,6 +12,7 @@ const { createGateway } = require('./gateway.cjs')
 const { managedBridgeRevision } = require('./managed-bridge-revision')
 const { createMeterRoom, createPanelMeter } = require('./panel-meter')
 const { createXYSeriesRoom, createPanelXYSeries } = require('./panel-xy-series')
+const { createMomentaryControls } = require('./panel-momentary')
 
 let statestore
 const authHandoffKey = crypto.randomBytes(32)
@@ -173,6 +174,13 @@ module.exports = function (RED) {
 
     let gateway
     let gatewayAuthKey
+    async function telemetryTicket (req, res, identity, active) {
+      if (await meter?.ticket(req, res, identity, active)) return true
+      return await xySeries?.ticket(req, res, identity, active) || false
+    }
+    const momentary = createMomentaryControls({ routes,
+      send: (command, identity) => node.send({ ...command, room: identity.room, user: identity.user }),
+      onError: error => node.error(error) })
     if (visualBinding && /^[a-zA-Z0-9_-]+$/.test(boundRoom || '')) {
       try {
         gatewayAuthKey = authSignature([node.id, boundRoom, node.credentials?.username,
@@ -182,15 +190,21 @@ module.exports = function (RED) {
           password: node.credentials?.password,
           room: boundRoom,
           prefix: endpoint,
+          holdEpoch: momentary.epoch,
           secureCookie: config.secureCookie === true,
           restoredSessions: takeSessions(gatewayHandoffs, node.id, gatewayAuthKey),
-          onAuthenticatedRequest: (req, res, identity) => meter?.ticket(req, res, identity,
-            () => gateway?.sessionActive(identity.token)) || xySeries?.ticket(req, res, identity,
-              () => gateway?.sessionActive(identity.token)) || false,
+          onAuthenticatedRequest: (req, res, identity) => telemetryTicket(req, res, identity,
+            () => gateway?.sessionActive(identity.token)),
           onBoundCommand: (message, identity) => {
             if (!bridgeReady) return false
-            node.send({ ...resolveBoundCommand(routes, message), room: identity.room, user: identity.user })
+            if (message?._controlPanel?.hold) return momentary.handle(message, identity)
+            const command = resolveBoundCommand(routes, message)
+            if (routes.get(command.controlId)?.control.buttonBehavior === 'momentary' || momentary.isHeld(command)) {
+              throw Error('A held button requires the momentary protocol')
+            }
+            node.send({ ...command, room: identity.room, user: identity.user })
           },
+          onSessionClosed: token => momentary.releaseSession(token),
           onBoundLogin: identity => {
             if (!boundMode || !bridgeReady) return
             try { node.send({ kind: 'read-all', room: identity.room, user: identity.user }) } catch (error) { node.error(error) }
@@ -215,9 +229,8 @@ module.exports = function (RED) {
         password: node.credentials?.editorPassword,
         secureCookie: config.secureCookie === true,
         restoredSessions: takeSessions(editorHandoffs, node.id, editorAuthKey),
-        onAuthenticatedRequest: (req, res, identity) => meter?.ticket(req, res, identity,
-          () => editor?.sessionActive(identity.token)) || xySeries?.ticket(req, res, identity,
-            () => editor?.sessionActive(identity.token)) || false,
+        onAuthenticatedRequest: (req, res, identity) => telemetryTicket(req, res, identity,
+          () => editor?.sessionActive(identity.token)),
         getConfig: async req => editorConfig(await getSnapshot(req.socket.localPort, fetch,
           RED.settings.httpAdminRoot ?? '/'), node.id),
         getDevices: async () => {
@@ -338,6 +351,7 @@ module.exports = function (RED) {
     registerWidget()
     node.on('close', () => {
       clearTimeout(retryTimer)
+      momentary.close()
       if (gateway) holdSessions(gatewayHandoffs, node.id, gatewayAuthKey, gateway.sessionSnapshot())
       if (editor) holdSessions(editorHandoffs, node.id, editorAuthKey, editor.sessionSnapshot())
       gateway?.close()

package/control-policy.js

@@ -7,6 +7,8 @@ const { createRoomMeterReceiver, createMeterRenderer } = require('./meter-frame'
 const { createPanelMeterClient } = require('./panel-meter-client')
 const { createRoomXYSeriesReceiver, createXYSeriesRenderer } = require('./xy-series-frame')
 const { createPanelXYSeriesClient } = require('./panel-xy-series-client')
+const { attachMomentaryButton } = require('./panel-momentary-client')
+const { attachButtonPress } = require('./panel-button-press')
 
 const CONTROL_POLICY_MARKER = '/* ui-control-panel-control-api-v1 */'
 
@@ -173,6 +175,8 @@ function buildDashboardPolicyOptionsSource (controls = [], boundPanel = null) {
     : ''
   const visualMethods = boundPanel?.visual
     ? `__createTargetMatcher: ${createTargetMatcher.toString()},
+    __attachMomentaryButton: ${attachMomentaryButton.toString()},
+    __attachButtonPress: ${attachButtonPress.toString()},
     __initializeVisualBinding: ${initializeVisualBinding.toString()},
     __disposeVisualBinding: ${disposeVisualBinding.toString()},`
     : ''
@@ -379,7 +383,7 @@ export default {
         this.boundState = {}
         this.boundFeedbackRevision = 0
       }
-      this.__boundPanelSession = { room: session.room, csrf: session.csrf }
+      this.__boundPanelSession = { room: session.room, csrf: session.csrf, holdEpoch: session.holdEpoch }
       this.boundAuthenticated = true
       this.__connectBoundFeedback()
     },

package/control-type-model.js

@@ -1,14 +1,16 @@
 const contract = require('./control-type-contract.json')
 const { meterRoute } = require('./meter-route')
-
-
-
 // Used by both server validation and the injected editor; keep it self-contained.
 function createTargetMatcher (typeContract) {
   const families = {
     range: ['number'], switch: ['boolean'], meter: ['number'], 'xy-series': ['xy-series'],
     'text-display': ['text', 'number', 'enum', 'boolean'], 'text-input': ['text'], select: ['enum']
   }
+  function modes (adapter) {
+    if (!families[adapter]) return []
+    return ['meter', 'xy-series', 'text-display'].includes(adapter)
+      ? ['read'] : ['both', 'write', 'read']
+  }
   function family (target) {
     if (target.xySeries) return 'xy-series'
     if (target.controlSchemaVersion !== typeContract.schemaVersion) return null
@@ -35,10 +37,10 @@ function createTargetMatcher (typeContract) {
     if (candidate.unit && candidate.unit !== target.unit) return false
     return true
   }
-  return { family, compatible }
+  return { family, compatible, modes }
 }
 
-const { family: targetFamily, compatible: compatibleTarget } = createTargetMatcher(contract)
+const { family: targetFamily, compatible: compatibleTarget, modes: bindingModes } = createTargetMatcher(contract)
 
 function controlTypeForAdapter (adapter, target) {
   if (!compatibleTarget(adapter, target, 'read') && !compatibleTarget(adapter, target, 'write')) {
@@ -69,4 +71,4 @@ function targetMeta (target, onebased) {
   }
 }
 
-module.exports = { contract, createTargetMatcher, compatibleTarget, controlTypeForAdapter, targetFamily, targetMeta }
+module.exports = { contract, createTargetMatcher, compatibleTarget, controlTypeForAdapter, targetFamily, targetMeta, bindingModes }

package/gateway.cjs

@@ -10,6 +10,8 @@ function createGateway ({
   onBoundCommand,
   onBoundLogin,
   onAuthenticatedRequest,
+  onSessionClosed,
+  holdEpoch,
   secureCookie = false,
   prefix,
   sessionTtlMs = 8 * 3600000,
@@ -45,15 +47,24 @@ function createGateway ({
   let closed = false
   let heartbeatTimer = null
 
-  function closeSubscriber (subscriber) {
-    subscribers.delete(subscriber)
-    try { subscriber.res.end() } catch (_) {}
+  function closeSubscriber (subscriber, destroy = false) {
+    if (!subscribers.delete(subscriber)) return
+    try { if (destroy) subscriber.res.destroy(); else subscriber.res.end() } catch (_) {}
     if (!subscribers.size && heartbeatTimer) {
       clearInterval(heartbeatTimer)
       heartbeatTimer = null
     }
   }
 
+  function writeSubscriber (subscriber, data) {
+    try {
+      // Allow one queued write to drain, including a large initial snapshot.
+      // A persistently blocked client reconnects to the latest snapshot.
+      if (subscriber.blocked) return closeSubscriber(subscriber, true)
+      if (subscriber.res.write(data) === false) subscriber.blocked = true
+    } catch (_) { closeSubscriber(subscriber, true) }
+  }
+
   function ensureHeartbeat () {
     if (heartbeatTimer || !subscribers.size) return
     heartbeatTimer = setInterval(() => {
@@ -62,26 +73,25 @@ function createGateway ({
         const session = sessions.get(subscriber.token)
         if (!session || session.expiry < now) {
           sessions.delete(subscriber.token)
+          onSessionClosed?.(subscriber.token)
           closeSubscriber(subscriber)
           continue
         }
-        try { subscriber.res.write(': heartbeat\n\n') } catch (_) { closeSubscriber(subscriber) }
+        writeSubscriber(subscriber, ': heartbeat\n\n')
       }
     }, FEEDBACK_HEARTBEAT_MS)
     heartbeatTimer.unref?.()
   }
 
   function sendFeedbackEvent (subscriber, message) {
-    try {
-      subscriber.res.write('data: ' + JSON.stringify(message) + '\n\n')
-    } catch (_) {
-      closeSubscriber(subscriber)
-    }
+    writeSubscriber(subscriber, 'data: ' + JSON.stringify(message) + '\n\n')
   }
 
 
   function broadcastFeedback (message) {
-    for (const subscriber of [...subscribers]) sendFeedbackEvent(subscriber, message)
+    if (!subscribers.size) return
+    const data = 'data: ' + JSON.stringify(message) + '\n\n'
+    for (const subscriber of [...subscribers]) writeSubscriber(subscriber, data)
   }
 
   function closeSubscribersForToken (token) {
@@ -128,6 +138,7 @@ function createGateway ({
       for (const [id, session] of sessions) {
         if (session.expiry < now) {
           sessions.delete(id)
+          onSessionClosed?.(id)
           closeSubscribersForToken(id)
         }
       }
@@ -172,7 +183,7 @@ function createGateway ({
         const token = crypto.randomBytes(32).toString('hex')
         const csrf = crypto.randomBytes(24).toString('hex')
         sessions.set(token, { csrf, expiry: now + sessionTtlMs })
-        reply(res, 200, { room, username, csrf }, {
+        reply(res, 200, { room, username, csrf, ...(holdEpoch ? { holdEpoch } : {}) }, {
           'Set-Cookie': cookie(token, Math.ceil(sessionTtlMs / 1000), req)
         })
         if (typeof onBoundLogin === 'function') {
@@ -197,10 +208,14 @@ function createGateway ({
       if (onAuthenticatedRequest && await onAuthenticatedRequest(req, res,
         { token, expiry: session.expiry, room, user: username })) return true
       if (path === routePrefix + '/session' && req.method === 'GET') {
-        reply(res, 200, { room, username, csrf: session.csrf })
+        reply(res, 200, { room, username, csrf: session.csrf, ...(holdEpoch ? { holdEpoch } : {}) })
         return true
       }
       if (path === routePrefix + '/events' && req.method === 'GET') {
+        if (subscribers.size >= 100) {
+          reply(res, 503, { error: 'Feedback connection limit reached' })
+          return true
+        }
         res.writeHead(200, {
           'Content-Type': 'text/event-stream; charset=utf-8',
           'Cache-Control': 'no-cache, no-transform',
@@ -209,8 +224,9 @@ function createGateway ({
           'X-Content-Type-Options': 'nosniff'
         })
         res.flushHeaders?.()
-        const subscriber = { res, token }
+        const subscriber = { res, token, blocked: false }
         subscribers.add(subscriber)
+        res.on('drain', () => { subscriber.blocked = false })
         res.on('close', () => closeSubscriber(subscriber))
         sendFeedbackEvent(subscriber, boundSnapshot())
         ensureHeartbeat()
@@ -226,6 +242,7 @@ function createGateway ({
       }
       if (path === routePrefix + '/logout' && req.method === 'POST') {
         sessions.delete(token)
+        onSessionClosed?.(token)
         closeSubscribersForToken(token)
         reply(res, 200, { ok: true }, { 'Set-Cookie': cookie('', 0, req) })
         return true
@@ -240,11 +257,12 @@ function createGateway ({
           reply(res, 403, { error: 'Region denied' })
           return true
         }
-        if (await onBoundCommand(data, { room, user: username }) === false) {
+        const result = await onBoundCommand(data, { room, user: username, token, expiry: session.expiry })
+        if (result === false) {
           reply(res, 409, { error: 'Managed bridge is out of sync' })
           return true
         }
-        reply(res, 200, { ok: true })
+        reply(res, 200, { ok: true, ...(typeof result?.held === 'boolean' ? { held: result.held } : {}) })
         return true
       }
 

package/native-binding-plan.js

@@ -222,10 +222,11 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
   }
 
   const commandSwitchId = `${scopeId}-commands`
-  // Meter lanes follow ordinary feedback lanes without overlapping their labels.
+  // Ordinary feedback, Meter, and XY-series each get a separate vertical band.
   for (const node of nodes) {
     if (node.id.startsWith(`${scopeId}-meter-`) || node.id.startsWith(`${scopeId}-xy-series-`)) {
       node.y += readTargets.size * 170
+      if (node.id.startsWith(`${scopeId}-xy-series-`)) node.y += meterStreams.size * 280
     }
   }
   const routerId = `${scopeId}-router`
@@ -256,7 +257,8 @@ function compileNativeBindingPlan ({ panel, targets, scopeId }) {
     category: 'panel binding',
     in: [{ x: 170, y: 150, wires: [{ id: routerId }] }],
     out: readTargets.size || meterStreams.size || xySeriesStreams.size
-      ? [{ x: meterStreams.size ? 1600 : 1290, y: Math.round((390 + (readTargets.size + meterStreams.size + 1) * 85) / 10) * 10,
+      ? [{ x: meterStreams.size || xySeriesStreams.size ? 1600 : 1290,
+        y: Math.round((390 + (readTargets.size + meterStreams.size + xySeriesStreams.size + 1) * 85) / 10) * 10,
         wires: [...readTargets.values()].map(target => ({ id: target.tagId, port: 0 }))
           .concat([...meterStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 }))))
           .concat([...xySeriesStreams.values()].flatMap(target => target.tagIds.map(id => ({ id, port: 0 })))) }]

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "node-red-contrib-room-tools",
-  "version": "1.9.1",
+  "version": "1.9.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "node-red-contrib-room-tools",
-      "version": "1.9.1",
+      "version": "1.9.4",
       "license": "UNLICENSED",
       "dependencies": {
         "@vue/compiler-sfc": "3.5.42",

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "node-red-contrib-room-tools",
-  "version": "1.9.1",
+  "version": "1.9.4",
   "description": "Authenticated visual control panel binding for Node-RED and MUSE Automator",
   "license": "UNLICENSED",
+  "scripts": {
+    "test": "node --test test-*.cjs"
+  },
   "engines": {
     "node": ">=18.16.0"
   },
@@ -26,6 +29,7 @@
     "meter-route.js",
     "meter-frame.js",
     "panel-meter.js",
+    "panel-telemetry-send.js",
     "panel-meter-client.js",
     "xy-series-route.js",
     "xy-series-frame.js",
@@ -38,6 +42,9 @@
     "panel-http.js",
     "panel-flow-editor-sync.js",
     "panel-binding-editor.js",
+    "panel-momentary.js",
+    "panel-momentary-client.js",
+    "panel-button-press.js",
     "native-binding-plan.js",
     "managed-native-bridge.js",
     "managed-bridge-revision.js",