Skip to content

fix: make workspace buttons less confusing when errors happen #10609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 16 commits into from
Closed

fix: make workspace buttons less confusing when errors happen #10609

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a1d4ed8
refactor: remove enums from workspace actions
Parkreiner Nov 8, 2023
216954c
docs: remove typos from comments
Parkreiner Nov 8, 2023
199f9c9
refactor: clean up code formatting
Parkreiner Nov 8, 2023
33bd412
refactor: clean up Workspace
Parkreiner Nov 8, 2023
d1d8cfe
docs: reword comments for clarity
Parkreiner Nov 8, 2023
e39dc2d
refactor: remove needless types
Parkreiner Nov 8, 2023
a0b153f
refactor: make restarting view logic more explicit
Parkreiner Nov 8, 2023
a4266e3
refactor: clean up types
Parkreiner Nov 8, 2023
99c3526
refactor: remove workspace errors enum
Parkreiner Nov 8, 2023
15a1dac
fix: remove pointless render key
Parkreiner Nov 8, 2023
f2a9f6a
chore: update imports
Parkreiner Nov 8, 2023
f7561e1
merge: main
Parkreiner Nov 15, 2023
7654838
Merge branch 'main' of https://github.com/coder/coder
Parkreiner Nov 15, 2023
552debc
Merge branch 'main' into mes/bugs/confusing-workspace-buttons
Parkreiner Nov 15, 2023
713e981
chore: update handleBuildRetry to auto-detect debug permissions
Parkreiner Nov 15, 2023
ecc3cf5
chore: associate failed workspace states with retry button
Parkreiner Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: remove workspace errors enum
  • Loading branch information
@Parkreiner
Parkreiner committed Nov 8, 2023
commit 99c352696abea6d0558a2e45b1b72f044b393a8c
8 changes: 4 additions & 4 deletions site/src/pages/WorkspacePage/Workspace.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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.",
}),
},
Expand Down Expand Up @@ -216,7 +216,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.",
}),
},
Expand All @@ -227,7 +227,7 @@ export const CancellationError: Story = {
args: {
...Failed.args,
workspaceErrors: {
[WorkspaceErrors.CANCELLATION_ERROR]: Mocks.mockApiError({
cancellationError: Mocks.mockApiError({
message: "Job could not be canceled.",
}),
},
Expand Down
34 changes: 14 additions & 20 deletions site/src/pages/WorkspacePage/Workspace.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,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;
Expand Down Expand Up @@ -62,7 +64,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;
Expand Down Expand Up @@ -211,18 +213,12 @@ export const Workspace: FC<React.PropsWithChildren<WorkspaceProps>> = ({
</Alert>
)}

{Boolean(workspaceErrors[WorkspaceErrors.BUILD_ERROR]) && (
<ErrorAlert
error={workspaceErrors[WorkspaceErrors.BUILD_ERROR]}
dismissible
/>
{Boolean(workspaceErrors.buildError) && (
<ErrorAlert error={workspaceErrors.buildError} dismissible />
)}

{Boolean(workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR]) && (
<ErrorAlert
error={workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR]}
dismissible
/>
{Boolean(workspaceErrors.cancellationError) && (
<ErrorAlert error={workspaceErrors.cancellationError} dismissible />
)}

{workspace.latest_build.status === "running" &&
Expand Down Expand Up @@ -338,10 +334,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}
Expand Down
8 changes: 4 additions & 4 deletions site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
} from "utils/schedule";
import { StateFrom } from "xstate";
import { DeleteDialog } from "components/Dialogs/DeleteDialog/DeleteDialog";
import { Workspace, WorkspaceErrors } from "./Workspace";
import { Workspace } from "./Workspace";
import { pageTitle } from "utils/page";
import { getFaviconByStatus, hasJobError } from "utils/workspace";
import {
Expand Down Expand Up @@ -195,9 +195,9 @@ export const WorkspaceReadyPage = ({
hideSSHButton={featureVisibility["browser_only"]}
hideVSCodeDesktopButton={featureVisibility["browser_only"]}
workspaceErrors={{
[WorkspaceErrors.GET_BUILDS_ERROR]: buildsError,
[WorkspaceErrors.BUILD_ERROR]: buildError || restartBuildError,
[WorkspaceErrors.CANCELLATION_ERROR]: cancellationError,
getBuildsError: buildsError,
buildError: buildError || restartBuildError,
cancellationError: cancellationError,
}}
buildInfo={buildInfo}
sshPrefix={sshPrefix}
Expand Down