Skip to content

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

feat(UX): support instance in project (#21105)

ecmadaoa657aa9dfef0
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 49d1ab3488..448c66707d 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -9958,12 +9958,6 @@ components:
type: boolean
title: validate_only
description: Validate only also tests the data source connection.
- initialDatabaseProject:
- type: string
- title: initial_database_project
- description: |-
- The project to assign newly discovered databases to during initial sync.
- Format: projects/{project}. This must be unset when `parent` is set.
title: CreateInstanceRequest
additionalProperties: false
bytebase.v1.CreateIssueCommentRequest:
diff --git a/backend/api/v1/instance_service.go b/backend/api/v1/instance_service.go
index 1ac4f15f9b..634892fcae 100644
--- a/backend/api/v1/instance_service.go
+++ b/backend/api/v1/instance_service.go
@@ -388,9 +388,6 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Reque
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid instance ID %v", req.Msg.InstanceId))
}
- if req.Msg.Parent != nil && req.Msg.InitialDatabaseProject != "" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("initial_database_project must be unset when parent is set"))
- }
projectID, err := s.getProjectInstanceParent(ctx, req.Msg.Parent)
if err != nil {
return nil, err
@@ -410,10 +407,6 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Reque
workspaceID := common.GetWorkspaceIDFromContext(ctx)
instanceMessage.Workspace = workspaceID
instanceMessage.ProjectID = projectID
- initialProjectID, err := s.getInitialDatabaseProjectID(ctx, req.Msg.GetInitialDatabaseProject())
- if err != nil {
- return nil, err
- }
for _, ds := range instanceMessage.Metadata.GetDataSources() {
if err := validateAndSanitizeDataSourceTLS(ds); err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
@@ -453,9 +446,7 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Reque
driver, err := s.dbFactory.GetAdminDatabaseDriver(ctx, instance, nil /* database */, db.ConnectionContext{})
if err == nil {
defer driver.Close(ctx)
- updatedInstance, _, newDatabases, err := s.schemaSyncer.SyncInstanceWithOptions(ctx, instance, schemasync.SyncInstanceOptions{
- InitialProjectID: initialProjectID,
- })
+ updatedInstance, _, newDatabases, err := s.schemaSyncer.SyncInstance(ctx, instance)
if err != nil {
slog.Warn("Failed to sync instance",
slog.String("instance", instance.ResourceID),
@@ -475,27 +466,6 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Reque
return connect.NewResponse(result), nil
}
-func (s *InstanceService) getInitialDatabaseProjectID(ctx context.Context, projectName string) (string, error) {
- if projectName == "" {
- return "", nil
- }
- projectID, err := common.GetProjectID(projectName)
- if err != nil {
- return "", connect.NewError(connect.CodeInvalidArgument, errors.Wrapf(err, "invalid project %q", projectName))
- }
- project, err := s.store.GetProject(ctx, &store.FindProjectMessage{
- ResourceID: &projectID,
- Workspace: common.GetWorkspaceIDFromContext(ctx),
- })
- if err != nil {
- return "", connect.NewError(connect.CodeInternal, err)
- }
- if project == nil || project.Deleted {
- return "", connect.NewError(connect.CodeNotFound, errors.Errorf("project %q not found", projectName))
- }
- return project.ResourceID, nil
-}
-
func (s *InstanceService) getProjectInstanceParent(ctx context.Context, parent *string) (*string, error) {
if parent == nil {
return nil, nil
diff --git a/backend/generated-go/v1/instance_service.pb.go b/backend/generated-go/v1/instance_service.pb.go
index 7a171cc6f9..2c9bd94cec 100644
--- a/backend/generated-go/v1/instance_service.pb.go
+++ b/backend/generated-go/v1/instance_service.pb.go
@@ -716,12 +716,9 @@ type CreateInstanceRequest struct {
// are /[a-z][0-9]-/.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Validate only also tests the data source connection.
- ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
- // The project to assign newly discovered databases to during initial sync.
- // Format: projects/{project}. This must be unset when `parent` is set.
- InitialDatabaseProject string `protobuf:"bytes,4,opt,name=initial_database_project,json=initialDatabaseProject,proto3" json:"initial_database_project,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
+ ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
}
func (x *CreateInstanceRequest) Reset() {
@@ -782,13 +779,6 @@ func (x *CreateInstanceRequest) GetValidateOnly() bool {
return false
}
-func (x *CreateInstanceRequest) GetInitialDatabaseProject() string {
- if x != nil {
- return x.InitialDatabaseProject
- }
- return ""
-}
-
type UpdateInstanceRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The instance to update.
@@ -3103,15 +3093,14 @@ const file_v1_instance_service_proto_rawDesc = "" +
"\a_parent\"t\n" +
"\x15ListInstancesResponse\x123\n" +
"\tinstances\x18\x01 \x03(\v2\x15.bytebase.v1.InstanceR\tinstances\x12&\n" +
- "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\x93\x02\n" +
+ "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\xf9\x01\n" +
"\x15CreateInstanceRequest\x127\n" +
"\x06parent\x18\x05 \x01(\tB\x1a\xfaA\x17\x12\x15bytebase.com/InstanceH\x00R\x06parent\x88\x01\x01\x126\n" +
"\binstance\x18\x01 \x01(\v2\x15.bytebase.v1.InstanceB\x03\xe0A\x02R\binstance\x12\x1f\n" +
"\vinstance_id\x18\x02 \x01(\tR\n" +
"instanceId\x12#\n" +
- "\rvalidate_only\x18\x03 \x01(\bR\fvalidateOnly\x128\n" +
- "\x18initial_database_project\x18\x04 \x01(\tR\x16initialDatabaseProjectB\t\n" +
- "\a_parent\"\xb1\x01\n" +
+ "\rvalidate_only\x18\x03 \x01(\bR\fvalidateOnlyB\t\n" +
+ "\a_parentJ\x04\b\x04\x10\x05R\x18initial_database_project\"\xb1\x01\n" +
"\x15UpdateInstanceRequest\x126\n" +
"\binstance\x18\x01 \x01(\v2\x15.bytebase.v1.InstanceB\x03\xe0A\x02R\binstance\x12;\n" +
"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
diff --git a/backend/generated-go/v1/instance_service_equal.pb.go b/backend/generated-go/v1/instance_service_equal.pb.go
index 3bee4827db..1cc09c36d9 100644
--- a/backend/generated-go/v1/instance_service_equal.pb.go
+++ b/backend/generated-go/v1/instance_service_equal.pb.go
@@ -89,9 +89,6 @@ func (x *CreateInstanceRequest) Equal(y *CreateInstanceRequest) bool {
if x.ValidateOnly != y.ValidateOnly {
return false
}
- if x.InitialDatabaseProject != y.InitialDatabaseProject {
- return false
- }
return true
}
diff --git a/backend/runner/schemasync/syncer.go b/backend/runner/schemasync/syncer.go
index 3506c0e6d7..94ee4ddd79 100644
--- a/backend/runner/schemasync/syncer.go
+++ b/backend/runner/schemasync/syncer.go
@@ -328,20 +328,8 @@ func (s *Syncer) GetInstanceMeta(ctx context.Context, instance *store.InstanceMe
return instanceMeta, nil
}
-// SyncInstanceOptions controls one-off sync behavior.
-type SyncInstanceOptions struct {
- // InitialProjectID assigns newly discovered databases to this project.
- // Empty means the workspace default project.
- InitialProjectID string
-}
-
// SyncInstance syncs the schema for all databases in an instance.
func (s *Syncer) SyncInstance(ctx context.Context, instance *store.InstanceMessage) (*store.InstanceMessage, []*storepb.DatabaseSchemaMetadata, []*store.DatabaseMessage, error) {
- return s.SyncInstanceWithOptions(ctx, instance, SyncInstanceOptions{})
-}
-
-// SyncInstanceWithOptions syncs the schema for all databases in an instance with one-off options.
-func (s *Syncer) SyncInstanceWithOptions(ctx context.Context, instance *store.InstanceMessage, options SyncInstanceOptions) (*store.InstanceMessage, []*storepb.DatabaseSchemaMetadata, []*store.DatabaseMessage, error) {
instanceMeta, err := s.GetInstanceMeta(ctx, instance)
if err != nil {
return nil, nil, nil, err
@@ -369,16 +357,13 @@ func (s *Syncer) SyncInstanceWithOptions(ctx context.Context, instance *store.In
}
var newDatabases []*store.DatabaseMessage
var filteredDatabaseMetadatas []*storepb.DatabaseSchemaMetadata
- databaseProjectID := options.InitialProjectID
- if databaseProjectID == "" {
- if instance.ProjectID != nil {
- databaseProjectID = *instance.ProjectID
- } else {
- var err error
- databaseProjectID, err = s.store.GetDefaultProjectID(ctx, instance.Workspace)
- if err != nil {
- return nil, nil, nil, errors.Wrapf(err, "failed to get default project ID for instance %q", instance.ResourceID)
- }
+ var databaseProjectID string
+ if instance.ProjectID != nil {
+ databaseProjectID = *instance.ProjectID
+ } else {
+ databaseProjectID, err = s.store.GetDefaultProjectID(ctx, instance.Workspace)
+ if err != nil {
+ return nil, nil, nil, errors.Wrapf(err, "failed to get default project ID for instance %q", instance.ResourceID)
}
}
diff --git a/backend/tests/instance_create_project_test.go b/backend/tests/instance_create_project_test.go
index b176e0ba1e..9f91871047 100644
--- a/backend/tests/instance_create_project_test.go
+++ b/backend/tests/instance_create_project_test.go
@@ -12,41 +12,6 @@ import (
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
)
-func TestCreateInstanceAssignsSyncedDatabasesToProject(t *testing.T) {
- t.Parallel()
- a := require.New(t)
- ctx := context.Background()
- ctl := &controller{}
- ctx, err := ctl.StartServerWithExternalPg(ctx)
- a.NoError(err)
- defer ctl.Close(ctx)
-
- pgContainer, err := provisionPgInstance(ctx, t)
- a.NoError(err)
- databaseName := "project_assignment"
- createPgDatabase(t, pgContainer, databaseName)
-
- instanceResp, err := ctl.instanceServiceClient.CreateInstance(ctx, connect.NewRequest(&v1pb.CreateInstanceRequest{
- InstanceId: generateRandomString("instance"),
- InitialDatabaseProject: ctl.project.Name,
- Instance: &v1pb.Instance{
- Title: "project-aware-sync",
- Engine: v1pb.Engine_POSTGRES,
- Environment: new("environments/prod"),
- Activation: true,
- DataSources: []*v1pb.DataSource{pgContainer.adminDataSource()},
- },
- }))
- a.NoError(err)
- instance := instanceResp.Msg
-
- databaseResp, err := ctl.databaseServiceClient.GetDatabase(ctx, connect.NewRequest(&v1pb.GetDatabaseRequest{
- Name: fmt.Sprintf("%s/databases/%s", instance.Name, databaseName),
- }))
- a.NoError(err)
- a.Equal(ctl.project.Name, databaseResp.Msg.Project)
-}
-
func TestCreateInstanceWithoutProjectKeepsDefaultProject(t *testing.T) {
t.Parallel()
a := require.New(t)
diff --git a/backend/tests/project_instance_test.go b/backend/tests/project_instance_test.go
index 4d6a24f220..38dd7fa08a 100644
--- a/backend/tests/project_instance_test.go
+++ b/backend/tests/project_instance_test.go
@@ -349,16 +349,6 @@ func TestProjectInstanceValidation(t *testing.T) {
}))
a.Error(err)
a.Equal(connect.CodeNotFound, connect.CodeOf(err))
-
- parent := ctl.project.Name
- _, err = ctl.instanceServiceClient.CreateInstance(ctx, connect.NewRequest(&v1pb.CreateInstanceRequest{
- Parent: &parent,
- InitialDatabaseProject: ctl.project.Name,
- InstanceId: "bot35-conflicting-parent",
- Instance: &v1pb.Instance{},
- }))
- a.Error(err)
- a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
}
func createProjectForProjectInstanceTest(ctx context.Context, t *testing.T, ctl *controller, projectID string) *v1pb.Project {
diff --git a/frontend/src/app/router/handles.ts b/frontend/src/app/router/handles.ts
index 19c54e36d9..ed54062bae 100644
--- a/frontend/src/app/router/handles.ts
+++ b/frontend/src/app/router/handles.ts
@@ -77,6 +77,9 @@ export const ENVIRONMENT_V1_ROUTE_DETAIL = `${ENVIRONMENT_V1_ROUTE_DASHBOARD}.de
// --- dashboard/projectV1.ts ---
export const PROJECT_V1_ROUTE_DETAIL = `${PROJECT_V1_ROUTE_DASHBOARD}.detail`;
+export const PROJECT_V1_ROUTE_INSTANCES = `${PROJECT_V1_ROUTE_DASHBOARD}.instance`;
+export const PROJECT_V1_ROUTE_INSTANCE_CREATE = `${PROJECT_V1_ROUTE_INSTANCES}.create`;
+export const PROJECT_V1_ROUTE_INSTANCE_DETAIL = `${PROJECT_V1_ROUTE_INSTANCES}.detail`;
export const PROJECT_V1_ROUTE_DATABASES = `${PROJECT_V1_ROUTE_DASHBOARD}.database`;
export const PROJECT_V1_ROUTE_MASKING_EXEMPTION = `${PROJECT_V1_ROUTE_DASHBOARD}.masking-exemption`;
export const PROJECT_V1_ROUTE_MASKING_EXEMPTION_CREATE = `${PROJECT_V1_ROUTE_DASHBOARD}.masking-exemption.create`;
diff --git a/frontend/src/app/router/routes/dashboard.tsx b/frontend/src/app/router/routes/dashboard.tsx
index 5d3fcc8396..7064ec3d81 100644
--- a/frontend/src/app/router/routes/dashboard.tsx
+++ b/frontend/src/app/router/routes/dashboard.tsx
@@ -22,6 +22,9 @@ import {
PROJECT_V1_ROUTE_DATABASES,
PROJECT_V1_ROUTE_DETAIL,
PROJECT_V1_ROUTE_GITOPS,
+ PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+ PROJECT_V1_ROUTE_INSTANCES,
PROJECT_V1_ROUTE_ISSUE_DETAIL,
PROJECT_V1_ROUTE_ISSUES,
PROJECT_V1_ROUTE_MASKING_EXEMPTION,
@@ -570,6 +573,39 @@ const projectV1Routes: RouteObject[] = [
// is relative to the parent `projects/:projectId`.
element: <Navigate to="issues" replace />,
},
+ {
+ path: "instances/new",
+ handle: {
+ name: PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ requiredPermissionList: (): Permission[] => ["bb.instances.create"],
+ },
+ lazy: lazyPage(
+ () => import("@/routes/project/ProjectCreateInstancePage"),
+ (m) => m.ProjectCreateInstancePage
+ ),
+ },
+ {
+ path: "instances",
+ handle: {
+ name: PROJECT_V1_ROUTE_INSTANCES,
+ requiredPermissionList: (): Permission[] => ["bb.instances.list"],
+ },
+ lazy: lazyPage(
+ () => import("@/routes/project/ProjectInstancesPage"),
+ (m) => m.ProjectInstancesPage
+ ),
+ },
+ {
+ path: "instances/:instanceId",
+ handle: {
+ name: PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+ requiredPermissionList: (): Permission[] => ["bb.instances.get"],
+ },
+ lazy: lazyPage(
+ () => import("@/routes/project/ProjectInstanceDetailPage"),
+ (m) => m.ProjectInstanceDetailPage
+ ),
+ },
{
path: "databases",
handle: {
diff --git a/frontend/src/components/InstanceLabel.test.tsx b/frontend/src/components/InstanceLabel.test.tsx
index 875f2753d9..7c9d17f400 100644
--- a/frontend/src/components/InstanceLabel.test.tsx
+++ b/frontend/src/components/InstanceLabel.test.tsx
@@ -12,6 +12,8 @@ const mocks = vi.hoisted(() => ({
instancesByName: {} as Record<string, { name: string; title: string }>,
fetchInstance: vi.fn(),
hasWorkspacePermissionV2: vi.fn((_permission: string) => true),
+ hasProjectPermissionV2: vi.fn(() => true),
+ projectsByName: {} as Record<string, { name: string }>,
}));
vi.mock("react-i18next", () => ({
@@ -40,6 +42,7 @@ vi.mock("@/components/RouterLink", () => ({
<a
className={className}
data-instance-id={to.params?.instanceId}
+ data-project-id={to.params?.projectId}
data-route-name={to.name}
onClick={onClick}
>
@@ -53,6 +56,9 @@ vi.mock("@/stores/app", () => {
get instancesByName() {
return mocks.instancesByName;
},
+ get projectsByName() {
+ return mocks.projectsByName;
+ },
};
const useAppStore = (selector: (state: typeof appState) => unknown) =>
selector(appState);
@@ -65,6 +71,7 @@ vi.mock("@/stores/app", () => {
vi.mock("@/utils", async (importOriginal) => ({
...(await importOriginal<typeof import("@/utils")>()),
hasWorkspacePermissionV2: mocks.hasWorkspacePermissionV2,
+ hasProjectPermissionV2: mocks.hasProjectPermissionV2,
}));
import { InstanceLabel } from "./InstanceLabel";
@@ -97,6 +104,7 @@ describe("InstanceLabel", () => {
dataSources: [],
} as never,
};
+ mocks.projectsByName = {};
});
afterEach(() => {
@@ -150,6 +158,37 @@ describe("InstanceLabel", () => {
expect(link?.getAttribute("data-instance-id")).toBe("prod");
});
+ test("links project-owned instances to the nested project route", async () => {
+ mocks.projectsByName = {
+ "projects/app": { name: "projects/app" },
+ };
+ mocks.instancesByName = {
+ "projects/app/instances/prod": {
+ name: "projects/app/instances/prod",
+ title: "Prod Instance",
+ engine: Engine.POSTGRES,
+ activation: true,
+ dataSources: [],
+ } as never,
+ };
+
+ const rendered = await render(
+ <InstanceLabel instanceName="projects/app/instances/prod" link />
+ );
+ root = rendered.root;
+
+ const link = rendered.container.querySelector("a");
+ expect(link?.getAttribute("data-route-name")).toBe(
+ "workspace.project.instance.detail"
+ );
+ expect(link?.getAttribute("data-project-id")).toBe("app");
+ expect(link?.getAttribute("data-instance-id")).toBe("prod");
+ expect(mocks.hasProjectPermissionV2).toHaveBeenCalledWith(
+ mocks.projectsByName["projects/app"],
+ "bb.instances.get"
+ );
+ });
+
test("renders invalid instance names as plain text even when link is requested", async () => {
const rendered = await render(<InstanceLabel instanceName="instances/" link />);
root = rendered.root;
diff --git a/frontend/src/components/InstanceLabel.tsx b/frontend/src/components/InstanceLabel.tsx
index 449554d250..a338f11152 100644
--- a/frontend/src/components/InstanceLabel.tsx
+++ b/frontend/src/components/InstanceLabel.tsx
@@ -1,6 +1,9 @@
import { type MouseEventHandler, type ReactNode, useEffect } from "react";
import { useTranslation } from "react-i18next";
-import { INSTANCE_ROUTE_DETAIL } from "@/app/router/handles";
+import {
+ INSTANCE_ROUTE_DETAIL,
+ PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+} from "@/app/router/handles";
import { EngineIcon } from "@/components/EngineIcon";
import { RouterLink, type RouterLinkProps } from "@/components/RouterLink";
import { cn } from "@/lib/utils";
@@ -12,6 +15,8 @@ import type {
import { isValidInstanceName } from "@/types/v1/instance";
import {
extractInstanceResourceName,
+ extractProjectResourceName,
+ hasProjectPermissionV2,
hasWorkspacePermissionV2,
instanceV1Name,
} from "@/utils";
@@ -36,8 +41,14 @@ export function InstanceLabel({
const { t } = useTranslation();
const name = instanceProp?.name ?? instanceName ?? "";
const instanceId = extractInstanceResourceName(name);
+ const projectName = name.match(/^(projects\/[^/]+)\/instances\/[^/]+$/)?.[1];
const validInstanceName = isValidInstanceName(name) && !!instanceId;
- const canGetInstance = hasWorkspacePermissionV2("bb.instances.get");
+ const project = useAppStore((s) =>
+ projectName ? s.projectsByName[projectName] : undefined
+ );
+ const canGetInstance = projectName
+ ? !!project && hasProjectPermissionV2(project, "bb.instances.get")
+ : hasWorkspacePermissionV2("bb.instances.get");
const cachedInstance = useAppStore((s) =>
validInstanceName && canGetInstance ? s.instancesByName[name] : undefined
);
@@ -99,8 +110,15 @@ export function InstanceLabel({
<RouterLink
{...linkProps}
to={{
- name: INSTANCE_ROUTE_DETAIL,
- params: { instanceId },
+ name: projectName
+ ? PROJECT_V1_ROUTE_INSTANCE_DETAIL
+ : INSTANCE_ROUTE_DETAIL,
+ params: projectName
+ ? {
+ projectId: extractProjectResourceName(projectName),
+ instanceId,
+ }
+ : { instanceId },
}}
className={cn(
"inline-flex min-w-0 max-w-full items-center gap-x-1 normal-link hover:underline",
diff --git a/frontend/src/components/InstanceSelect.tsx b/frontend/src/components/InstanceSelect.tsx
index 67785cf2ca..7f23caa071 100644
--- a/frontend/src/components/InstanceSelect.tsx
+++ b/frontend/src/components/InstanceSelect.tsx
@@ -100,10 +100,7 @@ export function InstanceSelect({
<div className="flex flex-col gap-0.5">
<div className="flex items-center gap-1.5">
{inst.environment && (
- <>
- <EnvironmentLabel environmentName={inst.environment} />
- <span className="text-control-placeholder">&gt;</span>
- </>
+ <EnvironmentLabel environmentName={inst.environment} />
)}
<EngineIcon engine={inst.engine} className="h-4 w-4" />
<span>{inst.title}</span>
diff --git a/frontend/src/components/ProjectSidebar.test.tsx b/frontend/src/components/ProjectSidebar.test.tsx
index 305edc8ec1..aa8c4da8c6 100644
--- a/frontend/src/components/ProjectSidebar.test.tsx
+++ b/frontend/src/components/ProjectSidebar.test.tsx
@@ -17,6 +17,7 @@ const mocks = vi.hoisted(() => ({
query: {},
},
defaultProject: "",
+ dev: true,
getOrFetchProjectByName: vi.fn(),
record: vi.fn(),
push: vi.fn(),
@@ -38,6 +39,7 @@ const t = vi.hoisted(
"common.databases": "Databases",
"common.groups": "Groups",
"common.issues": "Issues",
+ "common.instances": "Instances",
"common.manage": "Manage",
"common.members": options?.count === 2 ? "Members" : "Member",
"common.setting": "Setting",
@@ -99,6 +101,11 @@ vi.mock("@/stores/app", () => {
return { useAppStore };
});
+vi.mock("@/utils", async (importOriginal) => ({
+ ...(await importOriginal<typeof import("@/utils")>()),
+ isDev: () => mocks.dev,
+}));
+
let ProjectSidebar: typeof import("./ProjectSidebar").ProjectSidebar;
const renderIntoContainer = (element: ReactElement) => {
@@ -127,10 +134,52 @@ beforeEach(async () => {
projectId: "sample",
};
mocks.defaultProject = "";
+ mocks.dev = true;
({ ProjectSidebar } = await import("./ProjectSidebar"));
});
describe("ProjectSidebar", () => {
+ test("renders project instances before databases", () => {
+ const { container, render, unmount } = renderIntoContainer(
+ <ProjectSidebar />
+ );
+ render();
+
+ const labels = Array.from(container.querySelectorAll("a")).map((link) =>
+ link.textContent?.trim()
+ );
+ expect(labels.indexOf("Instances")).toBeGreaterThan(-1);
+ expect(labels.indexOf("Instances")).toBeLessThan(
+ labels.indexOf("Databases")
+ );
+
+ unmount();
+ });
+
+ test("hides project instances for the default project", () => {
+ mocks.defaultProject = "projects/sample";
+ const { container, render, unmount } = renderIntoContainer(
+ <ProjectSidebar />
+ );
+ render();
+
+ expect(container.textContent).not.toContain("Instances");
+
+ unmount();
+ });
+
+ test("renders project instances in release builds", () => {
+ mocks.dev = false;
+ const { container, render, unmount } = renderIntoContainer(
+ <ProjectSidebar />
+ );
+ render();
+
+ expect(container.textContent).toContain("Instances");
+
+ unmount();
+ });
+
test("renders the settings route with a plural label", () => {
const { container, render, unmount } = renderIntoContainer(
<ProjectSidebar />
diff --git a/frontend/src/components/ProjectSidebar.tsx b/frontend/src/components/ProjectSidebar.tsx
index eb64c8306f..d1647017e1 100644
--- a/frontend/src/components/ProjectSidebar.tsx
+++ b/frontend/src/components/ProjectSidebar.tsx
@@ -18,6 +18,7 @@ import {
PROJECT_V1_ROUTE_DATABASE_GROUPS,
PROJECT_V1_ROUTE_DATABASES,
PROJECT_V1_ROUTE_GITOPS,
+ PROJECT_V1_ROUTE_INSTANCES,
PROJECT_V1_ROUTE_ISSUES,
PROJECT_V1_ROUTE_MASKING_EXEMPTION,
PROJECT_V1_ROUTE_MEMBERS,
@@ -117,6 +118,12 @@ function useSidebarItems(): SidebarItem[] {
type: "div",
expand: true,
children: [
+ {
+ title: t("common.instances"),
+ path: PROJECT_V1_ROUTE_INSTANCES,
+ type: "div",
+ hide: isDefault,
+ },
{
title: t("common.databases"),
path: PROJECT_V1_ROUTE_DATABASES,
diff --git a/frontend/src/components/database/CreateDatabaseSheet.test.tsx b/frontend/src/components/database/CreateDatabaseSheet.test.tsx
index 813c761132..d79c546707 100644
--- a/frontend/src/components/database/CreateDatabaseSheet.test.tsx
+++ b/frontend/src/components/database/CreateDatabaseSheet.test.tsx
@@ -76,6 +76,7 @@ vi.mock("@/components/ui/combobox", () => ({
value,
onChange,
placeholder,
+ disabled,
portal,
}: {
value: string;
@@ -84,6 +85,7 @@ vi.mock("@/components/ui/combobox", () => ({
noResultsText?: string;
options?: unknown[];
onSearch?: (q: string) => void;
+ disabled?: boolean;
portal?: boolean;
renderValue?: (opt: unknown) => ReactNode;
}) =>
@@ -92,6 +94,7 @@ vi.mock("@/components/ui/combobox", () => ({
"data-portal": String(Boolean(portal)),
value,
placeholder,
+ disabled,
onChange: (e: React.ChangeEvent<HTMLInputElement>) =>
onChange(e.target.value),
}),
@@ -232,7 +235,8 @@ vi.mock("@/types", () => ({
name.startsWith("projects/") &&
name !== "projects/-1",
isValidInstanceName: (name: string) =>
- typeof name === "string" && name.startsWith("instances/"),
+ typeof name === "string" &&
+ /^(?:instances|projects\/[^/]+\/instances)\/[^/]+$/.test(name),
defaultCharsetOfEngineV1: () => "utf8",
defaultCollationOfEngineV1: () => "utf8_general_ci",
}));
@@ -262,6 +266,11 @@ const TEST_INSTANCE = {
engine: Engine.MYSQL,
environment: "environments/dev",
};
+const PROJECT_INSTANCE = {
+ name: "projects/app/instances/project-instance",
+ engine: Engine.MYSQL,
+ environment: "environments/dev",
+};
let container: HTMLDivElement;
let root: ReturnType<typeof createRoot>;
@@ -415,6 +424,25 @@ describe("CreateDatabaseSheet — enforceIssueTitle (BYT-9310)", () => {
expect(instanceSelect.dataset.portal).toBe("true");
});
+ it("selects and locks the owner project for a project-owned instance", async () => {
+ setupProjectMock(false);
+ mocks.instancesByName[PROJECT_INSTANCE.name] = PROJECT_INSTANCE;
+ await renderSheetWithoutFixedProject();
+
+ await fillInstance(PROJECT_INSTANCE.name);
+ await flush();
+
+ const projectSelect = container.querySelector(
+ "input[placeholder='common.project']"
+ ) as HTMLInputElement;
+ expect(projectSelect.value).toBe("projects/app");
+ expect(projectSelect.disabled).toBe(true);
+
+ await fillInstance(TEST_INSTANCE.name);
+ expect(projectSelect.value).toBe("");
+ expect(projectSelect.disabled).toBe(false);
+ });
+
it("hydrates a fixed project only when an always-mounted sheet opens", async () => {
setupProjectMock(false);
await act(async () => {
diff --git a/frontend/src/components/database/CreateDatabaseSheet.tsx b/frontend/src/components/database/CreateDatabaseSheet.tsx
index 5c85d621dc..6172718ef3 100644
--- a/frontend/src/components/database/CreateDatabaseSheet.tsx
+++ b/frontend/src/components/database/CreateDatabaseSheet.tsx
@@ -67,6 +67,9 @@ import {
const INTERNAL_RDS_USERS = ["rds_ad", "rdsadmin", "rds_iam"];
+const getInstanceProjectName = (instanceName: string): string =>
+ instanceName.match(/^(projects\/[^/]+)\/instances\/[^/]+$/)?.[1] ?? "";
+
export interface CreateDatabaseSheetProps {
open: boolean;
onClose: () => void;
@@ -177,7 +180,11 @@ function CreateDatabaseForm({
{ name: string; issueLabels: IssueLabel[] } | undefined
>();
- const effectiveProjectName = fixedProjectName || projectName;
+ const instanceProjectName = getInstanceProjectName(
+ selectedInstance?.name ?? ""
+ );
+ const effectiveProjectName =
+ instanceProjectName || fixedProjectName || projectName;
// Project hydration and the reactive cache entry must agree on the exact
// resource name. The store returns an unknown-project sentinel on a miss;
@@ -480,8 +487,9 @@ function CreateDatabaseForm({
}
>
<ProjectSelect
- value={projectName}
+ value={effectiveProjectName}
onChange={(name) => setProjectName(name)}
+ disabled={!!instanceProjectName}
portal
/>
</FormField>
diff --git a/frontend/src/components/instance/CreateInstanceView.test.tsx b/frontend/src/components/instance/CreateInstanceView.test.tsx
new file mode 100644
index 0000000000..5e67f91a69
--- /dev/null
+++ b/frontend/src/components/instance/CreateInstanceView.test.tsx
@@ -0,0 +1,222 @@
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+(
+ globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
+).IS_REACT_ACT_ENVIRONMENT = true;
+
+const mocks = vi.hoisted(() => ({
+ useUnsavedChangesGuard: vi.fn(),
+ onDismiss: vi.fn(),
+ onCreated: vi.fn(),
+ providerProps: undefined as Record<string, unknown> | undefined,
+ instanceFormContext: {
+ basicInfo: { engine: 0 },
+ state: { isRequesting: false },
+ valueChanged: false,
+ },
+}));
+
+let CreateInstanceView: typeof import("./CreateInstanceView").CreateInstanceView;
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: { type: "3rdParty", init: () => {} },
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+
+vi.mock("@/hooks/useUnsavedChangesGuard", () => ({
+ useUnsavedChangesGuard: mocks.useUnsavedChangesGuard,
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: {
+ getState: () => ({
+ instanceCountLimit: () => 10,
+ activatedInstanceCount: () => 0,
+ }),
+ },
+}));
+
+vi.mock("@/stores", () => ({
+ pushNotification: vi.fn(),
+}));
+
+vi.mock("@/components/instance", () => ({
+ InfoPanel: ({ children }: { children: React.ReactNode }) => (
+ <div>{children}</div>
+ ),
+ InfoPanelContent: () => <div />,
+ InstanceFormBody: () => <div data-testid="instance-form-body" />,
+ InstanceFormButtons: ({ className }: { className?: string }) => (
+ <div data-testid="instance-form-buttons" className={className} />
+ ),
+ InstanceFormProvider: ({
+ children,
+ onDismiss,
+ ...props
+ }: {
+ children: React.ReactNode;
+ onDismiss?: () => void;
+ parent?: string;
+ project?: unknown;
+ }) => (
+ <div
+ ref={() => {
+ mocks.providerProps = props;
+ }}
+ >
+ <button type="button" data-testid="dismiss" onClick={onDismiss}>
+ dismiss
+ </button>
+ {children}
+ </div>
+ ),
+ useInstanceFormContext: () => mocks.instanceFormContext,
+}));
+
+beforeEach(async () => {
+ vi.clearAllMocks();
+ mocks.providerProps = undefined;
+ mocks.instanceFormContext.state.isRequesting = false;
+ mocks.instanceFormContext.valueChanged = false;
+ globalThis.ResizeObserver = class ResizeObserver {
+ observe() {}
+ unobserve() {}
+ disconnect() {}
+ } as typeof ResizeObserver;
+ ({ CreateInstanceView } = await import("./CreateInstanceView"));
+});
+
+describe("CreateInstanceView", () => {
+ test("keeps the scroll container flush with the page edge", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ const page = container.firstElementChild;
+ expect(page).not.toHaveClass("px-4");
+ expect(page).not.toHaveClass("sm:px-6");
+
+ const bodyPadding = container.querySelector(
+ "[data-testid='instance-form-body']"
+ )?.parentElement;
+ expect(bodyPadding).toHaveClass("px-4");
+ expect(bodyPadding).toHaveClass("sm:px-6");
+
+ const buttons = container.querySelector(
+ "[data-testid='instance-form-buttons']"
+ );
+ expect(buttons).not.toHaveClass("px-4");
+ expect(buttons).not.toHaveClass("sm:px-6");
+
+ act(() => {
+ root.unmount();
+ });
+ });
+
+ test("guards navigation when the create form has unsaved changes", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(false);
+
+ mocks.instanceFormContext.valueChanged = true;
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(true);
+
+ mocks.instanceFormContext.state.isRequesting = true;
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(false);
+
+ act(() => {
+ root.unmount();
+ });
+ });
+
+ test("uses the provided dismissal callback", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ const dismiss = container.querySelector(
+ "[data-testid='dismiss']"
+ ) as HTMLButtonElement;
+ act(() => {
+ dismiss.click();
+ });
+
+ expect(mocks.onDismiss).toHaveBeenCalledOnce();
+
+ act(() => {
+ root.unmount();
+ });
+ });
+
+ test("forwards project ownership to the form provider", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+ const project = { name: "projects/demo" };
+
+ act(() => {
+ root.render(
+ <CreateInstanceView
+ parent="projects/demo"
+ project={project as never}
+ onDismiss={mocks.onDismiss}
+ onCreated={mocks.onCreated}
+ />
+ );
+ });
+
+ expect(mocks.providerProps).toEqual({
+ parent: "projects/demo",
+ project,
+ });
+
+ act(() => {
+ root.unmount();
+ });
+ });
+});
diff --git a/frontend/src/components/instance/CreateInstanceView.tsx b/frontend/src/components/instance/CreateInstanceView.tsx
new file mode 100644
index 0000000000..d3656d85ba
--- /dev/null
+++ b/frontend/src/components/instance/CreateInstanceView.tsx
@@ -0,0 +1,197 @@
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { useTranslation } from "react-i18next";
+import {
+ InfoPanel,
+ InfoPanelContent,
+ InstanceFormBody,
+ InstanceFormButtons,
+ InstanceFormProvider,
+ useInstanceFormContext,
+} from "@/components/instance";
+import type { InfoSection } from "@/components/instance/info-content";
+import { useUnsavedChangesGuard } from "@/hooks/useUnsavedChangesGuard";
+import { pushNotification } from "@/stores";
+import { useAppStore } from "@/stores/app";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+
+const MIN_DOCKED_MAIN_WIDTH = 700;
+const DOCKED_INFO_RAIL_WIDTH = 500;
+const DOCKED_INFO_RAIL_GAP = 16;
+const MIN_DOCKED_LAYOUT_WIDTH =
+ MIN_DOCKED_MAIN_WIDTH + DOCKED_INFO_RAIL_WIDTH + DOCKED_INFO_RAIL_GAP;
+
+interface CreateInstanceViewProps {
+ parent?: string;
+ project?: Project;
+ onDismiss: () => void;
+ onCreated: (instance: Instance) => void;
+}
+
+export function CreateInstanceView({
+ parent,
+ project,
+ onDismiss,
+ onCreated,
+}: CreateInstanceViewProps) {
+ const { t } = useTranslation();
+
+ // Check instance limit on mount
+ useEffect(() => {
+ const store = useAppStore.getState();
+ if (store.instanceCountLimit() <= store.activatedInstanceCount()) {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("subscription.usage.instance-count.title"),
+ description: t("subscription.usage.instance-count.runoutof", {
+ total: store.instanceCountLimit(),
+ }),
+ });
+ onDismiss();
+ }
+ }, [onDismiss, t]);
+
+ return (
+ <div className="h-full overflow-hidden">
+ <InstanceFormProvider
+ parent={parent}
+ project={project}
+ onDismiss={onDismiss}
+ >
+ <CreateInstanceFormInner onCreated={onCreated} />
+ </InstanceFormProvider>
+ </div>
+ );
+}
+
+function CreateInstanceFormInner({
+ onCreated,
+}: {
+ onCreated: (instance: Instance) => void;
+}) {
+ const { t } = useTranslation();
+ const ctx = useInstanceFormContext();
+ const currentEngine = ctx.basicInfo.engine;
+
+ const [activeInfoSection, setActiveInfoSection] = useState<
+ InfoSection | undefined
+ >();
+ const layoutRef = useRef<HTMLDivElement>(null);
+ const [layoutWidth, setLayoutWidth] = useState(0);
+
+ useEffect(() => {
+ const el = layoutRef.current;
+ if (!el) return;
+ const observer = new ResizeObserver((entries) => {
+ for (const entry of entries) {
+ setLayoutWidth(entry.contentRect.width);
+ }
+ });
+ observer.observe(el);
+ return () => observer.disconnect();
+ }, []);
+
+ const canUseDockedInfoLayout = layoutWidth >= MIN_DOCKED_LAYOUT_WIDTH;
+ const showDockedInfoPanel = !!activeInfoSection && canUseDockedInfoLayout;
+ const showOverlayInfoPanel = !!activeInfoSection && !canUseDockedInfoLayout;
+
+ const layoutStyle = useMemo(() => {
+ if (!canUseDockedInfoLayout || !showDockedInfoPanel) {
+ return {
+ gridTemplateColumns: "minmax(0, 1fr)",
+ columnGap: "0rem",
+ };
+ }
+ return {
+ gridTemplateColumns: `minmax(${MIN_DOCKED_MAIN_WIDTH}px, 1fr) ${DOCKED_INFO_RAIL_WIDTH}px`,
+ columnGap: `${DOCKED_INFO_RAIL_GAP}px`,
+ };
+ }, [canUseDockedInfoLayout, showDockedInfoPanel]);
+
+ const infoPanelTitle = useMemo(() => {
+ if (!activeInfoSection) return "";
+ const titleMap: Record<InfoSection, string> = {
+ host: t("instance.host-or-socket"),
+ port: t("instance.port"),
+ authentication: t("instance.connection-info"),
+ ssl: t("data-source.ssl-connection"),
+ ssh: t("data-source.ssh-connection"),
+ database: t("common.database"),
+ "sync-databases": t("instance.sync-databases.sync-all"),
+ };
+ return titleMap[activeInfoSection] ?? "";
+ }, [activeInfoSection, t]);
+
+ const handleDockedInfoPanelOutsideClick = useCallback(
+ (event: React.MouseEvent) => {
+ if (!showDockedInfoPanel) return;
+ const target = event.target;
+ if (!(target instanceof Element)) return;
+ if (target.closest("[data-info-panel-docked='true']")) return;
+ setActiveInfoSection(undefined);
+ },
+ [showDockedInfoPanel]
+ );
+
+ const handleOpenInfoPanel = useCallback((section: InfoSection) => {
+ setActiveInfoSection(section);
+ }, []);
+
+ return (
+ <div
+ ref={layoutRef}
+ className="grid h-full w-full min-h-0 min-w-0"
+ style={layoutStyle}
+ onClick={handleDockedInfoPanelOutsideClick}
+ >
+ <div className="min-w-0 min-h-0 flex-1 flex flex-col">
+ {/* Body */}
+ <div className="flex-1 min-h-0 overflow-auto">
+ <div className="px-4 py-4 sm:px-6">
+ <InstanceFormBody onOpenInfoPanel={handleOpenInfoPanel} />
+ </div>
+ </div>
+
+ <InstanceFormButtons onCreated={onCreated} />
+ <UnsavedChangesGuard />
+ </div>
+
+ {/* Docked info panel */}
+ <InfoPanel
+ visible={showDockedInfoPanel}
+ mode="docked"
+ title={infoPanelTitle}
+ onClose={() => setActiveInfoSection(undefined)}
+ >
+ {activeInfoSection && (
+ <InfoPanelContent
+ engine={currentEngine}
+ section={activeInfoSection}
+ />
+ )}
+ </InfoPanel>
+
+ {/* Overlay info panel */}
+ <InfoPanel
+ visible={showOverlayInfoPanel}
+ mode="overlay"
+ title={infoPanelTitle}
+ onClose={() => setActiveInfoSection(undefined)}
+ >
+ {activeInfoSection && (
+ <InfoPanelContent
+ engine={currentEngine}
+ section={activeInfoSection}
+ />
+ )}
+ </InfoPanel>
+ </div>
+ );
+}
+
+function UnsavedChangesGuard() {
+ const { state, valueChanged } = useInstanceFormContext();
+ useUnsavedChangesGuard(valueChanged && !state.isRequesting);
+ return null;
+}
diff --git a/frontend/src/components/instance/DataSourceSection.tsx b/frontend/src/components/instance/DataSourceSection.tsx
index 46e9a75f3e..f288c20810 100644
--- a/frontend/src/components/instance/DataSourceSection.tsx
+++ b/frontend/src/components/instance/DataSourceSection.tsx
@@ -7,7 +7,6 @@ import { useAppStore } from "@/stores/app";
import { DATASOURCE_READONLY_USER_NAME } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
import { DataSourceType } from "@/types/proto-es/v1/instance_service_pb";
-import { hasWorkspacePermissionV2 } from "@/utils";
import type { EditDataSource } from "./common";
import { wrapEditDataSource } from "./common";
import { DataSourceForm } from "./DataSourceForm";
@@ -36,9 +35,10 @@ export function DataSourceSection({
editingDataSource,
readonlyDataSourceList,
hasReadOnlyDataSource,
+ hasPermission,
} = ctx;
- const allowUpdate = hasWorkspacePermissionV2("bb.instances.update");
+ const allowUpdate = hasPermission("bb.instances.update");
const handleCreateRODataSource = useCallback(() => {
if (isCreating) return;
diff --git a/frontend/src/components/instance/InstanceActionDropdown.test.tsx b/frontend/src/components/instance/InstanceActionDropdown.test.tsx
index a9178338aa..383ae8262e 100644
--- a/frontend/src/components/instance/InstanceActionDropdown.test.tsx
+++ b/frontend/src/components/instance/InstanceActionDropdown.test.tsx
@@ -5,6 +5,10 @@ import { createRoot } from "react-dom/client";
import { beforeEach, describe, expect, test, vi } from "vitest";
import { State } from "@/types/proto-es/v1/common_pb";
import { InstanceSchema } from "@/types/proto-es/v1/instance_service_pb";
+import {
+ type Project,
+ ProjectSchema,
+} from "@/types/proto-es/v1/project_service_pb";
import { InstanceActionDropdown } from "./InstanceActionDropdown";
(
@@ -19,12 +23,17 @@ globalThis.ResizeObserver ??= class ResizeObserver {
const mocks = vi.hoisted(() => ({
hasWorkspacePermissionV2: vi.fn(() => true),
+ hasInstancePermission: vi.fn(() => true),
archiveInstance: vi.fn(),
restoreInstance: vi.fn(),
deleteInstance: vi.fn(),
routerReplace: vi.fn(),
}));
+vi.mock("./permission", () => ({
+ hasInstancePermission: mocks.hasInstancePermission,
+}));
+
vi.mock("react-i18next", () => ({
initReactI18next: { type: "3rdParty", init: () => {} },
useTranslation: () => ({
@@ -60,18 +69,28 @@ vi.mock("@/utils", async () => {
};
});
-const renderMenu = async (state: State) => {
+const renderMenu = async (
+ state: State,
+ project?: Project,
+ callbacks?: { onArchived?: () => void; onDeleted?: () => void }
+) => {
const container = document.createElement("div");
document.body.appendChild(container);
const root = createRoot(container);
const instance = create(InstanceSchema, {
- name: "instances/prod",
+ name: project ? `${project.name}/instances/prod` : "instances/prod",
title: "Production",
state,
});
await act(async () => {
- root.render(<InstanceActionDropdown instance={instance} />);
+ root.render(
+ <InstanceActionDropdown
+ instance={instance}
+ project={project}
+ {...callbacks}
+ />
+ );
});
await act(async () => {
container
@@ -112,6 +131,22 @@ describe("InstanceActionDropdown", () => {
act(() => menu.root.unmount());
});
+ test("checks project permissions for a project instance", async () => {
+ const project = create(ProjectSchema, { name: "projects/app" });
+ const menu = await renderMenu(State.ACTIVE, project);
+
+ expect(mocks.hasInstancePermission).toHaveBeenCalledWith(
+ project,
+ "bb.instances.delete"
+ );
+ expect(mocks.hasInstancePermission).toHaveBeenCalledWith(
+ project,
+ "bb.instances.undelete"
+ );
+
+ act(() => menu.root.unmount());
+ });
+
test("opens the default instance list after archiving", async () => {
const confirmSpy = vi.spyOn(window, "confirm").mockReturnValue(true);
mocks.archiveInstance.mockResolvedValue(undefined);
@@ -134,6 +169,53 @@ describe("InstanceActionDropdown", () => {
act(() => menu.root.unmount());
});
+ test("uses the owner callback after archiving", async () => {
+ const confirmSpy = vi.spyOn(window, "confirm").mockReturnValue(true);
+ const onArchived = vi.fn();
+ mocks.archiveInstance.mockResolvedValue(undefined);
+ const menu = await renderMenu(State.ACTIVE, undefined, { onArchived });
+ const archiveItem = Array.from(
+ document.body.querySelectorAll("[role='menuitem']")
+ ).find((el) => el.textContent === "common.archive");
+
+ await act(async () => {
+ archiveItem?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ await Promise.resolve();
+ });
+
+ expect(onArchived).toHaveBeenCalledOnce();
+ expect(mocks.routerReplace).not.toHaveBeenCalled();
+
+ confirmSpy.mockRestore();
+ act(() => menu.root.unmount());
+ });
+
+ test("archives a project instance without force", async () => {
+ const confirmSpy = vi.spyOn(window, "confirm").mockReturnValue(true);
+ const project = create(ProjectSchema, { name: "projects/app" });
+ mocks.archiveInstance.mockResolvedValue(undefined);
+ const menu = await renderMenu(State.ACTIVE, project);
+ const archiveItem = Array.from(
+ document.body.querySelectorAll("[role='menuitem']")
+ ).find((el) => el.textContent === "common.archive");
+
+ await act(async () => {
+ archiveItem?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ await Promise.resolve();
+ });
+
+ expect(confirmSpy).toHaveBeenCalledWith(
+ expect.not.stringContaining("instance.force-archive-description")
+ );
+ expect(mocks.archiveInstance).toHaveBeenCalledWith(
+ expect.objectContaining({ name: "projects/app/instances/prod" }),
+ false
+ );
+
+ confirmSpy.mockRestore();
+ act(() => menu.root.unmount());
+ });
+
test("archives before purging an active instance after resource id confirmation", async () => {
mocks.archiveInstance.mockResolvedValue(undefined);
mocks.deleteInstance.mockResolvedValue(undefined);
@@ -208,4 +290,42 @@ describe("InstanceActionDropdown", () => {
act(() => menu.root.unmount());
});
+
+ test("archives a project instance without force before purging it", async () => {
+ mocks.archiveInstance.mockResolvedValue(undefined);
+ mocks.deleteInstance.mockResolvedValue(undefined);
+ const project = create(ProjectSchema, { name: "projects/app" });
+ const menu = await renderMenu(State.ACTIVE, project);
+ const deleteItem = Array.from(
+ document.body.querySelectorAll("[role='menuitem']")
+ ).find((el) => el.textContent === "common.delete");
+
+ await act(async () => {
+ deleteItem?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
+ });
+
+ const input = document.body.querySelector("input") as HTMLInputElement;
+ const deleteButtons = Array.from(
+ document.body.querySelectorAll("button")
+ ).filter((el) => el.textContent === "common.delete");
+ const dialogDeleteButton = deleteButtons.at(-1) as HTMLButtonElement;
+
+ await act(async () => {
+ fireEvent.change(input, { target: { value: "prod" } });
+ dialogDeleteButton.dispatchEvent(
+ new MouseEvent("click", { bubbles: true })
+ );
+ await Promise.resolve();
+ });
+
+ expect(mocks.archiveInstance).toHaveBeenCalledWith(
+ expect.objectContaining({ name: "projects/app/instances/prod" }),
+ false
+ );
+ expect(mocks.deleteInstance).toHaveBeenCalledWith(
+ "projects/app/instances/prod"
+ );
+
+ act(() => menu.root.unmount());
+ });
});
diff --git a/frontend/src/components/instance/InstanceActionDropdown.tsx b/frontend/src/components/instance/InstanceActionDropdown.tsx
index 7fab52d929..7e9645e035 100644
--- a/frontend/src/components/instance/InstanceActionDropdown.tsx
+++ b/frontend/src/components/instance/InstanceActionDropdown.tsx
@@ -13,34 +13,41 @@ import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
import { State } from "@/types/proto-es/v1/common_pb";
import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
-import { hasWorkspacePermissionV2 } from "@/utils";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
import { InstanceDeleteDialog } from "./InstanceDeleteDialog";
+import { hasInstancePermission } from "./permission";
interface InstanceActionDropdownProps {
instance: Instance;
+ project?: Project;
+ onArchived?: () => void;
onDeleted?: () => void;
}
export function InstanceActionDropdown({
instance,
+ project,
+ onArchived,
onDeleted,
}: InstanceActionDropdownProps) {
const { t } = useTranslation();
const [showDeleteConfirm, setShowDeleteConfirm] = useState(false);
- const canArchive = hasWorkspacePermissionV2("bb.instances.delete");
- const canRestore = hasWorkspacePermissionV2("bb.instances.undelete");
+ const canArchive = hasInstancePermission(project, "bb.instances.delete");
+ const canRestore = hasInstancePermission(project, "bb.instances.undelete");
const handleArchive = useCallback(async () => {
const msg = t("instance.archive-instance-instance-name", {
0: instance.title,
});
- const forceArchive = window.confirm(
- `${msg}\n\n${t("instance.archived-instances-will-not-be-displayed")}\n\n${t("instance.force-archive-description")}`
+ const confirmed = window.confirm(
+ project
+ ? `${msg}\n\n${t("instance.archived-instances-will-not-be-displayed")}`
+ : `${msg}\n\n${t("instance.archived-instances-will-not-be-displayed")}\n\n${t("instance.force-archive-description")}`
);
- if (!forceArchive) return;
+ if (!confirmed) return;
- await useAppStore.getState().archiveInstance(instance, true);
+ await useAppStore.getState().archiveInstance(instance, !project);
pushNotification({
module: "bytebase",
style: "INFO",
@@ -48,8 +55,12 @@ export function InstanceActionDropdown({
0: instance.title,
}),
});
- router.replace({ name: INSTANCE_ROUTE_DASHBOARD });
- }, [instance, t]);
+ if (onArchived) {
+ onArchived();
+ } else {
+ router.replace({ name: INSTANCE_ROUTE_DASHBOARD });
+ }
+ }, [instance, onArchived, project, t]);
const handleRestore = useCallback(async () => {
if (
@@ -107,10 +118,14 @@ export function InstanceActionDropdown({
<InstanceDeleteDialog
open={showDeleteConfirm}
instance={instance}
+ forceArchive={!project}
onOpenChange={setShowDeleteConfirm}
onDeleted={() => {
- onDeleted?.();
- router.replace({ name: INSTANCE_ROUTE_DASHBOARD });
+ if (onDeleted) {
+ onDeleted();
+ } else {
+ router.replace({ name: INSTANCE_ROUTE_DASHBOARD });
+ }
}}
/>
</>
diff --git a/frontend/src/components/instance/InstanceDashboard.test.ts b/frontend/src/components/instance/InstanceDashboard.test.ts
new file mode 100644
index 0000000000..449d333f75
--- /dev/null
+++ b/frontend/src/components/instance/InstanceDashboard.test.ts
@@ -0,0 +1,33 @@
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { describe, expect, test } from "vitest";
+
+describe("InstanceDashboard", () => {
+ test("does not expose force archive paths for project instances", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/components/instance/InstanceDashboard.tsx"),
+ "utf-8"
+ );
+
+ expect(source).toMatch(
+ /archiveInstance\(\s*instance,\s*project \? false : forceArchive\s*\)/
+ );
+ expect(source).toContain("{!project && (");
+ expect(source).toContain("forceArchive={!project}");
+ });
+
+ test("resets scoped state when the project parent changes", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/components/instance/InstanceDashboard.tsx"),
+ "utf-8"
+ );
+
+ expect(source).toContain("const previousParentRef = useRef(parent);");
+ expect(source).toContain("fetchIdRef.current += 1;");
+ expect(source).toContain("setInstances([]);");
+ expect(source).toContain('nextPageTokenRef.current = "";');
+ expect(source).toContain("setHasMore(false);");
+ expect(source).toContain("setSelectedNames(new Set());");
+ expect(source).toContain("}, [parent]);");
+ });
+});
diff --git a/frontend/src/components/instance/InstanceDashboard.tsx b/frontend/src/components/instance/InstanceDashboard.tsx
new file mode 100644
index 0000000000..9d1913235e
--- /dev/null
+++ b/frontend/src/components/instance/InstanceDashboard.tsx
@@ -0,0 +1,1281 @@
+import { create } from "@bufbuild/protobuf";
+import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
+import {
+ ChevronDown,
+ ChevronUp,
+ EllipsisVertical,
+ GraduationCap,
+ Plus,
+ RefreshCw,
+ SquareStack,
+} from "lucide-react";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { useTranslation } from "react-i18next";
+import { router, useCurrentRoute } from "@/app/router";
+import { useListScrollRestorationLoadMore } from "@/app/router/NavigationScrollRestoration";
+import {
+ AdvancedSearch,
+ getValueFromScopes,
+ type ScopeOption,
+ type SearchParams,
+} from "@/components/AdvancedSearch";
+import { EngineIcon } from "@/components/EngineIcon";
+import { EnvironmentLabel } from "@/components/EnvironmentLabel";
+import { InstanceAssignmentSheet } from "@/components/InstanceAssignmentSheet";
+import { InstanceDeleteDialog } from "@/components/instance";
+import { PermissionGuard } from "@/components/PermissionGuard";
+import {
+ ProjectPageContent,
+ ProjectPageFooter,
+ ProjectPageToolbar,
+} from "@/components/ProjectPageLayout";
+import {
+ type SelectionAction,
+ SelectionActionBar,
+} from "@/components/SelectionActionBar";
+import { Alert } from "@/components/ui/alert";
+import {
+ AlertDialog,
+ AlertDialogContent,
+ AlertDialogDescription,
+ AlertDialogTitle,
+} from "@/components/ui/alert-dialog";
+import { Badge } from "@/components/ui/badge";
+import { Button } from "@/components/ui/button";
+import { Checkbox } from "@/components/ui/checkbox";
+import {
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+} from "@/components/ui/dropdown-menu";
+import { EllipsisText } from "@/components/ui/ellipsis-text";
+import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group";
+import {
+ Sheet,
+ SheetBody,
+ SheetContent,
+ SheetFooter,
+ SheetHeader,
+ SheetTitle,
+} from "@/components/ui/sheet";
+import {
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableRow,
+} from "@/components/ui/table";
+import {
+ WorkspacePageContent,
+ WorkspacePageFooter,
+ WorkspacePageToolbar,
+} from "@/components/WorkspacePageLayout";
+import { useColumnWidths } from "@/hooks/useColumnWidths";
+import { PagedTableFooter } from "@/hooks/usePagedData";
+import {
+ getPageSizeOptions,
+ useSessionPageSize,
+} from "@/hooks/useSessionPageSize";
+import {
+ createAdvancedSearchParser,
+ serializeAdvancedSearch,
+ useURLSearchParam,
+} from "@/hooks/useURLSearchParam";
+import {
+ CREATE_INSTANCE_PRODUCT_INTRO,
+ useProductIntro,
+} from "@/lib/productIntro";
+import {
+ defaultActiveStateSearchParams,
+ getResourceStateFilter,
+} from "@/lib/resourceStateFilter";
+import { cn } from "@/lib/utils";
+import { pushNotification } from "@/stores";
+import { useAppStore } from "@/stores/app";
+import type { InstanceFilter } from "@/stores/app/types";
+import { environmentNamePrefix } from "@/stores/modules/v1/common";
+import {
+ DEFAULT_ENVIRONMENT_COLOR,
+ isValidInstanceName,
+ UNKNOWN_ENVIRONMENT_NAME,
+ unknownEnvironment,
+} from "@/types";
+import { Engine, State } from "@/types/proto-es/v1/common_pb";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+import { UpdateInstanceRequestSchema } from "@/types/proto-es/v1/instance_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import {
+ engineNameV1,
+ hostPortOfDataSource,
+ hostPortOfInstanceV1,
+ supportedEngineV1List,
+} from "@/utils";
+import { hasInstancePermission } from "./permission";
+
+const ASSIGN_LICENSE_QUERY = "assignLicense";
+const ASSIGN_LICENSE_INSTANCES_QUERY = "instances";
+const parseInstanceSearch = createAdvancedSearchParser([
+ "environment",
+ "engine",
+ "label",
+ "state",
+ "host",
+ "port",
+]);
+
+interface InstanceColumn {
+ key: string;
+ title: React.ReactNode;
+ defaultWidth: number;
+ minWidth?: number;
+ resizable?: boolean;
+ sortable?: boolean;
+ sortKey?: string;
+ cellClassName?: string;
+ render: (instance: Instance) => React.ReactNode;
+ onCellClick?: (instance: Instance, e: React.MouseEvent) => void;
+ onHeaderClick?: (e: React.MouseEvent) => void;
+}
+
+export interface InstanceDashboardProps {
+ parent?: string;
+ project?: Project;
+ layout: "workspace" | "project";
+ onCreate: () => void;
+ onOpen: (instance: Instance, event: React.MouseEvent) => void;
+}
+
+// ============================================================
+// ConfirmDialog
+// ============================================================
+
+function ConfirmDialog({
+ open,
+ variant,
+ title,
+ description,
+ okText,
+ onOk,
+ onCancel,
+ children,
+}: {
+ open: boolean;
+ variant: "warning" | "error";
+ title: string;
+ description: string;
+ okText: string;
+ onOk: () => void;
+ onCancel: () => void;
+ children?: React.ReactNode;
+}) {
+ const { t } = useTranslation();
+
+ if (!open) return null;
+
+ const borderColor = variant === "error" ? "border-error" : "border-warning";
+ const okClassName =
+ variant === "warning"
+ ? "bg-warning text-accent-text hover:bg-warning-hover"
+ : undefined;
+
+ return (
+ <AlertDialog open onOpenChange={(nextOpen) => !nextOpen && onCancel()}>
+ <AlertDialogContent className={cn("max-w-lg border-t-4", borderColor)}>
+ <AlertDialogTitle>{title}</AlertDialogTitle>
+ <AlertDialogDescription className="mt-2">
+ {description}
+ </AlertDialogDescription>
+ {children && <div className="mt-4">{children}</div>}
+ <div className="mt-6 flex justify-end gap-x-2">
+ <Button appearance="outline" onClick={onCancel}>
+ {t("common.cancel")}
+ </Button>
+ <Button
+ variant={variant === "error" ? "destructive" : "default"}
+ className={okClassName}
+ onClick={onOk}
+ >
+ {okText}
+ </Button>
+ </div>
+ </AlertDialogContent>
+ </AlertDialog>
+ );
+}
+
+// ============================================================
+// InstanceActionDropdown
+// ============================================================
+
+function InstanceActionDropdown({
+ instance,
+ project,
+ onAction,
+}: {
+ instance: Instance;
+ project?: Project;
+ onAction: () => void;
+}) {
+ const { t } = useTranslation();
+ const [showArchiveConfirm, setShowArchiveConfirm] = useState(false);
+ const [showDeleteConfirm, setShowDeleteConfirm] = useState(false);
+ const [forceArchive, setForceArchive] = useState(false);
+
+ const canArchive = hasInstancePermission(project, "bb.instances.delete");
+ const canRestore = hasInstancePermission(project, "bb.instances.undelete");
+
+ const handleArchive = useCallback(async () => {
+ try {
+ await useAppStore
+ .getState()
+ .archiveInstance(instance, project ? false : forceArchive);
+ pushNotification({
+ module: "bytebase",
+ style: "INFO",
+ title: t("instance.successfully-archived-instance", {
+ 0: instance.title,
+ }),
+ });
+ setShowArchiveConfirm(false);
+ setForceArchive(false);
+ onAction();
+ } catch (error: unknown) {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.archive"),
+ description: (error as { message?: string }).message,
+ });
+ }
+ }, [instance, project, forceArchive, t, onAction]);
+
+ const handleRestore = useCallback(async () => {
+ try {
+ await useAppStore.getState().restoreInstance(instance);
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("instance.successfully-restored-instance", {
+ 0: instance.title,
+ }),
+ });
+ onAction();
+ } catch (error: unknown) {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.restore"),
+ description: (error as { message?: string }).message,
+ });
+ }
+ }, [instance, t, onAction]);
+
+ if (!canArchive && !canRestore) return null;
+
+ const isActive = instance.state === State.ACTIVE;
+
+ return (
+ <>
+ <DropdownMenu>
+ <DropdownMenuTrigger
+ className="p-1 rounded-xs hover:bg-control-bg outline-hidden"
+ onClick={(e) => e.stopPropagation()}
+ >
+ <EllipsisVertical className="h-4 w-4" />
+ </DropdownMenuTrigger>
+ <DropdownMenuContent>
+ {isActive && canArchive && (
+ <DropdownMenuItem
+ onClick={(e) => {
+ e.stopPropagation();
+ setShowArchiveConfirm(true);
+ }}
+ >
+ {t("common.archive")}
+ </DropdownMenuItem>
+ )}
+ {!isActive && canRestore && (
+ <DropdownMenuItem
+ onClick={(e) => {
+ e.stopPropagation();
+ handleRestore();
+ }}
+ >
+ {t("common.restore")}
+ </DropdownMenuItem>
+ )}
+ {canArchive && (
+ <DropdownMenuItem
+ className="text-error"
+ onClick={(e) => {
+ e.stopPropagation();
+ setShowDeleteConfirm(true);
+ }}
+ >
+ {t("common.delete")}
+ </DropdownMenuItem>
+ )}
+ </DropdownMenuContent>
+ </DropdownMenu>
+
+ <ConfirmDialog
+ open={showArchiveConfirm}
+ variant="warning"
+ title={t("instance.archive-instance-instance-name", {
+ 0: instance.title,
+ })}
+ description={t("instance.archived-instances-will-not-be-displayed")}
+ okText={t("common.archive")}
+ onOk={handleArchive}
+ onCancel={() => {
+ setShowArchiveConfirm(false);
+ setForceArchive(false);
+ }}
+ >
+ {!project && (
+ <label className="flex items-center gap-x-2 text-sm text-control-light mt-2">
+ <Checkbox
+ checked={forceArchive}
+ onCheckedChange={(checked) => setForceArchive(checked)}
+ />
+ {t("instance.force-archive-description")}
+ </label>
+ )}
+ </ConfirmDialog>
+
+ <InstanceDeleteDialog
+ open={showDeleteConfirm}
+ instance={instance}
+ forceArchive={!project}
+ onOpenChange={setShowDeleteConfirm}
+ onDeleted={onAction}
+ />
+ </>
+ );
+}
+
+// ============================================================
+// LabelsDisplay
+// ============================================================
+
+function LabelsDisplay({ labels }: { labels: { [key: string]: string } }) {
+ const entries = Object.entries(labels);
+ if (entries.length === 0)
+ return <span className="text-control-placeholder">-</span>;
+
+ const displayEntries = entries.slice(0, 3);
+ const hasMore = entries.length > 3;
+
+ return (
+ <div className="flex items-center gap-x-1">
+ {displayEntries.map(([key, value]) => (
+ <span
+ key={key}
+ className="rounded-xs bg-control-bg py-0.5 px-2 text-sm"
+ >
+ {key}:{value}
+ </span>
+ ))}
+ {hasMore && <span>...</span>}
+ </div>
+ );
+}
+
+// ============================================================
+// EditEnvironmentSheet
+// ============================================================
+
+function EditEnvironmentSheet({
+ open,
+ onClose,
+ onUpdate,
+}: {
+ open: boolean;
+ onClose: () => void;
+ onUpdate: (environment: string) => Promise<void>;
+}) {
+ const { t } = useTranslation();
+ const environments = useAppStore((s) => s.environmentList ?? []);
+ const [selected, setSelected] = useState("");
+ useEffect(() => {
+ if (open) setSelected("");
+ }, [open]);
+
+ return (
+ <Sheet open={open} onOpenChange={(next) => !next && onClose()}>
+ <SheetContent width="narrow">
+ <SheetHeader>
+ <SheetTitle>{t("common.environment")}</SheetTitle>
+ </SheetHeader>
+ <SheetBody>
+ <RadioGroup
+ className="flex-col items-stretch gap-y-2"
+ value={selected}
+ onValueChange={(value) => setSelected(value as string)}
+ >
+ {environments.map((env) => (
+ <RadioGroupItem
+ key={env.name}
+ value={env.name}
+ className={cn(
+ "flex items-center gap-x-3 px-3 py-2 rounded-xs cursor-pointer border",
+ selected === env.name
+ ? "border-accent bg-accent/5"
+ : "border-transparent hover:bg-control-bg"
+ )}
+ >
+ <div className="flex items-center gap-x-2">
+ <span
+ className="inline-block size-3 rounded-full"
+ style={{
+ backgroundColor: env.color || DEFAULT_ENVIRONMENT_COLOR,
+ }}
+ />
+ <span>{env.title}</span>
+ </div>
+ </RadioGroupItem>
+ ))}
+ </RadioGroup>
+ </SheetBody>
+ <SheetFooter>
+ <Button appearance="secondary" onClick={onClose}>
+ {t("common.cancel")}
+ </Button>
+ <Button
+ disabled={!selected}
+ onClick={async () => {
+ await onUpdate(selected);
+ onClose();
+ }}
+ >
+ {t("common.update")}
+ </Button>
+ </SheetFooter>
+ </SheetContent>
+ </Sheet>
+ );
+}
+
+// ============================================================
+// InstancesPage (main)
+// ============================================================
+
+export function InstanceDashboard({
+ parent,
+ project,
+ layout,
+ onCreate,
+ onOpen,
+}: InstanceDashboardProps) {
+ const { t } = useTranslation();
+ const route = useCurrentRoute();
+
+ const defaultSearchParams = useMemo<SearchParams>(
+ () => defaultActiveStateSearchParams(route.query.state),
+ [route.query.state]
+ );
+ const [searchParams, setSearchParams] = useURLSearchParam<SearchParams>({
+ param: "q",
+ parse: parseInstanceSearch,
+ serialize: serializeAdvancedSearch,
+ defaultValue: defaultSearchParams,
+ });
+
+ // Scope options
+ const canUndelete = hasInstancePermission(project, "bb.instances.undelete");
+ const environments = useAppStore((s) => s.environmentList ?? []);
+ const scopeOptions: ScopeOption[] = useMemo(() => {
+ const options: ScopeOption[] = [
+ {
+ id: "environment",
+ title: t("common.environment"),
+ description: t("issue.advanced-search.scope.environment.description"),
+ options: [unknownEnvironment(), ...environments].map((env) => {
+ const isUnknown = env.name === UNKNOWN_ENVIRONMENT_NAME;
+ return {
+ value: env.id,
+ keywords: isUnknown
+ ? ["unassigned", "none", env.id]
+ : [env.id, env.title],
+ custom: true,
+ render: () => <EnvironmentLabel environment={env} />,
+ };
+ }),
+ },
+ {
+ id: "engine",
+ title: t("database.engine"),
+ description: t("issue.advanced-search.scope.engine.description"),
+ options: supportedEngineV1List().map((engine) => ({
+ value: Engine[engine],
+ keywords: [Engine[engine].toLowerCase(), engineNameV1(engine)],
+ custom: true,
+ render: () => (
+ <span className="inline-flex items-center gap-x-1.5">
+ <EngineIcon engine={engine} className="h-4 w-4" />
+ <span>{engineNameV1(engine)}</span>
+ </span>
+ ),
+ })),
+ allowMultiple: true,
+ },
+ {
+ id: "label",
+ title: t("common.labels"),
+ description: t("issue.advanced-search.scope.label.description"),
+ allowMultiple: true,
+ },
+ {
+ id: "state",
+ title: t("common.state"),
+ description: t("issue.advanced-search.scope.state.description"),
+ options: [
+ {
+ value: "ACTIVE",
+ keywords: ["active"],
+ custom: true,
+ render: () => <span>{t("common.active")}</span>,
+ },
+ ...(canUndelete
+ ? [
+ {
+ value: "DELETED",
+ keywords: ["archived", "deleted"],
+ custom: true,
+ render: () => <span>{t("common.archived")}</span>,
+ },
+ {
+ value: "ALL",
+ keywords: ["all"],
+ custom: true,
+ render: () => <span>{t("common.all")}</span>,
+ },
+ ]
+ : []),
+ ],
+ },
+ {
+ id: "host",
+ title: t("instance.advanced-search.scope.host.title"),
+ description: t("instance.advanced-search.scope.host.description"),
+ },
+ {
+ id: "port",
+ title: t("instance.advanced-search.scope.port.title"),
+ description: t("instance.advanced-search.scope.port.description"),
+ },
+ ];
+ return options;
+ }, [t, canUndelete, environments]);
+
+ // Derived filter values — trivial lookups, no memo needed
+ const searchText = searchParams.query;
+
+ const stateFilterVal = getValueFromScopes(searchParams, "state");
+ const selectedState = getResourceStateFilter(stateFilterVal);
+
+ const envVal = getValueFromScopes(searchParams, "environment");
+ const selectedEnvironment = envVal
+ ? `${environmentNamePrefix}${envVal}`
+ : undefined;
+
+ const selectedHost = getValueFromScopes(searchParams, "host") || undefined;
+ const selectedPort = getValueFromScopes(searchParams, "port") || undefined;
+
+ const selectedEngines = useMemo(
+ () =>
+ searchParams.scopes
+ .filter((s) => s.id === "engine")
+ .map((s) => Engine[s.value as keyof typeof Engine])
+ .filter((e): e is Engine => e !== undefined),
+ [searchParams]
+ );
+
+ const selectedLabels = useMemo(
+ () =>
+ searchParams.scopes.filter((s) => s.id === "label").map((s) => s.value),
+ [searchParams]
+ );
+
+ // Mark instance visit on mount
+ useEffect(() => {
+ const store = useAppStore.getState();
+ if (!store.getIntroStateByKey("instance.visit")) {
+ store.saveIntroStateByKey({
+ key: "instance.visit",
+ newState: true,
+ });
+ }
+ }, []);
+
+ // Instance count warning
+ const instanceCountLimit = useAppStore((s) => s.instanceCountLimit());
+ const totalInstanceCount = useAppStore((s) => s.totalInstanceCount());
+ const hasSplitInstanceLicense = useAppStore((s) =>
+ s.hasSplitInstanceLicense()
+ );
+ const quotaExhausted = totalInstanceCount >= instanceCountLimit;
+
+ // Data fetching
+ const [instances, setInstances] = useState<Instance[]>([]);
+ const [loading, setLoading] = useState(true);
+ const nextPageTokenRef = useRef("");
+ const [hasMore, setHasMore] = useState(false);
+ const [isFetchingMore, setIsFetchingMore] = useState(false);
+ const [pageSize, setPageSize] = useSessionPageSize("bb.instance-table");
+ const fetchIdRef = useRef(0);
+ const previousParentRef = useRef(parent);
+
+ // Sort state
+ const [sortKey, setSortKey] = useState<string | null>(null);
+ const [sortOrder, setSortOrder] = useState<"asc" | "desc">("asc");
+
+ const orderBy = sortKey ? `${sortKey} ${sortOrder}` : "";
+
+ const toggleSort = useCallback(
+ (key: string) => {
+ if (sortKey === key) {
+ if (sortOrder === "asc") setSortOrder("desc");
+ else {
+ setSortKey(null);
+ setSortOrder("asc");
+ }
+ } else {
+ setSortKey(key);
+ setSortOrder("asc");
+ }
+ },
+ [sortKey, sortOrder]
+ );
+
+ const filter: InstanceFilter = useMemo(
+ () => ({
+ environment: selectedEnvironment,
+ host: selectedHost,
+ port: selectedPort,
+ query: searchText,
+ engines: selectedEngines,
+ labels: selectedLabels.length > 0 ? selectedLabels : undefined,
+ state: selectedState,
+ }),
+ [
+ selectedEnvironment,
+ selectedHost,
+ selectedPort,
+ searchText,
+ selectedEngines,
+ selectedLabels,
+ selectedState,
+ ]
+ );
+
+ const fetchInstances = useCallback(
+ async (isRefresh: boolean) => {
+ const currentFetchId = ++fetchIdRef.current;
+
+ if (isRefresh) {
+ setLoading(true);
+ } else {
+ setIsFetchingMore(true);
+ }
+
+ try {
+ const token = isRefresh ? "" : nextPageTokenRef.current;
+ const result = await useAppStore.getState().fetchInstanceList({
+ parent,
+ pageToken: token,
+ pageSize,
+ filter,
+ orderBy,
+ });
+
+ if (currentFetchId !== fetchIdRef.current) return;
+
+ if (isRefresh) {
+ setInstances(result.instances);
+ } else {
+ setInstances((prev) => [...prev, ...result.instances]);
+ }
+ nextPageTokenRef.current = result.nextPageToken ?? "";
+ setHasMore(Boolean(result.nextPageToken));
+ } catch (e) {
+ if (e instanceof Error && e.name === "AbortError") return;
+ console.error(e);
+ } finally {
+ if (currentFetchId === fetchIdRef.current) {
+ setLoading(false);
+ setIsFetchingMore(false);
+ }
+ }
+ },
+ [parent, pageSize, filter, orderBy]
+ );
+
+ // Fetch on mount + re-fetch on filter/sort/pageSize changes
+ const isFirstLoad = useRef(true);
+ useEffect(() => {
+ if (isFirstLoad.current) {
+ isFirstLoad.current = false;
+ fetchInstances(true);
+ return;
+ }
+ const timer = setTimeout(() => fetchInstances(true), 300);
+ return () => clearTimeout(timer);
+ }, [fetchInstances]);
+
+ const loadMore = useCallback(() => {
+ if (nextPageTokenRef.current && !isFetchingMore) {
+ fetchInstances(false);
+ }
+ }, [isFetchingMore, fetchInstances]);
+ useListScrollRestorationLoadMore({
+ dataList: instances,
+ hasMore,
+ isFetchingMore,
+ isLoading: loading,
+ loadMore,
+ });
+
+ // Selection state
+ const [selectedNames, setSelectedNames] = useState<Set<string>>(new Set());
+
+ useEffect(() => {
+ if (previousParentRef.current === parent) return;
+ previousParentRef.current = parent;
+ fetchIdRef.current += 1;
+ setInstances([]);
+ nextPageTokenRef.current = "";
+ setHasMore(false);
+ setIsFetchingMore(false);
+ setLoading(true);
+ setSelectedNames(new Set());
+ }, [parent]);
+
+ const selectedInstanceList = useMemo(() => {
+ if (selectedNames.size === 0) return [];
+ return Array.from(selectedNames)
+ .filter((name) => isValidInstanceName(name))
+ .map((name) => useAppStore.getState().getInstanceByName(name));
+ }, [selectedNames]);
+
+ const toggleSelection = useCallback((name: string) => {
+ setSelectedNames((prev) => {
+ const next = new Set(prev);
+ if (next.has(name)) next.delete(name);
+ else next.add(name);
+ return next;
+ });
+ }, []);
+
+ const toggleSelectAll = useCallback(() => {
+ setSelectedNames((prev) => {
+ if (prev.size === instances.length) return new Set();
+ return new Set(instances.map((i) => i.name));
+ });
+ }, [instances]);
+
+ // Batch operations — all mutation logic lives here in the parent
+ const [syncing, setSyncing] = useState(false);
+ const [showEditEnvDrawer, setShowEditEnvDrawer] = useState(false);
+ const [showAssignLicenseSheet, setShowAssignLicenseSheet] = useState(false);
+ const [assignLicenseNames, setAssignLicenseNames] = useState<string[]>([]);
+
+ const handleSync = useCallback(
+ async (enableFullSync: boolean) => {
+ setSyncing(true);
+ try {
+ await useAppStore
+ .getState()
+ .batchSyncInstances(
+ Array.from(selectedNames),
+ enableFullSync,
+ parent
+ );
+ pushNotification({
+ module: "bytebase",
+ style: "INFO",
+ title: t("db.start-to-sync-schema"),
+ });
+ } finally {
+ setSyncing(false);
+ }
+ },
+ [parent, selectedNames, t]
+ );
+
+ const handleEnvironmentUpdate = useCallback(
+ async (environment: string) => {
+ try {
+ await useAppStore.getState().batchUpdateInstances(
+ selectedInstanceList.map((instance) =>
+ create(UpdateInstanceRequestSchema, {
+ instance: { ...instance, environment },
+ updateMask: create(FieldMaskSchema, { paths: ["environment"] }),
+ })
+ ),
+ parent
+ );
+ // Re-fetch the full list to get fresh data
+ fetchInstances(true);
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("common.updated"),
+ });
+ } catch (error: unknown) {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.environment"),
+ description: (error as { message?: string }).message,
+ });
+ }
+ },
+ [parent, selectedInstanceList, t, fetchInstances]
+ );
+
+ const handleRowAction = useCallback(() => {
+ fetchInstances(true);
+ setSelectedNames(new Set());
+ }, [fetchInstances]);
+
+ const handleAssignLicense = useCallback(
+ (names: string[]) => {
+ if (!hasSplitInstanceLicense) {
+ return;
+ }
+ setAssignLicenseNames(names);
+ setShowAssignLicenseSheet(true);
+ },
+ [hasSplitInstanceLicense]
+ );
+
+ // Depend on the two primitive params, not `route.query` — the route object
+ // is rebuilt every render, which would re-run this effect each time.
+ const assignLicenseFlag = route.query[ASSIGN_LICENSE_QUERY];
+ const rawAssignLicenseInstances = route.query[ASSIGN_LICENSE_INSTANCES_QUERY];
+ useEffect(() => {
+ if (layout !== "workspace" || assignLicenseFlag !== "1") {
+ return;
+ }
+
+ const names =
+ typeof rawAssignLicenseInstances === "string"
+ ? rawAssignLicenseInstances.split(",").filter(Boolean)
+ : [];
+ handleAssignLicense(names);
+
+ const nextQuery = { ...router.currentRoute.value.query };
+ delete nextQuery[ASSIGN_LICENSE_QUERY];
+ delete nextQuery[ASSIGN_LICENSE_INSTANCES_QUERY];
+ router.replace({ query: nextQuery });
+ }, [
+ assignLicenseFlag,
+ rawAssignLicenseInstances,
+ handleAssignLicense,
+ layout,
+ ]);
+
+ // Data source toggle
+ const [expandedDataSources, setExpandedDataSources] = useState<Set<string>>(
+ new Set()
+ );
+
+ const toggleDataSource = useCallback((name: string) => {
+ setExpandedDataSources((prev) => {
+ const next = new Set(prev);
+ if (next.has(name)) next.delete(name);
+ else next.add(name);
+ return next;
+ });
+ }, []);
+
+ const activatedInstanceCount = useAppStore((s) => s.activatedInstanceCount());
+ const navigateToCreate = useCallback(() => {
+ if (instanceCountLimit <= activatedInstanceCount) {
+ // Limit reached — the warning banner is already visible
+ return;
+ }
+ onCreate();
+ }, [instanceCountLimit, activatedInstanceCount, onCreate]);
+
+ const handleRowClick = useCallback(
+ (instance: Instance, e: React.MouseEvent) => {
+ onOpen(instance, e);
+ },
+ [onOpen]
+ );
+
+ const canCreate = hasInstancePermission(project, "bb.instances.create");
+ useProductIntro({
+ id: CREATE_INSTANCE_PRODUCT_INTRO,
+ title: t("workspace-setup-guide.intro.instance-title"),
+ description: t("workspace-setup-guide.intro.instance-description"),
+ disabled: layout === "project" || !canCreate,
+ });
+ const allSelected =
+ instances.length > 0 && selectedNames.size === instances.length;
+ const someSelected =
+ selectedNames.size > 0 && selectedNames.size < instances.length;
+ const pageSizeOptions = getPageSizeOptions();
+
+ const columns: InstanceColumn[] = [
+ {
+ key: "select",
+ title: (
+ <Checkbox
+ checked={someSelected ? "indeterminate" : allSelected}
+ onCheckedChange={toggleSelectAll}
+ onClick={(e) => e.stopPropagation()}
+ />
+ ),
+ defaultWidth: 48,
+ cellClassName: "px-4 py-2",
+ onCellClick: (instance, e) => {
+ e.stopPropagation();
+ toggleSelection(instance.name);
+ },
+ onHeaderClick: (e) => {
+ e.stopPropagation();
+ toggleSelectAll();
+ },
+ render: (instance) => (
+ <Checkbox
+ checked={selectedNames.has(instance.name)}
+ onCheckedChange={() => toggleSelection(instance.name)}
+ onClick={(e) => e.stopPropagation()}
+ />
+ ),
+ },
+ {
+ key: "title",
+ title: t("common.name"),
+ defaultWidth: 280,
+ minWidth: 160,
+ resizable: true,
+ sortable: true,
+ render: (instance) => (
+ <div className="flex items-center gap-x-2 min-w-0">
+ <EngineIcon engine={instance.engine} className="h-5 w-5" />
+ <EllipsisText text={instance.title} />
+ </div>
+ ),
+ },
+ {
+ key: "environment",
+ title: t("common.environment"),
+ defaultWidth: 220,
+ minWidth: 120,
+ resizable: true,
+ sortable: true,
+ render: (instance) => (
+ <EnvironmentLabel environmentName={instance.environment ?? ""} />
+ ),
+ },
+ {
+ key: "state",
+ title: t("common.state"),
+ defaultWidth: 120,
+ minWidth: 100,
+ resizable: true,
+ render: (instance) =>
+ instance.state === State.DELETED ? (
+ <Badge variant="warning" className="text-xs">
+ {t("common.archived")}
+ </Badge>
+ ) : (
+ <Badge variant="success" className="text-xs">
+ {t("common.active")}
+ </Badge>
+ ),
+ },
+ {
+ key: "address",
+ title: t("common.address"),
+ defaultWidth: 280,
+ minWidth: 150,
+ resizable: true,
+ render: (instance) => {
+ const isExpanded = expandedDataSources.has(instance.name);
+ const hasMultipleDS = instance.dataSources.length > 1;
+ return (
+ <div className="flex items-start gap-x-2">
+ <span className="truncate">
+ {isExpanded
+ ? instance.dataSources.map((ds, idx) => (
+ <div key={idx}>{hostPortOfDataSource(ds)}</div>
+ ))
+ : hostPortOfInstanceV1(instance)}
+ </span>
+ {hasMultipleDS && (
+ <Button
+ type="button"
+ appearance="secondary"
+ size="xs"
+ className="size-5 shrink-0 p-0"
+ onClick={(e) => {
+ e.stopPropagation();
+ toggleDataSource(instance.name);
+ }}
+ >
+ {isExpanded ? (
+ <ChevronUp className="w-4 h-4" />
+ ) : (
+ <ChevronDown className="w-4 h-4" />
+ )}
+ </Button>
+ )}
+ </div>
+ );
+ },
+ },
+ {
+ key: "labels",
+ title: t("common.labels"),
+ defaultWidth: 240,
+ minWidth: 150,
+ resizable: true,
+ render: (instance) => <LabelsDisplay labels={instance.labels} />,
+ },
+ {
+ key: "license",
+ title: t("subscription.instance-assignment.license"),
+ defaultWidth: 100,
+ render: (instance) => (instance.activation ? "Y" : ""),
+ },
+ {
+ key: "actions",
+ title: "",
+ defaultWidth: 50,
+ render: (instance) => (
+ <div className="flex justify-end" onClick={(e) => e.stopPropagation()}>
+ <InstanceActionDropdown
+ instance={instance}
+ project={project}
+ onAction={handleRowAction}
+ />
+ </div>
+ ),
+ },
+ ];
+
+ const { widths, totalWidth, onResizeStart } = useColumnWidths(columns);
+ const PageToolbar =
+ layout === "project" ? ProjectPageToolbar : WorkspacePageToolbar;
+ const PageContent =
+ layout === "project" ? ProjectPageContent : WorkspacePageContent;
+ const PageFooter =
+ layout === "project" ? ProjectPageFooter : WorkspacePageFooter;
+
+ return (
+ <>
+ {/* Instance count warning */}
+ {quotaExhausted && (
+ <Alert
+ variant="warning"
+ className={cn(layout === "workspace" && "mb-4")}
+ title={t("subscription.usage.instance-count.title")}
+ description={t("subscription.usage.instance-count.runoutof", {
+ total: instanceCountLimit,
+ })}
+ />
+ )}
+
+ {/* Header: Search + Create */}
+ <PageToolbar className={cn(layout === "workspace" && "px-4")}>
+ <AdvancedSearch
+ params={searchParams}
+ scopeOptions={scopeOptions}
+ placeholder={t("instance.filter-instance-name")}
+ onParamsChange={setSearchParams}
+ />
+ <PermissionGuard
+ permissions={["bb.instances.create"]}
+ project={project}
+ >
+ <Button
+ data-product-intro-target={CREATE_INSTANCE_PRODUCT_INTRO}
+ disabled={!canCreate}
+ onClick={navigateToCreate}
+ >
+ <Plus className="h-4 w-4 mr-1" />
+ {t("instance.connect-instance")}
+ </Button>
+ </PermissionGuard>
+ </PageToolbar>
+
+ <PageContent className="overflow-x-auto border rounded-sm">
+ <Table className="table-fixed" style={{ minWidth: `${totalWidth}px` }}>
+ <colgroup>
+ {widths.map((w, i) => (
+ <col key={columns[i].key} style={{ width: `${w}px` }} />
+ ))}
+ </colgroup>
+ <TableHeader>
+ <TableRow className="bg-control-bg">
+ {columns.map((col, colIdx) => (
+ <TableHead
+ key={col.key}
+ sortable={col.sortable}
+ sortActive={
+ col.sortable && sortKey === (col.sortKey ?? col.key)
+ }
+ sortDir={sortOrder}
+ onSort={
+ col.sortable
+ ? () => toggleSort(col.sortKey ?? col.key)
+ : undefined
+ }
+ resizable={col.resizable}
+ onResizeStart={
+ col.resizable ? (e) => onResizeStart(colIdx, e) : undefined
+ }
+ className={cn(col.onHeaderClick && "cursor-pointer")}
+ onClick={col.onHeaderClick}
+ >
+ {col.title}
+ </TableHead>
+ ))}
+ </TableRow>
+ </TableHeader>
+ <TableBody>
+ {loading && instances.length === 0 ? (
+ <TableRow>
+ <TableCell
+ colSpan={columns.length}
+ className="px-4 py-8 text-center text-control-placeholder"
+ >
+ <div className="flex items-center justify-center gap-x-2">
+ <div className="animate-spin size-4 border-2 border-accent border-t-transparent rounded-full" />
+ {t("common.loading")}
+ </div>
+ </TableCell>
+ </TableRow>
+ ) : instances.length === 0 ? (
+ <TableRow>
+ <TableCell
+ colSpan={columns.length}
+ className="px-4 py-8 text-center text-control-placeholder"
+ >
+ {t("common.no-data")}
+ </TableCell>
+ </TableRow>
+ ) : (
+ instances.map((instance) => (
+ <TableRow
+ key={instance.name}
+ className="cursor-pointer"
+ onClick={(e) => handleRowClick(instance, e)}
+ >
+ {columns.map((col) => (
+ <TableCell
+ key={col.key}
+ className={cn(
+ "overflow-hidden",
+ col.cellClassName,
+ col.onCellClick && "cursor-pointer"
+ )}
+ onClick={
+ col.onCellClick
+ ? (e) => col.onCellClick!(instance, e)
+ : undefined
+ }
+ >
+ {col.render(instance)}
+ </TableCell>
+ ))}
+ </TableRow>
+ ))
+ )}
+ </TableBody>
+ </Table>
+ </PageContent>
+
+ <PageFooter>
+ <PagedTableFooter
+ pageSize={pageSize}
+ pageSizeOptions={pageSizeOptions}
+ onPageSizeChange={setPageSize}
+ hasMore={hasMore}
+ isFetchingMore={isFetchingMore}
+ onLoadMore={loadMore}
+ />
+ </PageFooter>
+
+ {/* Batch operations bar is fixed within the visible main content. */}
+ {(() => {
+ const canSync = hasInstancePermission(project, "bb.instances.sync");
+ const canUpdate = hasInstancePermission(project, "bb.instances.update");
+ const syncDisabled = !canSync || syncing;
+ const instanceActions: SelectionAction[] = [
+ {
+ key: "sync-new",
+ label: syncing
+ ? t("instance.syncing")
+ : t("instance.sync.sync-new"),
+ icon: RefreshCw,
+ onClick: () => handleSync(false),
+ disabled: syncDisabled,
+ },
+ {
+ key: "sync-all",
+ label: t("instance.sync.sync-all"),
+ icon: RefreshCw,
+ onClick: () => handleSync(true),
+ disabled: syncDisabled,
+ },
+ {
+ key: "edit-env",
+ label: t("database.edit-environment"),
+ icon: SquareStack,
+ onClick: () => setShowEditEnvDrawer(true),
+ disabled: !canUpdate,
+ },
+ {
+ key: "assign-license",
+ label: t("subscription.instance-assignment.assign-license"),
+ icon: GraduationCap,
+ onClick: () =>
+ handleAssignLicense(
+ selectedInstanceList.map((instance) => instance.name)
+ ),
+ disabled: !canUpdate,
+ hidden: layout === "project" || !hasSplitInstanceLicense,
+ },
+ ];
+ const allSelected =
+ instances.length > 0 &&
+ instances.every((i) => selectedNames.has(i.name));
+ return (
+ <SelectionActionBar
+ count={selectedInstanceList.length}
+ label={t("common.n-selected", { n: selectedInstanceList.length })}
+ allSelected={allSelected}
+ onToggleSelectAll={() => {
+ if (allSelected) setSelectedNames(new Set());
+ else setSelectedNames(new Set(instances.map((i) => i.name)));
+ }}
+ actions={instanceActions}
+ />
+ );
+ })()}
+
+ {/* Modals (portaled, position-independent) */}
+ <EditEnvironmentSheet
+ open={showEditEnvDrawer}
+ onClose={() => setShowEditEnvDrawer(false)}
+ onUpdate={handleEnvironmentUpdate}
+ />
+ {layout === "workspace" && hasSplitInstanceLicense && (
+ <InstanceAssignmentSheet
+ open={showAssignLicenseSheet}
+ selectedInstanceList={assignLicenseNames}
+ onOpenChange={setShowAssignLicenseSheet}
+ onUpdated={handleRowAction}
+ />
+ )}
+ </>
+ );
+}
diff --git a/frontend/src/components/instance/InstanceDeleteDialog.tsx b/frontend/src/components/instance/InstanceDeleteDialog.tsx
index a4e8a3206d..0562e8fd7a 100644
--- a/frontend/src/components/instance/InstanceDeleteDialog.tsx
+++ b/frontend/src/components/instance/InstanceDeleteDialog.tsx
@@ -17,6 +17,7 @@ import { extractInstanceResourceName } from "@/utils";
interface InstanceDeleteDialogProps {
open: boolean;
instance: Instance;
+ forceArchive?: boolean;
onOpenChange: (open: boolean) => void;
onDeleted?: () => void;
}
@@ -24,6 +25,7 @@ interface InstanceDeleteDialogProps {
export function InstanceDeleteDialog({
open,
instance,
+ forceArchive = true,
onOpenChange,
onDeleted,
}: InstanceDeleteDialogProps) {
@@ -60,7 +62,7 @@ export function InstanceDeleteDialog({
try {
const store = useAppStore.getState();
if (!isArchived) {
- await store.archiveInstance(instance, true);
+ await store.archiveInstance(instance, forceArchive);
}
await store.deleteInstance(instance.name);
pushNotification({
diff --git a/frontend/src/components/instance/InstanceDetailView.test.tsx b/frontend/src/components/instance/InstanceDetailView.test.tsx
new file mode 100644
index 0000000000..40ff0d5967
--- /dev/null
+++ b/frontend/src/components/instance/InstanceDetailView.test.tsx
@@ -0,0 +1,391 @@
+import type { ReactElement, ReactNode } from "react";
+import { act, useEffect } from "react";
+import { createRoot } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+
+(
+ globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
+).IS_REACT_ACT_ENVIRONMENT = true;
+
+const mocks = vi.hoisted(() => ({
+ location: {
+ pathname: "/instances/prod",
+ search: "?syncingInstance=prod",
+ hash: "#databases",
+ },
+ navigate: vi.fn(),
+ databases: [
+ {
+ name: "instances/prod/databases/app",
+ project: "projects/default",
+ },
+ ] as Database[],
+ projects: [{ name: "projects/default" }] as Project[],
+ instance: {
+ name: "instances/prod",
+ title: "Prod",
+ engine: 1,
+ state: 1,
+ environment: "environments/test",
+ roles: [],
+ } as unknown as Instance,
+ fetchProjectList: vi.fn(async () => ({
+ projects: [] as Project[],
+ nextPageToken: "",
+ })),
+ getOrFetchInstanceByName: vi.fn(),
+ removeDatabaseMetadataCache: vi.fn(),
+ removeCacheByInstance: vi.fn(),
+ syncInstance: vi.fn(),
+ batchSyncDatabases: vi.fn(),
+ batchUpdateDatabases: vi.fn(),
+ pushNotification: vi.fn(),
+ routerPush: vi.fn(),
+ actionProps: undefined as Record<string, unknown> | undefined,
+ syncProps: undefined as Record<string, unknown> | undefined,
+ providerProps: undefined as Record<string, unknown> | undefined,
+ batchProps: undefined as Record<string, unknown> | undefined,
+}));
+
+vi.mock("react-router", () => ({
+ useLocation: () => mocks.location,
+ useNavigate: () => mocks.navigate,
+}));
+
+vi.mock("@/app/router", () => ({
+ router: {
+ beforeEach: () => () => {},
+ push: mocks.routerPush,
+ },
+}));
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: { type: "3rdParty", init: () => {} },
+ Trans: ({
+ i18nKey,
+ components,
+ }: {
+ i18nKey: string;
+ components?: { instance?: ReactNode };
+ }) => (
+ <>
+ {i18nKey}
+ {components?.instance}
+ </>
+ ),
+ useTranslation: () => ({
+ t: (key: string) => key,
+ }),
+}));
+
+vi.mock("@/stores/app", () => {
+ const getState = () => ({
+ databasesByName: {},
+ projectsByName: {},
+ getDatabaseByName: (name: string) =>
+ mocks.databases.find((database) => database.name === name) ??
+ mocks.databases[0],
+ removeDatabaseMetadataCache: mocks.removeDatabaseMetadataCache,
+ instancesByName: { [mocks.instance.name]: mocks.instance },
+ environmentList: [],
+ serverInfo: { defaultProject: "projects/default" },
+ });
+ const useAppStore = (selector?: (s: ReturnType<typeof getState>) => unknown) =>
+ selector ? selector(getState()) : getState();
+ useAppStore.getState = () => ({
+ ...getState(),
+ getOrFetchInstanceByName: mocks.getOrFetchInstanceByName,
+ syncInstance: mocks.syncInstance,
+ removeCacheByInstance: mocks.removeCacheByInstance,
+ batchSyncDatabases: mocks.batchSyncDatabases,
+ batchUpdateDatabases: mocks.batchUpdateDatabases,
+ fetchProjectList: mocks.fetchProjectList,
+ });
+ return { useAppStore };
+});
+
+vi.mock("@/stores", () => ({
+ pushNotification: mocks.pushNotification,
+}));
+
+vi.mock("@/utils", () => ({
+ extractDatabaseResourceName: (name: string) => {
+ const [, instanceName, , databaseName] = name.split("/");
+ return { instanceName, databaseName };
+ },
+ extractInstanceResourceName: (name: string) => name.split("/").pop() ?? "",
+ extractProjectResourceName: (name: string) => name.split("/").pop() ?? "",
+ getDefaultPagination: () => 10,
+ hasWorkspacePermissionV2: () => true,
+ instanceV1Name: (instance: Instance) => instance.title,
+ isNullOrUndefined: (value: unknown) => value === null || value === undefined,
+ isValidDatabaseName: (name: string) =>
+ /^instances\/[^/]+\/databases\/[^/]+$/.test(name),
+ setDocumentTitle: vi.fn(),
+}));
+
+vi.mock("@/components/AdvancedSearch", () => ({
+ AdvancedSearch: () => <div />,
+ getValueFromScopes: () => undefined,
+}));
+
+vi.mock("@/components/EngineIcon", () => ({
+ EngineIcon: () => <div />,
+}));
+
+vi.mock("@/components/EnvironmentLabel", () => ({
+ EnvironmentLabel: () => <div />,
+}));
+
+vi.mock("@/components/EditEnvironmentSheet", () => ({
+ EditEnvironmentSheet: () => null,
+}));
+
+vi.mock("@/components/ui/tabs", () => ({
+ Tabs: ({ children }: { children: ReactNode }) => <div>{children}</div>,
+ TabsList: ({ children }: { children: ReactNode }) => <div>{children}</div>,
+ TabsPanel: ({ children }: { children: ReactNode }) => <div>{children}</div>,
+ TabsTrigger: ({ children }: { children: ReactNode }) => (
+ <button type="button">{children}</button>
+ ),
+}));
+
+vi.mock("@/components/instance", () => ({
+ InstanceActionDropdown: (props: Record<string, unknown>) => {
+ mocks.actionProps = props;
+ return null;
+ },
+ InstanceFormBody: () => null,
+ InstanceFormButtons: () => null,
+ InstanceFormProvider: ({
+ children,
+ ...props
+ }: {
+ children: ReactNode;
+ }) => {
+ mocks.providerProps = props;
+ return <div>{children}</div>;
+ },
+ InstanceRoleTable: () => null,
+ InstanceSyncButton: (props: Record<string, unknown>) => {
+ mocks.syncProps = props;
+ return null;
+ },
+ useInstanceFormContext: () => ({ isDirty: false }),
+}));
+
+vi.mock("@/components/database", () => ({
+ CreateDatabaseSheet: () => <div data-testid="create-database-sheet" />,
+ DatabaseBatchOperationsBar: (props: Record<string, unknown>) => {
+ mocks.batchProps = props;
+ return null;
+ },
+ DatabaseTable: ({
+ onDatabasesChange,
+ selectionColumnIntroTarget,
+ }: {
+ onDatabasesChange?: (databases: Database[]) => void;
+ selectionColumnIntroTarget?: string;
+ }) => {
+ useEffect(() => {
+ onDatabasesChange?.(mocks.databases);
+ }, [onDatabasesChange]);
+ return (
+ <div
+ data-selection-column-intro-target={selectionColumnIntroTarget ?? ""}
+ />
+ );
+ },
+ LabelEditorSheet: () => null,
+ TransferProjectSheet: ({
+ open,
+ onTransfer,
+ }: {
+ open: boolean;
+ onTransfer: (projectName: string) => Promise<void>;
+ }) =>
+ open ? (
+ <button
+ type="button"
+ data-testid="transfer-project-sheet"
+ onClick={() => {
+ void onTransfer("projects/app");
+ }}
+ >
+ transfer
+ </button>
+ ) : null,
+}));
+
+vi.mock("@/lib/productIntro", () => ({
+ PREPARE_DATABASE_PRODUCT_INTRO: "prepare-database",
+ PREPARE_DATABASE_TRANSFER_TIP: "transfer-databases-to-project",
+ PRODUCT_INTRO_TIP_QUERY_KEY: "tip",
+ useProductIntro: vi.fn(),
+}));
+
+import { InstanceDetailView } from "./InstanceDetailView";
+
+let container: HTMLDivElement;
+let root: ReturnType<typeof createRoot>;
+
+const render = async (element: ReactElement) => {
+ await act(async () => {
+ root.render(element);
+ await Promise.resolve();
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+};
+
+beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.location = {
+ pathname: "/instances/prod",
+ search: "?syncingInstance=prod",
+ hash: "#databases",
+ };
+ mocks.databases = [
+ {
+ name: "instances/prod/databases/app",
+ project: "projects/default",
+ },
+ ] as Database[];
+ mocks.projects = [{ name: "projects/default" }] as Project[];
+ mocks.instance = {
+ name: "instances/prod",
+ title: "Prod",
+ engine: 1,
+ state: 1,
+ environment: "environments/test",
+ roles: [],
+ } as unknown as Instance;
+ mocks.actionProps = undefined;
+ mocks.syncProps = undefined;
+ mocks.providerProps = undefined;
+ mocks.batchProps = undefined;
+ mocks.fetchProjectList.mockImplementation(async () => ({
+ projects: mocks.projects,
+ nextPageToken: "",
+ }));
+ container = document.createElement("div");
+ document.body.appendChild(container);
+ root = createRoot(container);
+});
+
+afterEach(() => {
+ act(() => {
+ root.unmount();
+ });
+ document.body.removeChild(container);
+});
+
+describe("InstanceDetailView", () => {
+ it("does not show the post-sync transfer action when there is no user project", async () => {
+ await render(<InstanceDetailView instanceName="instances/prod" />);
+
+ expect(container.textContent).not.toContain(
+ "db.instance-databases-synced-title"
+ );
+ expect(mocks.fetchProjectList).toHaveBeenCalled();
+ });
+
+ it("shows the post-sync transfer action when there is a user project", async () => {
+ mocks.projects = [
+ { name: "projects/default" },
+ { name: "projects/app" },
+ ] as Project[];
+
+ await render(<InstanceDetailView instanceName="instances/prod" />);
+
+ expect(container.textContent).toContain(
+ "db.instance-databases-synced-title"
+ );
+ });
+
+ it("highlights the database selection column for the post-sync transfer guide", async () => {
+ mocks.location.search =
+ "?syncingInstance=prod&intro=prepare-database&tip=transfer-databases-to-project";
+ mocks.projects = [
+ { name: "projects/default" },
+ { name: "projects/app" },
+ ] as Project[];
+
+ await render(<InstanceDetailView instanceName="instances/prod" />);
+
+ expect(
+ container
+ .querySelector("[data-selection-column-intro-target]")
+ ?.getAttribute("data-selection-column-intro-target")
+ ).toBe("prepare-database");
+ });
+
+ it("redirects to the target project databases page after transferring from the instance database list", async () => {
+ mocks.projects = [
+ { name: "projects/default" },
+ { name: "projects/app" },
+ ] as Project[];
+
+ await render(<InstanceDetailView instanceName="instances/prod" />);
+
+ const transferSyncedButton = Array.from(
+ container.querySelectorAll("button")
+ ).find((button) =>
+ button.textContent?.includes("db.instance-databases-synced-action")
+ ) as HTMLButtonElement;
+ await act(async () => {
+ transferSyncedButton.click();
+ await Promise.resolve();
+ });
+
+ const transferSheet = container.querySelector(
+ '[data-testid="transfer-project-sheet"]'
+ ) as HTMLButtonElement;
+ await act(async () => {
+ transferSheet.click();
+ await Promise.resolve();
+ });
+
+ expect(mocks.routerPush).toHaveBeenCalledWith({
+ name: "workspace.project.database",
+ params: {
+ projectId: "app",
+ },
+ });
+ });
+
+ it("uses project ownership and hides workspace-only database actions", async () => {
+ const project = { name: "projects/app", title: "App" } as Project;
+ mocks.instance = {
+ ...mocks.instance,
+ name: "projects/app/instances/prod",
+ } as Instance;
+ mocks.location.pathname = "/projects/app/instances/prod";
+
+ await render(
+ <InstanceDetailView
+ instanceName="projects/app/instances/prod"
+ project={project}
+ />
+ );
+
+ expect(mocks.getOrFetchInstanceByName).toHaveBeenCalledWith(
+ "projects/app/instances/prod"
+ );
+ expect(mocks.actionProps).toMatchObject({ project });
+ expect(mocks.syncProps).toMatchObject({ project });
+ expect(mocks.providerProps).toMatchObject({ project });
+ expect(mocks.batchProps).toMatchObject({
+ project,
+ onTransferProject: undefined,
+ });
+ expect(container.querySelector("[data-testid='transfer-project-sheet']"))
+ .toBeNull();
+ expect(container.querySelector("[data-testid='create-database-sheet']"))
+ .toBeNull();
+ expect(mocks.fetchProjectList).not.toHaveBeenCalled();
+ });
+});
diff --git a/frontend/src/components/instance/InstanceDetailView.tsx b/frontend/src/components/instance/InstanceDetailView.tsx
new file mode 100644
index 0000000000..1abf3b0bc5
--- /dev/null
+++ b/frontend/src/components/instance/InstanceDetailView.tsx
@@ -0,0 +1,773 @@
+import { create } from "@bufbuild/protobuf";
+import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { Trans, useTranslation } from "react-i18next";
+import { useLocation, useNavigate } from "react-router";
+import { router } from "@/app/router";
+import { PROJECT_V1_ROUTE_DATABASES } from "@/app/router/handles";
+import {
+ AdvancedSearch,
+ getValueFromScopes,
+ type ScopeOption,
+ type SearchParams,
+ type ValueOption,
+} from "@/components/AdvancedSearch";
+import {
+ CreateDatabaseSheet,
+ DatabaseBatchOperationsBar,
+ DatabaseTable,
+ LabelEditorSheet,
+ TransferProjectSheet,
+} from "@/components/database";
+import { EditEnvironmentSheet } from "@/components/EditEnvironmentSheet";
+import { EngineIcon } from "@/components/EngineIcon";
+import { EnvironmentLabel } from "@/components/EnvironmentLabel";
+import { InstanceLabel } from "@/components/InstanceLabel";
+import {
+ InstanceActionDropdown,
+ InstanceFormBody,
+ InstanceFormButtons,
+ InstanceFormProvider,
+ InstanceRoleTable,
+ InstanceSyncButton,
+ useInstanceFormContext,
+} from "@/components/instance";
+import { Alert } from "@/components/ui/alert";
+import { Button } from "@/components/ui/button";
+import { Tabs, TabsList, TabsPanel, TabsTrigger } from "@/components/ui/tabs";
+import { useUnsavedChangesGuard } from "@/hooks/useUnsavedChangesGuard";
+import type { DatabaseFilter } from "@/lib/databaseFilter";
+import {
+ PREPARE_DATABASE_PRODUCT_INTRO,
+ PREPARE_DATABASE_TRANSFER_TIP,
+ PRODUCT_INTRO_TIP_QUERY_KEY,
+ useProductIntro,
+} from "@/lib/productIntro";
+import { pushNotification } from "@/stores";
+import { useAppStore } from "@/stores/app";
+import {
+ environmentNamePrefix,
+ projectNamePrefix,
+} from "@/stores/modules/v1/common";
+import {
+ isValidDatabaseName,
+ UNKNOWN_ENVIRONMENT_NAME,
+ unknownEnvironment,
+} from "@/types";
+import { State } from "@/types/proto-es/v1/common_pb";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import {
+ BatchUpdateDatabasesRequestSchema,
+ DatabaseSchema$,
+ UpdateDatabaseRequestSchema,
+} from "@/types/proto-es/v1/database_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import { unknownInstance } from "@/types/v1/instance";
+import {
+ extractInstanceResourceName,
+ extractProjectResourceName,
+ getDefaultPagination,
+ instanceV1Name,
+ setDocumentTitle,
+} from "@/utils";
+
+const instanceHashList = ["overview", "databases", "users"] as const;
+type InstanceHash = (typeof instanceHashList)[number];
+const isInstanceHash = (x: unknown): x is InstanceHash =>
+ instanceHashList.includes(x as InstanceHash);
+
+interface InstanceDetailViewProps {
+ instanceName: string;
+ project?: Project;
+ onLeave?: () => void;
+}
+
+export function InstanceDetailView({
+ instanceName,
+ project,
+ onLeave,
+}: InstanceDetailViewProps) {
+ const { t } = useTranslation();
+ const location = useLocation();
+ const navigate = useNavigate();
+ const databasesByName = useAppStore((s) => s.databasesByName);
+ const projectsByName = useAppStore((s) => s.projectsByName);
+ const getDatabaseByName = useAppStore((s) => s.getDatabaseByName);
+ const removeDatabaseMetadataCache = useAppStore(
+ (s) => s.removeDatabaseMetadataCache
+ );
+ const instanceId = extractInstanceResourceName(instanceName);
+ const isProjectOwned = !!project;
+ const cachedInstance = useAppStore((s) => s.instancesByName[instanceName]);
+ const instance = useMemo(
+ () => cachedInstance ?? unknownInstance(),
+ [cachedInstance, instanceName]
+ );
+
+ const routeHash = location.hash.replace(/^#?/, "");
+ const selectedTab: InstanceHash = isInstanceHash(routeHash)
+ ? routeHash
+ : "overview";
+ const [searchParams, setSearchParams] = useState<SearchParams>({
+ query: "",
+ scopes: [{ id: "instance", value: instanceId, readonly: true }],
+ });
+
+ // Selection / batch operations
+ const [selectedNames, setSelectedNames] = useState<Set<string>>(new Set());
+ const [visibleDatabases, setVisibleDatabases] = useState<Database[]>([]);
+ const [refreshToken, setRefreshToken] = useState(0);
+ const autoRefreshCountRef = useRef(0);
+ const [syncing, setSyncing] = useState(false);
+ const [showLabelEditor, setShowLabelEditor] = useState(false);
+ const [showEditEnvDrawer, setShowEditEnvDrawer] = useState(false);
+ const [showTransferDrawer, setShowTransferDrawer] = useState(false);
+ const [showCreateDrawer, setShowCreateDrawer] = useState(false);
+ const [syncingRefreshExhausted, setSyncingRefreshExhausted] = useState(false);
+ const [hasUserProject, setHasUserProject] = useState(false);
+
+ const selectedDatabases = useMemo(() => {
+ if (selectedNames.size === 0) return [];
+ return Array.from(selectedNames)
+ .filter((name) => isValidDatabaseName(name))
+ .map((name) => getDatabaseByName(name));
+ }, [selectedNames, getDatabaseByName, databasesByName]);
+
+ // Mirror `selectedDatabases` into a ref so the batch-operation handlers
+ // below can read the latest value without listing it as a dep. Otherwise
+ // every selection toggle re-creates the handler closures, which cascades
+ // down as fresh prop refs into `DatabaseBatchOperationsBar` and forces
+ // it to re-render (with N selected items, this compounds quickly).
+ const selectedDatabasesRef = useRef(selectedDatabases);
+ selectedDatabasesRef.current = selectedDatabases;
+
+ const refresh = useCallback(() => {
+ setRefreshToken((prev) => prev + 1);
+ setSelectedNames(new Set());
+ }, []);
+
+ const locationQuery = useMemo(
+ () => new URLSearchParams(location.search),
+ [location.search]
+ );
+ const syncingInstanceId = useMemo(
+ () => locationQuery.get("syncingInstance") || undefined,
+ [locationQuery]
+ );
+ const showPrepareDatabaseTip =
+ locationQuery.get(PRODUCT_INTRO_TIP_QUERY_KEY) ===
+ PREPARE_DATABASE_TRANSFER_TIP;
+
+ useEffect(() => {
+ if (!syncingInstanceId || visibleDatabases.length > 0) {
+ setSyncingRefreshExhausted(false);
+ return;
+ }
+ setSyncingRefreshExhausted(false);
+ autoRefreshCountRef.current = 0;
+ const timer = window.setInterval(() => {
+ autoRefreshCountRef.current += 1;
+ refresh();
+ if (autoRefreshCountRef.current >= 12) {
+ setSyncingRefreshExhausted(true);
+ window.clearInterval(timer);
+ }
+ }, 5000);
+ return () => window.clearInterval(timer);
+ }, [syncingInstanceId, visibleDatabases.length, refresh]);
+
+ const handleSyncSchema = useCallback(async () => {
+ if (syncing) return;
+ setSyncing(true);
+ pushNotification({
+ module: "bytebase",
+ style: "INFO",
+ title: t("db.start-to-sync-schema"),
+ });
+ try {
+ await useAppStore
+ .getState()
+ .batchSyncDatabases(Array.from(selectedNames));
+ for (const name of selectedNames) {
+ removeDatabaseMetadataCache(name);
+ }
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("db.successfully-synced-schema"),
+ });
+ setSelectedNames(new Set());
+ } catch {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("db.failed-to-sync-schema"),
+ });
+ } finally {
+ setSyncing(false);
+ }
+ }, [syncing, selectedNames, removeDatabaseMetadataCache, t]);
+
+ const handleLabelsApply = useCallback(
+ async (labelsList: { [key: string]: string }[]) => {
+ try {
+ await useAppStore.getState().batchUpdateDatabases(
+ create(BatchUpdateDatabasesRequestSchema, {
+ parent: "-",
+ requests: selectedDatabasesRef.current.map((database, i) =>
+ create(UpdateDatabaseRequestSchema, {
+ database: create(DatabaseSchema$, {
+ ...database,
+ labels: labelsList[i],
+ }),
+ updateMask: create(FieldMaskSchema, { paths: ["labels"] }),
+ })
+ ),
+ })
+ );
+ refresh();
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("common.updated"),
+ });
+ } catch {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.failed"),
+ });
+ }
+ },
+ [refresh, t]
+ );
+
+ const handleEnvironmentUpdate = useCallback(
+ async (environment: string) => {
+ try {
+ await useAppStore.getState().batchUpdateDatabases(
+ create(BatchUpdateDatabasesRequestSchema, {
+ parent: "-",
+ requests: selectedDatabasesRef.current.map((database) =>
+ create(UpdateDatabaseRequestSchema, {
+ database: create(DatabaseSchema$, {
+ name: database.name,
+ environment,
+ }),
+ updateMask: create(FieldMaskSchema, { paths: ["environment"] }),
+ })
+ ),
+ })
+ );
+ refresh();
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("common.updated"),
+ });
+ } catch {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.failed"),
+ });
+ }
+ },
+ [refresh, t]
+ );
+
+ const handleTransferProject = useCallback(
+ async (projectName: string) => {
+ try {
+ await useAppStore.getState().batchUpdateDatabases(
+ create(BatchUpdateDatabasesRequestSchema, {
+ parent: "-",
+ requests: selectedDatabasesRef.current.map((database) =>
+ create(UpdateDatabaseRequestSchema, {
+ database: create(DatabaseSchema$, {
+ name: database.name,
+ project: projectName,
+ }),
+ updateMask: create(FieldMaskSchema, { paths: ["project"] }),
+ })
+ ),
+ })
+ );
+ refresh();
+ pushNotification({
+ module: "bytebase",
+ style: "SUCCESS",
+ title: t("database.successfully-transferred-databases"),
+ });
+ void router.push({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: {
+ projectId: extractProjectResourceName(projectName),
+ },
+ });
+ } catch {
+ pushNotification({
+ module: "bytebase",
+ style: "CRITICAL",
+ title: t("common.failed"),
+ });
+ }
+ },
+ [refresh, t]
+ );
+ // Trigger a fetch on mount so the instance is hydrated into the
+ // `useAppStore` cache. Without this, hard-refreshing the page shows
+ // "Unknown instance" because the cache hasn't been populated yet.
+ useEffect(() => {
+ void useAppStore.getState().getOrFetchInstanceByName(instanceName);
+ }, [instanceName]);
+
+ // Canonicalize legacy query state and invalid/missing hashes. The location
+ // remains the tab source of truth, so Back/Forward updates the selected tab.
+ useEffect(() => {
+ const query = new URLSearchParams(location.search);
+ query.delete("qs");
+ const search = query.toString();
+ const nextSearch = search ? `?${search}` : "";
+ const nextHash = `#${selectedTab}`;
+ if (location.search === nextSearch && location.hash === nextHash) return;
+ void navigate(
+ {
+ pathname: location.pathname,
+ search: nextSearch,
+ hash: nextHash,
+ },
+ { replace: true }
+ );
+ }, [
+ location.hash,
+ location.pathname,
+ location.search,
+ navigate,
+ selectedTab,
+ ]);
+
+ // Set document title
+ useEffect(() => {
+ if (instance.title) {
+ setDocumentTitle(instance.title);
+ }
+ }, [instance.title]);
+
+ const syncSchema = useCallback(
+ async (enableFullSync: boolean) => {
+ await useAppStore.getState().syncInstance(instance.name, enableFullSync);
+ useAppStore.getState().removeCacheByInstance(instance.name);
+ },
+ [instance.name]
+ );
+
+ // Database filter
+ const envVal = getValueFromScopes(searchParams, "environment");
+ const selectedEnvironment = envVal
+ ? `${environmentNamePrefix}${envVal}`
+ : undefined;
+ const projectVal = getValueFromScopes(searchParams, "project");
+ const selectedProject = projectVal
+ ? `${projectNamePrefix}${projectVal}`
+ : undefined;
+ const selectedLabels = useMemo(
+ () =>
+ searchParams.scopes.filter((s) => s.id === "label").map((s) => s.value),
+ [searchParams]
+ );
+
+ const filter: DatabaseFilter = useMemo(
+ () => ({
+ environment: selectedEnvironment,
+ project: selectedProject,
+ query: searchParams.query,
+ labels: selectedLabels.length > 0 ? selectedLabels : undefined,
+ }),
+ [selectedEnvironment, selectedProject, searchParams.query, selectedLabels]
+ );
+
+ const environments = useAppStore((s) => s.environmentList ?? []);
+
+ // Reactive: the actuator's `defaultProject` is fetched asynchronously, so
+ // we subscribe through the store selector — otherwise the value is
+ // captured as `""` on first render and the API filter becomes broken.
+ const defaultProjectId = useAppStore((s) =>
+ extractProjectResourceName(s.serverInfo?.defaultProject ?? "")
+ );
+ const defaultProjectName = useAppStore(
+ (s) => s.serverInfo?.defaultProject ?? ""
+ );
+ const unassignedProjectOption = useMemo<ValueOption>(
+ () => ({
+ value: defaultProjectId,
+ keywords: ["unassigned", "default"],
+ custom: true,
+ render: () => (
+ <span className="italic text-control-light">
+ {t("common.unassigned")}
+ </span>
+ ),
+ }),
+ [defaultProjectId, t]
+ );
+ const searchProjects = useCallback(
+ async (keyword: string): Promise<ValueOption[]> => {
+ const { projects } = await useAppStore.getState().fetchProjectList({
+ pageSize: getDefaultPagination(),
+ filter: keyword.trim() ? { query: keyword } : undefined,
+ });
+ return projects.map<ValueOption>((p) => {
+ const id = extractProjectResourceName(p.name);
+ if (id === defaultProjectId) return unassignedProjectOption;
+ return {
+ value: id,
+ keywords: [id, p.title],
+ };
+ });
+ },
+ [defaultProjectId, unassignedProjectOption]
+ );
+
+ const scopeOptions: ScopeOption[] = useMemo(
+ () => [
+ {
+ id: "environment",
+ title: t("common.environment"),
+ description: t("issue.advanced-search.scope.environment.description"),
+ options: [unknownEnvironment(), ...environments].map((env) => {
+ const isUnknown = env.name === UNKNOWN_ENVIRONMENT_NAME;
+ return {
+ value: env.id,
+ keywords: isUnknown
+ ? ["unassigned", "none", env.id]
+ : [env.id, env.title],
+ custom: true,
+ render: () => <EnvironmentLabel environment={env} />,
+ };
+ }),
+ },
+ {
+ id: "project",
+ title: t("common.project"),
+ description: t("issue.advanced-search.scope.project.description"),
+ // Static option lets the selected-tag display resolve the default
+ // project id to "Unassigned".
+ options: [unassignedProjectOption],
+ onSearch: searchProjects,
+ },
+ {
+ id: "label",
+ title: t("common.labels"),
+ description: t("issue.advanced-search.scope.label.description"),
+ allowMultiple: true,
+ },
+ ],
+ [t, environments, searchProjects, unassignedProjectOption]
+ );
+
+ const handleTabChange = useCallback(
+ (tab: string | number | null) => {
+ if (typeof tab !== "string" || !isInstanceHash(tab)) return;
+ void navigate(
+ {
+ pathname: location.pathname,
+ search: location.search,
+ hash: `#${tab}`,
+ },
+ { replace: true }
+ );
+ },
+ [location.pathname, location.search, navigate]
+ );
+
+ useEffect(() => {
+ if (isProjectOwned) {
+ setHasUserProject(false);
+ return;
+ }
+ if (!syncingInstanceId || visibleDatabases.length === 0) {
+ setHasUserProject(false);
+ return;
+ }
+
+ const isUserProject = (project?: { name?: string }) =>
+ !!defaultProjectName &&
+ !!project?.name &&
+ project.name !== defaultProjectName;
+
+ if (Object.values(projectsByName).some(isUserProject)) {
+ setHasUserProject(true);
+ return;
+ }
+
+ let cancelled = false;
+ void (async () => {
+ try {
+ const { projects } = await useAppStore.getState().fetchProjectList({
+ pageSize: getDefaultPagination(),
+ silent: true,
+ });
+ if (cancelled) {
+ return;
+ }
+ setHasUserProject(projects.some(isUserProject));
+ } catch {
+ if (!cancelled) {
+ setHasUserProject(false);
+ }
+ }
+ })();
+
+ return () => {
+ cancelled = true;
+ };
+ }, [
+ defaultProjectName,
+ isProjectOwned,
+ projectsByName,
+ syncingInstanceId,
+ visibleDatabases.length,
+ ]);
+
+ const showSyncingInstanceHint =
+ !!syncingInstanceId &&
+ visibleDatabases.length === 0 &&
+ !syncingRefreshExhausted;
+ const showNoDatabasesAfterSync =
+ !!syncingInstanceId &&
+ visibleDatabases.length === 0 &&
+ syncingRefreshExhausted;
+ const showPostSyncTransferAction =
+ !isProjectOwned &&
+ !!syncingInstanceId &&
+ visibleDatabases.length > 0 &&
+ hasUserProject;
+ const shouldShowTransferIntro =
+ showPrepareDatabaseTip && showPostSyncTransferAction;
+ useProductIntro({
+ id: PREPARE_DATABASE_PRODUCT_INTRO,
+ title: t("workspace-setup-guide.intro.transfer-title"),
+ description: t("workspace-setup-guide.intro.transfer-description"),
+ disabled: isProjectOwned || !shouldShowTransferIntro,
+ });
+ const syncingInstanceName = syncingInstanceId ? instanceName : undefined;
+ const syncingInstance =
+ syncingInstanceId === instanceId ? instance : undefined;
+ const handleTransferSyncedDatabases = useCallback(() => {
+ setSelectedNames(
+ new Set(visibleDatabases.map((database) => database.name))
+ );
+ setShowTransferDrawer(true);
+ }, [visibleDatabases]);
+
+ return (
+ <div className="p-4 flex flex-col gap-y-2">
+ {/* Archive banner */}
+ {instance.state === State.DELETED && (
+ <div className="bg-gray-700 text-white text-center py-2 rounded-sm text-sm font-medium">
+ {t("common.archived")}
+ </div>
+ )}
+
+ {/* No environment warning */}
+ {!instance.environment && (
+ <Alert
+ variant="warning"
+ className="mb-4"
+ description={t("instance.no-environment")}
+ />
+ )}
+
+ {/* Header */}
+ <div className="flex items-center justify-between">
+ <div className="flex items-center gap-x-2">
+ <EngineIcon engine={instance.engine} className="h-6 w-6" />
+ <span className="text-lg font-medium">
+ {instanceV1Name(instance)}
+ </span>
+ </div>
+ <div className="flex items-center gap-x-2">
+ {instance.state === State.ACTIVE && (
+ <InstanceSyncButton
+ instanceName={instance.name}
+ instanceTitle={instance.title}
+ project={project}
+ onSyncSchema={syncSchema}
+ />
+ )}
+ <InstanceActionDropdown
+ instance={instance}
+ project={project}
+ onArchived={onLeave}
+ onDeleted={onLeave}
+ />
+ </div>
+ </div>
+
+ {/* Tabs */}
+ <Tabs value={selectedTab} onValueChange={handleTabChange}>
+ <TabsList className="border-b-0">
+ <TabsTrigger value="overview">{t("common.overview")}</TabsTrigger>
+ <TabsTrigger value="databases">{t("common.databases")}</TabsTrigger>
+ <TabsTrigger value="users">{t("instance.users")}</TabsTrigger>
+ </TabsList>
+
+ <TabsPanel value="overview">
+ <InstanceFormProvider instance={instance} project={project}>
+ <InstanceFormBody />
+ <InstanceFormButtons />
+ <UnsavedChangesGuard />
+ </InstanceFormProvider>
+ </TabsPanel>
+
+ <TabsPanel value="databases" keepMounted={false}>
+ <div className="flex flex-col gap-y-2">
+ {showSyncingInstanceHint && (
+ <Alert
+ variant="info"
+ title={
+ <Trans
+ t={t}
+ i18nKey="db.project-instance-syncing-title"
+ components={{
+ instance: (
+ <InstanceLabel
+ instance={syncingInstance}
+ instanceName={syncingInstanceName}
+ />
+ ),
+ }}
+ />
+ }
+ description={
+ <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
+ <span>{t("db.project-instance-syncing-description")}</span>
+ <Button size="sm" appearance="outline" onClick={refresh}>
+ {t("common.refresh")}
+ </Button>
+ </div>
+ }
+ />
+ )}
+ {showPostSyncTransferAction && (
+ <Alert
+ variant="info"
+ title={t("db.instance-databases-synced-title")}
+ description={
+ <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
+ <span>{t("db.instance-databases-synced-description")}</span>
+ <Button size="sm" onClick={handleTransferSyncedDatabases}>
+ {t("db.instance-databases-synced-action")}
+ </Button>
+ </div>
+ }
+ />
+ )}
+ {showNoDatabasesAfterSync && (
+ <Alert
+ variant="info"
+ title={t("db.instance-no-databases-title")}
+ description={
+ <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
+ <span>{t("db.instance-no-databases-description")}</span>
+ {!isProjectOwned && (
+ <Button
+ size="sm"
+ appearance="outline"
+ onClick={() => setShowCreateDrawer(true)}
+ >
+ {t("db.instance-no-databases-action")}
+ </Button>
+ )}
+ </div>
+ }
+ />
+ )}
+ <AdvancedSearch
+ params={searchParams}
+ onParamsChange={setSearchParams}
+ placeholder={t("database.filter-database")}
+ scopeOptions={scopeOptions}
+ />
+ <EditEnvironmentSheet
+ open={showEditEnvDrawer}
+ onClose={() => setShowEditEnvDrawer(false)}
+ onUpdate={handleEnvironmentUpdate}
+ />
+ <LabelEditorSheet
+ open={showLabelEditor}
+ databases={selectedDatabases}
+ onClose={() => setShowLabelEditor(false)}
+ onApply={handleLabelsApply}
+ />
+ {!isProjectOwned && (
+ <>
+ <TransferProjectSheet
+ open={showTransferDrawer}
+ databases={selectedDatabases}
+ onClose={() => setShowTransferDrawer(false)}
+ onTransfer={handleTransferProject}
+ />
+ <CreateDatabaseSheet
+ open={showCreateDrawer}
+ onClose={() => setShowCreateDrawer(false)}
+ instanceName={instanceName}
+ />
+ </>
+ )}
+ <DatabaseTable
+ filter={filter}
+ parent={instance.name}
+ mode="ALL"
+ selectedNames={selectedNames}
+ onSelectedNamesChange={setSelectedNames}
+ onDatabasesChange={setVisibleDatabases}
+ refreshToken={refreshToken}
+ selectionColumnIntroTarget={
+ shouldShowTransferIntro
+ ? PREPARE_DATABASE_PRODUCT_INTRO
+ : undefined
+ }
+ />
+ {/* Batch operations bar is fixed within the visible main content. */}
+ <DatabaseBatchOperationsBar
+ databases={selectedDatabases}
+ project={project}
+ onSyncSchema={handleSyncSchema}
+ onEditLabels={() => setShowLabelEditor(true)}
+ onEditEnvironment={() => setShowEditEnvDrawer(true)}
+ onTransferProject={
+ isProjectOwned ? undefined : () => setShowTransferDrawer(true)
+ }
+ allSelected={
+ visibleDatabases.length > 0 &&
+ visibleDatabases.every((d) => selectedNames.has(d.name))
+ }
+ onToggleSelectAll={() => {
+ const allOnPage =
+ visibleDatabases.length > 0 &&
+ visibleDatabases.every((d) => selectedNames.has(d.name));
+ if (allOnPage) setSelectedNames(new Set());
+ else
+ setSelectedNames(
+ new Set(visibleDatabases.map((d) => d.name))
+ );
+ }}
+ />
+ </div>
+ </TabsPanel>
+
+ <TabsPanel value="users">
+ <InstanceRoleTable instanceRoleList={instance.roles ?? []} />
+ </TabsPanel>
+ </Tabs>
+ </div>
+ );
+}
+
+function UnsavedChangesGuard() {
+ const { valueChanged } = useInstanceFormContext();
+ useUnsavedChangesGuard(valueChanged);
+ return null;
+}
diff --git a/frontend/src/components/instance/InstanceFormBody.test.ts b/frontend/src/components/instance/InstanceFormBody.test.ts
index c0885f737e..9fb6912a06 100644
--- a/frontend/src/components/instance/InstanceFormBody.test.ts
+++ b/frontend/src/components/instance/InstanceFormBody.test.ts
@@ -51,7 +51,7 @@ describe("InstanceFormBody", () => {
expect(source.match(/<SyncDatabases/g)).toHaveLength(1);
});
- test("explains project-aware database sync in the instance form", () => {
+ test("labels project-aware database sync without a redundant alert", () => {
const source = readFileSync(
join(process.cwd(), "src/components/instance/InstanceFormBody.tsx"),
"utf-8"
@@ -63,18 +63,37 @@ describe("InstanceFormBody", () => {
expect(source).toContain("showLabel ? (");
expect(source).toContain("instance.sync-databases.description");
expect(source).toContain('t("instance.sync-databases.self")');
- expect(source).toContain("instance.sync-databases.project-description");
+ expect(source).not.toContain("instance.sync-databases.project-description");
expect(source).toContain("instance.sync-databases.project-sync-all");
expect(source).toContain("projectName");
- expect(source).toContain('useProjectByName(projectName ?? "")');
- expect(source).toContain("project.title || projectName");
- expect(source).toContain("values={{ project: projectTitle }}");
- expect(source).toContain("fetchProject(routeProjectName");
- expect(source).toContain("ResourceLink");
- expect(source).toContain("showResourceType={false}");
- expect(source).toContain('className="underline underline-offset-2"');
- expect(source).toContain('target="_blank"');
- expect(source).toContain('rel="noopener noreferrer"');
+ expect(source).not.toContain('useProjectByName(projectName ?? "")');
+ expect(source).not.toContain("fetchProject(routeProjectName");
+ expect(source).toContain("projectName={parent}");
+ expect(source).not.toContain("ResourceLink");
+ });
+
+ test("preserves the project parent when the resource id changes", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/components/instance/InstanceFormBody.tsx"),
+ "utf-8"
+ );
+
+ expect(source).toContain(
+ "parent ? `${parent}/instances/${id}` : `instances/${id}`"
+ );
+ expect(source).toContain(
+ "parent ? `${parent}/instances/${id}` : `${instanceNamePrefix}${id}`"
+ );
+ expect(source).not.toContain("router.currentRoute.value.query.project");
+ });
+
+ test("does not treat an inaccessible instance as a duplicate resource id", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/components/instance/InstanceFormBody.tsx"),
+ "utf-8"
+ );
+
+ expect(source).toContain("existing.name !== UNKNOWN_INSTANCE_NAME");
});
test("offers sync-all database details from the create instance form", () => {
diff --git a/frontend/src/components/instance/InstanceFormBody.tsx b/frontend/src/components/instance/InstanceFormBody.tsx
index 95a8f7f28e..283f43af5e 100644
--- a/frontend/src/components/instance/InstanceFormBody.tsx
+++ b/frontend/src/components/instance/InstanceFormBody.tsx
@@ -9,8 +9,7 @@ import {
Trash2,
} from "lucide-react";
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { Trans, useTranslation } from "react-i18next";
-import { router } from "@/app/router";
+import { useTranslation } from "react-i18next";
import { EngineIcon } from "@/components/EngineIcon";
import { EnvironmentSelect } from "@/components/EnvironmentSelect";
import { FeatureBadge } from "@/components/FeatureBadge";
@@ -18,7 +17,6 @@ import { LabelListEditor } from "@/components/LabelListEditor";
import { LearnMoreLink } from "@/components/LearnMoreLink";
import { ResourceIdField } from "@/components/ResourceIdField";
import { RouterLink } from "@/components/RouterLink";
-import { ResourceLink } from "@/components/sql-review/ResourceLink";
import { Alert } from "@/components/ui/alert";
import { Button } from "@/components/ui/button";
import { Checkbox } from "@/components/ui/checkbox";
@@ -30,18 +28,17 @@ import {
} from "@/components/ui/form";
import { Input } from "@/components/ui/input";
import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group";
-import { useProjectByName } from "@/hooks/useProjectByName";
import { cn } from "@/lib/utils";
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
import {
environmentNamePrefix,
instanceNamePrefix,
- projectNamePrefix,
} from "@/stores/modules/v1/common";
import {
isValidEnvironmentName,
UNKNOWN_ID,
+ UNKNOWN_INSTANCE_NAME,
type ValidatedMessage,
} from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
@@ -493,7 +490,6 @@ function SyncDatabases({
const { t } = useTranslation();
const ctx = useInstanceFormContext();
const { hideAdvancedFeatures, instance, pendingCreateInstance } = ctx;
- const project = useProjectByName(projectName ?? "");
const [syncAll, setSyncAll] = useState(syncDatabases === undefined);
const [selectedSet, setSelectedSet] = useState<Set<string>>(
@@ -568,8 +564,6 @@ function SyncDatabases({
const visibleDatabases = filteredDatabases.slice(0, visibleDatabaseCount);
const hasMore = filteredDatabases.length > visibleDatabaseCount;
const hasProjectContext = !!projectName && isCreatingProp;
- const projectTitle =
- project.name === projectName ? project.title || projectName : projectName;
const handleKeyDown = (e: React.KeyboardEvent) => {
if (e.nativeEvent.isComposing) return;
@@ -624,26 +618,6 @@ function SyncDatabases({
}
>
<div className="flex flex-col gap-y-2">
- {hasProjectContext && (
- <Alert variant="info">
- <Trans
- t={t}
- i18nKey="instance.sync-databases.project-description"
- values={{ project: projectTitle }}
- components={{
- project: (
- <ResourceLink
- resource={projectName || ""}
- showResourceType={false}
- className="underline underline-offset-2"
- target="_blank"
- rel="noopener noreferrer"
- />
- ),
- }}
- />
- </Alert>
- )}
<label className="flex items-center gap-x-2 cursor-pointer">
<Checkbox
checked={syncAll}
@@ -747,6 +721,7 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
showConnectionOptionsEvent,
emitShowConnectionOptions,
setResourceIdValidated,
+ parent,
} = ctx;
const { isEngineBeta, defaultPort, instanceLink, allowEditPort } = specs;
@@ -848,30 +823,14 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
return id;
}, [basicInfo.name]);
- const routeProjectId = useMemo(() => {
- const projectId = router.currentRoute.value.query.project;
- return typeof projectId === "string" && projectId ? projectId : undefined;
- }, []);
- const routeProjectName = routeProjectId
- ? `${projectNamePrefix}${routeProjectId}`
- : "";
-
- useEffect(() => {
- if (!routeProjectName) return;
- useAppStore
- .getState()
- .fetchProject(routeProjectName, true)
- .catch(() => {
- // Ignore prefetch failure. The instance creation request still uses the
- // route project name directly.
- });
- }, [routeProjectName]);
-
const setResourceId = useCallback(
(id: string) => {
- setBasicInfo((prev) => ({ ...prev, name: `instances/${id}` }));
+ setBasicInfo((prev) => ({
+ ...prev,
+ name: parent ? `${parent}/instances/${id}` : `instances/${id}`,
+ }));
},
- [setBasicInfo]
+ [parent, setBasicInfo]
);
// Duplicate-instance check used by the shared ResourceIdField's `validate`
@@ -884,10 +843,10 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
const existing = await useAppStore
.getState()
.getOrFetchInstanceByName(
- `${instanceNamePrefix}${id}`,
+ parent ? `${parent}/instances/${id}` : `${instanceNamePrefix}${id}`,
true /* silent */
);
- if (existing) {
+ if (existing.name !== UNKNOWN_INSTANCE_NAME) {
return [
{
type: "error",
@@ -902,7 +861,7 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
}
return [];
},
- [isCreating, t]
+ [isCreating, parent, t]
);
const currentMongoDBConnectionSchema = useMemo(() => {
@@ -1791,7 +1750,7 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
allowEdit={
isCreating ? allowEdit && !!allowCreate : allowEdit
}
- projectName={routeProjectName}
+ projectName={parent}
onOpenInfoPanel={onOpenInfoPanel}
syncDatabases={basicInfo.syncDatabases}
onSyncDatabasesChange={handleChangeSyncDatabases}
diff --git a/frontend/src/components/instance/InstanceFormButtons.test.tsx b/frontend/src/components/instance/InstanceFormButtons.test.tsx
index fd96e3867a..517c1a5177 100644
--- a/frontend/src/components/instance/InstanceFormButtons.test.tsx
+++ b/frontend/src/components/instance/InstanceFormButtons.test.tsx
@@ -24,6 +24,7 @@ const mocks = vi.hoisted(() => ({
fetchDatabases: vi.fn(),
batchUpdateDatabases: vi.fn(),
captureMetric: vi.fn(),
+ onCreated: vi.fn(),
context: undefined as Record<string, unknown> | undefined,
}));
@@ -79,8 +80,7 @@ vi.mock("@/stores", () => ({
vi.mock("@/utils", () => ({
convertKVListToLabels: (list: { key: string; value: string }[]) =>
Object.fromEntries(list.map(({ key, value }) => [key, value])),
- extractInstanceResourceName: (name: string) =>
- name.replace(/^instances\//, ""),
+ extractInstanceResourceName: (name: string) => name.split("/").at(-1) ?? "",
isValidSpannerDataSource: (ds: { projectId: string; instanceId: string }) =>
ds.projectId !== "" && ds.instanceId !== "",
isValidBigQueryDataSource: (ds: { projectId: string }) =>
@@ -227,7 +227,7 @@ beforeEach(() => {
describe("InstanceFormButtons", () => {
test("uses project-aware create action text when creating from a project", async () => {
- mocks.routerCurrentQuery = { project: "demo" };
+ mocks.context = { ...mocks.context, parent: "projects/demo" };
const container = document.createElement("div");
const root = createRoot(container);
@@ -246,12 +246,20 @@ describe("InstanceFormButtons", () => {
});
test("passes project context to instance creation without client-side database transfer", async () => {
- mocks.routerCurrentQuery = { project: "demo" };
+ mocks.routerCurrentName = "workspace.project.instance.create";
+ mocks.context = { ...mocks.context, parent: "projects/demo" };
+ mocks.createInstance.mockResolvedValue(
+ create(InstanceSchema, {
+ name: "projects/demo/instances/prod",
+ title: "Production",
+ engine: Engine.POSTGRES,
+ })
+ );
const container = document.createElement("div");
const root = createRoot(container);
await act(async () => {
- root.render(<InstanceFormButtons />);
+ root.render(<InstanceFormButtons onCreated={mocks.onCreated} />);
});
const createButton = Array.from(container.querySelectorAll("button")).find(
@@ -267,24 +275,20 @@ describe("InstanceFormButtons", () => {
expect.anything(),
false,
{
- initialDatabaseProject: "projects/demo",
+ parent: "projects/demo",
}
);
expect(mocks.fetchDatabases).not.toHaveBeenCalled();
expect(mocks.batchUpdateDatabases).not.toHaveBeenCalled();
- expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.project.database",
- params: { projectId: "demo" },
- query: {
- intro: "project-instance-synced",
- syncingInstance: "prod",
- },
- });
+ expect(mocks.onCreated).toHaveBeenCalledWith(
+ expect.objectContaining({ name: "projects/demo/instances/prod" })
+ );
+ expect(mocks.routerPush).not.toHaveBeenCalled();
expect(mocks.context?.onDismiss).not.toHaveBeenCalled();
expect(mocks.captureMetric).toHaveBeenCalledWith({
event: "instance create clicked",
properties: {
- route_id: "workspace.instance.create",
+ route_id: "workspace.project.instance.create",
resource: "projects/demo",
},
});
@@ -386,9 +390,7 @@ describe("InstanceFormButtons", () => {
syncDatabases: create(SyncDatabasesSchema, { databases: [] }),
}),
false,
- {
- initialDatabaseProject: undefined,
- }
+ undefined
);
await act(async () => {
diff --git a/frontend/src/components/instance/InstanceFormButtons.tsx b/frontend/src/components/instance/InstanceFormButtons.tsx
index 2da0ac2402..d7b7450488 100644
--- a/frontend/src/components/instance/InstanceFormButtons.tsx
+++ b/frontend/src/components/instance/InstanceFormButtons.tsx
@@ -5,20 +5,15 @@ import { useTranslation } from "react-i18next";
import { createBehaviorMetric } from "@/app/analytics/behavior";
import { behaviorAnalytics } from "@/app/analytics/provider";
import { router } from "@/app/router";
-import {
- INSTANCE_ROUTE_DETAIL,
- PROJECT_V1_ROUTE_DATABASES,
-} from "@/app/router/handles";
+import { INSTANCE_ROUTE_DETAIL } from "@/app/router/handles";
import {
PREPARE_DATABASE_PRODUCT_INTRO,
PREPARE_DATABASE_TRANSFER_TIP,
PRODUCT_INTRO_QUERY_KEY,
PRODUCT_INTRO_TIP_QUERY_KEY,
- PROJECT_INSTANCE_SYNCED_PRODUCT_INTRO,
} from "@/lib/productIntro";
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
-import { projectNamePrefix } from "@/stores/modules/v1/common";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type {
DataSource,
@@ -101,6 +96,7 @@ export function InstanceFormButtons({
valueChanged,
onDismiss,
emitShowConnectionOptions,
+ parent,
} = context;
const hasExternalSecretFeature = useAppStore((s) =>
@@ -240,19 +236,6 @@ export function InstanceFormButtons({
return inst;
};
- const getRouteProjectContext = () => {
- const projectId = router.currentRoute.value.query.project;
- if (typeof projectId !== "string" || projectId.length === 0) {
- return;
- }
- return {
- id: projectId,
- name: `${projectNamePrefix}${projectId}`,
- };
- };
-
- const projectContext = getRouteProjectContext();
-
const doCreate = async () => {
if (!isCreating) return;
@@ -266,20 +249,9 @@ export function InstanceFormButtons({
try {
const createdInstance = await useAppStore
.getState()
- .createInstance(payload, false, {
- initialDatabaseProject: projectContext?.name,
- });
+ .createInstance(payload, false, parent ? { parent } : undefined);
if (onCreated) {
onCreated(createdInstance);
- } else if (projectContext) {
- router.push({
- name: PROJECT_V1_ROUTE_DATABASES,
- params: { projectId: projectContext.id },
- query: {
- [PRODUCT_INTRO_QUERY_KEY]: PROJECT_INSTANCE_SYNCED_PRODUCT_INTRO,
- syncingInstance: extractInstanceResourceName(createdInstance.name),
- },
- });
} else {
const instanceId = extractInstanceResourceName(createdInstance.name);
router.push({
@@ -303,7 +275,7 @@ export function InstanceFormButtons({
0: createdInstance.title,
}
),
- description: projectContext
+ description: parent
? t("db.syncing-databases-for-instance", {
0: createdInstance.title,
})
@@ -318,7 +290,7 @@ export function InstanceFormButtons({
behaviorAnalytics.captureMetric(
createBehaviorMetric("instance create clicked", {
routeId: router.currentRoute.value.name?.toString(),
- resource: projectContext?.name,
+ resource: parent,
})
);
@@ -612,10 +584,10 @@ export function InstanceFormButtons({
onClick={tryCreate}
>
{state.isRequesting
- ? projectContext
+ ? parent
? t("instance.connecting-database-to-project")
: t("common.creating")
- : projectContext
+ : parent
? t("instance.connect-database-to-project")
: t("common.create")}
</Button>
diff --git a/frontend/src/components/instance/InstanceFormContext.test.tsx b/frontend/src/components/instance/InstanceFormContext.test.tsx
index a97769ffd3..7d97a92532 100644
--- a/frontend/src/components/instance/InstanceFormContext.test.tsx
+++ b/frontend/src/components/instance/InstanceFormContext.test.tsx
@@ -9,6 +9,7 @@ import {
DataSourceType,
InstanceSchema,
} from "@/types/proto-es/v1/instance_service_pb";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { unknownInstance } from "@/types/v1/instance";
import {
@@ -16,6 +17,14 @@ import {
useInstanceFormContext,
} from "./InstanceFormContext";
+const mocks = vi.hoisted(() => ({
+ hasInstancePermission: vi.fn(() => true),
+}));
+
+vi.mock("./permission", () => ({
+ hasInstancePermission: mocks.hasInstancePermission,
+}));
+
vi.mock("react-i18next", () => ({
useTranslation: () => ({
t: (key: string) => key,
@@ -133,10 +142,13 @@ const Probe = () => {
return (
<div
data-title={ctx.basicInfo.title}
+ data-name={ctx.basicInfo.name}
+ data-parent={ctx.parent}
data-host={ctx.adminDataSource.host}
data-environment={ctx.basicInfo.environment}
data-value-changed={String(ctx.valueChanged)}
data-is-editing={String(ctx.isEditing)}
+ data-can-update={String(ctx.hasPermission("bb.instances.update"))}
/>
);
};
@@ -162,10 +174,34 @@ const renderIntoContainer = () => {
describe("InstanceFormProvider", () => {
beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.hasInstancePermission.mockReturnValue(true);
mockEnvironmentList = [];
vi.useRealTimers();
});
+ test("uses project ownership for create names and permissions", async () => {
+ const project = create(ProjectSchema, { name: "projects/app" });
+ const harness = renderIntoContainer();
+
+ await harness.render(
+ <InstanceFormProvider parent="projects/app" project={project}>
+ <Probe />
+ </InstanceFormProvider>
+ );
+
+ const probe = harness.container.firstElementChild as HTMLElement;
+ expect(probe.dataset.name).toBe("projects/app/instances/-");
+ expect(probe.dataset.parent).toBe("projects/app");
+ expect(probe.dataset.canUpdate).toBe("true");
+ expect(mocks.hasInstancePermission).toHaveBeenCalledWith(
+ project,
+ "bb.instances.update"
+ );
+
+ harness.unmount();
+ });
+
test("selects the first environment by default when creating an instance", async () => {
mockEnvironmentList = [{ id: "dev", name: "environments/dev" }];
const harness = renderIntoContainer();
diff --git a/frontend/src/components/instance/InstanceFormContext.tsx b/frontend/src/components/instance/InstanceFormContext.tsx
index d52548508f..92a68f7c55 100644
--- a/frontend/src/components/instance/InstanceFormContext.tsx
+++ b/frontend/src/components/instance/InstanceFormContext.tsx
@@ -14,6 +14,7 @@ import {
import { useTranslation } from "react-i18next";
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
+import type { Permission } from "@/types";
import { Engine, State } from "@/types/proto-es/v1/common_pb";
import type {
DataSource,
@@ -27,11 +28,11 @@ import {
DataSourceType,
InstanceSchema,
} from "@/types/proto-es/v1/instance_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import {
convertKVListToLabels,
convertLabelsToKVList,
- hasWorkspacePermissionV2,
isValidBigQueryDataSource,
isValidSpannerDataSource,
} from "@/utils";
@@ -49,6 +50,7 @@ import {
extractDataSourceEditState,
} from "./common";
import { effectivePortForEngine } from "./constants";
+import { hasInstancePermission } from "./permission";
import { type InstanceSpecs, useInstanceSpecs } from "./specs";
export type LocalState = {
@@ -65,6 +67,8 @@ type TestConnectionResult = {
export interface InstanceFormContextValue {
instance: Instance | undefined;
+ parent: string | undefined;
+ project: Project | undefined;
hideAdvancedFeatures: boolean;
state: LocalState;
setState: React.Dispatch<React.SetStateAction<LocalState>>;
@@ -72,6 +76,7 @@ export interface InstanceFormContextValue {
isCreating: boolean;
allowEdit: boolean;
allowCreate: boolean;
+ hasPermission: (permission: Permission) => boolean;
environment: ReturnType<
ReturnType<typeof useAppStore.getState>["getEnvironmentByName"]
>;
@@ -130,11 +135,15 @@ export const useInstanceFormContext = () => {
export function InstanceFormProvider({
instance,
+ parent,
+ project,
hideAdvancedFeatures = false,
onDismiss,
children,
}: {
instance?: Instance;
+ parent?: string;
+ project?: Project;
hideAdvancedFeatures?: boolean;
onDismiss?: () => void;
children: ReactNode;
@@ -150,9 +159,13 @@ export function InstanceFormProvider({
isRequesting: false,
}));
- const [basicInfo, setBasicInfo] = useState<BasicInfo>(() =>
- extractBasicInfo(instance)
- );
+ const [basicInfo, setBasicInfo] = useState<BasicInfo>(() => {
+ const info = extractBasicInfo(instance);
+ if (!instance && parent) {
+ info.name = `${parent}/${info.name}`;
+ }
+ return info;
+ });
const [dataSourceEditState, setDataSourceEditState] =
useState<DataSourceEditState>(() => extractDataSourceEditState(instance));
const [labelKVList, setLabelKVList] = useState(() =>
@@ -214,10 +227,15 @@ export function InstanceFormProvider({
setShowConnectionOptionsEvent((prev) => prev + 1);
}, []);
+ const hasPermission = useCallback(
+ (permission: Permission) => hasInstancePermission(project, permission),
+ [project]
+ );
+
const allowEdit = isCreating
? true
: (instance?.state || State.STATE_UNSPECIFIED) === State.ACTIVE &&
- hasWorkspacePermissionV2("bb.instances.update");
+ hasPermission("bb.instances.update");
const adminDataSource = useMemo(
() =>
@@ -335,7 +353,7 @@ export function InstanceFormProvider({
);
const allowCreate = useMemo(() => {
- if (!hasWorkspacePermissionV2("bb.instances.create")) return false;
+ if (!hasPermission("bb.instances.create")) return false;
if (basicInfo.engine === Engine.SPANNER) {
return (
!!basicInfo.title.trim() && isValidSpannerDataSource(adminDataSource)
@@ -369,6 +387,7 @@ export function InstanceFormProvider({
resourceIdValidated,
labelErrors,
checkDataSource,
+ hasPermission,
]);
const resetDataSource = useCallback(() => {
@@ -512,7 +531,9 @@ export function InstanceFormProvider({
);
inst.dataSources = [dataSourceCreate];
try {
- await useAppStore.getState().createInstance(inst, true);
+ await useAppStore
+ .getState()
+ .createInstance(inst, true, parent ? { parent } : undefined);
return ok();
} catch (err) {
return fail(dataSourceCreate.host, err);
@@ -554,7 +575,7 @@ export function InstanceFormProvider({
}
}
},
- [isCreating, basicInfo, instance, extractDataSourceFromEdit, t]
+ [isCreating, basicInfo, instance, extractDataSourceFromEdit, parent, t]
);
// Debounced valueChanged to avoid expensive deep comparison on every keystroke.
@@ -586,6 +607,8 @@ export function InstanceFormProvider({
const value: InstanceFormContextValue = useMemo(
() => ({
instance,
+ parent,
+ project,
hideAdvancedFeatures,
state,
setState,
@@ -593,6 +616,7 @@ export function InstanceFormProvider({
isCreating,
allowEdit,
allowCreate,
+ hasPermission,
environment,
basicInfo,
setBasicInfo,
@@ -624,12 +648,15 @@ export function InstanceFormProvider({
}),
[
instance,
+ parent,
+ project,
hideAdvancedFeatures,
state,
specs,
isCreating,
allowEdit,
allowCreate,
+ hasPermission,
environment,
basicInfo,
labelKVList,
diff --git a/frontend/src/components/instance/InstanceSyncButton.tsx b/frontend/src/components/instance/InstanceSyncButton.tsx
index e2dbdc60ad..e546f95769 100644
--- a/frontend/src/components/instance/InstanceSyncButton.tsx
+++ b/frontend/src/components/instance/InstanceSyncButton.tsx
@@ -11,7 +11,8 @@ import {
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
import { SyncStatus } from "@/types/proto-es/v1/database_service_pb";
-import { hasWorkspacePermissionV2 } from "@/utils";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import { hasInstancePermission } from "./permission";
interface InstanceSyncButtonProps {
type?: "default" | "primary";
@@ -19,6 +20,7 @@ interface InstanceSyncButtonProps {
disabled?: boolean;
instanceName?: string;
instanceTitle?: string;
+ project?: Project;
onSyncSchema: (enableFullSync: boolean) => void;
}
@@ -26,13 +28,14 @@ export function InstanceSyncButton({
disabled = false,
instanceName = "",
instanceTitle = "",
+ project,
onSyncSchema,
}: InstanceSyncButtonProps) {
const { t } = useTranslation();
const [syncing, setSyncing] = useState(false);
const [open, setOpen] = useState(false);
- const hasPermission = hasWorkspacePermissionV2("bb.instances.sync");
+ const hasPermission = hasInstancePermission(project, "bb.instances.sync");
const syncSchema = useCallback(
async (option: "sync-all" | "sync-new") => {
diff --git a/frontend/src/components/instance/permission.test.ts b/frontend/src/components/instance/permission.test.ts
new file mode 100644
index 0000000000..7a17238a4f
--- /dev/null
+++ b/frontend/src/components/instance/permission.test.ts
@@ -0,0 +1,42 @@
+import { create } from "@bufbuild/protobuf";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
+import { hasInstancePermission } from "./permission";
+
+const mocks = vi.hoisted(() => ({
+ hasProjectPermissionV2: vi.fn(),
+ hasWorkspacePermissionV2: vi.fn(),
+}));
+
+vi.mock("@/utils/iam/permission", () => ({
+ hasProjectPermissionV2: mocks.hasProjectPermissionV2,
+ hasWorkspacePermissionV2: mocks.hasWorkspacePermissionV2,
+}));
+
+describe("hasInstancePermission", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ });
+
+ test("checks project IAM when a project owns the instance", () => {
+ const project = create(ProjectSchema, { name: "projects/app" });
+ mocks.hasProjectPermissionV2.mockReturnValue(true);
+
+ expect(hasInstancePermission(project, "bb.instances.update")).toBe(true);
+ expect(mocks.hasProjectPermissionV2).toHaveBeenCalledWith(
+ project,
+ "bb.instances.update"
+ );
+ expect(mocks.hasWorkspacePermissionV2).not.toHaveBeenCalled();
+ });
+
+ test("checks workspace IAM when the workspace owns the instance", () => {
+ mocks.hasWorkspacePermissionV2.mockReturnValue(false);
+
+ expect(hasInstancePermission(undefined, "bb.instances.update")).toBe(false);
+ expect(mocks.hasWorkspacePermissionV2).toHaveBeenCalledWith(
+ "bb.instances.update"
+ );
+ expect(mocks.hasProjectPermissionV2).not.toHaveBeenCalled();
+ });
+});
diff --git a/frontend/src/components/instance/permission.ts b/frontend/src/components/instance/permission.ts
new file mode 100644
index 0000000000..fbfc948f3f
--- /dev/null
+++ b/frontend/src/components/instance/permission.ts
@@ -0,0 +1,14 @@
+import type { Permission } from "@/types";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import {
+ hasProjectPermissionV2,
+ hasWorkspacePermissionV2,
+} from "@/utils/iam/permission";
+
+export const hasInstancePermission = (
+ project: Project | undefined,
+ permission: Permission
+): boolean =>
+ project
+ ? hasProjectPermissionV2(project, permission)
+ : hasWorkspacePermissionV2(permission);
diff --git a/frontend/src/routes/workspace/resourceStateFilter.test.ts b/frontend/src/lib/resourceStateFilter.test.ts
similarity index 100%
rename from frontend/src/routes/workspace/resourceStateFilter.test.ts
rename to frontend/src/lib/resourceStateFilter.test.ts
diff --git a/frontend/src/routes/workspace/resourceStateFilter.ts b/frontend/src/lib/resourceStateFilter.ts
similarity index 100%
rename from frontend/src/routes/workspace/resourceStateFilter.ts
rename to frontend/src/lib/resourceStateFilter.ts
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index e7ea728cde..32c321ead9 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -1273,7 +1273,6 @@
"sync-databases": {
"add-database": "+ Add database, press enter to submit",
"description": "Choose which databases to sync from this instance.",
- "project-description": "Synced databases will be added to <project>{{project}}</project>.",
"project-sync-all": "Sync all databases to this project",
"search-database": "Search database",
"self": "Sync Databases",
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index bc8f286c0b..dd6af5fc86 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -1273,7 +1273,6 @@
"sync-databases": {
"add-database": "+ Agregar base de datos, presione enter para enviar",
"description": "Elige qué bases de datos sincronizar desde esta instancia.",
- "project-description": "Las bases de datos sincronizadas se agregarán a <project>{{project}}</project>.",
"project-sync-all": "Sincronizar todas las bases de datos con este proyecto",
"search-database": "Buscar en la base de datos",
"self": "Sincronizar bases de datos",
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index df2d2f67ae..214ea4380d 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -1273,7 +1273,6 @@
"sync-databases": {
"add-database": "+ データベースを追加し、Enterキーを押して送信します",
"description": "このインスタンスから同期するデータベースを選択してください。",
- "project-description": "同期されたデータベースは <project>{{project}}</project> に追加されます。",
"project-sync-all": "すべてのデータベースをこのプロジェクトに同期する",
"search-database": "データベースを検索",
"self": "データベースを同期する",
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 1e972af386..89dca608b1 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -1273,7 +1273,6 @@
"sync-databases": {
"add-database": "+ Thêm cơ sở dữ liệu, nhấn enter để gửi",
"description": "Chọn cơ sở dữ liệu cần đồng bộ từ instance này.",
- "project-description": "Các cơ sở dữ liệu được đồng bộ sẽ được thêm vào <project>{{project}}</project>.",
"project-sync-all": "Đồng bộ tất cả cơ sở dữ liệu vào dự án này",
"search-database": "Tìm kiếm cơ sở dữ liệu",
"self": "Đồng bộ cơ sở dữ liệu",
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index 411930340c..7d8f57c5ef 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -1273,7 +1273,6 @@
"sync-databases": {
"add-database": "+ 添加数据库,按回车键提交",
"description": "选择要从此实例同步的数据库。",
- "project-description": "同步的数据库将添加到 <project>{{project}}</project>。",
"project-sync-all": "将所有数据库同步到此项目",
"search-database": "搜索数据库",
"self": "同步数据库",
diff --git a/frontend/src/routes/project/ProjectCreateInstancePage.test.tsx b/frontend/src/routes/project/ProjectCreateInstancePage.test.tsx
new file mode 100644
index 0000000000..5c224b5c84
--- /dev/null
+++ b/frontend/src/routes/project/ProjectCreateInstancePage.test.tsx
@@ -0,0 +1,123 @@
+import { create } from "@bufbuild/protobuf";
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { InstanceSchema } from "@/types/proto-es/v1/instance_service_pb";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
+import { ProjectCreateInstancePage } from "./ProjectCreateInstancePage";
+
+const mocks = vi.hoisted(() => ({
+ viewProps: undefined as Record<string, unknown> | undefined,
+ defaultProject: "",
+ project: undefined as unknown,
+ push: vi.fn(),
+ replace: vi.fn(),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: {
+ push: mocks.push,
+ replace: mocks.replace,
+ },
+}));
+
+vi.mock("@/components/instance/CreateInstanceView", () => ({
+ CreateInstanceView: (props: Record<string, unknown>) => {
+ mocks.viewProps = props;
+ return <div data-testid="create-instance-view" />;
+ },
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: (selector: (state: unknown) => unknown) =>
+ selector({
+ projectsByName: mocks.project
+ ? { "projects/app": mocks.project }
+ : {},
+ serverInfo: { defaultProject: mocks.defaultProject },
+ }),
+}));
+
+const renderPage = async () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+ await act(async () => {
+ root.render(
+ <ProjectCreateInstancePage projectId="app" />
+ );
+ });
+ return { root };
+};
+
+describe("ProjectCreateInstancePage", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.viewProps = undefined;
+ mocks.defaultProject = "";
+ mocks.project = create(ProjectSchema, {
+ name: "projects/app",
+ title: "App",
+ });
+ });
+
+ test("provides project ownership to the shared create view", async () => {
+ const page = await renderPage();
+
+ expect(mocks.viewProps).toMatchObject({
+ parent: "projects/app",
+ project: mocks.project,
+ });
+
+ act(() => page.root.unmount());
+ });
+
+ test("opens the nested detail route after creation", async () => {
+ const page = await renderPage();
+ const onCreated = mocks.viewProps?.onCreated as (instance: unknown) => void;
+
+ act(() => {
+ onCreated(
+ create(InstanceSchema, {
+ name: "projects/app/instances/prod",
+ title: "Production",
+ })
+ );
+ });
+
+ expect(mocks.push).toHaveBeenCalledWith({
+ name: "workspace.project.instance.detail",
+ params: { projectId: "app", instanceId: "prod" },
+ query: { syncingInstance: "prod" },
+ hash: "databases",
+ });
+
+ act(() => page.root.unmount());
+ });
+
+ test("returns to the project instance page", async () => {
+ const page = await renderPage();
+ const onDismiss = mocks.viewProps?.onDismiss as () => void;
+
+ act(() => onDismiss());
+
+ expect(mocks.push).toHaveBeenCalledWith({
+ name: "workspace.project.instance",
+ params: { projectId: "app" },
+ });
+
+ act(() => page.root.unmount());
+ });
+
+ test("redirects the default project before rendering the form", async () => {
+ mocks.defaultProject = "projects/app";
+ const page = await renderPage();
+
+ expect(mocks.replace).toHaveBeenCalledWith({
+ name: "workspace.project.database",
+ params: { projectId: "app" },
+ });
+ expect(mocks.viewProps).toBeUndefined();
+
+ act(() => page.root.unmount());
+ });
+});
diff --git a/frontend/src/routes/project/ProjectCreateInstancePage.tsx b/frontend/src/routes/project/ProjectCreateInstancePage.tsx
new file mode 100644
index 0000000000..b5d2e78c46
--- /dev/null
+++ b/frontend/src/routes/project/ProjectCreateInstancePage.tsx
@@ -0,0 +1,63 @@
+import { useCallback, useEffect } from "react";
+import { router } from "@/app/router";
+import {
+ PROJECT_V1_ROUTE_DATABASES,
+ PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+ PROJECT_V1_ROUTE_INSTANCES,
+} from "@/app/router/handles";
+import { CreateInstanceView } from "@/components/instance/CreateInstanceView";
+import { useAppStore } from "@/stores/app";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+import { extractInstanceResourceName } from "@/utils";
+
+export function ProjectCreateInstancePage({
+ projectId,
+}: {
+ projectId: string;
+}) {
+ const parent = `projects/${projectId}`;
+ const project = useAppStore((state) => state.projectsByName[parent]);
+ const defaultProject = useAppStore(
+ (state) => state.serverInfo?.defaultProject ?? ""
+ );
+ const isDefault = parent === defaultProject;
+
+ useEffect(() => {
+ if (!isDefault) return;
+ router.replace({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: { projectId },
+ });
+ }, [isDefault, projectId]);
+
+ const onDismiss = useCallback(() => {
+ router.push({
+ name: PROJECT_V1_ROUTE_INSTANCES,
+ params: { projectId },
+ });
+ }, [projectId]);
+
+ const onCreated = useCallback(
+ (instance: Instance) => {
+ const instanceId = extractInstanceResourceName(instance.name);
+ router.push({
+ name: PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+ params: { projectId, instanceId },
+ query: { syncingInstance: instanceId },
+ hash: "databases",
+ });
+ },
+ [projectId]
+ );
+
+ if (isDefault || !project) return null;
+
+ return (
+ <CreateInstanceView
+ parent={parent}
+ project={project}
+ onDismiss={onDismiss}
+ onCreated={onCreated}
+ />
+ );
+}
diff --git a/frontend/src/routes/project/ProjectDatabasesPage.test.tsx b/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
index c47d548be7..0cf7568cf6 100644
--- a/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
+++ b/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
@@ -26,6 +26,7 @@ const mocks = vi.hoisted(() => ({
"bb.instances.create",
"bb.instances.list",
]),
+ projectPermissions: new Set<string>(["bb.instances.create"]),
}));
let ProjectDatabasesPage: typeof import("./ProjectDatabasesPage").ProjectDatabasesPage;
@@ -235,7 +236,9 @@ vi.mock("@/utils", async () => {
extractInstanceResourceName: (name: string) =>
name.replace(/^instances\//, ""),
getDefaultPagination: () => 1000,
- hasProjectPermissionV2: () => true,
+ hasProjectPermissionV2: (_project: unknown, permission: string) =>
+ permission !== "bb.instances.create" ||
+ mocks.projectPermissions.has(permission),
hasWorkspacePermissionV2: (permission: string) =>
mocks.workspacePermissions.has(permission),
PERMISSIONS_FOR_DATABASE_CREATE_ISSUE: [],
@@ -256,6 +259,7 @@ beforeEach(async () => {
"bb.instances.get",
"bb.instances.list",
]);
+ mocks.projectPermissions = new Set(["bb.instances.create"]);
({ ProjectDatabasesPage } = await import("./ProjectDatabasesPage"));
});
@@ -322,8 +326,8 @@ describe("ProjectDatabasesPage", () => {
});
expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.instance.create",
- query: { project: "demo" },
+ name: "workspace.project.instance.create",
+ params: { projectId: "demo" },
});
expect(mocks.captureMetric).toHaveBeenCalledWith({
event: "connect database clicked",
@@ -373,8 +377,8 @@ describe("ProjectDatabasesPage", () => {
});
});
- test("disables the empty project connect action without workspace instance creation permission", async () => {
- mocks.workspacePermissions.delete("bb.instances.create");
+ test("disables the empty project connect action without project instance creation permission", async () => {
+ mocks.projectPermissions.delete("bb.instances.create");
const container = document.createElement("div");
const root = createRoot(container);
diff --git a/frontend/src/routes/project/ProjectDatabasesPage.tsx b/frontend/src/routes/project/ProjectDatabasesPage.tsx
index 1bb9fa2ea1..2f72db537f 100644
--- a/frontend/src/routes/project/ProjectDatabasesPage.tsx
+++ b/frontend/src/routes/project/ProjectDatabasesPage.tsx
@@ -7,8 +7,8 @@ import { createBehaviorMetric } from "@/app/analytics/behavior";
import { behaviorAnalytics } from "@/app/analytics/provider";
import { router, useCurrentRoute } from "@/app/router";
import {
- INSTANCE_ROUTE_CREATE,
PROJECT_V1_ROUTE_DATABASES,
+ PROJECT_V1_ROUTE_INSTANCE_CREATE,
SQL_EDITOR_DATABASE_MODULE,
} from "@/app/router/handles";
import { markListScrollRestorationEntry } from "@/app/router/NavigationScrollRestoration";
@@ -262,7 +262,7 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
() => selectedDatabases.map((db) => db.name),
[selectedDatabases]
);
- const canCreateInstance = hasWorkspacePermissionV2("bb.instances.create");
+ const canCreateInstance = hasProjectPermission("bb.instances.create");
// Mirror `selectedDatabases` into a ref so the batch-operation handlers
// below can read the latest value without listing it as a dep. Otherwise
@@ -572,7 +572,7 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
const handleCreateDatabaseAction = useCallback(() => {
if (checkingWorkspaceInstance) return;
if (emptyProjectShouldConnectInstance) {
- if (!hasWorkspacePermissionV2("bb.instances.create")) return;
+ if (!hasProjectPermission("bb.instances.create")) return;
behaviorAnalytics.captureMetric(
createBehaviorMetric("connect database clicked", {
routeId: router.currentRoute.value.name?.toString(),
@@ -580,8 +580,8 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
})
);
router.push({
- name: INSTANCE_ROUTE_CREATE,
- query: { project: projectId },
+ name: PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ params: { projectId },
});
return;
}
@@ -589,6 +589,7 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
}, [
checkingWorkspaceInstance,
emptyProjectShouldConnectInstance,
+ hasProjectPermission,
projectId,
projectName,
]);
diff --git a/frontend/src/routes/project/ProjectInstanceDetailPage.test.tsx b/frontend/src/routes/project/ProjectInstanceDetailPage.test.tsx
new file mode 100644
index 0000000000..b1f17cd0c6
--- /dev/null
+++ b/frontend/src/routes/project/ProjectInstanceDetailPage.test.tsx
@@ -0,0 +1,89 @@
+import { create } from "@bufbuild/protobuf";
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
+import { ProjectInstanceDetailPage } from "./ProjectInstanceDetailPage";
+
+const mocks = vi.hoisted(() => ({
+ viewProps: undefined as Record<string, unknown> | undefined,
+ defaultProject: "",
+ project: undefined as unknown,
+ replace: vi.fn(),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: { replace: mocks.replace },
+}));
+
+vi.mock("@/components/instance/InstanceDetailView", () => ({
+ InstanceDetailView: (props: Record<string, unknown>) => {
+ mocks.viewProps = props;
+ return <div />;
+ },
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: (selector: (state: unknown) => unknown) =>
+ selector({
+ projectsByName: mocks.project
+ ? { "projects/app": mocks.project }
+ : {},
+ serverInfo: { defaultProject: mocks.defaultProject },
+ }),
+}));
+
+describe("ProjectInstanceDetailPage", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.viewProps = undefined;
+ mocks.defaultProject = "";
+ mocks.project = create(ProjectSchema, {
+ name: "projects/app",
+ title: "App",
+ });
+ });
+
+ test("renders the nested instance with project ownership", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+ act(() =>
+ root.render(
+ <ProjectInstanceDetailPage projectId="app" instanceId="prod" />
+ )
+ );
+
+ expect(mocks.viewProps).toMatchObject({
+ instanceName: "projects/app/instances/prod",
+ project: mocks.project,
+ });
+
+ const onLeave = mocks.viewProps?.onLeave as () => void;
+ act(() => onLeave());
+ expect(mocks.replace).toHaveBeenCalledWith({
+ name: "workspace.project.instance",
+ params: { projectId: "app" },
+ });
+
+ act(() => root.unmount());
+ });
+
+ test("redirects the default project", () => {
+ mocks.defaultProject = "projects/app";
+ const container = document.createElement("div");
+ const root = createRoot(container);
+ act(() =>
+ root.render(
+ <ProjectInstanceDetailPage projectId="app" instanceId="prod" />
+ )
+ );
+
+ expect(mocks.replace).toHaveBeenCalledWith({
+ name: "workspace.project.database",
+ params: { projectId: "app" },
+ });
+ expect(mocks.viewProps).toBeUndefined();
+
+ act(() => root.unmount());
+ });
+});
diff --git a/frontend/src/routes/project/ProjectInstanceDetailPage.tsx b/frontend/src/routes/project/ProjectInstanceDetailPage.tsx
new file mode 100644
index 0000000000..6f05720ff0
--- /dev/null
+++ b/frontend/src/routes/project/ProjectInstanceDetailPage.tsx
@@ -0,0 +1,50 @@
+import { useCallback, useEffect } from "react";
+import { router } from "@/app/router";
+import {
+ PROJECT_V1_ROUTE_DATABASES,
+ PROJECT_V1_ROUTE_INSTANCES,
+} from "@/app/router/handles";
+import { InstanceDetailView } from "@/components/instance/InstanceDetailView";
+import { useAppStore } from "@/stores/app";
+
+interface ProjectInstanceDetailPageProps {
+ projectId: string;
+ instanceId: string;
+}
+
+export function ProjectInstanceDetailPage({
+ projectId,
+ instanceId,
+}: ProjectInstanceDetailPageProps) {
+ const parent = `projects/${projectId}`;
+ const project = useAppStore((state) => state.projectsByName[parent]);
+ const defaultProject = useAppStore(
+ (state) => state.serverInfo?.defaultProject ?? ""
+ );
+ const isDefault = parent === defaultProject;
+
+ useEffect(() => {
+ if (!isDefault) return;
+ router.replace({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: { projectId },
+ });
+ }, [isDefault, projectId]);
+
+ const onLeave = useCallback(() => {
+ router.replace({
+ name: PROJECT_V1_ROUTE_INSTANCES,
+ params: { projectId },
+ });
+ }, [projectId]);
+
+ if (isDefault || !project) return null;
+
+ return (
+ <InstanceDetailView
+ instanceName={`${parent}/instances/${instanceId}`}
+ project={project}
+ onLeave={onLeave}
+ />
+ );
+}
diff --git a/frontend/src/routes/project/ProjectInstancesPage.test.tsx b/frontend/src/routes/project/ProjectInstancesPage.test.tsx
new file mode 100644
index 0000000000..7f98c7d3eb
--- /dev/null
+++ b/frontend/src/routes/project/ProjectInstancesPage.test.tsx
@@ -0,0 +1,106 @@
+import { create } from "@bufbuild/protobuf";
+import type { ReactNode } from "react";
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import {
+ PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ PROJECT_V1_ROUTE_INSTANCE_DETAIL,
+ PROJECT_V1_ROUTE_INSTANCES,
+} from "@/app/router/handles";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
+import { ProjectInstancesPage } from "./ProjectInstancesPage";
+
+const mocks = vi.hoisted(() => ({
+ dashboardProps: undefined as Record<string, unknown> | undefined,
+ defaultProject: "",
+ project: undefined as unknown,
+ push: vi.fn(),
+ replace: vi.fn(),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: {
+ push: mocks.push,
+ replace: mocks.replace,
+ },
+}));
+
+vi.mock("@/components/instance/InstanceDashboard", () => ({
+ InstanceDashboard: (props: Record<string, unknown>) => {
+ mocks.dashboardProps = props;
+ return <div data-testid="instance-dashboard" />;
+ },
+}));
+
+vi.mock("@/components/ProjectPageLayout", () => ({
+ ProjectPageLayout: ({ children }: { children: ReactNode }) => (
+ <div>{children}</div>
+ ),
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: (selector: (state: unknown) => unknown) =>
+ selector({
+ projectsByName: mocks.project
+ ? { "projects/app": mocks.project }
+ : {},
+ serverInfo: { defaultProject: mocks.defaultProject },
+ }),
+}));
+
+const renderPage = async () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+ await act(async () => {
+ root.render(<ProjectInstancesPage projectId="app" />);
+ });
+ return { container, root };
+};
+
+describe("ProjectInstancesPage", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.dashboardProps = undefined;
+ mocks.defaultProject = "";
+ mocks.project = create(ProjectSchema, {
+ name: "projects/app",
+ title: "App",
+ });
+ });
+
+ test("defines project instance route handles", () => {
+ expect(PROJECT_V1_ROUTE_INSTANCES).toBe("workspace.project.instance");
+ expect(PROJECT_V1_ROUTE_INSTANCE_CREATE).toBe(
+ "workspace.project.instance.create"
+ );
+ expect(PROJECT_V1_ROUTE_INSTANCE_DETAIL).toBe(
+ "workspace.project.instance.detail"
+ );
+ });
+
+ test("renders the shared dashboard with the exact project parent", async () => {
+ const page = await renderPage();
+
+ expect(mocks.dashboardProps).toMatchObject({
+ parent: "projects/app",
+ project: mocks.project,
+ layout: "project",
+ });
+
+ act(() => page.root.unmount());
+ });
+
+ test("redirects the default project before rendering the dashboard", async () => {
+ mocks.defaultProject = "projects/app";
+ const page = await renderPage();
+
+ expect(mocks.replace).toHaveBeenCalledWith({
+ name: "workspace.project.database",
+ params: { projectId: "app" },
+ });
+ expect(mocks.dashboardProps).toBeUndefined();
+
+ act(() => page.root.unmount());
+ });
+});
diff --git a/frontend/src/routes/project/ProjectInstancesPage.tsx b/frontend/src/routes/project/ProjectInstancesPage.tsx
new file mode 100644
index 0000000000..2e7e3b6b2d
--- /dev/null
+++ b/frontend/src/routes/project/ProjectInstancesPage.tsx
@@ -0,0 +1,60 @@
+import { useCallback, useEffect } from "react";
+import { router } from "@/app/router";
+import {
+ PROJECT_V1_ROUTE_DATABASES,
+ PROJECT_V1_ROUTE_INSTANCE_CREATE,
+} from "@/app/router/handles";
+import { markListScrollRestorationEntry } from "@/app/router/NavigationScrollRestoration";
+import { InstanceDashboard } from "@/components/instance/InstanceDashboard";
+import { ProjectPageLayout } from "@/components/ProjectPageLayout";
+import { useAppStore } from "@/stores/app";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+
+export function ProjectInstancesPage({ projectId }: { projectId: string }) {
+ const parent = `projects/${projectId}`;
+ const project = useAppStore((state) => state.projectsByName[parent]);
+ const defaultProject = useAppStore(
+ (state) => state.serverInfo?.defaultProject ?? ""
+ );
+ const isDefault = parent === defaultProject;
+
+ useEffect(() => {
+ if (!isDefault) return;
+ router.replace({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: { projectId },
+ });
+ }, [isDefault, projectId]);
+
+ const handleOpen = useCallback(
+ (instance: Instance, event: React.MouseEvent) => {
+ const url = `/${instance.name}`;
+ if (event.ctrlKey || event.metaKey) {
+ window.open(url, "_blank");
+ return;
+ }
+ markListScrollRestorationEntry();
+ router.push(url);
+ },
+ []
+ );
+
+ if (isDefault || !project) return null;
+
+ return (
+ <ProjectPageLayout>
+ <InstanceDashboard
+ parent={parent}
+ project={project}
+ layout="project"
+ onCreate={() =>
+ router.push({
+ name: PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ params: { projectId },
+ })
+ }
+ onOpen={handleOpen}
+ />
+ </ProjectPageLayout>
+ );
+}
diff --git a/frontend/src/routes/project/ProjectPageLayout.test.ts b/frontend/src/routes/project/ProjectPageLayout.test.ts
index 468ed36b0b..0fd5d9214e 100644
--- a/frontend/src/routes/project/ProjectPageLayout.test.ts
+++ b/frontend/src/routes/project/ProjectPageLayout.test.ts
@@ -13,6 +13,7 @@ const projectListPages = [
"ProjectDatabasesPage.tsx",
"ProjectGitOpsPage.tsx",
"ProjectIssueDashboardPage.tsx",
+ "ProjectInstancesPage.tsx",
"ProjectPlanDashboardPage.tsx",
"ProjectReleaseDashboardPage.tsx",
"ProjectWebhooksPage.tsx",
diff --git a/frontend/src/routes/workspace/CreateInstancePage.test.tsx b/frontend/src/routes/workspace/CreateInstancePage.test.tsx
index 123553c749..97d033344d 100644
--- a/frontend/src/routes/workspace/CreateInstancePage.test.tsx
+++ b/frontend/src/routes/workspace/CreateInstancePage.test.tsx
@@ -1,257 +1,68 @@
+import { create } from "@bufbuild/protobuf";
import { act } from "react";
import { createRoot } from "react-dom/client";
import { beforeEach, describe, expect, test, vi } from "vitest";
-
-(
- globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
-).IS_REACT_ACT_ENVIRONMENT = true;
+import { InstanceSchema } from "@/types/proto-es/v1/instance_service_pb";
+import { CreateInstancePage } from "./CreateInstancePage";
const mocks = vi.hoisted(() => ({
- useUnsavedChangesGuard: vi.fn(),
- routerCurrentQuery: {} as Record<string, unknown>,
- routerPush: vi.fn(),
- instanceFormContext: {
- basicInfo: { engine: 0 },
- state: { isRequesting: false },
- valueChanged: false,
- },
-}));
-
-let CreateInstancePage: typeof import("./CreateInstancePage").CreateInstancePage;
-
-vi.mock("react-i18next", () => ({
- initReactI18next: { type: "3rdParty", init: () => {} },
- useTranslation: () => ({ t: (key: string) => key }),
-}));
-
-vi.mock("@/hooks/useUnsavedChangesGuard", () => ({
- useUnsavedChangesGuard: mocks.useUnsavedChangesGuard,
+ push: vi.fn(),
+ viewProps: undefined as Record<string, unknown> | undefined,
}));
vi.mock("@/app/router", () => ({
- router: {
- push: mocks.routerPush,
- currentRoute: {
- get value() {
- return { query: mocks.routerCurrentQuery };
- },
- },
- },
+ router: { push: mocks.push },
}));
-vi.mock("@/stores/app", () => ({
- useAppStore: {
- getState: () => ({
- instanceCountLimit: () => 10,
- activatedInstanceCount: () => 0,
- }),
+vi.mock("@/components/instance/CreateInstanceView", () => ({
+ CreateInstanceView: (props: Record<string, unknown>) => {
+ mocks.viewProps = props;
+ return <div data-testid="create-instance-view" />;
},
}));
-vi.mock("@/stores", () => ({
- pushNotification: vi.fn(),
-}));
-
-vi.mock("@/components/instance", () => ({
- InfoPanel: ({ children }: { children: React.ReactNode }) => (
- <div>{children}</div>
- ),
- InfoPanelContent: () => <div />,
- InstanceFormBody: () => <div data-testid="instance-form-body" />,
- InstanceFormButtons: ({ className }: { className?: string }) => (
- <div data-testid="instance-form-buttons" className={className} />
- ),
- InstanceFormProvider: ({
- children,
- onDismiss,
- }: {
- children: React.ReactNode;
- onDismiss?: () => void;
- }) => (
- <div>
- <button type="button" data-testid="dismiss" onClick={onDismiss}>
- dismiss
- </button>
- {children}
- </div>
- ),
- useInstanceFormContext: () => mocks.instanceFormContext,
-}));
-
-beforeEach(async () => {
- vi.clearAllMocks();
- mocks.routerCurrentQuery = {};
- mocks.instanceFormContext.state.isRequesting = false;
- mocks.instanceFormContext.valueChanged = false;
- globalThis.ResizeObserver = class ResizeObserver {
- observe() {}
- unobserve() {}
- disconnect() {}
- } as typeof ResizeObserver;
- ({ CreateInstancePage } = await import("./CreateInstancePage"));
-});
-
describe("CreateInstancePage", () => {
- test("keeps the scroll container flush with the page edge", () => {
- const container = document.createElement("div");
- const root = createRoot(container);
-
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- const page = container.firstElementChild;
- expect(page).not.toHaveClass("px-4");
- expect(page).not.toHaveClass("sm:px-6");
-
- const bodyPadding = container.querySelector(
- "[data-testid='instance-form-body']"
- )?.parentElement;
- expect(bodyPadding).toHaveClass("px-4");
- expect(bodyPadding).toHaveClass("sm:px-6");
-
- const buttons = container.querySelector(
- "[data-testid='instance-form-buttons']"
- );
- expect(buttons).not.toHaveClass("px-4");
- expect(buttons).not.toHaveClass("sm:px-6");
-
- act(() => {
- root.unmount();
- });
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.viewProps = undefined;
});
- test("guards navigation when the create form has unsaved changes", () => {
+ test("renders the workspace-owned create view", () => {
const container = document.createElement("div");
const root = createRoot(container);
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(false);
-
- mocks.instanceFormContext.valueChanged = true;
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(true);
+ act(() => root.render(<CreateInstancePage />));
- mocks.instanceFormContext.state.isRequesting = true;
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- expect(mocks.useUnsavedChangesGuard).toHaveBeenLastCalledWith(false);
-
- act(() => {
- root.unmount();
- });
+ expect(mocks.viewProps).not.toHaveProperty("parent");
+ act(() => root.unmount());
});
- test("dismisses to the workspace instance dashboard by default", () => {
+ test("opens the workspace instance detail after creation", () => {
const container = document.createElement("div");
const root = createRoot(container);
+ act(() => root.render(<CreateInstancePage />));
+ const onCreated = mocks.viewProps?.onCreated as (instance: unknown) => void;
act(() => {
- root.render(<CreateInstancePage />);
+ onCreated(
+ create(InstanceSchema, {
+ name: "instances/prod",
+ title: "Production",
+ })
+ );
});
- const dismiss = container.querySelector(
- "[data-testid='dismiss']"
- ) as HTMLButtonElement;
- act(() => {
- dismiss.click();
- });
-
- expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.instance",
- });
-
- act(() => {
- root.unmount();
- });
- });
-
- test("dismisses to the project database page when project context is present", () => {
- mocks.routerCurrentQuery = { project: "demo" };
- const container = document.createElement("div");
- const root = createRoot(container);
-
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- const dismiss = container.querySelector(
- "[data-testid='dismiss']"
- ) as HTMLButtonElement;
- act(() => {
- dismiss.click();
- });
-
- expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.project.database",
- params: { projectId: "demo" },
- });
-
- act(() => {
- root.unmount();
- });
- });
-
- test("keeps syncing instance and intro context when dismissing to the project database page", () => {
- mocks.routerCurrentQuery = {
- project: "demo",
- syncingInstance: "prod",
- intro: "connect-database",
- };
- const container = document.createElement("div");
- const root = createRoot(container);
-
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- const dismiss = container.querySelector(
- "[data-testid='dismiss']"
- ) as HTMLButtonElement;
- act(() => {
- dismiss.click();
- });
-
- expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.project.database",
- params: { projectId: "demo" },
+ expect(mocks.push).toHaveBeenCalledWith({
+ name: "workspace.instance.detail",
+ params: { instanceId: "prod" },
query: {
syncingInstance: "prod",
- intro: "connect-database",
+ intro: "prepare-database",
+ tip: "transfer-databases-to-project",
},
+ hash: "databases",
});
- act(() => {
- root.unmount();
- });
- });
-
- test("shows the instance form directly for project-context setup", () => {
- mocks.routerCurrentQuery = { project: "demo" };
- const container = document.createElement("div");
- const root = createRoot(container);
-
- act(() => {
- root.render(<CreateInstancePage />);
- });
-
- expect(container.textContent).not.toContain(
- "instance.create-readiness.title"
- );
- expect(
- container.querySelector("[data-testid='instance-form-body']")
- ).not.toBe(null);
-
- act(() => {
- root.unmount();
- });
+ act(() => root.unmount());
});
});
diff --git a/frontend/src/routes/workspace/CreateInstancePage.tsx b/frontend/src/routes/workspace/CreateInstancePage.tsx
index 3f5be0da5d..a4524d76ee 100644
--- a/frontend/src/routes/workspace/CreateInstancePage.tsx
+++ b/frontend/src/routes/workspace/CreateInstancePage.tsx
@@ -1,204 +1,37 @@
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { useTranslation } from "react-i18next";
+import { useCallback } from "react";
import { router } from "@/app/router";
import {
INSTANCE_ROUTE_DASHBOARD,
- PROJECT_V1_ROUTE_DATABASES,
+ INSTANCE_ROUTE_DETAIL,
} from "@/app/router/handles";
+import { CreateInstanceView } from "@/components/instance/CreateInstanceView";
import {
- InfoPanel,
- InfoPanelContent,
- InstanceFormBody,
- InstanceFormButtons,
- InstanceFormProvider,
- useInstanceFormContext,
-} from "@/components/instance";
-import type { InfoSection } from "@/components/instance/info-content";
-import { useUnsavedChangesGuard } from "@/hooks/useUnsavedChangesGuard";
-import { pushNotification } from "@/stores";
-import { useAppStore } from "@/stores/app";
-
-const MIN_DOCKED_MAIN_WIDTH = 700;
-const DOCKED_INFO_RAIL_WIDTH = 500;
-const DOCKED_INFO_RAIL_GAP = 16;
-const MIN_DOCKED_LAYOUT_WIDTH =
- MIN_DOCKED_MAIN_WIDTH + DOCKED_INFO_RAIL_WIDTH + DOCKED_INFO_RAIL_GAP;
+ PREPARE_DATABASE_PRODUCT_INTRO,
+ PREPARE_DATABASE_TRANSFER_TIP,
+ PRODUCT_INTRO_QUERY_KEY,
+ PRODUCT_INTRO_TIP_QUERY_KEY,
+} from "@/lib/productIntro";
+import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
+import { extractInstanceResourceName } from "@/utils";
export function CreateInstancePage() {
- const { t } = useTranslation();
-
- // Check instance limit on mount
- useEffect(() => {
- const store = useAppStore.getState();
- if (store.instanceCountLimit() <= store.activatedInstanceCount()) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("subscription.usage.instance-count.title"),
- description: t("subscription.usage.instance-count.runoutof", {
- total: store.instanceCountLimit(),
- }),
- });
- router.push({ name: INSTANCE_ROUTE_DASHBOARD });
- }
- }, [t]);
-
- const goBack = useCallback(() => {
- const {
- project: projectId,
- syncingInstance,
- intro,
- } = router.currentRoute.value.query;
- if (typeof projectId === "string" && projectId) {
- const query: Record<string, string> = {};
- if (typeof syncingInstance === "string" && syncingInstance) {
- query.syncingInstance = syncingInstance;
- }
- if (typeof intro === "string" && intro) {
- query.intro = intro;
- }
- router.push({
- name: PROJECT_V1_ROUTE_DATABASES,
- params: { projectId },
- ...(Object.keys(query).length > 0 ? { query } : {}),
- });
- return;
- }
+ const onDismiss = useCallback(() => {
router.push({ name: INSTANCE_ROUTE_DASHBOARD });
}, []);
- return (
- <div className="h-full overflow-hidden">
- <InstanceFormProvider onDismiss={goBack}>
- <CreateInstanceFormInner />
- </InstanceFormProvider>
- </div>
- );
-}
-
-function CreateInstanceFormInner() {
- const { t } = useTranslation();
- const ctx = useInstanceFormContext();
- const currentEngine = ctx.basicInfo.engine;
-
- const [activeInfoSection, setActiveInfoSection] = useState<
- InfoSection | undefined
- >();
- const layoutRef = useRef<HTMLDivElement>(null);
- const [layoutWidth, setLayoutWidth] = useState(0);
-
- useEffect(() => {
- const el = layoutRef.current;
- if (!el) return;
- const observer = new ResizeObserver((entries) => {
- for (const entry of entries) {
- setLayoutWidth(entry.contentRect.width);
- }
+ const onCreated = useCallback((instance: Instance) => {
+ const instanceId = extractInstanceResourceName(instance.name);
+ router.push({
+ name: INSTANCE_ROUTE_DETAIL,
+ params: { instanceId },
+ query: {
+ syncingInstance: instanceId,
+ [PRODUCT_INTRO_QUERY_KEY]: PREPARE_DATABASE_PRODUCT_INTRO,
+ [PRODUCT_INTRO_TIP_QUERY_KEY]: PREPARE_DATABASE_TRANSFER_TIP,
+ },
+ hash: "databases",
});
- observer.observe(el);
- return () => observer.disconnect();
- }, []);
-
- const canUseDockedInfoLayout = layoutWidth >= MIN_DOCKED_LAYOUT_WIDTH;
- const showDockedInfoPanel = !!activeInfoSection && canUseDockedInfoLayout;
- const showOverlayInfoPanel = !!activeInfoSection && !canUseDockedInfoLayout;
-
- const layoutStyle = useMemo(() => {
- if (!canUseDockedInfoLayout || !showDockedInfoPanel) {
- return {
- gridTemplateColumns: "minmax(0, 1fr)",
- columnGap: "0rem",
- };
- }
- return {
- gridTemplateColumns: `minmax(${MIN_DOCKED_MAIN_WIDTH}px, 1fr) ${DOCKED_INFO_RAIL_WIDTH}px`,
- columnGap: `${DOCKED_INFO_RAIL_GAP}px`,
- };
- }, [canUseDockedInfoLayout, showDockedInfoPanel]);
-
- const infoPanelTitle = useMemo(() => {
- if (!activeInfoSection) return "";
- const titleMap: Record<InfoSection, string> = {
- host: t("instance.host-or-socket"),
- port: t("instance.port"),
- authentication: t("instance.connection-info"),
- ssl: t("data-source.ssl-connection"),
- ssh: t("data-source.ssh-connection"),
- database: t("common.database"),
- "sync-databases": t("instance.sync-databases.sync-all"),
- };
- return titleMap[activeInfoSection] ?? "";
- }, [activeInfoSection, t]);
-
- const handleDockedInfoPanelOutsideClick = useCallback(
- (event: React.MouseEvent) => {
- if (!showDockedInfoPanel) return;
- const target = event.target;
- if (!(target instanceof Element)) return;
- if (target.closest("[data-info-panel-docked='true']")) return;
- setActiveInfoSection(undefined);
- },
- [showDockedInfoPanel]
- );
-
- const handleOpenInfoPanel = useCallback((section: InfoSection) => {
- setActiveInfoSection(section);
}, []);
- return (
- <div
- ref={layoutRef}
- className="grid h-full w-full min-h-0 min-w-0"
- style={layoutStyle}
- onClick={handleDockedInfoPanelOutsideClick}
- >
- <div className="min-w-0 min-h-0 flex-1 flex flex-col">
- {/* Body */}
- <div className="flex-1 min-h-0 overflow-auto">
- <div className="px-4 py-4 sm:px-6">
- <InstanceFormBody onOpenInfoPanel={handleOpenInfoPanel} />
- </div>
- </div>
-
- <InstanceFormButtons />
- <UnsavedChangesGuard />
- </div>
-
- {/* Docked info panel */}
- <InfoPanel
- visible={showDockedInfoPanel}
- mode="docked"
- title={infoPanelTitle}
- onClose={() => setActiveInfoSection(undefined)}
- >
- {activeInfoSection && (
- <InfoPanelContent
- engine={currentEngine}
- section={activeInfoSection}
- />
- )}
- </InfoPanel>
-
- {/* Overlay info panel */}
- <InfoPanel
- visible={showOverlayInfoPanel}
- mode="overlay"
- title={infoPanelTitle}
- onClose={() => setActiveInfoSection(undefined)}
- >
- {activeInfoSection && (
- <InfoPanelContent
- engine={currentEngine}
- section={activeInfoSection}
- />
- )}
- </InfoPanel>
- </div>
- );
-}
-
-function UnsavedChangesGuard() {
- const { state, valueChanged } = useInstanceFormContext();
- useUnsavedChangesGuard(valueChanged && !state.isRequesting);
- return null;
+ return <CreateInstanceView onDismiss={onDismiss} onCreated={onCreated} />;
}
diff --git a/frontend/src/routes/workspace/InstanceDetailPage.test.tsx b/frontend/src/routes/workspace/InstanceDetailPage.test.tsx
index eeb7f6e629..286e5494fe 100644
--- a/frontend/src/routes/workspace/InstanceDetailPage.test.tsx
+++ b/frontend/src/routes/workspace/InstanceDetailPage.test.tsx
@@ -1,329 +1,27 @@
-import type { ReactElement, ReactNode } from "react";
-import { act, useEffect } from "react";
+import { act } from "react";
import { createRoot } from "react-dom/client";
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import type { Database } from "@/types/proto-es/v1/database_service_pb";
-import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
-import type { Project } from "@/types/proto-es/v1/project_service_pb";
-
-(
- globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
-).IS_REACT_ACT_ENVIRONMENT = true;
+import { describe, expect, test, vi } from "vitest";
+import { InstanceDetailPage } from "./InstanceDetailPage";
const mocks = vi.hoisted(() => ({
- location: {
- pathname: "/instances/prod",
- search: "?syncingInstance=prod",
- hash: "#databases",
- },
- navigate: vi.fn(),
- databases: [
- {
- name: "instances/prod/databases/app",
- project: "projects/default",
- },
- ] as Database[],
- projects: [{ name: "projects/default" }] as Project[],
- instance: {
- name: "instances/prod",
- title: "Prod",
- engine: 1,
- state: 1,
- environment: "environments/test",
- roles: [],
- } as unknown as Instance,
- fetchProjectList: vi.fn(async () => ({
- projects: [] as Project[],
- nextPageToken: "",
- })),
- getOrFetchInstanceByName: vi.fn(),
- removeDatabaseMetadataCache: vi.fn(),
- removeCacheByInstance: vi.fn(),
- syncInstance: vi.fn(),
- batchSyncDatabases: vi.fn(),
- batchUpdateDatabases: vi.fn(),
- pushNotification: vi.fn(),
- routerPush: vi.fn(),
-}));
-
-vi.mock("react-router", () => ({
- useLocation: () => mocks.location,
- useNavigate: () => mocks.navigate,
-}));
-
-vi.mock("@/app/router", () => ({
- PROJECT_V1_ROUTE_DATABASES: "workspace.project.database",
- router: {
- beforeEach: () => () => {},
- push: mocks.routerPush,
- },
-}));
-
-vi.mock("react-i18next", () => ({
- initReactI18next: { type: "3rdParty", init: () => {} },
- Trans: ({
- i18nKey,
- components,
- }: {
- i18nKey: string;
- components?: { instance?: ReactNode };
- }) => (
- <>
- {i18nKey}
- {components?.instance}
- </>
- ),
- useTranslation: () => ({
- t: (key: string) => key,
- }),
-}));
-
-vi.mock("@/stores/app", () => {
- const getState = () => ({
- databasesByName: {},
- projectsByName: {},
- getDatabaseByName: (name: string) =>
- mocks.databases.find((database) => database.name === name) ??
- mocks.databases[0],
- removeDatabaseMetadataCache: mocks.removeDatabaseMetadataCache,
- instancesByName: { "instances/prod": mocks.instance },
- environmentList: [],
- serverInfo: { defaultProject: "projects/default" },
- });
- const useAppStore = (selector?: (s: ReturnType<typeof getState>) => unknown) =>
- selector ? selector(getState()) : getState();
- useAppStore.getState = () => ({
- ...getState(),
- getOrFetchInstanceByName: mocks.getOrFetchInstanceByName,
- syncInstance: mocks.syncInstance,
- removeCacheByInstance: mocks.removeCacheByInstance,
- batchSyncDatabases: mocks.batchSyncDatabases,
- batchUpdateDatabases: mocks.batchUpdateDatabases,
- fetchProjectList: mocks.fetchProjectList,
- });
- return { useAppStore };
-});
-
-vi.mock("@/stores", () => ({
- pushNotification: mocks.pushNotification,
-}));
-
-vi.mock("@/utils", () => ({
- extractDatabaseResourceName: (name: string) => {
- const [, instanceName, , databaseName] = name.split("/");
- return { instanceName, databaseName };
- },
- extractInstanceResourceName: (name: string) => name.split("/").pop() ?? "",
- extractProjectResourceName: (name: string) => name.split("/").pop() ?? "",
- getDefaultPagination: () => 10,
- hasWorkspacePermissionV2: () => true,
- instanceV1Name: (instance: Instance) => instance.title,
- isNullOrUndefined: (value: unknown) => value === null || value === undefined,
- isValidDatabaseName: (name: string) =>
- /^instances\/[^/]+\/databases\/[^/]+$/.test(name),
- setDocumentTitle: vi.fn(),
-}));
-
-vi.mock("@/components/AdvancedSearch", () => ({
- AdvancedSearch: () => <div />,
- getValueFromScopes: () => undefined,
-}));
-
-vi.mock("@/components/EngineIcon", () => ({
- EngineIcon: () => <div />,
-}));
-
-vi.mock("@/components/EnvironmentLabel", () => ({
- EnvironmentLabel: () => <div />,
-}));
-
-vi.mock("@/components/EditEnvironmentSheet", () => ({
- EditEnvironmentSheet: () => null,
-}));
-
-vi.mock("@/components/ui/tabs", () => ({
- Tabs: ({ children }: { children: ReactNode }) => <div>{children}</div>,
- TabsList: ({ children }: { children: ReactNode }) => <div>{children}</div>,
- TabsPanel: ({ children }: { children: ReactNode }) => <div>{children}</div>,
- TabsTrigger: ({ children }: { children: ReactNode }) => (
- <button type="button">{children}</button>
- ),
-}));
-
-vi.mock("@/components/instance", () => ({
- InstanceActionDropdown: () => null,
- InstanceFormBody: () => null,
- InstanceFormButtons: () => null,
- InstanceFormProvider: ({ children }: { children: ReactNode }) => (
- <div>{children}</div>
- ),
- InstanceRoleTable: () => null,
- InstanceSyncButton: () => null,
- useInstanceFormContext: () => ({ isDirty: false }),
+ viewProps: undefined as Record<string, unknown> | undefined,
}));
-vi.mock("@/components/database", () => ({
- CreateDatabaseSheet: () => null,
- DatabaseBatchOperationsBar: () => null,
- DatabaseTable: ({
- onDatabasesChange,
- selectionColumnIntroTarget,
- }: {
- onDatabasesChange?: (databases: Database[]) => void;
- selectionColumnIntroTarget?: string;
- }) => {
- useEffect(() => {
- onDatabasesChange?.(mocks.databases);
- }, [onDatabasesChange]);
- return (
- <div
- data-selection-column-intro-target={selectionColumnIntroTarget ?? ""}
- />
- );
+vi.mock("@/components/instance/InstanceDetailView", () => ({
+ InstanceDetailView: (props: Record<string, unknown>) => {
+ mocks.viewProps = props;
+ return <div />;
},
- LabelEditorSheet: () => null,
- TransferProjectSheet: ({
- open,
- onTransfer,
- }: {
- open: boolean;
- onTransfer: (projectName: string) => Promise<void>;
- }) =>
- open ? (
- <button
- type="button"
- data-testid="transfer-project-sheet"
- onClick={() => {
- void onTransfer("projects/app");
- }}
- >
- transfer
- </button>
- ) : null,
}));
-vi.mock("@/lib/productIntro", () => ({
- PREPARE_DATABASE_PRODUCT_INTRO: "prepare-database",
- PREPARE_DATABASE_TRANSFER_TIP: "transfer-databases-to-project",
- PRODUCT_INTRO_TIP_QUERY_KEY: "tip",
- useProductIntro: vi.fn(),
-}));
-
-import { InstanceDetailPage } from "./InstanceDetailPage";
-
-let container: HTMLDivElement;
-let root: ReturnType<typeof createRoot>;
-
-const render = async (element: ReactElement) => {
- await act(async () => {
- root.render(element);
- await Promise.resolve();
- await Promise.resolve();
- await Promise.resolve();
- });
-};
-
-beforeEach(() => {
- vi.clearAllMocks();
- mocks.location = {
- pathname: "/instances/prod",
- search: "?syncingInstance=prod",
- hash: "#databases",
- };
- mocks.databases = [
- {
- name: "instances/prod/databases/app",
- project: "projects/default",
- },
- ] as Database[];
- mocks.projects = [{ name: "projects/default" }] as Project[];
- mocks.fetchProjectList.mockImplementation(async () => ({
- projects: mocks.projects,
- nextPageToken: "",
- }));
- container = document.createElement("div");
- document.body.appendChild(container);
- root = createRoot(container);
-});
-
-afterEach(() => {
- act(() => {
- root.unmount();
- });
- document.body.removeChild(container);
-});
-
describe("InstanceDetailPage", () => {
- it("does not show the post-sync transfer action when there is no user project", async () => {
- await render(<InstanceDetailPage instanceId="prod" />);
-
- expect(container.textContent).not.toContain(
- "db.instance-databases-synced-title"
- );
- expect(mocks.fetchProjectList).toHaveBeenCalled();
- });
-
- it("shows the post-sync transfer action when there is a user project", async () => {
- mocks.projects = [
- { name: "projects/default" },
- { name: "projects/app" },
- ] as Project[];
-
- await render(<InstanceDetailPage instanceId="prod" />);
-
- expect(container.textContent).toContain(
- "db.instance-databases-synced-title"
- );
- });
-
- it("highlights the database selection column for the post-sync transfer guide", async () => {
- mocks.location.search =
- "?syncingInstance=prod&intro=prepare-database&tip=transfer-databases-to-project";
- mocks.projects = [
- { name: "projects/default" },
- { name: "projects/app" },
- ] as Project[];
-
- await render(<InstanceDetailPage instanceId="prod" />);
-
- expect(
- container
- .querySelector("[data-selection-column-intro-target]")
- ?.getAttribute("data-selection-column-intro-target")
- ).toBe("prepare-database");
- });
-
- it("redirects to the target project databases page after transferring from the instance database list", async () => {
- mocks.projects = [
- { name: "projects/default" },
- { name: "projects/app" },
- ] as Project[];
-
- await render(<InstanceDetailPage instanceId="prod" />);
-
- const transferSyncedButton = Array.from(
- container.querySelectorAll("button")
- ).find((button) =>
- button.textContent?.includes("db.instance-databases-synced-action")
- ) as HTMLButtonElement;
- await act(async () => {
- transferSyncedButton.click();
- await Promise.resolve();
- });
+ test("renders a workspace-owned instance", () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
- const transferSheet = container.querySelector(
- '[data-testid="transfer-project-sheet"]'
- ) as HTMLButtonElement;
- await act(async () => {
- transferSheet.click();
- await Promise.resolve();
- });
+ act(() => root.render(<InstanceDetailPage instanceId="prod" />));
- expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.project.database",
- params: {
- projectId: "app",
- },
- });
+ expect(mocks.viewProps).toEqual({ instanceName: "instances/prod" });
+ act(() => root.unmount());
});
});
diff --git a/frontend/src/routes/workspace/InstanceDetailPage.tsx b/frontend/src/routes/workspace/InstanceDetailPage.tsx
index 14a814bdcd..fae2432d49 100644
--- a/frontend/src/routes/workspace/InstanceDetailPage.tsx
+++ b/frontend/src/routes/workspace/InstanceDetailPage.tsx
@@ -1,739 +1,8 @@
-import { create } from "@bufbuild/protobuf";
-import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { Trans, useTranslation } from "react-i18next";
-import { useLocation, useNavigate } from "react-router";
-import { PROJECT_V1_ROUTE_DATABASES, router } from "@/app/router";
-import {
- AdvancedSearch,
- getValueFromScopes,
- type ScopeOption,
- type SearchParams,
- type ValueOption,
-} from "@/components/AdvancedSearch";
-import {
- CreateDatabaseSheet,
- DatabaseBatchOperationsBar,
- DatabaseTable,
- LabelEditorSheet,
- TransferProjectSheet,
-} from "@/components/database";
-import { EditEnvironmentSheet } from "@/components/EditEnvironmentSheet";
-import { EngineIcon } from "@/components/EngineIcon";
-import { EnvironmentLabel } from "@/components/EnvironmentLabel";
-import { InstanceLabel } from "@/components/InstanceLabel";
-import {
- InstanceActionDropdown,
- InstanceFormBody,
- InstanceFormButtons,
- InstanceFormProvider,
- InstanceRoleTable,
- InstanceSyncButton,
- useInstanceFormContext,
-} from "@/components/instance";
-import { Alert } from "@/components/ui/alert";
-import { Button } from "@/components/ui/button";
-import { Tabs, TabsList, TabsPanel, TabsTrigger } from "@/components/ui/tabs";
-import { useUnsavedChangesGuard } from "@/hooks/useUnsavedChangesGuard";
-import type { DatabaseFilter } from "@/lib/databaseFilter";
-import {
- PREPARE_DATABASE_PRODUCT_INTRO,
- PREPARE_DATABASE_TRANSFER_TIP,
- PRODUCT_INTRO_TIP_QUERY_KEY,
- useProductIntro,
-} from "@/lib/productIntro";
-import { pushNotification } from "@/stores";
-import { useAppStore } from "@/stores/app";
-import {
- environmentNamePrefix,
- instanceNamePrefix,
- projectNamePrefix,
-} from "@/stores/modules/v1/common";
-import {
- isValidDatabaseName,
- UNKNOWN_ENVIRONMENT_NAME,
- unknownEnvironment,
-} from "@/types";
-import { State } from "@/types/proto-es/v1/common_pb";
-import type { Database } from "@/types/proto-es/v1/database_service_pb";
-import {
- BatchUpdateDatabasesRequestSchema,
- DatabaseSchema$,
- UpdateDatabaseRequestSchema,
-} from "@/types/proto-es/v1/database_service_pb";
-import { unknownInstance } from "@/types/v1/instance";
-import {
- extractProjectResourceName,
- getDefaultPagination,
- instanceV1Name,
- setDocumentTitle,
-} from "@/utils";
-
-const instanceHashList = ["overview", "databases", "users"] as const;
-type InstanceHash = (typeof instanceHashList)[number];
-const isInstanceHash = (x: unknown): x is InstanceHash =>
- instanceHashList.includes(x as InstanceHash);
+import { InstanceDetailView } from "@/components/instance/InstanceDetailView";
+import { instanceNamePrefix } from "@/stores/modules/v1/common";
export function InstanceDetailPage({ instanceId }: { instanceId: string }) {
- const { t } = useTranslation();
- const location = useLocation();
- const navigate = useNavigate();
- const databasesByName = useAppStore((s) => s.databasesByName);
- const projectsByName = useAppStore((s) => s.projectsByName);
- const getDatabaseByName = useAppStore((s) => s.getDatabaseByName);
- const removeDatabaseMetadataCache = useAppStore(
- (s) => s.removeDatabaseMetadataCache
- );
- const instanceName = `${instanceNamePrefix}${instanceId}`;
- const cachedInstance = useAppStore((s) => s.instancesByName[instanceName]);
- const instance = useMemo(
- () => cachedInstance ?? unknownInstance(),
- [cachedInstance, instanceName]
- );
-
- const routeHash = location.hash.replace(/^#?/, "");
- const selectedTab: InstanceHash = isInstanceHash(routeHash)
- ? routeHash
- : "overview";
- const [searchParams, setSearchParams] = useState<SearchParams>({
- query: "",
- scopes: [{ id: "instance", value: instanceId, readonly: true }],
- });
-
- // Selection / batch operations
- const [selectedNames, setSelectedNames] = useState<Set<string>>(new Set());
- const [visibleDatabases, setVisibleDatabases] = useState<Database[]>([]);
- const [refreshToken, setRefreshToken] = useState(0);
- const autoRefreshCountRef = useRef(0);
- const [syncing, setSyncing] = useState(false);
- const [showLabelEditor, setShowLabelEditor] = useState(false);
- const [showEditEnvDrawer, setShowEditEnvDrawer] = useState(false);
- const [showTransferDrawer, setShowTransferDrawer] = useState(false);
- const [showCreateDrawer, setShowCreateDrawer] = useState(false);
- const [syncingRefreshExhausted, setSyncingRefreshExhausted] = useState(false);
- const [hasUserProject, setHasUserProject] = useState(false);
-
- const selectedDatabases = useMemo(() => {
- if (selectedNames.size === 0) return [];
- return Array.from(selectedNames)
- .filter((name) => isValidDatabaseName(name))
- .map((name) => getDatabaseByName(name));
- }, [selectedNames, getDatabaseByName, databasesByName]);
-
- // Mirror `selectedDatabases` into a ref so the batch-operation handlers
- // below can read the latest value without listing it as a dep. Otherwise
- // every selection toggle re-creates the handler closures, which cascades
- // down as fresh prop refs into `DatabaseBatchOperationsBar` and forces
- // it to re-render (with N selected items, this compounds quickly).
- const selectedDatabasesRef = useRef(selectedDatabases);
- selectedDatabasesRef.current = selectedDatabases;
-
- const refresh = useCallback(() => {
- setRefreshToken((prev) => prev + 1);
- setSelectedNames(new Set());
- }, []);
-
- const locationQuery = useMemo(
- () => new URLSearchParams(location.search),
- [location.search]
- );
- const syncingInstanceId = useMemo(
- () => locationQuery.get("syncingInstance") || undefined,
- [locationQuery]
- );
- const showPrepareDatabaseTip =
- locationQuery.get(PRODUCT_INTRO_TIP_QUERY_KEY) ===
- PREPARE_DATABASE_TRANSFER_TIP;
-
- useEffect(() => {
- if (!syncingInstanceId || visibleDatabases.length > 0) {
- setSyncingRefreshExhausted(false);
- return;
- }
- setSyncingRefreshExhausted(false);
- autoRefreshCountRef.current = 0;
- const timer = window.setInterval(() => {
- autoRefreshCountRef.current += 1;
- refresh();
- if (autoRefreshCountRef.current >= 12) {
- setSyncingRefreshExhausted(true);
- window.clearInterval(timer);
- }
- }, 5000);
- return () => window.clearInterval(timer);
- }, [syncingInstanceId, visibleDatabases.length, refresh]);
-
- const handleSyncSchema = useCallback(async () => {
- if (syncing) return;
- setSyncing(true);
- pushNotification({
- module: "bytebase",
- style: "INFO",
- title: t("db.start-to-sync-schema"),
- });
- try {
- await useAppStore
- .getState()
- .batchSyncDatabases(Array.from(selectedNames));
- for (const name of selectedNames) {
- removeDatabaseMetadataCache(name);
- }
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("db.successfully-synced-schema"),
- });
- setSelectedNames(new Set());
- } catch {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("db.failed-to-sync-schema"),
- });
- } finally {
- setSyncing(false);
- }
- }, [syncing, selectedNames, removeDatabaseMetadataCache, t]);
-
- const handleLabelsApply = useCallback(
- async (labelsList: { [key: string]: string }[]) => {
- try {
- await useAppStore.getState().batchUpdateDatabases(
- create(BatchUpdateDatabasesRequestSchema, {
- parent: "-",
- requests: selectedDatabasesRef.current.map((database, i) =>
- create(UpdateDatabaseRequestSchema, {
- database: create(DatabaseSchema$, {
- ...database,
- labels: labelsList[i],
- }),
- updateMask: create(FieldMaskSchema, { paths: ["labels"] }),
- })
- ),
- })
- );
- refresh();
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
- } catch {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.failed"),
- });
- }
- },
- [refresh, t]
- );
-
- const handleEnvironmentUpdate = useCallback(
- async (environment: string) => {
- try {
- await useAppStore.getState().batchUpdateDatabases(
- create(BatchUpdateDatabasesRequestSchema, {
- parent: "-",
- requests: selectedDatabasesRef.current.map((database) =>
- create(UpdateDatabaseRequestSchema, {
- database: create(DatabaseSchema$, {
- name: database.name,
- environment,
- }),
- updateMask: create(FieldMaskSchema, { paths: ["environment"] }),
- })
- ),
- })
- );
- refresh();
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
- } catch {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.failed"),
- });
- }
- },
- [refresh, t]
- );
-
- const handleTransferProject = useCallback(
- async (projectName: string) => {
- try {
- await useAppStore.getState().batchUpdateDatabases(
- create(BatchUpdateDatabasesRequestSchema, {
- parent: "-",
- requests: selectedDatabasesRef.current.map((database) =>
- create(UpdateDatabaseRequestSchema, {
- database: create(DatabaseSchema$, {
- name: database.name,
- project: projectName,
- }),
- updateMask: create(FieldMaskSchema, { paths: ["project"] }),
- })
- ),
- })
- );
- refresh();
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("database.successfully-transferred-databases"),
- });
- void router.push({
- name: PROJECT_V1_ROUTE_DATABASES,
- params: {
- projectId: extractProjectResourceName(projectName),
- },
- });
- } catch {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.failed"),
- });
- }
- },
- [refresh, t]
- );
- // Trigger a fetch on mount so the instance is hydrated into the
- // `useAppStore` cache. Without this, hard-refreshing the page shows
- // "Unknown instance" because the cache hasn't been populated yet.
- useEffect(() => {
- void useAppStore.getState().getOrFetchInstanceByName(instanceName);
- }, [instanceName]);
-
- // Canonicalize legacy query state and invalid/missing hashes. The location
- // remains the tab source of truth, so Back/Forward updates the selected tab.
- useEffect(() => {
- const query = new URLSearchParams(location.search);
- query.delete("qs");
- const search = query.toString();
- const nextSearch = search ? `?${search}` : "";
- const nextHash = `#${selectedTab}`;
- if (location.search === nextSearch && location.hash === nextHash) return;
- void navigate(
- {
- pathname: location.pathname,
- search: nextSearch,
- hash: nextHash,
- },
- { replace: true }
- );
- }, [
- location.hash,
- location.pathname,
- location.search,
- navigate,
- selectedTab,
- ]);
-
- // Set document title
- useEffect(() => {
- if (instance.title) {
- setDocumentTitle(instance.title);
- }
- }, [instance.title]);
-
- const syncSchema = useCallback(
- async (enableFullSync: boolean) => {
- await useAppStore.getState().syncInstance(instance.name, enableFullSync);
- useAppStore.getState().removeCacheByInstance(instance.name);
- },
- [instance.name]
- );
-
- // Database filter
- const envVal = getValueFromScopes(searchParams, "environment");
- const selectedEnvironment = envVal
- ? `${environmentNamePrefix}${envVal}`
- : undefined;
- const projectVal = getValueFromScopes(searchParams, "project");
- const selectedProject = projectVal
- ? `${projectNamePrefix}${projectVal}`
- : undefined;
- const selectedLabels = useMemo(
- () =>
- searchParams.scopes.filter((s) => s.id === "label").map((s) => s.value),
- [searchParams]
- );
-
- const filter: DatabaseFilter = useMemo(
- () => ({
- environment: selectedEnvironment,
- project: selectedProject,
- query: searchParams.query,
- labels: selectedLabels.length > 0 ? selectedLabels : undefined,
- }),
- [selectedEnvironment, selectedProject, searchParams.query, selectedLabels]
- );
-
- const environments = useAppStore((s) => s.environmentList ?? []);
-
- // Reactive: the actuator's `defaultProject` is fetched asynchronously, so
- // we subscribe through the store selector — otherwise the value is
- // captured as `""` on first render and the API filter becomes broken.
- const defaultProjectId = useAppStore((s) =>
- extractProjectResourceName(s.serverInfo?.defaultProject ?? "")
- );
- const defaultProjectName = useAppStore(
- (s) => s.serverInfo?.defaultProject ?? ""
- );
- const unassignedProjectOption = useMemo<ValueOption>(
- () => ({
- value: defaultProjectId,
- keywords: ["unassigned", "default"],
- custom: true,
- render: () => (
- <span className="italic text-control-light">
- {t("common.unassigned")}
- </span>
- ),
- }),
- [defaultProjectId, t]
- );
- const searchProjects = useCallback(
- async (keyword: string): Promise<ValueOption[]> => {
- const { projects } = await useAppStore.getState().fetchProjectList({
- pageSize: getDefaultPagination(),
- filter: keyword.trim() ? { query: keyword } : undefined,
- });
- return projects.map<ValueOption>((p) => {
- const id = extractProjectResourceName(p.name);
- if (id === defaultProjectId) return unassignedProjectOption;
- return {
- value: id,
- keywords: [id, p.title],
- };
- });
- },
- [defaultProjectId, unassignedProjectOption]
- );
-
- const scopeOptions: ScopeOption[] = useMemo(
- () => [
- {
- id: "environment",
- title: t("common.environment"),
- description: t("issue.advanced-search.scope.environment.description"),
- options: [unknownEnvironment(), ...environments].map((env) => {
- const isUnknown = env.name === UNKNOWN_ENVIRONMENT_NAME;
- return {
- value: env.id,
- keywords: isUnknown
- ? ["unassigned", "none", env.id]
- : [env.id, env.title],
- custom: true,
- render: () => <EnvironmentLabel environment={env} />,
- };
- }),
- },
- {
- id: "project",
- title: t("common.project"),
- description: t("issue.advanced-search.scope.project.description"),
- // Static option lets the selected-tag display resolve the default
- // project id to "Unassigned".
- options: [unassignedProjectOption],
- onSearch: searchProjects,
- },
- {
- id: "label",
- title: t("common.labels"),
- description: t("issue.advanced-search.scope.label.description"),
- allowMultiple: true,
- },
- ],
- [t, environments, searchProjects, unassignedProjectOption]
- );
-
- const handleTabChange = useCallback(
- (tab: string | number | null) => {
- if (typeof tab !== "string" || !isInstanceHash(tab)) return;
- void navigate(
- {
- pathname: location.pathname,
- search: location.search,
- hash: `#${tab}`,
- },
- { replace: true }
- );
- },
- [location.pathname, location.search, navigate]
- );
-
- useEffect(() => {
- if (!syncingInstanceId || visibleDatabases.length === 0) {
- setHasUserProject(false);
- return;
- }
-
- const isUserProject = (project?: { name?: string }) =>
- !!defaultProjectName &&
- !!project?.name &&
- project.name !== defaultProjectName;
-
- if (Object.values(projectsByName).some(isUserProject)) {
- setHasUserProject(true);
- return;
- }
-
- let cancelled = false;
- void (async () => {
- try {
- const { projects } = await useAppStore.getState().fetchProjectList({
- pageSize: getDefaultPagination(),
- silent: true,
- });
- if (cancelled) {
- return;
- }
- setHasUserProject(projects.some(isUserProject));
- } catch {
- if (!cancelled) {
- setHasUserProject(false);
- }
- }
- })();
-
- return () => {
- cancelled = true;
- };
- }, [
- defaultProjectName,
- projectsByName,
- syncingInstanceId,
- visibleDatabases.length,
- ]);
-
- const showSyncingInstanceHint =
- !!syncingInstanceId &&
- visibleDatabases.length === 0 &&
- !syncingRefreshExhausted;
- const showNoDatabasesAfterSync =
- !!syncingInstanceId &&
- visibleDatabases.length === 0 &&
- syncingRefreshExhausted;
- const showPostSyncTransferAction =
- !!syncingInstanceId && visibleDatabases.length > 0 && hasUserProject;
- const shouldShowTransferIntro =
- showPrepareDatabaseTip && showPostSyncTransferAction;
- useProductIntro({
- id: PREPARE_DATABASE_PRODUCT_INTRO,
- title: t("workspace-setup-guide.intro.transfer-title"),
- description: t("workspace-setup-guide.intro.transfer-description"),
- disabled: !shouldShowTransferIntro,
- });
- const syncingInstanceName = syncingInstanceId
- ? `${instanceNamePrefix}${syncingInstanceId}`
- : undefined;
- const syncingInstance =
- syncingInstanceId === instanceId ? instance : undefined;
- const handleTransferSyncedDatabases = useCallback(() => {
- setSelectedNames(
- new Set(visibleDatabases.map((database) => database.name))
- );
- setShowTransferDrawer(true);
- }, [visibleDatabases]);
-
return (
- <div className="p-4 flex flex-col gap-y-2">
- {/* Archive banner */}
- {instance.state === State.DELETED && (
- <div className="bg-gray-700 text-white text-center py-2 rounded-sm text-sm font-medium">
- {t("common.archived")}
- </div>
- )}
-
- {/* No environment warning */}
- {!instance.environment && (
- <Alert
- variant="warning"
- className="mb-4"
- description={t("instance.no-environment")}
- />
- )}
-
- {/* Header */}
- <div className="flex items-center justify-between">
- <div className="flex items-center gap-x-2">
- <EngineIcon engine={instance.engine} className="h-6 w-6" />
- <span className="text-lg font-medium">
- {instanceV1Name(instance)}
- </span>
- </div>
- <div className="flex items-center gap-x-2">
- {instance.state === State.ACTIVE && (
- <InstanceSyncButton
- instanceName={instance.name}
- instanceTitle={instance.title}
- onSyncSchema={syncSchema}
- />
- )}
- <InstanceActionDropdown instance={instance} />
- </div>
- </div>
-
- {/* Tabs */}
- <Tabs value={selectedTab} onValueChange={handleTabChange}>
- <TabsList className="border-b-0">
- <TabsTrigger value="overview">{t("common.overview")}</TabsTrigger>
- <TabsTrigger value="databases">{t("common.databases")}</TabsTrigger>
- <TabsTrigger value="users">{t("instance.users")}</TabsTrigger>
- </TabsList>
-
- <TabsPanel value="overview">
- <InstanceFormProvider instance={instance}>
- <InstanceFormBody />
- <InstanceFormButtons />
- <UnsavedChangesGuard />
- </InstanceFormProvider>
- </TabsPanel>
-
- <TabsPanel value="databases" keepMounted={false}>
- <div className="flex flex-col gap-y-2">
- {showSyncingInstanceHint && (
- <Alert
- variant="info"
- title={
- <Trans
- t={t}
- i18nKey="db.project-instance-syncing-title"
- components={{
- instance: (
- <InstanceLabel
- instance={syncingInstance}
- instanceName={syncingInstanceName}
- />
- ),
- }}
- />
- }
- description={
- <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
- <span>{t("db.project-instance-syncing-description")}</span>
- <Button size="sm" appearance="outline" onClick={refresh}>
- {t("common.refresh")}
- </Button>
- </div>
- }
- />
- )}
- {showPostSyncTransferAction && (
- <Alert
- variant="info"
- title={t("db.instance-databases-synced-title")}
- description={
- <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
- <span>{t("db.instance-databases-synced-description")}</span>
- <Button size="sm" onClick={handleTransferSyncedDatabases}>
- {t("db.instance-databases-synced-action")}
- </Button>
- </div>
- }
- />
- )}
- {showNoDatabasesAfterSync && (
- <Alert
- variant="info"
- title={t("db.instance-no-databases-title")}
- description={
- <div className="flex flex-col gap-y-3 sm:flex-row sm:items-center sm:justify-between sm:gap-x-4">
- <span>{t("db.instance-no-databases-description")}</span>
- <Button
- size="sm"
- appearance="outline"
- onClick={() => setShowCreateDrawer(true)}
- >
- {t("db.instance-no-databases-action")}
- </Button>
- </div>
- }
- />
- )}
- <AdvancedSearch
- params={searchParams}
- onParamsChange={setSearchParams}
- placeholder={t("database.filter-database")}
- scopeOptions={scopeOptions}
- />
- <EditEnvironmentSheet
- open={showEditEnvDrawer}
- onClose={() => setShowEditEnvDrawer(false)}
- onUpdate={handleEnvironmentUpdate}
- />
- <LabelEditorSheet
- open={showLabelEditor}
- databases={selectedDatabases}
- onClose={() => setShowLabelEditor(false)}
- onApply={handleLabelsApply}
- />
- <TransferProjectSheet
- open={showTransferDrawer}
- databases={selectedDatabases}
- onClose={() => setShowTransferDrawer(false)}
- onTransfer={handleTransferProject}
- />
- <CreateDatabaseSheet
- open={showCreateDrawer}
- onClose={() => setShowCreateDrawer(false)}
- instanceName={instanceName}
- />
- <DatabaseTable
- filter={filter}
- parent={instance.name}
- mode="ALL"
- selectedNames={selectedNames}
- onSelectedNamesChange={setSelectedNames}
- onDatabasesChange={setVisibleDatabases}
- refreshToken={refreshToken}
- selectionColumnIntroTarget={
- shouldShowTransferIntro
- ? PREPARE_DATABASE_PRODUCT_INTRO
- : undefined
- }
- />
- {/* Batch operations bar is fixed within the visible main content. */}
- <DatabaseBatchOperationsBar
- databases={selectedDatabases}
- onSyncSchema={handleSyncSchema}
- onEditLabels={() => setShowLabelEditor(true)}
- onEditEnvironment={() => setShowEditEnvDrawer(true)}
- onTransferProject={() => setShowTransferDrawer(true)}
- allSelected={
- visibleDatabases.length > 0 &&
- visibleDatabases.every((d) => selectedNames.has(d.name))
- }
- onToggleSelectAll={() => {
- const allOnPage =
- visibleDatabases.length > 0 &&
- visibleDatabases.every((d) => selectedNames.has(d.name));
- if (allOnPage) setSelectedNames(new Set());
- else
- setSelectedNames(
- new Set(visibleDatabases.map((d) => d.name))
- );
- }}
- />
- </div>
- </TabsPanel>
-
- <TabsPanel value="users">
- <InstanceRoleTable instanceRoleList={instance.roles ?? []} />
- </TabsPanel>
- </Tabs>
- </div>
+ <InstanceDetailView instanceName={`${instanceNamePrefix}${instanceId}`} />
);
}
-
-function UnsavedChangesGuard() {
- const { valueChanged } = useInstanceFormContext();
- useUnsavedChangesGuard(valueChanged);
- return null;
-}
diff --git a/frontend/src/routes/workspace/InstancesPage.test.tsx b/frontend/src/routes/workspace/InstancesPage.test.tsx
new file mode 100644
index 0000000000..7b12e851f5
--- /dev/null
+++ b/frontend/src/routes/workspace/InstancesPage.test.tsx
@@ -0,0 +1,48 @@
+import type { ReactNode } from "react";
+import { act } from "react";
+import { createRoot } from "react-dom/client";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { InstancesPage } from "./InstancesPage";
+
+const mocks = vi.hoisted(() => ({
+ dashboardProps: undefined as Record<string, unknown> | undefined,
+ push: vi.fn(),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: { push: mocks.push },
+}));
+
+vi.mock("@/components/instance/InstanceDashboard", () => ({
+ InstanceDashboard: (props: Record<string, unknown>) => {
+ mocks.dashboardProps = props;
+ return <div data-testid="instance-dashboard" />;
+ },
+}));
+
+vi.mock("@/components/WorkspacePageLayout", () => ({
+ WorkspacePageLayout: ({ children }: { children: ReactNode }) => (
+ <div>{children}</div>
+ ),
+}));
+
+describe("InstancesPage", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.dashboardProps = undefined;
+ });
+
+ test("renders the shared dashboard without a project parent", async () => {
+ const container = document.createElement("div");
+ const root = createRoot(container);
+
+ await act(async () => {
+ root.render(<InstancesPage />);
+ });
+
+ expect(mocks.dashboardProps).toMatchObject({ layout: "workspace" });
+ expect(mocks.dashboardProps).not.toHaveProperty("parent");
+
+ act(() => root.unmount());
+ });
+});
diff --git a/frontend/src/routes/workspace/InstancesPage.tsx b/frontend/src/routes/workspace/InstancesPage.tsx
index c5e7f65332..6f703bbfba 100644
--- a/frontend/src/routes/workspace/InstancesPage.tsx
+++ b/frontend/src/routes/workspace/InstancesPage.tsx
@@ -1,1231 +1,32 @@
-import { create } from "@bufbuild/protobuf";
-import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
-import {
- ChevronDown,
- ChevronUp,
- EllipsisVertical,
- GraduationCap,
- Plus,
- RefreshCw,
- SquareStack,
-} from "lucide-react";
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { useTranslation } from "react-i18next";
-import { router, useCurrentRoute } from "@/app/router";
+import { useCallback } from "react";
+import { router } from "@/app/router";
import { INSTANCE_ROUTE_CREATE } from "@/app/router/handles";
-import {
- markListScrollRestorationEntry,
- useListScrollRestorationLoadMore,
-} from "@/app/router/NavigationScrollRestoration";
-import {
- AdvancedSearch,
- getValueFromScopes,
- type ScopeOption,
- type SearchParams,
-} from "@/components/AdvancedSearch";
-import { EngineIcon } from "@/components/EngineIcon";
-import { EnvironmentLabel } from "@/components/EnvironmentLabel";
-import { InstanceAssignmentSheet } from "@/components/InstanceAssignmentSheet";
-import { InstanceDeleteDialog } from "@/components/instance";
-import { PermissionGuard } from "@/components/PermissionGuard";
-import {
- type SelectionAction,
- SelectionActionBar,
-} from "@/components/SelectionActionBar";
-import { Alert } from "@/components/ui/alert";
-import {
- AlertDialog,
- AlertDialogContent,
- AlertDialogDescription,
- AlertDialogTitle,
-} from "@/components/ui/alert-dialog";
-import { Badge } from "@/components/ui/badge";
-import { Button } from "@/components/ui/button";
-import { Checkbox } from "@/components/ui/checkbox";
-import {
- DropdownMenu,
- DropdownMenuContent,
- DropdownMenuItem,
- DropdownMenuTrigger,
-} from "@/components/ui/dropdown-menu";
-import { EllipsisText } from "@/components/ui/ellipsis-text";
-import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group";
-import {
- Sheet,
- SheetBody,
- SheetContent,
- SheetFooter,
- SheetHeader,
- SheetTitle,
-} from "@/components/ui/sheet";
-import {
- Table,
- TableBody,
- TableCell,
- TableHead,
- TableHeader,
- TableRow,
-} from "@/components/ui/table";
-import {
- WorkspacePageContent,
- WorkspacePageFooter,
- WorkspacePageLayout,
- WorkspacePageToolbar,
-} from "@/components/WorkspacePageLayout";
-import { useColumnWidths } from "@/hooks/useColumnWidths";
-import { PagedTableFooter } from "@/hooks/usePagedData";
-import {
- getPageSizeOptions,
- useSessionPageSize,
-} from "@/hooks/useSessionPageSize";
-import {
- createAdvancedSearchParser,
- serializeAdvancedSearch,
- useURLSearchParam,
-} from "@/hooks/useURLSearchParam";
-import {
- CREATE_INSTANCE_PRODUCT_INTRO,
- useProductIntro,
-} from "@/lib/productIntro";
-import { cn } from "@/lib/utils";
-import { pushNotification } from "@/stores";
-import { useAppStore } from "@/stores/app";
-import type { InstanceFilter } from "@/stores/app/types";
-import { environmentNamePrefix } from "@/stores/modules/v1/common";
-import {
- DEFAULT_ENVIRONMENT_COLOR,
- isValidInstanceName,
- UNKNOWN_ENVIRONMENT_NAME,
- unknownEnvironment,
-} from "@/types";
-import { Engine, State } from "@/types/proto-es/v1/common_pb";
+import { markListScrollRestorationEntry } from "@/app/router/NavigationScrollRestoration";
+import { InstanceDashboard } from "@/components/instance/InstanceDashboard";
+import { WorkspacePageLayout } from "@/components/WorkspacePageLayout";
import type { Instance } from "@/types/proto-es/v1/instance_service_pb";
-import { UpdateInstanceRequestSchema } from "@/types/proto-es/v1/instance_service_pb";
-import {
- engineNameV1,
- hasWorkspacePermissionV2,
- hostPortOfDataSource,
- hostPortOfInstanceV1,
- supportedEngineV1List,
-} from "@/utils";
-import {
- defaultActiveStateSearchParams,
- getResourceStateFilter,
-} from "./resourceStateFilter";
-
-const ASSIGN_LICENSE_QUERY = "assignLicense";
-const ASSIGN_LICENSE_INSTANCES_QUERY = "instances";
-const parseInstanceSearch = createAdvancedSearchParser([
- "environment",
- "engine",
- "label",
- "state",
- "host",
- "port",
-]);
-
-interface InstanceColumn {
- key: string;
- title: React.ReactNode;
- defaultWidth: number;
- minWidth?: number;
- resizable?: boolean;
- sortable?: boolean;
- sortKey?: string;
- cellClassName?: string;
- render: (instance: Instance) => React.ReactNode;
- onCellClick?: (instance: Instance, e: React.MouseEvent) => void;
- onHeaderClick?: (e: React.MouseEvent) => void;
-}
-
-// ============================================================
-// ConfirmDialog
-// ============================================================
-
-function ConfirmDialog({
- open,
- variant,
- title,
- description,
- okText,
- onOk,
- onCancel,
- children,
-}: {
- open: boolean;
- variant: "warning" | "error";
- title: string;
- description: string;
- okText: string;
- onOk: () => void;
- onCancel: () => void;
- children?: React.ReactNode;
-}) {
- const { t } = useTranslation();
-
- if (!open) return null;
-
- const borderColor = variant === "error" ? "border-error" : "border-warning";
- const okClassName =
- variant === "warning"
- ? "bg-warning text-accent-text hover:bg-warning-hover"
- : undefined;
-
- return (
- <AlertDialog open onOpenChange={(nextOpen) => !nextOpen && onCancel()}>
- <AlertDialogContent className={cn("max-w-lg border-t-4", borderColor)}>
- <AlertDialogTitle>{title}</AlertDialogTitle>
- <AlertDialogDescription className="mt-2">
- {description}
- </AlertDialogDescription>
- {children && <div className="mt-4">{children}</div>}
- <div className="mt-6 flex justify-end gap-x-2">
- <Button appearance="outline" onClick={onCancel}>
- {t("common.cancel")}
- </Button>
- <Button
- variant={variant === "error" ? "destructive" : "default"}
- className={okClassName}
- onClick={onOk}
- >
- {okText}
- </Button>
- </div>
- </AlertDialogContent>
- </AlertDialog>
- );
-}
-
-// ============================================================
-// InstanceActionDropdown
-// ============================================================
-
-function InstanceActionDropdown({
- instance,
- onAction,
-}: {
- instance: Instance;
- onAction: () => void;
-}) {
- const { t } = useTranslation();
- const [showArchiveConfirm, setShowArchiveConfirm] = useState(false);
- const [showDeleteConfirm, setShowDeleteConfirm] = useState(false);
- const [forceArchive, setForceArchive] = useState(false);
-
- const canArchive = hasWorkspacePermissionV2("bb.instances.delete");
- const canRestore = hasWorkspacePermissionV2("bb.instances.undelete");
-
- const handleArchive = useCallback(async () => {
- try {
- await useAppStore.getState().archiveInstance(instance, forceArchive);
- pushNotification({
- module: "bytebase",
- style: "INFO",
- title: t("instance.successfully-archived-instance", {
- 0: instance.title,
- }),
- });
- setShowArchiveConfirm(false);
- setForceArchive(false);
- onAction();
- } catch (error: unknown) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.archive"),
- description: (error as { message?: string }).message,
- });
- }
- }, [instance, forceArchive, t, onAction]);
-
- const handleRestore = useCallback(async () => {
- try {
- await useAppStore.getState().restoreInstance(instance);
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("instance.successfully-restored-instance", {
- 0: instance.title,
- }),
- });
- onAction();
- } catch (error: unknown) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.restore"),
- description: (error as { message?: string }).message,
- });
- }
- }, [instance, t, onAction]);
-
- if (!canArchive && !canRestore) return null;
-
- const isActive = instance.state === State.ACTIVE;
-
- return (
- <>
- <DropdownMenu>
- <DropdownMenuTrigger
- className="p-1 rounded-xs hover:bg-control-bg outline-hidden"
- onClick={(e) => e.stopPropagation()}
- >
- <EllipsisVertical className="h-4 w-4" />
- </DropdownMenuTrigger>
- <DropdownMenuContent>
- {isActive && canArchive && (
- <DropdownMenuItem
- onClick={(e) => {
- e.stopPropagation();
- setShowArchiveConfirm(true);
- }}
- >
- {t("common.archive")}
- </DropdownMenuItem>
- )}
- {!isActive && canRestore && (
- <DropdownMenuItem
- onClick={(e) => {
- e.stopPropagation();
- handleRestore();
- }}
- >
- {t("common.restore")}
- </DropdownMenuItem>
- )}
- {canArchive && (
- <DropdownMenuItem
- className="text-error"
- onClick={(e) => {
- e.stopPropagation();
- setShowDeleteConfirm(true);
- }}
- >
- {t("common.delete")}
- </DropdownMenuItem>
- )}
- </DropdownMenuContent>
- </DropdownMenu>
-
- <ConfirmDialog
- open={showArchiveConfirm}
- variant="warning"
- title={t("instance.archive-instance-instance-name", {
- 0: instance.title,
- })}
- description={t("instance.archived-instances-will-not-be-displayed")}
- okText={t("common.archive")}
- onOk={handleArchive}
- onCancel={() => {
- setShowArchiveConfirm(false);
- setForceArchive(false);
- }}
- >
- <label className="flex items-center gap-x-2 text-sm text-control-light mt-2">
- <Checkbox
- checked={forceArchive}
- onCheckedChange={(checked) => setForceArchive(checked)}
- />
- {t("instance.force-archive-description")}
- </label>
- </ConfirmDialog>
-
- <InstanceDeleteDialog
- open={showDeleteConfirm}
- instance={instance}
- onOpenChange={setShowDeleteConfirm}
- onDeleted={onAction}
- />
- </>
- );
-}
-
-// ============================================================
-// LabelsDisplay
-// ============================================================
-
-function LabelsDisplay({ labels }: { labels: { [key: string]: string } }) {
- const entries = Object.entries(labels);
- if (entries.length === 0)
- return <span className="text-control-placeholder">-</span>;
-
- const displayEntries = entries.slice(0, 3);
- const hasMore = entries.length > 3;
-
- return (
- <div className="flex items-center gap-x-1">
- {displayEntries.map(([key, value]) => (
- <span
- key={key}
- className="rounded-xs bg-control-bg py-0.5 px-2 text-sm"
- >
- {key}:{value}
- </span>
- ))}
- {hasMore && <span>...</span>}
- </div>
- );
-}
-
-// ============================================================
-// EditEnvironmentSheet
-// ============================================================
-
-function EditEnvironmentSheet({
- open,
- onClose,
- onUpdate,
-}: {
- open: boolean;
- onClose: () => void;
- onUpdate: (environment: string) => Promise<void>;
-}) {
- const { t } = useTranslation();
- const environments = useAppStore((s) => s.environmentList ?? []);
- const [selected, setSelected] = useState("");
- useEffect(() => {
- if (open) setSelected("");
- }, [open]);
-
- return (
- <Sheet open={open} onOpenChange={(next) => !next && onClose()}>
- <SheetContent width="narrow">
- <SheetHeader>
- <SheetTitle>{t("common.environment")}</SheetTitle>
- </SheetHeader>
- <SheetBody>
- <RadioGroup
- className="flex-col items-stretch gap-y-2"
- value={selected}
- onValueChange={(value) => setSelected(value as string)}
- >
- {environments.map((env) => (
- <RadioGroupItem
- key={env.name}
- value={env.name}
- className={cn(
- "flex items-center gap-x-3 px-3 py-2 rounded-xs cursor-pointer border",
- selected === env.name
- ? "border-accent bg-accent/5"
- : "border-transparent hover:bg-control-bg"
- )}
- >
- <div className="flex items-center gap-x-2">
- <span
- className="inline-block size-3 rounded-full"
- style={{
- backgroundColor: env.color || DEFAULT_ENVIRONMENT_COLOR,
- }}
- />
- <span>{env.title}</span>
- </div>
- </RadioGroupItem>
- ))}
- </RadioGroup>
- </SheetBody>
- <SheetFooter>
- <Button appearance="secondary" onClick={onClose}>
- {t("common.cancel")}
- </Button>
- <Button
- disabled={!selected}
- onClick={async () => {
- await onUpdate(selected);
- onClose();
- }}
- >
- {t("common.update")}
- </Button>
- </SheetFooter>
- </SheetContent>
- </Sheet>
- );
-}
-
-// ============================================================
-// InstancesPage (main)
-// ============================================================
export function InstancesPage() {
- const { t } = useTranslation();
- const route = useCurrentRoute();
-
- const defaultSearchParams = useMemo<SearchParams>(
- () => defaultActiveStateSearchParams(route.query.state),
- [route.query.state]
- );
- const [searchParams, setSearchParams] = useURLSearchParam<SearchParams>({
- param: "q",
- parse: parseInstanceSearch,
- serialize: serializeAdvancedSearch,
- defaultValue: defaultSearchParams,
- });
-
- // Scope options
- const canUndelete = hasWorkspacePermissionV2("bb.instances.undelete");
- const environments = useAppStore((s) => s.environmentList ?? []);
- const scopeOptions: ScopeOption[] = useMemo(() => {
- const options: ScopeOption[] = [
- {
- id: "environment",
- title: t("common.environment"),
- description: t("issue.advanced-search.scope.environment.description"),
- options: [unknownEnvironment(), ...environments].map((env) => {
- const isUnknown = env.name === UNKNOWN_ENVIRONMENT_NAME;
- return {
- value: env.id,
- keywords: isUnknown
- ? ["unassigned", "none", env.id]
- : [env.id, env.title],
- custom: true,
- render: () => <EnvironmentLabel environment={env} />,
- };
- }),
- },
- {
- id: "engine",
- title: t("database.engine"),
- description: t("issue.advanced-search.scope.engine.description"),
- options: supportedEngineV1List().map((engine) => ({
- value: Engine[engine],
- keywords: [Engine[engine].toLowerCase(), engineNameV1(engine)],
- custom: true,
- render: () => (
- <span className="inline-flex items-center gap-x-1.5">
- <EngineIcon engine={engine} className="h-4 w-4" />
- <span>{engineNameV1(engine)}</span>
- </span>
- ),
- })),
- allowMultiple: true,
- },
- {
- id: "label",
- title: t("common.labels"),
- description: t("issue.advanced-search.scope.label.description"),
- allowMultiple: true,
- },
- {
- id: "state",
- title: t("common.state"),
- description: t("issue.advanced-search.scope.state.description"),
- options: [
- {
- value: "ACTIVE",
- keywords: ["active"],
- custom: true,
- render: () => <span>{t("common.active")}</span>,
- },
- ...(canUndelete
- ? [
- {
- value: "DELETED",
- keywords: ["archived", "deleted"],
- custom: true,
- render: () => <span>{t("common.archived")}</span>,
- },
- {
- value: "ALL",
- keywords: ["all"],
- custom: true,
- render: () => <span>{t("common.all")}</span>,
- },
- ]
- : []),
- ],
- },
- {
- id: "host",
- title: t("instance.advanced-search.scope.host.title"),
- description: t("instance.advanced-search.scope.host.description"),
- },
- {
- id: "port",
- title: t("instance.advanced-search.scope.port.title"),
- description: t("instance.advanced-search.scope.port.description"),
- },
- ];
- return options;
- }, [t, canUndelete, environments]);
-
- // Derived filter values — trivial lookups, no memo needed
- const searchText = searchParams.query;
-
- const stateFilterVal = getValueFromScopes(searchParams, "state");
- const selectedState = getResourceStateFilter(stateFilterVal);
-
- const envVal = getValueFromScopes(searchParams, "environment");
- const selectedEnvironment = envVal
- ? `${environmentNamePrefix}${envVal}`
- : undefined;
-
- const selectedHost = getValueFromScopes(searchParams, "host") || undefined;
- const selectedPort = getValueFromScopes(searchParams, "port") || undefined;
-
- const selectedEngines = useMemo(
- () =>
- searchParams.scopes
- .filter((s) => s.id === "engine")
- .map((s) => Engine[s.value as keyof typeof Engine])
- .filter((e): e is Engine => e !== undefined),
- [searchParams]
- );
-
- const selectedLabels = useMemo(
- () =>
- searchParams.scopes.filter((s) => s.id === "label").map((s) => s.value),
- [searchParams]
- );
-
- // Mark instance visit on mount
- useEffect(() => {
- const store = useAppStore.getState();
- if (!store.getIntroStateByKey("instance.visit")) {
- store.saveIntroStateByKey({
- key: "instance.visit",
- newState: true,
- });
- }
- }, []);
-
- // Instance count warning
- const instanceCountLimit = useAppStore((s) => s.instanceCountLimit());
- const totalInstanceCount = useAppStore((s) => s.totalInstanceCount());
- const hasSplitInstanceLicense = useAppStore((s) =>
- s.hasSplitInstanceLicense()
- );
- const quotaExhausted = totalInstanceCount >= instanceCountLimit;
-
- // Data fetching
- const [instances, setInstances] = useState<Instance[]>([]);
- const [loading, setLoading] = useState(true);
- const nextPageTokenRef = useRef("");
- const [hasMore, setHasMore] = useState(false);
- const [isFetchingMore, setIsFetchingMore] = useState(false);
- const [pageSize, setPageSize] = useSessionPageSize("bb.instance-table");
- const fetchIdRef = useRef(0);
-
- // Sort state
- const [sortKey, setSortKey] = useState<string | null>(null);
- const [sortOrder, setSortOrder] = useState<"asc" | "desc">("asc");
-
- const orderBy = sortKey ? `${sortKey} ${sortOrder}` : "";
-
- const toggleSort = useCallback(
- (key: string) => {
- if (sortKey === key) {
- if (sortOrder === "asc") setSortOrder("desc");
- else {
- setSortKey(null);
- setSortOrder("asc");
- }
- } else {
- setSortKey(key);
- setSortOrder("asc");
- }
- },
- [sortKey, sortOrder]
- );
-
- const filter: InstanceFilter = useMemo(
- () => ({
- environment: selectedEnvironment,
- host: selectedHost,
- port: selectedPort,
- query: searchText,
- engines: selectedEngines,
- labels: selectedLabels.length > 0 ? selectedLabels : undefined,
- state: selectedState,
- }),
- [
- selectedEnvironment,
- selectedHost,
- selectedPort,
- searchText,
- selectedEngines,
- selectedLabels,
- selectedState,
- ]
- );
-
- const fetchInstances = useCallback(
- async (isRefresh: boolean) => {
- const currentFetchId = ++fetchIdRef.current;
-
- if (isRefresh) {
- setLoading(true);
- } else {
- setIsFetchingMore(true);
- }
-
- try {
- const token = isRefresh ? "" : nextPageTokenRef.current;
- const result = await useAppStore.getState().fetchInstanceList({
- pageToken: token,
- pageSize,
- filter,
- orderBy,
- });
-
- if (currentFetchId !== fetchIdRef.current) return;
-
- if (isRefresh) {
- setInstances(result.instances);
- } else {
- setInstances((prev) => [...prev, ...result.instances]);
- }
- nextPageTokenRef.current = result.nextPageToken ?? "";
- setHasMore(Boolean(result.nextPageToken));
- } catch (e) {
- if (e instanceof Error && e.name === "AbortError") return;
- console.error(e);
- } finally {
- if (currentFetchId === fetchIdRef.current) {
- setLoading(false);
- setIsFetchingMore(false);
- }
- }
- },
- [pageSize, filter, orderBy]
- );
-
- // Fetch on mount + re-fetch on filter/sort/pageSize changes
- const isFirstLoad = useRef(true);
- useEffect(() => {
- if (isFirstLoad.current) {
- isFirstLoad.current = false;
- fetchInstances(true);
- return;
- }
- const timer = setTimeout(() => fetchInstances(true), 300);
- return () => clearTimeout(timer);
- }, [fetchInstances]);
-
- const loadMore = useCallback(() => {
- if (nextPageTokenRef.current && !isFetchingMore) {
- fetchInstances(false);
- }
- }, [isFetchingMore, fetchInstances]);
- useListScrollRestorationLoadMore({
- dataList: instances,
- hasMore,
- isFetchingMore,
- isLoading: loading,
- loadMore,
- });
-
- // Selection state
- const [selectedNames, setSelectedNames] = useState<Set<string>>(new Set());
-
- const selectedInstanceList = useMemo(() => {
- if (selectedNames.size === 0) return [];
- return Array.from(selectedNames)
- .filter((name) => isValidInstanceName(name))
- .map((name) => useAppStore.getState().getInstanceByName(name));
- }, [selectedNames]);
-
- const toggleSelection = useCallback((name: string) => {
- setSelectedNames((prev) => {
- const next = new Set(prev);
- if (next.has(name)) next.delete(name);
- else next.add(name);
- return next;
- });
- }, []);
-
- const toggleSelectAll = useCallback(() => {
- setSelectedNames((prev) => {
- if (prev.size === instances.length) return new Set();
- return new Set(instances.map((i) => i.name));
- });
- }, [instances]);
-
- // Batch operations — all mutation logic lives here in the parent
- const [syncing, setSyncing] = useState(false);
- const [showEditEnvDrawer, setShowEditEnvDrawer] = useState(false);
- const [showAssignLicenseSheet, setShowAssignLicenseSheet] = useState(false);
- const [assignLicenseNames, setAssignLicenseNames] = useState<string[]>([]);
-
- const handleSync = useCallback(
- async (enableFullSync: boolean) => {
- setSyncing(true);
- try {
- await useAppStore
- .getState()
- .batchSyncInstances(Array.from(selectedNames), enableFullSync);
- pushNotification({
- module: "bytebase",
- style: "INFO",
- title: t("db.start-to-sync-schema"),
- });
- } finally {
- setSyncing(false);
- }
- },
- [selectedNames, t]
- );
-
- const handleEnvironmentUpdate = useCallback(
- async (environment: string) => {
- try {
- await useAppStore.getState().batchUpdateInstances(
- selectedInstanceList.map((instance) =>
- create(UpdateInstanceRequestSchema, {
- instance: { ...instance, environment },
- updateMask: create(FieldMaskSchema, { paths: ["environment"] }),
- })
- )
- );
- // Re-fetch the full list to get fresh data
- fetchInstances(true);
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
- } catch (error: unknown) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: t("common.environment"),
- description: (error as { message?: string }).message,
- });
- }
- },
- [selectedInstanceList, t, fetchInstances]
- );
-
- const handleRowAction = useCallback(() => {
- fetchInstances(true);
- setSelectedNames(new Set());
- }, [fetchInstances]);
-
- const handleAssignLicense = useCallback(
- (names: string[]) => {
- if (!hasSplitInstanceLicense) {
- return;
- }
- setAssignLicenseNames(names);
- setShowAssignLicenseSheet(true);
- },
- [hasSplitInstanceLicense]
- );
-
- // Depend on the two primitive params, not `route.query` — the route object
- // is rebuilt every render, which would re-run this effect each time.
- const assignLicenseFlag = route.query[ASSIGN_LICENSE_QUERY];
- const rawAssignLicenseInstances = route.query[ASSIGN_LICENSE_INSTANCES_QUERY];
- useEffect(() => {
- if (assignLicenseFlag !== "1") {
- return;
- }
-
- const names =
- typeof rawAssignLicenseInstances === "string"
- ? rawAssignLicenseInstances.split(",").filter(Boolean)
- : [];
- handleAssignLicense(names);
-
- const nextQuery = { ...router.currentRoute.value.query };
- delete nextQuery[ASSIGN_LICENSE_QUERY];
- delete nextQuery[ASSIGN_LICENSE_INSTANCES_QUERY];
- router.replace({ query: nextQuery });
- }, [assignLicenseFlag, rawAssignLicenseInstances, handleAssignLicense]);
-
- // Data source toggle
- const [expandedDataSources, setExpandedDataSources] = useState<Set<string>>(
- new Set()
- );
-
- const toggleDataSource = useCallback((name: string) => {
- setExpandedDataSources((prev) => {
- const next = new Set(prev);
- if (next.has(name)) next.delete(name);
- else next.add(name);
- return next;
- });
- }, []);
-
- const activatedInstanceCount = useAppStore((s) => s.activatedInstanceCount());
- const navigateToCreate = useCallback(() => {
- if (instanceCountLimit <= activatedInstanceCount) {
- // Limit reached — the warning banner is already visible
- return;
- }
- router.push({ name: INSTANCE_ROUTE_CREATE });
- }, [instanceCountLimit, activatedInstanceCount]);
-
- const handleRowClick = useCallback(
- (instance: Instance, e: React.MouseEvent) => {
+ const handleOpen = useCallback(
+ (instance: Instance, event: React.MouseEvent) => {
const url = `/${instance.name}`;
- if (e.ctrlKey || e.metaKey) {
+ if (event.ctrlKey || event.metaKey) {
window.open(url, "_blank");
- } else {
- markListScrollRestorationEntry();
- router.push(url);
+ return;
}
+ markListScrollRestorationEntry();
+ router.push(url);
},
[]
);
- const canCreate = hasWorkspacePermissionV2("bb.instances.create");
- useProductIntro({
- id: CREATE_INSTANCE_PRODUCT_INTRO,
- title: t("workspace-setup-guide.intro.instance-title"),
- description: t("workspace-setup-guide.intro.instance-description"),
- disabled: !canCreate,
- });
- const allSelected =
- instances.length > 0 && selectedNames.size === instances.length;
- const someSelected =
- selectedNames.size > 0 && selectedNames.size < instances.length;
- const pageSizeOptions = getPageSizeOptions();
-
- const columns: InstanceColumn[] = [
- {
- key: "select",
- title: (
- <Checkbox
- checked={someSelected ? "indeterminate" : allSelected}
- onCheckedChange={toggleSelectAll}
- onClick={(e) => e.stopPropagation()}
- />
- ),
- defaultWidth: 48,
- cellClassName: "px-4 py-2",
- onCellClick: (instance, e) => {
- e.stopPropagation();
- toggleSelection(instance.name);
- },
- onHeaderClick: (e) => {
- e.stopPropagation();
- toggleSelectAll();
- },
- render: (instance) => (
- <Checkbox
- checked={selectedNames.has(instance.name)}
- onCheckedChange={() => toggleSelection(instance.name)}
- onClick={(e) => e.stopPropagation()}
- />
- ),
- },
- {
- key: "title",
- title: t("common.name"),
- defaultWidth: 280,
- minWidth: 160,
- resizable: true,
- sortable: true,
- render: (instance) => (
- <div className="flex items-center gap-x-2 min-w-0">
- <EngineIcon engine={instance.engine} className="h-5 w-5" />
- <EllipsisText text={instance.title} />
- </div>
- ),
- },
- {
- key: "environment",
- title: t("common.environment"),
- defaultWidth: 220,
- minWidth: 120,
- resizable: true,
- sortable: true,
- render: (instance) => (
- <EnvironmentLabel environmentName={instance.environment ?? ""} />
- ),
- },
- {
- key: "state",
- title: t("common.state"),
- defaultWidth: 120,
- minWidth: 100,
- resizable: true,
- render: (instance) =>
- instance.state === State.DELETED ? (
- <Badge variant="warning" className="text-xs">
- {t("common.archived")}
- </Badge>
- ) : (
- <Badge variant="success" className="text-xs">
- {t("common.active")}
- </Badge>
- ),
- },
- {
- key: "address",
- title: t("common.address"),
- defaultWidth: 280,
- minWidth: 150,
- resizable: true,
- render: (instance) => {
- const isExpanded = expandedDataSources.has(instance.name);
- const hasMultipleDS = instance.dataSources.length > 1;
- return (
- <div className="flex items-start gap-x-2">
- <span className="truncate">
- {isExpanded
- ? instance.dataSources.map((ds, idx) => (
- <div key={idx}>{hostPortOfDataSource(ds)}</div>
- ))
- : hostPortOfInstanceV1(instance)}
- </span>
- {hasMultipleDS && (
- <Button
- type="button"
- appearance="secondary"
- size="xs"
- className="size-5 shrink-0 p-0"
- onClick={(e) => {
- e.stopPropagation();
- toggleDataSource(instance.name);
- }}
- >
- {isExpanded ? (
- <ChevronUp className="w-4 h-4" />
- ) : (
- <ChevronDown className="w-4 h-4" />
- )}
- </Button>
- )}
- </div>
- );
- },
- },
- {
- key: "labels",
- title: t("common.labels"),
- defaultWidth: 240,
- minWidth: 150,
- resizable: true,
- render: (instance) => <LabelsDisplay labels={instance.labels} />,
- },
- {
- key: "license",
- title: t("subscription.instance-assignment.license"),
- defaultWidth: 100,
- render: (instance) => (instance.activation ? "Y" : ""),
- },
- {
- key: "actions",
- title: "",
- defaultWidth: 50,
- render: (instance) => (
- <div className="flex justify-end" onClick={(e) => e.stopPropagation()}>
- <InstanceActionDropdown
- instance={instance}
- onAction={handleRowAction}
- />
- </div>
- ),
- },
- ];
-
- const { widths, totalWidth, onResizeStart } = useColumnWidths(columns);
-
return (
<WorkspacePageLayout padding="flush">
- {/* Instance count warning */}
- {quotaExhausted && (
- <Alert
- variant="warning"
- className="mb-4"
- title={t("subscription.usage.instance-count.title")}
- description={t("subscription.usage.instance-count.runoutof", {
- total: instanceCountLimit,
- })}
- />
- )}
-
- {/* Header: Search + Create */}
- <WorkspacePageToolbar className="px-4">
- <AdvancedSearch
- params={searchParams}
- scopeOptions={scopeOptions}
- placeholder={t("instance.filter-instance-name")}
- onParamsChange={setSearchParams}
- />
- <PermissionGuard permissions={["bb.instances.create"]}>
- <Button
- data-product-intro-target={CREATE_INSTANCE_PRODUCT_INTRO}
- disabled={!canCreate}
- onClick={navigateToCreate}
- >
- <Plus className="h-4 w-4 mr-1" />
- {t("instance.connect-instance")}
- </Button>
- </PermissionGuard>
- </WorkspacePageToolbar>
-
- <WorkspacePageContent className="overflow-x-auto border rounded-sm">
- <Table className="table-fixed" style={{ minWidth: `${totalWidth}px` }}>
- <colgroup>
- {widths.map((w, i) => (
- <col key={columns[i].key} style={{ width: `${w}px` }} />
- ))}
- </colgroup>
- <TableHeader>
- <TableRow className="bg-control-bg">
- {columns.map((col, colIdx) => (
- <TableHead
- key={col.key}
- sortable={col.sortable}
- sortActive={
- col.sortable && sortKey === (col.sortKey ?? col.key)
- }
- sortDir={sortOrder}
- onSort={
- col.sortable
- ? () => toggleSort(col.sortKey ?? col.key)
- : undefined
- }
- resizable={col.resizable}
- onResizeStart={
- col.resizable ? (e) => onResizeStart(colIdx, e) : undefined
- }
- className={cn(col.onHeaderClick && "cursor-pointer")}
- onClick={col.onHeaderClick}
- >
- {col.title}
- </TableHead>
- ))}
- </TableRow>
- </TableHeader>
- <TableBody>
- {loading && instances.length === 0 ? (
- <TableRow>
- <TableCell
- colSpan={columns.length}
- className="px-4 py-8 text-center text-control-placeholder"
- >
- <div className="flex items-center justify-center gap-x-2">
- <div className="animate-spin size-4 border-2 border-accent border-t-transparent rounded-full" />
- {t("common.loading")}
- </div>
- </TableCell>
- </TableRow>
- ) : instances.length === 0 ? (
- <TableRow>
- <TableCell
- colSpan={columns.length}
- className="px-4 py-8 text-center text-control-placeholder"
- >
- {t("common.no-data")}
- </TableCell>
- </TableRow>
- ) : (
- instances.map((instance) => (
- <TableRow
- key={instance.name}
- className="cursor-pointer"
- onClick={(e) => handleRowClick(instance, e)}
- >
- {columns.map((col) => (
- <TableCell
- key={col.key}
- className={cn(
- "overflow-hidden",
- col.cellClassName,
- col.onCellClick && "cursor-pointer"
- )}
- onClick={
- col.onCellClick
- ? (e) => col.onCellClick!(instance, e)
- : undefined
- }
- >
- {col.render(instance)}
- </TableCell>
- ))}
- </TableRow>
- ))
- )}
- </TableBody>
- </Table>
- </WorkspacePageContent>
-
- <WorkspacePageFooter>
- <PagedTableFooter
- pageSize={pageSize}
- pageSizeOptions={pageSizeOptions}
- onPageSizeChange={setPageSize}
- hasMore={hasMore}
- isFetchingMore={isFetchingMore}
- onLoadMore={loadMore}
- />
- </WorkspacePageFooter>
-
- {/* Batch operations bar is fixed within the visible main content. */}
- {(() => {
- const canSync = hasWorkspacePermissionV2("bb.instances.sync");
- const canUpdate = hasWorkspacePermissionV2("bb.instances.update");
- const syncDisabled = !canSync || syncing;
- const instanceActions: SelectionAction[] = [
- {
- key: "sync-new",
- label: syncing
- ? t("instance.syncing")
- : t("instance.sync.sync-new"),
- icon: RefreshCw,
- onClick: () => handleSync(false),
- disabled: syncDisabled,
- },
- {
- key: "sync-all",
- label: t("instance.sync.sync-all"),
- icon: RefreshCw,
- onClick: () => handleSync(true),
- disabled: syncDisabled,
- },
- {
- key: "edit-env",
- label: t("database.edit-environment"),
- icon: SquareStack,
- onClick: () => setShowEditEnvDrawer(true),
- disabled: !canUpdate,
- },
- {
- key: "assign-license",
- label: t("subscription.instance-assignment.assign-license"),
- icon: GraduationCap,
- onClick: () =>
- handleAssignLicense(
- selectedInstanceList.map((instance) => instance.name)
- ),
- disabled: !canUpdate,
- hidden: !hasSplitInstanceLicense,
- },
- ];
- const allSelected =
- instances.length > 0 &&
- instances.every((i) => selectedNames.has(i.name));
- return (
- <SelectionActionBar
- count={selectedInstanceList.length}
- label={t("common.n-selected", { n: selectedInstanceList.length })}
- allSelected={allSelected}
- onToggleSelectAll={() => {
- if (allSelected) setSelectedNames(new Set());
- else setSelectedNames(new Set(instances.map((i) => i.name)));
- }}
- actions={instanceActions}
- />
- );
- })()}
-
- {/* Modals (portaled, position-independent) */}
- <EditEnvironmentSheet
- open={showEditEnvDrawer}
- onClose={() => setShowEditEnvDrawer(false)}
- onUpdate={handleEnvironmentUpdate}
+ <InstanceDashboard
+ layout="workspace"
+ onCreate={() => router.push({ name: INSTANCE_ROUTE_CREATE })}
+ onOpen={handleOpen}
/>
- {hasSplitInstanceLicense && (
- <InstanceAssignmentSheet
- open={showAssignLicenseSheet}
- selectedInstanceList={assignLicenseNames}
- onOpenChange={setShowAssignLicenseSheet}
- onUpdated={handleRowAction}
- />
- )}
</WorkspacePageLayout>
);
}
diff --git a/frontend/src/routes/workspace/ProjectsPage.navigation.test.ts b/frontend/src/routes/workspace/ProjectsPage.navigation.test.ts
index 9ff4659035..9694de625d 100644
--- a/frontend/src/routes/workspace/ProjectsPage.navigation.test.ts
+++ b/frontend/src/routes/workspace/ProjectsPage.navigation.test.ts
@@ -3,6 +3,13 @@ import { describe, expect, test } from "vitest";
import source from "./ProjectsPage.tsx?raw";
describe("ProjectsPage navigation", () => {
+ test("opens a newly created project on the databases page with the connect instance intro", () => {
+ expect(source).toContain("PROJECT_V1_ROUTE_DATABASES");
+ expect(source).toContain(
+ "query: { [PRODUCT_INTRO_QUERY_KEY]: CONNECT_DATABASE_PRODUCT_INTRO }"
+ );
+ });
+
test("opens projects from the table on the issues page", () => {
expect(source).toContain("PROJECT_V1_ROUTE_ISSUES");
expect(source).toContain("projectIssuesRoute(project)");
diff --git a/frontend/src/routes/workspace/ProjectsPage.tsx b/frontend/src/routes/workspace/ProjectsPage.tsx
index 9642e5ec80..bbae166066 100644
--- a/frontend/src/routes/workspace/ProjectsPage.tsx
+++ b/frontend/src/routes/workspace/ProjectsPage.tsx
@@ -2,7 +2,10 @@ import { Archive, Check, EllipsisVertical, Plus, Trash2 } from "lucide-react";
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import { router, useCurrentRoute } from "@/app/router";
-import { PROJECT_V1_ROUTE_ISSUES } from "@/app/router/handles";
+import {
+ PROJECT_V1_ROUTE_DATABASES,
+ PROJECT_V1_ROUTE_ISSUES,
+} from "@/app/router/handles";
import {
markListScrollRestorationEntry,
useListScrollRestorationLoadMore,
@@ -50,9 +53,15 @@ import {
useURLSearchParam,
} from "@/hooks/useURLSearchParam";
import {
+ CONNECT_DATABASE_PRODUCT_INTRO,
CREATE_PROJECT_PRODUCT_INTRO,
+ PRODUCT_INTRO_QUERY_KEY,
useProductIntro,
} from "@/lib/productIntro";
+import {
+ defaultActiveStateSearchParams,
+ getResourceStateFilter,
+} from "@/lib/resourceStateFilter";
import { cn } from "@/lib/utils";
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
@@ -64,10 +73,6 @@ import {
hasProjectPermissionV2,
hasWorkspacePermissionV2,
} from "@/utils";
-import {
- defaultActiveStateSearchParams,
- getResourceStateFilter,
-} from "./resourceStateFilter";
const parseProjectSearch = createAdvancedSearchParser(["state", "label"]);
@@ -594,7 +599,11 @@ export function ProjectsPage() {
});
const handleCreated = useCallback((project: Project) => {
- router.push(projectIssuesRoute(project));
+ router.push({
+ name: PROJECT_V1_ROUTE_DATABASES,
+ params: { projectId: getProjectName(project.name) },
+ query: { [PRODUCT_INTRO_QUERY_KEY]: CONNECT_DATABASE_PRODUCT_INTRO },
+ });
}, []);
const handleRowClick = useCallback(
diff --git a/frontend/src/routes/workspace/WorkspacePageLayout.test.ts b/frontend/src/routes/workspace/WorkspacePageLayout.test.ts
index 12e6e16e55..36f58054a3 100644
--- a/frontend/src/routes/workspace/WorkspacePageLayout.test.ts
+++ b/frontend/src/routes/workspace/WorkspacePageLayout.test.ts
@@ -101,7 +101,22 @@ describe("workspace list page layout", () => {
)
) {
expect(source, file).toContain('padding="flush"');
- expect(source, file).toContain('<WorkspacePageToolbar className="px-4');
+ const layoutSource =
+ file === "InstancesPage.tsx"
+ ? readFileSync(
+ join(componentsDir, "instance/InstanceDashboard.tsx"),
+ "utf8"
+ )
+ : source;
+ if (file === "InstancesPage.tsx") {
+ expect(layoutSource, file).toContain(
+ 'layout === "workspace" && "px-4"'
+ );
+ } else {
+ expect(layoutSource, file).toContain(
+ '<WorkspacePageToolbar className="px-4'
+ );
+ }
}
expect(source, file).not.toContain(
'className="w-full px-4 overflow-x-hidden flex flex-col pt-2 pb-4"'
@@ -132,7 +147,10 @@ describe("workspace list page layout", () => {
});
test("labels the instances page create action as connect instance", () => {
- const source = readSettingsPage("InstancesPage.tsx");
+ const source = readFileSync(
+ join(componentsDir, "instance/InstanceDashboard.tsx"),
+ "utf8"
+ );
expect(source).toContain('t("instance.connect-instance")');
expect(source).not.toContain('{t("common.create")}');
diff --git a/frontend/src/stores/app/instance.test.ts b/frontend/src/stores/app/instance.test.ts
new file mode 100644
index 0000000000..62dce439a9
--- /dev/null
+++ b/frontend/src/stores/app/instance.test.ts
@@ -0,0 +1,152 @@
+import { create } from "@bufbuild/protobuf";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import {
+ InstanceSchema,
+ type ListInstancesRequest,
+} from "@/types/proto-es/v1/instance_service_pb";
+import { ProjectSchema } from "@/types/proto-es/v1/project_service_pb";
+import { createInstanceSlice } from "./instance";
+
+const mocks = vi.hoisted(() => ({
+ getInstance: vi.fn(),
+ listInstances: vi.fn(),
+ createInstance: vi.fn(),
+ batchSyncInstances: vi.fn(),
+ batchUpdateInstances: vi.fn(),
+ hasWorkspacePermissionV2: vi.fn(() => true),
+ hasProjectPermissionV2: vi.fn(() => true),
+}));
+
+vi.mock("@/api", () => ({
+ instanceServiceClientConnect: {
+ getInstance: mocks.getInstance,
+ listInstances: mocks.listInstances,
+ createInstance: mocks.createInstance,
+ batchSyncInstances: mocks.batchSyncInstances,
+ batchUpdateInstances: mocks.batchUpdateInstances,
+ },
+}));
+
+vi.mock("@/utils", async (importOriginal) => ({
+ ...(await importOriginal<typeof import("@/utils")>()),
+ hasWorkspacePermissionV2: mocks.hasWorkspacePermissionV2,
+ hasProjectPermissionV2: mocks.hasProjectPermissionV2,
+}));
+
+const createStore = () => {
+ const state: Record<string, unknown> = {};
+ const set = (updater: unknown) => {
+ const patch =
+ typeof updater === "function"
+ ? (updater as (value: typeof state) => object)(state)
+ : updater;
+ Object.assign(state, patch);
+ };
+ const get = () => state;
+ Object.assign(
+ state,
+ createInstanceSlice(set as never, get as never, {} as never)
+ );
+ return state as ReturnType<typeof createInstanceSlice>;
+};
+
+describe("instance store project parent", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.hasWorkspacePermissionV2.mockReturnValue(true);
+ mocks.hasProjectPermissionV2.mockReturnValue(true);
+ mocks.listInstances.mockResolvedValue({
+ instances: [],
+ nextPageToken: "",
+ });
+ mocks.createInstance.mockResolvedValue(
+ create(InstanceSchema, {
+ name: "projects/app/instances/prod",
+ title: "Prod",
+ })
+ );
+ mocks.batchSyncInstances.mockResolvedValue({});
+ mocks.batchUpdateInstances.mockResolvedValue({ instances: [] });
+ });
+
+ test("forwards the project parent when listing instances", async () => {
+ const store = createStore();
+
+ await store.fetchInstanceList({
+ parent: "projects/app",
+ pageSize: 10,
+ } as Parameters<typeof store.fetchInstanceList>[0]);
+
+ const request = mocks.listInstances.mock
+ .calls[0][0] as ListInstancesRequest;
+ expect(request.parent).toBe("projects/app");
+ expect(request.pageSize).toBe(10);
+ });
+
+ test("leaves the parent unset for workspace lists", async () => {
+ const store = createStore();
+
+ await store.fetchInstanceList({ pageSize: 10 });
+
+ const request = mocks.listInstances.mock
+ .calls[0][0] as ListInstancesRequest;
+ expect(request.parent).toBeUndefined();
+ });
+
+ test("forwards the project parent when creating an instance", async () => {
+ const store = createStore();
+ const instance = create(InstanceSchema, {
+ name: "projects/app/instances/prod",
+ title: "Prod",
+ });
+
+ await store.createInstance(instance, false, {
+ parent: "projects/app",
+ } as Parameters<typeof store.createInstance>[2]);
+
+ expect(mocks.createInstance.mock.calls[0][0]).toMatchObject({
+ parent: "projects/app",
+ });
+ });
+
+ test("uses project permission to fetch a nested instance", async () => {
+ const store = createStore();
+ const project = create(ProjectSchema, { name: "projects/app" });
+ const instance = create(InstanceSchema, {
+ name: "projects/app/instances/prod",
+ title: "Prod",
+ });
+ Object.assign(store, {
+ projectsByName: { [project.name]: project },
+ });
+ mocks.hasWorkspacePermissionV2.mockReturnValue(false);
+ mocks.getInstance.mockResolvedValue(instance);
+
+ const result = await store.getOrFetchInstanceByName(instance.name, true);
+
+ expect(result).toBe(instance);
+ expect(mocks.hasProjectPermissionV2).toHaveBeenCalledWith(
+ project,
+ "bb.instances.get"
+ );
+ expect(mocks.getInstance).toHaveBeenCalledOnce();
+ });
+
+ test("forwards the project parent for batch operations", async () => {
+ const store = createStore();
+
+ await store.batchSyncInstances(
+ ["projects/app/instances/prod"],
+ true,
+ "projects/app"
+ );
+ await store.batchUpdateInstances([], "projects/app");
+
+ expect(mocks.batchSyncInstances.mock.calls[0][0]).toMatchObject({
+ parent: "projects/app",
+ });
+ expect(mocks.batchUpdateInstances.mock.calls[0][0]).toMatchObject({
+ parent: "projects/app",
+ });
+ });
+});
diff --git a/frontend/src/stores/app/instance.ts b/frontend/src/stores/app/instance.ts
index d0b8cd0fb1..9e58036745 100644
--- a/frontend/src/stores/app/instance.ts
+++ b/frontend/src/stores/app/instance.ts
@@ -2,6 +2,7 @@ import { create as createProto } from "@bufbuild/protobuf";
import { createContextValues } from "@connectrpc/connect";
import { instanceServiceClientConnect } from "@/api";
import { silentContextKey } from "@/api/context-key";
+import { projectNamePrefix } from "@/stores/modules/v1/common";
import { Engine, State } from "@/types/proto-es/v1/common_pb";
import {
AddDataSourceRequestSchema,
@@ -29,7 +30,12 @@ import {
UNKNOWN_INSTANCE_NAME,
} from "@/types/v1/instance";
import { isValidProjectName } from "@/types/v1/project";
-import { extractInstanceResourceName, hasWorkspacePermissionV2 } from "@/utils";
+import {
+ extractInstanceResourceName,
+ extractProjectResourceName,
+ hasProjectPermissionV2,
+ hasWorkspacePermissionV2,
+} from "@/utils";
import type { AppSliceCreator, InstanceFilter, InstanceSlice } from "./types";
import { getLabelFilter, toError } from "./utils";
@@ -152,10 +158,17 @@ export const createInstanceSlice: AppSliceCreator<InstanceSlice> = (
getOrFetchInstanceByName: async (name, silent = false) => {
const cached = get().instancesByName[name];
if (cached) return cached;
- if (
- !isValidInstanceName(name) ||
- !hasWorkspacePermissionV2("bb.instances.get")
- ) {
+ if (!isValidInstanceName(name)) {
+ return unknownInstance;
+ }
+ const projectID = extractProjectResourceName(name);
+ const project = projectID
+ ? get().projectsByName[`${projectNamePrefix}${projectID}`]
+ : undefined;
+ const canGetInstance = projectID
+ ? !!project && hasProjectPermissionV2(project, "bb.instances.get")
+ : hasWorkspacePermissionV2("bb.instances.get");
+ if (!canGetInstance) {
return unknownInstance;
}
// Propagate fetch failures (e.g. NotFound) to the caller — callers such
@@ -173,10 +186,10 @@ export const createInstanceSlice: AppSliceCreator<InstanceSlice> = (
const validateOnlyValue = validateOnly ?? false;
const response = await instanceServiceClientConnect.createInstance(
createProto(CreateInstanceRequestSchema, {
+ parent: options?.parent,
instance,
instanceId: extractInstanceResourceName(instance.name),
validateOnly: validateOnlyValue,
- initialDatabaseProject: options?.initialDatabaseProject,
}),
{
contextValues: createContextValues().set(
@@ -237,17 +250,18 @@ export const createInstanceSlice: AppSliceCreator<InstanceSlice> = (
})
),
- batchSyncInstances: async (instanceNameList, enableFullSync) => {
+ batchSyncInstances: async (instanceNameList, enableFullSync, parent) => {
await instanceServiceClientConnect.batchSyncInstances(
createProto(BatchSyncInstancesRequestSchema, {
+ parent,
requests: instanceNameList.map((name) => ({ name, enableFullSync })),
})
);
},
- batchUpdateInstances: async (requests) => {
+ batchUpdateInstances: async (requests, parent) => {
const response = await instanceServiceClientConnect.batchUpdateInstances(
- createProto(BatchUpdateInstancesRequestSchema, { requests })
+ createProto(BatchUpdateInstancesRequestSchema, { parent, requests })
);
return upsertInstances(response.instances);
},
@@ -316,6 +330,7 @@ export const createInstanceSlice: AppSliceCreator<InstanceSlice> = (
fetchInstanceList: async (params) => {
const response = await instanceServiceClientConnect.listInstances(
createProto(ListInstancesRequestSchema, {
+ parent: params.parent,
pageSize: params.pageSize,
pageToken: params.pageToken,
orderBy: params.orderBy,
diff --git a/frontend/src/stores/app/types.ts b/frontend/src/stores/app/types.ts
index a7aa808ed4..d8a69ac39d 100644
--- a/frontend/src/stores/app/types.ts
+++ b/frontend/src/stores/app/types.ts
@@ -446,7 +446,7 @@ export type InstanceSlice = {
createInstance: (
instance: Instance,
validateOnly?: boolean,
- options?: { initialDatabaseProject?: string }
+ options?: { parent?: string }
) => Promise<Instance>;
updateInstance: (
instance: Instance,
@@ -461,10 +461,12 @@ export type InstanceSlice = {
) => Promise<SyncInstanceResponse>;
batchSyncInstances: (
instanceNameList: string[],
- enableFullSync: boolean
+ enableFullSync: boolean,
+ parent?: string
) => Promise<void>;
batchUpdateInstances: (
- requests: UpdateInstanceRequest[]
+ requests: UpdateInstanceRequest[],
+ parent?: string
) => Promise<Instance[]>;
createDataSource: (params: {
instance: string;
@@ -486,6 +488,7 @@ export type InstanceSlice = {
instance?: Instance
) => Promise<ListInstanceDatabaseResponse>;
fetchInstanceList: (params: {
+ parent?: string;
pageSize?: number;
pageToken?: string;
orderBy?: string;
diff --git a/frontend/src/types/proto-es/v1/instance_service_pb.d.ts b/frontend/src/types/proto-es/v1/instance_service_pb.d.ts
index 0785d7d6b8..5e04761c90 100644
--- a/frontend/src/types/proto-es/v1/instance_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/instance_service_pb.d.ts
@@ -197,14 +197,6 @@ export declare type CreateInstanceRequest = Message<"bytebase.v1.CreateInstanceR
* @generated from field: bool validate_only = 3;
*/
validateOnly: boolean;
-
- /**
- * The project to assign newly discovered databases to during initial sync.
- * Format: projects/{project}. This must be unset when `parent` is set.
- *
- * @generated from field: string initial_database_project = 4;
- */
- initialDatabaseProject: string;
};
/**
diff --git a/frontend/src/types/proto-es/v1/instance_service_pb.js b/frontend/src/types/proto-es/v1/instance_service_pb.js
index 43beb9f167..e4b3a0a69c 100644
--- a/frontend/src/types/proto-es/v1/instance_service_pb.js
+++ b/frontend/src/types/proto-es/v1/instance_service_pb.js
@@ -17,7 +17,7 @@ import { file_v1_instance_role_service } from "./instance_role_service_pb";
* Describes the file v1/instance_service.proto.
*/
export const file_v1_instance_service = /*@__PURE__*/
- fileDesc("Chl2MS9pbnN0YW5jZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXRJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UisQEKFExpc3RJbnN0YW5jZXNSZXF1ZXN0Ei8KBnBhcmVudBgGIAEoCUIa+kEXEhVieXRlYmFzZS5jb20vSW5zdGFuY2VIAIgBARIRCglwYWdlX3NpemUYASABKAUSEgoKcGFnZV90b2tlbhgCIAEoCRIUCgxzaG93X2RlbGV0ZWQYAyABKAgSDgoGZmlsdGVyGAQgASgJEhAKCG9yZGVyX2J5GAUgASgJQgkKB19wYXJlbnQiWgoVTGlzdEluc3RhbmNlc1Jlc3BvbnNlEigKCWluc3RhbmNlcxgBIAMoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSLPAQoVQ3JlYXRlSW5zdGFuY2VSZXF1ZXN0Ei8KBnBhcmVudBgFIAEoCUIa+kEXEhVieXRlYmFzZS5jb20vSW5zdGFuY2VIAIgBARIsCghpbnN0YW5jZRgBIAEoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlQgPgQQISEwoLaW5zdGFuY2VfaWQYAiABKAkSFQoNdmFsaWRhdGVfb25seRgDIAEoCBIgChhpbml0aWFsX2RhdGFiYXNlX3Byb2plY3QYBCABKAlCCQoHX3BhcmVudCKNAQoVVXBkYXRlSW5zdGFuY2VSZXF1ZXN0EiwKCGluc3RhbmNlGAEgASgLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2VCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJiChVEZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USDQoFZm9yY2UYAiABKAgSDQoFcHVyZ2UYAyABKAgiRgoXVW5kZWxldGVJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UiXAoTU3luY0luc3RhbmNlUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIYChBlbmFibGVfZnVsbF9zeW5jGAIgASgIIooBChtMaXN0SW5zdGFuY2VEYXRhYmFzZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoIaW5zdGFuY2UYAiABKAsyFS5ieXRlYmFzZS52MS5JbnN0YW5jZUID4EECSACIAQFCCwoJX2luc3RhbmNlIjEKHExpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2USEQoJZGF0YWJhc2VzGAEgAygJIikKFFN5bmNJbnN0YW5jZVJlc3BvbnNlEhEKCWRhdGFiYXNlcxgBIAMoCSKQAQoZQmF0Y2hTeW5jSW5zdGFuY2VzUmVxdWVzdBIvCgZwYXJlbnQYAiABKAlCGvpBFxIVYnl0ZWJhc2UuY29tL0luc3RhbmNlSACIAQESNwoIcmVxdWVzdHMYASADKAsyIC5ieXRlYmFzZS52MS5TeW5jSW5zdGFuY2VSZXF1ZXN0QgPgQQJCCQoHX3BhcmVudCIcChpCYXRjaFN5bmNJbnN0YW5jZXNSZXNwb25zZSKUAQobQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXF1ZXN0Ei8KBnBhcmVudBgCIAEoCUIa+kEXEhVieXRlYmFzZS5jb20vSW5zdGFuY2VIAIgBARI5CghyZXF1ZXN0cxgBIAMoCzIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdEID4EECQgkKB19wYXJlbnQiSAocQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXNwb25zZRIoCglpbnN0YW5jZXMYASADKAsyFS5ieXRlYmFzZS52MS5JbnN0YW5jZSKNAQoUQWRkRGF0YVNvdXJjZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoLZGF0YV9zb3VyY2UYAiABKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlQgPgQQISFQoNdmFsaWRhdGVfb25seRgDIAEoCCJ5ChdSZW1vdmVEYXRhU291cmNlUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIxCgtkYXRhX3NvdXJjZRgCIAEoCzIXLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VCA+BBAiLYAQoXVXBkYXRlRGF0YVNvdXJjZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoLZGF0YV9zb3VyY2UYAiABKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlQgPgQQISLwoLdXBkYXRlX21hc2sYAyABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrEhUKDXZhbGlkYXRlX29ubHkYBCABKAgSFQoNYWxsb3dfbWlzc2luZxgFIAEoCCIiCg1TeW5jRGF0YWJhc2VzEhEKCWRhdGFiYXNlcxgBIAMoCSK2BQoISW5zdGFuY2USDAoEbmFtZRgBIAEoCRIhCgVzdGF0ZRgDIAEoDjISLmJ5dGViYXNlLnYxLlN0YXRlEhcKBXRpdGxlGAQgASgJQgi6SAVyAxjIARIjCgZlbmdpbmUYBSABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSGwoOZW5naW5lX3ZlcnNpb24YBiABKAlCA+BBAxIVCg1leHRlcm5hbF9saW5rGAcgASgJEi0KDGRhdGFfc291cmNlcxgIIAMoCzIXLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2USHQoLZW52aXJvbm1lbnQYCSABKAlCA+BBAUgAiAEBEhIKCmFjdGl2YXRpb24YCiABKAgSLQoFcm9sZXMYCyADKAsyGS5ieXRlYmFzZS52MS5JbnN0YW5jZVJvbGVCA+BBAxIwCg1zeW5jX2ludGVydmFsGAwgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uEjIKDnN5bmNfZGF0YWJhc2VzGA4gASgLMhouYnl0ZWJhc2UudjEuU3luY0RhdGFiYXNlcxI3Cg5sYXN0X3N5bmNfdGltZRgPIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIxCgZsYWJlbHMYECADKAsyIS5ieXRlYmFzZS52MS5JbnN0YW5jZS5MYWJlbHNFbnRyeRotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBOlnqQVYKFWJ5dGViYXNlLmNvbS9JbnN0YW5jZRIUaW5zdGFuY2VzL3tpbnN0YW5jZX0SJ3Byb2plY3RzL3twcm9qZWN0fS9pbnN0YW5jZXMve2luc3RhbmNlfUIOCgxfZW52aXJvbm1lbnRKBAgCEANKBAgNEA4irwgKGERhdGFTb3VyY2VFeHRlcm5hbFNlY3JldBJFCgtzZWNyZXRfdHlwZRgBIAEoDjIwLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VFeHRlcm5hbFNlY3JldC5TZWNyZXRUeXBlEgsKA3VybBgCIAEoCRJBCglhdXRoX3R5cGUYAyABKA4yLi5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuQXV0aFR5cGUSSwoIYXBwX3JvbGUYBCABKAsyNy5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuQXBwUm9sZUF1dGhPcHRpb25IABIUCgV0b2tlbhgFIAEoCUID4EEESAASQwoKdG9rZW5fdHlwZRgNIAEoDjIvLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VFeHRlcm5hbFNlY3JldC5Ub2tlblR5cGUSEwoLZW5naW5lX25hbWUYBiABKAkSEwoLc2VjcmV0X25hbWUYByABKAkSGQoRcGFzc3dvcmRfa2V5X25hbWUYCCABKAkSIwobc2tpcF92YXVsdF90bHNfdmVyaWZpY2F0aW9uGAkgASgIEhkKDHZhdWx0X3NzbF9jYRgKIAEoCUID4EEEEhsKDnZhdWx0X3NzbF9jZXJ0GAsgASgJQgPgQQQSGgoNdmF1bHRfc3NsX2tleRgMIAEoCUID4EEEGu4BChFBcHBSb2xlQXV0aE9wdGlvbhIUCgdyb2xlX2lkGAEgASgJQgPgQQQSFgoJc2VjcmV0X2lkGAIgASgJQgPgQQQSUAoEdHlwZRgDIAEoDjJCLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VFeHRlcm5hbFNlY3JldC5BcHBSb2xlQXV0aE9wdGlvbi5TZWNyZXRUeXBlEhIKCm1vdW50X3BhdGgYBCABKAkiRQoKU2VjcmV0VHlwZRIbChdTRUNSRVRfVFlQRV9VTlNQRUNJRklFRBAAEgkKBVBMQUlOEAESDwoLRU5WSVJPTk1FTlQQAiKAAQoKU2VjcmV0VHlwZRIbChdTRUNSRVRfVFlQRV9VTlNQRUNJRklFRBAAEg8KC1ZBVUxUX0tWX1YyEAESFwoTQVdTX1NFQ1JFVFNfTUFOQUdFUhACEhYKEkdDUF9TRUNSRVRfTUFOQUdFUhADEhMKD0FaVVJFX0tFWV9WQVVMVBAEIkQKCEF1dGhUeXBlEhkKFUFVVEhfVFlQRV9VTlNQRUNJRklFRBAAEgkKBVRPS0VOEAESEgoOVkFVTFRfQVBQX1JPTEUQAiJNCglUb2tlblR5cGUSGgoWVE9LRU5fVFlQRV9VTlNQRUNJRklFRBAAEgkKBVBMQUlOEAESDwoLRU5WSVJPTk1FTlQQAhIICgRGSUxFEANCDQoLYXV0aF9vcHRpb24i0BIKCkRhdGFTb3VyY2USCgoCaWQYASABKAkSKQoEdHlwZRgCIAEoDjIbLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2VUeXBlEhAKCHVzZXJuYW1lGAMgASgJEhUKCHBhc3N3b3JkGAQgASgJQgPgQQQSDwoHdXNlX3NzbBgeIAEoCBITCgZzc2xfY2EYBSABKAlCA+BBBBIVCghzc2xfY2VydBgGIAEoCUID4EEEEhQKB3NzbF9rZXkYByABKAlCA+BBBBIYCgtzc2xfY2FfcGF0aBgpIAEoCUID4EEEEhoKDXNzbF9jZXJ0X3BhdGgYKiABKAlCA+BBBBIZCgxzc2xfa2V5X3BhdGgYKyABKAlCA+BBBBIXCgpzc2xfY2Ffc2V0GCwgASgIQgPgQQMSGQoMc3NsX2NlcnRfc2V0GC0gASgIQgPgQQMSGAoLc3NsX2tleV9zZXQYLiABKAhCA+BBAxIcCg9zc2xfY2FfcGF0aF9zZXQYLyABKAhCA+BBAxIeChFzc2xfY2VydF9wYXRoX3NldBgwIAEoCEID4EEDEh0KEHNzbF9rZXlfcGF0aF9zZXQYMSABKAhCA+BBAxIeChZ2ZXJpZnlfdGxzX2NlcnRpZmljYXRlGCcgASgIEgwKBGhvc3QYCCABKAkSDAoEcG9ydBgJIAEoCRIQCghkYXRhYmFzZRgKIAEoCRILCgNzcnYYCyABKAgSHwoXYXV0aGVudGljYXRpb25fZGF0YWJhc2UYDCABKAkSEwoLcmVwbGljYV9zZXQYGSABKAkSCwoDc2lkGA0gASgJEhQKDHNlcnZpY2VfbmFtZRgOIAEoCRIQCghzc2hfaG9zdBgPIAEoCRIQCghzc2hfcG9ydBgQIAEoCRIQCghzc2hfdXNlchgRIAEoCRIZCgxzc2hfcGFzc3dvcmQYEiABKAlCA+BBBBIcCg9zc2hfcHJpdmF0ZV9rZXkYEyABKAlCA+BBBBInChphdXRoZW50aWNhdGlvbl9wcml2YXRlX2tleRgUIAEoCUID4EEEEjIKJWF1dGhlbnRpY2F0aW9uX3ByaXZhdGVfa2V5X3Bhc3NwaHJhc2UYKCABKAlCA+BBBBI+Cg9leHRlcm5hbF9zZWNyZXQYFSABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRwoTYXV0aGVudGljYXRpb25fdHlwZRgWIAEoDjIqLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQXV0aGVudGljYXRpb25UeXBlEkEKEWNsb3VkX3NxbF9pcF90eXBlGDggASgOMiYuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5DbG91ZFNRTElQVHlwZRJDChBhenVyZV9jcmVkZW50aWFsGBcgASgLMicuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5BenVyZUNyZWRlbnRpYWxIABI/Cg5hd3NfY3JlZGVudGlhbBglIAEoCzIlLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQVdTQ3JlZGVudGlhbEgAEj8KDmdjcF9jcmVkZW50aWFsGCYgASgLMiUuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5HQ1BDcmVkZW50aWFsSAASLAoLc2FzbF9jb25maWcYGCABKAsyFy5ieXRlYmFzZS52MS5TQVNMQ29uZmlnEkIKFGFkZGl0aW9uYWxfYWRkcmVzc2VzGBogAygLMh8uYnl0ZWJhc2UudjEuRGF0YVNvdXJjZS5BZGRyZXNzQgPgQQESGQoRZGlyZWN0X2Nvbm5lY3Rpb24YGyABKAgSDgoGcmVnaW9uGBwgASgJEhQKDHdhcmVob3VzZV9pZBgdIAEoCRITCgttYXN0ZXJfbmFtZRgfIAEoCRIXCg9tYXN0ZXJfdXNlcm5hbWUYICABKAkSHAoPbWFzdGVyX3Bhc3N3b3JkGCEgASgJQgPgQQQSNQoKcmVkaXNfdHlwZRgiIAEoDjIhLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuUmVkaXNUeXBlElsKG2V4dHJhX2Nvbm5lY3Rpb25fcGFyYW1ldGVycxgkIAMoCzI2LmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuRXh0cmFDb25uZWN0aW9uUGFyYW1ldGVyc0VudHJ5EhIKCnByb2plY3RfaWQYOSABKAkSEwoLaW5zdGFuY2VfaWQYOiABKAkaUwoPQXp1cmVDcmVkZW50aWFsEhEKCXRlbmFudF9pZBgBIAEoCRIRCgljbGllbnRfaWQYAiABKAkSGgoNY2xpZW50X3NlY3JldBgDIAEoCUID4EEEGpgBCg1BV1NDcmVkZW50aWFsEhoKDWFjY2Vzc19rZXlfaWQYASABKAlCA+BBBBIeChFzZWNyZXRfYWNjZXNzX2tleRgCIAEoCUID4EEEEhoKDXNlc3Npb25fdG9rZW4YAyABKAlCA+BBBBIVCghyb2xlX2FybhgEIAEoCUID4EEEEhgKC2V4dGVybmFsX2lkGAUgASgJQgPgQQQaJQoNR0NQQ3JlZGVudGlhbBIUCgdjb250ZW50GAEgASgJQgPgQQQaJQoHQWRkcmVzcxIMCgRob3N0GAEgASgJEgwKBHBvcnQYAiABKAkaQAoeRXh0cmFDb25uZWN0aW9uUGFyYW1ldGVyc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEifAoSQXV0aGVudGljYXRpb25UeXBlEh4KGkFVVEhFTlRJQ0FUSU9OX1VOU1BFQ0lGSUVEEAASDAoIUEFTU1dPUkQQARIYChRHT09HTEVfQ0xPVURfU1FMX0lBTRACEg8KC0FXU19SRFNfSUFNEAMSDQoJQVpVUkVfSUFNEAQiVQoOQ2xvdWRTUUxJUFR5cGUSIQodQ0xPVURfU1FMX0lQX1RZUEVfVU5TUEVDSUZJRUQQABIKCgZQVUJMSUMQARILCgdQUklWQVRFEAISBwoDUFNDEAMiUgoJUmVkaXNUeXBlEhoKFlJFRElTX1RZUEVfVU5TUEVDSUZJRUQQABIOCgpTVEFOREFMT05FEAESDAoIU0VOVElORUwQAhILCgdDTFVTVEVSEANCDwoNaWFtX2V4dGVuc2lvbkoECCMQJEoECDIQOCLeAQoQSW5zdGFuY2VSZXNvdXJjZRINCgV0aXRsZRgBIAEoCRIjCgZlbmdpbmUYAiABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSGwoOZW5naW5lX3ZlcnNpb24YAyABKAlCA+BBAxItCgxkYXRhX3NvdXJjZXMYBCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEhIKCmFjdGl2YXRpb24YBSABKAgSDAoEbmFtZRgGIAEoCRIYCgtlbnZpcm9ubWVudBgHIAEoCUgAiAEBQg4KDF9lbnZpcm9ubWVudCJMCgpTQVNMQ29uZmlnEjEKCmtyYl9jb25maWcYASABKAsyGy5ieXRlYmFzZS52MS5LZXJiZXJvc0NvbmZpZ0gAQgsKCW1lY2hhbmlzbSKbAQoOS2VyYmVyb3NDb25maWcSDwoHcHJpbWFyeRgBIAEoCRIQCghpbnN0YW5jZRgCIAEoCRINCgVyZWFsbRgDIAEoCRITCgZrZXl0YWIYBCABKAxCA+BBBBIQCghrZGNfaG9zdBgFIAEoCRIQCghrZGNfcG9ydBgGIAEoCRIeChZrZGNfdHJhbnNwb3J0X3Byb3RvY29sGAcgASgJKkcKDkRhdGFTb3VyY2VUeXBlEhsKF0RBVEFfU09VUkNFX1VOU1BFQ0lGSUVEEAASCQoFQURNSU4QARINCglSRUFEX09OTFkQAjLWFQoPSW5zdGFuY2VTZXJ2aWNlEqkBCgtHZXRJbnN0YW5jZRIfLmJ5dGViYXNlLnYxLkdldEluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlImLaQQRuYW1liuowEGJiLmluc3RhbmNlcy5nZXSQ6jABgtPkkwI9WiMSIS92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfRIWL3YxL3tuYW1lPWluc3RhbmNlcy8qfRKuAQoNTGlzdEluc3RhbmNlcxIhLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZXNSZXF1ZXN0GiIuYnl0ZWJhc2UudjEuTGlzdEluc3RhbmNlc1Jlc3BvbnNlIlbaQQCK6jARYmIuaW5zdGFuY2VzLmxpc3SQ6jABgtPkkwI0WiMSIS92MS97cGFyZW50PXByb2plY3RzLyp9L2luc3RhbmNlcxINL3YxL2luc3RhbmNlcxLFAQoOQ3JlYXRlSW5zdGFuY2USIi5ieXRlYmFzZS52MS5DcmVhdGVJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSJ42kEIaW5zdGFuY2WK6jATYmIuaW5zdGFuY2VzLmNyZWF0ZZDqMAGY6jABgtPkkwJIOghpbnN0YW5jZVotOghpbnN0YW5jZSIhL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vaW5zdGFuY2VzIg0vdjEvaW5zdGFuY2VzEu0BCg5VcGRhdGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLlVwZGF0ZUluc3RhbmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIp8B2kEUaW5zdGFuY2UsdXBkYXRlX21hc2uK6jATYmIuaW5zdGFuY2VzLnVwZGF0ZZDqMAGY6jABgtPkkwJjOghpbnN0YW5jZVo2OghpbnN0YW5jZTIqL3YxL3tpbnN0YW5jZS5uYW1lPXByb2plY3RzLyovaW5zdGFuY2VzLyp9Mh8vdjEve2luc3RhbmNlLm5hbWU9aW5zdGFuY2VzLyp9ErcBCg5EZWxldGVJbnN0YW5jZRIiLmJ5dGViYXNlLnYxLkRlbGV0ZUluc3RhbmNlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSJp2kEEbmFtZYrqMBNiYi5pbnN0YW5jZXMuZGVsZXRlkOowAZjqMAGC0+STAj1aIyohL3YxL3tuYW1lPXByb2plY3RzLyovaW5zdGFuY2VzLyp9KhYvdjEve25hbWU9aW5zdGFuY2VzLyp9Es0BChBVbmRlbGV0ZUluc3RhbmNlEiQuYnl0ZWJhc2UudjEuVW5kZWxldGVJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSJ8iuowFWJiLmluc3RhbmNlcy51bmRlbGV0ZZDqMAGY6jABgtPkkwJVOgEqWi86ASoiKi92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfTp1bmRlbGV0ZSIfL3YxL3tuYW1lPWluc3RhbmNlcy8qfTp1bmRlbGV0ZRLBAQoMU3luY0luc3RhbmNlEiAuYnl0ZWJhc2UudjEuU3luY0luc3RhbmNlUmVxdWVzdBohLmJ5dGViYXNlLnYxLlN5bmNJbnN0YW5jZVJlc3BvbnNlImyK6jARYmIuaW5zdGFuY2VzLnN5bmOQ6jABgtPkkwJNOgEqWis6ASoiJi92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfTpzeW5jIhsvdjEve25hbWU9aW5zdGFuY2VzLyp9OnN5bmMS4gEKFExpc3RJbnN0YW5jZURhdGFiYXNlEiguYnl0ZWJhc2UudjEuTGlzdEluc3RhbmNlRGF0YWJhc2VSZXF1ZXN0GikuYnl0ZWJhc2UudjEuTGlzdEluc3RhbmNlRGF0YWJhc2VSZXNwb25zZSJ1iuowEGJiLmluc3RhbmNlcy5nZXSQ6jABgtPkkwJXOgEqWjA6ASoiKy92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfTpkYXRhYmFzZXMiIC92MS97bmFtZT1pbnN0YW5jZXMvKn06ZGF0YWJhc2VzEtQBChJCYXRjaFN5bmNJbnN0YW5jZXMSJi5ieXRlYmFzZS52MS5CYXRjaFN5bmNJbnN0YW5jZXNSZXF1ZXN0GicuYnl0ZWJhc2UudjEuQmF0Y2hTeW5jSW5zdGFuY2VzUmVzcG9uc2UibYrqMBFiYi5pbnN0YW5jZXMuc3luY5DqMAGC0+STAk46ASpaMDoBKiIrL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vaW5zdGFuY2VzOmJhdGNoU3luYyIXL3YxL2luc3RhbmNlczpiYXRjaFN5bmMS5AEKFEJhdGNoVXBkYXRlSW5zdGFuY2VzEiguYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXF1ZXN0GikuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVJbnN0YW5jZXNSZXNwb25zZSJ3iuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCUjoBKloyOgEqIi0vdjEve3BhcmVudD1wcm9qZWN0cy8qfS9pbnN0YW5jZXM6YmF0Y2hVcGRhdGUiGS92MS9pbnN0YW5jZXM6YmF0Y2hVcGRhdGUS0AEKDUFkZERhdGFTb3VyY2USIS5ieXRlYmFzZS52MS5BZGREYXRhU291cmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIoQBiuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCXzoBKlo0OgEqIi8vdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn06YWRkRGF0YVNvdXJjZSIkL3YxL3tuYW1lPWluc3RhbmNlcy8qfTphZGREYXRhU291cmNlEtwBChBSZW1vdmVEYXRhU291cmNlEiQuYnl0ZWJhc2UudjEuUmVtb3ZlRGF0YVNvdXJjZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSKKAYrqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAmU6ASpaNzoBKiIyL3YxL3tuYW1lPXByb2plY3RzLyovaW5zdGFuY2VzLyp9OnJlbW92ZURhdGFTb3VyY2UiJy92MS97bmFtZT1pbnN0YW5jZXMvKn06cmVtb3ZlRGF0YVNvdXJjZRKKAgoQVXBkYXRlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlVwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiuAHaQRdkYXRhX3NvdXJjZSx1cGRhdGVfbWFza4rqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAnk6C2RhdGFfc291cmNlWkE6C2RhdGFfc291cmNlMjIvdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn06dXBkYXRlRGF0YVNvdXJjZTInL3YxL3tuYW1lPWluc3RhbmNlcy8qfTp1cGRhdGVEYXRhU291cmNlQqoBCg9jb20uYnl0ZWJhc2UudjFCFEluc3RhbmNlU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_role_service]);
+ fileDesc("Chl2MS9pbnN0YW5jZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXRJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2UisQEKFExpc3RJbnN0YW5jZXNSZXF1ZXN0Ei8KBnBhcmVudBgGIAEoCUIa+kEXEhVieXRlYmFzZS5jb20vSW5zdGFuY2VIAIgBARIRCglwYWdlX3NpemUYASABKAUSEgoKcGFnZV90b2tlbhgCIAEoCRIUCgxzaG93X2RlbGV0ZWQYAyABKAgSDgoGZmlsdGVyGAQgASgJEhAKCG9yZGVyX2J5GAUgASgJQgkKB19wYXJlbnQiWgoVTGlzdEluc3RhbmNlc1Jlc3BvbnNlEigKCWluc3RhbmNlcxgBIAMoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSLNAQoVQ3JlYXRlSW5zdGFuY2VSZXF1ZXN0Ei8KBnBhcmVudBgFIAEoCUIa+kEXEhVieXRlYmFzZS5jb20vSW5zdGFuY2VIAIgBARIsCghpbnN0YW5jZRgBIAEoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlQgPgQQISEwoLaW5zdGFuY2VfaWQYAiABKAkSFQoNdmFsaWRhdGVfb25seRgDIAEoCEIJCgdfcGFyZW50SgQIBBAFUhhpbml0aWFsX2RhdGFiYXNlX3Byb2plY3QijQEKFVVwZGF0ZUluc3RhbmNlUmVxdWVzdBIsCghpbnN0YW5jZRgBIAEoCzIVLmJ5dGViYXNlLnYxLkluc3RhbmNlQgPgQQISLwoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrEhUKDWFsbG93X21pc3NpbmcYAyABKAgiYgoVRGVsZXRlSW5zdGFuY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEg0KBWZvcmNlGAIgASgIEg0KBXB1cmdlGAMgASgIIkYKF1VuZGVsZXRlSW5zdGFuY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlIlwKE1N5bmNJbnN0YW5jZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USGAoQZW5hYmxlX2Z1bGxfc3luYxgCIAEoCCKKAQobTGlzdEluc3RhbmNlRGF0YWJhc2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKCGluc3RhbmNlGAIgASgLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2VCA+BBAkgAiAEBQgsKCV9pbnN0YW5jZSIxChxMaXN0SW5zdGFuY2VEYXRhYmFzZVJlc3BvbnNlEhEKCWRhdGFiYXNlcxgBIAMoCSIpChRTeW5jSW5zdGFuY2VSZXNwb25zZRIRCglkYXRhYmFzZXMYASADKAkikAEKGUJhdGNoU3luY0luc3RhbmNlc1JlcXVlc3QSLwoGcGFyZW50GAIgASgJQhr6QRcSFWJ5dGViYXNlLmNvbS9JbnN0YW5jZUgAiAEBEjcKCHJlcXVlc3RzGAEgAygLMiAuYnl0ZWJhc2UudjEuU3luY0luc3RhbmNlUmVxdWVzdEID4EECQgkKB19wYXJlbnQiHAoaQmF0Y2hTeW5jSW5zdGFuY2VzUmVzcG9uc2UilAEKG0JhdGNoVXBkYXRlSW5zdGFuY2VzUmVxdWVzdBIvCgZwYXJlbnQYAiABKAlCGvpBFxIVYnl0ZWJhc2UuY29tL0luc3RhbmNlSACIAQESOQoIcmVxdWVzdHMYASADKAsyIi5ieXRlYmFzZS52MS5VcGRhdGVJbnN0YW5jZVJlcXVlc3RCA+BBAkIJCgdfcGFyZW50IkgKHEJhdGNoVXBkYXRlSW5zdGFuY2VzUmVzcG9uc2USKAoJaW5zdGFuY2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UijQEKFEFkZERhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEhUKDXZhbGlkYXRlX29ubHkYAyABKAgieQoXUmVtb3ZlRGF0YVNvdXJjZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vSW5zdGFuY2USMQoLZGF0YV9zb3VyY2UYAiABKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlQgPgQQIi2AEKF1VwZGF0ZURhdGFTb3VyY2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0luc3RhbmNlEjEKC2RhdGFfc291cmNlGAIgASgLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUID4EECEi8KC3VwZGF0ZV9tYXNrGAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg12YWxpZGF0ZV9vbmx5GAQgASgIEhUKDWFsbG93X21pc3NpbmcYBSABKAgiIgoNU3luY0RhdGFiYXNlcxIRCglkYXRhYmFzZXMYASADKAkitgUKCEluc3RhbmNlEgwKBG5hbWUYASABKAkSIQoFc3RhdGUYAyABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZRIXCgV0aXRsZRgEIAEoCUIIukgFcgMYyAESIwoGZW5naW5lGAUgASgOMhMuYnl0ZWJhc2UudjEuRW5naW5lEhsKDmVuZ2luZV92ZXJzaW9uGAYgASgJQgPgQQMSFQoNZXh0ZXJuYWxfbGluaxgHIAEoCRItCgxkYXRhX3NvdXJjZXMYCCADKAsyFy5ieXRlYmFzZS52MS5EYXRhU291cmNlEh0KC2Vudmlyb25tZW50GAkgASgJQgPgQQFIAIgBARISCgphY3RpdmF0aW9uGAogASgIEi0KBXJvbGVzGAsgAygLMhkuYnl0ZWJhc2UudjEuSW5zdGFuY2VSb2xlQgPgQQMSMAoNc3luY19pbnRlcnZhbBgMIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbhIyCg5zeW5jX2RhdGFiYXNlcxgOIAEoCzIaLmJ5dGViYXNlLnYxLlN5bmNEYXRhYmFzZXMSNwoObGFzdF9zeW5jX3RpbWUYDyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSMQoGbGFiZWxzGBAgAygLMiEuYnl0ZWJhc2UudjEuSW5zdGFuY2UuTGFiZWxzRW50cnkaLQoLTGFiZWxzRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4ATpZ6kFWChVieXRlYmFzZS5jb20vSW5zdGFuY2USFGluc3RhbmNlcy97aW5zdGFuY2V9Eidwcm9qZWN0cy97cHJvamVjdH0vaW5zdGFuY2VzL3tpbnN0YW5jZX1CDgoMX2Vudmlyb25tZW50SgQIAhADSgQIDRAOIq8IChhEYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQSRQoLc2VjcmV0X3R5cGUYASABKA4yMC5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuU2VjcmV0VHlwZRILCgN1cmwYAiABKAkSQQoJYXV0aF90eXBlGAMgASgOMi4uYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkF1dGhUeXBlEksKCGFwcF9yb2xlGAQgASgLMjcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0LkFwcFJvbGVBdXRoT3B0aW9uSAASFAoFdG9rZW4YBSABKAlCA+BBBEgAEkMKCnRva2VuX3R5cGUYDSABKA4yLy5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuVG9rZW5UeXBlEhMKC2VuZ2luZV9uYW1lGAYgASgJEhMKC3NlY3JldF9uYW1lGAcgASgJEhkKEXBhc3N3b3JkX2tleV9uYW1lGAggASgJEiMKG3NraXBfdmF1bHRfdGxzX3ZlcmlmaWNhdGlvbhgJIAEoCBIZCgx2YXVsdF9zc2xfY2EYCiABKAlCA+BBBBIbCg52YXVsdF9zc2xfY2VydBgLIAEoCUID4EEEEhoKDXZhdWx0X3NzbF9rZXkYDCABKAlCA+BBBBruAQoRQXBwUm9sZUF1dGhPcHRpb24SFAoHcm9sZV9pZBgBIAEoCUID4EEEEhYKCXNlY3JldF9pZBgCIAEoCUID4EEEElAKBHR5cGUYAyABKA4yQi5ieXRlYmFzZS52MS5EYXRhU291cmNlRXh0ZXJuYWxTZWNyZXQuQXBwUm9sZUF1dGhPcHRpb24uU2VjcmV0VHlwZRISCgptb3VudF9wYXRoGAQgASgJIkUKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVQTEFJThABEg8KC0VOVklST05NRU5UEAIigAEKClNlY3JldFR5cGUSGwoXU0VDUkVUX1RZUEVfVU5TUEVDSUZJRUQQABIPCgtWQVVMVF9LVl9WMhABEhcKE0FXU19TRUNSRVRTX01BTkFHRVIQAhIWChJHQ1BfU0VDUkVUX01BTkFHRVIQAxITCg9BWlVSRV9LRVlfVkFVTFQQBCJECghBdXRoVHlwZRIZChVBVVRIX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVUT0tFThABEhIKDlZBVUxUX0FQUF9ST0xFEAIiTQoJVG9rZW5UeXBlEhoKFlRPS0VOX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVQTEFJThABEg8KC0VOVklST05NRU5UEAISCAoERklMRRADQg0KC2F1dGhfb3B0aW9uItASCgpEYXRhU291cmNlEgoKAmlkGAEgASgJEikKBHR5cGUYAiABKA4yGy5ieXRlYmFzZS52MS5EYXRhU291cmNlVHlwZRIQCgh1c2VybmFtZRgDIAEoCRIVCghwYXNzd29yZBgEIAEoCUID4EEEEg8KB3VzZV9zc2wYHiABKAgSEwoGc3NsX2NhGAUgASgJQgPgQQQSFQoIc3NsX2NlcnQYBiABKAlCA+BBBBIUCgdzc2xfa2V5GAcgASgJQgPgQQQSGAoLc3NsX2NhX3BhdGgYKSABKAlCA+BBBBIaCg1zc2xfY2VydF9wYXRoGCogASgJQgPgQQQSGQoMc3NsX2tleV9wYXRoGCsgASgJQgPgQQQSFwoKc3NsX2NhX3NldBgsIAEoCEID4EEDEhkKDHNzbF9jZXJ0X3NldBgtIAEoCEID4EEDEhgKC3NzbF9rZXlfc2V0GC4gASgIQgPgQQMSHAoPc3NsX2NhX3BhdGhfc2V0GC8gASgIQgPgQQMSHgoRc3NsX2NlcnRfcGF0aF9zZXQYMCABKAhCA+BBAxIdChBzc2xfa2V5X3BhdGhfc2V0GDEgASgIQgPgQQMSHgoWdmVyaWZ5X3Rsc19jZXJ0aWZpY2F0ZRgnIAEoCBIMCgRob3N0GAggASgJEgwKBHBvcnQYCSABKAkSEAoIZGF0YWJhc2UYCiABKAkSCwoDc3J2GAsgASgIEh8KF2F1dGhlbnRpY2F0aW9uX2RhdGFiYXNlGAwgASgJEhMKC3JlcGxpY2Ffc2V0GBkgASgJEgsKA3NpZBgNIAEoCRIUCgxzZXJ2aWNlX25hbWUYDiABKAkSEAoIc3NoX2hvc3QYDyABKAkSEAoIc3NoX3BvcnQYECABKAkSEAoIc3NoX3VzZXIYESABKAkSGQoMc3NoX3Bhc3N3b3JkGBIgASgJQgPgQQQSHAoPc3NoX3ByaXZhdGVfa2V5GBMgASgJQgPgQQQSJwoaYXV0aGVudGljYXRpb25fcHJpdmF0ZV9rZXkYFCABKAlCA+BBBBIyCiVhdXRoZW50aWNhdGlvbl9wcml2YXRlX2tleV9wYXNzcGhyYXNlGCggASgJQgPgQQQSPgoPZXh0ZXJuYWxfc2VjcmV0GBUgASgLMiUuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZUV4dGVybmFsU2VjcmV0EkcKE2F1dGhlbnRpY2F0aW9uX3R5cGUYFiABKA4yKi5ieXRlYmFzZS52MS5EYXRhU291cmNlLkF1dGhlbnRpY2F0aW9uVHlwZRJBChFjbG91ZF9zcWxfaXBfdHlwZRg4IAEoDjImLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQ2xvdWRTUUxJUFR5cGUSQwoQYXp1cmVfY3JlZGVudGlhbBgXIAEoCzInLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQXp1cmVDcmVkZW50aWFsSAASPwoOYXdzX2NyZWRlbnRpYWwYJSABKAsyJS5ieXRlYmFzZS52MS5EYXRhU291cmNlLkFXU0NyZWRlbnRpYWxIABI/Cg5nY3BfY3JlZGVudGlhbBgmIAEoCzIlLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuR0NQQ3JlZGVudGlhbEgAEiwKC3Nhc2xfY29uZmlnGBggASgLMhcuYnl0ZWJhc2UudjEuU0FTTENvbmZpZxJCChRhZGRpdGlvbmFsX2FkZHJlc3NlcxgaIAMoCzIfLmJ5dGViYXNlLnYxLkRhdGFTb3VyY2UuQWRkcmVzc0ID4EEBEhkKEWRpcmVjdF9jb25uZWN0aW9uGBsgASgIEg4KBnJlZ2lvbhgcIAEoCRIUCgx3YXJlaG91c2VfaWQYHSABKAkSEwoLbWFzdGVyX25hbWUYHyABKAkSFwoPbWFzdGVyX3VzZXJuYW1lGCAgASgJEhwKD21hc3Rlcl9wYXNzd29yZBghIAEoCUID4EEEEjUKCnJlZGlzX3R5cGUYIiABKA4yIS5ieXRlYmFzZS52MS5EYXRhU291cmNlLlJlZGlzVHlwZRJbChtleHRyYV9jb25uZWN0aW9uX3BhcmFtZXRlcnMYJCADKAsyNi5ieXRlYmFzZS52MS5EYXRhU291cmNlLkV4dHJhQ29ubmVjdGlvblBhcmFtZXRlcnNFbnRyeRISCgpwcm9qZWN0X2lkGDkgASgJEhMKC2luc3RhbmNlX2lkGDogASgJGlMKD0F6dXJlQ3JlZGVudGlhbBIRCgl0ZW5hbnRfaWQYASABKAkSEQoJY2xpZW50X2lkGAIgASgJEhoKDWNsaWVudF9zZWNyZXQYAyABKAlCA+BBBBqYAQoNQVdTQ3JlZGVudGlhbBIaCg1hY2Nlc3Nfa2V5X2lkGAEgASgJQgPgQQQSHgoRc2VjcmV0X2FjY2Vzc19rZXkYAiABKAlCA+BBBBIaCg1zZXNzaW9uX3Rva2VuGAMgASgJQgPgQQQSFQoIcm9sZV9hcm4YBCABKAlCA+BBBBIYCgtleHRlcm5hbF9pZBgFIAEoCUID4EEEGiUKDUdDUENyZWRlbnRpYWwSFAoHY29udGVudBgBIAEoCUID4EEEGiUKB0FkZHJlc3MSDAoEaG9zdBgBIAEoCRIMCgRwb3J0GAIgASgJGkAKHkV4dHJhQ29ubmVjdGlvblBhcmFtZXRlcnNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBInwKEkF1dGhlbnRpY2F0aW9uVHlwZRIeChpBVVRIRU5USUNBVElPTl9VTlNQRUNJRklFRBAAEgwKCFBBU1NXT1JEEAESGAoUR09PR0xFX0NMT1VEX1NRTF9JQU0QAhIPCgtBV1NfUkRTX0lBTRADEg0KCUFaVVJFX0lBTRAEIlUKDkNsb3VkU1FMSVBUeXBlEiEKHUNMT1VEX1NRTF9JUF9UWVBFX1VOU1BFQ0lGSUVEEAASCgoGUFVCTElDEAESCwoHUFJJVkFURRACEgcKA1BTQxADIlIKCVJlZGlzVHlwZRIaChZSRURJU19UWVBFX1VOU1BFQ0lGSUVEEAASDgoKU1RBTkRBTE9ORRABEgwKCFNFTlRJTkVMEAISCwoHQ0xVU1RFUhADQg8KDWlhbV9leHRlbnNpb25KBAgjECRKBAgyEDgi3gEKEEluc3RhbmNlUmVzb3VyY2USDQoFdGl0bGUYASABKAkSIwoGZW5naW5lGAIgASgOMhMuYnl0ZWJhc2UudjEuRW5naW5lEhsKDmVuZ2luZV92ZXJzaW9uGAMgASgJQgPgQQMSLQoMZGF0YV9zb3VyY2VzGAQgAygLMhcuYnl0ZWJhc2UudjEuRGF0YVNvdXJjZRISCgphY3RpdmF0aW9uGAUgASgIEgwKBG5hbWUYBiABKAkSGAoLZW52aXJvbm1lbnQYByABKAlIAIgBAUIOCgxfZW52aXJvbm1lbnQiTAoKU0FTTENvbmZpZxIxCgprcmJfY29uZmlnGAEgASgLMhsuYnl0ZWJhc2UudjEuS2VyYmVyb3NDb25maWdIAEILCgltZWNoYW5pc20imwEKDktlcmJlcm9zQ29uZmlnEg8KB3ByaW1hcnkYASABKAkSEAoIaW5zdGFuY2UYAiABKAkSDQoFcmVhbG0YAyABKAkSEwoGa2V5dGFiGAQgASgMQgPgQQQSEAoIa2RjX2hvc3QYBSABKAkSEAoIa2RjX3BvcnQYBiABKAkSHgoWa2RjX3RyYW5zcG9ydF9wcm90b2NvbBgHIAEoCSpHCg5EYXRhU291cmNlVHlwZRIbChdEQVRBX1NPVVJDRV9VTlNQRUNJRklFRBAAEgkKBUFETUlOEAESDQoJUkVBRF9PTkxZEAIy1hUKD0luc3RhbmNlU2VydmljZRKpAQoLR2V0SW5zdGFuY2USHy5ieXRlYmFzZS52MS5HZXRJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSJi2kEEbmFtZYrqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCPVojEiEvdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn0SFi92MS97bmFtZT1pbnN0YW5jZXMvKn0SrgEKDUxpc3RJbnN0YW5jZXMSIS5ieXRlYmFzZS52MS5MaXN0SW5zdGFuY2VzUmVxdWVzdBoiLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZXNSZXNwb25zZSJW2kEAiuowEWJiLmluc3RhbmNlcy5saXN0kOowAYLT5JMCNFojEiEvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9pbnN0YW5jZXMSDS92MS9pbnN0YW5jZXMSxQEKDkNyZWF0ZUluc3RhbmNlEiIuYnl0ZWJhc2UudjEuQ3JlYXRlSW5zdGFuY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UieNpBCGluc3RhbmNliuowE2JiLmluc3RhbmNlcy5jcmVhdGWQ6jABmOowAYLT5JMCSDoIaW5zdGFuY2VaLToIaW5zdGFuY2UiIS92MS97cGFyZW50PXByb2plY3RzLyp9L2luc3RhbmNlcyINL3YxL2luc3RhbmNlcxLtAQoOVXBkYXRlSW5zdGFuY2USIi5ieXRlYmFzZS52MS5VcGRhdGVJbnN0YW5jZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSKfAdpBFGluc3RhbmNlLHVwZGF0ZV9tYXNriuowE2JiLmluc3RhbmNlcy51cGRhdGWQ6jABmOowAYLT5JMCYzoIaW5zdGFuY2VaNjoIaW5zdGFuY2UyKi92MS97aW5zdGFuY2UubmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfTIfL3YxL3tpbnN0YW5jZS5uYW1lPWluc3RhbmNlcy8qfRK3AQoORGVsZXRlSW5zdGFuY2USIi5ieXRlYmFzZS52MS5EZWxldGVJbnN0YW5jZVJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiadpBBG5hbWWK6jATYmIuaW5zdGFuY2VzLmRlbGV0ZZDqMAGY6jABgtPkkwI9WiMqIS92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfSoWL3YxL3tuYW1lPWluc3RhbmNlcy8qfRLNAQoQVW5kZWxldGVJbnN0YW5jZRIkLmJ5dGViYXNlLnYxLlVuZGVsZXRlSW5zdGFuY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UifIrqMBViYi5pbnN0YW5jZXMudW5kZWxldGWQ6jABmOowAYLT5JMCVToBKlovOgEqIiovdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn06dW5kZWxldGUiHy92MS97bmFtZT1pbnN0YW5jZXMvKn06dW5kZWxldGUSwQEKDFN5bmNJbnN0YW5jZRIgLmJ5dGViYXNlLnYxLlN5bmNJbnN0YW5jZVJlcXVlc3QaIS5ieXRlYmFzZS52MS5TeW5jSW5zdGFuY2VSZXNwb25zZSJsiuowEWJiLmluc3RhbmNlcy5zeW5jkOowAYLT5JMCTToBKlorOgEqIiYvdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn06c3luYyIbL3YxL3tuYW1lPWluc3RhbmNlcy8qfTpzeW5jEuIBChRMaXN0SW5zdGFuY2VEYXRhYmFzZRIoLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVxdWVzdBopLmJ5dGViYXNlLnYxLkxpc3RJbnN0YW5jZURhdGFiYXNlUmVzcG9uc2UidYrqMBBiYi5pbnN0YW5jZXMuZ2V0kOowAYLT5JMCVzoBKlowOgEqIisvdjEve25hbWU9cHJvamVjdHMvKi9pbnN0YW5jZXMvKn06ZGF0YWJhc2VzIiAvdjEve25hbWU9aW5zdGFuY2VzLyp9OmRhdGFiYXNlcxLUAQoSQmF0Y2hTeW5jSW5zdGFuY2VzEiYuYnl0ZWJhc2UudjEuQmF0Y2hTeW5jSW5zdGFuY2VzUmVxdWVzdBonLmJ5dGViYXNlLnYxLkJhdGNoU3luY0luc3RhbmNlc1Jlc3BvbnNlIm2K6jARYmIuaW5zdGFuY2VzLnN5bmOQ6jABgtPkkwJOOgEqWjA6ASoiKy92MS97cGFyZW50PXByb2plY3RzLyp9L2luc3RhbmNlczpiYXRjaFN5bmMiFy92MS9pbnN0YW5jZXM6YmF0Y2hTeW5jEuQBChRCYXRjaFVwZGF0ZUluc3RhbmNlcxIoLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlSW5zdGFuY2VzUmVxdWVzdBopLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlSW5zdGFuY2VzUmVzcG9uc2Uid4rqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAlI6ASpaMjoBKiItL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vaW5zdGFuY2VzOmJhdGNoVXBkYXRlIhkvdjEvaW5zdGFuY2VzOmJhdGNoVXBkYXRlEtABCg1BZGREYXRhU291cmNlEiEuYnl0ZWJhc2UudjEuQWRkRGF0YVNvdXJjZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5JbnN0YW5jZSKEAYrqMBNiYi5pbnN0YW5jZXMudXBkYXRlkOowAZjqMAGC0+STAl86ASpaNDoBKiIvL3YxL3tuYW1lPXByb2plY3RzLyovaW5zdGFuY2VzLyp9OmFkZERhdGFTb3VyY2UiJC92MS97bmFtZT1pbnN0YW5jZXMvKn06YWRkRGF0YVNvdXJjZRLcAQoQUmVtb3ZlRGF0YVNvdXJjZRIkLmJ5dGViYXNlLnYxLlJlbW92ZURhdGFTb3VyY2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuSW5zdGFuY2UiigGK6jATYmIuaW5zdGFuY2VzLnVwZGF0ZZDqMAGY6jABgtPkkwJlOgEqWjc6ASoiMi92MS97bmFtZT1wcm9qZWN0cy8qL2luc3RhbmNlcy8qfTpyZW1vdmVEYXRhU291cmNlIicvdjEve25hbWU9aW5zdGFuY2VzLyp9OnJlbW92ZURhdGFTb3VyY2USigIKEFVwZGF0ZURhdGFTb3VyY2USJC5ieXRlYmFzZS52MS5VcGRhdGVEYXRhU291cmNlUmVxdWVzdBoVLmJ5dGViYXNlLnYxLkluc3RhbmNlIrgB2kEXZGF0YV9zb3VyY2UsdXBkYXRlX21hc2uK6jATYmIuaW5zdGFuY2VzLnVwZGF0ZZDqMAGY6jABgtPkkwJ5OgtkYXRhX3NvdXJjZVpBOgtkYXRhX3NvdXJjZTIyL3YxL3tuYW1lPXByb2plY3RzLyovaW5zdGFuY2VzLyp9OnVwZGF0ZURhdGFTb3VyY2UyJy92MS97bmFtZT1pbnN0YW5jZXMvKn06dXBkYXRlRGF0YVNvdXJjZUKqAQoPY29tLmJ5dGViYXNlLnYxQhRJbnN0YW5jZVNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_role_service]);
/**
* Describes the message bytebase.v1.GetInstanceRequest.
diff --git a/frontend/src/types/v1/instance.test.ts b/frontend/src/types/v1/instance.test.ts
new file mode 100644
index 0000000000..861550611d
--- /dev/null
+++ b/frontend/src/types/v1/instance.test.ts
@@ -0,0 +1,17 @@
+import { describe, expect, test } from "vitest";
+import { isValidInstanceName, UNKNOWN_INSTANCE_NAME } from "./instance";
+
+describe("isValidInstanceName", () => {
+ test("accepts workspace and project instance resource names", () => {
+ expect(isValidInstanceName("instances/prod")).toBe(true);
+ expect(isValidInstanceName("projects/app/instances/prod")).toBe(true);
+ });
+
+ test("rejects malformed, descendant, and unknown resource names", () => {
+ expect(isValidInstanceName("projects/app/instances/")).toBe(false);
+ expect(
+ isValidInstanceName("projects/app/instances/prod/databases/main")
+ ).toBe(false);
+ expect(isValidInstanceName(UNKNOWN_INSTANCE_NAME)).toBe(false);
+ });
+});
diff --git a/frontend/src/types/v1/instance.ts b/frontend/src/types/v1/instance.ts
index b8c1bb27ab..df5ab95759 100644
--- a/frontend/src/types/v1/instance.ts
+++ b/frontend/src/types/v1/instance.ts
@@ -11,6 +11,8 @@ import {
} from "../proto-es/v1/instance_service_pb";
export const UNKNOWN_INSTANCE_NAME = `instances/${UNKNOWN_ID}`;
+const INSTANCE_NAME_PATTERN =
+ /^(?:instances|projects\/[^/]+\/instances)\/[^/]+$/;
export const unknownInstance = (): Instance => {
return create(InstanceSchema, {
@@ -31,7 +33,7 @@ export const unknownInstanceResource = (): InstanceResource => {
export const isValidInstanceName = (name: unknown): name is string => {
return (
typeof name === "string" &&
- name.startsWith("instances/") &&
+ INSTANCE_NAME_PATTERN.test(name) &&
name !== UNKNOWN_INSTANCE_NAME
);
};
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 664e961991..815ca2f8f7 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -1820,14 +1820,6 @@ paths:
schema:
type: boolean
title: validate_only
- - name: initialDatabaseProject
- in: query
- description: |-
- The project to assign newly discovered databases to during initial sync.
- Format: projects/{project}. This must be unset when `parent` is set.
- schema:
- type: string
- title: initial_database_project
requestBody:
description: The instance to create.
content:
@@ -6882,14 +6874,6 @@ paths:
schema:
type: boolean
title: validate_only
- - name: initialDatabaseProject
- in: query
- description: |-
- The project to assign newly discovered databases to during initial sync.
- Format: projects/{project}. This must be unset when `parent` is set.
- schema:
- type: string
- title: initial_database_project
requestBody:
description: The instance to create.
content:
@@ -20951,12 +20935,6 @@ components:
type: boolean
title: validate_only
description: Validate only also tests the data source connection.
- initialDatabaseProject:
- type: string
- title: initial_database_project
- description: |-
- The project to assign newly discovered databases to during initial sync.
- Format: projects/{project}. This must be unset when `parent` is set.
title: CreateInstanceRequest
required:
- instance
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index dbfa95e845..bd297b5525 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -6570,7 +6570,6 @@ InstanceRoleService manages database roles within instances.
This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
-| initial_database_project | [string](#string) | | The project to assign newly discovered databases to during initial sync. Format: projects/{project}. This must be unset when `parent` is set. |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 21bca5da6c..dc1563d11a 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -18449,14 +18449,6 @@ are /[a-z][0-9]-/. </p></td>
<td><p>Validate only also tests the data source connection. </p></td>
</tr>
- <tr>
- <td>initial_database_project</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The project to assign newly discovered databases to during initial sync.
-Format: projects/{project}. This must be unset when `parent` is set. </p></td>
- </tr>
-
</tbody>
</table>
diff --git a/proto/v1/v1/instance_service.proto b/proto/v1/v1/instance_service.proto
index d9df5f7428..7615f37b53 100644
--- a/proto/v1/v1/instance_service.proto
+++ b/proto/v1/v1/instance_service.proto
@@ -309,6 +309,9 @@ message ListInstancesResponse {
}
message CreateInstanceRequest {
+ reserved 4;
+ reserved "initial_database_project";
+
// The parent, which owns this collection of instances.
// Format: projects/{project}. If omitted, the instance is created in the
// workspace collection.
@@ -326,10 +329,6 @@ message CreateInstanceRequest {
// Validate only also tests the data source connection.
bool validate_only = 3;
-
- // The project to assign newly discovered databases to during initial sync.
- // Format: projects/{project}. This must be unset when `parent` is set.
- string initial_database_project = 4;
}
message UpdateInstanceRequest {