Skip to content

chore(site): remove create template xservice #10112

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 17 commits into from
Oct 9, 2023
Merged

chore(site): remove create template xservice #10112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b1a0b25
Started to think on a few abstractions
BrunoQuaresma Oct 6, 2023
fca6504
Refactor loading views and duplicate template
BrunoQuaresma Oct 6, 2023
1180e8b
Show logs and build errors
BrunoQuaresma Oct 6, 2023
f6b3fd2
Fix missing parameters
BrunoQuaresma Oct 6, 2023
21ae383
Refactor DuplicateTemplateView
BrunoQuaresma Oct 6, 2023
db14220
Refactor ImportStarterTemplateView
BrunoQuaresma Oct 6, 2023
a95ed6d
Refactor upload view
BrunoQuaresma Oct 6, 2023
80ac7bf
Remove create template xservice
BrunoQuaresma Oct 6, 2023
82fd842
Merge branch 'main' of https://github.com/coder/coder into bq/refacto…
BrunoQuaresma Oct 9, 2023
be8a70e
Fix imports
BrunoQuaresma Oct 9, 2023
d3ca396
Show missed variables
BrunoQuaresma Oct 9, 2023
3d13ca6
Remove emotion warning
BrunoQuaresma Oct 9, 2023
4d4a629
Mock scroll to function
BrunoQuaresma Oct 9, 2023
5310b1b
Mock logs
BrunoQuaresma Oct 9, 2023
d1b307a
Fix one test
BrunoQuaresma Oct 9, 2023
4e2476f
Fix tests
BrunoQuaresma Oct 9, 2023
673c524
Fix storybook
BrunoQuaresma Oct 9, 2023
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
1 change: 1 addition & 0 deletions site/jest.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ module.exports = {
transform: {
react: {
runtime: "automatic",
importSource: "@emotion/react",
},
},
experimental: {
Expand Down
1 change: 1 addition & 0 deletions site/jest.setup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ global.TextEncoder = TextEncoder;
global.TextDecoder = TextDecoder as any;
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Polyfill for jsdom
global.Blob = Blob as any;
global.scrollTo = jest.fn();

// Polyfill the getRandomValues that is used on utils/random.ts
Object.defineProperty(global.self, "crypto", {
Expand Down
2 changes: 1 addition & 1 deletion site/src/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@ export const getTemplateExamples = async (
return response.data;
};

export const uploadTemplateFile = async (
export const uploadFile = async (
file: File,
): Promise<TypesGen.UploadResponse> => {
const response = await axios.post("/api/v2/files", file, {
Expand Down
7 changes: 7 additions & 0 deletions site/src/api/queries/files.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as API from "api/api";

export const uploadFile = () => {
return {
mutationFn: API.uploadFile,
};
};
8 changes: 8 additions & 0 deletions site/src/api/queries/templateVersions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import * as API from "api/api";

export const templateVersionLogs = (versionId: string) => {
return {
queryKey: ["templateVersion", versionId, "logs"],
queryFn: () => API.getTemplateVersionLogs(versionId),
};
};
73 changes: 55 additions & 18 deletions site/src/api/queries/templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import {
type CreateTemplateVersionRequest,
type ProvisionerJobStatus,
type TemplateVersion,
CreateTemplateRequest,
ProvisionerJob,
} from "api/typesGenerated";
import { type QueryClient, type QueryOptions } from "react-query";
import { delay } from "utils/delay";
Expand Down Expand Up @@ -80,25 +82,10 @@ export const templateVersionVariables = (versionId: string) => {

export const createAndBuildTemplateVersion = (orgId: string) => {
return {
mutationFn: async (
request: CreateTemplateVersionRequest,
): Promise<string> => {
mutationFn: async (request: CreateTemplateVersionRequest) => {
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;
await waitBuildToBeFinished(newVersion);
return newVersion;
},
};
};
Expand Down Expand Up @@ -133,3 +120,53 @@ export const templateVersionExternalAuth = (versionId: string) => {
queryFn: () => API.getTemplateVersionExternalAuth(versionId),
};
};

export const createTemplate = () => {
return {
mutationFn: createTemplateFn,
};
};

const createTemplateFn = async (options: {
organizationId: string;
version: CreateTemplateVersionRequest;
template: Omit<CreateTemplateRequest, "template_version_id">;
}) => {
const version = await API.createTemplateVersion(
options.organizationId,
options.version,
);
await waitBuildToBeFinished(version);
return API.createTemplate(options.organizationId, {
...options.template,
template_version_id: version.id,
});
};

const waitBuildToBeFinished = async (version: TemplateVersion) => {
let data: TemplateVersion;
let jobStatus: ProvisionerJobStatus;
do {
await delay(1000);
data = await API.getTemplateVersion(version.id);
jobStatus = data.job.status;

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

// No longer pending/running, but didn't succeed
throw new JobError(data.job, version);
};

export class JobError extends Error {
public job: ProvisionerJob;
public version: TemplateVersion;

constructor(job: ProvisionerJob, version: TemplateVersion) {
super(job.error);
this.job = job;
this.version = version;
}
}
Comment on lines +163 to +172
Copy link
Member

Choose a reason for hiding this comment

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

do we have somewhere more general we can put these sorts of errors? not crazy about this being tucked away in queries/

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We don't but I'm open to it if you have any place or organization in mind.

Copy link
Member

Choose a reason for hiding this comment

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

maybe util/errors or something? I don’t tend to like util/ folders, but it’d be slightly more reusable there until we think of somewhere better

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hm... Idk but I feel it is kinda of far from where it is used since it is only used there - for now and probably it will be the only place where it makes sense IMO.

18 changes: 15 additions & 3 deletions site/src/pages/CreateTemplatePage/CreateTemplateForm.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {
MockTemplate,
MockTemplateExample,
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
Expand All @@ -21,16 +22,26 @@ const meta: Meta<typeof CreateTemplateForm> = {
export default meta;
type Story = StoryObj<typeof CreateTemplateForm>;

export const Initial: Story = {};
export const Upload: Story = {
args: {
upload: {
isUploading: false,
onRemove: () => {},
onUpload: () => {},
file: undefined,
},
},
};

export const WithStarterTemplate: Story = {
export const StarterTemplate: Story = {
args: {
starterTemplate: MockTemplateExample,
},
};

export const WithVariables: Story = {
export const DuplicateTemplateWithVariables: Story = {
args: {
copiedTemplate: MockTemplate,
variables: [
MockTemplateVersionVariable1,
MockTemplateVersionVariable2,
Expand All @@ -43,6 +54,7 @@ export const WithVariables: Story = {

export const WithJobError: Story = {
args: {
copiedTemplate: MockTemplate,
jobError:
"template import provision for start: recv import provision: plan terraform: terraform plan: exit status 1",
logs: [
Expand Down
Loading