[ENH] add ids param on meta-analysis endpoint (#687)

* switch to main branch

* update logic and test

* update typescript libraries

* switch from using a filter to a specific meta-analysis query

* add new hook

Author: jdkent

compose/neurosynth-frontend/src/components/Dialogs/CreateMetaAnalysisSpecificationDialog/CreateMetaAnalysisSpecificationDetailsStep/CreateMetaAnalysisSpecificationDetailsStep.tsx

@@ -2,10 +2,10 @@ import { Box, TextField } from '@mui/material';
 import NavigationButtons, {
     ENavigationButton,
 } from 'components/Buttons/NavigationButtons/NavigationButtons';
-import { useGetMetaAnalysesByProjectId } from 'hooks';
-import { useProjectName } from 'pages/Projects/ProjectPage/ProjectStore';
+import { useGetMetaAnalysesByIds } from 'hooks';
+import { useProjectName, useProjectMetaAnalyses } from 'pages/Projects/ProjectPage/ProjectStore';
+import { MetaAnalysisReturn } from 'neurosynth-compose-typescript-sdk';
 import { ChangeEvent, useEffect } from 'react';
-import { useParams } from 'react-router-dom';
 
 const CreateMetaAnalysisSpecificationDetailsStep: React.FC<{
     details: { name: string; description: string };
@@ -15,8 +15,18 @@ const CreateMetaAnalysisSpecificationDetailsStep: React.FC<{
     onUpdateDetails: (details: { name: string; description: string }) => void;
     onNavigate: (button: ENavigationButton) => void;
 }> = (props) => {
-    const { projectId } = useParams<{ projectId: string | undefined }>();
-    const { data } = useGetMetaAnalysesByProjectId(projectId);
+    const projectMetaAnalyses = useProjectMetaAnalyses() || [];
+    let metaAnalysisIds: string[] = [];
+    if (projectMetaAnalyses.length > 0) {
+        if (typeof projectMetaAnalyses[0] === 'string') {
+            metaAnalysisIds = projectMetaAnalyses as string[];
+        } else {
+            metaAnalysisIds = (projectMetaAnalyses as MetaAnalysisReturn[])
+                .map((metaAnalysis) => metaAnalysis.id)
+                .filter((id): id is string => id !== undefined);
+        }
+    }
+    const { data } = useGetMetaAnalysesByIds(metaAnalysisIds);
     const { details, selectionKey, algorithmName, correctorName, onUpdateDetails, onNavigate } =
         props;
     const projectName = useProjectName();

compose/neurosynth-frontend/src/components/ProjectComponents/ViewMetaAnalyses/ViewMetaAnalyses.tsx

@@ -2,18 +2,31 @@ import { Add } from '@mui/icons-material';
 import { Box, Button, Typography } from '@mui/material';
 import CreateMetaAnalysisSpecificationDialogBase from 'components/Dialogs/CreateMetaAnalysisSpecificationDialog/CreateMetaAnalysisSpecificationDialogBase';
 import StateHandlerComponent from 'components/StateHandlerComponent/StateHandlerComponent';
-import { useGetMetaAnalysesByProjectId, useGuard } from 'hooks';
+import { useGetMetaAnalysesByIds, useGuard } from 'hooks';
 import {
     useProjectId,
+    useProjectMetaAnalyses,
     useProjectMetaAnalysisCanEdit,
 } from 'pages/Projects/ProjectPage/ProjectStore';
+import { MetaAnalysisReturn } from 'neurosynth-compose-typescript-sdk';
 import { useState } from 'react';
 import { useParams } from 'react-router-dom';
 import ViewMetaAnalysis from './ViewMetaAnalysis';
 
 const ViewMetaAnalyses: React.FC = () => {
     const { projectId }: { projectId: string } = useParams();
-    const { data, isLoading, isError } = useGetMetaAnalysesByProjectId(projectId);
+    const projectMetaAnalyses = useProjectMetaAnalyses() || [];
+    let metaAnalysisIds: string[] = [];
+    if (projectMetaAnalyses.length > 0) {
+        if (typeof projectMetaAnalyses[0] === 'string') {
+            metaAnalysisIds = projectMetaAnalyses as string[];
+        } else {
+            metaAnalysisIds = (projectMetaAnalyses as MetaAnalysisReturn[])
+                .map((metaAnalysis) => metaAnalysis.id)
+                .filter((id): id is string => id !== undefined);
+        }
+    }
+    const { data, isLoading, isError } = useGetMetaAnalysesByIds(metaAnalysisIds);
     const canEditMetaAnalyses = useProjectMetaAnalysisCanEdit();
     const projectIdFromProject = useProjectId();
     const [createMetaAnalysisDialogIsOpen, setCreateMetaAnalysisDialogIsOpen] = useState(false);

compose/neurosynth-frontend/src/hooks/index.ts

@@ -6,7 +6,7 @@ import useGetTour from './useGetTour';
 import useGetWindowHeight from './useGetWindowHeight';
 
 import useCreateAlgorithmSpecification from './metaAnalyses/useCreateAlgorithmSpecification';
-import useGetMetaAnalysesByProjectId from './metaAnalyses/useGetMetaAnalysesByProjectId';
+import useGetMetaAnalysesByIds from './metaAnalyses/useGetMetaAnalysesByIds';
 import useGetMetaAnalysisById from './metaAnalyses/useGetMetaAnalysisById';
 import useGetAnnotationsByStudysetId from './analyses/useGetAnnotationsByStudysetId';
 import useCreatePoint from './analyses/useCreatePoint';
@@ -46,7 +46,7 @@ export {
     useCreateStudy,
     // META-ANALYSES
     useCreateAlgorithmSpecification,
-    useGetMetaAnalysesByProjectId,
+    useGetMetaAnalysesByIds,
     useGetMetaAnalysisById,
     // STUDYSETS
     useGetStudysets,

compose/neurosynth-frontend/src/hooks/metaAnalyses/useGetMetaAnalysesByIds.tsx

@@ -0,0 +1,21 @@
+import { useQuery } from 'react-query';
+import API from 'utils/api';
+
+const useGetMetaAnalysesByIds = (metaAnalysisIds: string[] | undefined) => {
+    return useQuery(
+        ['meta-analyses', metaAnalysisIds],
+        () =>
+            API.NeurosynthServices.MetaAnalysisService.metaAnalysesGet(
+                false,
+                metaAnalysisIds || []
+            ),
+        {
+            select: (axiosResponse) => {
+                const res = axiosResponse.data.results || [];
+                return res;
+            },
+        }
+    );
+};
+
+export default useGetMetaAnalysesByIds;

compose/neurosynth-frontend/src/hooks/metaAnalyses/useGetMetaAnalysesByProjectId.tsx

@@ -2,12 +2,25 @@ import { Box, TableCell, TableRow, Typography } from '@mui/material';
 import StateHandlerComponent from 'components/StateHandlerComponent/StateHandlerComponent';
 import NeurosynthTable from 'components/Tables/NeurosynthTable/NeurosynthTable';
 import NeurosynthTableStyles from 'components/Tables/NeurosynthTable/NeurosynthTable.styles';
-import { useGetMetaAnalysesByProjectId } from 'hooks';
+import { useGetMetaAnalysesByIds } from 'hooks';
+import { useProjectMetaAnalyses } from 'pages/Projects/ProjectPage/ProjectStore';
+import { MetaAnalysisReturn } from 'neurosynth-compose-typescript-sdk';
 import { useHistory } from 'react-router-dom';
 
 const MetaAnalysesPage: React.FC = (props) => {
     const history = useHistory();
-    const { data, isLoading, isError } = useGetMetaAnalysesByProjectId();
+    const projectMetaAnalyses = useProjectMetaAnalyses() || [];
+    let metaAnalysisIds: string[] = [];
+    if (projectMetaAnalyses.length > 0) {
+        if (typeof projectMetaAnalyses[0] === 'string') {
+            metaAnalysisIds = projectMetaAnalyses as string[];
+        } else {
+            metaAnalysisIds = (projectMetaAnalyses as MetaAnalysisReturn[])
+                .map((metaAnalysis) => metaAnalysis.id)
+                .filter((id): id is string => id !== undefined);
+        }
+    }
+    const { data, isLoading, isError } = useGetMetaAnalysesByIds(metaAnalysisIds);
 
     return (
         <>

compose/neurosynth-frontend/src/neurostore-typescript-sdk

@@ -742,6 +742,7 @@ export const useUpdateProjectIsLoading = () =>
     useProjectStore((state) => state.metadata.updateProjectIsLoading);
 export const useProjectIsError = () => useProjectStore((state) => state.metadata.isError);
 export const useProjectUser = () => useProjectStore((state) => state.user);
+export const useProjectMetaAnalyses = () => useProjectStore((state) => state.meta_analyses);
 
 // curation retrieval hooks
 export const useProjectCurationColumns = () =>