Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor(frontend): migrate route shells to React (#20125)

boojackb603a5246274
diff --git a/frontend/src/components/ArchiveBanner.vue b/frontend/src/components/ArchiveBanner.vue
deleted file mode 100644
index ffa911a07e..0000000000
--- a/frontend/src/components/ArchiveBanner.vue
+++ /dev/null
@@ -1,13 +0,0 @@
-<template>
- <div
- class="h-8 w-full text-base font-medium bg-gray-700 text-white flex justify-center items-center"
- >
- {{ $t("common.archived") }}
- </div>
-</template>
-
-<script lang="ts">
-export default {
- name: "ArchiveBanner",
-};
-</script>
diff --git a/frontend/src/components/Project/useRecentProjects.ts b/frontend/src/components/Project/useRecentProjects.ts
index 5a30b6a78d..d622dfe2d0 100644
--- a/frontend/src/components/Project/useRecentProjects.ts
+++ b/frontend/src/components/Project/useRecentProjects.ts
@@ -48,7 +48,7 @@ export const useRecentProjects = () => {
try {
const project = projectV1Store.getProjectByName(projectName);
if (isValidProjectName(project.name)) {
- // Only check if project exists, let ProjectV1Layout handle permission
+ // Only check if project exists, let ProjectRouteShell handle permission
projects.push(project);
} else {
// Project doesn't exist or is invalid
diff --git a/frontend/src/layouts/BodyLayout.vue b/frontend/src/layouts/BodyLayout.vue
index 0e5d17a663..eb3ab6262e 100644
--- a/frontend/src/layouts/BodyLayout.vue
+++ b/frontend/src/layouts/BodyLayout.vue
@@ -13,10 +13,15 @@
<router-view name="leftSidebar" />
</teleport>
- <teleport v-if="contentTarget" :to="contentTarget">
+ <teleport v-if="contentTarget && isProjectRoute" :to="contentTarget">
+ <router-view name="content" />
+ </teleport>
+
+ <teleport v-else-if="contentTarget" :to="contentTarget">
<ReactPageMount
page="RoutePermissionGuardShell"
:page-props="{
+ routeKey: route.fullPath,
className: 'm-4',
targetClassName: 'h-full min-h-0',
onReady: handlePermissionReady,
@@ -25,7 +30,7 @@
</teleport>
<teleport
- v-if="routePermitted && routePermissionTarget"
+ v-if="!isProjectRoute && routePermitted && routePermissionTarget"
:to="routePermissionTarget"
>
<router-view name="content" />
@@ -87,6 +92,9 @@ const routePermitted = useRoutePermitted();
const isRootPath = computed(() => {
return router.currentRoute.value.name === WORKSPACE_ROOT_MODULE;
});
+const isProjectRoute = computed(() => {
+ return Boolean(route.params.projectId);
+});
const contentTarget = computed(() => shellTargets.value.content);
const quickstartTarget = computed(() => shellTargets.value.quickstart);
diff --git a/frontend/src/layouts/InstanceLayout.vue b/frontend/src/layouts/InstanceLayout.vue
deleted file mode 100644
index 0dd339ff44..0000000000
--- a/frontend/src/layouts/InstanceLayout.vue
+++ /dev/null
@@ -1,41 +0,0 @@
-<template>
- <Suspense>
- <template #default>
- <div
- v-if="!isValidInstanceName(instance.name)"
- class="flex items-center gap-x-2 m-4"
- >
- <BBSpin :size="20" />
- Loading instance...
- </div>
- <router-view v-else :instance-id="instanceId" />
- </template>
- <template #fallback>
- <span>Loading instance...</span>
- </template>
- </Suspense>
-</template>
-
-<script lang="ts" setup>
-import { computed, watchEffect } from "vue";
-import { BBSpin } from "@/bbkit";
-import { useInstanceV1Store } from "@/store";
-import { instanceNamePrefix } from "@/store/modules/v1/common";
-import { isValidInstanceName } from "@/types";
-
-const props = defineProps<{
- instanceId: string;
-}>();
-
-const instanceStore = useInstanceV1Store();
-
-watchEffect(async () => {
- await instanceStore.getOrFetchInstanceByName(
- `${instanceNamePrefix}${props.instanceId}`
- );
-});
-
-const instance = computed(() =>
- instanceStore.getInstanceByName(`${instanceNamePrefix}${props.instanceId}`)
-);
-</script>
diff --git a/frontend/src/layouts/IssuesLayout.vue b/frontend/src/layouts/IssuesLayout.vue
deleted file mode 100644
index b00b3781c8..0000000000
--- a/frontend/src/layouts/IssuesLayout.vue
+++ /dev/null
@@ -1,49 +0,0 @@
-<template>
- <ReactPageMount
- page="DashboardBodyShell"
- :page-props="{
- variant: 'issues',
- routeKey: route.fullPath,
- onReady: handleReady,
- }"
- />
-
- <teleport v-if="contentTarget" :to="contentTarget">
- <router-view name="content" />
- </teleport>
-
- <teleport v-if="quickstartTarget" :to="quickstartTarget">
- <Quickstart />
- </teleport>
-</template>
-
-<script lang="ts" setup>
-import { computed, ref, shallowRef } from "vue";
-import { useRoute } from "vue-router";
-import Quickstart from "@/components/Quickstart.vue";
-import type { DashboardShellTargets } from "@/react/dashboard-shell";
-import ReactPageMount from "@/react/ReactPageMount.vue";
-import { provideBodyLayoutContext } from "./common";
-
-const route = useRoute();
-const shellTargets = shallowRef<DashboardShellTargets>({
- desktopSidebar: null,
- mobileSidebar: null,
- content: null,
- quickstart: null,
- mainContainer: null,
-});
-const mainContainerRef = ref<HTMLDivElement>();
-
-const contentTarget = computed(() => shellTargets.value.content);
-const quickstartTarget = computed(() => shellTargets.value.quickstart);
-
-const handleReady = (targets: DashboardShellTargets) => {
- shellTargets.value = targets;
- mainContainerRef.value = targets.mainContainer ?? undefined;
-};
-
-provideBodyLayoutContext({
- mainContainerRef,
-});
-</script>
diff --git a/frontend/src/layouts/ProjectV1Layout.vue b/frontend/src/layouts/ProjectV1Layout.vue
deleted file mode 100644
index 3ab9c2736e..0000000000
--- a/frontend/src/layouts/ProjectV1Layout.vue
+++ /dev/null
@@ -1,170 +0,0 @@
-<template>
- <template v-if="initialized">
- <ArchiveBanner v-if="project.state === State.DELETED" class="py-2 mb-4" />
- <div v-if="isDefaultProject" class="m-4">
- <h1 class="mb-4 text-xl font-bold leading-6 text-main truncate">
- {{ $t("database.unassigned-databases") }}
- </h1>
- <BBAttention class="mb-4" type="info">
- {{ $t("project.overview.info-slot-content") }}
- </BBAttention>
- </div>
-
- <ReactPageMount
- page="RoutePermissionGuardShell"
- :page-props="{
- project,
- className: 'm-4',
- targetClassName: 'h-full min-h-0',
- onReady: handlePermissionReady,
- }"
- />
- <teleport
- v-if="routePermitted && routePermissionTarget"
- :to="routePermissionTarget"
- >
- <router-view
- :project-id="projectId"
- :allow-edit="allowEdit"
- v-bind="$attrs"
- />
- </teleport>
- </template>
- <div
- v-else
- class="fixed inset-0 bg-white flex flex-col items-center justify-center"
- >
- <NSpin />
- </div>
-
- <IAMRemindModal :project-name="project.name" />
-</template>
-
-<script lang="tsx" setup>
-import { type ConnectError } from "@connectrpc/connect";
-import { NSpin } from "naive-ui";
-import { computed, shallowRef, watch, watchEffect } from "vue";
-import { useRoute, useRouter } from "vue-router";
-import { BBAttention } from "@/bbkit";
-import ArchiveBanner from "@/components/ArchiveBanner.vue";
-import IAMRemindModal from "@/components/IAMRemindModal.vue";
-import { useRecentProjects } from "@/components/Project/useRecentProjects";
-import { useRoutePermitted } from "@/composables/useRoutePermitted";
-import ReactPageMount from "@/react/ReactPageMount.vue";
-import { PROJECT_V1_ROUTE_DETAIL } from "@/router/dashboard/projectV1";
-import { WORKSPACE_ROUTE_LANDING } from "@/router/dashboard/workspaceRoutes";
-import { useRecentVisit } from "@/router/useRecentVisit";
-import {
- pushNotification,
- useProjectByName,
- useProjectIamPolicy,
- useProjectV1Store,
-} from "@/store";
-import { projectNamePrefix } from "@/store/modules/v1/common";
-import {
- isDefaultProject as checkIsDefaultProject,
- UNKNOWN_PROJECT_NAME,
-} from "@/types";
-import { State } from "@/types/proto-es/v1/common_pb";
-import { hasProjectPermissionV2, setDocumentTitle } from "@/utils";
-
-const props = defineProps<{
- projectId: string;
-}>();
-
-const router = useRouter();
-const recentProjects = useRecentProjects();
-const projectStore = useProjectV1Store();
-const { remove: removeVisit } = useRecentVisit();
-const routePermissionTarget = shallowRef<HTMLDivElement | null>(null);
-
-const handlePermissionReady = (target: HTMLDivElement | null) => {
- routePermissionTarget.value = target;
-};
-
-const projectName = computed(() => `${projectNamePrefix}${props.projectId}`);
-
-watchEffect(async () => {
- // Capture the current project name before the async gap so we can
- // detect stale responses if projectId changes while the fetch is
- // in flight.
- const currentName = projectName.value;
- try {
- const project = await projectStore.getOrFetchProjectByName(
- currentName,
- false
- );
- // If projectId changed during the fetch, ignore this stale result.
- if (currentName !== projectName.value) return;
- // If the project resolves to the unknown sentinel (e.g. projectId is "-1"),
- // it will never initialize. Redirect to the landing page instead of
- // spinning forever.
- if (project.name === UNKNOWN_PROJECT_NAME) {
- const projectRoute = router.resolve({
- name: PROJECT_V1_ROUTE_DETAIL,
- params: { projectId: props.projectId },
- });
- removeVisit(projectRoute.fullPath);
- router.replace({ name: WORKSPACE_ROUTE_LANDING });
- return;
- }
- recentProjects.setRecentProject(project.name);
- } catch (err) {
- if (currentName !== projectName.value) return;
- console.error(err);
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: `Failed to fetch project ${props.projectId}`,
- description: (err as ConnectError).message,
- });
-
- const projectRoute = router.resolve({
- name: PROJECT_V1_ROUTE_DETAIL,
- params: {
- projectId: props.projectId,
- },
- });
- removeVisit(projectRoute.fullPath);
- router.replace({
- name: WORKSPACE_ROUTE_LANDING,
- });
- }
-});
-
-const { project, ready } = useProjectByName(projectName);
-const { ready: iamReady } = useProjectIamPolicy(projectName);
-const routePermitted = useRoutePermitted(project);
-
-const initialized = computed(
- () =>
- ready.value && iamReady.value && project.value.name !== UNKNOWN_PROJECT_NAME
-);
-
-const isDefaultProject = computed((): boolean => {
- return checkIsDefaultProject(project.value.name);
-});
-
-const allowEdit = computed(() => {
- if (project.value.state === State.DELETED) {
- return false;
- }
-
- return hasProjectPermissionV2(project.value, "bb.projects.update");
-});
-
-const route = useRoute();
-watch(
- [() => route.meta.title, () => project.value.title, initialized],
- () => {
- if (!initialized.value) return;
- const pageTitle = route.meta.title ? route.meta.title(route) : undefined;
- if (pageTitle) {
- setDocumentTitle(pageTitle, project.value.title);
- } else {
- setDocumentTitle(project.value.title);
- }
- },
- { immediate: true }
-);
-</script>
diff --git a/frontend/src/layouts/SettingLayout.vue b/frontend/src/layouts/SettingLayout.vue
deleted file mode 100644
index a9cdc71171..0000000000
--- a/frontend/src/layouts/SettingLayout.vue
+++ /dev/null
@@ -1,30 +0,0 @@
-<template>
- <div class="min-h-full">
- <router-view :allow-edit="allowEdit" v-bind="$attrs" />
- </div>
-</template>
-
-<script lang="ts" setup>
-import { computed, watch } from "vue";
-import { useI18n } from "vue-i18n";
-import { useRoute } from "vue-router";
-import { hasWorkspacePermissionV2, setDocumentTitle } from "@/utils";
-
-const { t } = useI18n();
-const route = useRoute();
-
-const allowEdit = computed((): boolean => {
- return hasWorkspacePermissionV2("bb.settings.set");
-});
-
-watch(
- () => route.meta.title,
- () => {
- const pageTitle = route.meta.title ? route.meta.title(route) : undefined;
- if (pageTitle) {
- setDocumentTitle(pageTitle, t("common.settings"));
- }
- },
- { immediate: true }
-);
-</script>
diff --git a/frontend/src/layouts/layout-bridge.test.ts b/frontend/src/layouts/layout-bridge.test.ts
index 8f888f37ca..633d532f7b 100644
--- a/frontend/src/layouts/layout-bridge.test.ts
+++ b/frontend/src/layouts/layout-bridge.test.ts
@@ -178,8 +178,8 @@ vi.mock("@/types/proto-es/v1/subscription_service_pb", () => ({
},
}));
+import ReactRouteShellBridge from "@/react/ReactRouteShellBridge.vue";
import BodyLayout from "./BodyLayout.vue";
-import IssuesLayout from "./IssuesLayout.vue";
const SidebarView = defineComponent({
name: "SidebarView",
@@ -204,13 +204,14 @@ const ContentView = defineComponent({
});
async function mountRouteTree(
- routes: Parameters<typeof createRouter>[0]["routes"]
+ routes: Parameters<typeof createRouter>[0]["routes"],
+ target = "/target"
) {
const router = createRouter({
history: createMemoryHistory(),
routes,
});
- await router.push("/target");
+ await router.push(target);
await router.isReady();
const wrapper = mount(RouterView, {
@@ -272,11 +273,50 @@ describe("layout bridges", () => {
wrapper.unmount();
});
- test("IssuesLayout reuses the shell without teleporting sidebar content", async () => {
+ test("BodyLayout lets project routes reach their project permission shell", async () => {
+ const wrapper = await mountRouteTree(
+ [
+ {
+ path: "/",
+ component: BodyLayout,
+ children: [
+ {
+ path: "target/:projectId",
+ name: "workspace.projects.detail",
+ components: {
+ leftSidebar: SidebarView,
+ content: ContentView,
+ },
+ },
+ ],
+ },
+ ],
+ "/target/prod"
+ );
+
+ expect(
+ document.querySelector(
+ '[data-testid="shell-content"] > [data-testid="content-view"]'
+ )?.textContent
+ ).toContain("connected");
+ expect(
+ document.querySelector(
+ '[data-testid="shell-content"] [data-testid="permission-guard"]'
+ )
+ ).toBeNull();
+
+ wrapper.unmount();
+ });
+
+ test("ReactRouteShellBridge teleports named route content into React shell", async () => {
const wrapper = await mountRouteTree([
{
path: "/",
- component: IssuesLayout,
+ component: ReactRouteShellBridge,
+ props: {
+ page: "IssuesRouteShell",
+ routerViewName: "content",
+ },
children: [
{
path: "target",
diff --git a/frontend/src/react/ReactRouteShellBridge.vue b/frontend/src/react/ReactRouteShellBridge.vue
new file mode 100644
index 0000000000..8c85258000
--- /dev/null
+++ b/frontend/src/react/ReactRouteShellBridge.vue
@@ -0,0 +1,49 @@
+<template>
+ <ReactPageMount
+ :page="page"
+ :page-props="{
+ ...pageProps,
+ routeKey: route.fullPath,
+ onReady: handleReady,
+ }"
+ />
+
+ <teleport v-if="targets.content" :to="targets.content">
+ <router-view
+ v-if="routerViewName"
+ :name="routerViewName"
+ v-bind="targets.routeProps ?? {}"
+ />
+ <router-view v-else v-bind="targets.routeProps ?? {}" />
+ </teleport>
+</template>
+
+<script lang="ts" setup>
+import { computed, shallowRef } from "vue";
+import { useRoute } from "vue-router";
+import { provideBodyLayoutContext } from "@/layouts/common";
+import type { ReactRouteShellTargets } from "@/react/dashboard-shell";
+import ReactPageMount from "@/react/ReactPageMount.vue";
+
+defineProps<{
+ page: string;
+ pageProps?: Record<string, unknown>;
+ routerViewName?: string;
+}>();
+
+const route = useRoute();
+const targets = shallowRef<ReactRouteShellTargets>({
+ content: null,
+});
+const mainContainerRef = computed(
+ () => targets.value.mainContainer ?? undefined
+);
+
+const handleReady = (nextTargets: ReactRouteShellTargets | null) => {
+ targets.value = nextTargets ?? { content: null };
+};
+
+provideBodyLayoutContext({
+ mainContainerRef,
+});
+</script>
diff --git a/frontend/src/react/components/IAMRemindDialog.tsx b/frontend/src/react/components/IAMRemindDialog.tsx
new file mode 100644
index 0000000000..cb4a31f13e
--- /dev/null
+++ b/frontend/src/react/components/IAMRemindDialog.tsx
@@ -0,0 +1,145 @@
+import { useEffect, useMemo, useState } from "react";
+import { useTranslation } from "react-i18next";
+import { Button } from "@/react/components/ui/button";
+import {
+ Dialog,
+ DialogContent,
+ DialogTitle,
+} from "@/react/components/ui/dialog";
+import {
+ PROJECT_V1_ROUTE_DATABASES,
+ useCurrentRoute,
+ useNavigate,
+} from "@/react/router";
+import { useAppStore } from "@/react/stores/app";
+import {
+ bindingMatchesUser,
+ getBindingExpirationDate,
+ readJson,
+ writeJson,
+} from "@/react/stores/app/utils";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import { displayRoleTitle, formatAbsoluteDateTime } from "@/utils";
+import { storageKeyIamRemind } from "@/utils/storage-keys";
+
+interface IAMRemindDialogProps {
+ project: Project;
+}
+
+export function IAMRemindDialog({ project }: IAMRemindDialogProps) {
+ const { t } = useTranslation();
+ const route = useCurrentRoute();
+ const navigate = useNavigate();
+ const currentUser = useAppStore((state) => state.currentUser);
+ const roles = useAppStore((state) => state.roles);
+ const policy = useAppStore(
+ (state) => state.projectPoliciesByName[project.name]
+ );
+ const [checked, setChecked] = useState(false);
+ const [open, setOpen] = useState(false);
+
+ const pendingExpireRoles = useMemo(() => {
+ if (!policy || !currentUser) return [];
+ const roleByName = new Map(roles.map((role) => [role.name, role]));
+ const now = Date.now();
+ const expiresBefore = now + 2 * 24 * 60 * 60 * 1000;
+ return bindingMatchesUser(policy, currentUser)
+ .map((binding) => {
+ const role = roleByName.get(binding.role);
+ const expiration = getBindingExpirationDate(binding);
+ return role && expiration ? { role, expiration } : undefined;
+ })
+ .filter((item): item is NonNullable<typeof item> => Boolean(item))
+ .filter(({ expiration }) => {
+ const time = expiration.getTime();
+ return time > now && time < expiresBefore;
+ })
+ .sort((a, b) => a.expiration.getTime() - b.expiration.getTime());
+ }, [currentUser, policy, roles]);
+
+ const storageKey = currentUser?.email
+ ? storageKeyIamRemind(currentUser.email)
+ : "";
+ const remindKey =
+ pendingExpireRoles.length > 0
+ ? `${project.name}.${pendingExpireRoles
+ .map(({ role }) => role.name)
+ .join("&")}`
+ : "";
+ const isInProjectPage = route.fullPath.startsWith(`/${project.name}`);
+
+ useEffect(() => {
+ if (!storageKey || !remindKey) {
+ setOpen(false);
+ return;
+ }
+ const state = readJson<Record<string, boolean>>(storageKey, {});
+ if (!(remindKey in state)) {
+ writeJson(storageKey, { ...state, [remindKey]: true });
+ setOpen(true);
+ return;
+ }
+ setOpen(state[remindKey] ?? false);
+ }, [remindKey, storageKey]);
+
+ const close = () => {
+ if (checked && storageKey && remindKey) {
+ const state = readJson<Record<string, boolean>>(storageKey, {});
+ writeJson(storageKey, { ...state, [remindKey]: false });
+ }
+ setOpen(false);
+ };
+
+ if (pendingExpireRoles.length === 0) {
+ return null;
+ }
+
+ return (
+ <Dialog open={open} onOpenChange={setOpen}>
+ <DialogContent className="p-6 w-[calc(100vw-10rem)] max-w-[30rem]">
+ <DialogTitle>{t("remind.role-expire.title")}</DialogTitle>
+ <div className="mt-4 flex flex-col gap-2 text-sm">
+ <p>{t("remind.role-expire.content")}</p>
+ <ul className="list-disc text-control-light ml-4">
+ {pendingExpireRoles.map(({ role, expiration }) => (
+ <li key={role.name}>
+ {displayRoleTitle(role.name)}:{" "}
+ <span className="text-error">
+ {formatAbsoluteDateTime(expiration.getTime())}
+ </span>
+ </li>
+ ))}
+ </ul>
+ </div>
+ <label className="mt-6 flex items-center gap-x-2 text-sm text-control-light">
+ <input
+ type="checkbox"
+ className="size-4 rounded-xs border-control-border"
+ checked={checked}
+ onChange={(event) => setChecked(event.target.checked)}
+ />
+ {t("remind.role-expire.checkbox")}
+ </label>
+
+ <div className="mt-7 flex justify-end gap-x-2">
+ <Button variant="outline" onClick={close}>
+ {t("common.dismiss")}
+ </Button>
+ {!isInProjectPage && (
+ <Button
+ onClick={() => {
+ setOpen(false);
+ void navigate.push({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: { projectId: project.name.slice("projects/".length) },
+ });
+ }}
+ >
+ {t("remind.role-expire.go-to-project")}
+ </Button>
+ )}
+ </div>
+ </DialogContent>
+ </Dialog>
+ );
+}
diff --git a/frontend/src/react/components/InstanceRouteShell.tsx b/frontend/src/react/components/InstanceRouteShell.tsx
new file mode 100644
index 0000000000..b983235ff0
--- /dev/null
+++ b/frontend/src/react/components/InstanceRouteShell.tsx
@@ -0,0 +1,60 @@
+import { LoaderCircle } from "lucide-react";
+import { useEffect, useMemo, useRef, useState } from "react";
+import { useTranslation } from "react-i18next";
+import type { ReactRouteShellTargets } from "@/react/dashboard-shell";
+import { instanceNamePrefix } from "@/react/lib/resourceName";
+import { useAppStore } from "@/react/stores/app";
+import { isValidInstanceName } from "@/types/v1/instance";
+
+interface InstanceRouteShellProps {
+ instanceId: string;
+ onReady?: (targets: ReactRouteShellTargets | null) => void;
+}
+
+export function InstanceRouteShell({
+ instanceId,
+ onReady,
+}: InstanceRouteShellProps) {
+ const { t } = useTranslation();
+ const contentRef = useRef<HTMLDivElement>(null);
+ const instanceName = `${instanceNamePrefix}${instanceId}`;
+ const instance = useAppStore((state) => state.instancesByName[instanceName]);
+ const fetchInstance = useAppStore((state) => state.fetchInstance);
+ const [ready, setReady] = useState(false);
+ const routeProps = useMemo(() => ({ instanceId }), [instanceId]);
+
+ useEffect(() => {
+ let stale = false;
+ setReady(false);
+ onReady?.(null);
+ void fetchInstance(instanceName).then(() => {
+ if (!stale) {
+ setReady(true);
+ }
+ });
+ return () => {
+ stale = true;
+ onReady?.(null);
+ };
+ }, [fetchInstance, instanceName, onReady]);
+
+ useEffect(() => {
+ if (!ready || !isValidInstanceName(instance?.name)) return;
+ onReady?.({
+ content: contentRef.current,
+ routeProps,
+ });
+ return () => onReady?.(null);
+ }, [instance?.name, onReady, ready, routeProps]);
+
+ if (!ready || !isValidInstanceName(instance?.name)) {
+ return (
+ <div className="flex items-center gap-x-2 m-4 text-sm text-control-light">
+ <LoaderCircle className="size-5 animate-spin" />
+ {t("common.loading")} {t("common.instance").toLowerCase()}...
+ </div>
+ );
+ }
+
+ return <div ref={contentRef} className="h-full min-h-0" />;
+}
diff --git a/frontend/src/react/components/IssuesRouteShell.tsx b/frontend/src/react/components/IssuesRouteShell.tsx
new file mode 100644
index 0000000000..c12762e9db
--- /dev/null
+++ b/frontend/src/react/components/IssuesRouteShell.tsx
@@ -0,0 +1,32 @@
+import { useCallback } from "react";
+import { DashboardBodyShell } from "@/react/components/DashboardBodyShell";
+import type {
+ DashboardShellTargets,
+ ReactRouteShellTargets,
+} from "@/react/dashboard-shell";
+
+interface IssuesRouteShellProps {
+ routeKey?: string;
+ onReady?: (targets: ReactRouteShellTargets | null) => void;
+}
+
+export function IssuesRouteShell({ routeKey, onReady }: IssuesRouteShellProps) {
+ const handleReady = useCallback(
+ (targets: DashboardShellTargets) => {
+ onReady?.({
+ content: targets.content,
+ quickstart: targets.quickstart,
+ mainContainer: targets.mainContainer,
+ });
+ },
+ [onReady]
+ );
+
+ return (
+ <DashboardBodyShell
+ variant="issues"
+ routeKey={routeKey}
+ onReady={handleReady}
+ />
+ );
+}
diff --git a/frontend/src/react/components/ProjectRouteShell.tsx b/frontend/src/react/components/ProjectRouteShell.tsx
new file mode 100644
index 0000000000..8c5911bac2
--- /dev/null
+++ b/frontend/src/react/components/ProjectRouteShell.tsx
@@ -0,0 +1,170 @@
+import { LoaderCircle } from "lucide-react";
+import { useEffect, useMemo, useRef, useState } from "react";
+import { useTranslation } from "react-i18next";
+import { IAMRemindDialog } from "@/react/components/IAMRemindDialog";
+import { RoutePermissionGuardShell } from "@/react/components/RoutePermissionGuardShell";
+import { Alert, AlertDescription } from "@/react/components/ui/alert";
+import type { ReactRouteShellTargets } from "@/react/dashboard-shell";
+import { useNotify } from "@/react/hooks/useAppState";
+import {
+ PROJECT_V1_ROUTE_DETAIL,
+ useCurrentRoute,
+ useNavigate,
+ WORKSPACE_ROUTE_LANDING,
+} from "@/react/router";
+import { projectResourceNameFromId, useAppStore } from "@/react/stores/app";
+import { State } from "@/types/proto-es/v1/common_pb";
+import { setDocumentTitle } from "@/utils";
+
+interface ProjectRouteShellProps {
+ projectId: string;
+ routeKey?: string;
+ onReady?: (targets: ReactRouteShellTargets | null) => void;
+}
+
+export function ProjectRouteShell({
+ projectId,
+ routeKey,
+ onReady,
+}: ProjectRouteShellProps) {
+ const { t } = useTranslation();
+ const route = useCurrentRoute();
+ const navigate = useNavigate();
+ const navigateRef = useRef(navigate);
+ navigateRef.current = navigate;
+ const notify = useNotify();
+ const projectName = projectResourceNameFromId(projectId);
+ const project = useAppStore((state) => state.projectsByName[projectName]);
+ const defaultProjectName = useAppStore(
+ (state) => state.serverInfo?.defaultProject ?? ""
+ );
+ const allowEdit = useAppStore((state) =>
+ project
+ ? project.state !== State.DELETED &&
+ state.hasProjectPermission(project, "bb.projects.update")
+ : false
+ );
+ const fetchProject = useAppStore((state) => state.fetchProject);
+ const loadServerInfo = useAppStore((state) => state.loadServerInfo);
+ const loadCurrentUser = useAppStore((state) => state.loadCurrentUser);
+ const loadProjectIamPolicy = useAppStore(
+ (state) => state.loadProjectIamPolicy
+ );
+ const setRecentProject = useAppStore((state) => state.setRecentProject);
+ const removeRecentVisit = useAppStore((state) => state.removeRecentVisit);
+ const [ready, setReady] = useState(false);
+
+ useEffect(() => {
+ let stale = false;
+ setReady(false);
+ onReady?.(null);
+
+ const load = async () => {
+ await Promise.all([loadCurrentUser(), loadServerInfo()]);
+ const nextProject = await fetchProject(projectName);
+ if (stale) return;
+ if (!nextProject) {
+ const projectRoute = navigateRef.current.resolve({
+ name: PROJECT_V1_ROUTE_DETAIL,
+ params: { projectId },
+ });
+ removeRecentVisit(projectRoute.fullPath);
+ const error = useAppStore.getState().projectErrorsByName[projectName];
+ if (error) {
+ notify({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: `Failed to fetch project ${projectId}`,
+ description: error.message,
+ });
+ }
+ void navigateRef.current.replace({ name: WORKSPACE_ROUTE_LANDING });
+ return;
+ }
+ setRecentProject(nextProject.name);
+ await loadProjectIamPolicy(nextProject.name);
+ if (!stale) {
+ setReady(true);
+ }
+ };
+
+ void load();
+ return () => {
+ stale = true;
+ onReady?.(null);
+ };
+ }, [
+ fetchProject,
+ loadCurrentUser,
+ loadProjectIamPolicy,
+ loadServerInfo,
+ notify,
+ onReady,
+ projectId,
+ projectName,
+ removeRecentVisit,
+ setRecentProject,
+ ]);
+
+ useEffect(() => {
+ if (!ready || !project) return;
+ if (route.title) {
+ setDocumentTitle(route.title, project.title);
+ } else {
+ setDocumentTitle(project.title);
+ }
+ }, [project, ready, route.title]);
+
+ const routeProps = useMemo(
+ () => ({
+ projectId,
+ allowEdit,
+ }),
+ [allowEdit, projectId]
+ );
+
+ if (!ready || !project) {
+ return (
+ <div className="fixed inset-0 bg-white flex flex-col items-center justify-center">
+ <LoaderCircle className="size-5 animate-spin text-control-light" />
+ </div>
+ );
+ }
+
+ const isDefaultProject = project.name === defaultProjectName;
+
+ return (
+ <>
+ {project.state === State.DELETED && (
+ <div className="h-8 w-full text-base font-medium bg-control text-white flex justify-center items-center py-2 mb-4">
+ {t("common.archived")}
+ </div>
+ )}
+ {isDefaultProject && (
+ <div className="m-4">
+ <h1 className="mb-4 text-xl font-bold leading-6 text-main truncate">
+ {t("database.unassigned-databases")}
+ </h1>
+ <Alert variant="info" className="mb-4">
+ <AlertDescription>
+ {t("project.overview.info-slot-content")}
+ </AlertDescription>
+ </Alert>
+ </div>
+ )}
+ <RoutePermissionGuardShell
+ project={project}
+ routeKey={routeKey}
+ className="m-4"
+ targetClassName="h-full min-h-0"
+ onReady={(target) =>
+ onReady?.({
+ content: target,
+ routeProps,
+ })
+ }
+ />
+ <IAMRemindDialog project={project} />
+ </>
+ );
+}
diff --git a/frontend/src/react/components/ProjectSidebar.tsx b/frontend/src/react/components/ProjectSidebar.tsx
index 0ee0deb6e5..b6629291c0 100644
--- a/frontend/src/react/components/ProjectSidebar.tsx
+++ b/frontend/src/react/components/ProjectSidebar.tsx
@@ -271,7 +271,7 @@ export function ProjectSidebar() {
}, []);
// Ensure the project is fetched into the store cache.
- // ProjectV1Layout also fetches it, but this guards against race conditions.
+ // ProjectRouteShell also fetches it, but this guards against race conditions.
useEffect(() => {
if (projectId) {
projectStore.getOrFetchProjectByName(
diff --git a/frontend/src/react/components/RoutePermissionGuardShell.test.tsx b/frontend/src/react/components/RoutePermissionGuardShell.test.tsx
index 7ce7b162ee..0e0c782470 100644
--- a/frontend/src/react/components/RoutePermissionGuardShell.test.tsx
+++ b/frontend/src/react/components/RoutePermissionGuardShell.test.tsx
@@ -166,7 +166,7 @@ describe("RoutePermissionGuardShell", () => {
expect(container.textContent).not.toContain("bb.settings.set");
});
- test("does not re-emit on route changes when permission state is unchanged", async () => {
+ test("re-emits the content target on route changes", async () => {
mocks.route.requiredPermissions = ["bb.settings.get"];
mocks.workspacePermissions.add("bb.settings.get");
@@ -182,7 +182,8 @@ describe("RoutePermissionGuardShell", () => {
root.render(<RoutePermissionGuardShell onReady={onReady} />);
});
- expect(onReady).toHaveBeenCalledTimes(initialCalls);
+ expect(onReady).toHaveBeenCalledTimes(initialCalls + 1);
+ expect(onReady).toHaveBeenLastCalledWith(expect.any(HTMLDivElement));
});
test("uses project permissions when a project is provided", async () => {
diff --git a/frontend/src/react/components/RoutePermissionGuardShell.tsx b/frontend/src/react/components/RoutePermissionGuardShell.tsx
index 83a65850c2..54aeef0492 100644
--- a/frontend/src/react/components/RoutePermissionGuardShell.tsx
+++ b/frontend/src/react/components/RoutePermissionGuardShell.tsx
@@ -10,6 +10,7 @@ export interface RoutePermissionGuardShellProps {
project?: Project;
className?: string;
targetClassName?: string;
+ routeKey?: string;
onReady?: (target: HTMLDivElement | null) => void;
}
@@ -17,6 +18,7 @@ export function RoutePermissionGuardShell({
project,
className,
targetClassName,
+ routeKey,
onReady,
}: RoutePermissionGuardShellProps) {
const route = useCurrentRoute();
@@ -30,7 +32,7 @@ export function RoutePermissionGuardShell({
useEffect(() => {
onReady?.(permitted ? targetRef.current : null);
- }, [onReady, permitted]);
+ }, [onReady, permitted, project?.name, route.fullPath, routeKey]);
useEffect(() => {
return () => onReady?.(null);
diff --git a/frontend/src/react/components/SettingRouteShell.tsx b/frontend/src/react/components/SettingRouteShell.tsx
new file mode 100644
index 0000000000..653db44345
--- /dev/null
+++ b/frontend/src/react/components/SettingRouteShell.tsx
@@ -0,0 +1,34 @@
+import { useEffect, useMemo, useRef } from "react";
+import { useTranslation } from "react-i18next";
+import type { ReactRouteShellTargets } from "@/react/dashboard-shell";
+import { useWorkspacePermission } from "@/react/hooks/useAppState";
+import { useCurrentRoute } from "@/react/router";
+import { setDocumentTitle } from "@/utils";
+
+interface SettingRouteShellProps {
+ onReady?: (targets: ReactRouteShellTargets | null) => void;
+}
+
+export function SettingRouteShell({ onReady }: SettingRouteShellProps) {
+ const { t } = useTranslation();
+ const route = useCurrentRoute();
+ const contentRef = useRef<HTMLDivElement>(null);
+ const allowEdit = useWorkspacePermission("bb.settings.set");
+ const routeProps = useMemo(() => ({ allowEdit }), [allowEdit]);
+
+ useEffect(() => {
+ if (route.title) {
+ setDocumentTitle(route.title, t("common.settings"));
+ }
+ }, [route.title, t]);
+
+ useEffect(() => {
+ onReady?.({
+ content: contentRef.current,
+ routeProps,
+ });
+ return () => onReady?.(null);
+ }, [onReady, route.fullPath, routeProps]);
+
+ return <div ref={contentRef} className="min-h-full" />;
+}
diff --git a/frontend/src/react/dashboard-shell.ts b/frontend/src/react/dashboard-shell.ts
index cb38faeaa6..e1c9827f58 100644
--- a/frontend/src/react/dashboard-shell.ts
+++ b/frontend/src/react/dashboard-shell.ts
@@ -11,6 +11,13 @@ export type DashboardShellTargets = {
mainContainer: HTMLDivElement | null;
};
+export type ReactRouteShellTargets = {
+ content: HTMLDivElement | null;
+ quickstart?: HTMLDivElement | null;
+ mainContainer?: HTMLDivElement | null;
+ routeProps?: Record<string, unknown>;
+};
+
export type DashboardBodyShellVariant = "workspace" | "issues";
export type DashboardFrameShellProps = {
diff --git a/frontend/src/react/hooks/useAppState.ts b/frontend/src/react/hooks/useAppState.ts
index 49df41a2d5..5e208f69ec 100644
--- a/frontend/src/react/hooks/useAppState.ts
+++ b/frontend/src/react/hooks/useAppState.ts
@@ -77,6 +77,15 @@ export function useWorkspacePermission(permission: Permission) {
return allowed;
}
+export function useProjectPermission(
+ project: Project | undefined,
+ permission: Permission
+) {
+ return useAppStore((state) =>
+ project ? state.hasProjectPermission(project, permission) : false
+ );
+}
+
export function useProject(name: string | undefined) {
const project = useAppStore((state) =>
name ? state.projectsByName[name] : undefined
@@ -90,6 +99,19 @@ export function useProject(name: string | undefined) {
return project;
}
+export function useInstance(name: string | undefined) {
+ const instance = useAppStore((state) =>
+ name ? state.instancesByName[name] : undefined
+ );
+ const fetchInstance = useAppStore((state) => state.fetchInstance);
+ useEffect(() => {
+ if (name) {
+ void fetchInstance(name);
+ }
+ }, [fetchInstance, name]);
+ return instance;
+}
+
export function useProjectList(query: string) {
const searchProjects = useAppStore((state) => state.searchProjects);
const [projects, setProjects] = useState<Project[]>([]);
@@ -210,8 +232,10 @@ export function useRecentProjects() {
export function useRecentVisit() {
useCurrentUser();
const recordRecentVisit = useAppStore((state) => state.recordRecentVisit);
+ const removeRecentVisit = useAppStore((state) => state.removeRecentVisit);
return {
record: recordRecentVisit,
+ remove: removeRecentVisit,
};
}
diff --git a/frontend/src/react/lib/resourceName.ts b/frontend/src/react/lib/resourceName.ts
index 5be07d4d36..e6341a3699 100644
--- a/frontend/src/react/lib/resourceName.ts
+++ b/frontend/src/react/lib/resourceName.ts
@@ -1,6 +1,7 @@
export const workspaceNamePrefix = "workspaces/";
export const userNamePrefix = "users/";
export const projectNamePrefix = "projects/";
+export const instanceNamePrefix = "instances/";
export const settingNamePrefix = "settings/";
export function getResourceId(name: string, prefix: string): string {
diff --git a/frontend/src/react/locales/en-US.json b/frontend/src/react/locales/en-US.json
index 1973f8bcaa..8a87573055 100644
--- a/frontend/src/react/locales/en-US.json
+++ b/frontend/src/react/locales/en-US.json
@@ -812,6 +812,7 @@
"unassign": "Unassign",
"unassign-alert-description": "The selected databases will be removed from the project",
"unassign-alert-title": "Unassign databases",
+ "unassigned-databases": "Unassigned databases",
"unique": "Unique",
"visible": "Visible"
},
@@ -1703,6 +1704,9 @@
},
"revoke-role-from-member": "Revoke '{{role}}' from '{{member}}'?"
},
+ "overview": {
+ "info-slot-content": "Bytebase periodically syncs the instance schema. Newly synced databases are first placed here. User should transfer them to the proper application project."
+ },
"select": "Select project",
"settings": {
"confirm-archive-project": "Archiving \"{{name}}\" will make it read-only and hide it from active project lists. All issues, databases, and settings will be preserved. You can restore it later from the archived projects list.",
@@ -1845,6 +1849,12 @@
"remind": {
"release": {
"new-version-available-with-tag": "New version {{tag}} is available"
+ },
+ "role-expire": {
+ "checkbox": "Do not remind until any updates",
+ "content": "Your following roles are going to expire",
+ "go-to-project": "Go to the project page",
+ "title": "Role expiration remind"
}
},
"resource": {
diff --git a/frontend/src/react/locales/es-ES.json b/frontend/src/react/locales/es-ES.json
index ec219bd999..f56edfe8ef 100644
--- a/frontend/src/react/locales/es-ES.json
+++ b/frontend/src/react/locales/es-ES.json
@@ -805,6 +805,7 @@
"unassign": "Desasignar",
"unassign-alert-description": "Las bases de datos seleccionadas serán eliminadas del proyecto",
"unassign-alert-title": "Desasignar bases de datos",
+ "unassigned-databases": "Bases de datos no asignadas",
"unique": "Único",
"visible": "Visible"
},
@@ -1695,6 +1696,9 @@
},
"revoke-role-from-member": "¿Revocar '{{role}}' de '{{member}}'?"
},
+ "overview": {
+ "info-slot-content": "Bytebase sincroniza periódicamente el esquema de la instancia. Las bases de datos recién sincronizadas se colocan aquí primero. El usuario debe transferirlas al proyecto de aplicación adecuado."
+ },
"settings": {
"confirm-archive-project": "Archiving \"{{name}}\" will make it read-only and hide it from active project lists. All issues, databases, and settings will be preserved. You can restore it later from the archived projects list.",
"confirm-delete-project": "Deleting \"{{name}}\" will permanently remove the project and all associated data including issues, configurations, and history. All databases in this project will be moved to the default project. This action cannot be undone.",
@@ -1832,6 +1836,12 @@
"remind": {
"release": {
"new-version-available-with-tag": "La nueva versión {{tag}} está disponible"
+ },
+ "role-expire": {
+ "checkbox": "No recordar hasta que haya actualizaciones",
+ "content": "Tus siguientes roles expirarán",
+ "go-to-project": "Ir a la página del proyecto",
+ "title": "Recordatorio de expiración del rol"
}
},
"resource": {
diff --git a/frontend/src/react/locales/ja-JP.json b/frontend/src/react/locales/ja-JP.json
index 75c92cc96a..5c40dfc820 100644
--- a/frontend/src/react/locales/ja-JP.json
+++ b/frontend/src/react/locales/ja-JP.json
@@ -805,6 +805,7 @@
"unassign": "割り当てを解除する",
"unassign-alert-description": "選択したデータベースがプロジェクトから削除されます",
"unassign-alert-title": "データベースの割り当てを解除する",
+ "unassigned-databases": "未割り当てのデータベース",
"unique": "唯一",
"visible": "見える"
},
@@ -1695,6 +1696,9 @@
},
"revoke-role-from-member": "'{{member}}' から '{{role}}' を取り消しますか?"
},
+ "overview": {
+ "info-slot-content": "Bytebase はインスタンスのスキーマを定期的に同期します。新しく同期されたデータベースは最初にここに配置され、その後、それらを適切なプロジェクトに転送できます。"
+ },
"settings": {
"confirm-archive-project": "Archiving \"{{name}}\" will make it read-only and hide it from active project lists. All issues, databases, and settings will be preserved. You can restore it later from the archived projects list.",
"confirm-delete-project": "Deleting \"{{name}}\" will permanently remove the project and all associated data including issues, configurations, and history. All databases in this project will be moved to the default project. This action cannot be undone.",
@@ -1832,6 +1836,12 @@
"remind": {
"release": {
"new-version-available-with-tag": "新しいバージョン {{tag}} が利用可能です"
+ },
+ "role-expire": {
+ "checkbox": "更新があるまで通知しない",
+ "content": "次のロールは期限切れになります",
+ "go-to-project": "プロジェクトページへ",
+ "title": "ロールの有効期限通知"
}
},
"resource": {
diff --git a/frontend/src/react/locales/vi-VN.json b/frontend/src/react/locales/vi-VN.json
index 36c6267b1f..8aa2d17beb 100644
--- a/frontend/src/react/locales/vi-VN.json
+++ b/frontend/src/react/locales/vi-VN.json
@@ -805,6 +805,7 @@
"unassign": "Hủy gán",
"unassign-alert-description": "Các cơ sở dữ liệu đã chọn sẽ bị xóa khỏi dự án",
"unassign-alert-title": "Hủy gán cơ sở dữ liệu",
+ "unassigned-databases": "Cơ sở dữ liệu chưa được gán",
"unique": "Duy nhất",
"visible": "Hiển thị"
},
@@ -1695,6 +1696,9 @@
},
"revoke-role-from-member": "Thu hồi '{{role}}' từ '{{member}}'?"
},
+ "overview": {
+ "info-slot-content": "Bytebase định kỳ đồng bộ hóa lược đồ phiên bản. Các cơ sở dữ liệu mới được đồng bộ hóa trước tiên được đặt ở đây. Người dùng nên chuyển chúng đến dự án ứng dụng thích hợp."
+ },
"settings": {
"confirm-archive-project": "Archiving \"{{name}}\" will make it read-only and hide it from active project lists. All issues, databases, and settings will be preserved. You can restore it later from the archived projects list.",
"confirm-delete-project": "Deleting \"{{name}}\" will permanently remove the project and all associated data including issues, configurations, and history. All databases in this project will be moved to the default project. This action cannot be undone.",
@@ -1832,6 +1836,12 @@
"remind": {
"release": {
"new-version-available-with-tag": "Phiên bản mới {{tag}} có sẵn"
+ },
+ "role-expire": {
+ "checkbox": "Không nhắc nhở cho đến khi có bất kỳ cập nhật nào",
+ "content": "Các vai trò sau của bạn sắp hết hạn",
+ "go-to-project": "Đi đến trang dự án",
+ "title": "Nhắc nhở hết hạn vai trò"
}
},
"resource": {
diff --git a/frontend/src/react/locales/zh-CN.json b/frontend/src/react/locales/zh-CN.json
index 4df48a77e3..b9ea853a03 100644
--- a/frontend/src/react/locales/zh-CN.json
+++ b/frontend/src/react/locales/zh-CN.json
@@ -805,6 +805,7 @@
"unassign": "取消分配",
"unassign-alert-description": "选定的数据库将从项目中移除",
"unassign-alert-title": "取消分配数据库",
+ "unassigned-databases": "未分配的数据库",
"unique": "唯一",
"visible": "Visible"
},
@@ -1695,6 +1696,9 @@
},
"revoke-role-from-member": "从 '{{member}}' 撤销 '{{role}}' 角色?"
},
+ "overview": {
+ "info-slot-content": "Bytebase 会定时同步实例的 schema,新同步的数据库会首先被置于这里,之后您可以再将他们转移到适当的项目中。"
+ },
"settings": {
"confirm-archive-project": "归档「{{name}}」将使其变为只读并从活跃项目列表中隐藏。所有工单、数据库和设置将被保留。您可以稍后从已归档项目列表中恢复。",
"confirm-delete-project": "删除「{{name}}」将永久移除该项目及所有关联数据,包括工单、配置和历史记录。该项目中的所有数据库将被移至默认项目。此操作无法撤销。",
@@ -1832,6 +1836,12 @@
"remind": {
"release": {
"new-version-available-with-tag": "新版本 {{tag}} 已推出"
+ },
+ "role-expire": {
+ "checkbox": "直到有更新再提醒",
+ "content": "您的角色即将到期",
+ "go-to-project": "前往项目页面",
+ "title": "角色到期提醒"
}
},
"resource": {
diff --git a/frontend/src/react/no-legacy-vue-deps.test.ts b/frontend/src/react/no-legacy-vue-deps.test.ts
index 8e7b5bc99f..1e1172edfe 100644
--- a/frontend/src/react/no-legacy-vue-deps.test.ts
+++ b/frontend/src/react/no-legacy-vue-deps.test.ts
@@ -8,9 +8,13 @@ const sources = import.meta.glob(
"../router/dashboard/workspace.ts",
"../router/dashboard/workspaceSetting.ts",
"../layouts/BodyLayout.vue",
- "../layouts/ProjectV1Layout.vue",
"../layouts/SQLEditorLayout.vue",
"../components/ProvideSQLEditorContext.vue",
+ "./ReactRouteShellBridge.vue",
+ "./components/ProjectRouteShell.tsx",
+ "./components/SettingRouteShell.tsx",
+ "./components/InstanceRouteShell.tsx",
+ "./components/IssuesRouteShell.tsx",
"./components/RoutePermissionGuardShell.tsx",
],
{
@@ -57,6 +61,10 @@ describe("React Project and Settings legacy Vue dependencies", () => {
"@/components/IssueV1/components/Sidebar/IssueLabels",
"./IssueLabelSelector.vue",
"@/components/ProjectMember/AddProjectMember/AddProjectMemberForm.vue",
+ "@/layouts/ProjectV1Layout.vue",
+ "@/layouts/SettingLayout.vue",
+ "@/layouts/InstanceLayout.vue",
+ "@/layouts/IssuesLayout.vue",
];
const violations: string[] = [];
for (const [file, source] of Object.entries(sources)) {
diff --git a/frontend/src/react/router/index.ts b/frontend/src/react/router/index.ts
index d76c638fba..e0daee0a02 100644
--- a/frontend/src/react/router/index.ts
+++ b/frontend/src/react/router/index.ts
@@ -3,6 +3,7 @@ import type { RouteLocationRaw } from "vue-router";
import { router } from "@/router";
import { AUTH_SIGNIN_MODULE } from "@/router/auth";
import {
+ PROJECT_V1_ROUTE_DATABASES,
PROJECT_V1_ROUTE_DATABASE_DETAIL,
PROJECT_V1_ROUTE_DETAIL,
} from "@/router/dashboard/projectV1";
@@ -49,6 +50,7 @@ export {
ENVIRONMENT_V1_ROUTE_DASHBOARD,
INSTANCE_ROUTE_DASHBOARD,
PROJECT_V1_ROUTE_DASHBOARD,
+ PROJECT_V1_ROUTE_DATABASES,
PROJECT_V1_ROUTE_DATABASE_DETAIL,
PROJECT_V1_ROUTE_DETAIL,
SETTING_ROUTE_PROFILE,
@@ -84,6 +86,8 @@ export type ReactRoute = {
params: Record<string, string | string[] | undefined>;
query: Record<string, unknown>;
requiredPermissions: Permission[];
+ title?: string;
+ overrideDocumentTitle: boolean;
};
export type ReactResolvedRoute = {
@@ -113,6 +117,8 @@ function snapshotRoute(): ReactRoute {
(record.meta.requiredPermissionList?.() ?? []) as Permission[]
)
),
+ title: route.meta.title?.(route),
+ overrideDocumentTitle: route.meta.overrideDocumentTitle ?? false,
};
return cachedRoute;
}
diff --git a/frontend/src/react/stores/app/iam.ts b/frontend/src/react/stores/app/iam.ts
index e1e4269e6e..f457cee6d2 100644
--- a/frontend/src/react/stores/app/iam.ts
+++ b/frontend/src/react/stores/app/iam.ts
@@ -1,15 +1,19 @@
import { create as createProto } from "@bufbuild/protobuf";
import {
+ projectServiceClientConnect,
roleServiceClientConnect,
workspaceServiceClientConnect,
} from "@/connect";
import { workspaceNamePrefix } from "@/react/lib/resourceName";
+import { PRESET_WORKSPACE_ROLES } from "@/types/iam/role";
import { GetIamPolicyRequestSchema } from "@/types/proto-es/v1/iam_policy_pb";
import { ListRolesRequestSchema } from "@/types/proto-es/v1/role_service_pb";
import type { AppSliceCreator, IamSlice } from "./types";
import { bindingMatchesUser } from "./utils";
export const createIamSlice: AppSliceCreator<IamSlice> = (set, get) => ({
+ projectPoliciesByName: {},
+ projectPolicyRequests: {},
roles: [],
loadWorkspacePermissionState: async () => {
@@ -57,6 +61,49 @@ export const createIamSlice: AppSliceCreator<IamSlice> = (set, get) => ({
await Promise.all([rolesRequest, policyRequest]);
},
+ loadProjectIamPolicy: async (project) => {
+ const existing = get().projectPoliciesByName[project];
+ if (existing) return existing;
+ const pending = get().projectPolicyRequests[project];
+ if (pending) return pending;
+
+ await get().loadWorkspacePermissionState();
+
+ const request = projectServiceClientConnect
+ .getIamPolicy(
+ createProto(GetIamPolicyRequestSchema, { resource: project })
+ )
+ .then((policy) => {
+ set((state) => {
+ const { [project]: _, ...projectPolicyRequests } =
+ state.projectPolicyRequests;
+ return {
+ projectPoliciesByName: {
+ ...state.projectPoliciesByName,
+ [project]: policy,
+ },
+ projectPolicyRequests,
+ };
+ });
+ return policy;
+ })
+ .catch(() => {
+ set((state) => {
+ const { [project]: _, ...projectPolicyRequests } =
+ state.projectPolicyRequests;
+ return { projectPolicyRequests };
+ });
+ return undefined;
+ });
+ set((state) => ({
+ projectPolicyRequests: {
+ ...state.projectPolicyRequests,
+ [project]: request,
+ },
+ }));
+ return request;
+ },
+
hasWorkspacePermission: (permission) => {
const user = get().currentUser;
if (!user) return false;
@@ -68,4 +115,26 @@ export const createIamSlice: AppSliceCreator<IamSlice> = (set, get) => ({
roleByName.get(roleName)?.permissions.includes(permission)
);
},
+
+ hasProjectPermission: (project, permission) => {
+ if (get().hasWorkspacePermission(permission)) {
+ return true;
+ }
+ const user = get().currentUser;
+ if (!user) return false;
+ const roleByName = new Map(get().roles.map((role) => [role.name, role]));
+ const workspaceLevelProjectRoles = bindingMatchesUser(
+ get().workspacePolicy,
+ user
+ )
+ .map((binding) => binding.role)
+ .filter((role) => !PRESET_WORKSPACE_ROLES.includes(role));
+ const projectRoles = bindingMatchesUser(
+ get().projectPoliciesByName[project.name],
+ user
+ ).map((binding) => binding.role);
+ return [...workspaceLevelProjectRoles, ...projectRoles].some((roleName) =>
+ roleByName.get(roleName)?.permissions.includes(permission)
+ );
+ },
});
diff --git a/frontend/src/react/stores/app/index.test.ts b/frontend/src/react/stores/app/index.test.ts
index 294d0937eb..152fbac9ed 100644
--- a/frontend/src/react/stores/app/index.test.ts
+++ b/frontend/src/react/stores/app/index.test.ts
@@ -7,6 +7,7 @@ import {
BindingSchema,
IamPolicySchema,
} from "@/types/proto-es/v1/iam_policy_pb";
+import { InstanceSchema } from "@/types/proto-es/v1/instance_service_pb";
import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
import { RoleSchema } from "@/types/proto-es/v1/role_service_pb";
import {
@@ -34,9 +35,11 @@ const mocks = vi.hoisted(() => ({
uploadLicense: vi.fn(),
getSetting: vi.fn(),
getProject: vi.fn(),
+ getProjectIamPolicy: vi.fn(),
batchGetProjects: vi.fn(),
searchProjects: vi.fn(),
createProject: vi.fn(),
+ getInstance: vi.fn(),
}));
vi.mock("@/connect", () => ({
@@ -48,10 +51,14 @@ vi.mock("@/connect", () => ({
},
projectServiceClientConnect: {
getProject: mocks.getProject,
+ getIamPolicy: mocks.getProjectIamPolicy,
batchGetProjects: mocks.batchGetProjects,
searchProjects: mocks.searchProjects,
createProject: mocks.createProject,
},
+ instanceServiceClientConnect: {
+ getInstance: mocks.getInstance,
+ },
roleServiceClientConnect: {
listRoles: mocks.listRoles,
},
@@ -104,8 +111,10 @@ describe("useAppStore", () => {
expect(state.loadWorkspace).toBeTypeOf("function");
expect(state.hasWorkspacePermission).toBeTypeOf("function");
expect(state.fetchProject).toBeTypeOf("function");
+ expect(state.fetchInstance).toBeTypeOf("function");
expect(state.notify).toBeTypeOf("function");
expect(state.recordRecentVisit).toBeTypeOf("function");
+ expect(state.removeRecentVisit).toBeTypeOf("function");
});
test("deduplicates project fetches and caches the result", async () => {
@@ -248,6 +257,63 @@ describe("useAppStore", () => {
expect(store.getState().appFeatures["bb.feature.hide-trial"]).toBe(false);
});
+ test("loads project IAM policy and checks project permissions", async () => {
+ mocks.getCurrentUser.mockResolvedValue(user);
+ mocks.getActuatorInfo.mockResolvedValue({
+ workspace: "workspaces/default",
+ });
+ mocks.getWorkspace.mockResolvedValue({ name: "workspaces/default" });
+ mocks.listRoles.mockResolvedValue({
+ roles: [
+ createProto(RoleSchema, {
+ name: "roles/projectDeveloper",
+ permissions: ["bb.projects.update"],
+ }),
+ ],
+ });
+ mocks.getIamPolicy.mockResolvedValue(createProto(IamPolicySchema, {}));
+ mocks.getProjectIamPolicy.mockResolvedValue(
+ createProto(IamPolicySchema, {
+ bindings: [
+ createProto(BindingSchema, {
+ role: "roles/projectDeveloper",
+ members: ["user:[email protected]"],
+ }),
+ ],
+ })
+ );
+ const store = createAppStore();
+
+ await store.getState().loadProjectIamPolicy(projectA.name);
+
+ expect(mocks.getProjectIamPolicy).toHaveBeenCalledTimes(1);
+ expect(
+ store.getState().hasProjectPermission(projectA, "bb.projects.update")
+ ).toBe(true);
+ expect(
+ store.getState().hasProjectPermission(projectA, "bb.projects.delete")
+ ).toBe(false);
+ });
+
+ test("caches instances by resource name", async () => {
+ const instance = createProto(InstanceSchema, {
+ name: "instances/prod",
+ title: "Prod",
+ });
+ mocks.getInstance.mockResolvedValue(instance);
+ const store = createAppStore();
+
+ const [first, second] = await Promise.all([
+ store.getState().fetchInstance(instance.name),
+ store.getState().fetchInstance(instance.name),
+ ]);
+
+ expect(first).toBe(instance);
+ expect(second).toBe(instance);
+ expect(mocks.getInstance).toHaveBeenCalledTimes(1);
+ expect(store.getState().instancesByName[instance.name]).toBe(instance);
+ });
+
test("dispatches notification events for the Vue shell bridge", () => {
const store = createAppStore();
const listener = vi.fn();
@@ -274,6 +340,7 @@ describe("useAppStore", () => {
store.getState().setRecentProject(projectB.name);
store.getState().recordRecentVisit("/projects/a?tab=1");
store.getState().recordRecentVisit("/projects/a?tab=2");
+ store.getState().removeRecentVisit("/missing");
store.getState().resetQuickstartProgress();
expect(
diff --git a/frontend/src/react/stores/app/index.ts b/frontend/src/react/stores/app/index.ts
index fd1bdba02b..d1dae61776 100644
--- a/frontend/src/react/stores/app/index.ts
+++ b/frontend/src/react/stores/app/index.ts
@@ -1,6 +1,7 @@
import { create } from "zustand";
import { createAuthSlice } from "./auth";
import { createIamSlice } from "./iam";
+import { createInstanceSlice } from "./instance";
import { createNotificationSlice } from "./notification";
import { createPreferencesSlice } from "./preferences";
import { createProjectSlice } from "./project";
@@ -21,6 +22,7 @@ export const createAppStore = () =>
...createWorkspaceSlice(...args),
...createIamSlice(...args),
...createProjectSlice(...args),
+ ...createInstanceSlice(...args),
...createNotificationSlice(...args),
...createPreferencesSlice(...args),
}));
diff --git a/frontend/src/react/stores/app/instance.ts b/frontend/src/react/stores/app/instance.ts
new file mode 100644
index 0000000000..e36050a89c
--- /dev/null
+++ b/frontend/src/react/stores/app/instance.ts
@@ -0,0 +1,75 @@
+import { create as createProto } from "@bufbuild/protobuf";
+import { instanceServiceClientConnect } from "@/connect";
+import {
+ GetInstanceRequestSchema,
+ type Instance,
+} from "@/types/proto-es/v1/instance_service_pb";
+import {
+ isValidInstanceName,
+ UNKNOWN_INSTANCE_NAME,
+} from "@/types/v1/instance";
+import type { AppSliceCreator, InstanceSlice } from "./types";
+
+function toError(error: unknown): Error {
+ if (error instanceof Error) return error;
+ return new Error(String(error));
+}
+
+export const createInstanceSlice: AppSliceCreator<InstanceSlice> = (
+ set,
+ get
+) => ({
+ instancesByName: {},
+ instanceRequests: {},
+ instanceErrorsByName: {},
+
+ fetchInstance: async (name) => {
+ if (!isValidInstanceName(name) || name === UNKNOWN_INSTANCE_NAME) {
+ return undefined;
+ }
+ const existing = get().instancesByName[name];
+ if (existing) return existing;
+ const pending = get().instanceRequests[name];
+ if (pending) return pending;
+
+ const request = instanceServiceClientConnect
+ .getInstance(createProto(GetInstanceRequestSchema, { name }))
+ .then((instance: Instance) => {
+ set((state) => {
+ const { [name]: _, ...instanceRequests } = state.instanceRequests;
+ return {
+ instancesByName: {
+ ...state.instancesByName,
+ [instance.name]: instance,
+ },
+ instanceErrorsByName: {
+ ...state.instanceErrorsByName,
+ [name]: undefined,
+ },
+ instanceRequests,
+ };
+ });
+ return instance;
+ })
+ .catch((error) => {
+ set((state) => {
+ const { [name]: _, ...instanceRequests } = state.instanceRequests;
+ return {
+ instanceErrorsByName: {
+ ...state.instanceErrorsByName,
+ [name]: toError(error),
+ },
+ instanceRequests,
+ };
+ });
+ return undefined;
+ });
+ set((state) => ({
+ instanceRequests: {
+ ...state.instanceRequests,
+ [name]: request,
+ },
+ }));
+ return request;
+ },
+});
diff --git a/frontend/src/react/stores/app/preferences.ts b/frontend/src/react/stores/app/preferences.ts
index 791b7d8e97..845b05f41e 100644
--- a/frontend/src/react/stores/app/preferences.ts
+++ b/frontend/src/react/stores/app/preferences.ts
@@ -55,6 +55,17 @@ export const createPreferencesSlice: AppSliceCreator<PreferencesSlice> = (
writeJson(key, next);
},
+ removeRecentVisit: (path) => {
+ const email = getCurrentUserEmail(get);
+ if (!email) return;
+ const key = storageKeyRecentVisit(email);
+ const previous = readJson<string[]>(key, []);
+ writeJson(
+ key,
+ previous.filter((item) => item !== path)
+ );
+ },
+
resetQuickstartProgress: () => {
const email = getCurrentUserEmail(get);
if (!email) return;
diff --git a/frontend/src/react/stores/app/project.ts b/frontend/src/react/stores/app/project.ts
index e297a4a1d2..813bf1e8bb 100644
--- a/frontend/src/react/stores/app/project.ts
+++ b/frontend/src/react/stores/app/project.ts
@@ -1,6 +1,7 @@
import { create as createProto } from "@bufbuild/protobuf";
import { projectServiceClientConnect } from "@/connect";
import { isValidProjectName } from "@/react/lib/resourceName";
+import { UNKNOWN_ID } from "@/types/const";
import { State } from "@/types/proto-es/v1/common_pb";
import {
BatchGetProjectsRequestSchema,
@@ -12,15 +13,51 @@ import {
import type { AppSliceCreator, ProjectSlice } from "./types";
import { buildProjectFilter, defaultProjectName } from "./utils";
+const UNKNOWN_PROJECT_NAME = `projects/${UNKNOWN_ID}`;
+
+function createDefaultProject(name: string) {
+ return createProto(ProjectSchema, {
+ name,
+ title: "Default project",
+ state: State.ACTIVE,
+ enforceIssueTitle: true,
+ enforceSqlReview: true,
+ requireIssueApproval: true,
+ requirePlanCheckNoError: true,
+ allowRequestRole: true,
+ });
+}
+
+function toError(error: unknown): Error {
+ if (error instanceof Error) return error;
+ return new Error(String(error));
+}
+
export const createProjectSlice: AppSliceCreator<ProjectSlice> = (
set,
get
) => ({
projectsByName: {},
projectRequests: {},
+ projectErrorsByName: {},
fetchProject: async (name) => {
- if (!isValidProjectName(name) || name === defaultProjectName(get)) {
+ const defaultProject = defaultProjectName(get);
+ if (name && name === defaultProject) {
+ const project = createDefaultProject(name);
+ set((state) => ({
+ projectsByName: {
+ ...state.projectsByName,
+ [name]: state.projectsByName[name] ?? project,
+ },
+ projectErrorsByName: {
+ ...state.projectErrorsByName,
+ [name]: undefined,
+ },
+ }));
+ return project;
+ }
+ if (!isValidProjectName(name) || name === UNKNOWN_PROJECT_NAME) {
return undefined;
}
const existing = get().projectsByName[name];
@@ -38,15 +75,25 @@ export const createProjectSlice: AppSliceCreator<ProjectSlice> = (
...state.projectsByName,
[project.name]: project,
},
+ projectErrorsByName: {
+ ...state.projectErrorsByName,
+ [name]: undefined,
+ },
projectRequests,
};
});
return project;
})
- .catch(() => {
+ .catch((error) => {
set((state) => {
const { [name]: _, ...projectRequests } = state.projectRequests;
- return { projectRequests };
+ return {
+ projectErrorsByName: {
+ ...state.projectErrorsByName,
+ [name]: toError(error),
+ },
+ projectRequests,
+ };
});
return undefined;
});
diff --git a/frontend/src/react/stores/app/types.ts b/frontend/src/react/stores/app/types.ts
index a8bb7c6bdf..fb6bb046e3 100644
--- a/frontend/src/react/stores/app/types.ts
+++ b/frontend/src/react/stores/app/types.ts
@@ -4,6 +4,7 @@ import type { Permission } from "@/types/iam/permission";
import type { NotificationCreate } from "@/types/notification";
import type { ActuatorInfo } from "@/types/proto-es/v1/actuator_service_pb";
import type { IamPolicy } from "@/types/proto-es/v1/iam_policy_pb";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
import type { Project } from "@/types/proto-es/v1/project_service_pb";
import type { Role } from "@/types/proto-es/v1/role_service_pb";
import type { WorkspaceProfileSetting } from "@/types/proto-es/v1/setting_service_pb";
@@ -26,6 +27,7 @@ export type AuthSlice = {
export type WorkspaceSlice = {
serverInfo?: ActuatorInfo;
+ serverInfoTs: number;
serverInfoRequest?: Promise<ActuatorInfo | undefined>;
workspace?: Workspace;
workspaceRequest?: Promise<Workspace | undefined>;
@@ -35,6 +37,7 @@ export type WorkspaceSlice = {
subscription?: Subscription;
subscriptionRequest?: Promise<Subscription | undefined>;
loadServerInfo: () => Promise<ActuatorInfo | undefined>;
+ refreshServerInfo: () => Promise<ActuatorInfo | undefined>;
loadWorkspace: () => Promise<Workspace | undefined>;
loadWorkspaceProfile: () => Promise<WorkspaceProfileSetting | undefined>;
loadSubscription: () => Promise<Subscription | undefined>;
@@ -44,15 +47,20 @@ export type WorkspaceSlice = {
export type IamSlice = {
workspacePolicy?: IamPolicy;
workspacePolicyRequest?: Promise<IamPolicy | undefined>;
+ projectPoliciesByName: Record<string, IamPolicy>;
+ projectPolicyRequests: Record<string, Promise<IamPolicy | undefined>>;
roles: Role[];
rolesRequest?: Promise<Role[]>;
loadWorkspacePermissionState: () => Promise<void>;
+ loadProjectIamPolicy: (project: string) => Promise<IamPolicy | undefined>;
hasWorkspacePermission: (permission: Permission) => boolean;
+ hasProjectPermission: (project: Project, permission: Permission) => boolean;
};
export type ProjectSlice = {
projectsByName: Record<string, Project>;
projectRequests: Record<string, Promise<Project | undefined>>;
+ projectErrorsByName: Record<string, Error | undefined>;
fetchProject: (name: string) => Promise<Project | undefined>;
batchFetchProjects: (names: string[]) => Promise<Project[]>;
searchProjects: (params: ProjectListParams) => Promise<{
@@ -62,6 +70,13 @@ export type ProjectSlice = {
createProject: (title: string, resourceId: string) => Promise<Project>;
};
+export type InstanceSlice = {
+ instancesByName: Record<string, Instance>;
+ instanceRequests: Record<string, Promise<Instance | undefined>>;
+ instanceErrorsByName: Record<string, Error | undefined>;
+ fetchInstance: (name: string) => Promise<Instance | undefined>;
+};
+
export type NotificationSlice = {
notifications: NotificationCreate[];
notify: (notification: NotificationCreate) => void;
@@ -70,6 +85,7 @@ export type NotificationSlice = {
export type PreferencesSlice = {
setRecentProject: (name: string) => void;
recordRecentVisit: (path: string) => void;
+ removeRecentVisit: (path: string) => void;
resetQuickstartProgress: () => void;
};
@@ -77,6 +93,7 @@ export type AppStoreState = AuthSlice &
WorkspaceSlice &
IamSlice &
ProjectSlice &
+ InstanceSlice &
NotificationSlice &
PreferencesSlice;
diff --git a/frontend/src/react/stores/app/utils.ts b/frontend/src/react/stores/app/utils.ts
index 8fb9bc02d4..0e6256ac99 100644
--- a/frontend/src/react/stores/app/utils.ts
+++ b/frontend/src/react/stores/app/utils.ts
@@ -1,7 +1,4 @@
import { Code, ConnectError } from "@connectrpc/connect";
-import { resolveCELExpr } from "@/plugins/cel/logic/resolve";
-import type { SimpleExpr } from "@/plugins/cel/types";
-import { ExprType } from "@/plugins/cel/types";
import {
getProjectName,
getUserName,
@@ -11,7 +8,6 @@ import {
import type { Binding } from "@/types/proto-es/v1/iam_policy_pb";
import type { Project } from "@/types/proto-es/v1/project_service_pb";
import type { User } from "@/types/proto-es/v1/user_service_pb";
-import { CEL_ATTRIBUTE_REQUEST_TIME } from "@/utils/cel-attributes";
import type { AppStoreState } from "./types";
export const MAX_RECENT_PROJECT = 5;
@@ -64,41 +60,16 @@ function bindingMemberToNames(member: string): string[] {
return [getUserName(member)];
}
-function findExpirationDate(expr: SimpleExpr): Date | undefined {
- if (expr.type === ExprType.ConditionGroup) {
- for (const arg of expr.args) {
- const date = findExpirationDate(arg);
- if (date) return date;
- }
- }
- if (expr.type !== ExprType.Condition) {
- return undefined;
- }
- const [left, right] = expr.args;
- if (
- expr.operator === "_<_" &&
- left === CEL_ATTRIBUTE_REQUEST_TIME &&
- right instanceof Date
- ) {
- return right;
- }
- return undefined;
-}
-
-function getBindingExpirationDate(binding: Binding): Date | undefined {
+export function getBindingExpirationDate(binding: Binding): Date | undefined {
const expression = binding.condition?.expression;
const match = expression?.match(/request\.time\s*<\s*timestamp\("([^"]+)"\)/);
if (match) {
return new Date(match[1]);
}
- if (!binding.parsedExpr) {
- return undefined;
- }
- const date = findExpirationDate(resolveCELExpr(binding.parsedExpr));
- return date && !Number.isNaN(date.getTime()) ? date : undefined;
+ return undefined;
}
-function isBindingExpired(binding: Binding): boolean {
+export function isBindingExpired(binding: Binding): boolean {
const expiration = getBindingExpirationDate(binding);
return Boolean(expiration && expiration < new Date());
}
diff --git a/frontend/src/react/stores/app/workspace.ts b/frontend/src/react/stores/app/workspace.ts
index 54a063bdd5..01b7237717 100644
--- a/frontend/src/react/stores/app/workspace.ts
+++ b/frontend/src/react/stores/app/workspace.ts
@@ -45,6 +45,7 @@ export const createWorkspaceSlice: AppSliceCreator<WorkspaceSlice> = (
set,
get
) => ({
+ serverInfoTs: 0,
appFeatures: defaultAppProfile().features,
loadServerInfo: async () => {
@@ -55,7 +56,11 @@ export const createWorkspaceSlice: AppSliceCreator<WorkspaceSlice> = (
const request = actuatorServiceClientConnect
.getActuatorInfo({ name: get().currentUser?.workspace ?? "" })
.then((info) => {
- set({ serverInfo: info, serverInfoRequest: undefined });
+ set({
+ serverInfo: info,
+ serverInfoRequest: undefined,
+ serverInfoTs: Date.now(),
+ });
return info;
})
.catch(() => {
@@ -66,6 +71,14 @@ export const createWorkspaceSlice: AppSliceCreator<WorkspaceSlice> = (
return request;
},
+ refreshServerInfo: async () => {
+ const info = await actuatorServiceClientConnect.getActuatorInfo({
+ name: get().currentUser?.workspace ?? get().serverInfo?.workspace ?? "",
+ });
+ set({ serverInfo: info, serverInfoTs: Date.now() });
+ return info;
+ },
+
loadWorkspace: async () => {
const existing = get().workspace;
if (existing) return existing;
diff --git a/frontend/src/router/dashboard/index.ts b/frontend/src/router/dashboard/index.ts
index affa69aea7..2fbc1c0957 100644
--- a/frontend/src/router/dashboard/index.ts
+++ b/frontend/src/router/dashboard/index.ts
@@ -1,7 +1,6 @@
import type { RouteRecordRaw } from "vue-router";
import BodyLayout from "@/layouts/BodyLayout.vue";
import DashboardLayout from "@/layouts/DashboardLayout.vue";
-import IssuesLayout from "@/layouts/IssuesLayout.vue";
import { t } from "@/plugins/i18n";
import environmentV1Routes from "./environmentV1";
import instanceRoutes from "./instance";
@@ -28,8 +27,13 @@ const dashboardRoutes: RouteRecordRaw[] = [
},
{
path: "issues",
- components: { body: IssuesLayout },
- props: true,
+ components: { body: () => import("@/react/ReactRouteShellBridge.vue") },
+ props: {
+ body: () => ({
+ page: "IssuesRouteShell",
+ routerViewName: "content",
+ }),
+ },
meta: {
title: () => t("common.issues"),
},
diff --git a/frontend/src/router/dashboard/instance.ts b/frontend/src/router/dashboard/instance.ts
index 363b0da54e..0bae431ca0 100644
--- a/frontend/src/router/dashboard/instance.ts
+++ b/frontend/src/router/dashboard/instance.ts
@@ -1,6 +1,5 @@
import type { RouteLocationNormalized, RouteRecordRaw } from "vue-router";
import DummyRootView from "@/DummyRootView";
-import InstanceLayout from "@/layouts/InstanceLayout.vue";
import { t } from "@/plugins/i18n";
import {
databaseNamePrefix,
@@ -79,13 +78,20 @@ const instanceRoutes: RouteRecordRaw[] = [
{
path: "instances/:instanceId",
components: {
- content: InstanceLayout,
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
meta: {
title: () => t("common.instance"),
},
- props: { content: true },
+ props: {
+ content: (route: RouteLocationNormalized) => ({
+ page: "InstanceRouteShell",
+ pageProps: {
+ instanceId: route.params.instanceId,
+ },
+ }),
+ },
children: [
{
path: "",
diff --git a/frontend/src/router/dashboard/projectV1.ts b/frontend/src/router/dashboard/projectV1.ts
index d3d3e11190..a23d98aa6e 100644
--- a/frontend/src/router/dashboard/projectV1.ts
+++ b/frontend/src/router/dashboard/projectV1.ts
@@ -145,10 +145,18 @@ const projectV1Routes: RouteRecordRaw[] = [
{
path: "projects/:projectId",
components: {
- content: () => import("@/layouts/ProjectV1Layout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: ReactProjectSidebarMount,
},
- props: { content: true, leftSidebar: true },
+ props: {
+ content: (route: RouteLocationNormalized) => ({
+ page: "ProjectRouteShell",
+ pageProps: {
+ projectId: route.params.projectId,
+ },
+ }),
+ leftSidebar: true,
+ },
meta: {
requiredPermissionList: () => ["bb.projects.get"],
},
diff --git a/frontend/src/router/dashboard/workspace.ts b/frontend/src/router/dashboard/workspace.ts
index 8164e412a1..48b0dc41a5 100644
--- a/frontend/src/router/dashboard/workspace.ts
+++ b/frontend/src/router/dashboard/workspace.ts
@@ -168,11 +168,13 @@ const workspaceRoutes: RouteRecordRaw[] = [
overrideDocumentTitle: true,
},
components: {
- content: () => import("@/layouts/SettingLayout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
props: {
- content: true,
+ content: () => ({
+ page: "SettingRouteShell",
+ }),
leftSidebar: true,
},
children: [
@@ -225,11 +227,13 @@ const workspaceRoutes: RouteRecordRaw[] = [
overrideDocumentTitle: true,
},
components: {
- content: () => import("@/layouts/SettingLayout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
props: {
- content: true,
+ content: () => ({
+ page: "SettingRouteShell",
+ }),
leftSidebar: true,
},
children: [
@@ -253,10 +257,15 @@ const workspaceRoutes: RouteRecordRaw[] = [
overrideDocumentTitle: true,
},
components: {
- content: () => import("@/layouts/SettingLayout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
- props: true,
+ props: {
+ content: () => ({
+ page: "SettingRouteShell",
+ }),
+ leftSidebar: true,
+ },
children: [
{
path: "risk-assessment",
@@ -386,11 +395,13 @@ const workspaceRoutes: RouteRecordRaw[] = [
overrideDocumentTitle: true,
},
components: {
- content: () => import("@/layouts/SettingLayout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
props: {
- content: true,
+ content: () => ({
+ page: "SettingRouteShell",
+ }),
leftSidebar: true,
},
children: [
diff --git a/frontend/src/router/dashboard/workspaceSetting.ts b/frontend/src/router/dashboard/workspaceSetting.ts
index ae355edbd5..43c1cb70c6 100644
--- a/frontend/src/router/dashboard/workspaceSetting.ts
+++ b/frontend/src/router/dashboard/workspaceSetting.ts
@@ -14,11 +14,13 @@ const workspaceSettingRoutes: RouteRecordRaw[] = [
name: SETTING_ROUTE_WORKSPACE,
meta: { title: () => t("common.settings") },
components: {
- content: () => import("@/layouts/SettingLayout.vue"),
+ content: () => import("@/react/ReactRouteShellBridge.vue"),
leftSidebar: () => import("@/react/ReactSidebarMount.vue"),
},
props: {
- content: true,
+ content: () => ({
+ page: "SettingRouteShell",
+ }),
leftSidebar: true,
},
children: [
diff --git a/frontend/src/router/index.ts b/frontend/src/router/index.ts
index ec8f5a3d52..32c15edffc 100644
--- a/frontend/src/router/index.ts
+++ b/frontend/src/router/index.ts
@@ -276,9 +276,9 @@ router.beforeEach((to, from, next) => {
});
router.afterEach((to /*, from */) => {
- // Skip routes where a layout component manages the document title:
- // - ProjectV1Layout handles project-scoped routes (have projectId param)
- // - SettingLayout handles settings routes (marked with overrideDocumentTitle)
+ // Skip routes where the React route shell manages the document title:
+ // - ProjectRouteShell handles project-scoped routes (have projectId param)
+ // - SettingRouteShell handles settings routes (marked with overrideDocumentTitle)
if (to.params.projectId || to.meta.overrideDocumentTitle) return;
nextTick(() => {
diff --git a/frontend/src/shims-vue-router.d.ts b/frontend/src/shims-vue-router.d.ts
index 76ecd75a7f..3ad1762fd1 100644
--- a/frontend/src/shims-vue-router.d.ts
+++ b/frontend/src/shims-vue-router.d.ts
@@ -6,8 +6,8 @@ declare module "vue-router" {
interface RouteMeta {
title?: (route: RouteLocationNormalized) => string;
requiredPermissionList?: () => Permission[];
- // When true, a layout component (e.g. ProjectV1Layout, SettingLayout)
- // manages document.title for this route, so the router afterEach skips it.
+ // When true, a React route shell manages document.title for this route,
+ // so the router afterEach skips it.
overrideDocumentTitle?: boolean;
}
}