chore(front): Refactor the SnackBar component to use the new scope architecture (#2578)

* chore(front): Refactor the SnackBar component to use the new scope architecture

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

* Rename useSnackBarManager

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

---------

Co-authored-by: gitstart-twenty <gitstart-twenty@users.noreply.github.com>
Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>

front/src/modules/ui/feedback/snack-bar-manager/hooks/internal/useSnackBarManagerScopedStates.ts

@@ -0,0 +1,24 @@
+import { SnackBarManagerScopeInternalContext } from '@/ui/feedback/snack-bar-manager/scopes/scope-internal-context/SnackBarManagerScopeInternalContext';
+import { snackBarInternalScopedState } from '@/ui/feedback/snack-bar-manager/states/snackBarInternalScopedState';
+import { useRecoilScopedStateV2 } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedStateV2';
+import { useAvailableScopeIdOrThrow } from '@/ui/utilities/recoil-scope/scopes-internal/hooks/useAvailableScopeId';
+
+type useSnackBarManagerScopedStatesProps = {
+  snackBarManagerScopeId?: string;
+};
+
+export const useSnackBarManagerScopedStates = (
+  props?: useSnackBarManagerScopedStatesProps,
+) => {
+  const scopeId = useAvailableScopeIdOrThrow(
+    SnackBarManagerScopeInternalContext,
+    props?.snackBarManagerScopeId,
+  );
+
+  const [snackBarInternal, setSnackBarInternal] = useRecoilScopedStateV2(
+    snackBarInternalScopedState,
+    scopeId,
+  );
+
+  return { snackBarInternal, setSnackBarInternal };
+};

front/src/modules/ui/feedback/snack-bar-manager/hooks/usePausableTimeout.ts

@@ -0,0 +1,54 @@
+import { useCallback, useEffect, useRef } from 'react';
+
+export const usePausableTimeout = (callback: () => void, delay: number) => {
+  // eslint-disable-next-line twenty/no-state-useref
+  const savedCallback = useRef<() => void>(callback);
+  // eslint-disable-next-line twenty/no-state-useref
+  const remainingTime = useRef<number>(delay);
+  // eslint-disable-next-line twenty/no-state-useref
+  const startTime = useRef<number>(Date.now());
+  // eslint-disable-next-line twenty/no-state-useref
+  const timeoutId = useRef<ReturnType<typeof setTimeout> | null>(null);
+
+  const tick = () => {
+    if (savedCallback.current) {
+      savedCallback.current();
+    }
+  };
+
+  const startTimeout = useCallback(() => {
+    startTime.current = Date.now();
+    timeoutId.current = setTimeout(tick, remainingTime.current);
+  }, []);
+
+  // Remember the latest callback
+  useEffect(() => {
+    savedCallback.current = callback;
+  }, [callback]);
+
+  // Set up the timeout loop
+  useEffect(() => {
+    if (delay !== null) {
+      startTimeout();
+      return () => {
+        if (timeoutId.current) {
+          clearTimeout(timeoutId.current);
+        }
+      };
+    }
+  }, [delay, startTimeout]);
+
+  const pauseTimeout = () => {
+    if (timeoutId.current) {
+      clearTimeout(timeoutId.current);
+    }
+    const elapsedTime = Date.now() - startTime.current;
+    remainingTime.current = remainingTime.current - elapsedTime;
+  };
+
+  const resumeTimeout = () => {
+    startTimeout();
+  };
+
+  return { pauseTimeout, resumeTimeout };
+};

front/src/modules/ui/feedback/snack-bar-manager/hooks/useSnackBar.tsx

@@ -0,0 +1,53 @@
+import { useRecoilCallback } from 'recoil';
+import { v4 as uuidv4 } from 'uuid';
+
+import { SnackBarManagerScopeInternalContext } from '@/ui/feedback/snack-bar-manager/scopes/scope-internal-context/SnackBarManagerScopeInternalContext';
+import {
+  snackBarInternalScopedState,
+  SnackBarOptions,
+} from '@/ui/feedback/snack-bar-manager/states/snackBarInternalScopedState';
+import { useAvailableScopeIdOrThrow } from '@/ui/utilities/recoil-scope/scopes-internal/hooks/useAvailableScopeId';
+
+export const useSnackBar = () => {
+  const scopeId = useAvailableScopeIdOrThrow(
+    SnackBarManagerScopeInternalContext,
+  );
+
+  const handleSnackBarClose = useRecoilCallback(({ set }) => (id: string) => {
+    set(snackBarInternalScopedState({ scopeId }), (prevState) => ({
+      ...prevState,
+      queue: prevState.queue.filter((snackBar) => snackBar.id !== id),
+    }));
+  });
+
+  const setSnackBarQueue = useRecoilCallback(
+    ({ set }) =>
+      (newValue) =>
+        set(snackBarInternalScopedState({ scopeId }), (prev) => {
+          if (prev.queue.length >= prev.maxQueue) {
+            return {
+              ...prev,
+              queue: [...prev.queue.slice(1), newValue] as SnackBarOptions[],
+            };
+          }
+
+          return {
+            ...prev,
+            queue: [...prev.queue, newValue] as SnackBarOptions[],
+          };
+        }),
+  );
+
+  const enqueueSnackBar = (
+    message: string,
+    options?: Omit<SnackBarOptions, 'message' | 'id'>,
+  ) => {
+    setSnackBarQueue({
+      id: uuidv4(),
+      message,
+      ...options,
+    });
+  };
+
+  return { handleSnackBarClose, enqueueSnackBar };
+};