refactor: remove workspace error enums

Parkreiner · Parkreiner · commit c28f1d82f82b · 2023-11-15T21:36:31.000Z
diff --git a/site/src/pages/WorkspacePage/Workspace.stories.tsx b/site/src/pages/WorkspacePage/Workspace.stories.tsx
@@ -3,7 +3,7 @@ import { Meta, StoryObj } from "@storybook/react";
 import { WatchAgentMetadataContext } from "components/Resources/AgentMetadata";
 import { ProvisionerJobLog } from "api/typesGenerated";
 import * as Mocks from "testHelpers/entities";
-import { Workspace, WorkspaceErrors } from "./Workspace";
+import { Workspace } from "./Workspace";
 import { withReactContext } from "storybook-react-context";
 import EventSource from "eventsourcemock";
 import { ProxyContext, getPreferredProxy } from "contexts/ProxyContext";
@@ -133,7 +133,7 @@ export const Failed: Story = {
     ...Running.args,
     workspace: Mocks.MockFailedWorkspace,
     workspaceErrors: {
-      [WorkspaceErrors.BUILD_ERROR]: Mocks.mockApiError({
+      buildError: Mocks.mockApiError({
         message: "A workspace build is already active.",
       }),
     },
@@ -224,7 +224,7 @@ export const GetBuildsError: Story = {
   args: {
     ...Running.args,
     workspaceErrors: {
-      [WorkspaceErrors.GET_BUILDS_ERROR]: Mocks.mockApiError({
+      getBuildsError: Mocks.mockApiError({
         message: "There is a problem fetching builds.",
       }),
     },
@@ -235,7 +235,7 @@ export const CancellationError: Story = {
   args: {
     ...Failed.args,
     workspaceErrors: {
-      [WorkspaceErrors.CANCELLATION_ERROR]: Mocks.mockApiError({
+      cancellationError: Mocks.mockApiError({
         message: "Job could not be canceled.",
       }),
     },
diff --git a/site/src/pages/WorkspacePage/Workspace.tsx b/site/src/pages/WorkspacePage/Workspace.tsx
@@ -29,11 +29,13 @@ import { BuildsTable } from "./BuildsTable";
 import { WorkspaceDeletedBanner } from "./WorkspaceDeletedBanner";
 import { WorkspaceStats } from "./WorkspaceStats";
 
-export enum WorkspaceErrors {
-  GET_BUILDS_ERROR = "getBuildsError",
-  BUILD_ERROR = "buildError",
-  CANCELLATION_ERROR = "cancellationError",
-}
+export type WorkspaceError =
+  | "getBuildsError"
+  | "buildError"
+  | "cancellationError";
+
+export type WorkspaceErrors = Partial<Record<WorkspaceError, unknown>>;
+
 export interface WorkspaceProps {
   scheduleProps: {
     onDeadlinePlus: (hours: number) => void;
@@ -60,7 +62,7 @@ export interface WorkspaceProps {
   canChangeVersions: boolean;
   hideSSHButton?: boolean;
   hideVSCodeDesktopButton?: boolean;
-  workspaceErrors: Partial<Record<WorkspaceErrors, unknown>>;
+  workspaceErrors: WorkspaceErrors;
   buildInfo?: TypesGen.BuildInfoResponse;
   sshPrefix?: string;
   template?: TypesGen.Template;
@@ -114,28 +116,12 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
   const serverVersion = buildInfo?.version || "";
   const { saveLocal, getLocal } = useLocalStorage();
 
-  const buildError = Boolean(workspaceErrors[WorkspaceErrors.BUILD_ERROR]) && (
-    <ErrorAlert
-      error={workspaceErrors[WorkspaceErrors.BUILD_ERROR]}
-      dismissible
-    />
-  );
-
-  const cancellationError = Boolean(
-    workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR],
-  ) && (
-    <ErrorAlert
-      error={workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR]}
-      dismissible
-    />
-  );
-
-  let transitionStats: TypesGen.TransitionStats | undefined = undefined;
-  if (template !== undefined) {
-    transitionStats = ActiveTransition(template, workspace);
-  }
-
   const [showAlertPendingInQueue, setShowAlertPendingInQueue] = useState(false);
+
+  // 2023-11-15 - MES - This effect will be called every single render because
+  // "now" will always change and invalidate the dependency array. Need to
+  // figure out if this effect really should run every render (possibly meaning
+  // no dependency array at all), or how to get the array stabilized (ideal)
   const now = dayjs();
   useEffect(() => {
     if (
@@ -174,6 +160,9 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
   const autoStartFailing = workspace.autostart_schedule && !canAutostart;
   const requiresManualUpdate = updateRequired && autoStartFailing;
 
+  const transitionStats =
+    template !== undefined ? ActiveTransition(template, workspace) : undefined;
+
   return (
     <>
       <FullWidthPageHeader>
@@ -244,8 +233,15 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
                 {updateMessage && <AlertDetail>{updateMessage}</AlertDetail>}
               </Alert>
             ))}
-          {buildError}
-          {cancellationError}
+
+          {Boolean(workspaceErrors.buildError) && (
+            <ErrorAlert error={workspaceErrors.buildError} dismissible />
+          )}
+
+          {Boolean(workspaceErrors.cancellationError) && (
+            <ErrorAlert error={workspaceErrors.cancellationError} dismissible />
+          )}
+
           {workspace.latest_build.status === "running" &&
             !workspace.health.healthy && (
               <Alert
@@ -357,10 +353,8 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
             />
           )}
 
-          {workspaceErrors[WorkspaceErrors.GET_BUILDS_ERROR] ? (
-            <ErrorAlert
-              error={workspaceErrors[WorkspaceErrors.GET_BUILDS_ERROR]}
-            />
+          {workspaceErrors.getBuildsError ? (
+            <ErrorAlert error={workspaceErrors.getBuildsError} />
           ) : (
             <BuildsTable
               builds={builds}
diff --git a/site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx b/site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
@@ -9,7 +9,7 @@ import {
   getMaxDeadlineChange,
   getMinDeadline,
 } from "utils/schedule";
-import { Workspace, WorkspaceErrors } from "./Workspace";
+import { Workspace } from "./Workspace";
 import { pageTitle } from "utils/page";
 import { hasJobError } from "utils/workspace";
 import { UpdateBuildParametersDialog } from "./UpdateBuildParametersDialog";
@@ -278,14 +278,14 @@ export const WorkspaceReadyPage = ({
         hideSSHButton={featureVisibility["browser_only"]}
         hideVSCodeDesktopButton={featureVisibility["browser_only"]}
         workspaceErrors={{
-          [WorkspaceErrors.GET_BUILDS_ERROR]: buildsError,
-          [WorkspaceErrors.BUILD_ERROR]:
+          getBuildsError: buildsError,
+          buildError:
             restartBuildError ??
             startWorkspaceMutation.error ??
             stopWorkspaceMutation.error ??
             deleteWorkspaceMutation.error ??
             updateWorkspaceMutation.error,
-          [WorkspaceErrors.CANCELLATION_ERROR]: cancelBuildMutation.error,
+          cancellationError: cancelBuildMutation.error,
         }}
         buildInfo={buildInfo}
         sshPrefix={sshPrefixQuery.data?.hostname_prefix}
