Repository navigation
feat: [2312] Dashboard data store - Read from the store and remove the legacy datastore #2316
+414
−320
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,21 @@ | ||
| const { isClientScoped } = require('../utils/index.js') | ||
|
|
||
| const { createDataStore, attachToContext, MERGE_ENTRY, APPEND_ENTRY, SET_SERIES, TRIM_SERIES, ENTRY_MSG } = require('./reactive.js') | ||
|
|
||
| const config = { | ||
| RED: null | ||
| } | ||
|
|
||
| let storeOptions = {} | ||
| let fallbackStore = null | ||
| let storeContext = null | ||
| let storeBase = null | ||
| let warned = false | ||
|
|
||
| function warnOnce (problem) { | ||
| if (warned || !storeBase) return | ||
| warned = true | ||
| storeBase.warn(`Dashboard data store: ${problem}. Further store failures are not reported until the next full deploy or restart.`) | ||
| } | ||
|
|
||
| const attachOptions = () => ({ clone: config.RED.util.cloneMessage, ...storeOptions }) | ||
|
|
@@ -29,48 +27,28 @@ function getOrCreateStore (globalContext) { | |
| return store | ||
| } | ||
|
|
||
| function getStoreOrWarn (action, id) { | ||
| try { | ||
| return fallbackStore || getOrCreateStore(storeContext) | ||
| } catch (err) { warnOnce(`${action} ${id} failed (${err.message})`) } | ||
| } | ||
|
|
||
| function initStore (globalContext, { node, ...opts } = {}) { | ||
| storeOptions = opts | ||
| storeContext = globalContext | ||
| storeBase = node | ||
| warned = false | ||
| let store = null | ||
| try { | ||
| store = attachToContext(globalContext, attachOptions()) | ||
|
Contributor
There was a problem hiding this comment. Noticed something with a persistent context store (localfilesystem, cache: true). The store only gets written to disk when something else in global context is set, and then only the values go. After a restart my text input came back with its old value, which main never did, and the chart read back as
Contributor
Author
There was a problem hiding this comment. Yahh makes sense, went with starting fresh like main for now, which also fixes the chart coming back as #2322 also keeps a chart's messages in step with its points for flow writes. I do want state to eventually survive restarts, but it can be settled in the persistence work #2237 |
||
| } finally { | ||
| if (store) { | ||
| fallbackStore = null | ||
| } else if (!fallbackStore) { | ||
| fallbackStore = createDataStore(attachOptions()) | ||
| } | ||
| } | ||
| return store | ||
| } | ||
|
|
||
| function latestPerTopic (msgs, maxPoints) { | ||
|
|
@@ -120,26 +98,17 @@ function canSaveInStore (base, node, msg) { | |
| return checks.length === 0 || !checks.includes(false) | ||
| } | ||
|
|
||
| const getters = { | ||
| RED () { | ||
| return config.RED | ||
| }, | ||
| // given a widget id, return the latest msg received | ||
| msg (id) { | ||
| return config.RED.util.cloneMessage(getStoreOrWarn('reading', id)?.[ENTRY_MSG](id)) | ||
| }, | ||
| has (id) { | ||
| const store = getStoreOrWarn('reading', id) | ||
| return !!store && id in store | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -150,13 +119,10 @@ const setters = { | |
| }, | ||
| // remove data associated to a given widget | ||
| clear (id) { | ||
| const store = getStoreOrWarn('clearing', id) | ||
| if (store) { | ||
| delete store[id] | ||
| } | ||
| }, | ||
| /** | ||
| * | ||
|
|
@@ -166,35 +132,20 @@ const setters = { | |
| */ | ||
| save (base, node, msg) { | ||
| if (Array.isArray(msg)) { | ||
| const msgs = msg.filter((m) => canSaveInStore(base, node, m)) | ||
| if (msgs.every((m) => m && typeof m === 'object')) { | ||
| getStoreOrWarn('saving', node.id)?.[SET_SERIES](node.id, msgs) | ||
| } | ||
| } else if (msg && typeof msg === 'object' && canSaveInStore(base, node, msg)) { | ||
| const { ui_update: uiUpdate, ...rest } = msg | ||
| getStoreOrWarn('saving', node.id)?.[MERGE_ENTRY](node.id, rest) | ||
| } | ||
| }, | ||
| // given a widget id, and msg, store in an array of history of values | ||
| // useful for charting widgets | ||
| append (base, node, msg) { | ||
| if (msg && typeof msg === 'object' && canSaveInStore(base, node, msg)) { | ||
| getStoreOrWarn('saving', node.id)?.[APPEND_ENTRY](node.id, msg) | ||
| } | ||
| }, | ||
| /** | ||
|
|
@@ -204,28 +155,12 @@ const setters = { | |
| * @param {(msg) => Boolean} filterFunction | ||
| */ | ||
| filter (base, node, filterFunction) { | ||
| if (filterFunction) { | ||
| getStoreOrWarn('trimming', node.id)?.[TRIM_SERIES](node.id, (msgs) => msgs.filter(filterFunction)) | ||
| } | ||
| }, | ||
| keepLatestPerTopic (base, node, maxPoints) { | ||
| getStoreOrWarn('trimming', node.id)?.[TRIM_SERIES](node.id, (msgs) => latestPerTopic(msgs, maxPoints)) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -239,6 +174,5 @@ module.exports = { | |
| filter: setters.filter, | ||
| keepLatestPerTopic: setters.keepLatestPerTopic, | ||
| clear: setters.clear, | ||
| initStore | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works nicely. I tried cache: false and the dashboard kept its data through a full redeploy. Minor: the warning shows on every full deploy, which might get a bit noisy for those users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah good call fixed