Suggest similar investigations based on the currently displayed investigation on investigation landing page

packages/datagateway-common/src/api/investigations.test.tsx

@@ -14,8 +14,11 @@ import {
   useInvestigationSize,
   useInvestigationSizes,
   useInvestigationsPaginated,
+  useSimilarInvestigations,
 } from './investigations';
 
+import { SuggestedInvestigation } from '../app.types';
+
 jest.mock('../handleICATError');
 
 describe('investigation api functions', () => {
@@ -1253,4 +1256,100 @@ describe('investigation api functions', () => {
       expect(document.body.appendChild).toHaveBeenCalledWith(link);
     });
   });
+
+  describe('useSimilarInvestigations', function () {
+    const mockSuggestions: SuggestedInvestigation[] = [
+      {
+        id: 1,
+        visitId: 'visitId',
+        name: 'Suggested investigation 1 name',
+        title: 'Suggested investigation 1',
+        summary: 'Suggested investigation 1 summary',
+        doi: 'doi1',
+        score: 0.1,
+      },
+      {
+        id: 2,
+        visitId: 'visitId',
+        name: 'Suggested investigation 2 name',
+        title: 'Suggested investigation 2',
+        summary: 'Suggested investigation 2 summary',
+        doi: 'doi2',
+        score: 0.9,
+      },
+      {
+        id: 3,
+        visitId: 'visitId',
+        name: 'Suggested investigation 3 name',
+        title: 'Suggested investigation 3',
+        summary: 'Suggested investigation 3 summary',
+        doi: 'doi3',
+        score: 0.5,
+      },
+      {
+        id: 4,
+        visitId: 'visitId',
+        name: 'Suggested investigation 4 name',
+        title: 'Suggested investigation 4',
+        summary: 'Suggested investigation 4 summary',
+        doi: 'doi4',
+        score: 0.4,
+      },
+    ];
+
+    it('queries for investigations similar to the given investigation and sorts the result by their relevance from the most relevant to the least', async () => {
+      (axios.get as jest.Mock).mockResolvedValue({
+        data: mockSuggestions,
+      });
+
+      const { result, waitFor } = renderHook(
+        () =>
+          useSimilarInvestigations({
+            investigation: mockData[0],
+          }),
+        { wrapper: createReactQueryWrapper() }
+      );
+
+      await waitFor(() => result.current.isSuccess);
+
+      expect(result.current.data).toEqual([
+        {
+          id: 2,
+          visitId: 'visitId',
+          name: 'Suggested investigation 2 name',
+          title: 'Suggested investigation 2',
+          summary: 'Suggested investigation 2 summary',
+          doi: 'doi2',
+          score: 0.9,
+        },
+        {
+          id: 3,
+          visitId: 'visitId',
+          name: 'Suggested investigation 3 name',
+          title: 'Suggested investigation 3',
+          summary: 'Suggested investigation 3 summary',
+          doi: 'doi3',
+          score: 0.5,
+        },
+        {
+          id: 4,
+          visitId: 'visitId',
+          name: 'Suggested investigation 4 name',
+          title: 'Suggested investigation 4',
+          summary: 'Suggested investigation 4 summary',
+          doi: 'doi4',
+          score: 0.4,
+        },
+        {
+          id: 1,
+          visitId: 'visitId',
+          name: 'Suggested investigation 1 name',
+          title: 'Suggested investigation 1',
+          summary: 'Suggested investigation 1 summary',
+          doi: 'doi1',
+          score: 0.1,
+        },
+      ]);
+    });
+  });
 });

packages/datagateway-common/src/api/investigations.tsx

@@ -11,6 +11,7 @@
   FiltersType,
   Investigation,
   SortType,
+  SuggestedInvestigation,
 } from '../app.types';
 import { StateType } from '../state/app.types';
 import {
@@ -542,3 +543,40 @@
   link.click();
   link.remove();
 };
+
+export const useSimilarInvestigations = ({
+  investigation,
+}: {
+  investigation: Investigation;
+}): UseQueryResult<SuggestedInvestigation[], AxiosError> => {
+  // TODO: Remove this hardcoded URL
+  const baseUrl = 'http://172.16.103.71:4001/api';
+
+  return useQuery<
+    SuggestedInvestigation[],
+    AxiosError,
+    SuggestedInvestigation[],
+    ['similarInvestigations', Investigation['id']]
+  >(
+    ['similarInvestigations', investigation.id],
+    () =>
+      axios
+        .get<SuggestedInvestigation[]>(
+          `/v2/similar/doc/?id=${investigation.id}`,
+          {
+            baseURL: baseUrl,
+          }
+        )
+        .then((response) => response.data),
+    {
+      select: (data) => {
+        data.sort((resultA, resultB) => resultB.score - resultA.score);
+        return data;
+      },
+      onError: (error) => {
+        handleICATError(error);
+      },
+      retry: retryICATErrors,
+    }
+  );
+};

packages/datagateway-common/src/app.types.tsx

@@ -74,6 +74,18 @@ export interface InvestigationInstrument {
   investigation?: Investigation;
 }
 
+export interface SuggestedInvestigation {
+  doi: string;
+  name: string;
+  title: string;
+  id: number;
+  summary: string;
+  visitId: string;
+  startDate?: string;
+  endDate?: string;
+  score: number;
+}
+
 export interface Instrument {
   id: number;
   name: string;

packages/datagateway-dataview/public/res/default.json

@@ -144,6 +144,19 @@
     },
     "type": {
       "id": "Type ID"
+    },
+    "landingPage": {
+      "extraInfo": "Extra info",
+      "similarInvestigations": "Similar investigations",
+      "findingSimilarInvestigations": "Finding similar investigations…",
+      "noSuggestion": "No suggestion available",
+      "similarInvestigationListPaginationLabel": {
+        "pageButton": "Go to page {{page}} of similar investigations",
+        "firstPageButton": "Go to the first page of similar investigations",
+        "lastPageButton": "Go to the last page of similar investigations",
+        "nextButton": "Go to the next page of similar investigations",
+        "prevButton": "Go to the previous page of similar investigations"
+      }
     }
   },
   "datasets": {