8000 chore: redirect to the correct template page routes by aslilac · Pull Request #14230 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

chore: redirect to the correct template page routes #14230

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 9 commits into from
Aug 12, 2024
Merged

chore: redirect to the correct template page routes #14230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bcc6636
feat: show organization information on templates page
aslilac Aug 9, 2024
4fc07cb
add story
aslilac Aug 9, 2024
54901e3
🧹
aslilac Aug 9, 2024
4b9d029
chore: enforce correct template page routes
aslilac Aug 9, 2024
ff0101b
well ok then
aslilac Aug 9, 2024
f8b48f9
Merge branch 'main' into templates-redirect
aslilac Aug 12, 2024
132bc79
test!
aslilac Aug 12, 2024
1b4c881
ywdigydmf
aslilac Aug 12, 2024
2281908
:(
aslilac Aug 12, 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
40 changes: 40 additions & 0 deletions site/src/pages/TemplatePage/TemplateRedirectController.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { waitFor } from "@testing-library/react";
import { API } from "api/api";
import * as M from "testHelpers/entities";
import { renderWithAuth } from "testHelpers/renderHelpers";
import { TemplateRedirectController } from "./TemplateRedirectController";

const renderTemplateRedirectController = (route: string) => {
return renderWithAuth(<TemplateRedirectController />, {
route,
path: "/templates/:organization?/:template",
});
};

it("redirects from multi-org to single-org", async () => {
const { router } = renderTemplateRedirectController(
`/templates/${M.MockTemplate.organization_name}/${M.MockTemplate.name}`,
);

await waitFor(() =>
expect(router.state.location.pathname).toEqual(
`/templates/${M.MockTemplate.name}`,
),
);
});

it("redirects from single-org to multi-org", async () => {
jest
.spyOn(API, "getOrganizations")
.mockResolvedValueOnce([M.MockDefaultOrganization, M.MockOrganization2]);

const { router } = renderTemplateRedirectController(
`/templates/${M.MockTemplate.name}`,
);

await waitFor(() =>
expect(router.state.location.pathname).toEqual(
`/templates/${M.MockDefaultOrganization.name}/${M.MockTemplate.name}`,
),
);
});
53 changes: 53 additions & 0 deletions site/src/pages/TemplatePage/TemplateRedirectController.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import type { FC } from "react";
import { Navigate, Outlet, useLocation, useParams } from "react-router-dom";
import type { Organization } from "api/typesGenerated";
import { useDashboard } from "modules/dashboard/useDashboard";

export const TemplateRedirectController: FC = () => {
const { organizations, showOrganizations } = useDashboard();
const { organization, template } = useParams() as {
organization?: string;
template: string;
};
const location = useLocation();

// We redirect templates without an organization to the default organization,
// as that's likely what any links floating around expect.
if (showOrganizations && !organization) {
const extraPath = removePrefix(location.pathname, `/templates/${template}`);

return (
<Navigate
to={`/templates/${getOrganizationNameByDefault(
organizations,
)}/${template}${extraPath}${location.search}`}
replace
/>
);
}

// `showOrganizations` can only be false when there is a single organization,
// so it's safe to throw away the organization name.
if (!showOrganizations && organization) {
const extraPath = removePrefix(
location.pathname,
`/templates/${organization}/${template}`,
);

return (
<Navigate
to={`/templates/${template}${extraPath}${location.search}`}
replace
/>
);
}

return <Outlet />;
};

const getOrganizationNameByDefault = (organizations: Organization[]) =>
organizations.find((org) => org.is_default)?.name;

// I really hate doing it this way, but React Router does not provide a better way.
const removePrefix = (self: string, prefix: string) =>
self.startsWith(prefix) ? self.slice(prefix.length) : self;
41 changes: 22 additions & 19 deletions site/src/router.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { Suspense, lazy } from "react";
import { lazy, Suspense } from "react";
import {
createBrowserRouter,
createRoutesFromChildren,
Navigate,
Outlet,
Route,
} from "react-router-dom";
import { TemplateRedirectController } from "pages/TemplatePage/TemplateRedirectController";
import { Loader } from "./components/Loader/Loader";
import { RequireAuth } from "./contexts/auth/RequireAuth";
import { DashboardLayout } from "./modules/dashboard/DashboardLayout";
Expand Down Expand Up @@ -289,27 +290,29 @@ const RoutesWithSuspense = () => {
const templateRouter = () => {
return (
<Route path=":template">
<Route element={<TemplateLayout />}>
<Route index element={<TemplateSummaryPage />} />
<Route path="docs" element={<TemplateDocsPage />} />
<Route path="files" element={<TemplateFilesPage />} />
<Route path="versions" element={<TemplateVersionsPage />} />
<Route path="embed" element={<TemplateEmbedPage />} />
<Route path="insights" element={<TemplateInsightsPage />} />
</Route>
<Route element={<TemplateRedirectController />}>
<Route element={<TemplateLayout />}>
<Route index element={<TemplateSummaryPage />} />
<Route path="docs" element={<TemplateDocsPage />} />
<Route path="files" element={<TemplateFilesPage />} />
<Route path="versions" element={<TemplateVersionsPage />} />
<Route path="embed" element={<TemplateEmbedPage />} />
<Route path="insights" element={<TemplateInsightsPage />} />
</Route>

<Route path="workspace" element={<CreateWorkspacePage />} />
<Route path="workspace" element={<CreateWorkspacePage />} />

<Route path="settings" element={<TemplateSettingsLayout />}>
<Route index element={<TemplateSettingsPage />} />
<Route path="permissions" element={<TemplatePermissionsPage />} />
<Route path="variables" element={<TemplateVariablesPage />} />
<Route path="schedule" element={<TemplateSchedulePage />} />
</Route>
<Route path="settings" element={<TemplateSettingsLayout />}>
<Route index element={<TemplateSettingsPage />} />
<Route path="permissions" element={<TemplatePermissionsPage />} />
<Route path="variables" element={<TemplateVariablesPage />} />
<Route path="schedule" element={<TemplateSchedulePage />} />
</Route>

<Route path="versions">
<Route path=":version">
<Route index element={<TemplateVersionPage />} />
<Route path="versions">
<Rou 55B3 te path=":version">
<Route index element={<TemplateVersionPage />} />
</Route>
</Route>
</Route>
</Route>
Expand Down
Loading
0