Merge pull request #86 from bvmensvoort/85-make-errors-catchable

Make errors catchable

README.md

@@ -26,9 +26,7 @@ The following is supported from this package:
 - Get a user list from a room
 - Kick user from room
 - Ban user from room
-- Join a room
-- Create a room
-- Invite to a room
+- Join, Create, Invite, and Leave rooms
 - Synapse admin API to force add user to room (requires bot to be in same room already)
 
 

examples/README.md

@@ -15,6 +15,8 @@ Build something cool with these nodes? Feel free to submit a pull request to sha
 - [Respond to "image" with an uploaded image](#respond-to-image-with-an-uploaded-image)
 - [Respond to "file" with an uploaded file](#respond-to-file-with-an-uploaded-file)
 - [Respond to "react" with a reaction](#respond-to-react-with-a-reaction)
+- [Accept room invites from specific user](#accept-room-invites-from-specific-user)
+- [Leave room when someone says "bye"](#leave-room-when-someone-says-bye)
 - [Remove messages containing "delete"](#remove-messages-containing-delete)
 - [Respond to "users" with full list of server users](#respond-to-users-with-full-list-of-server-users)
 - [Respond to "newroom" by creating new room and inviting user](#respond-to-newroom-by-creating-new-room-and-inviting-user)
@@ -113,6 +115,26 @@ Give a 👍 reaction when someone says "react"
 
 
 
+### Accept room invites from specific user
+
+[View JSON](accept-room-invites.json)
+
+Accept room invites from specific user.
+
+![accept-room-invites.png](accept-room-invites.png)
+
+
+
+### Leave room when someone says bye
+
+[View JSON](leave-room-bye.json)
+
+Leave room when someone says "bye".
+
+![leave-room-bye.png](leave-room-bye.png)
+
+
+
 ### Remove messages containing "delete"
 
 [View JSON](delete-event.json)

examples/accept-room-invites.json

@@ -0,0 +1,94 @@
+[
+  {
+    "id": "64f76474ff7a3727",
+    "type": "matrix-room-invite",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "server": "8da0ef83f77f8e24",
+    "roomId": null,
+    "x": 270,
+    "y": 2380,
+    "wires": [
+      [
+        "22f6056fa5bc5bd0"
+      ]
+    ]
+  },
+  {
+    "id": "6d6f304a0a6342b8",
+    "type": "matrix-join-room",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "server": "8da0ef83f77f8e24",
+    "x": 770,
+    "y": 2380,
+    "wires": [
+      [
+        "1409ebb4a0e65663"
+      ],
+      [
+        "1409ebb4a0e65663"
+      ]
+    ]
+  },
+  {
+    "id": "22f6056fa5bc5bd0",
+    "type": "switch",
+    "z": "f025a8b9fbd1b054",
+    "name": "msg.userId == @skylord123:skylar.tech",
+    "property": "userId",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "@skylord123:skylar.tech",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "repair": false,
+    "outputs": 1,
+    "x": 520,
+    "y": 2380,
+    "wires": [
+      [
+        "6d6f304a0a6342b8"
+      ]
+    ]
+  },
+  {
+    "id": "043f74e6d76b1eb0",
+    "type": "comment",
+    "z": "f025a8b9fbd1b054",
+    "name": "Only accept room invites from specific user",
+    "info": "",
+    "x": 360,
+    "y": 2340,
+    "wires": []
+  },
+  {
+    "id": "1409ebb4a0e65663",
+    "type": "debug",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 910,
+    "y": 2380,
+    "wires": []
+  },
+  {
+    "id": "8da0ef83f77f8e24",
+    "type": "matrix-server-config",
+    "name": null,
+    "autoAcceptRoomInvites": false,
+    "enableE2ee": true,
+    "global": true
+  }
+]

examples/leave-room-bye.json

@@ -0,0 +1,103 @@
+[
+  {
+    "id": "997c354038202dba",
+    "type": "comment",
+    "z": "f025a8b9fbd1b054",
+    "name": "Leave room when someone says \"bye\"",
+    "info": "",
+    "x": 350,
+    "y": 2520,
+    "wires": []
+  },
+  {
+    "id": "69c4ea189be94feb",
+    "type": "matrix-receive",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "server": "8da0ef83f77f8e24",
+    "roomId": "",
+    "acceptText": true,
+    "acceptEmotes": true,
+    "acceptStickers": true,
+    "acceptReactions": true,
+    "acceptFiles": true,
+    "acceptAudio": true,
+    "acceptImages": true,
+    "acceptLocations": true,
+    "x": 280,
+    "y": 2560,
+    "wires": [
+      [
+        "19e1d64b63ae8a1f"
+      ]
+    ]
+  },
+  {
+    "id": "19e1d64b63ae8a1f",
+    "type": "switch",
+    "z": "f025a8b9fbd1b054",
+    "name": "msg.payload == bye",
+    "property": "payload",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "bye",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "repair": false,
+    "outputs": 1,
+    "x": 480,
+    "y": 2560,
+    "wires": [
+      [
+        "db0e51f8e7793f92"
+      ]
+    ]
+  },
+  {
+    "id": "db0e51f8e7793f92",
+    "type": "matrix-leave-room",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "server": "8da0ef83f77f8e24",
+    "roomId": null,
+    "x": 670,
+    "y": 2560,
+    "wires": [
+      [
+        "3791f551bf0e4fc4"
+      ],
+      [
+        "3791f551bf0e4fc4"
+      ]
+    ]
+  },
+  {
+    "id": "3791f551bf0e4fc4",
+    "type": "debug",
+    "z": "f025a8b9fbd1b054",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 810,
+    "y": 2560,
+    "wires": []
+  },
+  {
+    "id": "8da0ef83f77f8e24",
+    "type": "matrix-server-config",
+    "name": null,
+    "autoAcceptRoomInvites": false,
+    "enableE2ee": true,
+    "global": true
+  }
+]

package.json

@@ -1,14 +1,17 @@
 {
   "name": "node-red-contrib-matrix-chat",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Matrix chat server client for Node-RED",
   "dependencies": {
-    "fs-extra": "^10.0.1",
+    "abort-controller": "^3.0.0",
+    "fs-extra": "^11.1.0",
     "got": "^12.0.2",
     "isomorphic-webcrypto": "^2.3.8",
-    "matrix-js-sdk": "^16.0.0",
+    "matrix-js-sdk": "^28.0.0",
+    "node-fetch": "^3.3.0",
     "node-localstorage": "^2.2.1",
-    "olm": "https://gitlab.matrix.org/matrix-org/olm/-/package_files/271/download",
+    "olm": "https://gitlab.matrix.org/matrix-org/olm/-/package_files/2572/download",
+    "request": "^2.88.2",
     "utf8": "^3.0.0"
   },
   "node-red": {
@@ -23,7 +26,9 @@
       "matrix-react": "src/matrix-react.js",
       "matrix-create-room": "src/matrix-create-room.js",
       "matrix-invite-room": "src/matrix-invite-room.js",
+      "matrix-room-invite": "src/matrix-room-invite.js",
       "matrix-join-room": "src/matrix-join-room.js",
+      "matrix-leave-room": "src/matrix-leave-room.js",
       "matrix-crypt-file": "src/matrix-crypt-file.js",
       "matrix-room-kick": "src/matrix-room-kick.js",
       "matrix-room-ban": "src/matrix-room-ban.js",
@@ -42,9 +47,9 @@
   "keywords": [
     "node-red",
     "matrix",
-    "support",
-    "bot",
-    "chat"
+    "chat",
+    "chatbot",
+    "federated"
   ],
   "repository": {
     "type": "git",

src/matrix-create-room.js

@@ -8,9 +8,10 @@ module.exports = function(RED) {
         this.server = RED.nodes.getNode(n.server);
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
+        node.server.register(node);
 
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
@@ -41,7 +42,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
@@ -64,6 +65,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-create-room", MatrixCreateRoom);
 }

src/matrix-crypt-file.js

@@ -12,22 +12,22 @@ module.exports = function(RED) {
             const { got } = await import('got');
 
             if(!msg.type) {
-                node.error('msg.type is required.');
+                node.error('msg.type is required.', msg);
                 return;
             }
 
             if(!msg.content) {
-                node.error('msg.content is required.');
+                node.error('msg.content is required.', msg);
                 return;
             }
 
             if(!msg.content.file) {
-                node.error('msg.content.file is required.');
+                node.error('msg.content.file is required.', msg);
                 return;
             }
 
             if(!msg.url) {
-                node.error('msg.url is required.');
+                node.error('msg.url is required.', msg);
                 return;
             }
 

src/matrix-delete-event.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -27,7 +28,7 @@ module.exports = function(RED) {
         node.on('input', function(msg) {
 
             if(!msg.eventId) {
-                node.error("eventId is missing");
+                node.error("eventId is missing", msg);
                 node.send([null, msg])
                 return;
             }
@@ -38,7 +39,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
                 return;
             }
@@ -70,6 +71,10 @@ module.exports = function(RED) {
                 node.send([null, msg]);
             });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-delete-event",MatrixDeleteEvent);
 }

src/matrix-invite-room.html

@@ -12,9 +12,9 @@
             roomId: { value: null },
         },
         label: function() {
-            return this.name || "Room Invite";
+            return this.name || "Invite to Room";
         },
-        paletteLabel: 'Room Invite'
+        paletteLabel: 'Invite to Room'
     });
 </script>
 

src/matrix-invite-room.js

@@ -9,9 +9,10 @@ module.exports = function(RED) {
         this.roomId = n.roomId;
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
+        node.server.register(node);
 
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
@@ -37,18 +38,18 @@ module.exports = function(RED) {
 
         node.on("input", function (msg) {
             if (! node.server || ! node.server.matrixClient) {
-                node.error("No matrix server selected");
+                node.error("No matrix server selected", msg);
                 return;
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             msg.topic = node.roomId || msg.topic;
             if(!msg.topic) {
-                node.error("room must be defined in either msg.topic or in node config");
+                node.error("room must be defined in either msg.topic or in node config", msg);
                 return;
             }
 
@@ -64,6 +65,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-invite-room", MatrixInviteRoom);
 }

src/matrix-join-room.js

@@ -11,6 +11,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -24,17 +25,17 @@ module.exports = function(RED) {
 
         node.on("input", function (msg) {
             if (! node.server || ! node.server.matrixClient) {
-                node.error("No matrix server selected");
+                node.error("No matrix server selected", msg);
                 return;
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             if(!msg.topic) {
-                node.error("Room must be specified in msg.topic");
+                node.error("Room must be specified in msg.topic", msg);
                 return;
             }
 
@@ -46,11 +47,15 @@ module.exports = function(RED) {
                     node.send([msg, null]);
                 })
                 .catch(function(e){
-                    node.error("Error trying to join room " + msg.topic + ":" + e);
+                    node.error("Error trying to join room " + msg.topic + ":" + e, msg);
                     msg.error = e;
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-join-room", MatrixJoinRoom);
 }

src/matrix-leave-room.html

@@ -0,0 +1,63 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-leave-room', {
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        outputLabels: ["success", "error"],
+        inputs: 1,
+        outputs: 2,
+        defaults: {
+            name: { value: null },
+            server: { value: "", type: "matrix-server-config" },
+            roomId: { value: null },
+        },
+        label: function() {
+            return this.name || "Leave Room";
+        },
+        paletteLabel: 'Leave Room'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-leave-room">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
+        <input type="text" id="node-input-server">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="matrix-leave-room">
+    <h3>Details</h3>
+    <p>
+        This node leaves a room
+    </p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>msg.topic
+            <span class="property-type">string</span>
+        </dt>
+        <dd> The room identifier to leave: for example, <code>!h8zld9j31:example.com</code>.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Success
+            <dl class="message-properties">
+                <dt>msg.payload <span class="property-type">object</span></dt>
+                <dd>Returns the same message that was received</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>msg.error <span class="property-type">string</span></dt>
+                <dd>the error that occurred.</dd>
+            </dl>
+        </li>
+    </ol>
+
+</script>

src/matrix-leave-room.js

@@ -0,0 +1,59 @@
+module.exports = function(RED) {
+    function MatrixLeaveRoom(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+        this.roomId = n.roomId;
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        if (!node.server) {
+            node.error("No configuration node", {});
+            return;
+        }
+        node.server.register(node);
+
+        node.server.on("disconnected", function(){
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.on('input', function(msg) {
+            if (! node.server || ! node.server.matrixClient) {
+                node.error("No matrix server selected", msg);
+                return;
+            }
+
+            if(!msg.topic) {
+                node.error('No room provided in msg.topic', msg);
+                return;
+            }
+
+            if(!node.server.isConnected()) {
+                node.error("Matrix server connection is currently closed", msg);
+                node.send([null, msg]);
+            }
+
+            try {
+                node.log("Leaving room " + msg.topic);
+                node.server.matrixClient.leave(msg.topic);
+                node.send([msg, null]);
+            } catch(e) {
+                node.error("Failed to leave room " + msg.topic + ": " + e, msg);
+                msg.payload = e;
+                node.send([null, msg]);
+            }
+        });
+        
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
+    }
+    RED.nodes.registerType("matrix-leave-room", MatrixLeaveRoom);
+}

src/matrix-react.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -26,30 +27,30 @@ module.exports = function(RED) {
 
         node.on("input", function (msg) {
             if (!node.server || !node.server.matrixClient) {
-                node.error("No matrix server selected");
+                node.error("No matrix server selected", msg);
                 return;
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             msg.topic = node.roomId || msg.topic;
             if(!msg.topic) {
-                node.error("Room must be specified in msg.topic or in configuration");
+                node.error("Room must be specified in msg.topic or in configuration", msg);
                 return;
             }
 
             let payload = n.reaction || msg.payload;
             if(!payload) {
-                node.error('msg.payload must be defined or the reaction configured on the node.');
+                node.error('msg.payload must be defined or the reaction configured on the node.', msg);
                 return;
             }
 
             let eventId = msg.referenceEventId || msg.eventId;
             if(!eventId) {
-                node.error('Either msg.referenceEventId or msg.eventId must be defined to react to a message.');
+                node.error('Either msg.referenceEventId or msg.eventId must be defined to react to a message.', msg);
                 return;
             }
 
@@ -75,6 +76,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-react", MatrixReact);
 }

src/matrix-receive.html

@@ -17,6 +17,7 @@
             acceptFiles: {"value": true},
             acceptAudio: {"value": true},
             acceptImages: {"value": true},
+            acceptVideos: {"value": true},
             acceptLocations: {"value": true},
         },
         label: function() {
@@ -114,6 +115,16 @@
             Accept images <code style="text-transform: none;">m.image</code>
         </label>
     </div>
+    <div class="form-row">
+        <input
+                type="checkbox"
+                id="node-input-acceptVideos"
+                style="width: auto; margin-left: 125px; vertical-align: top"
+        />
+        <label for="node-input-acceptVideos" style="width: auto">
+            Accept videos <code style="text-transform: none;">m.video</code>
+        </label>
+    </div>
     <div class="form-row">
         <input
                 type="checkbox"

src/matrix-receive.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
         this.acceptFiles = n.acceptFiles;
         this.acceptAudio = n.acceptAudio;
         this.acceptImages = n.acceptImages;
+        this.acceptVideos = n.acceptVideos;
         this.acceptLocations = n.acceptLocations;
         this.roomId = n.roomId;
         this.roomIds = this.roomId ? this.roomId.split(',') : [];
@@ -20,9 +21,10 @@ module.exports = function(RED) {
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
         if (!node.server) {
-            node.error("No configuration node");
+            node.error("No configuration node", {});
             return;
         }
+        node.server.register(node);
 
         node.server.on("disconnected", function(){
             node.status({ fill: "red", shape: "ring", text: "disconnected" });
@@ -111,6 +113,23 @@ module.exports = function(RED) {
                     }
                     break;
 
+
+                case 'm.video':
+                    if(!node.acceptVideos) return;
+                    msg.filename = msg.content.filename || msg.content.body;
+                    if(msg.encrypted) {
+                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.file.url);
+                        msg.mxc_url = msg.content.file.url;
+                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_file.url);
+                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_file.url;
+                    } else {
+                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
+                        msg.mxc_url = msg.content.url;
+                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_url);
+                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_url;
+                    }
+                    break;
+
                 case 'm.location':
                     if(!node.acceptLocations) return;
                     msg.geo_uri = msg.content.geo_uri;
@@ -131,6 +150,10 @@ module.exports = function(RED) {
 
             node.send(msg);
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-receive", MatrixReceiveMessage);
 }

src/matrix-room-ban.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -26,23 +27,23 @@ module.exports = function(RED) {
 
         node.on("input", function (msg) {
             if (! node.server || ! node.server.matrixClient) {
-                node.error("No matrix server selected");
+                node.error("No matrix server selected", msg);
                 return;
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             msg.topic = node.roomId || msg.topic;
             if(!msg.topic) {
-                node.error("Room must be specified in msg.topic or in configuration");
+                node.error("Room must be specified in msg.topic or in configuration", msg);
                 return;
             }
 
             if(!msg.userId) {
-                node.error("msg.userId was not set.");
+                node.error("msg.userId was not set.", msg);
                 return;
             }
 
@@ -53,11 +54,15 @@ module.exports = function(RED) {
                     node.send([msg, null]);
                 })
                 .catch(function(e){
-                    node.error("Error trying to ban " + msg.userId + " from " + msg.topic);
+                    node.error("Error trying to ban " + msg.userId + " from " + msg.topic, msg);
                     msg.error = e;
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-room-ban", MatrixBan);
 }

src/matrix-room-invite.html

@@ -0,0 +1,80 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-room-invite', {
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        outputLabels: ["success", "error"],
+        inputs: 0,
+        outputs: 1,
+        defaults: {
+            name: { value: null },
+            server: { value: "", type: "matrix-server-config" },
+            roomId: { value: null },
+        },
+        label: function() {
+            return this.name || "Room Invite";
+        },
+        paletteLabel: 'Room Invite'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-room-invite">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
+        <input type="text" id="node-input-server">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="matrix-room-invite">
+    <h3>Details</h3>
+    <p>
+        This node receives room invites.
+    </p>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Success
+            <dl class="message-properties">
+                <dt>msg.type <span class="property-type">string</span></dt>
+                <dd>Always <code>m.room.member</code></dd>
+            </dl>
+
+            <dl class="message-properties">
+                <dt>msg.userId <span class="property-type">string</span></dt>
+                <dd>ID of the user the invite is from</dd>
+            </dl>
+
+            <dl class="message-properties">
+                <dt>msg.topic <span class="property-type">string</span></dt>
+                <dd>The room identifier for the invite: for example, <code>!h8zld9j31:example.com</code>.</dd>
+            </dl>
+
+            <dl class="message-properties">
+                <dt>msg.topicName <span class="property-type">string</span></dt>
+                <dd>The invited room name.</dd>
+            </dl>
+
+            <dl class="message-properties">
+                <dt>msg.event <span class="property-type">object</span></dt>
+                <dd>The event object for this invite to get extra details.</dd>
+            </dl>
+
+            <dl class="message-properties">
+                <dt>msg.eventId <span class="property-type">object</span></dt>
+                <dd>The ID of the event for this invite.</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>msg.error <span class="property-type">string</span></dt>
+                <dd>the error that occurred.</dd>
+            </dl>
+        </li>
+    </ol>
+
+</script>

src/matrix-room-invite.js

@@ -0,0 +1,36 @@
+module.exports = function(RED) {
+    function MatrixRoomInvite(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+        this.roomId = n.roomId;
+
+        if(!this.server) {
+            node.error('Server must be configured on the node.', {});
+            return;
+        }
+        node.server.register(node);
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        node.server.on("disconnected", function(){
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.server.on("Room.invite", async function(msg) {
+            node.send(msg);
+        });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
+    }
+    RED.nodes.registerType("matrix-room-invite", MatrixRoomInvite);
+}

src/matrix-room-kick.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -26,23 +27,23 @@ module.exports = function(RED) {
 
         node.on("input", function (msg) {
             if (! node.server || ! node.server.matrixClient) {
-                node.error("No matrix server selected");
+                node.error("No matrix server selected", msg);
                 return;
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             msg.topic = node.roomId || msg.topic;
             if(!msg.topic) {
-                node.error("Room must be specified in msg.topic or in configuration");
+                node.error("Room must be specified in msg.topic or in configuration", msg);
                 return;
             }
 
             if(!msg.userId) {
-                node.error("msg.userId was not set.");
+                node.error("msg.userId was not set.", msg);
                 return;
             }
 
@@ -53,11 +54,15 @@ module.exports = function(RED) {
                     node.send([msg, null]);
                 })
                 .catch(function(e){
-                    node.error("Error trying to kick " + msg.userId + " from " + msg.topic);
+                    node.error("Error trying to kick " + msg.userId + " from " + msg.topic, msg);
                     msg.error = e;
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-room-kick", MatrixKick);
 }

src/matrix-room-users.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -31,13 +32,13 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             let roomId = node.roomId || msg.topic;
             if(!roomId) {
-                node.error("msg.topic is required. Specify in the input or configure the room ID on the node.");
+                node.error("msg.topic is required. Specify in the input or configure the room ID on the node.", msg);
                 return;
             }
 
@@ -65,6 +66,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-room-users", MatrixRoomUsers);
 }

src/matrix-send-file.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -31,7 +32,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
@@ -57,7 +58,7 @@ module.exports = function(RED) {
             }
 
             if(!msg.payload) {
-                node.error('msg.payload is required');
+                node.error('msg.payload is required', msg);
                 return;
             }
 
@@ -94,6 +95,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-send-file", MatrixSendFile);
 }

src/matrix-send-image.js

@@ -13,6 +13,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -31,7 +32,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
@@ -57,7 +58,7 @@ module.exports = function(RED) {
             }
 
             if(!msg.payload) {
-                node.error('msg.payload is required');
+                node.error('msg.payload is required', msg);
                 return;
             }
 
@@ -98,6 +99,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-send-image", MatrixSendImage);
 }

src/matrix-send-message.js

@@ -54,6 +54,7 @@ module.exports = function(RED) {
             node.warn("No configuration node");
             return;
         }
+        node.server.register(node);
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -71,7 +72,7 @@ module.exports = function(RED) {
 
             if(msgType === 'msg.type') {
                 if(!msg.type) {
-                    node.error("msg.type type is set to be passed in via msg.type but was not defined");
+                    node.error("msg.type type is set to be passed in via msg.type but was not defined", msg);
                     return;
                 }
                 msgType = msg.type;
@@ -79,7 +80,7 @@ module.exports = function(RED) {
 
             if(msgFormat === 'msg.format') {
                 if(!msg.format) {
-                    node.error("Message format is set to be passed in via msg.format but was not defined");
+                    node.error("Message format is set to be passed in via msg.format but was not defined", msg);
                     return;
                 }
                 msgFormat = msg.format;
@@ -91,7 +92,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
                 return;
             }
@@ -104,7 +105,7 @@ module.exports = function(RED) {
 
             let payload = n.message || msg.payload;
             if(!payload) {
-                node.error('msg.payload must be defined or the message configured on the node.');
+                node.error('msg.payload must be defined or the message configured on the node.', msg);
                 return;
             }
 
@@ -152,6 +153,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-send-message", MatrixSendImage);
 }

src/matrix-server-config.html

@@ -162,7 +162,7 @@
             $("#matrix-access-token-loader").show();
             $.ajax({
                 type: 'POST',
-                url: '/matrix-chat/login',
+                url: 'matrix-chat/login',
                 dataType: 'json',
                 data: {
                     'userId': userId,
@@ -214,4 +214,4 @@
         <p>If this is a server you do not administrate/have access to follow these instructions:</p>
         <ol><li>In a private/incognito browser window, open Element.</li><li>Log in to the account you want to get the access token for, such as the bot's account. <strong>Do not setup key storage</strong>.</li><li>Click on the bot's name in the top left corner then "Settings".</li><li>(Optional) Set your bot's display name and avatar.</li><li>Click the "Help &amp; About" tab (left side of the dialog).</li><li>Scroll to the bottom and click the <code>&lt;click to reveal&gt;</code> part of <code>Access Token: &lt;click to reveal&gt;</code>.</li><li>Copy your access token to a safe place, like the bot's configuration file.</li><li><strong>Do not log out.</strong> Instead, just close the window. If you used a private browsing session, you should be able to still use Element for your own account. Logging out deletes the access token from the server, making the bot unable to use it.</li></ol>
     </div>
-</script>
+</script>

src/matrix-server-config.js

@@ -4,9 +4,30 @@ const sdk = require("matrix-js-sdk");
 const { resolve } = require('path');
 const { LocalStorage } = require('node-localstorage');
 const { LocalStorageCryptoStore } = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
-const {RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent} = require("matrix-js-sdk");
+const {RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent, MemoryStore} = require("matrix-js-sdk");
+const request = require("request");
+require("abort-controller/polyfill"); // polyfill abort-controller if we don't have it
+if (!globalThis.fetch) {
+    // polyfill fetch if we don't have it
+    if (!globalThis.fetch) {
+        import('node-fetch').then(({ default: fetch, Headers, Request, Response }) => {
+            Object.assign(globalThis, { fetch, Headers, Request, Response })
+        })
+    }
+}
 
 module.exports = function(RED) {
+    // disable logging if set to "off"
+    let loggingSettings = RED.settings.get('logging');
+    if(
+        typeof loggingSettings.console !== 'undefined' &&
+        typeof loggingSettings.console.level !== 'undefined' &&
+        ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
+    ) {
+        const { logger } = require('matrix-js-sdk/lib/logger');
+        logger.disableAll();
+    }
+
     function MatrixFolderNameFromUserId(name) {
         return name.replace(/[^a-z0-9]/gi, '_').toLowerCase();
     }
@@ -23,6 +44,7 @@ module.exports = function(RED) {
             this.credentials = {};
         }
 
+        this.users = {};
         this.connected = null;
         this.name = n.name;
         this.userId = this.credentials.userId;
@@ -47,9 +69,9 @@ module.exports = function(RED) {
         let retryStartTimeout = null;
 
         if(!this.credentials.accessToken) {
-            node.error("Matrix connection failed: missing access token in configuration.");
+            node.error("Matrix connection failed: missing access token in configuration.", {});
         } else if(!this.url) {
-            node.error("Matrix connection failed: missing server URL in configuration.");
+            node.error("Matrix connection failed: missing server URL in configuration.", {});
         } else {
             node.setConnected = async function(connected, cb) {
                 if (node.connected !== connected) {
@@ -67,7 +89,7 @@ module.exports = function(RED) {
                                 device_id = this.matrixClient.getDeviceId();
 
                             if(!device_id && node.enableE2ee) {
-                                node.error("Failed to auto detect deviceId for this auth token. You will need to manually specify one. You may need to login to create a new deviceId.")
+                                node.error("Failed to auto detect deviceId for this auth token. You will need to manually specify one. You may need to login to create a new deviceId.", {})
                             } else {
                                 if(!stored_device_id || stored_device_id !== device_id) {
                                     node.log(`Saving Device ID (old:${stored_device_id} new:${device_id})`);
@@ -86,13 +108,13 @@ module.exports = function(RED) {
                                                     }).then(
                                                         function(response) {},
                                                         function(error) {
-                                                            node.error("Failed to set device label: " + error);
+                                                            node.error("Failed to set device label: " + error, {});
                                                         }
                                                     );
                                                 }
                                             },
                                             function(error) {
-                                                node.error("Failed to fetch device: " + error);
+                                                node.error("Failed to fetch device: " + error, {});
                                             }
                                         );
                                 }
@@ -116,10 +138,13 @@ module.exports = function(RED) {
             node.matrixClient = sdk.createClient({
                 baseUrl: this.url,
                 accessToken: this.credentials.accessToken,
-                sessionStore: new sdk.WebStorageSessionStore(localStorage),
                 cryptoStore: new LocalStorageCryptoStore(localStorage),
+                store: new MemoryStore({
+                    localStorage: localStorage,
+                }),
                 userId: this.userId,
                 deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined,
+                request
                 // verificationMethods: ["m.sas.v1"]
             });
 
@@ -165,7 +190,7 @@ module.exports = function(RED) {
                 try {
                     await node.matrixClient.decryptEventIfNeeded(event);
                 } catch (error) {
-                    node.error(error);
+                    node.error(error, {});
                     return;
                 }
 
@@ -230,16 +255,30 @@ module.exports = function(RED) {
             // handle auto-joining rooms
 
             node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) {
+                if(node.initializedAt > event.getDate()) {
+                    return; // skip events that occurred before our client initialized
+                }
+
                 if (member.membership === "invite" && member.userId === node.userId) {
+                    node.log("Got invite to join room " + member.roomId);
+                    console.log(event);
                     if(node.autoAcceptRoomInvites) {
                         node.matrixClient.joinRoom(member.roomId).then(function() {
                             node.log("Automatically accepted invitation to join room " + member.roomId);
                         }).catch(function(e) {
                             node.warn("Cannot join room (could be from being kicked/banned) " + member.roomId + ": " + e);
                         });
-                    } else {
-                        node.log("Got invite to join room " + member.roomId);
                     }
+
+                    let room = node.matrixClient.getRoom(event.getRoomId());
+                    node.emit("Room.invite", {
+                        type      : 'm.room.member',
+                        userId    : event.getSender(),
+                        topic     : event.getRoomId(),
+                        topicName : (room ? room.name : null) || null,
+                        event     : event,
+                        eventId   : event.getId(),
+                    });
                 }
             });
 
@@ -254,7 +293,7 @@ module.exports = function(RED) {
                 } else if(prevState === null && state === "ERROR") {
                     // Occurs when the initial sync failed first time.
                     node.setConnected(false, function(){
-                        node.error("Failed to connect to Matrix server");
+                        node.error("Failed to connect to Matrix server", {});
                     });
                 } else if(prevState === "ERROR" && state === "PREPARED") {
                     // Occurs when the initial sync succeeds
@@ -271,18 +310,18 @@ module.exports = function(RED) {
                 } else if(prevState === "SYNCING" && state === "RECONNECTING") {
                     // Occurs when the live update fails.
                     node.setConnected(false, function(){
-                        node.error("Connection to Matrix server lost");
+                        node.error("Connection to Matrix server lost", {});
                     });
                 } else if(prevState === "RECONNECTING" && state === "RECONNECTING") {
                     // Can occur if the update calls continue to fail,
                     // but the keepalive calls (to /versions) succeed.
                     node.setConnected(false, function(){
-                        node.error("Connection to Matrix server lost");
+                        node.error("Connection to Matrix server lost", {});
                     });
                 } else if(prevState === "RECONNECTING" && state === "ERROR") {
                     // Occurs when the keepalive call also fails
                     node.setConnected(false, function(){
-                        node.error("Connection to Matrix server lost");
+                        node.error("Connection to Matrix server lost", {});
                     });
                 } else if(prevState === "ERROR" && state === "SYNCING") {
                     // Occurs when the client has performed a
@@ -294,7 +333,7 @@ module.exports = function(RED) {
                     // Occurs when the client has failed to
                     // keepalive for a second time or more.
                     node.setConnected(false, function(){
-                        node.error("Connection to Matrix server lost");
+                        node.error("Connection to Matrix server lost", {});
                     });
                 } else if(prevState === "SYNCING" && state === "SYNCING") {
                     // Occurs when the client has performed a live update.
@@ -306,7 +345,7 @@ module.exports = function(RED) {
                     // Occurs once the client has stopped syncing or
                     // trying to sync after stopClient has been called.
                     node.setConnected(false, function(){
-                        node.error("Connection to Matrix server lost");
+                        node.error("Connection to Matrix server lost", {});
                     });
                 }
             });
@@ -324,7 +363,7 @@ module.exports = function(RED) {
                 //     httpStatus: 401
                 // }
 
-                node.error("Authentication failure: " + errorObj);
+                node.error("Authentication failure: " + errorObj, {});
                 stopClient();
             });
 
@@ -340,7 +379,7 @@ module.exports = function(RED) {
                         initialSyncLimit: 8
                     });
                 } catch(error) {
-                    node.error(error);
+                    node.error(error, {});
                 }
             }
 
@@ -361,7 +400,7 @@ module.exports = function(RED) {
                     .then(
                         function(data) {
                             if((typeof data['device_id'] === undefined || !data['device_id']) && !node.deviceId && !getStoredDeviceId(localStorage)) {
-                                node.error("/whoami request did not return device_id. You will need to manually set one in your configuration because this cannot be automatically fetched.");
+                                node.error("/whoami request did not return device_id. You will need to manually set one in your configuration because this cannot be automatically fetched.", {});
                             }
                             if('device_id' in data && data['device_id'] && !node.deviceId) {
                                 // if we have no device_id configured lets use the one
@@ -371,7 +410,7 @@ module.exports = function(RED) {
 
                             // make sure our userId matches the access token's
                             if(data['user_id'].toLowerCase() !== node.userId.toLowerCase()) {
-                                node.error(`User ID provided is ${node.userId} but token belongs to ${data['user_id']}`);
+                                node.error(`User ID provided is ${node.userId} but token belongs to ${data['user_id']}`, {});
                                 return;
                             }
                             run().catch((error) => node.error(error));
@@ -380,11 +419,19 @@ module.exports = function(RED) {
                             // if the error isn't authentication related retry in a little bit
                             if(err.code !== "M_UNKNOWN_TOKEN") {
                                 retryStartTimeout = setTimeout(checkAuthTokenThenStart, 15000);
-                                node.error("Auth check failed: " + err);
+                                node.error("Auth check failed: " + err, {});
                             }
                         }
                     )
             })();
+
+            // Keep track of all consumers of this node to be able to catch errors
+            node.register = function(consumerNode) {
+                node.users[consumerNode.id] = consumerNode;
+            };
+            node.deregister = function(consumerNode) {
+                delete node.users[consumerNode.id];
+            };
         }
     }
 
@@ -411,7 +458,8 @@ module.exports = function(RED) {
             const matrixClient = sdk.createClient({
                 baseUrl: baseUrl,
                 deviceId: deviceId,
-                localTimeoutMs: '30000'
+                localTimeoutMs: '30000',
+                request
             });
 
             matrixClient.login(
@@ -442,7 +490,7 @@ module.exports = function(RED) {
         let oldStorageDir = './matrix-local-storage',
             oldStorageDir2 = './matrix-client-storage';
 
-        // if the old storage location exists lets move it to it's new location
+        // if the old storage location exists lets move it to the new location
         if(fs.pathExistsSync(oldStorageDir)){
             RED.nodes.eachNode(function(n){
                 try {
@@ -455,7 +503,7 @@ module.exports = function(RED) {
                         fs.copySync(oldStorageDir, dir);
                     }
                 } catch (err) {
-                    console.error(err)
+                    node.error(err, {});
                 }
             });
 

src/matrix-synapse-create-edit-user.js

@@ -8,9 +8,10 @@ module.exports = function(RED) {
         this.server = RED.nodes.getNode(n.server);
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
+        node.server.register(node);
 
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
@@ -41,18 +42,17 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             if(!msg.userId) {
-                node.error("msg.userId must be set to edit/create a user (ex: @user:server.com)");
+                node.error("msg.userId must be set to edit/create a user (ex: @user:server.com)", msg);
                 return;
             }
 
             node.server.matrixClient.http
                 .authedRequest(
-                    undefined,
                     'PUT',
                     node.encodeUri(
                         "/_synapse/admin/v2/users/$userId",
@@ -62,13 +62,17 @@ module.exports = function(RED) {
                     msg.payload,
                     { prefix: '' }
                 ).then(function(e){
-                msg.payload = e;
-                node.send([msg, null]);
-            }).catch(function(e){
-                node.warn("Error creating/editing user " + e);
-                msg.error = e;
-                node.send([null, msg]);
-            });
+                    msg.payload = e;
+                    node.send([msg, null]);
+                }).catch(function(e){
+                    node.warn("Error creating/editing user " + e);
+                    msg.error = e;
+                    node.send([null, msg]);
+                });
+        });
+
+        node.on("close", function() {
+            node.server.deregister(node);
         });
     }
     RED.nodes.registerType("matrix-synapse-create-edit-user", MatrixSynapseCreateEditUser);

src/matrix-synapse-deactivate-user.js

@@ -8,9 +8,10 @@ module.exports = function(RED) {
         this.server = RED.nodes.getNode(n.server);
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
+        node.server.register(node);
 
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
@@ -41,12 +42,12 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             if(!msg.userId) {
-                node.error("msg.userId must be set to edit/create a user (ex: @user:server.com)");
+                node.error("msg.userId must be set to edit/create a user (ex: @user:server.com)", msg);
                 return;
             }
 
@@ -56,7 +57,6 @@ module.exports = function(RED) {
             );
             node.server.matrixClient.http
                 .authedRequest(
-                    undefined,
                     'POST',
                     path,
                     undefined,
@@ -71,6 +71,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-synapse-deactivate-user", MatrixSynapseDeactivateUser);
 }

src/matrix-synapse-join-room.js

@@ -9,10 +9,9 @@ module.exports = function(RED) {
         this.roomId = n.roomId;
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
-
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
                 if (!variables.hasOwnProperty(key)) {
@@ -42,25 +41,24 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             msg.topic = node.roomId || msg.topic;
             if(!msg.topic) {
-                node.error("room must be defined in either msg.topic or in node config");
+                node.error("room must be defined in either msg.topic or in node config", msg);
                 return;
             }
 
             if(!msg.userId) {
-                node.error("msg.userId is required to set user into a room");
+                node.error("msg.userId is required to set user into a room", msg);
                 return;
             }
 
             // we need the status code, so set onlydata to false for this request
             node.server.matrixClient.http
                 .authedRequest(
-                    undefined,
                     'POST',
                     node.encodeUri(
                         "/_synapse/admin/v1/join/$room_id_or_alias",
@@ -78,6 +76,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-synapse-join-room", MatrixJoinRoom);
 }

src/matrix-synapse-register.js

@@ -12,25 +12,27 @@ module.exports = function(RED) {
         this.sharedSecret = this.credentials.sharedSecret;
 
         if(!this.server) {
-            node.error('Server URL must be configured on the node.');
+            node.error('Server URL must be configured on the node.', {});
             return;
         }
 
         if(!this.sharedSecret) {
-            node.error('Shared registration secret must be configured on the node.');
+            node.error('Shared registration secret must be configured on the node.', {});
             return;
         }
 
+        node.server.register(node);
+
         node.on("input", async function (msg) {
             const { got } = await import('got');
 
             if(!msg.payload.username) {
-                node.error("msg.payload.username is required");
+                node.error("msg.payload.username is required", msg);
                 return;
             }
 
             if(!msg.payload.password) {
-                node.error("msg.payload.password is required");
+                node.error("msg.payload.password is required", msg);
                 return;
             }
 
@@ -50,7 +52,7 @@ module.exports = function(RED) {
 
                 var nonce = response.body.nonce;
                 if(!nonce) {
-                    node.error('Could not get nonce from /_synapse/admin/v1/register');
+                    node.error('Could not get nonce from /_synapse/admin/v1/register', msg);
                     return;
                 }
 
@@ -96,6 +98,10 @@ module.exports = function(RED) {
                 node.send(msg);
             })();
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-synapse-register", MatrixSynapseRegister, {
         credentials: {

src/matrix-synapse-users.js

@@ -12,6 +12,8 @@ module.exports = function(RED) {
             return;
         }
 
+        node.server.register(node);
+
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
         node.server.on("disconnected", function(){
@@ -29,7 +31,7 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
@@ -48,7 +50,6 @@ module.exports = function(RED) {
 
             node.server.matrixClient.http
                 .authedRequest(
-                    undefined,
                     'GET',
                     "/_synapse/admin/v2/users",
                     queryParams,
@@ -63,6 +64,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-synapse-users", MatrixSynapseUsers);
 }

src/matrix-whois-user.js

@@ -8,10 +8,12 @@ module.exports = function(RED) {
         this.server = RED.nodes.getNode(n.server);
 
         if(!this.server) {
-            node.error('Server must be configured on the node.');
+            node.error('Server must be configured on the node.', {});
             return;
         }
 
+        node.server.register(node);
+
         this.encodeUri = function(pathTemplate, variables) {
             for (const key in variables) {
                 if (!variables.hasOwnProperty(key)) {
@@ -41,19 +43,18 @@ module.exports = function(RED) {
             }
 
             if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed");
+                node.error("Matrix server connection is currently closed", msg);
                 node.send([null, msg]);
             }
 
             if(!msg.userId) {
-                node.error("msg.userId must be set to get user whois data");
+                node.error("msg.userId must be set to get user whois data", msg);
                 return;
             }
 
             // we need the status code, so set onlydata to false for this request
             node.server.matrixClient.http
                 .authedRequest(
-                    undefined,
                     'GET',
                     node.encodeUri(
                         "/_matrix/client/r0/admin/whois/$userId",
@@ -71,6 +72,10 @@ module.exports = function(RED) {
                     node.send([null, msg]);
                 });
         });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
     }
     RED.nodes.registerType("matrix-whois-user", MatrixWhoIsUser);
 }