feat(site): Show warning if startup script is running (#7326)

BrunoQuaresma · web-flow · commit 730039f35f07 · 2023-05-02T14:49:16.000-03:00
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -1021,7 +1021,7 @@ export const getWorkspaceBuildParameters = async (
   return response.data
 }
 type Claims = {
-  license_expires?: jwt.NumericDate
+  license_expires?: number
   account_type?: string
   account_id?: string
   trial: boolean
diff --git a/site/src/pages/TerminalPage/TerminalPage.tsx b/site/src/pages/TerminalPage/TerminalPage.tsx
@@ -1,4 +1,7 @@
+import Button from "@material-ui/core/Button"
 import { makeStyles } from "@material-ui/core/styles"
+import WarningIcon from "@material-ui/icons/ErrorOutlineRounded"
+import RefreshOutlined from "@material-ui/icons/RefreshOutlined"
 import { useMachine } from "@xstate/react"
 import { portForwardURL } from "components/PortForwardButton/PortForwardButton"
 import { Stack } from "components/Stack/Stack"
@@ -15,41 +18,14 @@ import { MONOSPACE_FONT_FAMILY } from "../../theme/constants"
 import { pageTitle } from "../../utils/page"
 import { terminalMachine } from "../../xServices/terminal/terminalXService"
 import { useProxy } from "contexts/ProxyContext"
+import { combineClasses } from "utils/combineClasses"
 
 export const Language = {
   workspaceErrorMessagePrefix: "Unable to fetch workspace: ",
   workspaceAgentErrorMessagePrefix: "Unable to fetch workspace agent: ",
   websocketErrorMessagePrefix: "WebSocket failed: ",
 }
 
-const useReloading = (isDisconnected: boolean) => {
-  const [status, setStatus] = useState<"reloading" | "notReloading">(
-    "notReloading",
-  )
-
-  // Retry connection on key press when it is disconnected
-  useEffect(() => {
-    if (!isDisconnected) {
-      return
-    }
-
-    const keyDownHandler = () => {
-      setStatus("reloading")
-      window.location.reload()
-    }
-
-    document.addEventListener("keydown", keyDownHandler)
-
-    return () => {
-      document.removeEventListener("keydown", keyDownHandler)
-    }
-  }, [isDisconnected])
-
-  return {
-    status,
-  }
-}
-
 const TerminalPage: FC<
   React.PropsWithChildren<{
     readonly renderer?: XTerm.RendererType
@@ -102,6 +78,12 @@ const TerminalPage: FC<
     websocketError,
   } = terminalState.context
   const reloading = useReloading(isDisconnected)
+  const shouldDisplayStartupWarning = workspaceAgent
+    ? ["starting", "starting_timeout"].includes(workspaceAgent.lifecycle_state)
+    : false
+  const shouldDisplayStartupError = workspaceAgent
+    ? workspaceAgent.lifecycle_state === "start_error"
+    : false
 
   // handleWebLink handles opening of URLs in the terminal!
   const handleWebLink = useCallback(
@@ -316,12 +298,80 @@ const TerminalPage: FC<
           </Stack>
         )}
       </div>
+      {shouldDisplayStartupError && (
+        <div
+          className={combineClasses([styles.alert, styles.alertError])}
+          role="alert"
+        >
+          <WarningIcon className={styles.alertIcon} />
+          <div>
+            <div className={styles.alertTitle}>Startup script failed</div>
+            <div className={styles.alertMessage}>
+              You can continue using this terminal, but something may be missing
+              or not fully set up.
+            </div>
+          </div>
+        </div>
+      )}
+      {shouldDisplayStartupWarning && (
+        <div className={styles.alert} role="alert">
+          <WarningIcon className={styles.alertIcon} />
+          <div>
+            <div className={styles.alertTitle}>
+              Startup script is still running
+            </div>
+            <div className={styles.alertMessage}>
+              You can continue using this terminal, but something may be missing
+              or not fully set up.
+            </div>
+          </div>
+          <div className={styles.alertActions}>
+            <Button
+              startIcon={<RefreshOutlined />}
+              size="small"
+              onClick={() => {
+                // By redirecting the user without the session in the URL we
+                // create a new one
+                window.location.href = window.location.pathname
+              }}
+            >
+              Refresh session
+            </Button>
+          </div>
+        </div>
+      )}
       <div className={styles.terminal} ref={xtermRef} data-testid="terminal" />
     </>
   )
 }
 
-export default TerminalPage
+const useReloading = (isDisconnected: boolean) => {
+  const [status, setStatus] = useState<"reloading" | "notReloading">(
+    "notReloading",
+  )
+
+  // Retry connection on key press when it is disconnected
+  useEffect(() => {
+    if (!isDisconnected) {
+      return
+    }
+
+    const keyDownHandler = () => {
+      setStatus("reloading")
+      window.location.reload()
+    }
+
+    document.addEventListener("keydown", keyDownHandler)
+
+    return () => {
+      document.removeEventListener("keydown", keyDownHandler)
+    }
+  }, [isDisconnected])
+
+  return {
+    status,
+  }
+}
 
 const useStyles = makeStyles((theme) => ({
   overlay: {
@@ -355,6 +405,8 @@ const useStyles = makeStyles((theme) => ({
     width: "100vw",
     height: "100vh",
     overflow: "hidden",
+    padding: theme.spacing(1),
+    backgroundColor: theme.palette.background.paper,
     // These styles attempt to mimic the VS Code scrollbar.
     "& .xterm": {
       padding: 4,
@@ -377,4 +429,34 @@ const useStyles = makeStyles((theme) => ({
       backgroundColor: "rgba(255, 255, 255, 0.18)",
     },
   },
+  alert: {
+    display: "flex",
+    background: theme.palette.background.paperLight,
+    alignItems: "center",
+    padding: theme.spacing(2),
+    gap: theme.spacing(2),
+    borderBottom: `1px solid ${theme.palette.divider}`,
+  },
+  alertIcon: {
+    color: theme.palette.warning.light,
+    fontSize: theme.spacing(3),
+  },
+  alertError: {
+    "& $alertIcon": {
+      color: theme.palette.error.light,
+    },
+  },
+  alertTitle: {
+    fontWeight: 600,
+    color: theme.palette.text.primary,
+  },
+  alertMessage: {
+    fontSize: 14,
+    color: theme.palette.text.secondary,
+  },
+  alertActions: {
+    marginLeft: "auto",
+  },
 }))
+
+export default TerminalPage

Original file line number	Diff line number	Diff line change
`@@ -1021,7 +1021,7 @@ export const getWorkspaceBuildParameters = async (`
`1021`	`1021`	`return response.data`
`1022`	`1022`	`}`
`1023`	`1023`	`type Claims = {`
`1024`		`- license_expires?: jwt.NumericDate`
	`1024`	`+ license_expires?: number`
`1025`	`1025`	`account_type?: string`
`1026`	`1026`	`account_id?: string`
`1027`	`1027`	`trial: boolean`