Skip to content

fix: show error message for incompatible parameters #18365

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
Jun 13, 2025
Merged

fix: show error message for incompatible parameters #18365

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
19 changes: 9 additions & 10 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,11 +596,18 @@ export const CreateWorkspacePageViewExperimental: FC<
const currentParameterValueIndex =
form.values.rich_parameter_values?.findIndex(
(p) => p.name === parameter.name,
) ?? -1;
Copy link
Member

Choose a reason for hiding this comment

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

This feels like it could be a bad default 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yup, I removed this to check undefined instead

);
const parameterFieldIndex =
currentParameterValueIndex !== -1
currentParameterValueIndex !== undefined
? currentParameterValueIndex
: index;
// Get the form value by parameter name to ensure correct value mapping
const formValue =
currentParameterValueIndex !== undefined
? form.values?.rich_parameter_values?.[
currentParameterValueIndex
]?.value || ""
: "";
const parameterField = `rich_parameter_values.${parameterFieldIndex}`;
const isPresetParameter = presetParameterNames.includes(
parameter.name,
Expand All @@ -622,14 +629,6 @@ export const CreateWorkspacePageViewExperimental: FC<
return null;
}

// Get the form value by parameter name to ensure correct value mapping
const formValue =
currentParameterValueIndex !== -1
? form.values?.rich_parameter_values?.[
currentParameterValueIndex
]?.value || ""
: "";

return (
<DynamicParameter
key={parameter.name}
Expand Down
61 changes: 57 additions & 4 deletions ...WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPageViewExperimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,13 @@ export const WorkspaceParametersPageViewExperimental: FC<
setFieldValue: form.setFieldValue,
});

const hasIncompatibleParameters = parameters.some((parameter) => {
if (!parameter.mutable && parameter.diagnostics.length > 0) {
return true;
}
return false;
});

return (
<>
{disabled && (
Expand All @@ -132,6 +139,38 @@ export const WorkspaceParametersPageViewExperimental: FC<
</Alert>
)}

{hasIncompatibleParameters && (
<Alert severity="error">
<p className="text-lg leading-tight font-bold m-0">
Workspace update blocked
</p>
<p className="mb-0">
The new template version includes parameter changes that are
incompatible with this workspace's existing parameter values. This
may be caused by:
</p>
<ul className="mb-0 pl-4 space-y-1">
<li>
New <strong>required</strong> parameters that cannot be provided
after workspace creation
</li>
<li>
Changes to <strong>valid options or validations</strong> for
existing parameters
</li>
<li>Logic changes that conflict with previously selected values</li>
</ul>
<p className="mb-0">
Please contact the <strong>template administrator</strong> to review
the changes and ensure compatibility for existing workspaces.
</p>
<p className="mb-0">
Consider supplying defaults for new parameters or validating
conditional logic against prior workspace states.
</p>
</Alert>
)}

{diagnostics && diagnostics.length > 0 && (
<div className="flex flex-col gap-4 mb-8">
{diagnostics.map((diagnostic, index) => (
Expand Down Expand Up @@ -182,7 +221,23 @@ export const WorkspaceParametersPageViewExperimental: FC<
</p>
</hgroup>
{standardParameters.map((parameter, index) => {
const parameterField = `rich_parameter_values.${index}`;
const currentParameterValueIndex =
form.values.rich_parameter_values?.findIndex(
(p) => p.name === parameter.name,
);
const parameterFieldIndex =
currentParameterValueIndex !== undefined
? currentParameterValueIndex
: index;
// Get the form value by parameter name to ensure correct value mapping
const formValue =
currentParameterValueIndex !== undefined
? form.values?.rich_parameter_values?.[
currentParameterValueIndex
]?.value || ""
: "";

const parameterField = `rich_parameter_values.${parameterFieldIndex}`;
const isDisabled =
disabled ||
parameter.styling?.disabled ||
Expand All @@ -198,9 +253,7 @@ export const WorkspaceParametersPageViewExperimental: FC<
}
autofill={false}
disabled={isDisabled}
value={
form.values?.rich_parameter_values?.[index]?.value || ""
}
value={formValue}
/>
);
})}
Expand Down
Loading