Skip to content

feat: make dynamic parameters respect owner in form #18013

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.

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 11 commits into from
May 27, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fix: update websocket creation and requests to handle changing owner …
…id (#18020)
  • Loading branch information
jaaydenh authored May 27, 2025
commit f069ba10740c2d97e288639bc5a4f5a9cebc52ee
3 changes: 1 addition & 2 deletions site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1000,7 +1000,6 @@ class ApiMethods {
};

templateVersionDynamicParameters = (
userId: string,
versionId: string,
{
onMessage,
Expand All @@ -1013,7 +1012,7 @@ class ApiMethods {
},
): WebSocket => {
const socket = createWebSocket(
`/api/v2/users/${userId}/templateversions/${versionId}/parameters`,
`/api/v2/templateversions/${versionId}/dynamic-parameters`,
);

socket.addEventListener("message", (event) =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,19 @@ const CreateWorkspacePageExperimental: FC = () => {

const autofillParameters = getAutofillParameters(searchParams);

const sendMessage = useCallback((formValues: Record<string, string>) => {
const request: DynamicParametersRequest = {
id: wsResponseId.current + 1,
inputs: formValues,
};
if (ws.current && ws.current.readyState === WebSocket.OPEN) {
ws.current.send(JSON.stringify(request));
wsResponseId.current = wsResponseId.current + 1;
}
}, []);
const sendMessage = useEffectEvent(
(formValues: Record<string, string>, ownerId?: string) => {
const request: DynamicParametersRequest = {
id: wsResponseId.current + 1,
owner_id: ownerId ?? owner.id,
inputs: formValues,
};
if (ws.current && ws.current.readyState === WebSocket.OPEN) {
ws.current.send(JSON.stringify(request));
wsResponseId.current = wsResponseId.current + 1;
}
},
);

// On page load, sends all initial parameter values to the websocket
// (including defaults and autofilled from the url)
Expand Down Expand Up @@ -147,35 +150,31 @@ const CreateWorkspacePageExperimental: FC = () => {
useEffect(() => {
if (!realizedVersionId) return;

const socket = API.templateVersionDynamicParameters(
owner.id,
realizedVersionId,
{
onMessage,
onError: (error) => {
if (ws.current === socket) {
setWsError(error);
}
},
onClose: () => {
if (ws.current === socket) {
setWsError(
new DetailedError(
"Websocket connection for dynamic parameters unexpectedly closed.",
"Refresh the page to reset the form.",
),
);
}
},
const socket = API.templateVersionDynamicParameters(realizedVersionId, {
onMessage,
onError: (error) => {
if (ws.current === socket) {
setWsError(error);
}
},
);
onClose: () => {
if (ws.current === socket) {
setWsError(
new DetailedError(
"Websocket connection for dynamic parameters unexpectedly closed.",
"Refresh the page to reset the form.",
),
);
}
},
});

ws.current = socket;

return () => {
socket.close();
};
}, [owner.id, realizedVersionId, onMessage]);
}, [realizedVersionId, onMessage]);

const organizationId = templateQuery.data?.organization_id;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface CreateWorkspacePageViewExperimentalProps {
owner: TypesGen.User,
) => void;
resetMutation: () => void;
sendMessage: (message: Record<string, string>) => void;
sendMessage: (message: Record<string, string>, ownerId?: string) => void;
startPollingExternalAuth: () => void;
owner: TypesGen.User;
setOwner: (user: TypesGen.User) => void;
Expand Down Expand Up @@ -271,9 +271,10 @@ export const CreateWorkspacePageViewExperimental: FC<
form.values.rich_parameter_values,
]);

// send the last user modified parameter and all touched parameters to the websocket
// include any modified parameters and all touched parameters to the websocket request
const sendDynamicParamsRequest = (
parameters: Array<{ parameter: PreviewParameter; value: string }>,
ownerId?: string,
) => {
const formInputs: Record<string, string> = {};
const formParameters = form.values.rich_parameter_values ?? [];
Expand All @@ -294,7 +295,12 @@ export const CreateWorkspacePageViewExperimental: FC<
}
}

sendMessage(formInputs);
sendMessage(formInputs, ownerId);
};

const handleOwnerChange = (user: TypesGen.User) => {
setOwner(user);
sendDynamicParamsRequest([], user.id);
};

const handleChange = async (
Expand Down Expand Up @@ -449,7 +455,7 @@ export const CreateWorkspacePageViewExperimental: FC<
<UserAutocomplete
value={owner}
onChange={(user) => {
setOwner(user ?? defaultOwner);
handleOwnerChange(user ?? defaultOwner);
}}
size="medium"
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,7 @@ import { Link } from "components/Link/Link";
import { Loader } from "components/Loader/Loader";
import { useEffectEvent } from "hooks/hookPolyfills";
import type { FC } from "react";
import {
useCallback,
useContext,
useEffect,
useMemo,
useRef,
useState,
} from "react";
import { useContext, useEffect, useMemo, useRef, useState } from "react";
import { Helmet } from "react-helmet-async";
import { useMutation, useQuery } from "react-query";
import { useNavigate } from "react-router-dom";
Expand All @@ -46,16 +39,17 @@ const WorkspaceParametersPageExperimental: FC = () => {
const ws = useRef<WebSocket | null>(null);
const [wsError, setWsError] = useState<Error | null>(null);

const sendMessage = useCallback((formValues: Record<string, string>) => {
const sendMessage = useEffectEvent((formValues: Record<string, string>) => {
const request: DynamicParametersRequest = {
id: wsResponseId.current + 1,
owner_id: workspace.owner_id,
inputs: formValues,
};
if (ws.current && ws.current.readyState === WebSocket.OPEN) {
ws.current.send(JSON.stringify(request));
wsResponseId.current = wsResponseId.current + 1;
}
}, []);
});

const onMessage = useEffectEvent((response: DynamicParametersResponse) => {
if (latestResponse && latestResponse?.id >= response.id) {
Expand All @@ -69,7 +63,6 @@ const WorkspaceParametersPageExperimental: FC = () => {
if (!workspace.latest_build.template_version_id) return;

const socket = API.templateVersionDynamicParameters(
workspace.owner_id,
workspace.latest_build.template_version_id,
{
onMessage,
Expand All @@ -96,11 +89,7 @@ const WorkspaceParametersPageExperimental: FC = () => {
return () => {
socket.close();
};
}, [
workspace.owner_id,
workspace.latest_build.template_version_id,
onMessage,
]);
}, [workspace.latest_build.template_version_id, onMessage]);

const updateParameters = useMutation({
mutationFn: (buildParameters: WorkspaceBuildParameter[]) =>
Expand Down
Loading