Skip to content

chore(site): simplify the logic to load workspace initial data #7772

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

Merged
merged 6 commits into from
Jun 1, 2023
Merged

chore(site): simplify the logic to load workspace initial data #7772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
872b64a
Refactor workspaces
BrunoQuaresma Jun 1, 2023
2d92642
Merge branch 'main' into bq/refactor-workspaces
BrunoQuaresma Jun 1, 2023
8e9037a
Simplify the load initial data
BrunoQuaresma Jun 1, 2023
c28e731
Merge branch 'main' into bq/refactor-workspaces
BrunoQuaresma Jun 1, 2023
63f4432
Add error stories
BrunoQuaresma Jun 1, 2023
052188e
Fix error margin and update storybook
BrunoQuaresma Jun 1, 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
7 changes: 4 additions & 3 deletions site/src/components/Alert/Alert.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import { useState, FC, ReactNode, PropsWithChildren } from "react"
import { useState, FC, ReactNode } from "react"
import Collapse from "@mui/material/Collapse"
// eslint-disable-next-line no-restricted-imports -- It is the base component
import MuiAlert, { AlertProps as MuiAlertProps } from "@mui/material/Alert"
import Button from "@mui/material/Button"
import Box from "@mui/material/Box"

export interface AlertProps extends PropsWithChildren {
severity: MuiAlertProps["severity"]
export type AlertProps = MuiAlertProps & {
actions?: ReactNode
dismissible?: boolean
onRetry?: () => void
Expand All @@ -20,12 +19,14 @@ export const Alert: FC<AlertProps> = ({
dismissible,
severity,
onDismiss,
...alertProps
}) => {
const [open, setOpen] = useState(true)

return (
<Collapse in={open}>
<MuiAlert
{...alertProps}
severity={severity}
action={
<>
Expand Down
297 changes: 156 additions & 141 deletions site/src/components/Workspace/Workspace.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,56 @@
import { action } from "@storybook/addon-actions"
import { Story } from "@storybook/react"
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, WorkspaceProps } from "./Workspace"
import { Workspace, WorkspaceErrors } from "./Workspace"
import { withReactContext } from "storybook-react-context"
import EventSource from "eventsourcemock"
import { ProxyContext, getPreferredProxy } from "contexts/ProxyContext"
import { DashboardProviderContext } from "components/Dashboard/DashboardProvider"

export default {
const MockedAppearance = {
config: Mocks.MockAppearance,
preview: false,
setPreview: () => null,
save: () => null,
}

const meta: Meta<typeof Workspace> = {
title: "components/Workspace",
component: Workspace,
argTypes: {},
decorators: [
(Story) => (
<DashboardProviderContext.Provider
value={{
buildInfo: Mocks.MockBuildInfo,
entitlements: Mocks.MockEntitlementsWithScheduling,
experiments: Mocks.MockExperiments,
appearance: MockedAppearance,
}}
>
<ProxyContext.Provider
value={{
proxyLatencies: Mocks.MockProxyLatencies,
proxy: getPreferredProxy([], undefined),
proxies: [],
isLoading: false,
isFetched: true,
clearProxy: () => {
return
},
setProxy: () => {
return
},
refetchProxyLatencies: () => {
return
},
}}
>
<Story />
</ProxyContext.Provider>
</DashboardProviderContext.Provider>
),
withReactContext({
Context: WatchAgentMetadataContext,
initialState: (_: string): EventSource => {
Expand All @@ -23,172 +60,149 @@ export default {
}),
],
}
export default meta
type Story = StoryObj<typeof Workspace>

const MockedAppearance = {
config: Mocks.MockAppearance,
preview: false,
setPreview: () => null,
save: () => null,
}

const Template: Story<WorkspaceProps> = (args) => (
<DashboardProviderContext.Provider
value={{
buildInfo: Mocks.MockBuildInfo,
entitlements: Mocks.MockEntitlementsWithScheduling,
experiments: Mocks.MockExperiments,
appearance: MockedAppearance,
}}
>
<ProxyContext.Provider
value={{
proxyLatencies: Mocks.MockProxyLatencies,
proxy: getPreferredProxy([], undefined),
proxies: [],
isLoading: false,
isFetched: true,
clearProxy: () => {
return
},
setProxy: () => {
return
},
refetchProxyLatencies: () => {
return
},
}}
>
<Workspace {...args} />
</ProxyContext.Provider>
</DashboardProviderContext.Provider>
)

export const Running = Template.bind({})
Running.args = {
scheduleProps: {
onDeadlineMinus: () => {
// do nothing, this is just for storybook
},
onDeadlinePlus: () => {
// do nothing, this is just for storybook
},
maxDeadlineDecrease: 0,
maxDeadlineIncrease: 24,
export const Running: Story = {
args: {
scheduleProps: {
onDeadlineMinus: () => {
// do nothing, this is just for storybook
},
onDeadlinePlus: () => {
// do nothing, this is just for storybook
},
maxDeadlineDecrease: 0,
maxDeadlineIncrease: 24,
},
workspace: Mocks.MockWorkspace,
handleStart: action("start"),
handleStop: action("stop"),
resources: [
Mocks.MockWorkspaceResource,
Mocks.MockWorkspaceResource2,
Mocks.MockWorkspaceResource3,
],
builds: [Mocks.MockWorkspaceBuild],
canUpdateWorkspace: true,
workspaceErrors: {},
buildInfo: Mocks.MockBuildInfo,
template: Mocks.MockTemplate,
},
workspace: Mocks.MockWorkspace,
handleStart: action("start"),
handleStop: action("stop"),
resources: [
Mocks.MockWorkspaceResource,
Mocks.MockWorkspaceResource2,
Mocks.MockWorkspaceResource3,
],
builds: [Mocks.MockWorkspaceBuild],
canUpdateWorkspace: true,
workspaceErrors: {},
buildInfo: Mocks.MockBuildInfo,
template: Mocks.MockTemplate,
}

export const WithoutUpdateAccess = Template.bind({})
WithoutUpdateAccess.args = {
...Running.args,
canUpdateWorkspace: false,
export const WithoutUpdateAccess: Story = {
args: {
...Running.args,
canUpdateWorkspace: false,
},
}

export const Starting = Template.bind({})
Starting.args = {
...Running.args,
workspace: Mocks.MockStartingWorkspace,
export const Starting: Story = {
args: {
...Running.args,
workspace: Mocks.MockStartingWorkspace,
},
}

export const Stopped = Template.bind({})
Stopped.args = {
...Running.args,
workspace: Mocks.MockStoppedWorkspace,
export const Stopped: Story = {
args: {
...Running.args,
workspace: Mocks.MockStoppedWorkspace,
},
}

export const Stopping = Template.bind({})
Stopping.args = {
...Running.args,
workspace: Mocks.MockStoppingWorkspace,
export const Stopping: Story = {
args: {
...Running.args,
workspace: Mocks.MockStoppingWorkspace,
},
}

export const Failed = Template.bind({})
Failed.args = {
...Running.args,
workspace: Mocks.MockFailedWorkspace,
workspaceErrors: {
[WorkspaceErrors.BUILD_ERROR]: Mocks.mockApiError({
message: "A workspace build is already active.",
}),
export const Failed: Story = {
args: {
...Running.args,
workspace: Mocks.MockFailedWorkspace,
workspaceErrors: {
[WorkspaceErrors.BUILD_ERROR]: Mocks.mockApiError({
message: "A workspace build is already active.",
}),
},
},
}

export const FailedWithLogs = Template.bind({})
FailedWithLogs.args = {
...Running.args,
workspace: {
...Mocks.MockFailedWorkspace,
latest_build: {
...Mocks.MockFailedWorkspace.latest_build,
job: {
...Mocks.MockFailedWorkspace.latest_build.job,
error:
"recv workspace provision: plan terraform: terraform plan: exit status 1",
export const FailedWithLogs: Story = {
args: {
...Running.args,
workspace: {
...Mocks.MockFailedWorkspace,
latest_build: {
...Mocks.MockFailedWorkspace.latest_build,
job: {
...Mocks.MockFailedWorkspace.latest_build.job,
error:
"recv workspace provision: plan terraform: terraform plan: exit status 1",
},
},
},
failedBuildLogs: makeFailedBuildLogs(),
},
failedBuildLogs: makeFailedBuildLogs(),
}

export const Deleting = Template.bind({})
Deleting.args = {
...Running.args,
workspace: Mocks.MockDeletingWorkspace,
export const Deleting: Story = {
args: {
...Running.args,
workspace: Mocks.MockDeletingWorkspace,
},
}

export const Deleted = Template.bind({})
Deleted.args = {
...Running.args,
workspace: Mocks.MockDeletedWorkspace,
export const Deleted: Story = {
args: {
...Running.args,
workspace: Mocks.MockDeletedWorkspace,
},
}

export const Canceling = Template.bind({})
Canceling.args = {
...Running.args,
workspace: Mocks.MockCancelingWorkspace,
export const Canceling: Story = {
args: {
...Running.args,
workspace: Mocks.MockCancelingWorkspace,
},
}

export const Canceled = Template.bind({})
Canceled.args = {
...Running.args,
workspace: Mocks.MockCanceledWorkspace,
export const Canceled: Story = {
args: {
...Running.args,
workspace: Mocks.MockCanceledWorkspace,
},
}

export const Outdated = Template.bind({})
Outdated.args = {
...Running.args,
workspace: Mocks.MockOutdatedWorkspace,
export const Outdated: Story = {
args: {
...Running.args,
workspace: Mocks.MockOutdatedWorkspace,
},
}

export const GetBuildsError = Template.bind({})
GetBuildsError.args = {
...Running.args,
workspaceErrors: {
[WorkspaceErrors.GET_BUILDS_ERROR]: Mocks.mockApiError({
message: "There is a problem fetching builds.",
}),
export const GetBuildsError: Story = {
args: {
...Running.args,
workspaceErrors: {
[WorkspaceErrors.GET_BUILDS_ERROR]: Mocks.mockApiError({
message: "There is a problem fetching builds.",
}),
},
},
}

export const CancellationError = Template.bind({})
CancellationError.args = {
...Failed.args,
workspaceErrors: {
[WorkspaceErrors.CANCELLATION_ERROR]: Mocks.mockApiError({
message: "Job could not be canceled.",
}),
export const CancellationError: Story = {
args: {
...Failed.args,
workspaceErrors: {
[WorkspaceErrors.CANCELLATION_ERROR]: Mocks.mockApiError({
message: "Job could not be canceled.",
}),
},
},
}

Expand Down Expand Up @@ -683,8 +697,9 @@ function makeFailedBuildLogs(): ProvisionerJobLog[] {
]
}

export const WithDeprecatedParameters = Template.bind({})
WithDeprecatedParameters.args = {
...Running.args,
templateWarnings: ["DEPRECATED_PARAMETERS"],
export const WithDeprecatedParameters: Story = {
args: {
...Running.args,
templateWarnings: ["DEPRECATED_PARAMETERS"],
},
}
Loading