Skip to content

chore(site): refactor starter templates to use react-query #9697

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 3 commits into from
Sep 18, 2023
Merged

chore(site): refactor starter templates to use react-query #9697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92eb15a
Remove starter templates service
BrunoQuaresma Sep 15, 2023
f00cd7c
Remove starter template service
BrunoQuaresma Sep 15, 2023
d1df250
Remove template x service
BrunoQuaresma Sep 15, 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
23 changes: 11 additions & 12 deletions site/src/pages/StarterTemplatePage/StarterTemplatePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
import { useMachine } from "@xstate/react";
import { useOrganizationId } from "hooks/useOrganizationId";
import { FC } from "react";
import { Helmet } from "react-helmet-async";
import { useParams } from "react-router-dom";
import { pageTitle } from "utils/page";
import { starterTemplateMachine } from "xServices/starterTemplates/starterTemplateXService";
import { StarterTemplatePageView } from "./StarterTemplatePageView";
import { useQuery } from "@tanstack/react-query";
import { templateExamples } from "api/queries/templates";

const StarterTemplatePage: FC = () => {
const { exampleId } = useParams() as { exampleId: string };
const organizationId = useOrganizationId();
const [state] = useMachine(starterTemplateMachine, {
context: {
organizationId,
exampleId,
},
});
const templateExamplesQuery = useQuery(templateExamples(organizationId));
Copy link
Member

@code-asher code-asher Sep 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Not something to do in this PR, but just a note that maybe we need a way to get a template example by ID, seems unfortunate to query all the templates just to get one!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I do agree with you!

const starterTemplate = templateExamplesQuery.data?.find(
(example) => example.id === exampleId,
);

return (
<>
<Helmet>
<title>
{pageTitle(state.context.starterTemplate?.name ?? exampleId)}
</title>
<title>{pageTitle(starterTemplate?.name ?? exampleId)}</title>
</Helmet>

<StarterTemplatePageView context={state.context} />
<StarterTemplatePageView
starterTemplate={starterTemplate}
error={templateExamplesQuery.error}
/>
</>
);
};
Expand Down
26 changes: 7 additions & 19 deletions site/src/pages/StarterTemplatePage/StarterTemplatePageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
import {
mockApiError,
MockOrganization,
MockTemplateExample,
} from "testHelpers/entities";
import { mockApiError, MockTemplateExample } from "testHelpers/entities";
import { StarterTemplatePageView } from "./StarterTemplatePageView";

import type { Meta, StoryObj } from "@storybook/react";
Expand All @@ -17,23 +13,15 @@ type Story = StoryObj<typeof StarterTemplatePageView>;

export const Default: Story = {
args: {
context: {
exampleId: MockTemplateExample.id,
organizationId: MockOrganization.id,
error: undefined,
starterTemplate: MockTemplateExample,
},
error: undefined,
starterTemplate: MockTemplateExample,
},
};
export const Error: Story = {
args: {
context: {
exampleId: MockTemplateExample.id,
organizationId: MockOrganization.id,
error: mockApiError({
message: `Example ${MockTemplateExample.id} not found.`,
}),
starterTemplate: undefined,
},
error: mockApiError({
message: `Example ${MockTemplateExample.id} not found.`,
}),
starterTemplate: undefined,
},
};
13 changes: 7 additions & 6 deletions site/src/pages/StarterTemplatePage/StarterTemplatePageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,28 @@ import {
PageHeaderTitle,
} from "components/PageHeader/PageHeader";
import { FC } from "react";
import { StarterTemplateContext } from "xServices/starterTemplates/starterTemplateXService";
import ViewCodeIcon from "@mui/icons-material/OpenInNewOutlined";
import PlusIcon from "@mui/icons-material/AddOutlined";
import { Stack } from "components/Stack/Stack";
import { Link } from "react-router-dom";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { TemplateExample } from "api/typesGenerated";

export interface StarterTemplatePageViewProps {
context: StarterTemplateContext;
starterTemplate?: TemplateExample;
error?: unknown;
}

export const StarterTemplatePageView: FC<StarterTemplatePageViewProps> = ({
context,
starterTemplate,
error,
}) => {
const styles = useStyles();
const { starterTemplate } = context;

if (context.error) {
if (error) {
return (
<Margins>
<ErrorAlert error={context.error} />
<ErrorAlert error={error} />
</Margins>
);
}
Expand Down
17 changes: 11 additions & 6 deletions site/src/pages/StarterTemplatesPage/StarterTemplatesPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
import { useMachine } from "@xstate/react";
import { useOrganizationId } from "hooks/useOrganizationId";
import { FC } from "react";
import { Helmet } from "react-helmet-async";
import { pageTitle } from "utils/page";
import { starterTemplatesMachine } from "xServices/starterTemplates/starterTemplatesXService";
import { StarterTemplatesPageView } from "./StarterTemplatesPageView";
import { useQuery } from "@tanstack/react-query";
import { templateExamples } from "api/queries/templates";
import { getTemplatesByTag } from "utils/starterTemplates";

const StarterTemplatesPage: FC = () => {
const organizationId = useOrganizationId();
const [state] = useMachine(starterTemplatesMachine, {
context: { organizationId },
});
const templateExamplesQuery = useQuery(templateExamples(organizationId));
const starterTemplatesByTag = templateExamplesQuery.data
? getTemplatesByTag(templateExamplesQuery.data)
: undefined;

return (
<>
<Helmet>
<title>{pageTitle("Starter Templates")}</title>
</Helmet>

<StarterTemplatesPageView context={state.context} />
<StarterTemplatesPageView
error={templateExamplesQuery.error}
starterTemplatesByTag={starterTemplatesByTag}
/>
</>
);
};
Expand Down
25 changes: 9 additions & 16 deletions site/src/pages/StarterTemplatesPage/StarterTemplatesPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import {
mockApiError,
MockOrganization,
MockTemplateExample,
MockTemplateExample2,
} from "testHelpers/entities";
Expand All @@ -18,25 +17,19 @@ type Story = StoryObj<typeof StarterTemplatesPageView>;

export const Default: Story = {
args: {
context: {
organizationId: MockOrganization.id,
error: undefined,
starterTemplatesByTag: getTemplatesByTag([
MockTemplateExample,
MockTemplateExample2,
]),
},
error: undefined,
starterTemplatesByTag: getTemplatesByTag([
MockTemplateExample,
MockTemplateExample2,
]),
},
};

export const Error: Story = {
args: {
context: {
organizationId: MockOrganization.id,
error: mockApiError({
message: "Error on loading the template examples",
}),
starterTemplatesByTag: undefined,
},
error: mockApiError({
message: "Error on loading the template examples",
}),
starterTemplatesByTag: undefined,
},
};
19 changes: 11 additions & 8 deletions site/src/pages/StarterTemplatesPage/StarterTemplatesPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { TemplateExampleCard } from "components/TemplateExampleCard/TemplateExam
import { FC } from "react";
import { Link, useSearchParams } from "react-router-dom";
import { combineClasses } from "utils/combineClasses";
import { StarterTemplatesContext } from "xServices/starterTemplates/starterTemplatesXService";
import { StarterTemplatesByTag } from "utils/starterTemplates";

const getTagLabel = (tag: string) => {
const labelByTag: Record<string, string> = {
Expand All @@ -26,22 +26,25 @@ const getTagLabel = (tag: string) => {
return labelByTag[tag] ?? tag;
};

const selectTags = ({ starterTemplatesByTag }: StarterTemplatesContext) => {
const selectTags = (starterTemplatesByTag: StarterTemplatesByTag) => {
return starterTemplatesByTag
? Object.keys(starterTemplatesByTag).sort((a, b) => a.localeCompare(b))
: undefined;
};
export interface StarterTemplatesPageViewProps {
context: StarterTemplatesContext;
starterTemplatesByTag?: StarterTemplatesByTag;
error?: unknown;
}

export const StarterTemplatesPageView: FC<StarterTemplatesPageViewProps> = ({
context,
starterTemplatesByTag,
error,
}) => {
const [urlParams] = useSearchParams();
const styles = useStyles();
const { starterTemplatesByTag } = context;
const tags = selectTags(context);
const tags = starterTemplatesByTag
? selectTags(starterTemplatesByTag)
: undefined;
const activeTag = urlParams.get("tag") ?? "all";
const visibleTemplates = starterTemplatesByTag
? starterTemplatesByTag[activeTag]
Expand All @@ -56,8 +59,8 @@ export const StarterTemplatesPageView: FC<StarterTemplatesPageViewProps> = ({
</PageHeaderSubtitle>
</PageHeader>

<Maybe condition={Boolean(context.error)}>
<ErrorAlert error={context.error} />
<Maybe condition={Boolean(error)}>
<ErrorAlert error={error} />
</Maybe>

<Maybe condition={Boolean(!starterTemplatesByTag)}>
Expand Down
71 changes: 0 additions & 71 deletions site/src/xServices/starterTemplates/starterTemplateXService.ts
View file
Open in desktop

This file was deleted.

66 changes: 0 additions & 66 deletions site/src/xServices/starterTemplates/starterTemplatesXService.ts
View file
Open in desktop

This file was deleted.