8000 fix(site): Do not require immutable parameters by BrunoQuaresma · Pull Request #6637 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

fix(site): Do not require immutable parameters #6637

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
Mar 17, 2023
Merged

fix(site): Do not require immutable parameters #6637

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
e811741
fix(site): Do not require mutable parameters
BrunoQuaresma Mar 16, 2023
9969c82
Fix
BrunoQuaresma Mar 16, 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
48 changes: 42 additions & 6 deletions site/src/api/api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import axios from "axios"
import {
MockTemplate,
MockTemplateVersionParameter1,
MockTemplateVersionParameter2,
MockWorkspace,
MockWorkspaceBuild,
MockWorkspaceBuildParameter1,
} from "testHelpers/entities"
import * as api from "./api"
import * as TypesGen from "./typesGenerated"
Expand Down Expand Up @@ -176,18 +178,52 @@ describe("api.ts", () => {
})

it("fails when having missing parameters", async () => {
jest
.spyOn(api, "postWorkspaceBuild")
.mockResolvedValue(MockWorkspaceBuild)
jest.spyOn(api, "getTemplate").mockResolvedValue(MockTemplate)
jest.spyOn(api, "getWorkspaceBuildParameters").mockResolvedValue([])
jest
.spyOn(api, "getTemplateVersionRichParameters")
.mockResolvedValue([
MockTemplateVersionParameter1,
{ ...MockTemplateVersionParameter2, mutable: false },
])

let error = new Error()
try {
await api.updateWorkspace(MockWorkspace)
} catch (e) {
error = e as Error
}

expect(error).toBeInstanceOf(api.MissingBuildParameters)
// Verify if the correct missing parameters are being passed
// It should not require immutable parameters
expect((error as api.MissingBuildParameters).parameters).toEqual([
MockTemplateVersionParameter1,
])
})

it("creates a build with the no parameters if it is already filled", async () => {
jest
.spyOn(api, "postWorkspaceBuild")
.mockResolvedValueOnce(MockWorkspaceBuild)
jest.spyOn(api, "getTemplate").mockResolvedValueOnce(MockTemplate)
jest.spyOn(api, "getWorkspaceBuildParameters").mockResolvedValueOnce([])
jest
.spyOn(api, "getWorkspaceBuildParameters")
.mockResolvedValue([MockWorkspaceBuildParameter1])
jest
.spyOn(api, "getTemplateVersionRichParameters")
.mockResolvedValueOnce([MockTemplateVersionParameter1])

await expect(api.updateWorkspace(MockWorkspace)).rejects.toThrow(
api.MissingBuildParameters,
)
.mockResolvedValue([
{ ...MockTemplateVersionParameter1, required: true, mutable: false },
])
await api.updateWorkspace(MockWorkspace)
expect(api.postWorkspaceBuild).toHaveBeenCalledWith(MockWorkspace.id, {
transition: "start",
template_version_id: MockTemplate.active_version_id,
rich_parameter_values: [],
})
})
})
})
23 changes: 11 additions & 12 deletions site/src/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,31 +946,34 @@ export const updateWorkspace = async (
const templateParameters = await getTemplateVersionRichParameters(
activeVersionId,
)
const [updatedBuildParameters, missingParameters] = updateBuildParameters(
const missingParameters = getMissingParameters(
oldBuildParameters,
newBuildParameters,
templateParameters,
)

if (missingParameters.length > 0) {
throw new MissingBuildParameters(missingParameters)
}

return postWorkspaceBuild(workspace.id, {
transition: "start",
template_version_id: activeVersionId,
rich_parameter_values: updatedBuildParameters,
rich_parameter_values: newBuildParameters,
})
}

const updateBuildParameters = (
const getMissingParameters = (
oldBuildParameters: TypesGen.WorkspaceBuildParameter[],
newBuildParameters: TypesGen.WorkspaceBuildParameter[],
templateParameters: TypesGen.TemplateVersionParameter[],
) => {
const missingParameters: TypesGen.TemplateVersionParameter[] = []
const updatedBuildParameters: TypesGen.WorkspaceBuildParameter[] = []
const requiredParameters = templateParameters.filter(
(p) => p.required && p.mutable,
)

for (const parameter of templateParameters) {
for (const parameter of requiredParameters) {
// Check if there is a new value
let buildParameter = newBuildParameters.find(
(p) => p.name === parameter.name,
Expand All @@ -981,17 +984,13 @@ const updateBuildParameters = (
buildParameter = oldBuildParameters.find((p) => p.name === parameter.name)
}

// If there is a value from the new or old one, add it to the list
// If there is a value from the new or old one, it is not missed
if (buildParameter) {
updatedBuildParameters.push(buildParameter)
continue
}

// If there is no value and it is required, add it to the list of missing parameters
if (parameter.required) {
missingParameters.push(parameter)
}
missingParameters.push(parameter)
}

return [updatedBuildParameters, missingParameters] as const
return missingParameters
}
0