From c6d0e225dc2b2a962f613f6a2db68d66f7baf37e Mon Sep 17 00:00:00 2001
From: Maciej Bodek <maciej.bodek@gmail.com>
Date: Fri, 6 Dec 2024 09:48:19 +0100
Subject: [PATCH] Refactor listeners, simplify, cleanup

---
 .../web-console/src/modules/EventBus/types.ts |   2 +
 .../src/scenes/Editor/Metrics/index.tsx       | 117 ++++++++++++++----
 .../src/scenes/Editor/Metrics/metric.tsx      |  77 +-----------
 .../web-console/src/scenes/Layout/index.tsx   |  23 +++-
 4 files changed, 122 insertions(+), 97 deletions(-)

diff --git a/packages/web-console/src/modules/EventBus/types.ts b/packages/web-console/src/modules/EventBus/types.ts
index e9a013475..c05e7bd1a 100644
--- a/packages/web-console/src/modules/EventBus/types.ts
+++ b/packages/web-console/src/modules/EventBus/types.ts
@@ -17,4 +17,6 @@ export enum EventType {
   MSG_CONNECTION_UNAUTHORIZED = "query.connection.unauthorized",
   MSG_CONNECTION_FORBIDDEN = "query.connection.forbidden",
   REACT_READY = "react.ready",
+  TAB_FOCUS = "tab.focus",
+  TAB_BLUR = "tab.blur",
 }
diff --git a/packages/web-console/src/scenes/Editor/Metrics/index.tsx b/packages/web-console/src/scenes/Editor/Metrics/index.tsx
index 9b1721d30..dad4d8d4d 100644
--- a/packages/web-console/src/scenes/Editor/Metrics/index.tsx
+++ b/packages/web-console/src/scenes/Editor/Metrics/index.tsx
@@ -1,9 +1,14 @@
-import React, { useEffect, useState, useMemo } from "react"
+import React, { useCallback, useEffect, useState } from "react"
 import styled from "styled-components"
 import { Box, Button, Select } from "@questdb/react-components"
 import { Text, Link } from "../../../components"
 import { useEditor } from "../../../providers"
-import { MetricDuration, RefreshRate, autoRefreshRates } from "./utils"
+import {
+  MetricDuration,
+  RefreshRate,
+  autoRefreshRates,
+  refreshRates,
+} from "./utils"
 import { Time, Refresh } from "@styled-icons/boxicons-regular"
 import { AddMetricDialog } from "./add-metric-dialog"
 import type { Metric } from "../../../store/buffers"
@@ -15,6 +20,9 @@ import merge from "lodash.merge"
 import { AddChart } from "@styled-icons/material"
 import { getLocalTimeZone } from "../../../utils/dateTime"
 import { IconWithTooltip } from "../../../components/IconWithTooltip"
+import { useLocalStorage } from "../../../providers/LocalStorageProvider"
+import { eventBus } from "../../../modules/EventBus"
+import { EventType } from "../../../modules/EventBus/types"
 
 const Root = styled.div`
   display: flex;
@@ -87,14 +95,21 @@ const formatRefreshRateLabel = (
 
 export const Metrics = () => {
   const { activeBuffer, updateBuffer, buffers } = useEditor()
+
   const [metricDuration, setMetricDuration] = useState<MetricDuration>(
     MetricDuration.ONE_HOUR,
   )
-  const [refreshRate, setRefreshRate] = useState<RefreshRate>(RefreshRate.AUTO)
+  const [refreshRate, setRefreshRate] = useState<RefreshRate>()
   const [dialogOpen, setDialogOpen] = useState(false)
   const [metrics, setMetrics] = useState<Metric[]>([])
   const telemetryConfig = useSelector(selectors.telemetry.getConfig)
-  const [lastRefresh, setLastRefresh] = useState<number | undefined>()
+  const [lastRefresh, setLastRefresh] = useState<number>(new Date().getTime())
+
+  const tabInFocusRef = React.useRef<boolean>(true)
+  const refreshRateRef = React.useRef<RefreshRate>()
+  const intervalRef = React.useRef<NodeJS.Timeout>()
+
+  const { autoRefreshTables } = useLocalStorage()
 
   const buffer = buffers.find((b) => b.id === activeBuffer?.id)
 
@@ -139,6 +154,29 @@ export const Metrics = () => {
     }
   }
 
+  const focusListener = useCallback(() => {
+    tabInFocusRef.current = true
+    if (refreshRateRef.current !== RefreshRate.OFF) {
+      setLastRefresh(new Date().getTime())
+    }
+  }, [refreshRateRef.current])
+
+  const setupListeners = () => {
+    if (autoRefreshTables && refreshRate && refreshRate !== RefreshRate.OFF) {
+      intervalRef.current = setInterval(
+        () => {
+          if (!tabInFocusRef.current) return
+          setLastRefresh(new Date().getTime())
+        },
+        refreshRate === RefreshRate.AUTO
+          ? refreshRates[autoRefreshRates[metricDuration]]
+          : refreshRates[refreshRate],
+      )
+    } else {
+      clearInterval(intervalRef.current)
+    }
+  }
+
   useEffect(() => {
     if (buffer) {
       const metrics = buffer?.metricsViewState?.metrics
@@ -169,9 +207,29 @@ export const Metrics = () => {
         },
       })
       updateBuffer(buffer.id, merged)
+
+      setLastRefresh(new Date().getTime())
     }
   }, [metricDuration, refreshRate])
 
+  useEffect(() => {
+    if (refreshRate) {
+      refreshRateRef.current = refreshRate
+      setupListeners()
+    }
+  }, [refreshRate])
+
+  useEffect(() => {
+    eventBus.subscribe(EventType.TAB_FOCUS, focusListener)
+    eventBus.subscribe(EventType.TAB_BLUR, () => {
+      tabInFocusRef.current = false
+    })
+
+    return () => {
+      eventBus.unsubscribe(EventType.TAB_FOCUS, focusListener)
+    }
+  }, [])
+
   if (telemetryConfig && !telemetryConfig.enabled) {
     return (
       <Root>
@@ -227,27 +285,41 @@ export const Metrics = () => {
               tooltip="Refresh all widgets"
               placement="bottom"
             />
-            <Select
-              name="refresh_rate"
-              value={refreshRate}
-              options={Object.values(RefreshRate).map((rate) => ({
-                label: formatRefreshRateLabel(rate, metricDuration),
-                value: rate,
-              }))}
-              onChange={(e) => setRefreshRate(e.target.value as RefreshRate)}
+            <IconWithTooltip
+              icon={
+                <Select
+                  name="refresh_rate"
+                  value={refreshRate}
+                  options={Object.values(RefreshRate).map((rate) => ({
+                    label: formatRefreshRateLabel(rate, metricDuration),
+                    value: rate,
+                  }))}
+                  onChange={(e) =>
+                    setRefreshRate(e.target.value as RefreshRate)
+                  }
+                />
+              }
+              tooltip="Widget refresh rate"
+              placement="bottom"
             />
           </Box>
-          <Select
-            name="duration"
-            value={metricDuration}
-            options={Object.values(MetricDuration).map((duration) => ({
-              label: formatDurationLabel(duration),
-              value: duration,
-            }))}
-            onChange={(e) =>
-              setMetricDuration(e.target.value as MetricDuration)
+          <IconWithTooltip
+            icon={
+              <Select
+                name="duration"
+                value={metricDuration}
+                options={Object.values(MetricDuration).map((duration) => ({
+                  label: formatDurationLabel(duration),
+                  value: duration,
+                }))}
+                onChange={(e) =>
+                  setMetricDuration(e.target.value as MetricDuration)
+                }
+                prefixIcon={<Time size="18px" />}
+              />
             }
-            prefixIcon={<Time size="18px" />}
+            tooltip="Time duration"
+            placement="bottom"
           />
         </Box>
       </Toolbar>
@@ -274,7 +346,6 @@ export const Metrics = () => {
                 key={index}
                 metric={metric}
                 metricDuration={metricDuration}
-                refreshRate={refreshRate}
                 onRemove={handleRemoveMetric}
                 onTableChange={handleTableChange}
                 onColorChange={handleColorChange}
diff --git a/packages/web-console/src/scenes/Editor/Metrics/metric.tsx b/packages/web-console/src/scenes/Editor/Metrics/metric.tsx
index 9eb29ec3e..f2e0a0d96 100644
--- a/packages/web-console/src/scenes/Editor/Metrics/metric.tsx
+++ b/packages/web-console/src/scenes/Editor/Metrics/metric.tsx
@@ -1,10 +1,4 @@
-import React, {
-  useEffect,
-  useState,
-  useContext,
-  useCallback,
-  useRef,
-} from "react"
+import React, { useEffect, useState, useContext } from "react"
 import { Metric as MetricItem } from "../../../store/buffers"
 import {
   durationInMinutes,
@@ -12,9 +6,6 @@ import {
   MetricType,
   LastNotNull,
   ResultType,
-  RefreshRate,
-  refreshRates,
-  autoRefreshRates,
 } from "./utils"
 import { widgets } from "./widgets"
 import { QuestContext } from "../../../providers"
@@ -26,7 +17,6 @@ import { Box, Button, ForwardRef, Popover } from "@questdb/react-components"
 import { Error, Palette, Trash } from "@styled-icons/boxicons-regular"
 import { useSelector } from "react-redux"
 import { selectors } from "../../../store"
-import { useLocalStorage } from "../../../providers/LocalStorageProvider"
 import { TableSelector } from "./table-selector"
 import { IconWithTooltip } from "../../../components/IconWithTooltip"
 import { ColorPalette } from "./color-palette"
@@ -48,7 +38,6 @@ const ActionButton = styled(Button)`
 export const Metric = ({
   metric,
   metricDuration,
-  refreshRate,
   onRemove,
   onTableChange,
   onColorChange,
@@ -57,7 +46,6 @@ export const Metric = ({
 }: {
   metric: MetricItem
   metricDuration: MetricDuration
-  refreshRate: RefreshRate
   onRemove: (metric: MetricItem) => void
   onTableChange: (metric: MetricItem, tableId: number) => void
   onColorChange: (metric: MetricItem, color: string) => void
@@ -69,16 +57,9 @@ export const Metric = ({
   const [data, setData] = useState<uPlot.AlignedData>()
   const [lastNotNull, setLastNotNull] = useState<number>()
   const [colorPickerOpen, setColorPickerOpen] = useState(false)
-  const metricDurationRef = useRef(metricDuration)
 
   const tables = useSelector(selectors.query.getTables)
 
-  const intervalRef = React.useRef<NodeJS.Timeout>()
-  const focusListenerRef = React.useRef(false)
-  const refreshRateRef = useRef<RefreshRate>(refreshRate)
-
-  const { autoRefreshTables } = useLocalStorage()
-
   const widgetConfig = widgets[metric.metricType]
 
   const minuteDurations: [MetricDuration, number][] = Object.entries(
@@ -95,7 +76,7 @@ export const Metric = ({
         quest.query<ResultType[MetricType]>(
           widgetConfig.getQuery({
             tableId: metric.tableId,
-            metricDuration: metricDurationRef.current,
+            metricDuration: metricDuration,
           }),
         ),
         quest.query<LastNotNull>(
@@ -134,61 +115,11 @@ export const Metric = ({
     }
   }
 
-  const setupListeners = () => {
-    if (autoRefreshTables) {
-      if (refreshRate === RefreshRate.OFF) {
-        clearInterval(intervalRef.current)
-      } else {
-        intervalRef.current = setInterval(
-          () => fetchMetric(),
-          refreshRate === RefreshRate.AUTO
-            ? refreshRates[autoRefreshRates[metricDuration]]
-            : refreshRates[refreshRate],
-        )
-      }
-      window.addEventListener("focus", focusListener)
-      focusListenerRef.current = true
-    } else {
-      clearInterval(intervalRef.current)
-      window.removeEventListener("focus", focusListener)
-      focusListenerRef.current = false
-    }
-  }
-
-  useEffect(() => {
-    metricDurationRef.current = metricDuration
-    refreshRateRef.current = refreshRate
-
-    if (metric.tableId) {
-      fetchMetric()
-      setupListeners()
-    }
-
-    return () => {
-      if (intervalRef.current) {
-        clearInterval(intervalRef.current)
-      }
-      if (focusListenerRef.current) {
-        window.removeEventListener("focus", focusListener)
-        focusListenerRef.current = false
-      }
-    }
-  }, [autoRefreshTables, metricDuration, metric.tableId, refreshRate])
-
-  const focusListener = useCallback(() => {
-    if (
-      focusListenerRef.current &&
-      refreshRateRef.current !== RefreshRate.OFF
-    ) {
-      fetchMetric()
-    }
-  }, [metric.tableId, refreshRateRef.current])
-
   useEffect(() => {
-    if (lastRefresh) {
+    if (lastRefresh || metric.tableId) {
       fetchMetric()
     }
-  }, [lastRefresh])
+  }, [lastRefresh, metric.tableId])
 
   if (!data && !loading && metric.tableId)
     return (
diff --git a/packages/web-console/src/scenes/Layout/index.tsx b/packages/web-console/src/scenes/Layout/index.tsx
index ba14d4f73..ac949db35 100644
--- a/packages/web-console/src/scenes/Layout/index.tsx
+++ b/packages/web-console/src/scenes/Layout/index.tsx
@@ -22,7 +22,7 @@
  *
  ******************************************************************************/
 
-import React from "react"
+import React, { useCallback, useEffect } from "react"
 import styled from "styled-components"
 import Footer from "../Footer"
 import Console from "../Console"
@@ -40,6 +40,9 @@ import { ImageZoom } from "../News/image-zoom"
 
 import "allotment/dist/style.css"
 
+import { eventBus } from "../../modules/EventBus"
+import { EventType } from "../../modules/EventBus/types"
+
 const Page = styled.div`
   display: flex;
   width: 100%;
@@ -77,6 +80,24 @@ const Drawer = styled.div`
 const Layout = () => {
   const activeSidebar = useSelector(selectors.console.getActiveSidebar)
 
+  const focusListener = useCallback(() => {
+    eventBus.publish(EventType.TAB_FOCUS)
+  }, [])
+
+  const blurListener = useCallback(() => {
+    eventBus.publish(EventType.TAB_BLUR)
+  }, [])
+
+  useEffect(() => {
+    window.addEventListener("focus", focusListener)
+    window.addEventListener("blur", blurListener)
+
+    return () => {
+      window.removeEventListener("focus", focusListener)
+      window.removeEventListener("blur", blurListener)
+    }
+  }, [])
+
   return (
     <EditorProvider>
       <TopBar />