poll only if the plugin title is visible

Author: paula-stacho

packages/compass-global-writes/src/plugin-title.tsx

@@ -1,6 +1,10 @@
 import { connect } from 'react-redux';
-import React from 'react';
-import { type RootState, ShardingStatuses } from './store/reducer';
+import React, { useEffect } from 'react';
+import {
+  type RootState,
+  setPluginTitleVisibility,
+  ShardingStatuses,
+} from './store/reducer';
 import {
   Body,
   css,
@@ -30,8 +34,20 @@ const iconStylesDark = css({
   color: palette.yellow.base,
 });
 
-const PluginTitle = ({ showWarning }: { showWarning: boolean }) => {
+const PluginTitle = ({
+  showWarning,
+  onVisibilityChanged,
+}: {
+  showWarning: boolean;
+  onVisibilityChanged: (isVisible: boolean) => void;
+}) => {
   const darkMode = useDarkMode();
+  useEffect(() => {
+    onVisibilityChanged(true);
+    return () => {
+      onVisibilityChanged(false);
+    };
+  });
   return (
     <div data-testid="global-writes-tab-title" className={containerStyles}>
       Global Writes{' '}
@@ -74,5 +90,8 @@ const PluginTitle = ({ showWarning }: { showWarning: boolean }) => {
 export const GlobalWritesTabTitle = connect(
   ({ managedNamespace, status }: RootState) => ({
     showWarning: !managedNamespace && status !== ShardingStatuses.NOT_READY,
-  })
+  }),
+  {
+    onVisibilityChanged: setPluginTitleVisibility,
+  }
 )(PluginTitle);

packages/compass-global-writes/src/store/reducer.ts

@@ -46,6 +46,8 @@ enum GlobalWritesActionTypes {
   UnmanagingNamespaceStarted = 'global-writes/UnmanagingNamespaceStarted',
   UnmanagingNamespaceFinished = 'global-writes/UnmanagingNamespaceFinished',
   UnmanagingNamespaceErrored = 'global-writes/UnmanagingNamespaceErrored',
+
+  PluginTitleVisibilityChanged = 'global-writes/PluginTitleVisibilityChanged',
 }
 
 type ManagedNamespaceFetchedAction = {
@@ -115,6 +117,11 @@ type UnmanagingNamespaceErroredAction = {
   type: GlobalWritesActionTypes.UnmanagingNamespaceErrored;
 };
 
+type PluginTitleVisibilityChangedAction = {
+  type: GlobalWritesActionTypes.PluginTitleVisibilityChanged;
+  isVisible: boolean;
+};
+
 export enum ShardingStatuses {
   /**
    * Initial status, no information available yet.
@@ -193,6 +200,7 @@ export type RootState = {
   namespace: string;
   managedNamespace?: ManagedNamespace;
   shardZones: ShardZoneData[];
+  isPluginTitleVisible: boolean;
 } & (
   | {
       status: ShardingStatuses.NOT_READY;
@@ -245,6 +253,7 @@ const initialState: RootState = {
   namespace: '',
   status: ShardingStatuses.NOT_READY,
   shardZones: [],
+  isPluginTitleVisible: true,
 };
 
 const reducer: Reducer<RootState, Action> = (state = initialState, action) => {
@@ -472,6 +481,19 @@ const reducer: Reducer<RootState, Action> = (state = initialState, action) => {
     };
   }
 
+  if (
+    isAction<PluginTitleVisibilityChangedAction>(
+      action,
+      GlobalWritesActionTypes.PluginTitleVisibilityChanged
+    )
+  ) {
+    if (state.isPluginTitleVisible === action.isVisible) return state;
+    return {
+      ...state,
+      isPluginTitleVisible: action.isVisible,
+    };
+  }
+
   return state;
 };
 
@@ -646,7 +668,11 @@ const pollForShardKey = (): GlobalWritesThunkAction<
   NextPollingTimeoutSetAction
 > => {
   return (dispatch, getState) => {
-    if (getState().pollingTimeout) {
+    const { pollingTimeout, isPluginTitleVisible } = getState();
+    if (
+      !isPluginTitleVisible || // user is not in the Collection Workspace
+      pollingTimeout // prevent double polling
+    ) {
       return;
     }
     const timeout = setTimeout(
@@ -753,6 +779,30 @@ export const fetchShardingZones = (): GlobalWritesThunkAction<
   };
 };
 
+export const setPluginTitleVisibility = (
+  isVisible: boolean
+): GlobalWritesThunkAction<void, PluginTitleVisibilityChangedAction> => {
+  return (dispatch, getState) => {
+    const {
+      status,
+      pollingTimeout,
+      isPluginTitleVisible: previousIsVisible,
+    } = getState();
+    dispatch({
+      type: GlobalWritesActionTypes.PluginTitleVisibilityChanged,
+      isVisible,
+    });
+    if (
+      isVisible &&
+      !previousIsVisible &&
+      status === ShardingStatuses.SHARDING &&
+      !pollingTimeout
+    ) {
+      dispatch(pollForShardKey());
+    }
+  };
+};
+
 export const unmanageNamespace = (): GlobalWritesThunkAction<
   Promise<void>,
   | UnmanagingNamespaceStartedAction