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