Skip to content

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

fix: prevent instance database selection flicker (#21413)

p0ny084953f20ff6
diff --git a/frontend/src/components/instance/InstanceFormBody.test.ts b/frontend/src/components/instance/InstanceFormBody.test.ts
index 42df9d7f56..b4012d05ab 100644
--- a/frontend/src/components/instance/InstanceFormBody.test.ts
+++ b/frontend/src/components/instance/InstanceFormBody.test.ts
@@ -231,17 +231,6 @@ describe("InstanceFormBody", () => {
);
});
- test("refetches database previews when pending create instance changes", () => {
- const source = readFileSync(
- join(process.cwd(), "src/components/instance/InstanceFormBody.tsx"),
- "utf-8"
- );
-
- expect(source).toContain(
- "}, [syncAll, isCreatingProp, pendingCreateInstance, instance]);"
- );
- });
-
test("distinguishes sync-all from empty selected database list", () => {
const source = readFileSync(
join(process.cwd(), "src/components/instance/InstanceFormBody.tsx"),
diff --git a/frontend/src/components/instance/InstanceFormBody.tsx b/frontend/src/components/instance/InstanceFormBody.tsx
index 8debf020f2..24649c00b2 100644
--- a/frontend/src/components/instance/InstanceFormBody.tsx
+++ b/frontend/src/components/instance/InstanceFormBody.tsx
@@ -477,7 +477,7 @@ function ScanIntervalInput({
const MAX_VISIBLE_DATABASES = 100;
-function SyncDatabases({
+export function SyncDatabases({
isCreating: isCreatingProp,
showLabel,
allowEdit,
@@ -530,11 +530,15 @@ function SyncDatabases({
onSyncDatabasesChangeRef.current(syncAll ? [] : [...selectedSet], syncAll);
}, [syncAll, selectedSet]);
+ const databaseListInstance = isCreatingProp
+ ? pendingCreateInstance
+ : instance;
+
useEffect(() => {
if (syncAll) return;
let cancelled = false;
const fetchDatabases = async () => {
- const inst = isCreatingProp ? pendingCreateInstance : instance;
+ const inst = databaseListInstance;
if (!inst) return;
setLoading(true);
try {
@@ -552,7 +556,7 @@ function SyncDatabases({
return () => {
cancelled = true;
};
- }, [syncAll, isCreatingProp, pendingCreateInstance, instance]);
+ }, [syncAll, isCreatingProp, databaseListInstance]);
useEffect(() => {
setVisibleDatabaseCount(MAX_VISIBLE_DATABASES);
diff --git a/frontend/src/components/instance/InstanceFormContext.test.tsx b/frontend/src/components/instance/InstanceFormContext.test.tsx
index 0757eda105..f1ffc03aa2 100644
--- a/frontend/src/components/instance/InstanceFormContext.test.tsx
+++ b/frontend/src/components/instance/InstanceFormContext.test.tsx
@@ -12,6 +12,7 @@ import {
DataSourceSchema,
DataSourceType,
InstanceSchema,
+ SyncDatabasesSchema,
} 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";
@@ -28,8 +29,30 @@ const mocks = vi.hoisted(() => ({
pushNotification: vi.fn(),
createInstance: vi.fn(),
isSaaSMode: false,
+ listInstanceDatabases: vi.fn(async () => ({
+ databases: ["app", "analytics"],
+ })),
}));
+vi.mock("@/components/EngineIcon", () => ({ EngineIcon: () => null }));
+vi.mock("@/components/EnvironmentSelect", () => ({
+ EnvironmentSelect: () => null,
+}));
+vi.mock("@/components/FeatureBadge", () => ({ FeatureBadge: () => null }));
+vi.mock("@/components/LabelListEditor", () => ({
+ LabelListEditor: () => null,
+}));
+vi.mock("@/components/LearnMoreLink", () => ({ LearnMoreLink: () => null }));
+vi.mock("@/components/ResourceIdField", () => ({
+ ResourceIdField: () => null,
+}));
+vi.mock("@/components/RouterLink", () => ({ RouterLink: () => null }));
+vi.mock("./DataSourceForm", () => ({
+ DataSourceForm: () => null,
+ RedisSentinelFields: () => null,
+}));
+vi.mock("./DataSourceSection", () => ({ DataSourceSection: () => null }));
+
vi.mock("./permission", () => ({
hasInstancePermission: mocks.hasInstancePermission,
}));
@@ -54,6 +77,7 @@ vi.mock(
);
vi.mock("@/types", () => ({
+ DATASOURCE_ADMIN_USER_NAME: "bytebase",
UNKNOWN_INSTANCE_NAME: "instances/-",
unknownDataSource: () => ({
id: "admin",
@@ -78,6 +102,7 @@ vi.mock("@/stores/app", () => {
const appState = () => ({
createDataSource: vi.fn(),
createInstance: mocks.createInstance,
+ listInstanceDatabases: mocks.listInstanceDatabases,
updateDataSource: vi.fn(),
getEnvironmentByName: (name: string) => ({ name }),
hasInstanceFeature: () => false,
@@ -229,6 +254,159 @@ describe("InstanceFormProvider", () => {
vi.useRealTimers();
});
+ test.each([0, 1])(
+ "keeps the database list mounted when toggling database %i",
+ async (index) => {
+ const { SyncDatabases } = await import("./InstanceFormBody");
+ const Selector = () => {
+ const { basicInfo, setBasicInfo } = useInstanceFormContext();
+ return (
+ <SyncDatabases
+ isCreating={false}
+ showLabel={false}
+ allowEdit
+ syncDatabases={basicInfo.syncDatabases}
+ onSyncDatabasesChange={(databases, syncAll) => {
+ setBasicInfo((prev) => ({
+ ...prev,
+ syncDatabases: syncAll
+ ? undefined
+ : create(SyncDatabasesSchema, { databases }),
+ }));
+ }}
+ />
+ );
+ };
+ vi.useFakeTimers();
+ const harness = renderIntoContainer();
+ try {
+ await harness.render(
+ <InstanceFormProvider
+ instance={create(InstanceSchema, {
+ name: "instances/prod",
+ engine: Engine.POSTGRES,
+ syncDatabases: { databases: ["app"] },
+ })}
+ >
+ <Probe />
+ <Selector />
+ </InstanceFormProvider>
+ );
+ await act(async () => {
+ await vi.advanceTimersByTimeAsync(300);
+ });
+ const checkbox =
+ harness.container.querySelectorAll<HTMLElement>('[role="checkbox"]')[
+ index
+ ];
+ expect(checkbox).toBeDefined();
+ mocks.listInstanceDatabases.mockClear();
+ mocks.listInstanceDatabases.mockImplementation(
+ () => new Promise(() => {})
+ );
+ await act(async () => {
+ checkbox.click();
+ });
+ await act(async () => {
+ await vi.advanceTimersByTimeAsync(300);
+ });
+
+ expect(harness.container.contains(checkbox)).toBe(true);
+ expect(harness.container.textContent).not.toContain("common.loading");
+ expect(mocks.listInstanceDatabases).not.toHaveBeenCalled();
+ expect(
+ harness.container.firstElementChild?.getAttribute(
+ "data-value-changed"
+ )
+ ).toBe("true");
+
+ await act(async () => {
+ checkbox.click();
+ });
+ await act(async () => {
+ await vi.advanceTimersByTimeAsync(300);
+ });
+ expect(harness.container.contains(checkbox)).toBe(true);
+ expect(mocks.listInstanceDatabases).not.toHaveBeenCalled();
+ expect(
+ harness.container.firstElementChild?.getAttribute(
+ "data-value-changed"
+ )
+ ).toBe("false");
+ } finally {
+ harness.unmount();
+ vi.useRealTimers();
+ mocks.listInstanceDatabases.mockResolvedValue({
+ databases: ["app", "analytics"],
+ });
+ }
+ }
+ );
+
+ test("refreshes database previews when the create connection changes", async () => {
+ const { SyncDatabases } = await import("./InstanceFormBody");
+ const CreateSelector = () => {
+ const { setDataSourceEditState } = useInstanceFormContext();
+ return (
+ <>
+ <button
+ type="button"
+ data-testid="change-host"
+ onClick={() => {
+ setDataSourceEditState((prev) => ({
+ ...prev,
+ dataSources: prev.dataSources.map((ds) => ({
+ ...ds,
+ host: "new-host",
+ })),
+ }));
+ }}
+ >
+ Change host
+ </button>
+ <SyncDatabases
+ isCreating
+ showLabel={false}
+ allowEdit
+ syncDatabases={create(SyncDatabasesSchema, {})}
+ onSyncDatabasesChange={() => {}}
+ />
+ </>
+ );
+ };
+ vi.useFakeTimers();
+ const harness = renderIntoContainer();
+ try {
+ await harness.render(
+ <InstanceFormProvider>
+ <CreateSelector />
+ </InstanceFormProvider>
+ );
+ await act(async () => {
+ await vi.advanceTimersByTimeAsync(300);
+ });
+ mocks.listInstanceDatabases.mockClear();
+ await act(async () => {
+ harness.container
+ .querySelector<HTMLButtonElement>('[data-testid="change-host"]')
+ ?.click();
+ });
+ await act(async () => {
+ await vi.advanceTimersByTimeAsync(300);
+ });
+ expect(mocks.listInstanceDatabases).toHaveBeenCalledTimes(1);
+ expect(mocks.listInstanceDatabases).toHaveBeenCalledWith(
+ expect.any(String),
+ expect.objectContaining({
+ dataSources: [expect.objectContaining({ host: "new-host" })],
+ })
+ );
+ } finally {
+ harness.unmount();
+ vi.useRealTimers();
+ }
+ });
+
test("uses project ownership for create names and permissions", async () => {
const project = create(ProjectSchema, { name: "projects/app" });
const harness = renderIntoContainer();