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 4 commits
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
10 changes: 9 additions & 1 deletion site/src/api/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,15 @@ export const mapApiErrorToFieldErrors = (
export const getErrorMessage = (
error: unknown,
defaultMessage: string,
): string => (isApiError(error) ? error.response.data.message : defaultMessage);
): string => {
if (isApiError(error)) {
return error.response.data.message;
}
if (typeof error === "string") {
return error;
}
return defaultMessage;
};

/**
*
Expand Down
61 changes: 59 additions & 2 deletions site/src/api/queries/templates.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
import * as API from "api/api";
import { type Template, type AuthorizationResponse } from "api/typesGenerated";
import { type QueryOptions } from "@tanstack/react-query";
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 @@ -63,3 +70,53 @@ export const templateVersions = (templateId: string) => {
queryFn: () => API.getTemplateVersions(templateId),
};
};

export const templateVersionVariables = (versionId: string) => {
return {
queryKey: ["templateVersion", versionId, "variables"],
queryFn: () => API.getTemplateVersionVariables(versionId),
};
};

export const createAndBuildTemplateVersion = (orgId: string) => {
return {
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;
},
};
};

export const updateActiveTemplateVersion = (
template: Template,
queryClient: QueryClient,
) => {
return {
mutationFn: (versionId: string) =>
API.updateActiveTemplateVersion(template.id, {
id: versionId,
}),
onSuccess: async () => {
// invalidated because of `active_version_id`
await queryClient.invalidateQueries(
templateByNameKey(template.organization_id, template.name),
);
},
};
};
Original file line number Diff line number Diff line change
@@ -1,45 +1,88 @@
import { useMachine } from "@xstate/react";
import {
CreateTemplateVersionRequest,
TemplateVersionVariable,
VariableValue,
} from "api/typesGenerated";
import { displaySuccess } from "components/GlobalSnackbar/utils";
import { useOrganizationId } from "hooks/useOrganizationId";
import { FC } from "react";
import { useCallback, type FC } from "react";
import { Helmet } from "react-helmet-async";
import { useNavigate, useParams } from "react-router-dom";
import { templateVariablesMachine } from "xServices/template/templateVariablesXService";
import { pageTitle } from "../../../utils/page";
import { pageTitle } from "utils/page";
import { useTemplateSettings } from "../TemplateSettingsLayout";
import { TemplateVariablesPageView } from "./TemplateVariablesPageView";
import {
createAndBuildTemplateVersion,
templateVersion,
templateVersionVariables,
updateActiveTemplateVersion,
} from "api/queries/templates";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { Loader } from "components/Loader/Loader";

export const TemplateVariablesPage: FC = () => {
const { template: templateName } = useParams() as {
organization: string;
template: string;
};
const organizationId = useOrganizationId();
const orgId = useOrganizationId();
const { template } = useTemplateSettings();
const navigate = useNavigate();
const [state, send] = useMachine(templateVariablesMachine, {
context: {
organizationId,
template,
},
actions: {
onUpdateTemplate: () => {
displaySuccess("Template updated successfully");
},
},
const queryClient = useQueryClient();
const versionId = template.active_version_id;

const {
data: version,
error: versionError,
isLoading: isVersionLoading,
} = useQuery({ ...templateVersion(versionId), keepPreviousData: true });
const {
data: variables,
error: variablesError,
isLoading: isVariablesLoading,
} = useQuery({
...templateVersionVariables(versionId),
keepPreviousData: true,
});

const {
mutateAsync: sendCreateAndBuildTemplateVersion,
error: buildError,
isLoading: isBuilding,
} = useMutation(createAndBuildTemplateVersion(orgId));
const {
activeTemplateVersion,
templateVariables,
getTemplateDataError,
updateTemplateError,
jobError,
} = state.context;
mutateAsync: sendUpdateActiveTemplateVersion,
error: publishError,
isLoading: isPublishing,
} = useMutation(updateActiveTemplateVersion(template, queryClient));

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

const buildVersion = useCallback(
async (req: CreateTemplateVersionRequest) => {
const newVersionId = await sendCreateAndBuildTemplateVersion(req);
await publishVersion(newVersionId);
},
[sendCreateAndBuildTemplateVersion, publishVersion],
);

const isSubmitting = Boolean(isBuilding || isPublishing);

const error = versionError ?? variablesError;
if (error) {
return <ErrorAlert error={error} />;
}

if (isVersionLoading || isVariablesLoading) {
return <Loader />;
}

return (
<>
Expand All @@ -48,23 +91,19 @@ export const TemplateVariablesPage: FC = () => {
</Helmet>

<TemplateVariablesPageView
isSubmitting={state.hasTag("submitting")}
templateVersion={activeTemplateVersion}
templateVariables={templateVariables}
isSubmitting={isSubmitting}
templateVersion={version}
templateVariables={variables}
errors={{
getTemplateDataError,
updateTemplateError,
jobError,
buildError,
publishError,
}}
onCancel={() => {
navigate(`/templates/${templateName}`);
}}
onSubmit={(formData) => {
const request = filterEmptySensitiveVariables(
formData,
templateVariables,
);
send({ type: "UPDATE_TEMPLATE_EVENT", request: request });
onSubmit={async (formData) => {
const request = filterEmptySensitiveVariables(formData, variables);
await buildVersion(request);
}}
/>
</>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const RequiredVariable: Story = {
},
};

export const WithUpdateTemplateError: Story = {
export const WithErrors: Story = {
args: {
templateVersion: MockTemplateVersion,
templateVariables: [
Expand All @@ -59,25 +59,20 @@ export const WithUpdateTemplateError: Story = {
MockTemplateVersionVariable4,
],
errors: {
updateTemplateError: mockApiError({
message: "Something went wrong.",
buildError: mockApiError({
message: "statusError",
validations: [
{
field: `user_variable_values[0].value`,
detail: "Variable is required.",
},
],
}),
publishError: mockApiError({ message: "publishError" }),
},
},
};

export const WithJobError: Story = {
args: {
templateVersion: MockTemplateVersion,
templateVariables: [
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
MockTemplateVersionVariable3,
MockTemplateVersionVariable4,
],
errors: {
jobError:
"template import provision for start: recv import provision: plan terraform: terraform plan: exit status 1",
initialTouched: {
user_variable_values: true,
},
},
};
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import {
TemplateVersionVariable,
} from "api/typesGenerated";
import { Alert } from "components/Alert/Alert";
import { Loader } from "components/Loader/Loader";
import { ComponentProps, FC } from "react";
import { TemplateVariablesForm } from "./TemplateVariablesForm";
import { makeStyles } from "@mui/styles";
import { PageHeader, PageHeaderTitle } from "components/PageHeader/PageHeader";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { Stack } from "components/Stack/Stack";

export interface TemplateVariablesPageViewProps {
templateVersion?: TemplateVersion;
Expand All @@ -18,9 +18,14 @@ export interface TemplateVariablesPageViewProps {
onCancel: () => void;
isSubmitting: boolean;
errors?: {
getTemplateDataError?: unknown;
updateTemplateError?: unknown;
jobError?: TemplateVersion["job"]["error"];
/**
* Failed to build a new template version
*/
buildError?: unknown;
/**
* New version was created successfully, but publishing it failed
*/
publishError?: unknown;
};
initialTouched?: ComponentProps<
typeof TemplateVariablesForm
Expand All @@ -37,29 +42,23 @@ export const TemplateVariablesPageView: FC<TemplateVariablesPageViewProps> = ({
initialTouched,
}) => {
const classes = useStyles();
const isLoading =
!templateVersion &&
!templateVariables &&
!errors.getTemplateDataError &&
!errors.updateTemplateError;
const hasError = Object.values(errors).some((error) => Boolean(error));

return (
<>
<PageHeader className={classes.pageHeader}>
<PageHeaderTitle>Template variables</PageHeaderTitle>
</PageHeader>
{hasError && (
<div className={classes.errorContainer}>
{Boolean(errors.getTemplateDataError) && (
<ErrorAlert error={errors.getTemplateDataError} />
<Stack className={classes.errorContainer}>
{Boolean(errors.buildError) && (
<ErrorAlert error={errors.buildError} />
)}
{Boolean(errors.updateTemplateError) && (
<ErrorAlert error={errors.updateTemplateError} />
{Boolean(errors.publishError) && (
<ErrorAlert error={errors.publishError} />
)}
{Boolean(errors.jobError) && <ErrorAlert error={errors.jobError} />}
</div>
</Stack>
)}
{isLoading && <Loader />}
{templateVersion && templateVariables && templateVariables.length > 0 && (
<TemplateVariablesForm
initialTouched={initialTouched}
Expand All @@ -68,7 +67,7 @@ export const TemplateVariablesPageView: FC<TemplateVariablesPageViewProps> = ({
templateVariables={templateVariables}
onSubmit={onSubmit}
onCancel={onCancel}
error={errors.updateTemplateError}
error={errors.buildError}
/>
)}
{templateVariables && templateVariables.length === 0 && (
Expand Down
Loading