[AN-160] Reorganize methods repository files (#5155)

sam-schu · web-flow · commit c41981c9080a · 2024-11-05T14:31:12.000Z
diff --git a/src/libs/ajax/methods/Methods.ts b/src/libs/ajax/methods/Methods.ts
@@ -3,16 +3,21 @@ import _ from 'lodash/fp';
 import * as qs from 'qs';
 import { authOpts } from 'src/auth/auth-session';
 import { fetchAgora, fetchOrchestration, fetchRawls } from 'src/libs/ajax/ajax-common';
-import { MethodQuery, MethodResponse } from 'src/libs/ajax/methods/methods-models';
-import { Snapshot } from 'src/snapshots/Snapshot';
+import {
+  MethodConfigACL,
+  MethodDefinition,
+  MethodQuery,
+  MethodResponse,
+  Snapshot,
+} from 'src/libs/ajax/methods/methods-models';
 
 export const Methods = (signal?: AbortSignal) => ({
   list: async (params): Promise<Snapshot[]> => {
     const res = await fetchAgora(`methods?${qs.stringify(params)}`, _.merge(authOpts(), { signal }));
     return res.json();
   },
 
-  definitions: async () => {
+  definitions: async (): Promise<MethodDefinition[]> => {
     const res = await fetchAgora('methods/definitions', _.merge(authOpts(), { signal }));
     return res.json();
   },
@@ -60,12 +65,12 @@ export const Methods = (signal?: AbortSignal) => ({
         return res.json();
       },
 
-      permissions: async () => {
+      permissions: async (): Promise<MethodConfigACL> => {
         const res = await fetchOrchestration(`api/${root}/permissions`, _.merge(authOpts(), { signal }));
         return res.json();
       },
 
-      setPermissions: async (payload) => {
+      setPermissions: async (payload: MethodConfigACL): Promise<MethodConfigACL> => {
         const res = await fetchOrchestration(
           `api/${root}/permissions`,
           _.mergeAll([authOpts(), jsonBody(payload), { signal, method: 'POST' }])
diff --git a/src/libs/ajax/methods/methods-models.ts b/src/libs/ajax/methods/methods-models.ts
@@ -1,3 +1,36 @@
+/**
+ * Type for Agora's MethodDefinition schema.
+ */
+export interface MethodDefinition {
+  namespace: string;
+  name: string;
+  synopsis: string;
+  managers: string[];
+  public: boolean;
+  numConfigurations: number;
+  numSnapshots: number;
+  entityType: string;
+}
+
+/**
+ * Corresponds to Agora's MethodResponse schema. Represents information about
+ * a method snapshot in the Broad Methods Repository.
+ */
+export interface Snapshot {
+  managers: string[];
+  name: string;
+  createDate: string;
+  documentation?: string;
+  entityType: string;
+  snapshotComment: string;
+  snapshotId: number;
+  namespace: string;
+  payload: string;
+  url: string;
+  public: boolean | undefined;
+  synopsis: string;
+}
+
 /**
  * Type for Orchestration's MethodQuery schema.
  *
@@ -35,3 +68,14 @@ export interface MethodResponse {
   payload?: string;
   entityType?: string;
 }
+
+export type WorkflowAccessLevel = 'NO ACCESS' | 'READER' | 'OWNER';
+export interface WorkflowUserPermissions {
+  user: string;
+  role: WorkflowAccessLevel;
+}
+
+/**
+ * Type for Orchestration's MethodConfigACL schema.
+ */
+export type MethodConfigACL = WorkflowUserPermissions[];
diff --git a/src/libs/routes.js b/src/libs/routes.js
@@ -22,13 +22,13 @@ import * as DatasetBuilder from 'src/pages/library/dataset-builder/DatasetBuilde
 import * as Datasets from 'src/pages/library/Datasets';
 import * as DataExplorer from 'src/pages/library/datasets/DataExplorer';
 import * as Showcase from 'src/pages/library/Showcase';
+import * as WorkflowDetails from 'src/pages/methods/workflow-details/WorkflowSummary';
+import * as WorkflowWdl from 'src/pages/methods/workflow-details/WorkflowWdl';
+import * as WorkflowList from 'src/pages/methods/WorkflowList';
 import * as NotFound from 'src/pages/NotFound';
 import * as Profile from 'src/pages/ProfilePage';
 import * as Support from 'src/pages/SupportPage';
 import * as UploadData from 'src/pages/UploadDataPage';
-import * as WorkflowDetails from 'src/pages/workflows/workflow/WorkflowSummary';
-import * as WorkflowWdl from 'src/pages/workflows/workflow/WorkflowWdl';
-import * as WorkflowList from 'src/pages/workflows/WorkflowList';
 import * as WorkspaceList from 'src/pages/workspaces/List';
 import * as WorkspaceFiles from 'src/pages/workspaces/workspace/Files';
 import * as JobHistory from 'src/pages/workspaces/workspace/JobHistory';
diff --git a/src/libs/state.ts b/src/libs/state.ts
@@ -5,11 +5,11 @@ import { AuthTokenState } from 'src/auth/auth';
 import { OidcUser } from 'src/auth/oidc-broker';
 import { Dataset } from 'src/libs/ajax/Catalog';
 import { EcmLinkAccountResponse } from 'src/libs/ajax/ExternalCredentials';
+import { Snapshot } from 'src/libs/ajax/methods/methods-models';
 import { OidcConfig } from 'src/libs/ajax/OAuth2';
 import { SamTermsOfServiceConfig } from 'src/libs/ajax/TermsOfService';
 import { NihDatasetPermission, SamUserAllowances, SamUserAttributes, SamUserResponse } from 'src/libs/ajax/User';
 import { getLocalStorage, getSessionStorage, staticStorageSlot } from 'src/libs/browser-storage';
-import { Snapshot } from 'src/snapshots/Snapshot';
 import type { WorkspaceInfo, WorkspaceWrapper } from 'src/workspaces/utils';
 
 export const routeHandlersStore = atom<unknown[]>([]);
diff --git a/src/pages/methods/WorkflowList.test.tsx b/src/pages/methods/WorkflowList.test.tsx
@@ -6,13 +6,13 @@ import React from 'react';
 import { Ajax, AjaxContract } from 'src/libs/ajax';
 import { MethodsAjaxContract } from 'src/libs/ajax/methods/Methods';
 import { MethodResponse } from 'src/libs/ajax/methods/methods-models';
+import { MethodDefinition } from 'src/libs/ajax/methods/methods-models';
 import { createMethodProvider } from 'src/libs/ajax/methods/providers/CreateMethodProvider';
 import * as Nav from 'src/libs/nav';
 import { getLink } from 'src/libs/nav';
 import { notify } from 'src/libs/notifications';
 import { TerraUser, TerraUserState, userStore } from 'src/libs/state';
-import { MethodDefinition } from 'src/pages/workflows/workflow-utils';
-import { WorkflowList } from 'src/pages/workflows/WorkflowList';
+import { WorkflowList } from 'src/pages/methods/WorkflowList';
 import { asMockedFn, renderWithAppContexts as render } from 'src/testing/test-utils';
 
 jest.mock('src/libs/ajax');
@@ -23,9 +23,9 @@ jest.mock('src/libs/nav', () => ({
   goToPath: jest.fn(),
 }));
 
-type WDLEditorExports = typeof import('src/pages/workflows/common/WDLEditor');
-jest.mock('src/pages/workflows/common/WDLEditor', (): WDLEditorExports => {
-  const mockWDLEditorModule = jest.requireActual('src/pages/workflows/common/WDLEditor.mock');
+type WDLEditorExports = typeof import('src/workflows/methods/WDLEditor');
+jest.mock('src/workflows/methods/WDLEditor', (): WDLEditorExports => {
+  const mockWDLEditorModule = jest.requireActual('src/workflows/methods/WDLEditor.mock');
   return {
     WDLEditor: mockWDLEditorModule.MockWDLEditor,
   };
diff --git a/src/pages/methods/WorkflowList.tsx b/src/pages/methods/WorkflowList.tsx
@@ -10,15 +10,15 @@ import { TabBar } from 'src/components/tabBars';
 import { FlexTable, HeaderCell, Paginator, Sortable, TooltipCell } from 'src/components/table';
 import { TopBar } from 'src/components/TopBar';
 import { Ajax } from 'src/libs/ajax';
+import { MethodDefinition } from 'src/libs/ajax/methods/methods-models';
 import { createMethodProvider } from 'src/libs/ajax/methods/providers/CreateMethodProvider';
 import * as Nav from 'src/libs/nav';
 import { notify } from 'src/libs/notifications';
 import { useCancellation, useOnMount } from 'src/libs/react-utils';
 import { getTerraUser } from 'src/libs/state';
 import * as Utils from 'src/libs/utils';
 import { withBusyState } from 'src/libs/utils';
-import { WorkflowModal } from 'src/pages/workflows/workflow/common/WorkflowModal';
-import { MethodDefinition } from 'src/pages/workflows/workflow-utils';
+import { WorkflowModal } from 'src/workflows/methods/modals/WorkflowModal';
 
 // Note: The first tab key in this array will determine the default tab selected
 // if the tab query parameter is not present or has an invalid value (and when
diff --git a/src/pages/methods/workflow-details/WorkflowSummary.test.ts b/src/pages/methods/workflow-details/WorkflowSummary.test.ts
@@ -1,7 +1,7 @@
 import { fireEvent, screen } from '@testing-library/react';
 import { h } from 'react-hyperscript-helpers';
 import { snapshotStore } from 'src/libs/state';
-import { BaseWorkflowSummary } from 'src/pages/workflows/workflow/WorkflowSummary';
+import { BaseWorkflowSummary } from 'src/pages/methods/workflow-details/WorkflowSummary';
 import { renderWithAppContexts } from 'src/testing/test-utils';
 
 jest.mock('src/libs/notifications');
diff --git a/src/pages/methods/workflow-details/WorkflowSummary.ts b/src/pages/methods/workflow-details/WorkflowSummary.ts
@@ -12,8 +12,8 @@ import { withErrorReporting } from 'src/libs/error';
 import { forwardRefWithName, useStore } from 'src/libs/react-utils';
 import { snapshotStore } from 'src/libs/state';
 import * as Style from 'src/libs/style';
-import { WorkflowRightBoxSection } from 'src/pages/workflows/components/WorkflowRightBoxSection';
-import { wrapWorkflows } from 'src/pages/workflows/workflow/WorkflowWrapper';
+import { wrapWorkflows } from 'src/pages/methods/workflow-details/WorkflowWrapper';
+import { WorkflowRightBoxSection } from 'src/workflows/methods/WorkflowRightBoxSection';
 import { InfoRow } from 'src/workspaces/dashboard/InfoRow';
 
 export const BaseWorkflowSummary = () => {
diff --git a/src/pages/methods/workflow-details/WorkflowWdl.test.ts b/src/pages/methods/workflow-details/WorkflowWdl.test.ts
@@ -1,7 +1,7 @@
 import { screen } from '@testing-library/react';
 import { h } from 'react-hyperscript-helpers';
 import { snapshotStore } from 'src/libs/state';
-import { BaseWorkflowWdl } from 'src/pages/workflows/workflow/WorkflowWdl';
+import { BaseWorkflowWdl } from 'src/pages/methods/workflow-details/WorkflowWdl';
 import { renderWithAppContexts } from 'src/testing/test-utils';
 
 jest.mock('src/libs/ajax');
diff --git a/src/pages/methods/workflow-details/WorkflowWdl.ts b/src/pages/methods/workflow-details/WorkflowWdl.ts
@@ -7,7 +7,7 @@ import * as breadcrumbs from 'src/components/breadcrumbs';
 import WDLViewer from 'src/components/WDLViewer';
 import { forwardRefWithName } from 'src/libs/react-utils';
 import { snapshotStore } from 'src/libs/state';
-import { wrapWorkflows } from 'src/pages/workflows/workflow/WorkflowWrapper';
+import { wrapWorkflows } from 'src/pages/methods/workflow-details/WorkflowWrapper';
 
 export const BaseWorkflowWdl = () => {
   const { name, snapshotId, payload } = useStore(snapshotStore);
diff --git a/src/pages/methods/workflow-details/WorkflowWrapper.test.tsx b/src/pages/methods/workflow-details/WorkflowWrapper.test.tsx
@@ -6,13 +6,13 @@ import React from 'react';
 import * as breadcrumbs from 'src/components/breadcrumbs';
 import { Ajax, AjaxContract } from 'src/libs/ajax';
 import { MethodsAjaxContract } from 'src/libs/ajax/methods/Methods';
+import { Snapshot } from 'src/libs/ajax/methods/methods-models';
 import * as ExportWorkflowToWorkspaceProvider from 'src/libs/ajax/workspaces/providers/ExportWorkflowToWorkspaceProvider';
 import { errorWatcher } from 'src/libs/error.mock';
 import { goToPath } from 'src/libs/nav';
 import { forwardRefWithName } from 'src/libs/react-utils';
 import { snapshotsListStore, snapshotStore, TerraUser, TerraUserState, userStore } from 'src/libs/state';
-import { WorkflowsContainer, wrapWorkflows } from 'src/pages/workflows/workflow/WorkflowWrapper';
-import { Snapshot } from 'src/snapshots/Snapshot';
+import { WorkflowsContainer, wrapWorkflows } from 'src/pages/methods/workflow-details/WorkflowWrapper';
 import { asMockedFn, partial, renderWithAppContexts as render, SelectHelper } from 'src/testing/test-utils';
 import { useWorkspaces } from 'src/workspaces/common/state/useWorkspaces';
 import { AzureContext, WorkspaceInfo, WorkspaceWrapper } from 'src/workspaces/utils';
diff --git a/src/pages/methods/workflow-details/WorkflowWrapper.ts b/src/pages/methods/workflow-details/WorkflowWrapper.ts
@@ -8,6 +8,7 @@ import FooterWrapper from 'src/components/FooterWrapper';
 import { TabBar } from 'src/components/tabBars';
 import { TopBar } from 'src/components/TopBar';
 import { Ajax } from 'src/libs/ajax';
+import { Snapshot } from 'src/libs/ajax/methods/methods-models';
 import { makeExportWorkflowFromMethodsRepoProvider } from 'src/libs/ajax/workspaces/providers/ExportWorkflowToWorkspaceProvider';
 import { ErrorCallback, withErrorReporting } from 'src/libs/error';
 import * as Nav from 'src/libs/nav';
@@ -16,11 +17,10 @@ import { getTerraUser, snapshotsListStore, snapshotStore } from 'src/libs/state'
 import * as Style from 'src/libs/style';
 import * as Utils from 'src/libs/utils';
 import { withBusyState } from 'src/libs/utils';
-import { PermissionsModal } from 'src/pages/workflows/workflow/common/PermissionsModal';
-import { Snapshot } from 'src/snapshots/Snapshot';
-import DeleteSnapshotModal from 'src/workflows/modals/DeleteSnapshotModal';
+import DeleteSnapshotModal from 'src/workflows/methods/modals/DeleteSnapshotModal';
+import { PermissionsModal } from 'src/workflows/methods/modals/PermissionsModal';
+import SnapshotActionMenu from 'src/workflows/methods/SnapshotActionMenu';
 import ExportWorkflowModal from 'src/workflows/modals/ExportWorkflowModal';
-import SnapshotActionMenu from 'src/workflows/SnapshotActionMenu';
 import { isGoogleWorkspace, WorkspaceInfo, WorkspaceWrapper } from 'src/workspaces/utils';
 import * as WorkspaceUtils from 'src/workspaces/utils';
 
diff --git a/src/pages/workflows/workflow-utils.ts b/src/pages/workflows/workflow-utils.ts
diff --git a/src/pages/workflows/workflow/workflows-acl-utils.ts b/src/pages/workflows/workflow/workflows-acl-utils.ts
diff --git a/src/snapshots/Snapshot.ts b/src/snapshots/Snapshot.ts
diff --git a/src/workflows/methods/SnapshotActionMenu.test.tsx b/src/workflows/methods/SnapshotActionMenu.test.tsx
@@ -2,7 +2,7 @@ import { act, screen } from '@testing-library/react';
 import userEvent, { UserEvent } from '@testing-library/user-event';
 import React from 'react';
 import { renderWithAppContexts as render } from 'src/testing/test-utils';
-import SnapshotActionMenu from 'src/workflows/SnapshotActionMenu';
+import SnapshotActionMenu from 'src/workflows/methods/SnapshotActionMenu';
 
 const mockOnDelete = jest.fn();
 const mockOnEditPermissions = jest.fn();
diff --git a/src/workflows/methods/SnapshotActionMenu.tsx b/src/workflows/methods/SnapshotActionMenu.tsx
diff --git a/src/workflows/methods/WDLEditor.mock.tsx b/src/workflows/methods/WDLEditor.mock.tsx
diff --git a/src/workflows/methods/WDLEditor.test.tsx b/src/workflows/methods/WDLEditor.test.tsx
@@ -1,6 +1,6 @@
 import { render, screen } from '@testing-library/react';
 import React from 'react';
-import { WDLEditor } from 'src/pages/workflows/common/WDLEditor';
+import { WDLEditor } from 'src/workflows/methods/WDLEditor';
 
 describe('WDLEditor', () => {
   it('renders the editor', () => {
diff --git a/src/workflows/methods/WDLEditor.tsx b/src/workflows/methods/WDLEditor.tsx
diff --git a/src/workflows/methods/WorkflowRightBoxSection.tsx b/src/workflows/methods/WorkflowRightBoxSection.tsx
diff --git a/src/workflows/methods/modals/DeleteSnapshotModal.test.tsx b/src/workflows/methods/modals/DeleteSnapshotModal.test.tsx
@@ -2,7 +2,7 @@ import { act, screen, within } from '@testing-library/react';
 import userEvent, { UserEvent } from '@testing-library/user-event';
 import React from 'react';
 import { renderWithAppContexts as render } from 'src/testing/test-utils';
-import DeleteSnapshotModal from 'src/workflows/modals/DeleteSnapshotModal';
+import DeleteSnapshotModal from 'src/workflows/methods/modals/DeleteSnapshotModal';
 
 const mockOnConfirm = jest.fn();
 const mockOnDismiss = jest.fn();
diff --git a/src/workflows/methods/modals/DeleteSnapshotModal.tsx b/src/workflows/methods/modals/DeleteSnapshotModal.tsx
diff --git a/src/workflows/methods/modals/PermissionsModal.test.tsx b/src/workflows/methods/modals/PermissionsModal.test.tsx
@@ -4,9 +4,9 @@ import userEvent, { UserEvent } from '@testing-library/user-event';
 import React from 'react';
 import { Ajax, AjaxContract } from 'src/libs/ajax';
 import { reportError } from 'src/libs/error';
-import { PermissionsModal } from 'src/pages/workflows/workflow/common/PermissionsModal';
-import { WorkflowsPermissions } from 'src/pages/workflows/workflow/workflows-acl-utils';
 import { asMockedFn, renderWithAppContexts, SelectHelper } from 'src/testing/test-utils';
+import { PermissionsModal } from 'src/workflows/methods/modals/PermissionsModal';
+import { WorkflowsPermissions } from 'src/workflows/methods/workflows-acl-utils';
 
 jest.mock('src/libs/ajax');
 
diff --git a/src/workflows/methods/modals/PermissionsModal.tsx b/src/workflows/methods/modals/PermissionsModal.tsx
@@ -27,7 +27,7 @@ import {
   WorkflowAccessLevel,
   WorkflowsPermissions,
   WorkflowUserPermissions,
-} from 'src/pages/workflows/workflow/workflows-acl-utils';
+} from 'src/workflows/methods/workflows-acl-utils';
 import validate from 'validate.js';
 
 type WorkflowPermissionsModalProps = {
@@ -214,9 +214,13 @@ export const PermissionsModal = (props: WorkflowPermissionsModalProps) => {
   };
 
   const save = withBusyState(setWorking, async () => {
-    const toBeDeleted = _.remove((entry) => userEmails.includes(entry.user), originalPermissions);
+    const toBeDeleted: WorkflowsPermissions = _.remove((entry) => userEmails.includes(entry.user), originalPermissions);
+    const toBeDeletedPermissionUpdates: WorkflowsPermissions = _.map(
+      ({ user }) => ({ user, role: 'NO ACCESS' }),
+      toBeDeleted
+    );
 
-    const permissionUpdates = [...permissions, ..._.map(({ user }) => ({ user, role: 'NO ACCESS' }), toBeDeleted)];
+    const permissionUpdates: WorkflowsPermissions = [...permissions, ...toBeDeletedPermissionUpdates];
 
     try {
       await Ajax(signal).Methods.method(namespace, name, selectedSnapshot).setPermissions(permissionUpdates);
diff --git a/src/workflows/methods/modals/WorkflowModal.test.tsx b/src/workflows/methods/modals/WorkflowModal.test.tsx
@@ -4,12 +4,12 @@ import _ from 'lodash/fp';
 import React from 'react';
 import { MethodResponse } from 'src/libs/ajax/methods/methods-models';
 import { CreateMethodProvider } from 'src/libs/ajax/methods/providers/CreateMethodProvider';
-import { WorkflowModal } from 'src/pages/workflows/workflow/common/WorkflowModal';
 import { renderWithAppContexts as render } from 'src/testing/test-utils';
+import { WorkflowModal } from 'src/workflows/methods/modals/WorkflowModal';
 
-type WDLEditorExports = typeof import('src/pages/workflows/common/WDLEditor');
-jest.mock('src/pages/workflows/common/WDLEditor', (): WDLEditorExports => {
-  const mockWDLEditorModule = jest.requireActual('src/pages/workflows/common/WDLEditor.mock');
+type WDLEditorExports = typeof import('src/workflows/methods/WDLEditor');
+jest.mock('src/workflows/methods/WDLEditor', (): WDLEditorExports => {
+  const mockWDLEditorModule = jest.requireActual('src/workflows/methods/WDLEditor.mock');
   return {
     WDLEditor: mockWDLEditorModule.MockWDLEditor,
   };
diff --git a/src/workflows/methods/modals/WorkflowModal.tsx b/src/workflows/methods/modals/WorkflowModal.tsx
@@ -10,7 +10,7 @@ import colors from 'src/libs/colors';
 import { FormLabel } from 'src/libs/forms';
 import * as Utils from 'src/libs/utils';
 import { withBusyState } from 'src/libs/utils';
-import { WDLEditor } from 'src/pages/workflows/common/WDLEditor';
+import { WDLEditor } from 'src/workflows/methods/WDLEditor';
 import validate from 'validate.js';
 
 export interface WorkflowModalProps {
diff --git a/src/workflows/methods/workflows-acl-utils.ts b/src/workflows/methods/workflows-acl-utils.ts
@@ -0,0 +1,9 @@
+import { WorkflowUserPermissions } from 'src/libs/ajax/methods/methods-models';
+
+export type {
+  WorkflowAccessLevel,
+  WorkflowUserPermissions,
+  MethodConfigACL as WorkflowsPermissions,
+} from 'src/libs/ajax/methods/methods-models';
+
+export const publicUser = ({ user }: WorkflowUserPermissions): boolean => user === 'public';
