View module refactor with atomic recoil component instance states (#6810)

This PR refactors the view module to implement utils that avoid having to create hooks to inject the scope id in the states, like `useViewStates`, each componentState will know its unique related InstanceContext (which holds the instanceId), and thus will be able to retrieve it itself. We keep the naming componentState as it reflects the fact that those states are tied to instances of a component (or its children). We introduce the instance word where it is needed, in place of scopeId for example, to precise the fact that we handle instances of component state, one for each instance of a component. For example, the currentViewId is a state that is tied to an instance of the ViewBar, but as we can switch between views, we want currentViewId to be a componentState tied to an instance of the ViewBar component. This PR also refactors view filter and sort states to fix this issue : https://github.com/twentyhq/twenty/issues/6837 and other problems involving resetting those states between page navigation. Fixes https://github.com/twentyhq/twenty/issues/6837 --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2024-09-20 16:13:29 +02:00
parent bebeb1515b
commit 25522752e4
177 changed files with 3132 additions and 1745 deletions
@@ -1,19 +1,18 @@
 import { useCallback } from 'react';
-import { useSetRecoilState } from 'recoil';

 import { useDropdown } from '@/ui/layout/dropdown/hooks/useDropdown';
+import { useSetRecoilComponentStateV2 } from '@/ui/utilities/state/component-state/hooks/useSetRecoilComponentStateV2';
 import { VIEW_PICKER_DROPDOWN_ID } from '@/views/view-picker/constants/ViewPickerDropdownId';
 import { VIEW_PICKER_KANBAN_FIELD_DROPDOWN_ID } from '@/views/view-picker/constants/ViewPickerKanbanFieldDropdownId';
 import { VIEW_PICKER_VIEW_TYPE_DROPDOWN_ID } from '@/views/view-picker/constants/ViewPickerViewTypeDropdownId';
 import { useViewPickerMode } from '@/views/view-picker/hooks/useViewPickerMode';
-import { useViewPickerStates } from '@/views/view-picker/hooks/useViewPickerStates';
+import { viewPickerIsPersistingComponentState } from '@/views/view-picker/states/viewPickerIsPersistingComponentState';

 export const useCloseAndResetViewPicker = () => {
  const { setViewPickerMode } = useViewPickerMode();
-  const { viewPickerIsPersistingState } = useViewPickerStates();

-  const setViewPickerIsPersisting = useSetRecoilState(
-    viewPickerIsPersistingState,
+  const setViewPickerIsPersisting = useSetRecoilComponentStateV2(
+    viewPickerIsPersistingComponentState,
  );

  const { closeDropdown: closeViewPickerDropdown } = useDropdown(
@@ -0,0 +1,118 @@
+import { getSnapshotValue } from '@/ui/utilities/recoil-scope/utils/getSnapshotValue';
+import { useRecoilComponentCallbackStateV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentCallbackStateV2';
+import { useChangeView } from '@/views/hooks/useChangeView';
+import { useCreateViewFromCurrentView } from '@/views/hooks/useCreateViewFromCurrentView';
+import { useCloseAndResetViewPicker } from '@/views/view-picker/hooks/useCloseAndResetViewPicker';
+import { viewPickerInputNameComponentState } from '@/views/view-picker/states/viewPickerInputNameComponentState';
+import { viewPickerIsDirtyComponentState } from '@/views/view-picker/states/viewPickerIsDirtyComponentState';
+import { viewPickerIsPersistingComponentState } from '@/views/view-picker/states/viewPickerIsPersistingComponentState';
+import { viewPickerKanbanFieldMetadataIdComponentState } from '@/views/view-picker/states/viewPickerKanbanFieldMetadataIdComponentState';
+import { viewPickerModeComponentState } from '@/views/view-picker/states/viewPickerModeComponentState';
+import { viewPickerSelectedIconComponentState } from '@/views/view-picker/states/viewPickerSelectedIconComponentState';
+import { viewPickerTypeComponentState } from '@/views/view-picker/states/viewPickerTypeComponentState';
+import { useRecoilCallback } from 'recoil';
+import { v4 } from 'uuid';
+
+export const useCreateViewFromCurrentState = (viewBarInstanceId?: string) => {
+  const { closeAndResetViewPicker } = useCloseAndResetViewPicker();
+
+  const viewPickerInputNameCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerInputNameComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerSelectedIconCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerSelectedIconComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerTypeCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerTypeComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerKanbanFieldMetadataIdCallbackState =
+    useRecoilComponentCallbackStateV2(
+      viewPickerKanbanFieldMetadataIdComponentState,
+      viewBarInstanceId,
+    );
+
+  const viewPickerIsPersistingCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsPersistingComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerIsDirtyCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsDirtyComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerModeCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerModeComponentState,
+    viewBarInstanceId,
+  );
+
+  const { createViewFromCurrentView } =
+    useCreateViewFromCurrentView(viewBarInstanceId);
+  const { changeView } = useChangeView(viewBarInstanceId);
+
+  const createViewFromCurrentState = useRecoilCallback(
+    ({ snapshot, set }) =>
+      async () => {
+        const name = getSnapshotValue(
+          snapshot,
+          viewPickerInputNameCallbackState,
+        );
+        const iconKey = getSnapshotValue(
+          snapshot,
+          viewPickerSelectedIconCallbackState,
+        );
+        const type = getSnapshotValue(snapshot, viewPickerTypeCallbackState);
+        const kanbanFieldMetadataId = getSnapshotValue(
+          snapshot,
+          viewPickerKanbanFieldMetadataIdCallbackState,
+        );
+
+        const viewPickerMode = getSnapshotValue(
+          snapshot,
+          viewPickerModeCallbackState,
+        );
+
+        const shouldCopyFiltersAndSorts =
+          viewPickerMode === 'create-from-current';
+
+        const id = v4();
+
+        set(viewPickerIsPersistingCallbackState, true);
+        set(viewPickerIsDirtyCallbackState, false);
+
+        await createViewFromCurrentView(
+          {
+            id,
+            name,
+            icon: iconKey,
+            type,
+            kanbanFieldMetadataId,
+          },
+          shouldCopyFiltersAndSorts,
+        );
+
+        closeAndResetViewPicker();
+        changeView(id);
+      },
+    [
+      closeAndResetViewPicker,
+      createViewFromCurrentView,
+      changeView,
+      viewPickerInputNameCallbackState,
+      viewPickerIsDirtyCallbackState,
+      viewPickerIsPersistingCallbackState,
+      viewPickerKanbanFieldMetadataIdCallbackState,
+      viewPickerSelectedIconCallbackState,
+      viewPickerTypeCallbackState,
+      viewPickerModeCallbackState,
+    ],
+  );
+
+  return { createViewFromCurrentState };
+};
@@ -0,0 +1,78 @@
+import { useRecoilCallback } from 'recoil';
+
+import { getSnapshotValue } from '@/ui/utilities/recoil-scope/utils/getSnapshotValue';
+import { useRecoilComponentCallbackStateV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentCallbackStateV2';
+import { useChangeView } from '@/views/hooks/useChangeView';
+import { useDeleteView } from '@/views/hooks/useDeleteView';
+import { useGetCurrentView } from '@/views/hooks/useGetCurrentView';
+import { useCloseAndResetViewPicker } from '@/views/view-picker/hooks/useCloseAndResetViewPicker';
+import { viewPickerIsDirtyComponentState } from '@/views/view-picker/states/viewPickerIsDirtyComponentState';
+import { viewPickerIsPersistingComponentState } from '@/views/view-picker/states/viewPickerIsPersistingComponentState';
+import { viewPickerReferenceViewIdComponentState } from '@/views/view-picker/states/viewPickerReferenceViewIdComponentState';
+
+export const useDeleteViewFromCurrentState = (viewBarInstanceId?: string) => {
+  const { viewsOnCurrentObject, currentViewId } =
+    useGetCurrentView(viewBarInstanceId);
+
+  const { closeAndResetViewPicker } = useCloseAndResetViewPicker();
+
+  const viewPickerIsPersistingCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsPersistingComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerIsDirtyCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsDirtyComponentState,
+    viewBarInstanceId,
+  );
+
+  const viewPickerReferenceViewIdCallbackState =
+    useRecoilComponentCallbackStateV2(
+      viewPickerReferenceViewIdComponentState,
+      viewBarInstanceId,
+    );
+
+  const { changeView } = useChangeView(viewBarInstanceId);
+
+  const { deleteView } = useDeleteView();
+
+  const deleteViewFromCurrentState = useRecoilCallback(
+    ({ set, snapshot }) =>
+      async () => {
+        set(viewPickerIsPersistingCallbackState, true);
+        closeAndResetViewPicker();
+        set(viewPickerIsDirtyCallbackState, false);
+
+        const viewPickerReferenceViewId = getSnapshotValue(
+          snapshot,
+          viewPickerReferenceViewIdCallbackState,
+        );
+
+        const shouldChangeView = viewPickerReferenceViewId === currentViewId;
+
+        if (shouldChangeView) {
+          changeView(
+            viewsOnCurrentObject.filter(
+              (view) => view.id !== viewPickerReferenceViewId,
+            )[0].id,
+          );
+        }
+
+        await deleteView(viewPickerReferenceViewId);
+      },
+    [
+      currentViewId,
+      closeAndResetViewPicker,
+      changeView,
+      deleteView,
+      viewPickerIsDirtyCallbackState,
+      viewPickerIsPersistingCallbackState,
+      viewPickerReferenceViewIdCallbackState,
+      viewsOnCurrentObject,
+    ],
+  );
+
+  return {
+    deleteViewFromCurrentState,
+  };
+};
@@ -5,14 +5,15 @@ import { useRecoilValue, useSetRecoilState } from 'recoil';
 import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
 import { getObjectSlug } from '@/object-metadata/utils/getObjectSlug';
 import { navigationMemorizedUrlState } from '@/ui/navigation/states/navigationMemorizedUrlState';
-import { useViewStates } from '@/views/hooks/internal/useViewStates';
+import { useRecoilComponentValueV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentValueV2';
+import { viewObjectMetadataIdComponentState } from '@/views/states/viewObjectMetadataIdComponentState';
 import { FieldMetadataType } from '~/generated-metadata/graphql';
 import { isDefined } from '~/utils/isDefined';

 export const useGetAvailableFieldsForKanban = () => {
-  const { viewObjectMetadataIdState } = useViewStates();
-
-  const viewObjectMetadataId = useRecoilValue(viewObjectMetadataIdState);
+  const viewObjectMetadataId = useRecoilComponentValueV2(
+    viewObjectMetadataIdComponentState,
+  );
  const objectMetadataItems = useRecoilValue(objectMetadataItemsState);
  const setNavigationMemorizedUrl = useSetRecoilState(
    navigationMemorizedUrlState,
@@ -0,0 +1,80 @@
+import { getSnapshotValue } from '@/ui/utilities/recoil-scope/utils/getSnapshotValue';
+import { useRecoilComponentCallbackStateV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentCallbackStateV2';
+import { useChangeView } from '@/views/hooks/useChangeView';
+import { useUpdateView } from '@/views/hooks/useUpdateView';
+import { useCloseAndResetViewPicker } from '@/views/view-picker/hooks/useCloseAndResetViewPicker';
+import { viewPickerInputNameComponentState } from '@/views/view-picker/states/viewPickerInputNameComponentState';
+import { viewPickerIsDirtyComponentState } from '@/views/view-picker/states/viewPickerIsDirtyComponentState';
+import { viewPickerIsPersistingComponentState } from '@/views/view-picker/states/viewPickerIsPersistingComponentState';
+import { viewPickerReferenceViewIdComponentState } from '@/views/view-picker/states/viewPickerReferenceViewIdComponentState';
+import { viewPickerSelectedIconComponentState } from '@/views/view-picker/states/viewPickerSelectedIconComponentState';
+import { useRecoilCallback } from 'recoil';
+
+export const useUpdateViewFromCurrentState = (viewBarInstanceId?: string) => {
+  const { closeAndResetViewPicker } = useCloseAndResetViewPicker();
+
+  const viewPickerInputNameCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerInputNameComponentState,
+  );
+
+  const viewPickerSelectedIconCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerSelectedIconComponentState,
+  );
+
+  const viewPickerIsPersistingCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsPersistingComponentState,
+  );
+
+  const viewPickerIsDirtyCallbackState = useRecoilComponentCallbackStateV2(
+    viewPickerIsDirtyComponentState,
+  );
+
+  const viewPickerReferenceViewIdCallbackState =
+    useRecoilComponentCallbackStateV2(viewPickerReferenceViewIdComponentState);
+
+  const { updateView } = useUpdateView();
+  const { changeView } = useChangeView(viewBarInstanceId);
+
+  const updateViewFromCurrentState = useRecoilCallback(
+    ({ set, snapshot }) =>
+      async () => {
+        set(viewPickerIsPersistingCallbackState, true);
+        set(viewPickerIsDirtyCallbackState, false);
+        closeAndResetViewPicker();
+
+        const viewPickerReferenceViewId = getSnapshotValue(
+          snapshot,
+          viewPickerReferenceViewIdCallbackState,
+        );
+        const viewPickerInputName = getSnapshotValue(
+          snapshot,
+          viewPickerInputNameCallbackState,
+        );
+        const viewPickerSelectedIcon = getSnapshotValue(
+          snapshot,
+          viewPickerSelectedIconCallbackState,
+        );
+
+        await updateView({
+          id: viewPickerReferenceViewId,
+          name: viewPickerInputName,
+          icon: viewPickerSelectedIcon,
+        });
+        changeView(viewPickerReferenceViewId);
+      },
+    [
+      viewPickerIsPersistingCallbackState,
+      viewPickerIsDirtyCallbackState,
+      closeAndResetViewPicker,
+      viewPickerReferenceViewIdCallbackState,
+      viewPickerInputNameCallbackState,
+      viewPickerSelectedIconCallbackState,
+      updateView,
+      changeView,
+    ],
+  );
+
+  return {
+    updateViewFromCurrentState,
+  };
+};
@@ -1,12 +1,11 @@
-import { useRecoilState } from 'recoil';
-
-import { useViewPickerStates } from '@/views/view-picker/hooks/useViewPickerStates';
+import { useRecoilComponentStateV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentStateV2';
+import { viewPickerModeComponentState } from '@/views/view-picker/states/viewPickerModeComponentState';

 export const useViewPickerMode = (viewBarComponentId?: string) => {
-  const { viewPickerModeState } = useViewPickerStates(viewBarComponentId);
-
-  const [viewPickerMode, setViewPickerMode] =
-    useRecoilState(viewPickerModeState);
+  const [viewPickerMode, setViewPickerMode] = useRecoilComponentStateV2(
+    viewPickerModeComponentState,
+    viewBarComponentId,
+  );

  return {
    viewPickerMode,
@@ -1,132 +0,0 @@
-import { useRecoilCallback } from 'recoil';
-import { v4 } from 'uuid';
-
-import { getSnapshotValue } from '@/ui/utilities/recoil-scope/utils/getSnapshotValue';
-import { useGetCurrentView } from '@/views/hooks/useGetCurrentView';
-import { useHandleViews } from '@/views/hooks/useHandleViews';
-import { useCloseAndResetViewPicker } from '@/views/view-picker/hooks/useCloseAndResetViewPicker';
-import { useViewPickerStates } from '@/views/view-picker/hooks/useViewPickerStates';
-
-export const useViewPickerPersistView = () => {
-  const {
-    viewPickerInputNameState,
-    viewPickerSelectedIconState,
-    viewPickerIsPersistingState,
-    viewPickerReferenceViewIdState,
-    viewPickerKanbanFieldMetadataIdState,
-    viewPickerTypeState,
-    viewPickerIsDirtyState,
-  } = useViewPickerStates();
-
-  const { createView, selectView, removeView, updateView } = useHandleViews();
-
-  const { viewsOnCurrentObject } = useGetCurrentView();
-
-  const { closeAndResetViewPicker } = useCloseAndResetViewPicker();
-
-  const handleCreate = useRecoilCallback(
-    ({ snapshot, set }) =>
-      async () => {
-        const name = getSnapshotValue(snapshot, viewPickerInputNameState);
-        const iconKey = getSnapshotValue(snapshot, viewPickerSelectedIconState);
-        const type = getSnapshotValue(snapshot, viewPickerTypeState);
-        const kanbanFieldMetadataId = getSnapshotValue(
-          snapshot,
-          viewPickerKanbanFieldMetadataIdState,
-        );
-        const id = v4();
-        set(viewPickerIsPersistingState, true);
-        set(viewPickerIsDirtyState, false);
-        await createView({
-          id,
-          name,
-          icon: iconKey,
-          type,
-          kanbanFieldMetadataId,
-        });
-        closeAndResetViewPicker();
-        selectView(id);
-      },
-    [
-      closeAndResetViewPicker,
-      createView,
-      selectView,
-      viewPickerInputNameState,
-      viewPickerIsDirtyState,
-      viewPickerIsPersistingState,
-      viewPickerKanbanFieldMetadataIdState,
-      viewPickerSelectedIconState,
-      viewPickerTypeState,
-    ],
-  );
-
-  const handleDelete = useRecoilCallback(
-    ({ set, snapshot }) =>
-      async () => {
-        set(viewPickerIsPersistingState, true);
-        closeAndResetViewPicker();
-        set(viewPickerIsDirtyState, false);
-        const viewPickerReferenceViewId = getSnapshotValue(
-          snapshot,
-          viewPickerReferenceViewIdState,
-        );
-
-        selectView(
-          viewsOnCurrentObject.filter(
-            (view) => view.id !== viewPickerReferenceViewId,
-          )[0].id,
-        );
-        await removeView(viewPickerReferenceViewId);
-      },
-    [
-      closeAndResetViewPicker,
-      removeView,
-      selectView,
-      viewPickerIsDirtyState,
-      viewPickerIsPersistingState,
-      viewPickerReferenceViewIdState,
-      viewsOnCurrentObject,
-    ],
-  );
-
-  const handleUpdate = useRecoilCallback(
-    ({ set, snapshot }) =>
-      async () => {
-        set(viewPickerIsPersistingState, true);
-        set(viewPickerIsDirtyState, false);
-        closeAndResetViewPicker();
-
-        const viewPickerReferenceViewId = getSnapshotValue(
-          snapshot,
-          viewPickerReferenceViewIdState,
-        );
-        const viewPickerInputName = getSnapshotValue(
-          snapshot,
-          viewPickerInputNameState,
-        );
-        const viewPickerSelectedIcon = getSnapshotValue(
-          snapshot,
-          viewPickerSelectedIconState,
-        );
-
-        await updateView({
-          id: viewPickerReferenceViewId,
-          name: viewPickerInputName,
-          icon: viewPickerSelectedIcon,
-        });
-        selectView(viewPickerReferenceViewId);
-      },
-    [
-      viewPickerIsPersistingState,
-      viewPickerIsDirtyState,
-      closeAndResetViewPicker,
-      viewPickerReferenceViewIdState,
-      viewPickerInputNameState,
-      viewPickerSelectedIconState,
-      updateView,
-      selectView,
-    ],
-  );
-
-  return { handleCreate, handleDelete, handleUpdate };
-};
@@ -1,55 +0,0 @@
-import { useAvailableScopeIdOrThrow } from '@/ui/utilities/recoil-scope/scopes-internal/hooks/useAvailableScopeId';
-import { extractComponentState } from '@/ui/utilities/state/component-state/utils/extractComponentState';
-import { viewPickerInputNameComponentState } from '@/views/view-picker/states/viewPickerInputNameComponentState';
-import { viewPickerIsDirtyComponentState } from '@/views/view-picker/states/viewPickerIsDirtyComponentState';
-import { viewPickerIsPersistingComponentState } from '@/views/view-picker/states/viewPickerIsPersistingComponentState';
-import { viewPickerKanbanFieldMetadataIdComponentState } from '@/views/view-picker/states/viewPickerKanbanFieldMetadataIdComponentState';
-import { viewPickerModeComponentState } from '@/views/view-picker/states/viewPickerModeComponentState';
-import { viewPickerReferenceViewIdComponentState } from '@/views/view-picker/states/viewPickerReferenceViewIdComponentState';
-import { viewPickerSelectedIconComponentState } from '@/views/view-picker/states/viewPickerSelectedIconComponentState';
-import { viewPickerTypeComponentState } from '@/views/view-picker/states/viewPickerTypeComponentState';
-
-import { ViewScopeInternalContext } from '../../scopes/scope-internal-context/ViewScopeInternalContext';
-
-export const useViewPickerStates = (viewComponentId?: string) => {
-  const componentId = useAvailableScopeIdOrThrow(
-    ViewScopeInternalContext,
-    viewComponentId,
-  );
-
-  return {
-    componentId,
-    viewPickerModeState: extractComponentState(
-      viewPickerModeComponentState,
-      componentId,
-    ),
-    viewPickerInputNameState: extractComponentState(
-      viewPickerInputNameComponentState,
-      componentId,
-    ),
-    viewPickerSelectedIconState: extractComponentState(
-      viewPickerSelectedIconComponentState,
-      componentId,
-    ),
-    viewPickerKanbanFieldMetadataIdState: extractComponentState(
-      viewPickerKanbanFieldMetadataIdComponentState,
-      componentId,
-    ),
-    viewPickerReferenceViewIdState: extractComponentState(
-      viewPickerReferenceViewIdComponentState,
-      componentId,
-    ),
-    viewPickerIsPersistingState: extractComponentState(
-      viewPickerIsPersistingComponentState,
-      componentId,
-    ),
-    viewPickerTypeState: extractComponentState(
-      viewPickerTypeComponentState,
-      componentId,
-    ),
-    viewPickerIsDirtyState: extractComponentState(
-      viewPickerIsDirtyComponentState,
-      componentId,
-    ),
-  };
-};