fix(ui): code-split markdown title + desc, fix row linking, etc (#12580)

Signed-off-by: Anton Gilgur <[email protected]>

ui/src/app/workflows/components/workflows-row/react-markdown-gfm.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import ReactMarkdown from 'react-markdown';
+import remarkGfm from 'remark-gfm';
+
+import {openLinkWithKey} from '../../../shared/components/links';
+
+export function ReactMarkdownGfm({markdown}: {markdown: string}) {
+    return (
+        <ReactMarkdown components={{p: React.Fragment, a: NestedAnchor}} remarkPlugins={[remarkGfm]}>
+            {markdown}
+        </ReactMarkdown>
+    );
+}
+export default ReactMarkdownGfm; // for lazy loading
+
+function NestedAnchor(props: React.ComponentProps<'a'>) {
+    return (
+        <a
+            {...props}
+            onClick={ev => {
+                ev.preventDefault(); // don't bubble up
+                openLinkWithKey(props.href); // eslint-disable-line react/prop-types -- it's not interpreting the prop types correctly
+            }}
+        />
+    );
+}

ui/src/app/workflows/components/workflows-row/workflows-row.scss

@@ -3,20 +3,6 @@
 .wf-rows-name {
   line-height: 1.5em;
   display: inline-block;
-  position: relative;
-  pointer-events: none;
   vertical-align: middle;
   white-space: pre-line;
 }
-.overlay {
-  position: absolute;
-  top: 0;
-  left: 0;
-  right: 0;
-  bottom: 0;
-}
-.wf-rows-name a {
-  pointer-events: all;
-  position: relative;
-  z-index: 1;
-}

ui/src/app/workflows/components/workflows-row/workflows-row.tsx

@@ -2,15 +2,19 @@ import {Ticker} from 'argo-ui/src/index';
 import * as React from 'react';
 import {useState} from 'react';
 import {Link} from 'react-router-dom';
+
 import * as models from '../../../../models';
 import {isArchivedWorkflow, Workflow} from '../../../../models';
+import {ANNOTATION_DESCRIPTION, ANNOTATION_TITLE} from '../../../shared/annotations';
 import {uiUrl} from '../../../shared/base';
+import {Loading} from '../../../shared/components/loading';
 import {DurationPanel} from '../../../shared/components/duration-panel';
 import {PhaseIcon} from '../../../shared/components/phase-icon';
 import {Timestamp} from '../../../shared/components/timestamp';
 import {wfDuration} from '../../../shared/duration';
 import {WorkflowDrawer} from '../workflow-drawer/workflow-drawer';
-import {WorkflowsRowName} from './workflows-row-name';
+
+require('./workflows-row.scss');
 
 interface WorkflowsRowProps {
     workflow: Workflow;
@@ -23,7 +27,11 @@ interface WorkflowsRowProps {
 export function WorkflowsRow(props: WorkflowsRowProps) {
     const [hideDrawer, setHideDrawer] = useState(true);
     const wf = props.workflow;
-    const workflowLink = uiUrl(`workflows/${wf.metadata.namespace}/${wf.metadata.name}?uid=${wf.metadata.uid}`);
+    // title + description vars
+    const title = wf.metadata.annotations?.[ANNOTATION_TITLE] ?? wf.metadata.name;
+    const description = (wf.metadata.annotations?.[ANNOTATION_DESCRIPTION] && `\n${wf.metadata.annotations[ANNOTATION_DESCRIPTION]}`) || '';
+    const hasAnnotation = title !== wf.metadata.name && description !== '';
+    const markdown = `${title}${description}`;
 
     return (
         <div className='workflows-list__row-container'>
@@ -42,16 +50,15 @@ export function WorkflowsRow(props: WorkflowsRowProps) {
                     />
                     <PhaseIcon value={wf.status.phase} />
                 </div>
-                <div className='columns small-2'>
-                    <a className='overlay' href={workflowLink}></a>
-                    <WorkflowsRowName metadata={wf.metadata} />
-                </div>
-                <Link
-                    to={{
-                        pathname: uiUrl(`workflows/${wf.metadata.namespace}/${wf.metadata.name}`),
-                        search: `?uid=${wf.metadata.uid}`
-                    }}
-                    className='small-8 row'>
+                <div className='small-11 row'>
+                    <Link
+                        to={{
+                            pathname: uiUrl(`workflows/${wf.metadata.namespace}/${wf.metadata.name}`),
+                            search: `?uid=${wf.metadata.uid}`
+                        }}
+                        className='columns small-2'>
+                        <div className='wf-rows-name'>{hasAnnotation ? <SuspenseReactMarkdownGfm markdown={markdown} /> : markdown}</div>
+                    </Link>
                     <div className='columns small-1'>{wf.metadata.namespace}</div>
                     <div className='columns small-1'>
                         <Timestamp date={wf.status.startedAt} />
@@ -96,8 +103,21 @@ export function WorkflowsRow(props: WorkflowsRowProps) {
                         );
                     })}
                     {hideDrawer ? <span /> : <WorkflowDrawer name={wf.metadata.name} namespace={wf.metadata.namespace} onChange={props.onChange} />}
-                </Link>
+                </div>
             </div>
         </div>
     );
 }
+
+// lazy load ReactMarkdown (and remark-gfm) as it is a large optional component (which can be split into a separate bundle)
+const LazyReactMarkdownGfm = React.lazy(() => {
+    return import(/* webpackChunkName: "react-markdown-plus-gfm" */ './react-markdown-gfm');
+});
+
+function SuspenseReactMarkdownGfm(props: {markdown: string}) {
+    return (
+        <React.Suspense fallback={<Loading />}>
+            <LazyReactMarkdownGfm markdown={props.markdown} />
+        </React.Suspense>
+    );
+}