Guard settings access

Generate instanceId and include in hash for cache busting
Restore caching busting functionality without using explict version number
2025-03-01 10:36:34 +00:00 · 2024-01-08 23:37:44 +00:00 · 2024-01-08 23:27:14 +00:00 · 2024-01-05 23:14:00 +00:00 · 2024-01-05 21:00:29 +00:00 · 2024-01-05 20:59:45 +00:00
17 changed files with 38 additions and 28 deletions
--- a/packages/node_modules/@node-red/editor-api/lib/editor/index.js
+++ b/packages/node_modules/@node-red/editor-api/lib/editor/index.js
@@ -51,7 +51,7 @@ module.exports = {

            var ui = require("./ui");

-            ui.init(runtimeAPI);
+            ui.init(settings, runtimeAPI);

            const editorApp = apiUtil.createExpressApp(settings)

--- a/packages/node_modules/@node-red/editor-api/lib/editor/ui.js
+++ b/packages/node_modules/@node-red/editor-api/lib/editor/ui.js
@@ -13,6 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/
+const crypto = require('crypto')
 var express = require('express');
 var fs = require("fs");
 var path = require("path");
@@ -24,13 +25,16 @@ var apiUtils = require("../util");
 var theme = require("./theme");

 var runtimeAPI;
+let settings;
 var editorClientDir = path.dirname(require.resolve("@node-red/editor-client"));
 var defaultNodeIcon = path.join(editorClientDir,"public","red","images","icons","arrow-in.svg");
 var editorTemplatePath = path.join(editorClientDir,"templates","index.mst");
 var editorTemplate;
+let cacheBuster

 module.exports = {
-    init: function(_runtimeAPI) {
+    init: function(_settings, _runtimeAPI) {
+        settings = _settings;
        runtimeAPI = _runtimeAPI;
        editorTemplate = fs.readFileSync(editorTemplatePath,"utf8");
        Mustache.parse(editorTemplate);
@@ -91,6 +95,12 @@ module.exports = {
    },

    editor: async function(req,res) {
+        if (!cacheBuster) {
+            // settings.instanceId is set asynchronously to the editor-api
+            // being initiaised. So we defer calculating the cacheBuster hash
+            // until the first load of the editor
+            cacheBuster = crypto.createHash('md5').update(`${settings.version || 'version'}-${settings.instanceId || 'instanceId'}`).digest("hex").substring(0,12)    
+        }

        let sessionMessages;
        if (req.session && req.session.messages) {
@@ -99,6 +109,7 @@ module.exports = {
        }
        res.send(Mustache.render(editorTemplate,{
            sessionMessages,
+            cacheBuster,
            ...await theme.context()
        }));
    },
--- a/packages/node_modules/@node-red/editor-client/locales/de/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/de/editor.json
@@ -109,7 +109,6 @@
            "selectionToSubflow": "Auswahl in Subflow umwandeln",
            "flows": "Flow",
            "add": "Hinzufügen",
-            "rename": "Umbenennen",
            "delete": "Löschen",
            "keyboardShortcuts": "Tastenkürzel",
            "login": "Anmelden",
--- a/packages/node_modules/@node-red/editor-client/locales/en-US/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/en-US/editor.json
@@ -122,7 +122,6 @@
            "selectionToSubflow": "Selection to Subflow",
            "flows": "Flows",
            "add": "Add",
-            "rename": "Rename",
            "delete": "Delete",
            "keyboardShortcuts": "Keyboard shortcuts",
            "login": "Login",
--- a/packages/node_modules/@node-red/editor-client/locales/fr/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/fr/editor.json
@@ -122,7 +122,6 @@
      "selectionToSubflow": "Convertir en sous-flux",
      "flows": "Flux",
      "add": "Ajouter",
-      "rename": "Renommer",
      "delete": "Supprimer",
      "keyboardShortcuts": "Raccourcis clavier",
      "login": "Se connecter",
--- a/packages/node_modules/@node-red/editor-client/locales/ja/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/ja/editor.json
@@ -122,7 +122,6 @@
            "selectionToSubflow": "選択部分をサブフロー化",
            "flows": "フロー",
            "add": "フローを新規追加",
-            "rename": "フロー名を変更",
            "delete": "フローを削除",
            "keyboardShortcuts": "ショートカットキーの説明",
            "login": "ログイン",
--- a/packages/node_modules/@node-red/editor-client/locales/ko/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/ko/editor.json
@@ -79,7 +79,6 @@
      "selectionToSubflow": "서브 플로우 선택",
      "flows": "플로우",
      "add": "추가",
-      "rename": "이름변경",
      "delete": "삭제",
      "keyboardShortcuts": "단축키",
      "login": "로그인",
--- a/packages/node_modules/@node-red/editor-client/locales/pt-BR/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/pt-BR/editor.json
@@ -109,7 +109,6 @@
            "selectionToSubflow": "Seleção para subfluxo",
            "flows": "Fluxos",
            "add": "Adicionar",
-            "rename": "Renomear",
            "delete": "Apagar",
            "keyboardShortcuts": "Atalhos do teclado",
            "login": "Ingressar",
--- a/packages/node_modules/@node-red/editor-client/locales/ru/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/ru/editor.json
@@ -95,7 +95,6 @@
            "selectionToSubflow": "Выделение в подпоток",
            "flows": "Потоки",
            "add": "Добавить",
-            "rename": "Переименовать",
            "delete": "Удалить",
            "keyboardShortcuts": "Сочетания клавиш",
            "login": "Войти",
--- a/packages/node_modules/@node-red/editor-client/locales/zh-CN/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/zh-CN/editor.json
@@ -120,7 +120,6 @@
      "selectionToSubflow": "将选择部分更改为子流程",
      "flows": "流程",
      "add": "增加",
-      "rename": "重命名",
      "delete": "删除",
      "keyboardShortcuts": "键盘快捷方式",
      "login": "登录",
--- a/packages/node_modules/@node-red/editor-client/locales/zh-TW/editor.json
+++ b/packages/node_modules/@node-red/editor-client/locales/zh-TW/editor.json
@@ -120,7 +120,6 @@
            "selectionToSubflow": "將選擇部分更改為子流程",
            "flows": "流程",
            "add": "增加",
-            "rename": "重新命名",
            "delete": "刪除",
            "keyboardShortcuts": "鍵盤快速鍵",
            "login": "登入",
--- a/packages/node_modules/@node-red/editor-client/src/js/events.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/events.js
@@ -39,15 +39,16 @@
             console.warn(evt,args);
         }
         if (handlers[evt]) {
-             for (var i=0;i<handlers[evt].length;i++) {
+             let cpyHandlers = [...handlers[evt]];
+          
+             for (var i=0;i<cpyHandlers.length;i++) {
                 try {
-                     handlers[evt][i].apply(null, args);
+                     cpyHandlers[i].apply(null, args);
                 } catch(err) {
                     console.warn("RED.events.emit error: ["+evt+"] "+(err.toString()));
                     console.warn(err);
                 }
             }
-
         }
     }
     return {
--- a/packages/node_modules/@node-red/editor-client/src/js/red.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/red.js
@@ -722,7 +722,7 @@ var RED = (function() {
        menuOptions.push({id:"menu-item-config-nodes",label:RED._("menu.label.displayConfig"),onselect:"core:show-config-tab"});
        menuOptions.push({id:"menu-item-workspace",label:RED._("menu.label.flows"),options:[
            {id:"menu-item-workspace-add",label:RED._("menu.label.add"),onselect:"core:add-flow"},
-            {id:"menu-item-workspace-edit",label:RED._("menu.label.rename"),onselect:"core:edit-flow"},
+            {id:"menu-item-workspace-edit",label:RED._("menu.label.edit"),onselect:"core:edit-flow"},
            {id:"menu-item-workspace-delete",label:RED._("menu.label.delete"),onselect:"core:remove-flow"}
        ]});
        menuOptions.push({id:"menu-item-subflow",label:RED._("menu.label.subflows"), options: [
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/palette.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/palette.js
@@ -484,7 +484,7 @@ RED.palette = (function() {
        var currentLabel = paletteNode.attr("data-palette-label");
        var currentInfo = paletteNode.attr("data-palette-info");

-        if (currentLabel !== sf.name || currentInfo !== sf.info) {
+        if (currentLabel !== sf.name || currentInfo !== sf.info || sf.in.length > 0 || sf.out.length > 0) {
            paletteNode.attr("data-palette-info",sf.info);
            setLabel(sf.type+":"+sf.id,paletteNode,sf.name,RED.utils.renderMarkdown(sf.info||""));
        }
--- a/packages/node_modules/@node-red/editor-client/templates/index.mst
+++ b/packages/node_modules/@node-red/editor-client/templates/index.mst
@@ -24,24 +24,24 @@
 <title>{{ page.title }}</title>
 <link rel="icon" type="image/png" href="{{ page.favicon }}">
 <link rel="mask-icon" href="{{ page.tabicon.icon }}" color="{{ page.tabicon.colour }}">
-<link rel="stylesheet" href="vendor/jquery/css/base/jquery-ui.min.css?v={{ page.version }}">
-<link rel="stylesheet" href="vendor/font-awesome/css/font-awesome.min.css?v={{ page.version }}">
-<link rel="stylesheet" href="red/style.min.css?v={{ page.version }}">
+<link rel="stylesheet" href="vendor/jquery/css/base/jquery-ui.min.css?v={{ cacheBuster }}">
+<link rel="stylesheet" href="vendor/font-awesome/css/font-awesome.min.css?v={{ cacheBuster }}">
+<link rel="stylesheet" href="red/style.min.css?v={{ cacheBuster }}">
 {{#page.css}}
 <link rel="stylesheet" href="{{.}}">
 {{/page.css}}
 {{#asset.vendorMonaco}}
-<link rel="stylesheet" href="vendor/monaco/style.css?v={{ page.version }}">
+<link rel="stylesheet" href="vendor/monaco/style.css?v={{ cacheBuster }}">
 {{/asset.vendorMonaco}}
 </head>
 <body spellcheck="false">
 <div id="red-ui-editor"></div>
-<script src="vendor/vendor.js?v={{ page.version }}"></script>
+<script src="vendor/vendor.js?v={{ cacheBuster }}"></script>
 {{#asset.vendorMonaco}}
-<script src="{{ asset.vendorMonaco }}?v={{ page.version }}"></script>
+<script src="{{ asset.vendorMonaco }}?v={{ cacheBuster }}"></script>
 {{/asset.vendorMonaco}}
-<script src="{{ asset.red }}?v={{ page.version }}"></script>
-<script src="{{ asset.main }}?v={{ page.version }}"></script>
+<script src="{{ asset.red }}?v={{ cacheBuster }}"></script>
+<script src="{{ asset.main }}?v={{ cacheBuster }}"></script>
 {{# page.scripts }}
 <script src="{{.}}"></script>
 {{/ page.scripts }}
--- a/packages/node_modules/@node-red/runtime/lib/index.js
+++ b/packages/node_modules/@node-red/runtime/lib/index.js
@@ -27,6 +27,7 @@ var express = require("express");
 var path = require('path');
 var fs = require("fs");
 var os = require("os");
+const crypto = require("crypto")

 const {log,i18n,events,exec,util,hooks} = require("@node-red/util");

@@ -51,7 +52,7 @@ var adminApi = {
 var nodeApp;
 var adminApp;
 var server;
-
+let userSettings;

 /**
 * Initialise the runtime module.
@@ -61,8 +62,9 @@ var server;
 *                              better abstracted.
 * @memberof @node-red/runtime
 */
-function init(userSettings,httpServer,_adminApi) {
+function init(_userSettings,httpServer,_adminApi) {
    server = httpServer;
+    userSettings = _userSettings

    if (server && server.on) {
        // Add a listener to the upgrade event so that we can properly timeout connection
@@ -134,7 +136,12 @@ function start() {
        .then(function() { return settings.load(storage)})
        .then(function() { return library.init(runtime)})
        .then(function() {
-
+            if (settings.available()) {
+                if (settings.get('instanceId') === undefined) {
+                    settings.set('instanceId', crypto.randomBytes(8).toString('hex'))
+                }
+                userSettings.instanceId = settings.get('instanceId') || ''
+            }
            if (log.metric()) {
                runtimeMetricInterval = setInterval(function() {
                    reportMetrics();
--- a/test/unit/@node-red/editor-api/lib/editor/ui_spec.js
+++ b/test/unit/@node-red/editor-api/lib/editor/ui_spec.js
@@ -29,7 +29,7 @@ describe("api/editor/ui", function() {
    var app;

    before(function() {
-        ui.init({
+        ui.init({}, {
            nodes: {
                getIcon: function(opts) {
                    return new Promise(function(resolve,reject) {
Author	SHA1	Message	Date
Nick O'Leary	d876146ea5	Guard settings access	2024-01-08 23:37:44 +00:00
Nick O'Leary	50627cd697	Generate instanceId and include in hash for cache busting	2024-01-08 23:27:14 +00:00
Nick O'Leary	d7345d5bc6	Restore caching busting functionality without using explict version number Fixes #4503	2024-01-05 23:14:00 +00:00
Nick O'Leary	f0a9b0cf69	Merge pull request #4506 from GogoVega/fix-4505-menu-flow-edit-label Replace `rename` by `edit` for the menu flow label	2024-01-05 21:00:29 +00:00
Nick O'Leary	26ddb5c1b7	Merge pull request #4502 from kazuhitoyokoi/master-fixsubflowports Fix location of subflow ports in palette	2024-01-05 20:59:45 +00:00
Nick O'Leary	82f8b64599	Merge pull request #4484 from gorenje/patch-2 Client/Editor Events: fix off-in-on pattern emulating once	2024-01-05 20:56:43 +00:00
GogoVega	7f24de442f	Replace 'rename' with 'edit' for the flow label	2024-01-01 15:33:39 +01:00
Kazuhito Yokoi	8365310ca7	Put the changed code on one line to avoid jshint error	2023-12-29 20:32:14 +09:00
Kazuhito Yokoi	74ff0599d1	Fix location of subflow ports in palette	2023-12-23 19:51:57 +09:00
Gerrit Riessen	e1f2e0656b	Client Events: fix off-in-on pattern emulating once This fixes an issue when RED.events.off(..) is called in a RED.events.on(..) callback: ``` let cb = () => { RED.events.off("event-name", cb) .... } RED.events.on("event-name", cb) ``` This pattern emulates a once(..), i.e., execute a callback once-only for an event. Discussed in [Forum](https://discourse.nodered.org/t/event-offing-an-on-event-to-perform-only-once/83726)	2023-12-15 10:54:11 +01:00