8000 fix: sync websocket params with form params by jaaydenh · Pull Request #17895 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

fix: sync websocket params with form params #17895

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 4 commits into from
May 19, 2025
Merged

fix: sync websocket params with form params #17895

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41b3e2b
fix: sync websocket params with form params
jaaydenh May 16, 2025
68cb368
fix: add null check for response.parameters
jaaydenh May 16, 2025
711cbdc
fix: improve useSyncFormParameters logic
jaaydenh May 18, 2025
0bab142
fix: remove export
jaaydenh May 18, 2025
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
Next Next commit
fix: sync websocket params with form params
  • Loading branch information
@jaaydenh
jaaydenh committed May 16, 2025
commit 41b3e2bf6da73d2668e7a4361a639c28cdaa3232
93 changes: 89 additions & 4 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePageViewExperimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,23 @@ export const CreateWorkspacePageViewExperimental: FC<
setSuggestedName(() => generateWorkspaceName());
}, []);

const autofillByName = Object.fromEntries(
autofillParameters.map((param) => [param.name, param]),
);

// only touched fields are sent to the websocket
// In the case of autofill parameters, we need to mark the parameter as touched
// so that it is sent to the websocket
const initialTouched = parameters.reduce(
(touched, parameter) => {
if (autofillByName[parameter.name] !== undefined) {
touched[parameter.name] = true;
}
return touched;
},
{} as Record<string, boolean>,
);

const form: FormikContextType<TypesGen.CreateWorkspaceRequest> =
useFormik<TypesGen.CreateWorkspaceRequest>({
initialValues: {
Expand All @@ -123,6 +140,7 @@ export const CreateWorkspacePageViewExperimental: FC<
autofillParameters,
),
},
initialTouched,
validationSchema: Yup.object({
name: nameValidator("Workspace Name"),
rich_parameter_values:
Expand All @@ -140,10 +158,6 @@ export const CreateWorkspacePageViewExperimental: FC<
},
});

const autofillByName = Object.fromEntries(
autofillParameters.map((param) => [param.name, param]),
);

useEffect(() => {
if (error) {
window.scrollTo(0, 0);
Expand Down Expand Up @@ -250,6 +264,12 @@ export const CreateWorkspacePageViewExperimental: FC<
sendDynamicParamsRequest(parameter, value);
};

useSyncFormParameters({
parameters,
formValues: form.values.rich_parameter_values,
setFieldValue: form.setFieldValue,
});

return (
<>
<div className="sticky top-5 ml-10">
Expand Down Expand Up @@ -568,3 +588,68 @@ const Diagnostics: FC<DiagnosticsProps> = ({ diagnostics }) => {
</div>
);
};

/**
* Custom hook to synchronize parameters with form values.
*/
function useSyncFormParameters({
parameters,
formValues,
setFieldValue,
}: {
parameters: readonly PreviewParameter[] | undefined;
formValues: readonly TypesGen.WorkspaceBuildParameter[] | undefined;
setFieldValue: (
field: string,
value: TypesGen.WorkspaceBuildParameter[],
) => void;
}) {
const parametersRef = useRef<readonly PreviewParameter[] | undefined>(
parameters,
);

useEffect(() => {
const shouldSync = () => {
if (!parameters) return false;
if (!formValues) return true;

if (parametersRef.current?.length !== parameters.length) return true;

const currentParamNames = new Set((formValues || []).map((p) => p.name));
const newParamNames = new Set(parameters.map((p) => p.name));

const hasNewParams = parameters.some(
(p) => !currentParamNames.has(p.name),
);
const hasRemovedParams = (formValues || []).some(
(p) => !newParamNames.has(p.name),
);

return hasNewParams || hasRemovedParams;
};

if (!shouldSync()) return;
if (!parameters) return;

const currentFormParameters = formValues || [];

const newParameterValues = parameters.map((parameter) => {
const existingParam = currentFormParameters.find(
(p) => p.name === parameter.name,
);

if (existingParam) {
return existingParam;
}

return {
name: parameter.name,
value: parameter.value.valid ? parameter.value.value : "",
};
});

setFieldValue("rich_parameter_values", newParameterValues);

parametersRef.current = parameters;
}, [parameters, formValues, setFieldValue]);
}
Loading
0