16073: Refactor process io loading into actions and reducers to eliminate infinite...
[arvados-workbench2.git] / src / views / process-panel / process-io-card.tsx
index e1daa256340acf361a693fbdca338071fa5c81b3..5fd444b5e53fa5776b58813ce623e5d62f7b3097 100644 (file)
@@ -24,9 +24,10 @@ import {
     Paper,
     Grid,
     Chip,
+    CircularProgress,
 } from '@material-ui/core';
 import { ArvadosTheme } from 'common/custom-theme';
-import { CloseIcon, ImageIcon, InfoIcon, InputIcon, InvisibleIcon, OutputIcon, VisibleIcon } from 'components/icon/icon';
+import { CloseIcon, ImageIcon, InputIcon, ImageOffIcon, OutputIcon, MaximizeIcon } from 'components/icon/icon';
 import { MPVPanelProps } from 'components/multi-panel-view/multi-panel-view';
 import {
   BooleanCommandInputParameter,
@@ -62,8 +63,31 @@ import { RootState } from 'store/store';
 import { ProcessOutputCollectionFiles } from './process-output-collection-files';
 import { Process } from 'store/processes/process';
 import { navigateTo } from 'store/navigation/navigation-action';
-
-type CssRules = 'card' | 'content' | 'title' | 'header' | 'avatar' | 'iconHeader' | 'tableWrapper' | 'tableRoot' | 'paramValue' | 'keepLink' | 'collectionLink' | 'imagePreview' | 'valArray' | 'emptyValue' | 'halfRow' | 'symmetricTabs' | 'imagePlaceholder' | 'rowWithPreview';
+import classNames from 'classnames';
+import { DefaultCodeSnippet } from 'components/default-code-snippet/default-code-snippet';
+
+type CssRules =
+  | "card"
+  | "content"
+  | "title"
+  | "header"
+  | "avatar"
+  | "iconHeader"
+  | "tableWrapper"
+  | "tableRoot"
+  | "paramValue"
+  | "keepLink"
+  | "collectionLink"
+  | "imagePreview"
+  | "valArray"
+  | "secondaryVal"
+  | "secondaryRow"
+  | "emptyValue"
+  | "noBorderRow"
+  | "symmetricTabs"
+  | "imagePlaceholder"
+  | "rowWithPreview"
+  | "labelColumn";
 
 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
     card: {
@@ -71,7 +95,7 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
     },
     header: {
         paddingTop: theme.spacing.unit,
-        paddingBottom: theme.spacing.unit,
+        paddingBottom: 0,
     },
     iconHeader: {
         fontSize: '1.875rem',
@@ -82,8 +106,9 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
         paddingTop: theme.spacing.unit * 0.5
     },
     content: {
+        height: `calc(100% - ${theme.spacing.unit * 7}px - ${theme.spacing.unit * 1.5}px)`,
         padding: theme.spacing.unit * 1.0,
-        paddingTop: theme.spacing.unit * 0.5,
+        paddingTop: 0,
         '&:last-child': {
             paddingBottom: theme.spacing.unit * 1,
         }
@@ -93,6 +118,7 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
         paddingTop: theme.spacing.unit * 0.5
     },
     tableWrapper: {
+        height: `calc(100% - ${theme.spacing.unit * 6}px)`,
         overflow: 'auto',
     },
     tableRoot: {
@@ -100,6 +126,9 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
         '& thead th': {
             verticalAlign: 'bottom',
             paddingBottom: '10px',
+        },
+        '& td, & th': {
+            paddingRight: '25px',
         }
     },
     paramValue: {
@@ -135,10 +164,19 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
             display: 'inline',
         }
     },
+    secondaryVal: {
+        paddingLeft: '20px',
+    },
+    secondaryRow: {
+        height: '29px',
+        verticalAlign: 'top',
+        position: 'relative',
+        top: '-9px',
+    },
     emptyValue: {
         color: theme.customs.colors.grey500,
     },
-    halfRow: {
+    noBorderRow: {
         '& td': {
             borderBottom: 'none',
         }
@@ -159,7 +197,10 @@ const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
     },
     rowWithPreview: {
         verticalAlign: 'bottom',
-    }
+    },
+    labelColumn: {
+        minWidth: '120px',
+    },
 });
 
 export enum ProcessIOCardType {
@@ -169,8 +210,8 @@ export enum ProcessIOCardType {
 export interface ProcessIOCardDataProps {
     process: Process;
     label: ProcessIOCardType;
-    params: ProcessIOParameter[];
-    raw?: any;
+    params: ProcessIOParameter[] | null;
+    raw: any;
     mounts?: InputCollectionMount[];
     outputUuid?: string;
 }
@@ -186,7 +227,7 @@ const mapDispatchToProps = (dispatch: Dispatch): ProcessIOCardActionProps => ({
 type ProcessIOCardProps = ProcessIOCardDataProps & ProcessIOCardActionProps & WithStyles<CssRules> & MPVPanelProps;
 
 export const ProcessIOCard = withStyles(styles)(connect(null, mapDispatchToProps)(
-    ({ classes, label, params, raw, mounts, outputUuid, doHidePanel, panelName, process, navigateTo }: ProcessIOCardProps) => {
+    ({ classes, label, params, raw, mounts, outputUuid, doHidePanel, doMaximizePanel, panelMaximized, panelName, process, navigateTo }: ProcessIOCardProps) => {
         const [mainProcTabState, setMainProcTabState] = useState(0);
         const handleMainProcTabChange = (event: React.MouseEvent<HTMLElement>, value: number) => {
             setMainProcTabState(value);
@@ -197,6 +238,10 @@ export const ProcessIOCard = withStyles(styles)(connect(null, mapDispatchToProps
         const PanelIcon = label === ProcessIOCardType.INPUT ? InputIcon : OutputIcon;
         const mainProcess = !process.containerRequest.requestingContainerUuid;
 
+        const loading = raw === null || raw === undefined || params === null;
+        const hasRaw = !!(raw && Object.keys(raw).length > 0);
+        const hasParams = !!(params && params.length > 0);
+
         return <Card className={classes.card} data-cy="process-io-card">
             <CardHeader
                 className={classes.header}
@@ -213,7 +258,11 @@ export const ProcessIOCard = withStyles(styles)(connect(null, mapDispatchToProps
                 action={
                     <div>
                         { mainProcess && <Tooltip title={"Toggle Image Preview"} disableFocusListener>
-                            <IconButton data-cy="io-preview-image-toggle" onClick={() =>{setShowImagePreview(!showImagePreview)}}>{showImagePreview ? <VisibleIcon /> : <InvisibleIcon />}</IconButton>
+                            <IconButton data-cy="io-preview-image-toggle" onClick={() =>{setShowImagePreview(!showImagePreview)}}>{showImagePreview ? <ImageIcon /> : <ImageOffIcon />}</IconButton>
+                        </Tooltip> }
+                        { doMaximizePanel && !panelMaximized &&
+                        <Tooltip title={`Maximize ${panelName || 'panel'}`} disableFocusListener>
+                            <IconButton onClick={doMaximizePanel}><MaximizeIcon /></IconButton>
                         </Tooltip> }
                         { doHidePanel &&
                         <Tooltip title={`Close ${panelName || 'panel'}`} disableFocusListener>
@@ -222,46 +271,59 @@ export const ProcessIOCard = withStyles(styles)(connect(null, mapDispatchToProps
                     </div>
                 } />
             <CardContent className={classes.content}>
-                <div>
-                    {mainProcess ?
-                        (<>
-                            <Tabs value={mainProcTabState} onChange={handleMainProcTabChange} variant="fullWidth" className={classes.symmetricTabs}>
-                                <Tab label="Parameters" />
-                                <Tab label="JSON" />
-                            </Tabs>
-                            {mainProcTabState === 0 && <div className={classes.tableWrapper}>
-                                {params.length ?
-                                    <ProcessIOPreview data={params} showImagePreview={showImagePreview} /> :
-                                    <Grid container item alignItems='center' justify='center'>
-                                        <DefaultView messages={["No parameters found"]} icon={InfoIcon} />
-                                    </Grid>}
-                                </div>}
-                            {mainProcTabState === 1 && <div className={classes.tableWrapper}>
-                                {params.length ?
-                                    <ProcessIORaw data={raw || params} /> :
-                                    <Grid container item alignItems='center' justify='center'>
-                                        <DefaultView messages={["No parameters found"]} icon={InfoIcon} />
-                                    </Grid>}
-                                </div>}
-                        </>) :
-                        (<>
-                            <Tabs value={0} variant="fullWidth" className={classes.symmetricTabs}>
-                                {label === ProcessIOCardType.INPUT && <Tab label="Collections" />}
-                                {label === ProcessIOCardType.OUTPUT && <Tab label="Collection" />}
-                            </Tabs>
-                            <div className={classes.tableWrapper}>
-                                {label === ProcessIOCardType.INPUT && <ProcessInputMounts mounts={mounts || []} />}
-                                {label === ProcessIOCardType.OUTPUT && <>
-                                    {outputUuid && <Typography className={classes.collectionLink}>
-                                        Output Collection: <MuiLink className={classes.keepLink} onClick={() => {navigateTo(outputUuid)}}>
-                                        {outputUuid}
-                                    </MuiLink></Typography>}
-                                    <ProcessOutputCollectionFiles isWritable={false} currentItemUuid={outputUuid} />
-                                </>}
-                            </div>
-                        </>)
-                    }
-                </div>
+                {mainProcess ?
+                    (<>
+                        {/* raw is undefined until params are loaded */}
+                        {loading && <Grid container item alignItems='center' justify='center'>
+                            <CircularProgress />
+                        </Grid>}
+                        {/* Once loaded, either raw or params may still be empty
+                          *   Raw when all params are empty
+                          *   Params when raw is provided by containerRequest properties but workflow mount is absent for preview
+                          */}
+                        {(!loading && (hasRaw || hasParams)) &&
+                            <>
+                                <Tabs value={mainProcTabState} onChange={handleMainProcTabChange} variant="fullWidth" className={classes.symmetricTabs}>
+                                    {/* params will be empty on processes without workflow definitions in mounts, so we only show raw */}
+                                    {hasParams && <Tab label="Parameters" />}
+                                    <Tab label="JSON" />
+                                </Tabs>
+                                {(mainProcTabState === 0 && params && hasParams) && <div className={classes.tableWrapper}>
+                                        <ProcessIOPreview data={params} showImagePreview={showImagePreview} />
+                                    </div>}
+                                {(mainProcTabState === 1 || !hasParams) && <div className={classes.tableWrapper}>
+                                        <ProcessIORaw data={raw} />
+                                    </div>}
+                            </>}
+                        {!loading && !hasRaw && !hasParams && <Grid container item alignItems='center' justify='center'>
+                            <DefaultView messages={["No parameters found"]} />
+                        </Grid>}
+                    </>) :
+                    // Subprocess
+                    (<>
+                        {((mounts && mounts.length) || outputUuid) ?
+                            <>
+                                <Tabs value={0} variant="fullWidth" className={classes.symmetricTabs}>
+                                    {label === ProcessIOCardType.INPUT && <Tab label="Collections" />}
+                                    {label === ProcessIOCardType.OUTPUT && <Tab label="Collection" />}
+                                </Tabs>
+                                <div className={classes.tableWrapper}>
+                                    {label === ProcessIOCardType.INPUT && <ProcessInputMounts mounts={mounts || []} />}
+                                    {label === ProcessIOCardType.OUTPUT && <>
+                                        {outputUuid && <Typography className={classes.collectionLink}>
+                                            Output Collection: <MuiLink className={classes.keepLink} onClick={() => {navigateTo(outputUuid || "")}}>
+                                            {outputUuid}
+                                        </MuiLink></Typography>}
+                                        <ProcessOutputCollectionFiles isWritable={false} currentItemUuid={outputUuid} />
+                                    </>}
+                                </div>
+                            </> :
+                            <Grid container item alignItems='center' justify='center'>
+                                <DefaultView messages={["No collection(s) found"]} />
+                            </Grid>
+                        }
+                    </>)
+                }
             </CardContent>
         </Card>;
     }
@@ -271,12 +333,12 @@ export type ProcessIOValue = {
     display: ReactElement<any, any>;
     imageUrl?: string;
     collection?: ReactElement<any, any>;
+    secondary?: boolean;
 }
 
 export type ProcessIOParameter = {
     id: string;
     label: string;
-    doc: string;
     value: ProcessIOValue[];
 }
 
@@ -288,13 +350,13 @@ interface ProcessIOPreviewDataProps {
 type ProcessIOPreviewProps = ProcessIOPreviewDataProps & WithStyles<CssRules>;
 
 const ProcessIOPreview = withStyles(styles)(
-    ({ classes, data, showImagePreview }: ProcessIOPreviewProps) =>
-        <Table className={classes.tableRoot} aria-label="Process IO Preview">
+    ({ classes, data, showImagePreview }: ProcessIOPreviewProps) => {
+        const showLabel = data.some((param: ProcessIOParameter) => param.label);
+        return <Table className={classes.tableRoot} aria-label="Process IO Preview">
             <TableHead>
                 <TableRow>
                     <TableCell>Name</TableCell>
-                    <TableCell>Label</TableCell>
-                    <TableCell>Description</TableCell>
+                    {showLabel && <TableCell className={classes.labelColumn}>Label</TableCell>}
                     <TableCell>Value</TableCell>
                     <TableCell>Collection</TableCell>
                 </TableRow>
@@ -303,15 +365,16 @@ const ProcessIOPreview = withStyles(styles)(
                 {data.map((param: ProcessIOParameter) => {
                     const firstVal = param.value.length > 0 ? param.value[0] : undefined;
                     const rest = param.value.slice(1);
-                    const rowClass = rest.length > 0 ? classes.halfRow : undefined;
+                    const mainRowClasses = {
+                        [classes.noBorderRow]: (rest.length > 0),
+                    };
 
                     return <>
-                        <TableRow className={rowClass} data-cy="process-io-param">
+                        <TableRow className={classNames(mainRowClasses)} data-cy="process-io-param">
                             <TableCell>
                                 {param.id}
                             </TableCell>
-                            <TableCell >{param.label}</TableCell>
-                            <TableCell >{param.doc}</TableCell>
+                            {showLabel && <TableCell >{param.label}</TableCell>}
                             <TableCell>
                                 {firstVal && <ProcessValuePreview value={firstVal} showImagePreview={showImagePreview} />}
                             </TableCell>
@@ -321,11 +384,14 @@ const ProcessIOPreview = withStyles(styles)(
                                 </Typography>
                             </TableCell>
                         </TableRow>
-                        {rest.map((val, i) => (
-                            <TableRow className={(i < rest.length-1) ? rowClass : undefined}>
-                                <TableCell />
-                                <TableCell />
+                        {rest.map((val, i) => {
+                            const rowClasses = {
+                                [classes.noBorderRow]: (i < rest.length-1),
+                                [classes.secondaryRow]: val.secondary,
+                            };
+                            return <TableRow className={classNames(rowClasses)}>
                                 <TableCell />
+                                {showLabel && <TableCell />}
                                 <TableCell>
                                     <ProcessValuePreview value={val} showImagePreview={showImagePreview} />
                                 </TableCell>
@@ -335,12 +401,12 @@ const ProcessIOPreview = withStyles(styles)(
                                     </Typography>
                                 </TableCell>
                             </TableRow>
-                        ))}
+                        })}
                     </>;
                 })}
             </TableBody>
-        </Table>
-);
+        </Table>;
+});
 
 interface ProcessValuePreviewProps {
     value: ProcessIOValue;
@@ -352,17 +418,12 @@ const ProcessValuePreview = withStyles(styles)(
         <Typography className={classes.paramValue}>
             {value.imageUrl && showImagePreview ? <img className={classes.imagePreview} src={value.imageUrl} alt="Inline Preview" /> : ""}
             {value.imageUrl && !showImagePreview ? <ImagePlaceholder /> : ""}
-            <span className={classes.valArray}>
+            <span className={classNames(classes.valArray, value.secondary && classes.secondaryVal)}>
                 {value.display}
             </span>
         </Typography>
 )
 
-const handleClick = (url) => {
-    window.open(url, '_blank');
-}
-
-
 interface ProcessIORawDataProps {
     data: ProcessIOParameter[];
 }
@@ -370,9 +431,7 @@ interface ProcessIORawDataProps {
 const ProcessIORaw = withStyles(styles)(
     ({ data }: ProcessIORawDataProps) =>
         <Paper elevation={0}>
-            <pre>
-                {JSON.stringify(data, null, 2)}
-            </pre>
+            <DefaultCodeSnippet lines={[JSON.stringify(data, null, 2)]} linked />
         </Paper>
 );
 
@@ -454,9 +513,10 @@ export const getIOParamDisplayValue = (auth: AuthState, input: CommandInputParam
                 ...(mainFile && !(Array.isArray(mainFile) && mainFile.length === 0) ? [mainFile] : []),
                 ...secondaryFiles
             ];
+            const mainFilePdhUrl = mainFile ? getResourcePdhUrl(mainFile, pdh) : "";
 
             return files.length ?
-                files.map(file => fileToProcessIOValue(file, auth, pdh)) :
+                files.map((file, i) => fileToProcessIOValue(file, (i > 0), auth, pdh, (i > 0 ? mainFilePdhUrl : ""))) :
                 [{display: <EmptyValue />}];
 
         case isPrimitiveOfType(input, CWLType.DIRECTORY):
@@ -499,18 +559,22 @@ export const getIOParamDisplayValue = (auth: AuthState, input: CommandInputParam
                 [{display: <EmptyValue />}];
 
         case isArrayOfType(input, CWLType.FILE):
-            const fileArrayMainFile = ((input as FileArrayCommandInputParameter).value || []);
-            const fileArraySecondaryFiles = fileArrayMainFile.map((file) => (
-                ((file as unknown) as FileWithSecondaryFiles)?.secondaryFiles || []
-            )).reduce((acc: File[], params: File[]) => (acc.concat(params)), []);
-
-            const fileArrayFiles = [
-                ...fileArrayMainFile,
-                ...fileArraySecondaryFiles
-            ];
-
-            return fileArrayFiles.length ?
-                fileArrayFiles.map(file => fileToProcessIOValue(file, auth, pdh)) :
+            const fileArrayMainFiles = ((input as FileArrayCommandInputParameter).value || []);
+            const firstMainFilePdh = (fileArrayMainFiles.length > 0 && fileArrayMainFiles[0]) ? getResourcePdhUrl(fileArrayMainFiles[0], pdh) : "";
+
+            // Convert each main file into separate arrays of ProcessIOValue to preserve secondaryFile grouping
+            const fileArrayValues = fileArrayMainFiles.map((mainFile: File, i): ProcessIOValue[] => {
+                const secondaryFiles = ((mainFile as unknown) as FileWithSecondaryFiles)?.secondaryFiles || [];
+                return [
+                    // Pass firstMainFilePdh to secondary files and every main file besides the first to hide pdh if equal
+                    ...(mainFile ? [fileToProcessIOValue(mainFile, false, auth, pdh, i > 0 ? firstMainFilePdh : "")] : []),
+                    ...(secondaryFiles.map(file => fileToProcessIOValue(file, true, auth, pdh, firstMainFilePdh)))
+                ];
+            // Reduce each mainFile/secondaryFile group into single array preserving ordering
+            }).reduce((acc: ProcessIOValue[], mainFile: ProcessIOValue[]) => (acc.concat(mainFile)), []);
+
+            return fileArrayValues.length ?
+                fileArrayValues :
                 [{display: <EmptyValue />}];
 
         case isArrayOfType(input, CWLType.DIRECTORY):
@@ -525,9 +589,14 @@ export const getIOParamDisplayValue = (auth: AuthState, input: CommandInputParam
     }
 };
 
+/*
+ * @returns keep url without keep: prefix
+ */
 const getKeepUrl = (file: File | Directory, pdh?: string): string => {
     const isKeepUrl = file.location?.startsWith('keep:') || false;
-    const keepUrl = isKeepUrl ? file.location : pdh ? `keep:${pdh}/${file.location}` : file.location;
+    const keepUrl = isKeepUrl ?
+                        file.location?.replace('keep:', '') :
+                        pdh ? `${pdh}/${file.location}` : file.location;
     return keepUrl || '';
 };
 
@@ -537,11 +606,15 @@ interface KeepUrlProps {
     pdh?: string;
 }
 
-const KeepUrlBase = withStyles(styles)(({auth, res, pdh, classes}: KeepUrlProps & WithStyles<CssRules>) => {
+const getResourcePdhUrl = (res: File | Directory, pdh?: string): string => {
     const keepUrl = getKeepUrl(res, pdh);
-    const pdhUrl = keepUrl ? keepUrl.split('/').slice(0, 1)[0] : '';
+    return keepUrl ? keepUrl.split('/').slice(0, 1)[0] : '';
+};
+
+const KeepUrlBase = withStyles(styles)(({auth, res, pdh, classes}: KeepUrlProps & WithStyles<CssRules>) => {
+    const pdhUrl = getResourcePdhUrl(res, pdh);
     // Passing a pdh always returns a relative wb2 collection url
-    const pdhWbPath = getNavUrl(pdhUrl.replace('keep:', ''), auth);
+    const pdhWbPath = getNavUrl(pdhUrl, auth);
     return pdhUrl && pdhWbPath ?
         <Tooltip title={"View collection in Workbench"}><RouterLink to={pdhWbPath} className={classes.keepLink}>{pdhUrl}</RouterLink></Tooltip> :
         <></>;
@@ -553,19 +626,18 @@ const KeepUrlPath = withStyles(styles)(({auth, res, pdh, classes}: KeepUrlProps
     const keepUrlPath = keepUrlParts.length > 1 ? keepUrlParts.slice(1).join('/') : '';
 
     const keepUrlPathNav = getKeepNavUrl(auth, res, pdh);
-    return keepUrlPath && keepUrlPathNav ?
-        <Tooltip title={"View in keep-web"}><MuiLink className={classes.keepLink} onClick={() => handleClick(keepUrlPathNav)}>{keepUrlPath}</MuiLink></Tooltip> :
-        // Show No value for root collection io that lacks path part
+    return keepUrlPathNav ?
+        <Tooltip title={"View in keep-web"}><a className={classes.keepLink} href={keepUrlPathNav} target="_blank" rel="noopener noreferrer">{keepUrlPath || '/'}</a></Tooltip> :
         <EmptyValue />;
 });
 
 const getKeepNavUrl = (auth: AuthState, file: File | Directory, pdh?: string): string => {
-    let keepUrl = getKeepUrl(file, pdh).replace('keep:', '');
+    let keepUrl = getKeepUrl(file, pdh);
     return (getInlineFileUrl(`${auth.config.keepWebServiceUrl}/c=${keepUrl}?api_token=${auth.apiToken}`, auth.config.keepWebServiceUrl, auth.config.keepWebInlineServiceUrl));
 };
 
 const getImageUrl = (auth: AuthState, file: File, pdh?: string): string => {
-    const keepUrl = getKeepUrl(file, pdh).replace('keep:', '');
+    const keepUrl = getKeepUrl(file, pdh);
     return getInlineFileUrl(`${auth.config.keepWebServiceUrl}/c=${keepUrl}?api_token=${auth.apiToken}`, auth.config.keepWebServiceUrl, auth.config.keepWebInlineServiceUrl);
 };
 
@@ -591,11 +663,13 @@ const directoryToProcessIOValue = (directory: Directory, auth: AuthState, pdh?:
     };
 };
 
-const fileToProcessIOValue = (file: File, auth: AuthState, pdh?: string): ProcessIOValue => {
+const fileToProcessIOValue = (file: File, secondary: boolean, auth: AuthState, pdh: string | undefined, mainFilePdh: string): ProcessIOValue => {
+    const resourcePdh = getResourcePdhUrl(file, pdh);
     return {
         display: <KeepUrlPath auth={auth} res={file} pdh={pdh}/>,
+        secondary,
         imageUrl: isFileImage(file.basename) ? getImageUrl(auth, file, pdh) : undefined,
-        collection: <KeepUrlBase auth={auth} res={file} pdh={pdh}/>,
+        collection: (resourcePdh !== mainFilePdh) ? <KeepUrlBase auth={auth} res={file} pdh={pdh}/> : <></>,
     }
 };