Feat/record optimistic effect (#3076)

* WIP

* WIP

* POC working on hard coded completedAt field

* Finished isRecordMatchingFilter, mock of pg_graphql filtering mechanism

* Fixed and cleaned

* Unregister unused optimistic effects

* Fix lint

* Fixes from review

---------

Co-authored-by: Charles Bochet <charles@twenty.com>

packages/twenty-front/src/modules/object-metadata/hooks/useRecordOptimisticEffect.ts

@@ -0,0 +1,57 @@
+import { useEffect } from 'react';
+
+import { useOptimisticEffect } from '@/apollo/optimistic-effect/hooks/useOptimisticEffect';
+import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
+import { OrderByField } from '@/object-metadata/types/OrderByField';
+import { getRecordOptimisticEffectDefinition } from '@/object-record/graphql/optimistic-effect-definition/getRecordOptimisticEffectDefinition';
+import { ObjectRecordQueryFilter } from '@/object-record/record-filter/types/ObjectRecordQueryFilter';
+
+export const useRecordOptimisticEffect = ({
+  objectMetadataItem,
+  filter,
+  orderBy,
+  limit,
+}: {
+  objectMetadataItem: ObjectMetadataItem;
+  filter?: ObjectRecordQueryFilter;
+  orderBy?: OrderByField;
+  limit?: number;
+}) => {
+  const { registerOptimisticEffect, unregisterOptimisticEffect } =
+    useOptimisticEffect({
+      objectNameSingular: objectMetadataItem.nameSingular,
+    });
+
+  useEffect(() => {
+    registerOptimisticEffect({
+      definition: getRecordOptimisticEffectDefinition({
+        objectMetadataItem,
+      }),
+      variables: {
+        filter,
+        orderBy,
+        limit,
+      },
+    });
+
+    return () => {
+      unregisterOptimisticEffect({
+        definition: getRecordOptimisticEffectDefinition({
+          objectMetadataItem,
+        }),
+        variables: {
+          filter,
+          orderBy,
+          limit,
+        },
+      });
+    };
+  }, [
+    registerOptimisticEffect,
+    filter,
+    orderBy,
+    limit,
+    objectMetadataItem,
+    unregisterOptimisticEffect,
+  ]);
+};