Skip to content

fix(site): Fix missing parameters detection on update workspace #6740

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 1 commit into from
Mar 23, 2023
Merged

fix(site): Fix missing parameters detection on update workspace #6740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion site/src/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -977,7 +977,10 @@ const getMissingParameters = (
) => {
const missingParameters: TypesGen.TemplateVersionParameter[] = []
const requiredParameters = templateParameters.filter(
(p) => p.required && p.mutable,
// It is required
// and it can be changed
// and it is not from a legacy variable
(p) => p.required && p.mutable && p.legacy_variable_name === undefined,
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this correct @mtojek ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It definitely solved my case :) Thank you

)

for (const parameter of requiredParameters) {
Expand Down
17 changes: 7 additions & 10 deletions site/src/pages/WorkspacePage/UpdateBuildParametersDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,22 @@ import { useTranslation } from "react-i18next"
export type UpdateBuildParametersDialogProps = DialogProps & {
onClose: () => void
onUpdate: (buildParameters: WorkspaceBuildParameter[]) => void
parameters?: TemplateVersionParameter[]
missedParameters?: TemplateVersionParameter[]
}

export const UpdateBuildParametersDialog: FC<
UpdateBuildParametersDialogProps
> = ({ parameters, onUpdate, ...dialogProps }) => {
> = ({ missedParameters, onUpdate, ...dialogProps }) => {
const styles = useStyles()
const form = useFormik({
initialValues: {
rich_parameter_values: selectInitialRichParametersValues(parameters),
rich_parameter_values:
selectInitialRichParametersValues(missedParameters),
},
validationSchema: Yup.object({
rich_parameter_values: useValidationSchemaForRichParameters(
"createWorkspacePage",
parameters,
missedParameters,
),
}),
onSubmit: (values) => {
Expand Down Expand Up @@ -72,13 +73,9 @@ export const UpdateBuildParametersDialog: FC<
onSubmit={form.handleSubmit}
id="updateParameters"
>
{parameters && parameters.filter((p) => p.mutable).length > 0 && (
{missedParameters && (
<FormFields>
{parameters.map((parameter, index) => {
if (!parameter.mutable) {
return <></>
}

{missedParameters.map((parameter, index) => {
return (
<RichParameterInput
{...getFieldHelpers(
Expand Down
4 changes: 2 additions & 2 deletions site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const WorkspaceReadyPage = ({
cancellationError,
applicationsHost,
permissions,
missingParameters,
missedParameters,
} = workspaceState.context
if (workspace === undefined) {
throw Error("Workspace is undefined")
Expand Down Expand Up @@ -140,7 +140,7 @@ export const WorkspaceReadyPage = ({
}}
/>
<UpdateBuildParametersDialog
parameters={missingParameters}
missedParameters={missedParameters}
open={workspaceState.matches(
"ready.build.askingForMissedBuildParameters",
)}
Expand Down
8 changes: 4 additions & 4 deletions site/src/xServices/workspace/workspaceXService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export interface WorkspaceContext {
// Builds
builds?: TypesGen.WorkspaceBuild[]
getBuildsError?: Error | unknown
missingParameters?: TypesGen.TemplateVersionParameter[]
missedParameters?: TypesGen.TemplateVersionParameter[]
// error creating a new WorkspaceBuild
buildError?: Error | unknown
cancellationMessage?: Types.Message
Expand Down Expand Up @@ -302,7 +302,7 @@ export const workspaceMachine = createMachine(
{
target: "askingForMissedBuildParameters",
cond: "isMissingBuildParameterError",
actions: ["assignMissingParameters"],
actions: ["assignMissedParameters"],
},
{
target: "idle",
Expand Down Expand Up @@ -597,8 +597,8 @@ export const workspaceMachine = createMachine(
}
},
}),
assignMissingParameters: assign({
missingParameters: (_, { data }) => {
assignMissedParameters: assign({
missedParameters: (_, { data }) => {
if (!(data instanceof API.MissingBuildParameters)) {
throw new Error("data is not a MissingBuildParameters error")
}
Expand Down