This release includes the first small steps towards making Node-RED easier
+ to work with when you have multiple people editing flows at the same time.
+
When this feature is enabled, you will now see who else has the editor open and some
+ basic information on where they are in the editor.
+
Check the release post for details on how to enable this feature in your settings file.
Cette version inclut les premières étapes visant à rendre Node-RED plus facile à utiliser
+ lorsque plusieurs personnes modifient des flux en même temps.
+
Lorsque cette fonctionnalité est activée, vous pourrez désormais voir si d’autres utilisateurs ont
+ ouvert l'éditeur. Vous pourrez également savoir où ces utilisateurs se trouvent dans l'éditeur.
+
Consultez la note de publication pour plus de détails sur la façon d'activer cette fonctionnalité
+ dans votre fichier de paramètres.
If another user deploys changes whilst you are editing, we now use a more discrete notification
+ that doesn't stop you continuing your work - especially if they are being very productive and deploying lots
+ of changes.
Si un autre utilisateur déploie des modifications pendant que vous êtes en train de modifier, vous recevrez
+ une notification plus discrète qu'auparavant qui ne vous empêche pas de continuer votre travail.
When viewing changes made to a flow, Node-RED now distinguishes between nodes that have had configuration
+ changes and those that have only been moved.
+
When faced with a long list of changes to look at, this makes it much easier to focus on more significant items.
Lors de l'affichage des modifications apportées à un flux, Node-RED fait désormais la distinction entre les
+ noeuds qui ont changé de configuration et ceux qui ont seulement été déplacés.
+
Face à une longue liste de changements à examiner, il est beaucoup plus facile de se concentrer sur les éléments les
+ plus importants.
The Configuration node selection UI has had a small update to have a dedicated 'add' button
+ next to the select box.
+
It's a small change, but should make it easier to work with your config nodes.
`,
+ "ja": `
設定ノードを選択するUIが修正され、選択ボックスの隣に専用の「追加」ボタンが追加されました。
+
微修正ですが設定ノードの操作が容易になります。
`,
+ "fr": `
L'interface utilisateur de la sélection du noeud de configuration a fait l'objet d'une petite
+ mise à jour afin de disposer d'un bouton « Ajouter » à côté de la zone de sélection.
+
C'est un petit changement, mais cela devrait faciliter le travail avec vos noeuds de configuration.
Les entrées contextuelles flow/global et l'entrée env
+ incluent désormais des suggestions de saisie semi-automatique basées sur l'état actuel de vos flux.
+ `,
+ }
+ },
+ {
+ title: {
+ "en-US": "Config node customisation in Subflows",
+ "ja": "サブフローでの設定ノードのカスタマイズ",
+ "fr": "Personnalisation du noeud de configuration dans les sous-flux"
+ },
+ image: 'images/nr4-sf-config.png',
+ description: {
+ "en-US": `
Subflows can now be customised to allow each instance to use a different
+ config node of a selected type.
+
For example, each instance of a subflow that connects to an MQTT Broker and does some post-processing
+ of the messages received can be pointed at a different broker.
Les sous-flux peuvent désormais être personnalisés pour permettre à chaque instance d'utiliser un
+ noeud de configuration d'un type sélectionné.
+
Par exemple, chaque instance d'un sous-flux qui se connecte à un courtier MQTT et effectue un post-traitement
+ des messages reçus peut être pointée vers un autre courtier.
The palette now remembers what categories you have hidden between reloads - as well as any
+ filter you have applied.
`,
+ "ja": `
パレット上で非表示にしたカテゴリや適用したフィルタが、リロードしても記憶されるようになりました。
`,
+ "fr": `
La palette se souvient désormais des catégories que vous avez masquées entre les rechargements,
+ ainsi que le filtre que vous avez appliqué.
`
+ }
+ },
+ {
+ title: {
+ "en-US": "Plugins shown in the Palette Manager",
+ "ja": "パレット管理にプラグインを表示",
+ "fr": "Affichage des Plugins dans le gestionnaire de palettes"
+ },
+ image: 'images/nr4-plugins.png',
+ description: {
+ "en-US": `
The palette manager now shows any plugin modules you have installed, such as
+ node-red-debugger. Previously they would only be shown if the plugins include
+ nodes for the palette.
Le gestionnaire de palettes affiche désormais tous les plugins que vous avez installés,
+ tels que node-red-debugger. Auparavant, ils n'étaient affichés que s'ils contenaient
+ des noeuds pour la palette.
The core nodes have received lots of minor fixes, documentation updates and
+ small enhancements. Check the full changelog in the Help sidebar for a full list.
+
+
A fully RFC4180 compliant CSV mode
+
Customisable headers on the WebSocket node
+
Split node now can operate on any message property
Les noeuds principaux ont reçu de nombreux correctifs mineurs ainsi que des améliorations. La documentation a été mise à jour.
+ Consultez le journal des modifications dans la barre latérale d'aide pour une liste complète. Ci-dessous, les changements les plus importants :
+
+
Un mode CSV entièrement conforme à la norme RFC4180
+
En-têtes personnalisables pour le noeud WebSocket
+
Le noeud Split peut désormais fonctionner sur n'importe quelle propriété de message
This release includes the first small steps towards making Node-RED easier
- to work with when you have multiple people editing flows at the same time.
-
When this feature is enabled, you will now see who else has the editor open and some
- basic information on where they are in the editor.
-
Check the release post for details on how to enable this feature in your settings file.
Cette version inclut les premières étapes visant à rendre Node-RED plus facile à utiliser
- lorsque plusieurs personnes modifient des flux en même temps.
-
Lorsque cette fonctionnalité est activée, vous pourrez désormais voir si d’autres utilisateurs ont
- ouvert l'éditeur. Vous pourrez également savoir où ces utilisateurs se trouvent dans l'éditeur.
-
Consultez la note de publication pour plus de détails sur la façon d'activer cette fonctionnalité
- dans votre fichier de paramètres.
If another user deploys changes whilst you are editing, we now use a more discrete notification
- that doesn't stop you continuing your work - especially if they are being very productive and deploying lots
- of changes.
Si un autre utilisateur déploie des modifications pendant que vous êtes en train de modifier, vous recevrez
- une notification plus discrète qu'auparavant qui ne vous empêche pas de continuer votre travail.
When viewing changes made to a flow, Node-RED now distinguishes between nodes that have had configuration
- changes and those that have only been moved.
-
When faced with a long list of changes to look at, this makes it much easier to focus on more significant items.
Lors de l'affichage des modifications apportées à un flux, Node-RED fait désormais la distinction entre les
- noeuds qui ont changé de configuration et ceux qui ont seulement été déplacés.
-
Face à une longue liste de changements à examiner, il est beaucoup plus facile de se concentrer sur les éléments les
- plus importants.
The Configuration node selection UI has had a small update to have a dedicated 'add' button
- next to the select box.
-
It's a small change, but should make it easier to work with your config nodes.
`,
- "ja": `
設定ノードを選択するUIが修正され、選択ボックスの隣に専用の「追加」ボタンが追加されました。
-
微修正ですが設定ノードの操作が容易になります。
`,
- "fr": `
L'interface utilisateur de la sélection du noeud de configuration a fait l'objet d'une petite
- mise à jour afin de disposer d'un bouton « Ajouter » à côté de la zone de sélection.
-
C'est un petit changement, mais cela devrait faciliter le travail avec vos noeuds de configuration.
Les entrées contextuelles flow/global et l'entrée env
- incluent désormais des suggestions de saisie semi-automatique basées sur l'état actuel de vos flux.
- `,
- }
- },
- {
- title: {
- "en-US": "Config node customisation in Subflows",
- "ja": "サブフローでの設定ノードのカスタマイズ",
- "fr": "Personnalisation du noeud de configuration dans les sous-flux"
- },
- image: 'images/nr4-sf-config.png',
- description: {
- "en-US": `
Subflows can now be customised to allow each instance to use a different
- config node of a selected type.
-
For example, each instance of a subflow that connects to an MQTT Broker and does some post-processing
- of the messages received can be pointed at a different broker.
Les sous-flux peuvent désormais être personnalisés pour permettre à chaque instance d'utiliser un
- noeud de configuration d'un type sélectionné.
-
Par exemple, chaque instance d'un sous-flux qui se connecte à un courtier MQTT et effectue un post-traitement
- des messages reçus peut être pointée vers un autre courtier.
The palette now remembers what categories you have hidden between reloads - as well as any
- filter you have applied.
`,
- "ja": `
パレット上で非表示にしたカテゴリや適用したフィルタが、リロードしても記憶されるようになりました。
`,
- "fr": `
La palette se souvient désormais des catégories que vous avez masquées entre les rechargements,
- ainsi que le filtre que vous avez appliqué.
`
- }
- },
- {
- title: {
- "en-US": "Plugins shown in the Palette Manager",
- "ja": "パレット管理にプラグインを表示",
- "fr": "Affichage des Plugins dans le gestionnaire de palettes"
- },
- image: 'images/nr4-plugins.png',
- description: {
- "en-US": `
The palette manager now shows any plugin modules you have installed, such as
- node-red-debugger. Previously they would only be shown if the plugins include
- nodes for the palette.
Le gestionnaire de palettes affiche désormais tous les plugins que vous avez installés,
- tels que node-red-debugger. Auparavant, ils n'étaient affichés que s'ils contenaient
- des noeuds pour la palette.
The core nodes have received lots of minor fixes, documentation updates and
- small enhancements. Check the full changelog in the Help sidebar for a full list.
-
-
A fully RFC4180 compliant CSV mode
-
Customisable headers on the WebSocket node
-
Split node now can operate on any message property
Les noeuds principaux ont reçu de nombreux correctifs mineurs ainsi que des améliorations. La documentation a été mise à jour.
- Consultez le journal des modifications dans la barre latérale d'aide pour une liste complète. Ci-dessous, les changements les plus importants :
-
-
Un mode CSV entièrement conforme à la norme RFC4180
-
En-têtes personnalisables pour le noeud WebSocket
-
Le noeud Split peut désormais fonctionner sur n'importe quelle propriété de message
The core nodes have received lots of minor fixes, documentation updates and
+ // small enhancements. Check the full changelog in the Help sidebar for a full list.
+ //
+ //
A fully RFC4180 compliant CSV mode
+ //
Customisable headers on the WebSocket node
+ //
Split node now can operate on any message property
Les noeuds principaux ont reçu de nombreux correctifs mineurs ainsi que des améliorations. La documentation a été mise à jour.
+ // Consultez le journal des modifications dans la barre latérale d'aide pour une liste complète. Ci-dessous, les changements les plus importants :
+ //
+ //
Un mode CSV entièrement conforme à la norme RFC4180
+ //
En-têtes personnalisables pour le noeud WebSocket
+ //
Le noeud Split peut désormais fonctionner sur n'importe quelle propriété de message
+ //
Et bien plus encore...
+ //
`
+ // }
+ // }
]
}
diff --git a/packages/node_modules/@node-red/runtime/lib/api/settings.js b/packages/node_modules/@node-red/runtime/lib/api/settings.js
index 1aa335f1a..634f5dbf3 100644
--- a/packages/node_modules/@node-red/runtime/lib/api/settings.js
+++ b/packages/node_modules/@node-red/runtime/lib/api/settings.js
@@ -161,6 +161,8 @@ var api = module.exports = {
safeSettings.diagnostics.ui = false; // cannot have UI without endpoint
}
+ safeSettings.telemetryEnabled = runtime.telemetry.isEnabled()
+
safeSettings.runtimeState = {
//unless runtimeState.ui and runtimeState.enabled are explicitly true, they will default to false.
enabled: !!runtime.settings.runtimeState && runtime.settings.runtimeState.enabled === true,
@@ -213,7 +215,19 @@ var api = module.exports = {
}
var currentSettings = runtime.settings.getUserSettings(username)||{};
currentSettings = extend(currentSettings, opts.settings);
+
try {
+ if (currentSettings.hasOwnProperty("telemetryEnabled")) {
+ // This is a global setting that is being set by the user. It should
+ // not be stored per-user as it applies to the whole runtime.
+ const telemetryEnabled = currentSettings.telemetryEnabled;
+ delete currentSettings.telemetryEnabled;
+ if (telemetryEnabled) {
+ runtime.telemetry.enable()
+ } else {
+ runtime.telemetry.disable()
+ }
+ }
return runtime.settings.setUserSettings(username, currentSettings).then(function() {
runtime.log.audit({event: "settings.update",username:username}, opts.req);
return;
diff --git a/packages/node_modules/@node-red/runtime/lib/index.js b/packages/node_modules/@node-red/runtime/lib/index.js
index 4ac7cfb5b..3251ff2fa 100644
--- a/packages/node_modules/@node-red/runtime/lib/index.js
+++ b/packages/node_modules/@node-red/runtime/lib/index.js
@@ -23,6 +23,7 @@ var library = require("./library");
var plugins = require("./plugins");
var settings = require("./settings");
const multiplayer = require("./multiplayer");
+const telemetry = require("./telemetry");
var express = require("express");
var path = require('path');
@@ -135,6 +136,7 @@ function start() {
return i18n.registerMessageCatalog("runtime",path.resolve(path.join(__dirname,"..","locales")),"runtime.json")
.then(function() { return storage.init(runtime)})
.then(function() { return settings.load(storage)})
+ .then(function() { return telemetry.init(runtime)})
.then(function() { return library.init(runtime)})
.then(function() { return multiplayer.init(runtime)})
.then(function() {
@@ -337,6 +339,7 @@ var runtime = {
library: library,
exec: exec,
util: util,
+ telemetry: telemetry,
get adminApi() { return adminApi },
get adminApp() { return adminApp },
get nodeApp() { return nodeApp },
diff --git a/packages/node_modules/@node-red/runtime/lib/telemetry/index.js b/packages/node_modules/@node-red/runtime/lib/telemetry/index.js
new file mode 100644
index 000000000..3c9c5ce4d
--- /dev/null
+++ b/packages/node_modules/@node-red/runtime/lib/telemetry/index.js
@@ -0,0 +1,208 @@
+const path = require('path')
+const fs = require('fs/promises')
+const semver = require('semver')
+const cronosjs = require('cronosjs')
+
+const METRICS_DIR = path.join(__dirname, 'metrics')
+const INITIAL_PING_DELAY = 1000 * 60 * 30 // 30 minutes from startup
+
+let runtime
+
+let scheduleTask
+
+async function gather () {
+ let metricFiles = await fs.readdir(METRICS_DIR)
+ metricFiles = metricFiles.filter(name => /^\d+-.*\.js$/.test(name))
+ metricFiles.sort()
+
+ const metrics = {}
+
+ for (let i = 0, l = metricFiles.length; i < l; i++) {
+ const metricModule = require(path.join(METRICS_DIR, metricFiles[i]))
+ let result = metricModule(runtime)
+ if (!!result && (typeof result === 'object' || typeof result === 'function') && typeof result.then === 'function') {
+ result = await result
+ }
+ const keys = Object.keys(result)
+ keys.forEach(key => {
+ const keyParts = key.split('.')
+ let p = metrics
+ keyParts.forEach((part, index) => {
+ if (index < keyParts.length - 1) {
+ if (!p[part]) {
+ p[part] = {}
+ }
+ p = p[part]
+ } else {
+ p[part] = result[key]
+ }
+ })
+ })
+ }
+ return metrics
+}
+
+async function report () {
+ if (!isTelemetryEnabled()) {
+ return
+ }
+ // If enabled, gather metrics
+ const metrics = await gather()
+ console.log(JSON.stringify(metrics, null, 2))
+
+ // Post metrics to endpoint - handle any error silently
+
+ const { got } = await import('got')
+ runtime.log.debug('Sending telemetry')
+ const response = await got.post('https://telemetry.nodered.org/ping', {
+ json: metrics,
+ responseType: 'json',
+ headers: {
+ 'User-Agent': `Node-RED/${runtime.settings.version}`
+ }
+ }).json().catch(err => {
+ // swallow errors
+ runtime.log.debug('Failed to send telemetry: ' + err.toString())
+ })
+ // Example response:
+ // { 'node-red': { latest: '4.0.9', next: '4.1.0-beta.1.9' } }
+ runtime.log.debug(`Telemetry response: ${JSON.stringify(response)}`)
+ // Get response from endpoint
+ if (response?.['node-red']) {
+ const currentVersion = metrics.env['node-red']
+ if (semver.valid(currentVersion)) {
+ const latest = response['node-red'].latest
+ const next = response['node-red'].next
+ let updatePayload
+ if (semver.lt(currentVersion, latest)) {
+ // Case one: current < latest
+ runtime.log.info(`A new version of Node-RED is available: ${latest}`)
+ updatePayload = { version: latest }
+ } else if (semver.gt(currentVersion, latest) && semver.lt(currentVersion, next)) {
+ // Case two: current > latest && current < next
+ runtime.log.info(`A new beta version of Node-RED is available: ${next}`)
+ updatePayload = { version: next }
+ }
+
+ if (updatePayload && isUpdateNotificationEnabled()) {
+ runtime.events.emit("runtime-event",{id:"update-available", payload: updatePayload, retain: true});
+ }
+ }
+ }
+}
+
+function isTelemetryEnabled () {
+ // If NODE_RED_DISABLE_TELEMETRY was set, or --no-telemetry was specified,
+ // the settings object will have been updated to disable telemetry explicitly
+
+ // If there are no telemetry settings then the user has not had a chance
+ // to opt out yet - so keep it disabled until they do
+
+ let telemetrySettings
+ try {
+ telemetrySettings = runtime.settings.get('telemetry')
+ } catch (err) {
+ // Settings not available
+ }
+ let runtimeTelemetryEnabled
+ try {
+ runtimeTelemetryEnabled = runtime.settings.get('telemetryEnabled')
+ } catch (err) {
+ // Settings not available
+ }
+
+ if (telemetrySettings === undefined && runtimeTelemetryEnabled === undefined) {
+ // No telemetry settings - so keep it disabled
+ return undefined
+ }
+
+ // User has made a choice; defer to that
+ if (runtimeTelemetryEnabled !== undefined) {
+ return runtimeTelemetryEnabled
+ }
+
+ // If there are telemetry settings, use what it says
+ if (telemetrySettings && telemetrySettings.enabled !== undefined) {
+ return telemetrySettings.enabled
+ }
+
+ // At this point, we have no sign the user has consented to telemetry, so
+ // keep disabled - but return undefined as a false-like value to distinguish
+ // it from the explicit disable above
+ return undefined
+}
+
+function isUpdateNotificationEnabled () {
+ const telemetrySettings = runtime.settings.get('telemetry') || {}
+ return telemetrySettings.updateNotification !== false
+}
+/**
+ * Start the telemetry schedule
+ */
+function startTelemetry () {
+ if (scheduleTask) {
+ // Already scheduled - nothing left to do
+ return
+ }
+
+ const pingTime = new Date(Date.now() + INITIAL_PING_DELAY)
+ const pingMinutes = pingTime.getMinutes()
+ const pingHours = pingTime.getHours()
+ const pingSchedule = `${pingMinutes} ${pingHours} * * *`
+
+ runtime.log.debug(`Telemetry enabled. Schedule: ${pingSchedule}`)
+
+ scheduleTask = cronosjs.scheduleTask(pingSchedule, () => {
+ report()
+ })
+}
+
+function stopTelemetry () {
+ if (scheduleTask) {
+ runtime.log.debug(`Telemetry disabled`)
+ scheduleTask.stop()
+ scheduleTask = null
+ }
+}
+
+module.exports = {
+ init: (_runtime) => {
+ runtime = _runtime
+
+ if (isTelemetryEnabled()) {
+ startTelemetry()
+ }
+ },
+ /**
+ * Enable telemetry via user opt-in in the editor
+ */
+ enable: () => {
+ if (runtime.settings.available()) {
+ runtime.settings.set('telemetryEnabled', true)
+ }
+ startTelemetry()
+ },
+
+ /**
+ * Disable telemetry via user opt-in in the editor
+ */
+ disable: () => {
+ if (runtime.settings.available()) {
+ runtime.settings.set('telemetryEnabled', false)
+ }
+ stopTelemetry()
+ },
+
+ /**
+ * Get telemetry enabled status
+ * @returns {boolean} true if telemetry is enabled, false if disabled, undefined if not set
+ */
+ isEnabled: isTelemetryEnabled,
+
+ stop: () => {
+ if (scheduleTask) {
+ scheduleTask.stop()
+ scheduleTask = null
+ }
+ }
+}
\ No newline at end of file
diff --git a/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/01-core.js b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/01-core.js
new file mode 100644
index 000000000..acac829fb
--- /dev/null
+++ b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/01-core.js
@@ -0,0 +1,5 @@
+module.exports = (runtime) => {
+ return {
+ instanceId: runtime.settings.get('instanceId')
+ }
+}
diff --git a/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/02-os.js b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/02-os.js
new file mode 100644
index 000000000..ae2a31859
--- /dev/null
+++ b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/02-os.js
@@ -0,0 +1,9 @@
+const os = require('os')
+
+module.exports = (_) => {
+ return {
+ 'os.type': os.type(),
+ 'os.release': os.release(),
+ 'os.arch': os.arch()
+ }
+}
diff --git a/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/03-env.js b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/03-env.js
new file mode 100644
index 000000000..173adc752
--- /dev/null
+++ b/packages/node_modules/@node-red/runtime/lib/telemetry/metrics/03-env.js
@@ -0,0 +1,8 @@
+const process = require('process')
+
+module.exports = (runtime) => {
+ return {
+ 'env.nodejs': process.version.replace(/^v/, ''),
+ 'env.node-red': runtime.settings.version
+ }
+}
diff --git a/packages/node_modules/@node-red/runtime/package.json b/packages/node_modules/@node-red/runtime/package.json
index e6f1ca0d0..03ef360d2 100644
--- a/packages/node_modules/@node-red/runtime/package.json
+++ b/packages/node_modules/@node-red/runtime/package.json
@@ -20,9 +20,11 @@
"@node-red/util": "4.1.0-beta.0",
"async-mutex": "0.5.0",
"clone": "2.1.2",
+ "cronosjs": "1.7.1",
"express": "4.21.2",
"fs-extra": "11.3.0",
"json-stringify-safe": "5.0.1",
- "rfdc": "^1.3.1"
+ "rfdc": "^1.3.1",
+ "semver": "7.7.1"
}
}
diff --git a/packages/node_modules/node-red/red.js b/packages/node_modules/node-red/red.js
index 5f3c9da25..d98b69f8f 100755
--- a/packages/node_modules/node-red/red.js
+++ b/packages/node_modules/node-red/red.js
@@ -63,7 +63,8 @@ var knownOpts = {
"verbose": Boolean,
"safe": Boolean,
"version": Boolean,
- "define": [String, Array]
+ "define": [String, Array],
+ "no-telemetry": Boolean
};
var shortHands = {
"?":["--help"],
@@ -97,6 +98,7 @@ if (parsedArgs.help) {
console.log(" --safe enable safe mode");
console.log(" -D, --define X=Y overwrite value in settings file");
console.log(" --version show version information");
+ console.log(" --no-telemetry do not share usage data with the Node-RED project");
console.log(" -?, --help show this help");
console.log(" admin run an admin command");
console.log("");
@@ -222,6 +224,10 @@ if (process.env.NODE_RED_ENABLE_TOURS) {
settings.editorTheme.tours = !/^false$/i.test(process.env.NODE_RED_ENABLE_TOURS);
}
+if (parsedArgs.telemetry === false || process.env.NODE_RED_DISABLE_TELEMETRY) {
+ settings.telemetry = settings.telemetry || {};
+ settings.telemetry.enabled = false;
+}
var defaultServerSettings = {
"x-powered-by": false
diff --git a/packages/node_modules/node-red/settings.js b/packages/node_modules/node-red/settings.js
index e8bb01228..5c4ce0e94 100644
--- a/packages/node_modules/node-red/settings.js
+++ b/packages/node_modules/node-red/settings.js
@@ -273,6 +273,7 @@ module.exports = {
* Runtime Settings
* - lang
* - runtimeState
+ * - telemetry
* - diagnostics
* - logging
* - contextStorage
@@ -311,6 +312,22 @@ module.exports = {
/** show or hide runtime stop/start options in the node-red editor. Must be set to `false` to hide */
ui: false,
},
+ telemetry: {
+ /**
+ * By default, telemetry is disabled until the user provides consent the first
+ * time they open the editor.
+ *
+ * The following property can be uncommented and set to true/false to enable/disable
+ * telemetry without seeking further consent in the editor.
+ * The user can override this setting via the user settings dialog within the editor
+ */
+ // enabled: true,
+ /**
+ * If telemetry is enabled, the editor will notify the user if a new version of Node-RED
+ * is available. Set the following property to false to disable this notification.
+ */
+ // updateNotification: true
+ },
/** Configure the logging output */
logging: {
/** Only console logging is currently supported */
diff --git a/test/unit/@node-red/runtime/lib/api/settings_spec.js b/test/unit/@node-red/runtime/lib/api/settings_spec.js
index 9b3b94229..0e9e20422 100644
--- a/test/unit/@node-red/runtime/lib/api/settings_spec.js
+++ b/test/unit/@node-red/runtime/lib/api/settings_spec.js
@@ -57,7 +57,8 @@ describe("runtime-api/settings", function() {
getCredentialKeyType: () => "test-key-type"
},
library: {getLibraries: () => ["lib1"] },
- storage: {}
+ storage: {},
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({}).then(result => {
result.should.have.property("httpNodeRoot","testHttpNodeRoot");
@@ -96,7 +97,8 @@ describe("runtime-api/settings", function() {
getCredentialKeyType: () => "test-key-type"
},
library: {getLibraries: () => { ["lib1"]} },
- storage: {}
+ storage: {},
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({
user: {
@@ -145,7 +147,8 @@ describe("runtime-api/settings", function() {
getCredentialsFilename: () => 'test-creds-file',
getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}}
}
- }
+ },
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({
user: {
@@ -202,7 +205,8 @@ describe("runtime-api/settings", function() {
getCredentialsFilename: () => 'test-creds-file',
getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}}
}
- }
+ },
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({
user: {
@@ -250,7 +254,8 @@ describe("runtime-api/settings", function() {
getCredentialsFilename: () => 'test-creds-file',
getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}}
}
- }
+ },
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({
user: {
@@ -301,7 +306,8 @@ describe("runtime-api/settings", function() {
getCredentialsFilename: () => 'test-creds-file',
getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}}
}
- }
+ },
+ telemetry: { isEnabled: () => true }
})
return settings.getRuntimeSettings({
user: {
diff --git a/test/unit/@node-red/runtime/lib/telemetry/index_spec.js b/test/unit/@node-red/runtime/lib/telemetry/index_spec.js
new file mode 100644
index 000000000..7ab1b89d1
--- /dev/null
+++ b/test/unit/@node-red/runtime/lib/telemetry/index_spec.js
@@ -0,0 +1,96 @@
+const should = require("should");
+const NR_TEST_UTILS = require("nr-test-utils");
+
+const telemetryApi = NR_TEST_UTILS.require("@node-red/runtime/lib/telemetry/index");
+
+describe("telemetry", function() {
+
+ afterEach(function () {
+ telemetryApi.stop()
+ messages = []
+ })
+
+ let messages = []
+
+ function getMockRuntime(settings) {
+ return {
+ settings: {
+ get: key => { return settings[key] },
+ set: (key, value) => { settings[key] = value },
+ available: () => true,
+ },
+ log: {
+ debug: (msg) => { messages.push(msg)}
+ }
+ }
+ }
+
+ // Principles to test:
+ // - No settings at all; disable telemetry
+ // - Runtime settings only; do what it says
+ // - User settings take precedence over runtime settings
+
+ it('Disables telemetry with no settings present', function () {
+ telemetryApi.init(getMockRuntime({}))
+ messages.should.have.length(0)
+ // Returns undefined as we don't know either way
+ ;(telemetryApi.isEnabled() === undefined).should.be.true()
+ })
+ it('Runtime settings - enable', function () {
+ // Enabled in runtime settings
+ telemetryApi.init(getMockRuntime({
+ telemetry: { enabled: true }
+ }))
+ telemetryApi.isEnabled().should.be.true()
+ messages.should.have.length(1)
+ ;/Telemetry enabled/.test(messages[0]).should.be.true()
+ })
+ it('Runtime settings - disable', function () {
+ telemetryApi.init(getMockRuntime({
+ telemetry: { enabled: false },
+ }))
+ // Returns false, not undefined
+ telemetryApi.isEnabled().should.be.false()
+ messages.should.have.length(0)
+ })
+
+ it('User settings - enable overrides runtime settings', function () {
+ telemetryApi.init(getMockRuntime({
+ telemetry: { enabled: false },
+ telemetryEnabled: true
+ }))
+ telemetryApi.isEnabled().should.be.true()
+ messages.should.have.length(1)
+ ;/Telemetry enabled/.test(messages[0]).should.be.true()
+ })
+
+ it('User settings - disable overrides runtime settings', function () {
+ telemetryApi.init(getMockRuntime({
+ telemetry: { enabled: true },
+ telemetryEnabled: false
+ }))
+ telemetryApi.isEnabled().should.be.false()
+ messages.should.have.length(0)
+ })
+
+ it('Can enable/disable telemetry', function () {
+ const settings = {}
+ telemetryApi.init(getMockRuntime(settings))
+ ;(telemetryApi.isEnabled() === undefined).should.be.true()
+
+ telemetryApi.enable()
+
+ telemetryApi.isEnabled().should.be.true()
+ messages.should.have.length(1)
+ ;/Telemetry enabled/.test(messages[0]).should.be.true()
+ settings.should.have.property('telemetryEnabled', true)
+
+ telemetryApi.disable()
+
+ telemetryApi.isEnabled().should.be.false()
+ messages.should.have.length(2)
+ ;/Telemetry disabled/.test(messages[1]).should.be.true()
+ settings.should.have.property('telemetryEnabled', false)
+
+ })
+})
\ No newline at end of file
diff --git a/test/unit/@node-red/runtime/lib/telemetry/metrics/01-core_spec.js b/test/unit/@node-red/runtime/lib/telemetry/metrics/01-core_spec.js
new file mode 100644
index 000000000..d1e012e5a
--- /dev/null
+++ b/test/unit/@node-red/runtime/lib/telemetry/metrics/01-core_spec.js
@@ -0,0 +1,16 @@
+const should = require("should");
+const NR_TEST_UTILS = require("nr-test-utils");
+
+const api = NR_TEST_UTILS.require("@node-red/runtime/lib/telemetry/metrics/01-core");
+
+describe("telemetry metrics/01-core", function() {
+
+ it('reports core metrics', function () {
+ const result = api({
+ settings: {
+ get: key => { return {instanceId: "1234"}[key]}
+ }
+ })
+ result.should.have.property("instanceId", "1234")
+ })
+})
\ No newline at end of file
diff --git a/test/unit/@node-red/runtime/lib/telemetry/metrics/02-os_spec.js b/test/unit/@node-red/runtime/lib/telemetry/metrics/02-os_spec.js
new file mode 100644
index 000000000..77a4b60af
--- /dev/null
+++ b/test/unit/@node-red/runtime/lib/telemetry/metrics/02-os_spec.js
@@ -0,0 +1,14 @@
+const should = require("should");
+const NR_TEST_UTILS = require("nr-test-utils");
+
+const api = NR_TEST_UTILS.require("@node-red/runtime/lib/telemetry/metrics/02-os");
+
+describe("telemetry metrics/02-os", function() {
+
+ it('reports os metrics', function () {
+ const result = api()
+ result.should.have.property("os.type")
+ result.should.have.property("os.release")
+ result.should.have.property("os.arch")
+ })
+})
\ No newline at end of file
diff --git a/test/unit/@node-red/runtime/lib/telemetry/metrics/03-env_spec.js b/test/unit/@node-red/runtime/lib/telemetry/metrics/03-env_spec.js
new file mode 100644
index 000000000..eff539270
--- /dev/null
+++ b/test/unit/@node-red/runtime/lib/telemetry/metrics/03-env_spec.js
@@ -0,0 +1,17 @@
+const should = require("should");
+const NR_TEST_UTILS = require("nr-test-utils");
+
+const api = NR_TEST_UTILS.require("@node-red/runtime/lib/telemetry/metrics/03-env");
+
+describe("telemetry metrics/03-env", function() {
+
+ it('reports env metrics', function () {
+ const result = api({
+ settings: {
+ version: '1.2.3'
+ }
+ })
+ result.should.have.property("env.nodejs", process.version.replace(/^v/, ''))
+ result.should.have.property("env.node-red", '1.2.3')
+ })
+})
\ No newline at end of file