Skip to content

refactor: get rid of templateVariablesXService #9763

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 6 commits into from
Sep 19, 2023
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
feedback
  • Loading branch information
aslilac committed Sep 19, 2023
commit a4032d091a4d89960b5d2963c16cce29172ffb91
30 changes: 24 additions & 6 deletions site/src/api/queries/templates.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ import {
type Template,
type AuthorizationResponse,
type CreateTemplateVersionRequest,
type ProvisionerJobStatus,
type TemplateVersion,
} from "api/typesGenerated";
import { type QueryClient, type QueryOptions } from "@tanstack/react-query";
import { delay } from "utils/delay";

export const templateByNameKey = (orgId: string, name: string) => [
orgId,
Expand Down Expand Up @@ -75,13 +78,28 @@ export const templateVersionVariables = (versionId: string) => {
};
};

export const createTemplateVersion = (
orgId: string,
queryClient: QueryClient,
) => {
export const createAndBuildTemplateVersion = (orgId: string) => {
return {
mutationFn: (request: CreateTemplateVersionRequest) =>
API.createTemplateVersion(orgId, request),
mutationFn: async (
request: CreateTemplateVersionRequest,
): Promise<string> => {
const newVersion = await API.createTemplateVersion(orgId, request);

let data: TemplateVersion;
let jobStatus: ProvisionerJobStatus;
do {
await delay(1000);
data = await API.getTemplateVersion(newVersion.id);
jobStatus = data.job.status;

if (jobStatus === "succeeded") {
return newVersion.id;
}
} while (jobStatus === "pending" || jobStatus === "running");

// No longer pending/running, but didn't succeed
throw data.job.error;
},
};
};

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
import { useMachine } from "@xstate/react";
import {
CreateTemplateVersionRequest,
TemplateVersionVariable,
VariableValue,
} from "api/typesGenerated";
import { displaySuccess } from "components/GlobalSnackbar/utils";
import { useOrganizationId } from "hooks/useOrganizationId";
import { useEffect, type FC, useState } from "react";
import { useCallback, type FC } from "react";
import { Helmet } from "react-helmet-async";
import { useNavigate, useParams } from "react-router-dom";
import { pageTitle } from "utils/page";
import { useTemplateSettings } from "../TemplateSettingsLayout";
import { TemplateVariablesPageView } from "./TemplateVariablesPageView";
import {
createTemplateVersion,
createAndBuildTemplateVersion,
templateVersion,
templateVersionVariables,
updateActiveTemplateVersion,
Expand All @@ -33,8 +32,6 @@ export const TemplateVariablesPage: FC = () => {
const queryClient = useQueryClient();
const versionId = template.active_version_id;

const [newVersionId, setNewVersionId] = useState<string | null>(null);

const {
data: version,
error: versionError,
Expand All @@ -49,51 +46,34 @@ export const TemplateVariablesPage: FC = () => {
keepPreviousData: true,
});

const createVersionMutation = createTemplateVersion(orgId, queryClient);
const { mutate: sendCreateTemplateVersion, error: createVersionError } =
useMutation({
...createVersionMutation,
onSuccess: (data) => {
setNewVersionId(data.id);
},
});
const publishMutation = updateActiveTemplateVersion(template, queryClient);
const { mutate: publishVersion, error: publishError } = useMutation({
...publishMutation,
onSuccess: () => {
publishMutation.onSuccess();
const {
mutateAsync: sendCreateAndBuildTemplateVersion,
error: buildError,
isLoading: isBuilding,
} = useMutation(createAndBuildTemplateVersion(orgId));
const {
mutateAsync: sendUpdateActiveTemplateVersion,
error: publishError,
isLoading: isPublishing,
} = useMutation(updateActiveTemplateVersion(template, queryClient));

const publishVersion = useCallback(
async (versionId: string) => {
await sendUpdateActiveTemplateVersion(versionId);
displaySuccess("Template updated successfully");
},
onSettled: () => {
setNewVersionId(null);
},
});

const {
data: status,
error: statusError,
refetch: refetchStatus,
isRefetching,
} = useQuery(
newVersionId ? templateVersion(newVersionId) : { enabled: false },
[sendUpdateActiveTemplateVersion],
);

const isSubmitting = Boolean(newVersionId && !statusError);

// Poll build status while we're updating the template
useEffect(() => {
if (!newVersionId || !status || isRefetching) {
return;
}

const jobStatus = status.job.status;
if (jobStatus === "pending" || jobStatus === "running") {
setTimeout(() => refetchStatus(), 2_000);
return;
}
const buildVersion = useCallback(
async (req: CreateTemplateVersionRequest) => {
const newVersionId = await sendCreateAndBuildTemplateVersion(req);
await publishVersion(newVersionId);
},
[sendCreateAndBuildTemplateVersion, publishVersion],
);

publishVersion(newVersionId);
}, [newVersionId, status, isRefetching]);
const isSubmitting = Boolean(isBuilding || isPublishing);

const error = versionError ?? variablesError;
if (error) {
Expand All @@ -115,17 +95,15 @@ export const TemplateVariablesPage: FC = () => {
templateVersion={version}
templateVariables={variables}
errors={{
createVersionError,
statusError,
jobError: status?.job.error,
buildError,
publishError,
}}
onCancel={() => {
navigate(`/templates/${templateName}`);
}}
onSubmit={(formData) => {
onSubmit={async (formData) => {
const request = filterEmptySensitiveVariables(formData, variables);
sendCreateTemplateVersion(request);
await buildVersion(request);
}}
/>
</>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,7 @@ export const WithErrors: Story = {
MockTemplateVersionVariable4,
],
errors: {
createVersionError: mockApiError({
message: "createVersionError",
}),
statusError: mockApiError({
buildError: mockApiError({
message: "statusError",
validations: [
{
Expand All @@ -71,7 +68,6 @@ export const WithErrors: Story = {
},
],
}),
jobError: "jobError",
publishError: mockApiError({ message: "publishError" }),
},

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,9 @@ export interface TemplateVariablesPageViewProps {
isSubmitting: boolean;
errors?: {
/**
* Failed to create a new template version
* Failed to build a new template version
*/
createVersionError?: unknown;
/**
* Failed to poll job status of new template version
*/
statusError?: unknown;
/**
* Job for new template version failed
*/
jobError?: TemplateVersion["job"]["error"];
buildError?: unknown;
/**
* New version was created successfully, but publishing it failed
*/
Expand All @@ -52,22 +44,16 @@ export const TemplateVariablesPageView: FC<TemplateVariablesPageViewProps> = ({
const classes = useStyles();
const hasError = Object.values(errors).some((error) => Boolean(error));

console.log("LOOK AT ME", errors);

return (
<>
<PageHeader className={classes.pageHeader}>
<PageHeaderTitle>Template variables</PageHeaderTitle>
</PageHeader>
{hasError && (
<Stack className={classes.errorContainer}>
{Boolean(errors.createVersionError) && (
<ErrorAlert error={errors.createVersionError} />
)}
{Boolean(errors.statusError) && (
<ErrorAlert error={errors.statusError} />
{Boolean(errors.buildError) && (
<ErrorAlert error={errors.buildError} />
)}
{Boolean(errors.jobError) && <ErrorAlert error={errors.jobError} />}
{Boolean(errors.publishError) && (
<ErrorAlert error={errors.publishError} />
)}
Expand All @@ -81,7 +67,7 @@ export const TemplateVariablesPageView: FC<TemplateVariablesPageViewProps> = ({
templateVariables={templateVariables}
onSubmit={onSubmit}
onCancel={onCancel}
error={errors.statusError}
error={errors.buildError}
/>
)}
{templateVariables && templateVariables.length === 0 && (
Expand Down