services/workbench2/src/views/process-panel/process-panel-root.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import React from "react";
   6 import { StyleRulesCallback, WithStyles, withStyles } from "@material-ui/core";
   7 import { ProcessIcon } from "components/icon/icon";
   8 import { Process } from "store/processes/process";
   9 import { SubprocessPanel } from "views/subprocess-panel/subprocess-panel";
  10 import { SubprocessFilterDataProps } from "components/subprocess-filter/subprocess-filter";
  11 import { MPVContainer, MPVPanelContent, MPVPanelState } from "components/multi-panel-view/multi-panel-view";
  12 import { ArvadosTheme } from "common/custom-theme";
  13 import { ProcessDetailsCard } from "./process-details-card";
  14 import { ProcessIOCard, ProcessIOCardType, ProcessIOParameter } from "./process-io-card";
  15 import { ProcessResourceCard } from "./process-resource-card";
  16 import { getProcessPanelLogs, ProcessLogsPanel } from "store/process-logs-panel/process-logs-panel";
  17 import { ProcessLogsCard } from "./process-log-card";
  18 import { FilterOption } from "views/process-panel/process-log-form";
  19 import { getInputCollectionMounts } from "store/processes/processes-actions";
  20 import { WorkflowInputsData } from "models/workflow";
  21 import { CommandOutputParameter } from "cwlts/mappings/v1.0/CommandOutputParameter";
  22 import { AuthState } from "store/auth/auth-reducer";
  23 import { ProcessCmdCard } from "./process-cmd-card";
  24 import { ContainerRequestResource } from "models/container-request";
  25 import { OutputDetails, NodeInstanceType } from "store/process-panel/process-panel";
  26 import { NotFoundView } from 'views/not-found-panel/not-found-panel';
  27
  28 type CssRules = "root";
  29
  30 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  31     root: {
  32         width: "100%",
  33     },
  34 });
  35
  36 export interface ProcessPanelRootDataProps {
  37     process?: Process;
  38     subprocesses: Array<Process>;
  39     filters: Array<SubprocessFilterDataProps>;
  40     processLogsPanel: ProcessLogsPanel;
  41     auth: AuthState;
  42     inputRaw: WorkflowInputsData | null;
  43     inputParams: ProcessIOParameter[] | null;
  44     outputData: OutputDetails | null;
  45     outputDefinitions: CommandOutputParameter[];
  46     outputParams: ProcessIOParameter[] | null;
  47     nodeInfo: NodeInstanceType | null;
  48 }
  49
  50 export interface ProcessPanelRootActionProps {
  51     onContextMenu: (event: React.MouseEvent<HTMLElement>, process: Process) => void;
  52     onToggle: (status: string) => void;
  53     cancelProcess: (uuid: string) => void;
  54     startProcess: (uuid: string) => void;
  55     resumeOnHoldWorkflow: (uuid: string) => void;
  56     onLogFilterChange: (filter: FilterOption) => void;
  57     navigateToLog: (uuid: string) => void;
  58     onCopyToClipboard: (uuid: string) => void;
  59     loadInputs: (containerRequest: ContainerRequestResource) => void;
  60     loadOutputs: (containerRequest: ContainerRequestResource) => void;
  61     loadNodeJson: (containerRequest: ContainerRequestResource) => void;
  62     loadOutputDefinitions: (containerRequest: ContainerRequestResource) => void;
  63     updateOutputParams: () => void;
  64     pollProcessLogs: (processUuid: string) => Promise<void>;
  65 }
  66
  67 export type ProcessPanelRootProps = ProcessPanelRootDataProps & ProcessPanelRootActionProps & WithStyles<CssRules>;
  68
  69 const panelsData: MPVPanelState[] = [
  70     { name: "Details" },
  71     { name: "Logs", visible: true },
  72     { name: "Subprocesses" },
  73     { name: "Outputs" },
  74     { name: "Inputs" },
  75     { name: "Command" },
  76     { name: "Resources" },
  77 ];
  78
  79 export const ProcessPanelRoot = withStyles(styles)(
  80     ({
  81         process,
  82         auth,
  83         processLogsPanel,
  84         inputRaw,
  85         inputParams,
  86         outputData,
  87         outputDefinitions,
  88         outputParams,
  89         nodeInfo,
  90         loadInputs,
  91         loadOutputs,
  92         loadNodeJson,
  93         loadOutputDefinitions,
  94         updateOutputParams,
  95         ...props
  96     }: ProcessPanelRootProps) => {
  97         const outputUuid = process?.containerRequest.outputUuid;
  98         const containerRequest = process?.containerRequest;
  99         const inputMounts = getInputCollectionMounts(process?.containerRequest);
 100
 101         React.useEffect(() => {
 102             if (containerRequest) {
 103                 // Load inputs from mounts or props
 104                 loadInputs(containerRequest);
 105                 // Fetch raw output (loads from props or keep)
 106                 loadOutputs(containerRequest);
 107                 // Loads output definitions from mounts into store
 108                 loadOutputDefinitions(containerRequest);
 109                 // load the assigned instance type from node.json in
 110                 // the log collection
 111                 loadNodeJson(containerRequest);
 112             }
 113         }, [containerRequest, loadInputs, loadOutputs, loadOutputDefinitions, loadNodeJson]);
 114
 115         const maxHeight = "100%";
 116
 117         // Trigger processing output params when raw or definitions change
 118         React.useEffect(() => {
 119             updateOutputParams();
 120         }, [outputData, outputDefinitions, updateOutputParams]);
 121
 122         return process ? (
 123             <MPVContainer
 124                 className={props.classes.root}
 125                 spacing={8}
 126                 panelStates={panelsData}
 127                 justify-content="flex-start"
 128                 direction="column"
 129                 wrap="nowrap">
 130                 <MPVPanelContent
 131                     forwardProps
 132                     xs="auto"
 133                     data-cy="process-details">
 134                     <ProcessDetailsCard
 135                         process={process}
 136                         onContextMenu={event => props.onContextMenu(event, process)}
 137                         cancelProcess={props.cancelProcess}
 138                         startProcess={props.startProcess}
 139                         resumeOnHoldWorkflow={props.resumeOnHoldWorkflow}
 140                     />
 141                 </MPVPanelContent>
 142                 <MPVPanelContent
 143                     forwardProps
 144                     xs
 145                     minHeight={maxHeight}
 146                     maxHeight={maxHeight}
 147                     data-cy="process-logs">
 148                     <ProcessLogsCard
 149                         onCopy={props.onCopyToClipboard}
 150                         process={process}
 151                         lines={getProcessPanelLogs(processLogsPanel)}
 152                         selectedFilter={{
 153                             label: processLogsPanel.selectedFilter,
 154                             value: processLogsPanel.selectedFilter,
 155                         }}
 156                         filters={processLogsPanel.filters.map(filter => ({ label: filter, value: filter }))}
 157                         onLogFilterChange={props.onLogFilterChange}
 158                         navigateToLog={props.navigateToLog}
 159                         pollProcessLogs={props.pollProcessLogs}
 160                     />
 161                 </MPVPanelContent>
 162                 <MPVPanelContent
 163                     forwardProps
 164                     xs
 165                     maxHeight={maxHeight}
 166                     data-cy="process-children">
 167                     <SubprocessPanel process={process} />
 168                 </MPVPanelContent>
 169                 <MPVPanelContent
 170                     forwardProps
 171                     xs
 172                     maxHeight={maxHeight}
 173                     data-cy="process-outputs">
 174                     <ProcessIOCard
 175                         label={ProcessIOCardType.OUTPUT}
 176                         process={process}
 177                         params={outputParams}
 178                         raw={outputData?.raw}
 179                         outputUuid={outputUuid || ""}
 180                     />
 181                 </MPVPanelContent>
 182                 <MPVPanelContent
 183                     forwardProps
 184                     xs
 185                     maxHeight={maxHeight}
 186                     data-cy="process-inputs">
 187                     <ProcessIOCard
 188                         label={ProcessIOCardType.INPUT}
 189                         process={process}
 190                         params={inputParams}
 191                         raw={inputRaw}
 192                         mounts={inputMounts}
 193                     />
 194                 </MPVPanelContent>
 195                 <MPVPanelContent
 196                     forwardProps
 197                     xs="auto"
 198                     data-cy="process-cmd">
 199                     <ProcessCmdCard
 200                         onCopy={props.onCopyToClipboard}
 201                         process={process}
 202                     />
 203                 </MPVPanelContent>
 204                 <MPVPanelContent
 205                     forwardProps
 206                     xs
 207                     data-cy="process-resources">
 208                     <ProcessResourceCard
 209                         process={process}
 210                         nodeInfo={nodeInfo}
 211                     />
 212                 </MPVPanelContent>
 213             </MPVContainer>
 214         ) : (
 215             <NotFoundView
 216                 icon={ProcessIcon}
 217                 messages={["Process not found"]}
 218             />
 219         );
 220     }
 221 );