initial working pipeline steps for type Hybrid Sim (#1201)

* initial working pipeline steps for type Hybrid Sim * add UI for changing project type * import fix * add selection page for publish vs amend/revise * formatting * linting * Add change_project_type function and test cases (#1214) * fixes for citations/tree view; add listings to entity view * update publication ingest to add all versions * add project selection to copy modal * linting fixes --------- Co-authored-by: Van Go <[email protected]>
DesignSafe-CI · Apr 22, 2024 · 2605554 · 2605554
1 parent db25814
commit 2605554
Show file tree

Hide file tree

Showing 71 changed files with 3,744 additions and 239 deletions.
diff --git a/client/modules/_hooks/src/datafiles/projects/UseValidateEntitySelection.ts b/client/modules/_hooks/src/datafiles/projects/UseValidateEntitySelection.ts
@@ -0,0 +1,32 @@
+import { useMutation } from '@tanstack/react-query';
+import apiClient from '../../apiClient';
+
+export type TPipelineValidationResult = {
+  errorType: string;
+  name: string;
+  title: string;
+  missing: string[];
+};
+
+async function validateEntitySelection(
+  projectId: string,
+  entityUuids: string[]
+) {
+  const res = await apiClient.post<{ result: TPipelineValidationResult[] }>(
+    `/api/projects/v2/${projectId}/entities/validate/`,
+    { entityUuids }
+  );
+  return res.data;
+}
+
+export function useValidateEntitySelection() {
+  return useMutation({
+    mutationFn: ({
+      projectId,
+      entityUuids,
+    }: {
+      projectId: string;
+      entityUuids: string[];
+    }) => validateEntitySelection(projectId, entityUuids),
+  });
+}
diff --git a/client/modules/_hooks/src/datafiles/projects/index.ts b/client/modules/_hooks/src/datafiles/projects/index.ts
@@ -12,3 +12,7 @@ export { useRemoveEntityFromTree } from './useRemoveEntityFromTree';
 export { useAddFileAssociation } from './useAddFileAssociation';
 export { useRemoveFileAssociation } from './useRemoveFileAssociation';
 export { useSetFileTags } from './useSetFileTags';
+export { usePatchEntityMetadata } from './usePatchEntityMetadata';
+export { usePatchProjectMetadata } from './usePatchProjectMetadata';
+export { useValidateEntitySelection } from './UseValidateEntitySelection';
+export type { TPipelineValidationResult } from './UseValidateEntitySelection';
diff --git a/client/modules/_hooks/src/datafiles/projects/types.ts b/client/modules/_hooks/src/datafiles/projects/types.ts
@@ -91,11 +91,14 @@ export type TBaseProjectValue = {
   dois: string[];
   fileObjs: TFileObj[];
   fileTags: TFileTag[];
+
+  license?: string;
 };
 
-type TEntityValue = {
+export type TEntityValue = {
   title: string;
   description?: string;
+  projectId?: string;
   authors?: TProjectUser[];
   fileObjs?: TFileObj[];
   fileTags: TFileTag[];
@@ -116,3 +119,20 @@ export type TBaseProject = TProjectMeta & {
 export type TEntityMeta = TProjectMeta & {
   value: TEntityValue;
 };
+
+export type TPreviewTreeData = {
+  name: string;
+  id: string;
+  uuid: string;
+  value: TEntityValue;
+  order: number;
+  children: TPreviewTreeData[];
+};
+
+export type TTreeData = {
+  name: string;
+  id: string;
+  uuid: string;
+  order: number;
+  children: TTreeData[];
+};
diff --git a/client/modules/_hooks/src/datafiles/projects/usePatchEntityMetadata.ts b/client/modules/_hooks/src/datafiles/projects/usePatchEntityMetadata.ts
@@ -0,0 +1,36 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query';
+import apiClient from '../../apiClient';
+
+async function patchEntityMetadata(
+  entityUuid: string,
+  patchMetadata: Record<string, unknown>
+) {
+  // Replace undefined with null so that deleted values are unset instead of ignored.
+  Object.keys(patchMetadata).forEach((k) => {
+    if (patchMetadata[k] === undefined) {
+      patchMetadata[k] = null;
+    }
+  });
+  const res = await apiClient.patch(
+    `/api/projects/v2/entities/${entityUuid}/`,
+    { patchMetadata }
+  );
+  return res.data;
+}
+
+export function usePatchEntityMetadata() {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({
+      entityUuid,
+      patchMetadata,
+    }: {
+      patchMetadata: Record<string, unknown>;
+      entityUuid: string;
+    }) => patchEntityMetadata(entityUuid, patchMetadata),
+    onSuccess: () =>
+      queryClient.invalidateQueries({
+        queryKey: ['datafiles', 'projects', 'detail'],
+      }),
+  });
+}
diff --git a/client/modules/_hooks/src/datafiles/projects/usePatchProjectMetadata.ts b/client/modules/_hooks/src/datafiles/projects/usePatchProjectMetadata.ts
@@ -0,0 +1,33 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query';
+import apiClient from '../../apiClient';
+
+async function patchProjectMetadata(
+  projectId: string,
+  patchMetadata: Record<string, unknown>
+) {
+  // Replace undefined with null so that deleted values are unset instead of ignored.
+  Object.keys(patchMetadata).forEach((k) => {
+    if (patchMetadata[k] === undefined) {
+      patchMetadata[k] = null;
+    }
+  });
+  const res = await apiClient.patch(`/api/projects/v2/${projectId}/`, {
+    patchMetadata,
+  });
+  return res.data;
+}
+
+export function usePatchProjectMetadata(projectId: string) {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({
+      patchMetadata,
+    }: {
+      patchMetadata: Record<string, unknown>;
+    }) => patchProjectMetadata(projectId, patchMetadata),
+    onSuccess: () =>
+      queryClient.invalidateQueries({
+        queryKey: ['datafiles', 'projects', 'detail', projectId],
+      }),
+  });
+}
diff --git a/client/modules/_hooks/src/datafiles/projects/useProjectDetail.ts b/client/modules/_hooks/src/datafiles/projects/useProjectDetail.ts
@@ -1,12 +1,12 @@
 import { useQuery } from '@tanstack/react-query';
 import apiClient from '../../apiClient';
-import { TBaseProject, TEntityMeta, TFileTag } from './types';
+import { TBaseProject, TEntityMeta, TFileTag, TTreeData } from './types';
 import { useMemo } from 'react';
 
 type TProjectDetailResponse = {
   baseProject: TBaseProject;
   entities: TEntityMeta[];
-  tree: unknown;
+  tree: TTreeData;
 };
 
 async function getProjectDetail({

diff --git a/client/modules/_hooks/src/datafiles/projects/useProjectPreview.tsx b/client/modules/_hooks/src/datafiles/projects/useProjectPreview.tsx
@@ -1,11 +1,11 @@
 import { useQuery } from '@tanstack/react-query';
 import apiClient from '../../apiClient';
-import { TBaseProject, TEntityMeta } from './types';
+import { TBaseProject, TEntityMeta, TPreviewTreeData } from './types';
 
 type TProjectPreviewResponse = {
   baseProject: TBaseProject;
   entities: TEntityMeta[];
-  tree: unknown;
+  tree: TPreviewTreeData;
 };
 
 async function getProjectPreview({

diff --git a/client/modules/_hooks/src/datafiles/publications/usePublicationDetail.ts b/client/modules/_hooks/src/datafiles/publications/usePublicationDetail.ts
@@ -1,9 +1,22 @@
 import { useQuery } from '@tanstack/react-query';
 import apiClient from '../../apiClient';
-import { TBaseProjectValue } from '../projects';
+import { TBaseProjectValue, TEntityValue } from '../projects';
+
+export type TPublicationTree<T> = {
+  name: string;
+  uuid: string;
+  id: string;
+  basePath: string;
+  value: T;
+  publicationDate: string;
+  status: string;
+  order: number;
+  version?: number;
+  children: TPublicationTree<TEntityValue>[];
+};
 
 export type TPublicationDetailResponse = {
-  tree: unknown;
+  tree: TPublicationTree<TBaseProjectValue | undefined>;
   baseProject: TBaseProjectValue;
 };
 

diff --git a/client/modules/_hooks/src/datafiles/useFileListing.ts b/client/modules/_hooks/src/datafiles/useFileListing.ts
@@ -45,6 +45,7 @@ type TFileListingHookArgs = {
   path: string;
   scheme: string;
   pageSize: number;
+  disabled?: boolean;
 };
 
 type TFileListingPageParam = {
@@ -58,6 +59,7 @@ function useFileListing({
   path,
   scheme = 'private',
   pageSize = 100,
+  disabled = false,
 }: TFileListingHookArgs) {
   return useInfiniteQuery<
     FileListingResponse,
@@ -78,6 +80,7 @@ function useFileListing({
           signal,
         }
       ),
+    enabled: !disabled,
     getNextPageParam: (lastPage, allpages): TFileListingPageParam | null => {
       return lastPage.listing.length >= pageSize
         ? { page: allpages.length, nextPageToken: lastPage.nextPageToken }

diff --git a/client/modules/_hooks/src/datafiles/usePathDisplayName.ts b/client/modules/_hooks/src/datafiles/usePathDisplayName.ts
@@ -31,7 +31,7 @@ function _getPathDisplayName(
     return 'My Data';
   }
   if (system === 'designsafe.storage.frontera.work' && path === usernamePath) {
-    return 'My Data (Work)';
+    return 'HPC Work';
   }
 
   return decodeURIComponent(path).split('/').slice(-1)[0] || 'Data Files';

diff --git a/client/modules/_hooks/src/datafiles/useSelectedFiles.ts b/client/modules/_hooks/src/datafiles/useSelectedFiles.ts
@@ -19,24 +19,48 @@ export function useSelectedFiles(
 
   const queryClient = useQueryClient();
   const setSelectedFiles = useCallback(
-    (selection: TFileListing[]) =>
-      queryClient.setQueryData(queryKey, selection),
+    (selection: TFileListing[]) => {
+      queryClient.setQueryData(queryKey, selection);
+      queryClient.invalidateQueries({ queryKey: ['rows-for-system'] });
+    },
     [queryKey, queryClient]
   );
 
-  return { selectedFiles: selectedRowsQuery.data, setSelectedFiles };
+  const unsetSelections = useCallback(() => {
+    queryClient.setQueriesData({ queryKey: ['selected-rows'] }, () => []);
+    queryClient.invalidateQueries({ queryKey: ['rows-for-system'] });
+  }, [queryClient]);
+
+  return {
+    selectedFiles: selectedRowsQuery.data,
+    setSelectedFiles,
+    unsetSelections,
+  };
 }
 
 export function useSelectedFilesForSystem(api: string, system: string) {
   // Get all selected files matching a given system.
   // Used when multiple listings can be present in a single page, e.g. publications.
-  const queryKey = ['selected-rows', api, system];
+
   const queryClient = useQueryClient();
-  const selections = queryClient.getQueriesData<TFileListing[]>({ queryKey });
+  /*
+  const selections = useMemo(() => {
+    const queryKey = ['selected-rows', api, system];
+    return queryClient.getQueriesData<TFileListing[]>({ queryKey });
+  }, [api, system, queryClient]);
+  */
+
+  const { data: selections } = useQuery({
+    queryKey: ['rows-for-system', api, system],
+    queryFn: () => {
+      const queryKey = ['selected-rows', api, system];
+      return queryClient.getQueriesData<TFileListing[]>({ queryKey });
+    },
+  });
 
   const reducedSelections = useMemo(() => {
     const allSelections: TFileListing[] = [];
-    selections.forEach((s) => s[1] && allSelections.push(...s[1]));
+    (selections ?? []).forEach((s) => s[1] && allSelections.push(...s[1]));
     return allSelections;
   }, [selections]);
   return reducedSelections;

diff --git a/client/modules/datafiles/src/AddFileFolder/AddFileFolder.module.css b/client/modules/datafiles/src/AddFileFolder/AddFileFolder.module.css
@@ -35,7 +35,6 @@ a.navLink:not(:global(.active)):hover > div {
 }
 
 .customUl {
-  border: 1px solid #e3e3e3;
   list-style-type: none;
   padding-left: 0;
 }

diff --git a/client/modules/datafiles/src/AddFileFolder/AddFileFolder.tsx b/client/modules/datafiles/src/AddFileFolder/AddFileFolder.tsx
@@ -102,22 +102,23 @@ export const AddFileFolder: React.FC = () => {
                   )}
                 </DatafilesModal.UploadFolder>
               </li>
-              <li
-                onClick={(e) => {
-                  e.preventDefault();
-                  window.location.href =
-                    'https://www.designsafe-ci.org/rw/user-guides/data-transfer-guide/';
-                }}
-              >
-                <Button
-                  type="text"
-                  className={`${styles.active} ${styles.fullWidthButton}`}
+              <li>
+                <a
+                  href="https://www.designsafe-ci.org/rw/user-guides/data-transfer-guide/"
+                  target="_blank"
+                  rel="noopener noreferrer"
+                  style={{ padding: '0px' }}
                 >
-                  <span className="fa-stack fa-lg">
-                    <i className="fa fa-hdd-o fa-stack-2x" role="none"></i>
-                  </span>
-                  <span>Bulk Data Transfer</span>
-                </Button>
+                  <Button
+                    type="text"
+                    className={`${styles.active} ${styles.fullWidthButton}`}
+                  >
+                    <span className="fa-stack fa-lg">
+                      <i className="fa fa-hdd-o fa-stack-2x" role="none"></i>
+                    </span>
+                    <span>Bulk Data Transfer</span>
+                  </Button>
+                </a>
               </li>
             </ul>
           </div>

diff --git a/client/modules/datafiles/src/DatafilesBreadcrumb/DatafilesBreadcrumb.tsx b/client/modules/datafiles/src/DatafilesBreadcrumb/DatafilesBreadcrumb.tsx
@@ -36,18 +36,22 @@ export const DatafilesBreadcrumb: React.FC<
     baseRoute: string;
     systemRoot: string;
     systemRootAlias?: string;
+    skipBreadcrumbs?: number; // Number of path elements to skip when generating breadcrumbs
   } & BreadcrumbProps
 > = ({
   initialBreadcrumbs,
   path,
   baseRoute,
   systemRoot,
   systemRootAlias,
+  skipBreadcrumbs,
   ...props
 }) => {
   const breadcrumbItems = [
     ...initialBreadcrumbs,
-    ...getPathRoutes(baseRoute, path, systemRoot, systemRootAlias),
+    ...getPathRoutes(baseRoute, path, systemRoot, systemRootAlias).slice(
+      skipBreadcrumbs ?? 0
+    ),
   ];
 
   return (
@@ -67,19 +71,32 @@ function isUserHomeSystem(system: string) {
 }
 
 export const BaseFileListingBreadcrumb: React.FC<
-  { api: string; system: string; path: string } & BreadcrumbProps
-> = ({ api, system, path, ...props }) => {
+  {
+    api: string;
+    system: string;
+    path: string;
+    systemRootAlias?: string;
+    initialBreadcrumbs?: { title: string; path: string }[];
+  } & BreadcrumbProps
+> = ({
+  api,
+  system,
+  path,
+  systemRootAlias,
+  initialBreadcrumbs = [],
+  ...props
+}) => {
   const { user } = useAuthenticatedUser();
 
   return (
     <DatafilesBreadcrumb
-      initialBreadcrumbs={[]}
+      initialBreadcrumbs={initialBreadcrumbs ?? []}
       path={path}
       baseRoute={`/${api}/${system}`}
       systemRoot={
         isUserHomeSystem(system) ? encodeURIComponent('/' + user?.username) : ''
       }
-      systemRootAlias={getSystemRootDisplayName(api, system)}
+      systemRootAlias={systemRootAlias || getSystemRootDisplayName(api, system)}
       {...props}
     />
   );