Skip to content

fix(site): use the active version on the parameters page when it is required #30906

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

Draft
jeremyruppel wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −59
Draft

fix(site): use the active version on the parameters page when it is required #30906

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
51 changes: 0 additions & 51 deletions ...c/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import type { Workspace } from "#/api/typesGenerated";
import type { WorkspacePermissions } from "#/modules/workspaces/permissions";
import {
MockDropdownParameter,
MockOutdatedRunningWorkspaceRequireActiveVersion,
MockOutdatedStoppedWorkspaceRequireActiveVersion,
MockPermissions,
MockPreviewParameter,
Expand Down Expand Up @@ -162,56 +161,6 @@ export const StartWorkspace: Story = {
},
};

export const RequireActiveVersionBlocked: Story = {
parameters: {
reactRouter: workspaceRouterParameters(
MockOutdatedStoppedWorkspaceRequireActiveVersion,
),
queries: workspaceQueries(
MockOutdatedStoppedWorkspaceRequireActiveVersion,
{ updateWorkspaceVersion: false },
),
webSocket: filledWebSocketParams(),
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
await waitFor(() =>
expect(
canvas.getByText(/requires automatic updates/),
).toBeInTheDocument(),
);
const submitButton = canvas.getByRole("button", {
name: "Update and start",
});
expect(submitButton).toBeDisabled();
},
};

export const RequireActiveVersionBlockedRunning: Story = {
parameters: {
reactRouter: workspaceRouterParameters(
MockOutdatedRunningWorkspaceRequireActiveVersion,
),
queries: workspaceQueries(
MockOutdatedRunningWorkspaceRequireActiveVersion,
{ updateWorkspaceVersion: false },
),
webSocket: filledWebSocketParams(),
},
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
await waitFor(() =>
expect(
canvas.getByText(/requires automatic updates/),
).toBeInTheDocument(),
);
const submitButton = canvas.getByRole("button", {
name: "Update and restart",
});
expect(submitButton).toBeDisabled();
},
};

export const RequireActiveVersionEditable: Story = {
parameters: {
reactRouter: workspaceRouterParameters(
Expand Down
54 changes: 54 additions & 0 deletions .../src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
MockPreviewParameter2,
MockPreviewParameter4,
MockPreviewParameter7,
MockTemplateVersion2,
MockWorkspace,
MockWorkspaceBuildParameter1,
MockWorkspaceBuildParameter4,
Expand Down Expand Up @@ -315,6 +316,59 @@ describe("WorkspaceParametersPage", () => {
);
});

it("uses the required active version when opened without one", async () => {
const workspace: TypesGen.Workspace = {
...MockOutdatedStoppedWorkspaceRequireActiveVersion,
template_active_version_id: MockTemplateVersion2.id,
};
vi.mocked(API.getWorkspaceByOwnerAndName)
.mockReset()
.mockResolvedValue(workspace);
vi.spyOn(API, "checkAuthorization").mockResolvedValue({
readWorkspace: true,
shareWorkspace: true,
updateWorkspace: true,
updateWorkspaceVersion: false,
deleteFailedWorkspace: false,
});
vi.spyOn(API, "getWorkspaceBuildParameters").mockResolvedValueOnce([]);

const [, mockPublisher] = mockDynamicParameterWebSocket();

renderWorkspaceParametersPage(
`/@${workspace.owner_name}/${workspace.name}/settings`,
);

await connectWithInitialParameters(mockPublisher, [
MockPreviewParameter1,
MockPreviewParameter4,
MockPreviewParameter7,
]);
expect(API.templateVersionDynamicParameters).toHaveBeenCalledTimes(1);
expect(API.templateVersionDynamicParameters).toHaveBeenCalledWith(
workspace.template_active_version_id,
workspace.owner_id,
expect.anything(),
);
await waitForLoaderToBeRemoved();

const form = screen.getByTestId("form");
const submitButton = within(form).getByRole("button", {
name: /update and start/i,
});
await waitFor(() => expect(submitButton).toBeEnabled());

await userEvent.click(submitButton);
await waitFor(() =>
expect(API.postWorkspaceBuild).toHaveBeenCalledWith(
workspace.id,
expect.objectContaining({
template_version_id: workspace.template_active_version_id,
}),
),
);
});

it("does not clobber edited parameters", async () => {
vi.spyOn(API, "getWorkspaceBuildParameters").mockResolvedValueOnce([]);

Expand Down
12 changes: 11 additions & 1 deletion site/src/pages/WorkspaceSettingsPage/WorkspaceParametersPage/WorkspaceParametersPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ const WorkspaceParametersPage: React.FC = () => {
const { permissions, workspace } = useWorkspaceSettings();
const navigate = useNavigate();
const [searchParams] = useSearchParams();
const templateVersionId = searchParams.get("templateVersionId") ?? undefined;
const mustUseActiveVersion =
workspace.template_require_active_version &&
!permissions?.updateWorkspaceVersion;
const requestedVersionId = searchParams.get("templateVersionId") ?? undefined;
const templateVersionId = mustUseActiveVersion
? workspace.template_active_version_id
: requestedVersionId;
const permissionsLoaded = permissions !== undefined;

const [confirmingRestart, setConfirmingRestart] = useState<{
open: boolean;
Expand Down Expand Up @@ -119,6 +126,8 @@ const WorkspaceParametersPage: React.FC = () => {
}, [latestBuildParametersLoading]);

useEffect(() => {
// The target version depends on permissions.
if (!permissionsLoaded) return;
Comment on lines +129 to +130

@aslilac aslilac Oct 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't like adding another condition here. why not just leave templateVersionId unresolved until permissions is set so that it falls through to the early return immediately after this?

if (!templateVersionId && !workspace.latest_build.template_version_id)
return;

Expand Down Expand Up @@ -168,6 +177,7 @@ const WorkspaceParametersPage: React.FC = () => {
socket.close();
};
}, [
permissionsLoaded,
templateVersionId,
workspace.latest_build.template_version_id,
workspace.owner_id,
Expand Down
13 changes: 6 additions & 7 deletions site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1898,13 +1898,12 @@ export const MockDormantOutdatedWorkspace: TypesGen.Workspace = {
dormant_at: new Date().toISOString(),
};

export const MockOutdatedRunningWorkspaceRequireActiveVersion: TypesGen.Workspace =
{
...MockWorkspace,
id: "test-outdated-workspace-require-active-version",
outdated: true,
template_require_active_version: true,
};
const MockOutdatedRunningWorkspaceRequireActiveVersion: TypesGen.Workspace = {
...MockWorkspace,
id: "test-outdated-workspace-require-active-version",
outdated: true,
template_require_active_version: true,
};

export const MockOutdatedStoppedWorkspaceRequireActiveVersion: TypesGen.Workspace =
{
Expand Down
Loading