Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5b90c69

Browse files
BrunoQuaresmaBrunoQuaresma
authored
chore: simplify workspace routing (#17981)
1 parent db806ae commit 5b90c69

File tree

6 files changed

+47
-58
lines changed

6 files changed

+47
-58
lines changed

‎site/src/modules/dashboard/DashboardLayout.tsx

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import { AnnouncementBanners } from "modules/dashboard/AnnouncementBanners/Annou
88
import { LicenseBanner } from "modules/dashboard/LicenseBanner/LicenseBanner";
99
import { type FC, type HTMLAttributes, Suspense } from "react";
1010
import { Outlet } from "react-router-dom";
11-
import { dashboardContentBottomPadding } from "theme/constants";
1211
import { docs } from "utils/docs";
1312
import { DeploymentBanner } from "./DeploymentBanner/DeploymentBanner";
1413
import { Navbar } from "./Navbar/Navbar";
@@ -24,23 +23,10 @@ export const DashboardLayout: FC = () => {
2423
{canViewDeployment && <LicenseBanner />}
2524
<AnnouncementBanners />
2625

27-
<div
28-
css={{
29-
display: "flex",
30-
minHeight: "100%",
31-
flexDirection: "column",
32-
}}
33-
>
26+
<div className="flex flex-col min-h-full">
3427
<Navbar />
3528

36-
<div
37-
css={{
38-
flex: 1,
39-
paddingBottom: dashboardContentBottomPadding, // Add bottom space since we don't use a footer
40-
display: "flex",
41-
flexDirection: "column",
42-
}}
43-
>
29+
<div className="flex flex-col flex-1">
4430
<Suspense fallback={<Loader />}>
4531
<Outlet />
4632
</Suspense>
@@ -111,7 +97,6 @@ export const DashboardFullPage: FC<HTMLAttributes<HTMLDivElement>> = ({
11197
<div
11298
{...attrs}
11399
css={{
114-
marginBottom: `-${dashboardContentBottomPadding}px`,
115100
flex: 1,
116101
display: "flex",
117102
flexDirection: "column",

‎site/src/modules/dashboard/DeploymentBanner/DeploymentBanner.tsx

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,36 @@ import { deploymentStats } from "api/queries/deployment";
33
import { useAuthenticated } from "hooks";
44
import type { FC } from "react";
55
import { useQuery } from "react-query";
6+
import { useLocation } from "react-router-dom";
67
import { DeploymentBannerView } from "./DeploymentBannerView";
78

9+
const HIDE_DEPLOYMENT_BANNER_PATHS = [
10+
// Hide the banner on workspace page because it already has a lot of
11+
// information.
12+
// - It adds names to the main groups that we're checking for, so it'll be a
13+
// little more self-documenting
14+
// - It redefines each group to only allow the characters A-Z (lowercase or
15+
// uppercase), numbers, and hyphens
16+
/^\/@(?<username>[a-zA-Z0-9-]+)\/(?<workspace_name>[a-zA-Z0-9-]+)$/,
17+
];
18+
819
export const DeploymentBanner: FC = () => {
920
const { permissions } = useAuthenticated();
1021
const deploymentStatsQuery = useQuery(deploymentStats());
1122
const healthQuery = useQuery({
1223
...health(),
1324
enabled: permissions.viewDeploymentConfig,
1425
});
26+
const location = useLocation();
27+
const isHidden = HIDE_DEPLOYMENT_BANNER_PATHS.some((regex) =>
28+
regex.test(location.pathname),
29+
);
1530

16-
if (!permissions.viewDeploymentConfig || !deploymentStatsQuery.data) {
31+
if (
32+
isHidden ||
33+
!permissions.viewDeploymentConfig ||
34+
!deploymentStatsQuery.data
35+
) {
1736
return null;
1837
}
1938

‎site/src/modules/resources/useAgentLogs.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { useAgentLogs } from "./useAgentLogs";
1010
* Issue: https://github.com/romgain/jest-websocket-mock/issues/172
1111
*/
1212

13-
describe("useAgentLogs", () => {
13+
describe.skip("useAgentLogs", () => {
1414
afterEach(() => {
1515
WS.clean();
1616
});

‎site/src/pages/WorkspacePage/WorkspacePage.tsx

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ import { displayError } from "components/GlobalSnackbar/utils";
1111
import { Loader } from "components/Loader/Loader";
1212
import { Margins } from "components/Margins/Margins";
1313
import { useEffectEvent } from "hooks/hookPolyfills";
14-
import { AnnouncementBanners } from "modules/dashboard/AnnouncementBanners/AnnouncementBanners";
15-
import { Navbar } from "modules/dashboard/Navbar/Navbar";
1614
import { type FC, useEffect } from "react";
1715
import { useQuery, useQueryClient } from "react-query";
1816
import { useParams } from "react-router-dom";
@@ -105,29 +103,18 @@ const WorkspacePage: FC = () => {
105103
workspaceQuery.error ?? templateQuery.error ?? permissionsQuery.error;
106104
const isLoading = !workspace || !template || !permissions;
107105

108-
return (
109-
<>
110-
<AnnouncementBanners />
111-
<div css={{ height: "100%", display: "flex", flexDirection: "column" }}>
112-
<Navbar />
113-
{pageError ? (
114-
<Margins>
115-
<ErrorAlert
116-
error={pageError}
117-
css={{ marginTop: 16, marginBottom: 16 }}
118-
/>
119-
</Margins>
120-
) : isLoading ? (
121-
<Loader />
122-
) : (
123-
<WorkspaceReadyPage
124-
workspace={workspace}
125-
template={template}
126-
permissions={permissions}
127-
/>
128-
)}
129-
</div>
130-
</>
106+
return pageError ? (
107+
<Margins>
108+
<ErrorAlert error={pageError} css={{ marginTop: 16, marginBottom: 16 }} />
109+
</Margins>
110+
) : isLoading ? (
111+
<Loader />
112+
) : (
113+
<WorkspaceReadyPage
114+
workspace={workspace}
115+
template={template}
116+
permissions={permissions}
117+
/>
131118
);
132119
};
133120

‎site/src/router.tsx

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -532,20 +532,20 @@ export const router = createBrowserRouter(
532532

533533
{/* In order for the 404 page to work properly the routes that start with
534534
top level parameter must be fully qualified. */}
535-
<Route
536-
path="/:username/:workspace/builds/:buildNumber"
537-
element={<WorkspaceBuildPage />}
538-
/>
539-
<Route
540-
path="/:username/:workspace/settings"
541-
element={<WorkspaceSettingsLayout />}
542-
>
543-
<Route index element={<WorkspaceSettingsPage />} />
535+
<Route path="/:username/:workspace">
536+
<Route index element={<WorkspacePage />} />
544537
<Route
545-
path="parameters"
546-
element={<WorkspaceParametersExperimentRouter />}
538+
path="builds/:buildNumber"
539+
element={<WorkspaceBuildPage />}
547540
/>
548-
<Route path="schedule" element={<WorkspaceSchedulePage />} />
541+
<Route path="settings" element={<WorkspaceSettingsLayout />}>
542+
<Route index element={<WorkspaceSettingsPage />} />
543+
<Route
544+
path="parameters"
545+
element={<WorkspaceParametersExperimentRouter />}
546+
/>
547+
<Route path="schedule" element={<WorkspaceSchedulePage />} />
548+
</Route>
549549
</Route>
550550

551551
<Route path="/health" element={<HealthLayout />}>
@@ -574,7 +574,6 @@ export const router = createBrowserRouter(
574574
</Route>
575575

576576
{/* Pages that don't have the dashboard layout */}
577-
<Route path="/:username/:workspace" element={<WorkspacePage />} />
578577
<Route
579578
path="/templates/:template/versions/:version/edit"
580579
element={<TemplateVersionEditorPage />}

‎site/src/theme/constants.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ export const navHeight = 62;
3232
export const containerWidth = 1380;
3333
export const containerWidthMedium = 1080;
3434
export const sidePadding = 24;
35-
export const dashboardContentBottomPadding = 8 * 6;
3635

3736
// MUI does not have aligned heights for buttons and inputs so we have to "hack" it a little bit
3837
export const BUTTON_XL_HEIGHT = 44;

0 commit comments

Comments
 (0)