Skip to content

fix(site): fix workspace parameters update when having immutable parameters #9500

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 2 commits into from
Sep 4, 2023
Merged

fix(site): fix workspace parameters update when having immutable parameters #9500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edbe4fe
fix(site): fix workspace parameters update when having immutable para…
BrunoQuaresma Sep 4, 2023
6b6523b
Fix random build number
BrunoQuaresma Sep 4, 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
2 changes: 1 addition & 1 deletion site/src/pages/WorkspaceBuildPage/WorkspaceBuildPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const LoadingBuildLogs: Story = {

const failedBuild = {
...MockFailedWorkspaceBuild("delete"),
build_number: new Date().getDate(),
build_number: 123123123123,
}

export const FailedDelete: Story = {
Expand Down
26 changes: 14 additions & 12 deletions .../src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,27 @@ import {
MockWorkspaceBuildParameter1,
MockWorkspaceBuildParameter2,
MockWorkspaceBuild,
MockTemplateVersionParameter4,
MockWorkspaceBuildParameter4,
} from "testHelpers/entities"

test("Submit the workspace settings page successfully", async () => {
// Mock the API calls that loads data
jest
.spyOn(api, "getWorkspaceByOwnerAndName")
.mockResolvedValueOnce(MockWorkspace)
jest
.spyOn(api, "getTemplateVersionRichParameters")
.mockResolvedValueOnce([
MockTemplateVersionParameter1,
MockTemplateVersionParameter2,
])
jest
.spyOn(api, "getWorkspaceBuildParameters")
.mockResolvedValueOnce([
MockWorkspaceBuildParameter1,
MockWorkspaceBuildParameter2,
])
jest.spyOn(api, "getTemplateVersionRichParameters").mockResolvedValueOnce([
MockTemplateVersionParameter1,
MockTemplateVersionParameter2,
// Immutable parameters
MockTemplateVersionParameter4,
])
jest.spyOn(api, "getWorkspaceBuildParameters").mockResolvedValueOnce([
MockWorkspaceBuildParameter1,
MockWorkspaceBuildParameter2,
// Immutable value
MockWorkspaceBuildParameter4,
])
// Mock the API calls that submit data
const postWorkspaceBuildSpy = jest
.spyOn(api, "postWorkspaceBuild")
Expand Down
27 changes: 19 additions & 8 deletions site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ import { PageHeader, PageHeaderTitle } from "components/PageHeader/PageHeader"
import { FC } from "react"
import { isApiValidationError } from "api/errors"
import { ErrorAlert } from "components/Alert/ErrorAlert"
import { WorkspaceBuildParameter } from "api/typesGenerated"

const WorkspaceParametersPage = () => {
const { workspace } = useWorkspaceSettingsContext()
const query = useQuery({
const parameters = useQuery({
queryKey: ["workspace", workspace.id, "parameters"],
queryFn: () => getWorkspaceParameters(workspace),
})
const navigate = useNavigate()
const mutation = useMutation({
mutationFn: (formValues: WorkspaceParametersFormValues) =>
const updateParameters = useMutation({
mutationFn: (buildParameters: WorkspaceBuildParameter[]) =>
postWorkspaceBuild(workspace.id, {
transition: "start",
rich_parameter_values: formValues.rich_parameter_values,
rich_parameter_values: buildParameters,
}),
onSuccess: () => {
navigate(`/${workspace.owner_name}/${workspace.name}`)
Expand All @@ -40,10 +41,20 @@ const WorkspaceParametersPage = () => {
</Helmet>

<WorkspaceParametersPageView
data={query.data}
submitError={mutation.error}
isSubmitting={mutation.isLoading}
onSubmit={mutation.mutate}
data={parameters.data}
submitError={updateParameters.error}
isSubmitting={updateParameters.isLoading}
onSubmit={(values) => {
// When updating the parameters, the API does not accept immutable
// values so we need to filter them
const onlyMultableValues = parameters
.data!.templateVersionRichParameters.filter((p) => p.mutable)
.map(
(p) =>
values.rich_parameter_values.find((v) => v.name === p.name)!,
)
updateParameters.mutate(onlyMultableValues)
}}
onCancel={() => {
navigate("../..")
}}
Expand Down
5 changes: 5 additions & 0 deletions site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2078,6 +2078,11 @@ export const MockWorkspaceBuildParameter3: TypesGen.WorkspaceBuildParameter = {
value: "my-database",
}

export const MockWorkspaceBuildParameter4: TypesGen.WorkspaceBuildParameter = {
name: MockTemplateVersionParameter4.name,
value: "immutable-value",
}

export const MockWorkspaceBuildParameter5: TypesGen.WorkspaceBuildParameter = {
name: MockTemplateVersionParameter5.name,
value: "5",
Expand Down