Skip to content

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

fix: select sync databases during instance creation (#20850)

ecmadao5903d9ed368a
diff --git a/backend/api/v1/acl.go b/backend/api/v1/acl.go
index 3672ae1c7a..ca6c81a143 100644
--- a/backend/api/v1/acl.go
+++ b/backend/api/v1/acl.go
@@ -132,6 +132,7 @@ func (in *ACLInterceptor) doACLCheck(ctx context.Context, request any, fullMetho
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to populate raw resources %s", err))
}
authContext.Resources = resources
+ authContext.Permission = getPermissionForRequest(request, authContext.Permission)
if auth.IsAuthenticationSkipped(fullMethod, authContext) {
return nil
@@ -224,6 +225,13 @@ func (in *ACLInterceptor) doACLCheck(ctx context.Context, request any, fullMetho
return nil
}
+func getPermissionForRequest(request any, defaultPermission permission.Permission) permission.Permission {
+ if r, ok := request.(*v1pb.ListInstanceDatabaseRequest); ok && r.GetInstance() != nil {
+ return permission.InstancesCreate
+ }
+ return defaultPermission
+}
+
func hasPath(fieldMask *fieldmaskpb.FieldMask, want string) bool {
if fieldMask == nil {
return false
@@ -423,6 +431,14 @@ func getResourceFromRequest(ctx context.Context, request any, method string) ([]
var resources []string
+ if r, ok := request.(*v1pb.ListInstanceDatabaseRequest); ok && r.GetInstance() != nil {
+ // During instance creation, the request carries an inline instance so
+ // the handler can preview remote databases before the instance exists.
+ // Use the workspace resource instead of validating the future instance name.
+ resources = append(resources, "")
+ return resources, nil
+ }
+
// Transferring database projects needs to check both projects.
var updateDatabaseRequests []*v1pb.UpdateDatabaseRequest
switch r := request.(type) {
diff --git a/backend/api/v1/acl_test.go b/backend/api/v1/acl_test.go
index 3ec3da743d..0a85332fcb 100644
--- a/backend/api/v1/acl_test.go
+++ b/backend/api/v1/acl_test.go
@@ -7,6 +7,7 @@ import (
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/types/known/fieldmaskpb"
+ "github.com/bytebase/bytebase/backend/common/permission"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
)
@@ -128,6 +129,21 @@ func TestGetResourceFromRequest(t *testing.T) {
method: "/bytebase.v1.InstanceService/SyncInstance",
want: []string{"instances/hello"},
},
+ {
+ request: &v1pb.ListInstanceDatabaseRequest{
+ Name: "instances/hello",
+ },
+ method: "/bytebase.v1.InstanceService/ListInstanceDatabase",
+ want: []string{"instances/hello"},
+ },
+ {
+ request: &v1pb.ListInstanceDatabaseRequest{
+ Name: "instances/hello",
+ Instance: &v1pb.Instance{},
+ },
+ method: "/bytebase.v1.InstanceService/ListInstanceDatabase",
+ want: []string{""},
+ },
{
request: &v1pb.BatchSyncInstancesRequest{
Requests: []*v1pb.SyncInstanceRequest{
@@ -182,6 +198,46 @@ func TestToSnakeCase(t *testing.T) {
}
}
+func TestGetPermissionForRequest(t *testing.T) {
+ tests := []struct {
+ name string
+ request any
+ defaultPermission permission.Permission
+ want permission.Permission
+ }{
+ {
+ name: "keeps default permission for existing instance database listing",
+ request: &v1pb.ListInstanceDatabaseRequest{
+ Name: "instances/hello",
+ },
+ defaultPermission: permission.InstancesGet,
+ want: permission.InstancesGet,
+ },
+ {
+ name: "requires create permission for inline instance database preview",
+ request: &v1pb.ListInstanceDatabaseRequest{
+ Name: "instances/hello",
+ Instance: &v1pb.Instance{},
+ },
+ defaultPermission: permission.InstancesGet,
+ want: permission.InstancesCreate,
+ },
+ {
+ name: "keeps default permission for other requests",
+ request: &v1pb.SyncInstanceRequest{Name: "instances/hello"},
+ defaultPermission: permission.InstancesSync,
+ want: permission.InstancesSync,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ got := getPermissionForRequest(tt.request, tt.defaultPermission)
+ require.Equal(t, tt.want, got)
+ })
+ }
+}
+
func TestHasAllowMissingEnabled(t *testing.T) {
tests := []struct {
name string
diff --git a/backend/api/v1/instance_service.go b/backend/api/v1/instance_service.go
index 419901649a..ccea23093b 100644
--- a/backend/api/v1/instance_service.go
+++ b/backend/api/v1/instance_service.go
@@ -132,6 +132,7 @@ func (s *InstanceService) ListInstanceDatabase(ctx context.Context, req *connect
if instanceMessage, err = convertToStoreInstance(instanceID, req.Msg.Instance); err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ instanceMessage.Workspace = common.GetWorkspaceIDFromContext(ctx)
} else {
instance, err := getInstanceMessage(ctx, s.store, req.Msg.Name)
if err != nil {
diff --git a/frontend/src/react/components/instance/InstanceFormBody.test.ts b/frontend/src/react/components/instance/InstanceFormBody.test.ts
index f11949c7ae..4145a64a3e 100644
--- a/frontend/src/react/components/instance/InstanceFormBody.test.ts
+++ b/frontend/src/react/components/instance/InstanceFormBody.test.ts
@@ -22,4 +22,32 @@ describe("InstanceFormBody", () => {
"inert={isConnectionOptionsCollapsed ? true : undefined}"
);
});
+
+ test("renders database sync controls inside the connection card", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/react/components/instance/InstanceFormBody.tsx"),
+ "utf-8"
+ );
+
+ const connectionCardIndex = source.indexOf("{/* Connection Card */}");
+ const syncDatabasesIndex = source.indexOf("{/* Sync Databases */}");
+ const connectionOptionsIndex = source.indexOf(
+ "{/* Connection Options Card */}"
+ );
+
+ expect(connectionCardIndex).toBeGreaterThanOrEqual(0);
+ expect(syncDatabasesIndex).toBeGreaterThan(connectionCardIndex);
+ expect(syncDatabasesIndex).toBeLessThan(connectionOptionsIndex);
+ });
+
+ test("refetches database previews when pending create instance changes", () => {
+ const source = readFileSync(
+ join(process.cwd(), "src/react/components/instance/InstanceFormBody.tsx"),
+ "utf-8"
+ );
+
+ expect(source).toContain(
+ "}, [syncAll, isCreatingProp, pendingCreateInstance, instance]);"
+ );
+ });
});
diff --git a/frontend/src/react/components/instance/InstanceFormBody.tsx b/frontend/src/react/components/instance/InstanceFormBody.tsx
index 76361b119d..47198d9df8 100644
--- a/frontend/src/react/components/instance/InstanceFormBody.tsx
+++ b/frontend/src/react/components/instance/InstanceFormBody.tsx
@@ -459,7 +459,7 @@ function SyncDatabases({
return () => {
cancelled = true;
};
- }, [syncAll]);
+ }, [syncAll, isCreatingProp, pendingCreateInstance, instance]);
if (hideAdvancedFeatures) return null;
@@ -1287,17 +1287,6 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
onScanIntervalChange={changeScanInterval}
/>
)}
-
- {/* Sync Databases */}
- {basicInfo.engine !== Engine.DYNAMODB && (
- <SyncDatabases
- isCreating={isCreating}
- showLabel={!isCreating}
- allowEdit={isCreating ? allowEdit && !!allowCreate : allowEdit}
- syncDatabases={basicInfo.syncDatabases}
- onSyncDatabasesChange={handleChangeSyncDatabases}
- />
- )}
</div>
</div>
@@ -1602,6 +1591,19 @@ export function InstanceFormBody({ onOpenInfoPanel }: InstanceFormBodyProps) {
)}
</>
)}
+
+ {/* Sync Databases */}
+ {basicInfo.engine !== Engine.DYNAMODB && (
+ <div className="mt-6 grid grid-cols-1 gap-y-6 gap-x-4 sm:grid-cols-4">
+ <SyncDatabases
+ isCreating={isCreating}
+ showLabel={!isCreating}
+ allowEdit={isCreating ? allowEdit && !!allowCreate : allowEdit}
+ syncDatabases={basicInfo.syncDatabases}
+ onSyncDatabasesChange={handleChangeSyncDatabases}
+ />
+ </div>
+ )}
</div>
{/* Connection Options Card */}