Merge cf82daf5da into 0cb8ecf8aa

README.md

@@ -5,8 +5,6 @@
 
 Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
 
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B51BM7C)
-
 ### Features
 
 Supported functionality in this package includes:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-matrix-chat",
-  "version": "0.9.2",
+  "version": "0.8.0",
   "description": "Matrix chat server client for Node-RED",
   "dependencies": {
     "abort-controller": "^3.0.0",
@@ -9,11 +9,12 @@
     "got": "^12.0.2",
     "image-size": "^1.0.2",
     "isomorphic-webcrypto": "^2.3.8",
-    "matrix-js-sdk": "34.11.1",
+    "matrix-js-sdk": "^28.0.0",
     "mime": "^3.0.0",
     "node-fetch": "^3.3.0",
     "node-localstorage": "^2.2.1",
     "olm": "https://gitlab.matrix.org/matrix-org/olm/-/package_files/2572/download",
+    "request": "^2.88.2",
     "sharp": "^0.33.4",
     "tmp": "^0.2.1",
     "utf8": "^3.0.0"

src/matrix-event-relations.js

@@ -1,4 +1,4 @@
-const sdkPromise = import("matrix-js-sdk");
+const {RelationType, EventType, Direction} = require("matrix-js-sdk");
 
 module.exports = function(RED) {
     function MatrixFetchRelations(n) {
@@ -49,17 +49,14 @@ module.exports = function(RED) {
             }
 
             try {
-                const sdk = await sdkPromise;
-                const Direction = sdk.Direction;
-
                 function evaluateNodePropertySafe(value, type, node, msg) {
                     try {
                         return RED.util.evaluateNodeProperty(value, type, node, msg);
                     } catch (e) {
                         if (e instanceof TypeError) {
-                            return undefined;
+                            return undefined;  // Handle TypeError and return undefined
                         }
-                        throw e;
+                        throw e;  // Re-throw other errors to prevent masking issues
                     }
                 }
 

src/matrix-get-event.html

@@ -19,18 +19,14 @@
         },
         oneditprepare: function() {
             $("#node-input-roomId").typedInput({
+                type: this.roomIdType,
                 types:['msg','flow','global','str'],
-                typeField: "#node-input-roomId"
+            }).typedInput('value', this.roomIdValue);
-            });
-            $("#node-input-roomId").typedInput("type", this.roomIdType || "msg");
-            $("#node-input-roomId").typedInput("value", this.roomIdValue || "topic");
 
             $("#node-input-eventId").typedInput({
+                type: this.eventIdType,
                 types:['msg','flow','global','str'],
-                typeField: "#node-input-eventId"
+            }).typedInput('value', this.eventIdValue);
-            });
-            $("#node-input-eventId").typedInput("type", this.eventIdType || "msg");
-            $("#node-input-eventId").typedInput("value", this.eventIdValue || "eventId");
         },
         oneditsave: function() {
             this.roomIdType = $("#node-input-roomId").typedInput('type');
@@ -62,6 +58,18 @@
         <label for="node-input-eventId"><i class="fa fa-file"></i> Event ID</label>
         <input type="text" id="node-input-eventId">
     </div>
+
+    <script type="text/javascript">
+        $(function(){
+            $("#node-input-roomId").on("keyup", function() {
+                if($(this).val() && !$(this).val().startsWith("!")) {
+                    $("#node-input-roomId-error").html(`Room IDs start with exclamation point "!"<br />Example: !OGEhHVWSdvArJzumhm:matrix.org`).show();
+                } else {
+                    $("#node-input-roomId-error").hide();
+                }
+            }).trigger('keyup');
+        });
+</script>
 </script>
 
 <script type="text/html" data-help-name="matrix-get-event">

src/matrix-mark-read.js

@@ -1,8 +1,9 @@
+const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
 const crypto = require('crypto');
-
 module.exports = function(RED) {
-    function MatrixMarkRead(n) {
+    function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
+
         let node = this;
         this.name = n.name;
         this.server = RED.nodes.getNode(n.server);
@@ -37,7 +38,7 @@ module.exports = function(RED) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if (type === 'flow' || type === 'global') {
+                } else if ((type === 'flow') || (type === 'global')) {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
                     } catch(e2) {
@@ -65,7 +66,7 @@ module.exports = function(RED) {
                     throw new Error(`Event ${eventId} not found in room ${roomId}.`);
                 }
 
-                await node.server.matrixClient.sendReceipt(event, "m.read");
+                await node.server.matrixClient.sendReceipt(event, "m.read")
                 node.send([msg, null]);
             } catch(e) {
                 msg.error = `Room pagination error: ${e}`;
@@ -78,5 +79,5 @@ module.exports = function(RED) {
             node.server.deregister(node);
         });
     }
-    RED.nodes.registerType("matrix-mark-read", MatrixMarkRead);
+    RED.nodes.registerType("matrix-mark-read", MatrixReceiveMessage);
 }

src/matrix-paginate-room.js

@@ -1,8 +1,7 @@
-const sdkPromise = import("matrix-js-sdk");
+const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
 const crypto = require('crypto');
-
 module.exports = function(RED) {
-    function MatrixPaginateRoom(n) {
+    function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
 
         let node = this;
@@ -44,7 +43,7 @@ module.exports = function(RED) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if (type === 'flow' || type === 'global') {
+                } else if ((type === 'flow') || (type === 'global')) {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
                     } catch(e2) {
@@ -62,15 +61,17 @@ module.exports = function(RED) {
                 if(type === 'global' || type === 'flow') {
                     var contextKey = RED.util.parseContextStore(property);
                     if (/\[msg/.test(contextKey.key)) {
-                        // The key has a nested msg. reference that must be evaluated first
+                        // The key has a nest msg. reference to evaluate first
-                        contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true);
+                        contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true)
                     }
                     var target = node.context()[type];
-                    target.set(contextKey.key, value, contextKey.store, err => {
+                    var callback = err => {
                         if (err) {
                             node.error(err, msg);
+                            getterErrors[rule.p] = err.message;
                         }
-                    });
+                    }
+                    target.set(contextKey.key, value, contextKey.store, callback);
                 } else if(type === 'msg') {
                     if (!RED.util.setMessageProperty(msg, property, value)) {
                         node.warn(RED._("change.errors.no-override",{property:property}));
@@ -79,12 +80,6 @@ module.exports = function(RED) {
             }
 
             try {
-                // Dynamically load the SDK
-                const sdk = await sdkPromise;
-                const TimelineWindow = sdk.TimelineWindow;
-                const RelationType = sdk.RelationType;
-                // (Filter was imported originally but is not used, so we omit it.)
-
                 let roomId = getToValue(msg, node.roomType, node.roomValue),
                     paginateBackwards = getToValue(msg, node.paginateBackwardsType, node.paginateBackwardsValue),
                     pageSize = getToValue(msg, node.pageSizeType, node.pageSizeValue),
@@ -106,19 +101,24 @@ module.exports = function(RED) {
                     moreMessages = true;
                 if(!timelineWindow) {
                     let timelineSet = room.getUnfilteredTimelineSet();
-                    // MatrixClient's option initialSyncLimit gets set to the filter we are using,
+                    // node.debug(JSON.stringify(timelineSet.getFilter()));
-                    // so override that value with our pageSize.
+
+                    // MatrixClient's option initialSyncLimit gets set to the filter we are using
+                    // so override that value with our pageSize
                     timelineWindow = new TimelineWindow(node.server.matrixClient, timelineSet);
                     await timelineWindow.load(msg.eventId || null, pageSize);
                     node.timelineWindows.set(pageKey, timelineWindow);
                 } else {
-                    moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // 'b' for backwards, 'f' for forwards
+                    moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // b for backwards f for forwards
                     if(moreMessages) {
                         await timelineWindow.unpaginate(pageSize, !paginateBackwards);
                     }
                 }
 
-                // To avoid errors converting massive MatrixEvent objects to JSON, we omit them.
+                // MatrixEvent objects are massive so this throws an encode error for the string being too long
+                // since msg objects convert to JSON
+                // msg.payload = moreMessages ? timelineWindow.getEvents() : false;
+
                 msg.payload = false;
                 msg.start = timelineWindow.getTimelineIndex('b')?.index;
                 msg.end = timelineWindow.getTimelineIndex('f')?.index;
@@ -152,5 +152,5 @@ module.exports = function(RED) {
             node.server.deregister(node);
         });
     }
-    RED.nodes.registerType("matrix-paginate-room", MatrixPaginateRoom);
+    RED.nodes.registerType("matrix-paginate-room", MatrixReceiveMessage);
 }

src/matrix-receive.html

@@ -13,7 +13,6 @@
             acceptOwnEvents: {"value": false},
             acceptText: {"value": true},
             acceptEmotes: {"value": true},
-            acceptNotices: {"value": true},
             acceptStickers: {"value": true},
             acceptReactions: {"value": true},
             acceptFiles: {"value": true},
@@ -67,16 +66,6 @@
             Accept text <code style="text-transform: none;">m.text</code>
         </label>
     </div>
-    <div class="form-row" style="margin-bottom:0;">
-        <input
-                type="checkbox"
-                id="node-input-acceptNotices"
-                style="width: auto; margin-left: 125px; vertical-align: top"
-        />
-        <label for="node-input-acceptNotices" style="width: auto">
-            Accept notices <code style="text-transform: none;">m.notice</code>
-        </label>
-    </div>
     <div class="form-row" style="margin-bottom:0;">
         <input
                 type="checkbox"

src/matrix-receive.js

@@ -1,3 +1,4 @@
+const {RelationType} = require("matrix-js-sdk");
 module.exports = function(RED) {
     function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
@@ -9,7 +10,6 @@ module.exports = function(RED) {
         this.acceptOwnEvents = n.acceptOwnEvents;
         this.acceptText = n.acceptText;
         this.acceptEmotes = n.acceptEmotes;
-        this.acceptNotices = n.acceptNotices;
         this.acceptStickers = n.acceptStickers;
         this.acceptReactions = n.acceptReactions;
         this.acceptFiles = n.acceptFiles;
@@ -69,10 +69,6 @@ module.exports = function(RED) {
                     if (!node.acceptEmotes) return;
                     break;
 
-                case 'm.notice':
-                    if (!node.acceptNotices) return;
-                    break;
-
                 case 'm.text':
                     if (!node.acceptText) return;
                     break;

src/matrix-send-message.js

@@ -1,8 +1,9 @@
-const sdkPromise = import("matrix-js-sdk");
+const {RelationType} = require("matrix-js-sdk");
 
 module.exports = function(RED) {
     function MatrixSendImage(n) {
         RED.nodes.createNode(this, n);
+
         var node = this;
 
         this.name = n.name;
@@ -67,17 +68,12 @@ module.exports = function(RED) {
             node.status({ fill: "green", shape: "ring", text: "connected" });
         });
 
-        // Make the input handler async so we can await the dynamic import.
+        node.on("input", function (msg) {
-        node.on("input", async function (msg) {
-            // Await the SDK import and get the RelationType constant.
-            const sdk = await sdkPromise;
-            const RelationType = sdk.RelationType;
-
             function getToValue(msg, type, property) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if (type === 'flow' || type === 'global') {
+                } else if ((type === 'flow') || (type === 'global')) {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
                     } catch(e2) {
@@ -124,14 +120,14 @@ module.exports = function(RED) {
             } else {
                 if(msgType === 'msg.type') {
                     if(!msg.type) {
-                        node.error("msg.type is set to be passed in via msg.type but was not defined", msg);
+                        node.error("msg.type type is set to be passed in via msg.type but was not defined", msg);
                         return;
                     }
                     msgType = msg.type;
                 }
 
                 if(msgFormat === 'msg.format') {
-                    if (!Object.hasOwn(msg, 'format')) {
+                    if(!msg.format) {
                         node.error("Message format is set to be passed in via msg.format but was not defined", msg);
                         return;
                     }
@@ -169,11 +165,9 @@ module.exports = function(RED) {
                     };
                     content['body'] = ' * ' + content['body'];
                 } else if(threadReply) {
-                    // If incoming message is a reply to a thread we fetch the thread parent from m.relates_to,
+                    // if incoming message is a reply to a thread we fetch the thread parent from the m.relates_to property
-                    // otherwise fallback to msg.eventId.
+                    // otherwise fallback to msg.eventId
-                    let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread
+                    let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread ? msg?.content?.['m.relates_to']?.event_id : null) || msg.eventId;
-                        ? msg?.content?.['m.relates_to']?.event_id
-                        : null) || msg.eventId;
                     if(threadParent) {
                         content["m.relates_to"] = {
                             "rel_type": RelationType.Thread,
@@ -208,4 +202,4 @@ module.exports = function(RED) {
         });
     }
     RED.nodes.registerType("matrix-send-message", MatrixSendImage);
-};
+}

src/matrix-server-config.js

@@ -1,33 +1,20 @@
+const {RelationType, TimelineWindow} = require("matrix-js-sdk");
+
 global.Olm = require('olm');
 const fs = require("fs-extra");
-let RelationType, sdk, LocalStorageCryptoStore, RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent, MemoryStore;
+const sdk = require("matrix-js-sdk");
-
-(async () => {
-    const mod = await import("matrix-js-sdk");
-    RelationType = mod.RelationType;
-    // matrix-js-sdk doesn't export a default – the top-level export is the same object:
-    sdk = mod;
-
-    RoomEvent = mod.RoomEvent;
-    RoomMemberEvent = mod.RoomMemberEvent;
-    HttpApiEvent = mod.HttpApiEvent;
-    ClientEvent = mod.ClientEvent;
-    MemoryStore = mod.MemoryStore;
-
-    // For LocalStorageCryptoStore, specify the file extension for Node 20+:
-    const cmod = await import("matrix-js-sdk/lib/crypto/store/localStorage-crypto-store.js");
-    LocalStorageCryptoStore = cmod.LocalStorageCryptoStore;
-})();
-
 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, 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 });
+            Object.assign(globalThis, { fetch, Headers, Request, Response })
-        });
+        })
     }
 }
 
@@ -39,13 +26,8 @@ module.exports = function(RED) {
         typeof loggingSettings.console.level !== 'undefined' &&
         ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
     ) {
-        import('matrix-js-sdk/lib/logger.js')
+        const { logger } = require('matrix-js-sdk/lib/logger');
-            .then(({ logger }) => {
         logger.disableAll();
-            })
-            .catch((err) => {
-                console.error("Error loading logger module:", err);
-            });
     }
 
     function MatrixFolderNameFromUserId(name) {
@@ -78,7 +60,7 @@ module.exports = function(RED) {
         this.initializedAt = new Date();
         node.initialSyncLimit = 25;
 
-        // Keep track of all consumers of this node to catch errors
+        // Keep track of all consumers of this node to be able to catch errors
         node.register = function(consumerNode) {
             node.users[consumerNode.id] = consumerNode;
         };
@@ -118,7 +100,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})`);
@@ -135,7 +117,7 @@ module.exports = function(RED) {
                                                     node.matrixClient.setDeviceDetails(device_id, {
                                                         display_name: node.deviceLabel
                                                     }).then(
-                                                        function() {},
+                                                        function(response) {},
                                                         function(error) {
                                                             node.error("Failed to set device label: " + error, {});
                                                         }
@@ -172,7 +154,9 @@ module.exports = function(RED) {
                     localStorage: localStorage,
                 }),
                 userId: this.userId,
-                deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined
+                deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined,
+                request
+                // verificationMethods: ["m.sas.v1"]
             });
 
             node.debug(`hasLazyLoadMembersEnabled=${node.matrixClient.hasLazyLoadMembersEnabled()}`);
@@ -212,15 +196,15 @@ module.exports = function(RED) {
             node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) {
                 if (toStartOfTimeline) {
                     node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: paginated result");
-                    return;
+                    return; // ignore paginated results
                 }
                 if (!data || !data.liveEvent) {
                     node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message");
-                    return;
+                    return; // ignore old message (we only want live events)
                 }
                 if(node.initializedAt > event.getDate()) {
                     node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message before init");
-                    return;
+                    return; // skip events that occurred before our client initialized
                 }
 
                 try {
@@ -395,6 +379,7 @@ module.exports = function(RED) {
                 }
             });
 
+
             node.matrixClient.on(HttpApiEvent.SessionLoggedOut, async function(errorObj){
                 // Example if user auth token incorrect:
                 // {
@@ -467,7 +452,7 @@ module.exports = function(RED) {
                                 node.error("Auth check failed: " + err, {});
                             }
                         }
-                    );
+                    )
             })();
         }
     }
@@ -492,19 +477,20 @@ module.exports = function(RED) {
                 deviceId = req.body.deviceId || undefined,
                 displayName = req.body.displayName || undefined;
 
-            (async () => {
+            const matrixClient = sdk.createClient({
-                const mod = await import("matrix-js-sdk");
-                const matrixClient = mod.createClient({
                 baseUrl: baseUrl,
                 deviceId: deviceId,
                 timelineSupport: true,
-                    localTimeoutMs: '30000'
+                localTimeoutMs: '30000',
+                request
             });
 
+            new TimelineWindow()
 
             matrixClient.timelineSupport = true;
 
-                matrixClient.login('m.login.password', {
+            matrixClient.login(
+                'm.login.password', {
                     identifier: {
                         type: 'm.id.user',
                         user: userId,
@@ -528,11 +514,7 @@ module.exports = function(RED) {
                         });
                     }
                 );
-            })().catch(err => {
-                res.json({ result: 'error', message: err.toString() });
         });
-        }
-    );
 
     function upgradeDirectoryIfNecessary(node, storageDir) {
         let oldStorageDir = './matrix-local-storage',
@@ -573,6 +555,9 @@ module.exports = function(RED) {
         }
     }
 
+    /**
+     * If a device ID is stored we will use that for the client
+     */
     function getStoredDeviceId(localStorage) {
         let deviceId = localStorage.getItem('my_device_id');
         if(deviceId === "null" || !deviceId) {
@@ -588,4 +573,4 @@ module.exports = function(RED) {
         localStorage.setItem('my_device_id', deviceId);
         return true;
     }
-};
+}