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, { useState } 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 { getIOParamDisplayValue, ProcessIOCard, ProcessIOCardType, ProcessIOParameter } from './process-io-card';
  16
  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 { getInputs, getInputCollectionMounts, getOutputParameters } from 'store/processes/processes-actions';
  21 import { CommandInputParameter, getIOParamId } from 'models/workflow';
  22 import { CommandOutputParameter } from 'cwlts/mappings/v1.0/CommandOutputParameter';
  23 import { AuthState } from 'store/auth/auth-reducer';
  24
  25 type CssRules = 'root';
  26
  27 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  28     root: {
  29         width: '100%',
  30     },
  31 });
  32
  33 export interface ProcessPanelRootDataProps {
  34     process?: Process;
  35     subprocesses: Array<Process>;
  36     filters: Array<SubprocessFilterDataProps>;
  37     processLogsPanel: ProcessLogsPanel;
  38     auth: AuthState;
  39 }
  40
  41 export interface ProcessPanelRootActionProps {
  42     onContextMenu: (event: React.MouseEvent<HTMLElement>, process: Process) => void;
  43     onToggle: (status: string) => void;
  44     cancelProcess: (uuid: string) => void;
  45     onLogFilterChange: (filter: FilterOption) => void;
  46     navigateToLog: (uuid: string) => void;
  47     onLogCopyToClipboard: (uuid: string) => void;
  48     fetchOutputs: (uuid: string, fetchOutputs) => void;
  49 }
  50
  51 export type ProcessPanelRootProps = ProcessPanelRootDataProps & ProcessPanelRootActionProps & WithStyles<CssRules>;
  52
  53 type OutputDetails = {
  54     rawOutputs?: any;
  55     pdh?: string;
  56 }
  57
  58 const panelsData: MPVPanelState[] = [
  59     {name: "Details"},
  60     {name: "Logs", visible: true},
  61     {name: "Inputs"},
  62     {name: "Outputs"},
  63     {name: "Subprocesses"},
  64 ];
  65
  66 export const ProcessPanelRoot = withStyles(styles)(
  67     ({ process, auth, processLogsPanel, fetchOutputs, ...props }: ProcessPanelRootProps) => {
  68
  69     const [outputDetails, setOutputs] = useState<OutputDetails>({});
  70     const [rawInputs, setInputs] = useState<CommandInputParameter[]>([]);
  71
  72
  73     const [processedOutputs, setProcessedOutputs] = useState<ProcessIOParameter[]>([]);
  74     const [processedInputs, setProcessedInputs] = useState<ProcessIOParameter[]>([]);
  75
  76     const outputUuid = process?.containerRequest.outputUuid;
  77     const requestUuid = process?.containerRequest.uuid;
  78
  79     const inputMounts = getInputCollectionMounts(process?.containerRequest);
  80
  81     React.useEffect(() => {
  82         if (outputUuid) {
  83             fetchOutputs(outputUuid, setOutputs);
  84         }
  85     }, [outputUuid, fetchOutputs]);
  86
  87     React.useEffect(() => {
  88         if (outputDetails.rawOutputs && process) {
  89             const outputDefinitions = getOutputParameters(process.containerRequest);
  90             setProcessedOutputs(formatOutputData(outputDefinitions, outputDetails.rawOutputs, outputDetails.pdh, auth));
  91         } else {
  92             setProcessedOutputs([]);
  93         }
  94     }, [outputDetails, auth, process]);
  95
  96     React.useEffect(() => {
  97         if (process) {
  98             const rawInputs = getInputs(process.containerRequest);
  99             setInputs(rawInputs);
 100             setProcessedInputs(formatInputData(rawInputs, auth));
 101         }
 102     }, [requestUuid, auth, process]);
 103
 104     return process
 105         ? <MPVContainer className={props.classes.root} spacing={8} panelStates={panelsData}  justify-content="flex-start" direction="column" wrap="nowrap">
 106             <MPVPanelContent forwardProps xs="auto" data-cy="process-details">
 107                 <ProcessDetailsCard
 108                     process={process}
 109                     onContextMenu={event => props.onContextMenu(event, process)}
 110                     cancelProcess={props.cancelProcess}
 111                 />
 112             </MPVPanelContent>
 113             <MPVPanelContent forwardProps xs maxHeight='50%' data-cy="process-logs">
 114                 <ProcessLogsCard
 115                     onCopy={props.onLogCopyToClipboard}
 116                     process={process}
 117                     lines={getProcessPanelLogs(processLogsPanel)}
 118                     selectedFilter={{
 119                         label: processLogsPanel.selectedFilter,
 120                         value: processLogsPanel.selectedFilter
 121                     }}
 122                     filters={processLogsPanel.filters.map(
 123                         filter => ({ label: filter, value: filter })
 124                     )}
 125                     onLogFilterChange={props.onLogFilterChange}
 126                     navigateToLog={props.navigateToLog}
 127                 />
 128             </MPVPanelContent>
 129             <MPVPanelContent forwardProps xs="auto" data-cy="process-inputs">
 130                 <ProcessIOCard
 131                     label={ProcessIOCardType.INPUT}
 132                     params={processedInputs}
 133                     raw={rawInputs}
 134                     mounts={inputMounts}
 135                  />
 136             </MPVPanelContent>
 137             <MPVPanelContent forwardProps xs="auto" data-cy="process-outputs">
 138                 <ProcessIOCard
 139                     label={ProcessIOCardType.OUTPUT}
 140                     params={processedOutputs}
 141                     raw={outputDetails.rawOutputs}
 142                     outputUuid={outputUuid || ""}
 143                  />
 144             </MPVPanelContent>
 145             <MPVPanelContent forwardProps xs maxHeight='50%' data-cy="process-children">
 146                 <SubprocessPanel />
 147             </MPVPanelContent>
 148         </MPVContainer>
 149         : <Grid container
 150             alignItems='center'
 151             justify='center'
 152             style={{ minHeight: '100%' }}>
 153             <DefaultView
 154                 icon={ProcessIcon}
 155                 messages={['Process not found']} />
 156         </Grid>;
 157     }
 158 );
 159
 160 const formatInputData = (inputs: CommandInputParameter[], auth: AuthState): ProcessIOParameter[] => {
 161     return inputs.map(input => {
 162         const doc = Array.isArray(input.doc) ? input.doc.join(', ') : input.doc;
 163         return {
 164             id: getIOParamId(input),
 165             doc: input.label || doc || "",
 166             value: getIOParamDisplayValue(auth, input)
 167         };
 168     });
 169 };
 170
 171 const formatOutputData = (definitions: CommandOutputParameter[], values: any, pdh: string | undefined, auth: AuthState): ProcessIOParameter[] => {
 172     return definitions.map(output => {
 173         const doc = Array.isArray(output.doc) ? output.doc.join(', ') : output.doc;
 174         return {
 175             id: getIOParamId(output),
 176             doc: output.label || doc || "",
 177             value: getIOParamDisplayValue(auth, Object.assign(output, { value: values[getIOParamId(output)] || [] }), pdh)
 178         };
 179     });
 180 };