polling

Author: paula-stacho

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

@@ -3,6 +3,8 @@ import type { GlobalWritesThunkAction } from '.';
 import { openToast, showConfirmation } from '@mongodb-js/compass-components';
 import type { ManagedNamespace } from '../services/atlas-global-writes-service';
 
+export const POLLING_INTERVAL = 5000;
+
 export function isAction<A extends Action>(
   action: Action,
   type: A['type']
@@ -34,6 +36,8 @@ enum GlobalWritesActionTypes {
   CancellingShardingFinished = 'global-writes/CancellingShardingFinished',
   CancellingShardingErrored = 'global-writes/CancellingShardingErrored',
 
+  NextPollingTimeoutSet = 'global-writes/NextPollingTimeoutSet',
+
   UnmanagingNamespaceStarted = 'global-writes/UnmanagingNamespaceStarted',
   UnmanagingNamespaceFinished = 'global-writes/UnmanagingNamespaceFinished',
   UnmanagingNamespaceErrored = 'global-writes/UnmanagingNamespaceErrored',
@@ -85,6 +89,11 @@ type CancellingShardingErroredAction = {
   type: GlobalWritesActionTypes.CancellingShardingErrored;
 };
 
+type NextPollingTimeoutSetAction = {
+  type: GlobalWritesActionTypes.NextPollingTimeoutSet;
+  timeout: NodeJS.Timeout;
+};
+
 type UnmanagingNamespaceStartedAction = {
   type: GlobalWritesActionTypes.UnmanagingNamespaceStarted;
 };
@@ -123,7 +132,7 @@ export enum ShardingStatuses {
    * State when user cancels the sharding and
    * we are waiting for server to accept the request.
    */
-  CANCEL_SHARDING = 'CANCEL_SHARDING',
+  CANCELLING_SHARDING = 'CANCELLING_SHARDING',
 
   /**
    * Sharding failed.
@@ -181,23 +190,36 @@ export type RootState = {
       status: ShardingStatuses.NOT_READY;
       shardKey?: never;
       shardingError?: never;
+      pollingTimeout?: never;
     }
   | {
       status:
         | ShardingStatuses.UNSHARDED
         | ShardingStatuses.SUBMITTING_FOR_SHARDING
-        | ShardingStatuses.SHARDING;
+        | ShardingStatuses.CANCELLING_SHARDING;
       /**
        * note: shardKey might exist even for unsharded.
        * if the collection was sharded previously and then unmanaged
        */
       shardKey?: ShardKey;
       shardingError?: never;
+      pollingTimeout?: never;
+    }
+  | {
+      status: ShardingStatuses.SHARDING;
+      /**
+       * note: shardKey might exist
+       * if the collection was sharded previously and then unmanaged
+       */
+      shardKey?: ShardKey;
+      shardingError?: never;
+      pollingTimeout?: NodeJS.Timeout;
     }
   | {
       status: ShardingStatuses.SHARDING_ERROR;
       shardKey?: never;
       shardingError: string;
+      pollingTimeout?: never;
     }
   | {
       status:
@@ -207,6 +229,7 @@ export type RootState = {
         | ShardingStatuses.UNMANAGING_NAMESPACE;
       shardKey: ShardKey;
       shardingError?: never;
+      pollingTimeout?: never;
     }
 );
 
@@ -238,13 +261,15 @@ const reducer: Reducer<RootState, Action> = (state = initialState, action) => {
       action,
       GlobalWritesActionTypes.NamespaceShardingErrorFetched
     ) &&
-    state.status === ShardingStatuses.NOT_READY
+    (state.status === ShardingStatuses.NOT_READY ||
+      state.status === ShardingStatuses.SHARDING)
   ) {
     return {
       ...state,
       status: ShardingStatuses.SHARDING_ERROR,
       shardKey: undefined,
       shardingError: action.error,
+      pollingTimeout: undefined,
     };
   }
 
@@ -253,13 +278,15 @@ const reducer: Reducer<RootState, Action> = (state = initialState, action) => {
       action,
       GlobalWritesActionTypes.NamespaceShardKeyFetched
     ) &&
-    state.status === ShardingStatuses.NOT_READY
+    (state.status === ShardingStatuses.NOT_READY ||
+      state.status === ShardingStatuses.SHARDING)
   ) {
     return {
       ...state,
       status: getStatusFromShardKey(action.shardKey, state.managedNamespace),
       shardKey: action.shardKey,
       shardingError: undefined,
+      pollingTimeout: undefined,
     };
   }
 
@@ -302,6 +329,62 @@ const reducer: Reducer<RootState, Action> = (state = initialState, action) => {
     };
   }
 
+  if (
+    isAction<NextPollingTimeoutSetAction>(
+      action,
+      GlobalWritesActionTypes.NextPollingTimeoutSet
+    ) &&
+    state.status === ShardingStatuses.SHARDING
+  ) {
+    return {
+      ...state,
+      pollingTimeout: action.timeout,
+    };
+  }
+
+  if (
+    isAction<CancellingShardingStartedAction>(
+      action,
+      GlobalWritesActionTypes.CancellingShardingStarted
+    ) &&
+    state.status === ShardingStatuses.SHARDING
+  ) {
+    return {
+      ...state,
+      status: ShardingStatuses.CANCELLING_SHARDING,
+      pollingTimeout: undefined,
+    };
+  }
+
+  if (
+    isAction<CancellingShardingErroredAction>(
+      action,
+      GlobalWritesActionTypes.CancellingShardingErrored
+    ) &&
+    state.status === ShardingStatuses.CANCELLING_SHARDING
+  ) {
+    return {
+      ...state,
+      status: ShardingStatuses.SHARDING,
+    };
+  }
+
+  if (
+    isAction<CancellingShardingFinishedAction>(
+      action,
+      GlobalWritesActionTypes.CancellingShardingFinished
+    ) &&
+    (state.status === ShardingStatuses.CANCELLING_SHARDING ||
+      state.status === ShardingStatuses.SHARDING_ERROR)
+    // the error might come before the cancel request was processed
+  ) {
+    return {
+      ...state,
+      status: ShardingStatuses.UNSHARDED,
+      shardingError: undefined,
+    };
+  }
+
   if (
     isAction<SubmittingForShardingErroredAction>(
       action,
@@ -473,7 +556,11 @@ export const cancelSharding = ():
 
     if (!confirmed) return;
 
-    const { namespace } = getState();
+    const { namespace, status } = getState();
+
+    if (status === ShardingStatuses.SHARDING) {
+      stopPollingForShardKey(getState);
+    }
     dispatch({
       type: GlobalWritesActionTypes.CancellingShardingStarted,
     });
@@ -515,9 +602,31 @@ const setNamespaceBeingSharded = (
       type: GlobalWritesActionTypes.SubmittingForShardingFinished,
       managedNamespace,
     });
+    dispatch(startPollingForShardKey());
   };
 };
 
+const startPollingForShardKey = (): GlobalWritesThunkAction<
+  void,
+  NextPollingTimeoutSetAction
+> => {
+  return (dispatch) => {
+    const timeout = setTimeout(() => {
+      void dispatch(fetchNamespaceShardKey());
+    }, POLLING_INTERVAL);
+    dispatch({
+      type: GlobalWritesActionTypes.NextPollingTimeoutSet,
+      timeout,
+    });
+  };
+};
+
+const stopPollingForShardKey = (getState: () => RootState) => {
+  const { pollingTimeout } = getState();
+  if (!pollingTimeout) return;
+  clearTimeout(pollingTimeout);
+};
+
 export const fetchNamespaceShardKey = (): GlobalWritesThunkAction<
   Promise<void>,
   NamespaceShardingErrorFetchedAction | NamespaceShardKeyFetchedAction
@@ -527,7 +636,7 @@ export const fetchNamespaceShardKey = (): GlobalWritesThunkAction<
     getState,
     { atlasGlobalWritesService, logger, connectionInfoRef }
   ) => {
-    const { namespace } = getState();
+    const { namespace, status } = getState();
 
     try {
       const [shardingError, shardKey] = await Promise.all([
@@ -536,6 +645,9 @@ export const fetchNamespaceShardKey = (): GlobalWritesThunkAction<
       ]);
 
       if (shardingError) {
+        if (status === ShardingStatuses.SHARDING) {
+          stopPollingForShardKey(getState);
+        }
         dispatch({
           type: GlobalWritesActionTypes.NamespaceShardingErrorFetched,
           error: shardingError,
@@ -548,6 +660,9 @@ export const fetchNamespaceShardKey = (): GlobalWritesThunkAction<
         return;
       }
 
+      if (status === ShardingStatuses.SHARDING) {
+        stopPollingForShardKey(getState);
+      }
       dispatch({
         type: GlobalWritesActionTypes.NamespaceShardKeyFetched,
         shardKey,