Skip to content

fix(site): fix parameters' request upon template variables update #11898

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
Jan 30, 2024
Merged

fix(site): fix parameters' request upon template variables update #11898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
257eeda
fix(site): fix parameters getting asked on template variables update
BrunoQuaresma Jan 29, 2024
5b2b84b
Rollback custom test query client config
BrunoQuaresma Jan 29, 2024
bf25751
Add better name
BrunoQuaresma Jan 29, 2024
b486ff1
Fix tests
BrunoQuaresma Jan 29, 2024
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
8 changes: 7 additions & 1 deletion site/src/api/queries/templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,15 @@ export const templateVersions = (templateId: string) => {
};
};

export const templateVersionVariablesKey = (versionId: string) => [
"templateVersion",
versionId,
"variables",
];

export const templateVersionVariables = (versionId: string) => {
return {
queryKey: ["templateVersion", versionId, "variables"],
queryKey: templateVersionVariablesKey(versionId),
queryFn: () => API.getTemplateVersionVariables(versionId),
};
};
Expand Down
15 changes: 5 additions & 10 deletions site/src/pages/TemplateVersionEditorPage/ProvisionerTagsPopover.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
PopoverTrigger,
} from "components/Popover/Popover";
import { ProvisionerTag } from "pages/HealthPage/ProvisionerDaemonsPage";
import { type FC } from "react";
import { Fragment, type FC } from "react";
import useTheme from "@mui/system/useTheme";
import { useFormik } from "formik";
import * as Yup from "yup";
Expand Down Expand Up @@ -111,18 +111,13 @@ export const ProvisionerTagsPopover: FC<ProvisionerTagsPopoverProps> = ({
return key !== "owner";
})
.map((k) => (
<>
<Fragment key={k}>
{k === "scope" ? (
<ProvisionerTag key={k} k={k} v={tags[k]} />
<ProvisionerTag k={k} v={tags[k]} />
) : (
<ProvisionerTag
key={k}
k={k}
v={tags[k]}
onDelete={onDelete}
/>
<ProvisionerTag k={k} v={tags[k]} onDelete={onDelete} />
)}
</>
</Fragment>
Comment on lines +114 to +120
Copy link
Member

Choose a reason for hiding this comment

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

this doesn't even need to be a fragment, both branches only return one element. I guess it's nice to only specify the key in one place tho.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes!

))}
</Stack>

Expand Down
4 changes: 2 additions & 2 deletions site/src/pages/TemplateVersionEditorPage/TemplateVersionEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,7 +689,7 @@ const styles = {
padding: "0 16px",
fontFamily: MONOSPACE_FONT_FAMILY,

"&:first-child": {
"&:first-of-type": {
paddingTop: 16,
},

Expand All @@ -715,7 +715,7 @@ const styles = {
borderLeft: 0,
borderRight: 0,

"&:first-child": {
"&:first-of-type": {
borderTop: 0,
},

Expand Down
124 changes: 122 additions & 2 deletions site/src/pages/TemplateVersionEditorPage/TemplateVersionEditorPage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
import { renderWithAuth } from "testHelpers/renderHelpers";
import {
renderWithAuth,
waitForLoaderToBeRemoved,
} from "testHelpers/renderHelpers";
import TemplateVersionEditorPage from "./TemplateVersionEditorPage";
import { screen, waitFor, within } from "@testing-library/react";
import { render, screen, waitFor, within } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import * as api from "api/api";
import {
MockTemplate,
MockTemplateVersion,
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
MockWorkspaceBuildLogs,
} from "testHelpers/entities";
import { Language } from "./PublishTemplateVersionDialog";
import { QueryClient } from "react-query";
import { templateVersionVariablesKey } from "api/queries/templates";
import { RouterProvider, createMemoryRouter } from "react-router-dom";
import { RequireAuth } from "contexts/auth/RequireAuth";
import { server } from "testHelpers/server";
import { rest } from "msw";
import { AppProviders } from "App";

// For some reason this component in Jest is throwing a MUI style warning so,
// since we don't need it for this test, we can mock it out
Expand Down Expand Up @@ -208,3 +220,111 @@ test("Patch request is not send when there are no changes", async () => {
);
expect(patchTemplateVersion).toBeCalledTimes(0);
});

describe.each([
{
testName: "Do not ask when template version has no errors",
initialVariables: undefined,
loadedVariables: undefined,
templateVersion: MockTemplateVersion,
askForVariables: false,
},
{
testName:
"Do not ask when template version has no errors even when having previously loaded variables",
initialVariables: [
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
],
loadedVariables: undefined,
templateVersion: MockTemplateVersion,
askForVariables: false,
},
{
testName: "Ask when template version has errors",
initialVariables: undefined,
templateVersion: {
...MockTemplateVersion,
job: {
...MockTemplateVersion.job,
error_code: "REQUIRED_TEMPLATE_VARIABLES",
},
},
loadedVariables: [
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
],
askForVariables: true,
},
])(
"Missing template variables",
({
testName,
initialVariables,
loadedVariables,
templateVersion,
askForVariables,
}) => {
it(testName, async () => {
jest.resetAllMocks();
const queryClient = new QueryClient();
queryClient.setQueryData(
templateVersionVariablesKey(MockTemplateVersion.id),
initialVariables,
);

server.use(
rest.get(
"/api/v2/organizations/:org/templates/:template/versions/:version",
(req, res, ctx) => {
return res(ctx.json(templateVersion));
},
),
);

if (loadedVariables) {
server.use(
rest.get(
"/api/v2/templateversions/:version/variables",
(req, res, ctx) => {
return res(ctx.json(loadedVariables));
},
),
);
}

render(
<AppProviders queryClient={queryClient}>
<RouterProvider
router={createMemoryRouter(
[
{
element: <RequireAuth />,
children: [
{
element: <TemplateVersionEditorPage />,
path: "/templates/:template/versions/:version/edit",
},
],
},
],
{
initialEntries: [
`/templates/${MockTemplate.name}/versions/${MockTemplateVersion.name}/edit`,
],
},
)}
/>
</AppProviders>,
);
await waitForLoaderToBeRemoved();

const dialogSelector = /template variables/i;
if (askForVariables) {
await screen.findByText(dialogSelector);
} else {
expect(screen.queryByText(dialogSelector)).not.toBeInTheDocument();
}
});
},
);
12 changes: 7 additions & 5 deletions site/src/pages/TemplateVersionEditorPage/TemplateVersionEditorPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,21 +302,23 @@ const useVersionLogs = (
};

const useMissingVariables = (templateVersion: TemplateVersion | undefined) => {
const { data: missingVariables } = useQuery({
const isRequiringVariables =
templateVersion?.job.error_code === "REQUIRED_TEMPLATE_VARIABLES";
const { data: variables } = useQuery({
...templateVersionVariables(templateVersion?.id ?? ""),
enabled: templateVersion?.job.error_code === "REQUIRED_TEMPLATE_VARIABLES",
enabled: isRequiringVariables,
});
const [isMissingVariablesDialogOpen, setIsMissingVariablesDialogOpen] =
useState(false);

useEffect(() => {
if (missingVariables) {
if (isRequiringVariables) {
setIsMissingVariablesDialogOpen(true);
}
}, [missingVariables]);
}, [isRequiringVariables]);

return {
missingVariables,
missingVariables: isRequiringVariables ? variables : undefined,
isMissingVariablesDialogOpen,
setIsMissingVariablesDialogOpen,
};
Expand Down
6 changes: 6 additions & 0 deletions site/src/testHelpers/handlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ export const handlers = [
ctx.json([M.MockTemplateVersion2, M.MockTemplateVersion]),
);
}),
rest.patch(
"/api/v2/templates/:templateId/versions",
async (req, res, ctx) => {
return res(ctx.status(200), ctx.json({}));
},
),
rest.patch("/api/v2/templates/:templateId", async (req, res, ctx) => {
return res(ctx.status(200), ctx.json(M.MockTemplate));
}),
Expand Down