Search (#7237)

Steps to test

1. Run metadata migrations
2. Run sync-metadata on your workspace
3. Enable the following feature flags: 
IS_SEARCH_ENABLED
IS_QUERY_RUNNER_TWENTY_ORM_ENABLED
IS_WORKSPACE_MIGRATED_FOR_SEARCH
4. Type Cmd + K and search anything

packages/twenty-front/src/modules/object-record/graphql/types/RecordGqlOperationSearchResult.ts

@@ -0,0 +1,5 @@
+import { RecordGqlConnection } from '@/object-record/graphql/types/RecordGqlConnection';
+
+export type RecordGqlOperationSearchResult = {
+  [objectNamePlural: string]: RecordGqlConnection;
+};

packages/twenty-front/src/modules/object-record/hooks/useSearchRecords.ts

@@ -0,0 +1,94 @@
+import { useQuery, WatchQueryFetchPolicy } from '@apollo/client';
+import { useRecoilValue } from 'recoil';
+
+import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { useObjectMetadataItem } from '@/object-metadata/hooks/useObjectMetadataItem';
+import { ObjectMetadataItemIdentifier } from '@/object-metadata/types/ObjectMetadataItemIdentifier';
+import { getRecordsFromRecordConnection } from '@/object-record/cache/utils/getRecordsFromRecordConnection';
+import { RecordGqlOperationGqlRecordFields } from '@/object-record/graphql/types/RecordGqlOperationGqlRecordFields';
+import { RecordGqlOperationSearchResult } from '@/object-record/graphql/types/RecordGqlOperationSearchResult';
+import { RecordGqlOperationVariables } from '@/object-record/graphql/types/RecordGqlOperationVariables';
+import { useSearchRecordsQuery } from '@/object-record/hooks/useSearchRecordsQuery';
+import { ObjectRecord } from '@/object-record/types/ObjectRecord';
+import { getSearchRecordsQueryResponseField } from '@/object-record/utils/getSearchRecordsQueryResponseField';
+import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/SnackBar';
+import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
+import { useMemo } from 'react';
+import { logError } from '~/utils/logError';
+
+export type UseSearchRecordsParams = ObjectMetadataItemIdentifier &
+  RecordGqlOperationVariables & {
+    onError?: (error?: Error) => void;
+    skip?: boolean;
+    recordGqlFields?: RecordGqlOperationGqlRecordFields;
+    fetchPolicy?: WatchQueryFetchPolicy;
+    searchInput?: string;
+  };
+
+export const useSearchRecords = <T extends ObjectRecord = ObjectRecord>({
+  objectNameSingular,
+  searchInput,
+  limit,
+  skip,
+  recordGqlFields,
+  fetchPolicy,
+}: UseSearchRecordsParams) => {
+  const currentWorkspaceMember = useRecoilValue(currentWorkspaceMemberState);
+  const { objectMetadataItem } = useObjectMetadataItem({
+    objectNameSingular,
+  });
+  const { searchRecordsQuery } = useSearchRecordsQuery({
+    objectNameSingular,
+    recordGqlFields,
+  });
+
+  const { enqueueSnackBar } = useSnackBar();
+
+  const { data, loading, error } = useQuery<RecordGqlOperationSearchResult>(
+    searchRecordsQuery,
+    {
+      skip:
+        skip || !objectMetadataItem || !currentWorkspaceMember || !searchInput,
+      variables: {
+        search: searchInput,
+        limit: limit,
+      },
+      fetchPolicy: fetchPolicy,
+      onError: (error) => {
+        logError(
+          `useSearchRecords for "${objectMetadataItem.namePlural}" error : ` +
+            error,
+        );
+        enqueueSnackBar(
+          `Error during useSearchRecords for "${objectMetadataItem.namePlural}", ${error.message}`,
+          {
+            variant: SnackBarVariant.Error,
+          },
+        );
+      },
+    },
+  );
+
+  const queryResponseField = getSearchRecordsQueryResponseField(
+    objectMetadataItem.namePlural,
+  );
+
+  const result = data?.[queryResponseField];
+
+  const records = useMemo(
+    () =>
+      result
+        ? (getRecordsFromRecordConnection({
+            recordConnection: result,
+          }) as T[])
+        : [],
+    [result],
+  );
+
+  return {
+    objectMetadataItem,
+    records: records,
+    loading,
+    error,
+  };
+};

packages/twenty-front/src/modules/object-record/hooks/useSearchRecordsQuery.ts

@@ -0,0 +1,33 @@
+import { useRecoilValue } from 'recoil';
+
+import { useObjectMetadataItem } from '@/object-metadata/hooks/useObjectMetadataItem';
+import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
+import { RecordGqlOperationGqlRecordFields } from '@/object-record/graphql/types/RecordGqlOperationGqlRecordFields';
+import { generateSearchRecordsQuery } from '@/object-record/utils/generateSearchRecordsQuery';
+
+export const useSearchRecordsQuery = ({
+  objectNameSingular,
+  recordGqlFields,
+  computeReferences,
+}: {
+  objectNameSingular: string;
+  recordGqlFields?: RecordGqlOperationGqlRecordFields;
+  computeReferences?: boolean;
+}) => {
+  const { objectMetadataItem } = useObjectMetadataItem({
+    objectNameSingular,
+  });
+
+  const objectMetadataItems = useRecoilValue(objectMetadataItemsState);
+
+  const searchRecordsQuery = generateSearchRecordsQuery({
+    objectMetadataItem,
+    objectMetadataItems,
+    recordGqlFields,
+    computeReferences,
+  });
+
+  return {
+    searchRecordsQuery,
+  };
+};

packages/twenty-front/src/modules/object-record/utils/generateSearchRecordsQuery.ts

@@ -0,0 +1,40 @@
+import gql from 'graphql-tag';
+
+import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
+import { mapObjectMetadataToGraphQLQuery } from '@/object-metadata/utils/mapObjectMetadataToGraphQLQuery';
+import { RecordGqlOperationGqlRecordFields } from '@/object-record/graphql/types/RecordGqlOperationGqlRecordFields';
+import { getSearchRecordsQueryResponseField } from '@/object-record/utils/getSearchRecordsQueryResponseField';
+import { capitalize } from '~/utils/string/capitalize';
+
+export type QueryCursorDirection = 'before' | 'after';
+
+export const generateSearchRecordsQuery = ({
+  objectMetadataItem,
+  objectMetadataItems,
+  recordGqlFields,
+  computeReferences,
+}: {
+  objectMetadataItem: ObjectMetadataItem;
+  objectMetadataItems: ObjectMetadataItem[]; // TODO - what is this used for?
+  recordGqlFields?: RecordGqlOperationGqlRecordFields;
+  computeReferences?: boolean;
+}) => gql`
+    query Search${capitalize(objectMetadataItem.namePlural)}($search: String, $limit: Int) {
+  ${getSearchRecordsQueryResponseField(objectMetadataItem.namePlural)}(searchInput: $search, limit: $limit){
+    edges {
+      node ${mapObjectMetadataToGraphQLQuery({
+        objectMetadataItems,
+        objectMetadataItem,
+        recordGqlFields,
+        computeReferences,
+      })}
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+  }
+}
+`;

packages/twenty-front/src/modules/object-record/utils/getSearchRecordsQueryResponseField.ts

@@ -0,0 +1,4 @@
+import { capitalize } from '~/utils/string/capitalize';
+
+export const getSearchRecordsQueryResponseField = (objectNamePlural: string) =>
+  `search${capitalize(objectNamePlural)}`;