Rename serverPush to pushFromServer

Author: jgclark

jgclark.Dashboard/src/clickHandlers.js

@@ -524,9 +524,9 @@ export async function doDashboardSettingsChanged(data: MessageDataObject, settin
 
   // DataStore.settings = combinedUpdatedSettings
   const res = await saveSettings(pluginID, combinedUpdatedSettings)
-  const updatedPluginData = { [settingName]: newSettings } // was also: serverPush: { [settingName]: true }
+  const updatedPluginData = { [settingName]: newSettings } // was also: pushFromServer: { [settingName]: true }
   if (perspectivesToSave) {
-    // updatedPluginData.serverPush ? updatedPluginData.serverPush.perspectiveSettings = true
+    // updatedPluginData.pushFromServer ? updatedPluginData.pushFromServer.perspectiveSettings = true
     // $FlowFixMe(incompatible-type)
     updatedPluginData.perspectiveSettings = perspectivesToSave
   }

jgclark.Dashboard/src/perspectiveClickHandlers.js

@@ -188,7 +188,7 @@ export async function doSwitchToPerspective(data: MessageDataObject): Promise<TB
   const updatesToPluginData = {
     perspectiveSettings: revisedDefs,
     dashboardSettings: newDashboardSettings,
-    serverPush: { dashboardSettings: true, perspectiveSettings: true },
+    pushFromServer: { dashboardSettings: true, perspectiveSettings: true },
     sections: [],
     lastChange: `_Switched to perspective ${switchToName} ${dt()} changed from plugin`,
   }
@@ -232,7 +232,7 @@ export async function doPerspectiveSettingsChanged(data: MessageDataObject): Pro
   // after (potential) multi-editing in the PerspectivesTable, we need to clean the dashboardSettings for each perspective
   // because the tagsToShow may have been changed, so we need to clean out the showSection* vars
   const cleanedPerspSettings = newSettings.map((p) => ({ ...p, dashboardSettings: cleanDashboardSettingsInAPerspective(p.dashboardSettings) }))
-  const updatedPluginData = { perspectiveSettings: cleanedPerspSettings, dashboardSettings, serverPush: { perspectiveSettings: true, dashboardSettings: true } }
+  const updatedPluginData = { perspectiveSettings: cleanedPerspSettings, dashboardSettings, pushFromServer: { perspectiveSettings: true, dashboardSettings: true } }
   if (dashboardSettings.usePerspectives) {
     const currentPerspDef = getActivePerspectiveDef(cleanedPerspSettings)
     if (currentPerspDef && currentPerspDef.name !== '-') {

jgclark.Dashboard/src/react/customHooks/useSyncDashboardSettingsWithPlugin.js

@@ -34,7 +34,7 @@ export const useSyncDashboardSettingsWithPlugin = (
   pluginDataDSettings: any,
   dispatch: (action: DispatchAction) => void,
   sendActionToPlugin: SendActionToPlugin,
-  pluginData: TPluginData, // for tracking serverPush
+  pluginData: TPluginData, // for tracking pushFromServer
   updatePluginData: (data: any, msg: string) => void,
   compareFn: CompareFn = compareObjects,
 ) => {
@@ -45,7 +45,7 @@ export const useSyncDashboardSettingsWithPlugin = (
   useEffect(() => {
     const pluginDataDSettingsChanged = pluginDataDSettings && compareFn(lastpluginDataDSettingsRef.current, pluginDataDSettings) !== null
     logDebug(
-      `useSyncDashboardSettingsWithPlugin effect1 PLUGIN->REACT checking pluginData?.serverPush?.dashboardSettings=${String(pluginData?.serverPush?.dashboardSettings) || ''}`,
+      `useSyncDashboardSettingsWithPlugin effect1 PLUGIN->REACT checking pluginData?.pushFromServer?.dashboardSettings=${String(pluginData?.pushFromServer?.dashboardSettings) || ''}`,
     )
     if (pluginDataDSettingsChanged) {
       logDebug(
@@ -79,15 +79,15 @@ export const useSyncDashboardSettingsWithPlugin = (
         `useSyncDashboardSettingsWithPlugin dashboardSettings in REACT changed BB dashboardSettingsChanged: ${String(
           dashboardSettingsChanged,
         )} pluginData.perspectiveChanging:${String(pluginData.perspectiveChanging)}`,
-        { dashboardSettings, realDiff, serverPush: pluginData?.serverPush?.dashboardSettings },
+        { dashboardSettings, realDiff, pushFromServer: pluginData?.pushFromServer?.dashboardSettings },
       )
-      if (pluginData?.serverPush?.dashboardSettings) {
+      if (pluginData?.pushFromServer?.dashboardSettings) {
         logDebug(
-          `useSyncDashboardSettingsWithPlugin pluginData changed; serverPush=${JSON.stringify(
-            pluginData.serverPush,
-          )} changing serverPush.dashboardSettings to false; not sending to server`,
+          `useSyncDashboardSettingsWithPlugin pluginData changed; pushFromServer=${JSON.stringify(
+            pluginData.pushFromServer,
+          )} changing pushFromServer.dashboardSettings to false; not sending to server`,
         )
-        const newPluginData = { ...pluginData, serverPush: { ...pluginData.serverPush, dashboardSettings: false } }
+        const newPluginData = { ...pluginData, pushFromServer: { ...pluginData.pushFromServer, dashboardSettings: false } }
         updatePluginData(newPluginData, `acknowledging server push`)
         // was a server push so don't need to send to server
       } else {
@@ -117,12 +117,12 @@ export const useSyncDashboardSettingsWithPlugin = (
   }, [dashboardSettings, sendActionToPlugin, compareFn, pluginData])
 
   useEffect(() => {
-    if (pluginData.serverPush.dashboardSettings) {
-      logDebug(`useSyncDashboardSettingsWithPlugin pluginData.serverPush.dashboardSettings is true; resetting it`, {
+    if (pluginData.pushFromServer.dashboardSettings) {
+      logDebug(`useSyncDashboardSettingsWithPlugin pluginData.pushFromServer.dashboardSettings is true; resetting it`, {
         pluginData,
       })
-      const newPluginData = { ...pluginData, serverPush: { ...pluginData.serverPush, dashboardSettings: false } }
+      const newPluginData = { ...pluginData, pushFromServer: { ...pluginData.pushFromServer, dashboardSettings: false } }
       updatePluginData(newPluginData, `acknowledging server push`)
     }
-  }, [pluginData.serverPush.dashboardSettings])
+  }, [pluginData.pushFromServer.dashboardSettings])
 }

jgclark.Dashboard/src/reactMain.js

@@ -540,7 +540,7 @@ export async function getPluginData(dashboardSettings: TDashboardSettings, persp
     platform: NotePlan.environment.platform, // used in dialog positioning
     themeName: dashboardSettings.dashboardTheme ? dashboardSettings.dashboardTheme : Editor.currentTheme?.name || '<could not get theme>',
     version: pluginJson['plugin.version'],
-    serverPush: {
+    pushFromServer: {
       dashboardSettings: true,
       perspectiveSettings: true,
     },

jgclark.Dashboard/src/types.js

@@ -1,7 +1,7 @@
 // @flow
 //-----------------------------------------------------------------------------
 // Types for Dashboard code
-// Last updated 2025-05-15 for v2.3.0.b2, @jgclark
+// Last updated 2025-05-18 for v2.3.0, @jgclark
 //-----------------------------------------------------------------------------
 // Types for Settings
 
@@ -149,7 +149,7 @@ export type TSection = {
   actionButtons?: Array<TActionButton>,
   generatedDate?: Date, // note different from lastFullRefresh on whole project
   totalCount?: number, // for when not all possible items are passed in pluginData
-  doneCounts?: TDoneCount, // number of tasks and checklists completed today etc.
+  doneCounts?: TDoneCount, // number of tasks (and potentially checklists) completed in the relevant calendar note
   showColoredBackground?: boolean, // whether to show a colored background for the section
 }
 
@@ -379,8 +379,9 @@ export type TPluginData = {
   themeName: string /* the theme name used when generating the dashboard */,
   platform: string /* the platform used when generating the dashboard */,
   version: string /* version of this plugin */,
-  serverPush: {
-    /* see below for documentation */ dashboardSettings?: boolean,
+  pushFromServer: {
+    /* see below for documentation */
+    dashboardSettings?: boolean,
     perspectiveSettings?: boolean,
   },
   demoMode: boolean /* use fake content for demo/test purposes */,
@@ -389,11 +390,11 @@ export type TPluginData = {
 }
 
 /**
- * serverPush was designed especially for dashboardSettings, because dashboardSettings can change in the front-end (via user action) which then need to be noticed and sent to the back-end, or can be sent to the front end from the back-end (plugin) in which case they should just be accepted but not sent back to the plugin.
+ * pushFromServer was designed especially for dashboardSettings, because dashboardSettings can change in the front-end (via user action) which then need to be noticed and sent to the back-end, or can be sent to the front end from the back-end (plugin) in which case they should just be accepted but not sent back to the plugin.
  * Initially I was doing this with the  lastChange  message, and if that message started with a "_" it meant this is coming from the plugin and should not be sent back.
- * But that seemed too non-obvious. So I added this serverPush variable which is set when the plugin wants to send updates to the front-end but does not want those updates to be sent back erroneously.
+ * But that seemed too non-obvious. So I added this pushFromServer variable which is set when the plugin wants to send updates to the front-end but does not want those updates to be sent back erroneously.
  * Specifically,
- * - the initial data send in reactMain or the clickHandlers in clickHandlers and perspectiveClickHandlers set data that is changed and then set pluginData.serverPush.dashboardData = true  and send it to the front-end using setPluginData()
+ * - the initial data send in reactMain or the clickHandlers in clickHandlers and perspectiveClickHandlers set data that is changed and then set pluginData.pushFromServer.dashboardData = true  and send it to the front-end using setPluginData()
  * - the change is picked up by the first useEffect in useSyncDashboardSettingsWithPlugin and then that var is set to false and stored locally in pluginData without sending it back to the plugin
  */