chore: task observability (#720)

* chore: tlro basic setup Signed-off-by: Carina Ursu <[email protected]> * progress checkin * Stable state refactored to use generic naming * updated types * working before updating routes * chore: progress Signed-off-by: Carina Ursu <[email protected]> * chore: remove debugger Signed-off-by: Carina Ursu <[email protected]> * chore: allow custom class in execution actions Signed-off-by: Carina Ursu <[email protected]> * chore: lint fix Signed-off-by: Carina Ursu <[email protected]> * chore: bump console Signed-off-by: Carina Ursu <[email protected]> * chore: up package version Signed-off-by: Carina Ursu <[email protected]> --------- Signed-off-by: Carina Ursu <[email protected]> Co-authored-by: Jason Porter <[email protected]> Signed-off-by: 4nalog <[email protected]>
flyteorg · Mar 30, 2023 · d4fd39e · d4fd39e
1 parent 5e252b4
commit d4fd39e
Show file tree

Hide file tree

Showing 24 changed files with 207 additions and 87 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,5 @@
 {
-  "explorer.autoReveal": "focusNoScroll",
+  "explorer.autoReveal": true,
   "explorer.enableUndo": true,
   "explorer.excludeGitIgnore": false,
 

diff --git a/Makefile b/Makefile
@@ -22,8 +22,7 @@ build_prod:
 
 .PHONY: pack
 pack:
-	yarn workspaces focus --production --all
-	yarn run build:pack
+ 	yarn run build:pack
 
 .PHONY: types
 types:

diff --git a/packages/console/package.json b/packages/console/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/console",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "Flyteconsole main app module",
   "main": "./dist/index.js",
   "module": "./lib/index.js",
@@ -20,7 +20,8 @@
     "README.md",
     "dist",
     "lib",
-    "node_modules"
+    "node_modules",
+    "src"
   ],
   "keywords": [
     "flyteorg",
@@ -31,9 +32,11 @@
   "scripts": {
     "debug": "NM_DEBUG_LEVEL=2 yarn",
     "clean": "rm -rf dist && rm -rf lib && rm -rf **.tsbuildinfo || true",
-    "build:watch": "run -T tsc-watch --noClear -p ./tsconfig.build.es.json --onSuccess \"yarn build\"",
+    "build:watch": "run -T tsc-watch --noClear --signalEmittedFiles -p ./tsconfig.build.es.json --onSuccess \"yarn build:watch:success\"",
+    "build:watch:success": "yarn build:esm:alias && yalc push",
     "build": "yarn clean && yarn build:esm && yarn build:cjs",
-    "build:esm": "mkdir lib && cp -R src/assets ./lib && run -T tsc --module esnext --project ./tsconfig.build.es.json && run -T tsc-alias -p ./tsconfig.build.es.json",
+    "build:esm": "mkdir lib && cp -R src/assets ./lib && run -T tsc --module esnext --project ./tsconfig.build.es.json && yarn build:esm:alias",
+    "build:esm:alias": "run -T tsc-alias -p ./tsconfig.build.es.json",
     "build:cjs": "mkdir dist && cp -R src/assets ./dist && run -T wait-on ./dist/assets && run -T tsc --project ./tsconfig.build.json && run -T tsc-alias -p ./tsconfig.build.json",
     "build:types": "run -T tsc --module esnext --project ./tsconfig.build.es.json --emitDeclarationOnly && run -T tsc-alias -p ./tsconfig.build.es.json",
     "test": "NODE_ENV=test jest"
@@ -79,7 +82,7 @@
     "dagre": "0.8.5",
     "dagre-d3": "^0.6.4",
     "debug": "2.6.9",
-    "dom-helpers": "^3.4.0",
+    "dom-helpers": "5.2.1",
     "fuzzysort": "^1.1.1",
     "intersection-observer": "^0.7.0",
     "js-yaml": "^3.13.1",
@@ -109,7 +112,7 @@
   },
   "devDependencies": {
     "@types/debug": "^0.0.30",
-    "@types/dom-helpers": "^3.4.1",
+    "@types/dom-helpers": "^5.0.1",
     "@types/js-yaml": "^3.10.1",
     "@types/linkify-it": "^2.1.0",
     "@types/lodash": "^4.14.68",
@@ -129,6 +132,7 @@
   },
   "resolutions": {
     "react": "^16.13.1",
+    "dom-helpers": "5.2.1",
     "react-dom": "^16.13.1",
     "micromatch": "^4.0.0",
     "@types/react": "^16.9.34",

diff --git a/packages/console/src/basics/ExternalConfigHoc.tsx b/packages/console/src/basics/ExternalConfigHoc.tsx
@@ -0,0 +1,5 @@
+import * as React from 'react';
+
+export const ExternalConfigHoc = ({ ChildComponent, data }): any => {
+  return <ChildComponent data={data} />;
+};
diff --git a/packages/console/src/basics/ExternalConfigurationProvider/ExternalConfigurationProvider.tsx b/packages/console/src/basics/ExternalConfigurationProvider/ExternalConfigurationProvider.tsx
@@ -0,0 +1,31 @@
+import React, { PropsWithChildren, useContext } from 'react';
+import { AppConfig } from '@flyteorg/common';
+
+export interface ExternalConfigurationProviderProps {
+  registry?: {
+    nav?: React.FC<any>;
+    taskExecutionAttemps?: React.FC<any>;
+    additionalRoutes?: any;
+  };
+  env?: any;
+  config?: AppConfig;
+}
+
+export const ExternalConfigurationContext =
+  React.createContext<ExternalConfigurationProviderProps>({});
+
+export const ExternalConfigurationProvider = ({
+  children,
+  config,
+  env,
+  registry,
+}: PropsWithChildren<ExternalConfigurationProviderProps>) => {
+  return (
+    <ExternalConfigurationContext.Provider value={{ config, env, registry }}>
+      {children}
+    </ExternalConfigurationContext.Provider>
+  );
+};
+
+export const useExternalConfigurationContext = () =>
+  useContext(ExternalConfigurationContext);
diff --git a/packages/console/src/basics/ExternalConfigurationProvider/index.ts b/packages/console/src/basics/ExternalConfigurationProvider/index.ts
@@ -0,0 +1 @@
+export * from './ExternalConfigurationProvider';
diff --git a/packages/console/src/basics/index.ts b/packages/console/src/basics/index.ts
@@ -0,0 +1,4 @@
+export {
+  type ExternalConfigurationProviderProps,
+  ExternalConfigurationProvider,
+} from './ExternalConfigurationProvider';
diff --git a/packages/console/src/common/index.ts b/packages/console/src/common/index.ts
@@ -0,0 +1,4 @@
+export { navbarGridHeight } from './layout';
+export { unknownValueString } from './constants';
+export { dateWithFromNow, protobufDurationToHMS } from './formatters';
+export { timestampToDate } from './utils';
diff --git a/packages/console/src/components/App/App.tsx b/packages/console/src/components/App/App.tsx
@@ -10,7 +10,7 @@ import { ThemeProvider } from '@material-ui/styles';
 import { FlyteApiProvider } from '@flyteorg/flyte-api';
 import { SnackbarProvider } from 'notistack';
 import { FeatureFlagsProvider } from 'basics/FeatureFlags';
-import { env, updateEnv, AppConfig } from '@flyteorg/common';
+import { env, updateEnv } from '@flyteorg/common';
 import { debug, debugPrefix } from 'common/log';
 import { ErrorBoundary } from 'components/common/ErrorBoundary';
 import { APIContext, useAPIState } from 'components/data/apiContext';
@@ -31,17 +31,14 @@ import { ApplicationRouter } from 'routes/ApplicationRouter';
 import { history } from 'routes/history';
 import { NavBarRouter } from 'routes/NavBarRouter';
 import { LocalCacheProvider } from 'basics/LocalCache/ContextProvider';
+import {
+  ExternalConfigurationProvider,
+  ExternalConfigurationProviderProps,
+} from 'basics/ExternalConfigurationProvider';
 
-const queryClient = createQueryClient();
-
-interface AppComponentProps {
-  registry?: {
-    nav?: React.FC<any>;
-  };
-  env?: any;
-  config?: AppConfig;
-}
+export type AppComponentProps = ExternalConfigurationProviderProps;
 
+const queryClient = createQueryClient();
 let overrided = false;
 
 export const AppComponent: React.FC<AppComponentProps> = (
@@ -82,12 +79,14 @@ export const AppComponent: React.FC<AppComponentProps> = (
                       highlightColor={skeletonHighlightColor}
                     >
                       <CssBaseline />
-                      <Router history={history}>
-                        <ErrorBoundary fixed={true}>
-                          <NavBarRouter registry={props?.registry} />
-                          <ApplicationRouter />
-                        </ErrorBoundary>
-                      </Router>
+                      <ExternalConfigurationProvider {...props}>
+                        <Router history={history}>
+                          <ErrorBoundary fixed={true}>
+                            <NavBarRouter />
+                            <ApplicationRouter />
+                          </ErrorBoundary>
+                        </Router>
+                      </ExternalConfigurationProvider>
                       <SystemStatusBanner />
                     </SkeletonTheme>
                   </APIContext.Provider>

diff --git a/packages/console/src/components/Executions/ExecutionDetails/ExecutionDetailsActions.tsx b/packages/console/src/components/Executions/ExecutionDetails/ExecutionDetailsActions.tsx
@@ -14,6 +14,7 @@ import { TaskInitialLaunchParameters } from 'components/Launch/LaunchForm/types'
 import { NodeExecutionPhase } from 'models/Execution/enums';
 import Close from '@material-ui/icons/Close';
 import { useEffect, useState } from 'react';
+import classnames from 'classnames';
 import { NodeExecutionDetails } from '../types';
 import t from './strings';
 import { ExecutionNodeDeck } from './ExecutionNodeDeck';
@@ -62,15 +63,23 @@ const useStyles = makeStyles((theme: Theme) => {
 });
 
 interface ExecutionDetailsActionsProps {
+  className?: string;
   details?: NodeExecutionDetails;
   nodeExecutionId: NodeExecutionIdentifier;
   phase: NodeExecutionPhase;
+  text?: {
+    flyteDeckText?: string;
+    rerunText?: string;
+    resumeText?: string;
+  };
 }
 
 export const ExecutionDetailsActions = ({
+  className,
   details,
   nodeExecutionId,
   phase,
+  text,
 }: ExecutionDetailsActionsProps): JSX.Element => {
   const styles = useStyles();
 
@@ -128,25 +137,25 @@ export const ExecutionDetailsActions = ({
 
   return (
     <>
-      <div className={styles.actionsContainer}>
+      <div className={classnames(styles.actionsContainer, className)}>
         {execution?.value?.closure?.deckUri && (
           <Button
             variant="outlined"
             color="primary"
             onClick={() => setShowDeck(true)}
             disabled={phase !== NodeExecutionPhase.SUCCEEDED}
           >
-            {t('flyteDeck')}
+            {text?.flyteDeckText || t('flyteDeck')}
           </Button>
         )}
         {id && initialParameters && details && (
           <Button variant="outlined" color="primary" onClick={rerunOnClick}>
-            {t('rerun')}
+            {text?.rerunText || t('rerun')}
           </Button>
         )}
         {phase === NodeExecutionPhase.PAUSED && (
           <Button variant="outlined" color="primary" onClick={onResumeClick}>
-            {t('resume')}
+            {text?.resumeText || t('resume')}
           </Button>
         )}
       </div>

diff --git a/packages/console/src/components/Executions/ExecutionStatusBadge.tsx b/packages/console/src/components/Executions/ExecutionStatusBadge.tsx
@@ -85,11 +85,19 @@ export function getPhaseConstants(
  * a badge with the proper text and styling to indicate the status (succeeded/
  * failed etc.)
  */
-export const ExecutionStatusBadge: React.FC<ExecutionStatusBadgeProps> = ({
+export const ExecutionStatusBadge: React.FC<
+  ExecutionStatusBadgeProps &
+    React.DetailedHTMLProps<
+      React.HTMLAttributes<HTMLDivElement>,
+      HTMLDivElement
+    >
+> = ({
   phase,
   type,
   variant = 'default',
   disabled = false,
+  className,
+  ...htmlProps
 }) => {
   const styles = useStyles();
   const style: React.CSSProperties = {};
@@ -102,7 +110,11 @@ export const ExecutionStatusBadge: React.FC<ExecutionStatusBadgeProps> = ({
   }
 
   return (
-    <div className={classnames(styles.root, styles[variant])} style={style}>
+    <div
+      className={classnames(styles.root, styles[variant], className)}
+      style={style}
+      {...htmlProps}
+    >
       {text}
     </div>
   );

diff --git a/packages/console/src/components/Executions/Tables/NodeExecutionsTable.tsx b/packages/console/src/components/Executions/Tables/NodeExecutionsTable.tsx
@@ -1,7 +1,7 @@
 import classnames from 'classnames';
 import { getCacheKey } from 'components/Cache/utils';
 import { useCommonStyles } from 'components/common/styles';
-import scrollbarSize from 'dom-helpers/util/scrollbarSize';
+import scrollbarSize from 'dom-helpers/scrollbarSize';
 import { NodeExecution } from 'models/Execution/types';
 import { dNode } from 'models/Graph/types';
 import { NodeExecutionPhase } from 'models/Execution/enums';

diff --git a/packages/console/src/components/Executions/TaskExecutionsList/TaskExecutionLogs.tsx b/packages/console/src/components/Executions/TaskExecutionsList/TaskExecutionLogs.tsx
@@ -38,7 +38,9 @@ export const TaskLogList: React.FC<{ logs: Core.ITaskLog[] }> = ({ logs }) => {
           </NewTargetLink>
         ) : (
           // If there is no url, show item a a name string only, as it's not really clickable
-          <div className={styles.logName}>{name}</div>
+          <div key={name} className={styles.logName}>
+            {name}
+          </div>
         ),
       )}
     </>

diff --git a/packages/console/src/components/Executions/TaskExecutionsList/TaskExecutionLogsCard.tsx b/packages/console/src/components/Executions/TaskExecutionsList/TaskExecutionLogsCard.tsx
@@ -6,6 +6,8 @@ import { useCommonStyles } from 'components/common/styles';
 import { TaskExecutionPhase } from 'models/Execution/enums';
 import { TaskExecution } from 'models/Execution/types';
 import { Core } from '@flyteorg/flyteidl-types';
+import { ExternalConfigHoc } from 'basics/ExternalConfigHoc';
+import { useExternalConfigurationContext } from 'basics/ExternalConfigurationProvider';
 import { ExecutionStatusBadge } from '../ExecutionStatusBadge';
 import { TaskExecutionDetails } from './TaskExecutionDetails';
 import { TaskExecutionError } from './TaskExecutionError';
@@ -20,6 +22,10 @@ const useStyles = makeStyles((theme: Theme) => ({
   },
   title: {
     marginBottom: theme.spacing(1),
+
+    '& > svg': {
+      verticalAlign: 'middle',
+    },
   },
   showDetailsButton: {
     marginTop: theme.spacing(1),
@@ -36,30 +42,40 @@ interface TaskExecutionLogsCardProps {
   logs: Core.ITaskLog[];
 }
 
-export const TaskExecutionLogsCard: React.FC<TaskExecutionLogsCardProps> = ({
-  taskExecution,
-  headerText,
-  phase,
-  logs,
-}) => {
+export const TaskExecutionLogsCard: React.FC<
+  TaskExecutionLogsCardProps
+> = props => {
+  const { taskExecution, headerText, phase, logs } = props;
   const commonStyles = useCommonStyles();
   const styles = useStyles();
+  const { registry } = useExternalConfigurationContext();
 
   const {
     closure: { error, startedAt, updatedAt, duration },
   } = taskExecution;
-  const taskHasStarted = phase >= TaskExecutionPhase.QUEUED;
 
+  const taskHasStarted = phase >= TaskExecutionPhase.QUEUED;
+  const externalProps = { ...props, styles, commonStyles };
   return (
     <>
       <section className={styles.section}>
         <header className={styles.header}>
-          <Typography
-            variant="h6"
-            className={classnames(styles.title, commonStyles.textWrapped)}
-          >
-            {headerText}
-          </Typography>
+          {registry?.taskExecutionAttemps ? (
+            // Alternate path
+
+            <ExternalConfigHoc
+              ChildComponent={registry.taskExecutionAttemps}
+              data={externalProps}
+            />
+          ) : (
+            // default path
+            <Typography
+              variant="h6"
+              className={classnames(styles.title, commonStyles.textWrapped)}
+            >
+              {headerText}
+            </Typography>
+          )}
         </header>
         <ExecutionStatusBadge phase={phase} type="task" variant="text" />
       </section>

diff --git a/packages/console/src/components/Navigation/NavBarContent.tsx b/packages/console/src/components/Navigation/NavBarContent.tsx
@@ -4,7 +4,9 @@ import * as React from 'react';
 import ReactDOM from 'react-dom';
 
 /** Complements NavBar, allowing pages to inject custom content. */
-export const NavBarContent: React.FC<{}> = ({ children }) => {
+export const NavBarContent: React.FC<React.PropsWithChildren<{}>> = ({
+  children,
+}) => {
   const navBar = document.getElementById(navBarContentId);
   if (navBar == null) {
     log.warn(`

diff --git a/packages/console/src/components/common/index.ts b/packages/console/src/components/common/index.ts
@@ -0,0 +1,5 @@
+export { useCommonStyles } from './styles';
+export { withRouteParams } from './withRouteParams';
+export { WaitForData } from './WaitForData';
+export { WaitForQuery } from './WaitForQuery';
+export { DetailsGroup } from './DetailsGroup';