@flowfuse/nr-project-nodes - npm Package Compare versions

Comparing version 0.7.3-e8ae1f8-202409021242.0 to 0.7.3

CHANGELOG.md

@@ -0,1 +1,6 @@
+### 0.7.3
+
+ - Ensure all pub/sub MQTT operations use QoS 2 (#99) @Steve-Mcl
+ - Bump flowfuse/github-actions-workflows from 0.1.0 to 0.28.0 (#97) @dependabot
+
 ### 0.7.2
@@ -2,0 +7,0 @@

nodes/project-link.js

@@ -454,3 +454,3 @@ module.exports = function (RED) {
                 const subOptions = Object.assign({}, options)
-                subOptions.qos = subOptions.qos == null ? 1 : subOptions.qos
+                subOptions.qos = subOptions.qos == null ? 2 : subOptions.qos
                 subOptions.properties = Object.assign({}, options.properties)
@@ -528,3 +528,3 @@ subOptions.properties.userProperties = subOptions.properties.userProperties || {}
                 const pubOptions = Object.assign({}, options)
-                pubOptions.qos = pubOptions.qos == null ? 1 : pubOptions.qos
+                pubOptions.qos = pubOptions.qos == null ? 2 : pubOptions.qos
                 pubOptions.properties = Object.assign({}, options.properties)
@@ -531,0 +531,0 @@ pubOptions.properties.userProperties = pubOptions.properties.userProperties || {}

package.json

 {
     "name": "@flowfuse/nr-project-nodes",
-    "version": "0.7.3-e8ae1f8-202409021242.0",
+    "version": "0.7.3",
     "description": "A collection of Node-RED nodes for easy communication between Node-RED instances running in the FlowFuse platform",
@@ -5,0 +5,0 @@ "scripts": {

test/unit/nodes/project-link_spec.js

@@ -10,2 +10,4 @@ const should = require('should') // eslint-disable-line no-unused-vars
 
+const TEAM_ID = 'ABCD5678'
+const PROJECT_ID = '1234-5678-9012-9876abcdef12'
 describe('project-link node', function () {
@@ -18,67 +20,77 @@ afterEach(function () {
 
-    describe('proxy', function () {
-        function setup (httpProxy, httpsProxy, allProxy, noProxy, forgeUrl, mqttUrl) {
-            const mqttConnectStub = sinon.stub(MQTT, 'connect').returns({
-                on: sinon.fake(),
-                subscribe: sinon.fake(),
-                unsubscribe: sinon.fake(),
-                publish: sinon.fake(),
-                removeAllListeners: sinon.fake(),
-                end: sinon.fake()
-            })
-            process.env.http_proxy = httpProxy || ''
-            process.env.https_proxy = httpsProxy || ''
-            process.env.all_proxy = allProxy || ''
-            process.env.no_proxy = noProxy || ''
-            const nodes = {}
-            const RED = {
-                settings: {
-                    flowforge: {
-                        forgeURL: forgeUrl || 'https://local.testfuse.com',
-                        projectID: '1234',
-                        teamID: '5678',
-                        projectLink: {
-                            featureEnabled: true,
-                            broker: {
-                                url: mqttUrl || 'ws://localhost',
-                                clientId: 'nr-project-link'
-                            }
+    function setup (httpProxy, httpsProxy, allProxy, noProxy, forgeUrl, mqttUrl) {
+        const mqttStub = {
+            on: sinon.fake(),
+            subscribe: sinon.fake(),
+            unsubscribe: sinon.fake(),
+            publish: sinon.fake(function (topic, message, options, callback) {
+                const pkt = { topic, message, options }
+                callback(null, pkt)
+            }),
+            removeAllListeners: sinon.fake(),
+            end: sinon.fake()
+        }
+        const mqttConnectStub = sinon.stub(MQTT, 'connect').returns(mqttStub)
+        process.env.http_proxy = httpProxy || ''
+        process.env.https_proxy = httpsProxy || ''
+        process.env.all_proxy = allProxy || ''
+        process.env.no_proxy = noProxy || ''
+        const nodes = {}
+        const RED = {
+            settings: {
+                flowforge: {
+                    forgeURL: forgeUrl || 'https://local.testfuse.com',
+                    projectID: PROJECT_ID,
+                    teamID: TEAM_ID,
+                    projectLink: {
+                        featureEnabled: true,
+                        broker: {
+                            url: mqttUrl || 'ws://localhost',
+                            clientId: 'nr-project-link'
                         }
                     }
+                }
+            },
+            log: {
+                error: sinon.fake(() => { console.error(...arguments) }),
+                debug: sinon.fake(() => { console.debug(...arguments) }),
+                log: sinon.fake(() => { console.log(...arguments) }),
+                warn: sinon.fake(() => { console.warn(...arguments) }),
+                info: sinon.fake(() => { console.info(...arguments) }),
+                trace: sinon.fake(() => { console.trace(...arguments) })
+            },
+            nodes: {
+                createNode: function (node, config) {
+                    return node
                 },
-                log: {
-                    error: sinon.fake(() => { console.error(...arguments) }),
-                    debug: sinon.fake(() => { console.debug(...arguments) }),
-                    log: sinon.fake(() => { console.log(...arguments) }),
-                    warn: sinon.fake(() => { console.warn(...arguments) }),
-                    info: sinon.fake(() => { console.info(...arguments) }),
-                    trace: sinon.fake(() => { console.trace(...arguments) })
-                },
-                nodes: {
-                    createNode: function (node, config) {
-                        return node
-                    },
-                    // RED.nodes.registerType('project link in', ProjectLinkInNode, {
-                    registerType: sinon.fake((name, NodeConstructor, options) => {
-                        nodes[name] = {
-                            name,
-                            NodeConstructor,
-                            options
-                        }
-                    })
-                },
-                httpAdmin: {
-                    get: sinon.stub()
-                },
-                auth: {
-                    needsPermission: sinon.stub()
+                // RED.nodes.registerType('project link in', ProjectLinkInNode, {
+                registerType: sinon.fake((name, NodeConstructor, options) => {
+                    nodes[name] = {
+                        name,
+                        NodeConstructor,
+                        options
+                    }
+                })
+            },
+            httpAdmin: {
+                get: sinon.stub()
+            },
+            auth: {
+                needsPermission: sinon.stub()
+            },
+            util: {
+                cloneMessage (msg) {
+                    return JSON.parse(JSON.stringify(msg))
                 }
             }
-            return {
-                RED,
-                nodes,
-                mqttConnectStub
-            }
         }
+        return {
+            RED,
+            nodes,
+            mqttStub,
+            mqttConnectStub
+        }
+    }
 
+    describe('proxy', function () {
         afterEach(function () {
@@ -260,2 +272,116 @@ sinon.restore()
     })
+    describe('Nodes', function () {
+        it('project link in should subscribe using QoS 2', function () {
+            const env = setup()
+            const inNode = {
+                on: sinon.fake(),
+                type: 'project link in'
+            }
+            const topic = 'cloud/project-nodes-test/xxx'
+            const RED = env.RED
+            projectLinkPackage(RED)
+            const NodeConstructor = env.nodes['project link in'].NodeConstructor
+            NodeConstructor.call(inNode, { topic, project: PROJECT_ID })
+
+            env.mqttStub.subscribe.calledOnce.should.be.true()
+            should(env.mqttStub.subscribe.args[0][0]).equal(`ff/v1/${TEAM_ID}/p/${PROJECT_ID}/in/${topic}`)
+            const options = env.mqttStub.subscribe.args[0][1]
+            should(options).be.an.Object()
+            options.should.have.property('qos').and.equal(2)
+            options.should.have.property('properties').and.be.an.Object()
+            options.properties.should.have.property('subscriptionIdentifier').and.be.a.Number()
+        })
+        it('project link call should publish and subscribe using QoS 2', async function () {
+            const env = setup()
+            const RED = env.RED
+            const nodeEvents = {}
+            const callNode = {
+                on: (event, cb) => {
+                    nodeEvents[event] = cb
+                },
+                error: sinon.fake(),
+                type: 'project link call'
+            }
+            const topic = 'cloud/project-nodes-test/call'
+            const expectedPubTopic = `ff/v1/${TEAM_ID}/p/${PROJECT_ID}/in/${topic}`
+            const expectedSubTopic = `ff/v1/${TEAM_ID}/p/${PROJECT_ID}/res/${topic}`
+            projectLinkPackage(RED)
+            const NodeConstructor = env.nodes['project link call'].NodeConstructor
+            NodeConstructor.call(callNode, { topic, project: PROJECT_ID })
+            callNode.should.have.property('topic', expectedPubTopic)
+            callNode.should.have.property('responseTopic', expectedSubTopic)
+            env.mqttStub.subscribe.calledOnce.should.be.true()
+            should(env.mqttStub.subscribe.args[0][0]).equal(expectedSubTopic)
+            const options = env.mqttStub.subscribe.args[0][1]
+            should(options).be.an.Object()
+            options.should.have.property('qos').and.equal(2)
+
+            // send a message to the node so that it can publish
+            await nodeEvents.input({ payload: 'test' }, sinon.fake(), sinon.fake())
+
+            // ensure qos 2 on the publish
+            env.mqttStub.publish.calledOnce.should.be.true()
+            const pubTopic = env.mqttStub.publish.args[0][0]
+            should(pubTopic).equal(expectedPubTopic)
+            const pubMessageStr = env.mqttStub.publish.args[0][1]
+            const pubMessage = JSON.parse(pubMessageStr)
+            should(pubMessage).be.an.Object()
+            pubMessage.should.have.property('payload').and.equal('test')
+            pubMessage.should.have.property('projectLink').and.be.an.Object()
+            pubMessage.projectLink.should.have.property('callStack').and.be.an.Array()
+            pubMessage.projectLink.callStack.should.have.length(1)
+            pubMessage.projectLink.callStack[0].should.have.property('topic').and.equal(topic)
+            pubMessage.projectLink.callStack[0].should.have.property('ts').and.be.a.Number()
+            pubMessage.projectLink.callStack[0].should.have.property('response').and.equal('res')
+            pubMessage.projectLink.callStack[0].should.have.property('application')
+            pubMessage.projectLink.callStack[0].should.have.property('instance')
+            pubMessage.projectLink.callStack[0].should.have.property('node')
+            pubMessage.projectLink.callStack[0].should.have.property('project').and.equal(PROJECT_ID)
+            pubMessage.projectLink.callStack[0].should.have.property('eventId').and.be.a.String()
+
+            const pubOptions = env.mqttStub.publish.args[0][2]
+            should(pubOptions).be.an.Object()
+            pubOptions.should.have.property('qos').and.equal(2)
+        })
+        it('project link out should publish using QoS 2', async function () {
+            const env = setup()
+            const RED = env.RED
+            const nodeEvents = {}
+            const outNode = {
+                on: (event, cb) => {
+                    nodeEvents[event] = cb
+                },
+                error: sinon.fake(),
+                type: 'project link call',
+                mode: 'link'
+            }
+            const topic = 'cloud/project-nodes-test/xxx'
+            const expectedPubTopic = `ff/v1/${TEAM_ID}/p/${PROJECT_ID}/in/${topic}`
+            projectLinkPackage(RED)
+            const NodeConstructor = env.nodes['project link out'].NodeConstructor
+            NodeConstructor.call(outNode, { topic, project: PROJECT_ID })
+            outNode.should.have.property('subTopic', topic)
+
+            // send a message to the node so that it can publish
+            await nodeEvents.input({ payload: 'test' }, sinon.fake(), sinon.fake())
+
+            env.mqttStub.publish.calledOnce.should.be.true()
+            const pubTopic = env.mqttStub.publish.args[0][0]
+            should(pubTopic).equal(expectedPubTopic)
+            const pubMessageStr = env.mqttStub.publish.args[0][1]
+            const pubMessage = JSON.parse(pubMessageStr)
+            should(pubMessage).be.an.Object()
+            pubMessage.should.have.property('payload').and.equal('test')
+            const pubOptions = env.mqttStub.publish.args[0][2]
+            should(pubOptions).be.an.Object()
+            pubOptions.should.have.property('qos').and.equal(2)
+            pubOptions.should.have.property('properties').and.be.an.Object()
+            pubOptions.properties.should.have.property('contentType', 'application/json')
+            pubOptions.properties.should.have.property('userProperties').and.be.an.Object()
+            pubOptions.properties.userProperties.should.have.property('_nodeID')
+            pubOptions.properties.userProperties.should.have.property('_projectID', PROJECT_ID)
+            pubOptions.properties.userProperties.should.have.property('_applicationID')
+            pubOptions.properties.userProperties.should.have.property('_publishTime').and.be.a.Number()
+        })
+    })
 })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

130116

increased by5.37%

Lines of code

1697

increased by7.61%

No dependency changes