Skip to content

fix: handle workspace errors #3341

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.

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

Merged
merged 13 commits into from
Aug 5, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
fix workflow context assignment
  • Loading branch information
AbhineetJain committed Aug 3, 2022
commit 66910aba4c33f268029e67116d4d4b1b20c8afee
15 changes: 10 additions & 5 deletions site/src/components/Workspace/Workspace.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,6 @@ export const Canceled = Template.bind({})
Canceled.args = {
...Started.args,
workspace: Mocks.MockCanceledWorkspace,
workspaceErrors: {
[WorkspaceErrors.CANCELLATION_MESSAGE]: Mocks.makeMockApiError({
message: "Job has been marked as canceled...",
}),
},
}

export const Outdated = Template.bind({})
Expand Down Expand Up @@ -133,3 +128,13 @@ GetResourcesError.args = {
}),
},
}

export const CancellationError = Template.bind({})
CancellationError.args = {
...Error.args,
workspaceErrors: {
[WorkspaceErrors.CANCELLATION_ERROR]: Mocks.makeMockApiError({
message: "Job could not be canceled.",
}),
},
}
6 changes: 3 additions & 3 deletions site/src/components/Workspace/Workspace.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export enum WorkspaceErrors {
GET_RESOURCES_ERROR = "getResourcesError",
GET_BUILDS_ERROR = "getBuildsError",
BUILD_ERROR = "buildError",
CANCELLATION_MESSAGE = "cancellationMessage",
CANCELLATION_ERROR = "cancellationError",
}

export interface WorkspaceProps {
Expand Down Expand Up @@ -70,8 +70,8 @@ export const Workspace: FC<WorkspaceProps> = ({
{workspaceErrors[WorkspaceErrors.BUILD_ERROR] && (
<ErrorSummary error={workspaceErrors[WorkspaceErrors.BUILD_ERROR]} dismissible />
)}
{workspaceErrors[WorkspaceErrors.CANCELLATION_MESSAGE] && (
<ErrorSummary error={workspaceErrors[WorkspaceErrors.CANCELLATION_MESSAGE]} dismissible />
{workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR] && (
<ErrorSummary error={workspaceErrors[WorkspaceErrors.CANCELLATION_ERROR]} dismissible />
)}
</Stack>
<PageHeader
Expand Down
4 changes: 2 additions & 2 deletions site/src/pages/WorkspacePage/WorkspacePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const WorkspacePage: React.FC = () => {
permissions,
checkPermissionsError,
buildError,
cancellationMessage,
cancellationError,
} = workspaceState.context

const canUpdateWorkspace = !!permissions?.updateWorkspace
Expand Down Expand Up @@ -124,7 +124,7 @@ export const WorkspacePage: React.FC = () => {
[WorkspaceErrors.GET_RESOURCES_ERROR]: getResourcesError,
[WorkspaceErrors.GET_BUILDS_ERROR]: getBuildsError,
[WorkspaceErrors.BUILD_ERROR]: buildError,
[WorkspaceErrors.CANCELLATION_MESSAGE]: cancellationMessage,
[WorkspaceErrors.CANCELLATION_ERROR]: cancellationError,
}}
/>
<DeleteWorkspaceDialog
Expand Down
102 changes: 53 additions & 49 deletions site/src/xServices/workspace/workspaceXService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { pure } from "xstate/lib/actions"
import * as API from "../../api/api"
import * as Types from "../../api/types"
import * as TypesGen from "../../api/typesGenerated"
import { displayError } from "../../components/GlobalSnackbar/utils"
import { displayError, displaySuccess } from "../../components/GlobalSnackbar/utils"

const latestBuild = (builds: TypesGen.WorkspaceBuild[]) => {
// Cloning builds to not change the origin object with the sort()
Expand Down Expand Up @@ -35,7 +35,8 @@ export interface WorkspaceContext {
builds?: TypesGen.WorkspaceBuild[]
getBuildsError?: Error | unknown
loadMoreBuildsError?: Error | unknown
cancellationMessage: Error | unknown
cancellationMessage?: Types.Message
cancellationError?: Error | unknown
// permissions
permissions?: Permissions
checkPermissionsError?: Error | unknown
Expand Down Expand Up @@ -97,6 +98,9 @@ export const workspaceMachine = createMachine(
stopWorkspace: {
data: TypesGen.WorkspaceBuild
}
deleteWorkspace: {
data: TypesGen.WorkspaceBuild
}
cancelWorkspace: {
data: Types.Message
}
Expand Down Expand Up @@ -248,17 +252,17 @@ export const workspaceMachine = createMachine(
},
},
requestingCancel: {
entry: "clearCancellationMessage",
entry: ["clearCancellationMessage", "clearCancellationError"],
invoke: {
id: "cancelWorkspace",
src: "cancelWorkspace",
onDone: {
target: "idle",
actions: ["assignCancellationMessage", "refreshTimeline"],
actions: ["assignCancellationMessage", "displayCancellationMessage", "refreshTimeline"],
},
onError: {
target: "idle",
actions: ["assignCancellationMessage"],
actions: ["assignCancellationError"],
},
},
},
Expand Down Expand Up @@ -387,57 +391,57 @@ export const workspaceMachine = createMachine(
clearGetPermissionsError: assign({
checkPermissionsError: (_) => undefined,
}),
assignBuild: (_, event) =>
assign({
build: event.data,
}),
assignBuildError: (_, event) =>
assign({
buildError: event.data,
}),
clearBuildError: (_) =>
assign({
buildError: undefined,
}),
assignCancellationMessage: (_, event) =>
assign({
cancellationMessage: event.data,
}),
clearCancellationMessage: (_) =>
assign({
cancellationMessage: undefined,
}),
assignRefreshWorkspaceError: (_, event) =>
assign({
refreshWorkspaceError: event.data,
}),
clearRefreshWorkspaceError: (_) =>
assign({
refreshWorkspaceError: undefined,
}),
assignRefreshTemplateError: (_, event) =>
assign({
refreshTemplateError: event.data,
}),
assignBuild: assign({
build: (_, event) => event.data,
}),
assignBuildError: assign({
buildError: (_, event) => event.data,
}),
clearBuildError: assign({
buildError: (_) => undefined,
}),
assignCancellationMessage: assign({
cancellationMessage: (_, event) => event.data,
}),
clearCancellationMessage: assign({
cancellationMessage: (_) => undefined,
}),
displayCancellationMessage: (context) => {
if (context.cancellationMessage) {
displaySuccess(context.cancellationMessage.message)
}
},
assignCancellationError: assign({
cancellationError: (_, event) => event.data,
}),
clearCancellationError: assign({
cancellationError: (_) => undefined,
}),
assignRefreshWorkspaceError: assign({
refreshWorkspaceError: (_, event) => event.data,
}),
clearRefreshWorkspaceError: assign({
refreshWorkspaceError: (_) => undefined,
}),
assignRefreshTemplateError: assign({
refreshTemplateError: (_, event) => event.data,
}),
displayRefreshTemplateError: () => {
displayError(Language.refreshTemplateError)
},
clearRefreshTemplateError: (_) =>
assign({
refreshTemplateError: undefined,
}),
clearRefreshTemplateError: assign({
refreshTemplateError: (_) => undefined,
}),
// Resources
assignResources: assign({
resources: (_, event) => event.data,
}),
assignGetResourcesError: (_, event) =>
assign({
getResourcesError: event.data,
}),
clearGetResourcesError: (_) =>
assign({
getResourcesError: undefined,
}),
assignGetResourcesError: assign({
getResourcesError: (_, event) => event.data,
}),
clearGetResourcesError: assign({
getResourcesError: (_) => undefined,
}),
// Timeline
assignBuilds: assign({
builds: (_, event) => event.data,
Expand Down