Skip to content

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

fix: migrate user-scoped localStorage keys when email changes (#19244)

boojack2fb3e538a503
diff --git a/frontend/src/utils/migrate-user-storage.test.ts b/frontend/src/utils/migrate-user-storage.test.ts
new file mode 100644
index 0000000000..71d9ff16e2
--- /dev/null
+++ b/frontend/src/utils/migrate-user-storage.test.ts
@@ -0,0 +1,225 @@
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { migrateUserStorage } from "./storage-migrate";
+
+function createMockStorage(): Storage {
+ let store: Record<string, string> = {};
+ return {
+ get length() {
+ return Object.keys(store).length;
+ },
+ key(index: number) {
+ return Object.keys(store)[index] ?? null;
+ },
+ getItem(key: string) {
+ return store[key] ?? null;
+ },
+ setItem(key: string, value: string) {
+ store[key] = String(value);
+ },
+ removeItem(key: string) {
+ delete store[key];
+ },
+ clear() {
+ store = {};
+ },
+ };
+}
+
+let mockStorage: Storage;
+
+beforeEach(() => {
+ mockStorage = createMockStorage();
+ vi.stubGlobal("localStorage", mockStorage);
+});
+
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
+describe("migrateUserStorage", () => {
+ test("migrates keys ending with old email to new email", () => {
+ localStorage.setItem("[email protected]", '{"visits":[]}');
+ localStorage.setItem("[email protected]", '["link1"]');
+
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"visits":[]}'
+ );
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '["link1"]'
+ );
+ expect(localStorage.getItem("[email protected]")).toBeNull();
+ expect(localStorage.getItem("[email protected]")).toBeNull();
+ });
+
+ test("migrates keys with variable middle segments", () => {
+ localStorage.setItem(
+ "bb.sql-editor.tabs.projects/[email protected]",
+ '[{"id":"tab1"}]'
+ );
+ localStorage.setItem(
+ "bb.sql-editor.conn-expanded.environments/[email protected]",
+ '{"expanded":true}'
+ );
+
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.tabs.projects/[email protected]"
+ )
+ ).toBe('[{"id":"tab1"}]');
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.conn-expanded.environments/[email protected]"
+ )
+ ).toBe('{"expanded":true}');
+ });
+
+ test("does not migrate keys not ending with old email", () => {
+ localStorage.setItem("bb.language", '"en-US"');
+ localStorage.setItem("bb.onboarding", '{"step":1}');
+ localStorage.setItem("[email protected]", '{"x":1}');
+
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(localStorage.getItem("bb.language")).toBe('"en-US"');
+ expect(localStorage.getItem("bb.onboarding")).toBe('{"step":1}');
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"x":1}'
+ );
+ });
+
+ test("overwrites existing keys at new location", () => {
+ localStorage.setItem("[email protected]", '{"old":true}');
+ localStorage.setItem("[email protected]", '{"new":true}');
+
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"old":true}'
+ );
+ });
+
+ test("returns early when oldEmail is empty", () => {
+ localStorage.setItem("[email protected]", '{"x":1}');
+
+ migrateUserStorage("", "[email protected]");
+
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"x":1}'
+ );
+ });
+
+ test("returns early when newEmail is empty", () => {
+ localStorage.setItem("[email protected]", '{"x":1}');
+
+ migrateUserStorage("[email protected]", "");
+
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"x":1}'
+ );
+ });
+
+ test("returns early when emails are the same", () => {
+ localStorage.setItem("[email protected]", '{"x":1}');
+
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(localStorage.getItem("[email protected]")).toBe(
+ '{"x":1}'
+ );
+ });
+
+ test("handles empty localStorage gracefully", () => {
+ migrateUserStorage("[email protected]", "[email protected]");
+
+ expect(localStorage.length).toBe(0);
+ });
+
+ test("migrates all 17 key families", () => {
+ const email = "[email protected]";
+ const newEmail = "[email protected]";
+
+ // Set up all key families
+ localStorage.setItem(`bb.recent-visit.${email}`, "1");
+ localStorage.setItem(`bb.recent-projects.${email}`, "2");
+ localStorage.setItem(`bb.quick-access.${email}`, "3");
+ localStorage.setItem(`bb.last-activity.${email}`, "4");
+ localStorage.setItem(`bb.collapse-state.${email}`, "5");
+ localStorage.setItem(`bb.intro-state.${email}`, "6");
+ localStorage.setItem(`bb.iam-remind.${email}`, "7");
+ localStorage.setItem(`bb.reset-password.${email}`, "8");
+ localStorage.setItem(`bb.search./dashboard.${email}`, "9");
+ localStorage.setItem(`bb.sql-editor.tabs.projects/p1.${email}`, "10");
+ localStorage.setItem(
+ `bb.sql-editor.current-tab.projects/p1.${email}`,
+ "11"
+ );
+ localStorage.setItem(`bb.sql-editor.conn-expanded.env/prod.${email}`, "12");
+ localStorage.setItem(`bb.sql-editor.conn-expanded-keys.${email}`, "13");
+ localStorage.setItem(
+ `bb.sql-editor.worksheet-filter.projects/p1.${email}`,
+ "14"
+ );
+ localStorage.setItem(
+ `bb.sql-editor.worksheet-tree.projects/p1.${email}`,
+ "15"
+ );
+ localStorage.setItem(
+ `bb.sql-editor.worksheet-folder.projects/p1.list.${email}`,
+ "16"
+ );
+ localStorage.setItem(`bb.sql-editor.ai-suggestion.${email}`, "17");
+
+ migrateUserStorage(email, newEmail);
+
+ // Verify all migrated
+ expect(localStorage.getItem(`bb.recent-visit.${newEmail}`)).toBe("1");
+ expect(localStorage.getItem(`bb.recent-projects.${newEmail}`)).toBe("2");
+ expect(localStorage.getItem(`bb.quick-access.${newEmail}`)).toBe("3");
+ expect(localStorage.getItem(`bb.last-activity.${newEmail}`)).toBe("4");
+ expect(localStorage.getItem(`bb.collapse-state.${newEmail}`)).toBe("5");
+ expect(localStorage.getItem(`bb.intro-state.${newEmail}`)).toBe("6");
+ expect(localStorage.getItem(`bb.iam-remind.${newEmail}`)).toBe("7");
+ expect(localStorage.getItem(`bb.reset-password.${newEmail}`)).toBe("8");
+ expect(localStorage.getItem(`bb.search./dashboard.${newEmail}`)).toBe("9");
+ expect(
+ localStorage.getItem(`bb.sql-editor.tabs.projects/p1.${newEmail}`)
+ ).toBe("10");
+ expect(
+ localStorage.getItem(`bb.sql-editor.current-tab.projects/p1.${newEmail}`)
+ ).toBe("11");
+ expect(
+ localStorage.getItem(`bb.sql-editor.conn-expanded.env/prod.${newEmail}`)
+ ).toBe("12");
+ expect(
+ localStorage.getItem(`bb.sql-editor.conn-expanded-keys.${newEmail}`)
+ ).toBe("13");
+ expect(
+ localStorage.getItem(
+ `bb.sql-editor.worksheet-filter.projects/p1.${newEmail}`
+ )
+ ).toBe("14");
+ expect(
+ localStorage.getItem(
+ `bb.sql-editor.worksheet-tree.projects/p1.${newEmail}`
+ )
+ ).toBe("15");
+ expect(
+ localStorage.getItem(
+ `bb.sql-editor.worksheet-folder.projects/p1.list.${newEmail}`
+ )
+ ).toBe("16");
+ expect(
+ localStorage.getItem(`bb.sql-editor.ai-suggestion.${newEmail}`)
+ ).toBe("17");
+
+ // Verify old keys removed
+ expect(localStorage.getItem(`bb.recent-visit.${email}`)).toBeNull();
+ expect(
+ localStorage.getItem(`bb.sql-editor.tabs.projects/p1.${email}`)
+ ).toBeNull();
+ });
+});
diff --git a/frontend/src/utils/storage-migrate.ts b/frontend/src/utils/storage-migrate.ts
index a400e47575..a7c27032c1 100644
--- a/frontend/src/utils/storage-migrate.ts
+++ b/frontend/src/utils/storage-migrate.ts
@@ -185,3 +185,30 @@ export function migrateStorageKeys() {
localStorage.setItem(MIGRATION_MARKER, "1");
}
+
+/**
+ * Migrate user-scoped localStorage keys when email changes.
+ * Renames all keys ending with `.{oldEmail}` to end with `.{newEmail}`.
+ */
+export function migrateUserStorage(oldEmail: string, newEmail: string) {
+ if (!oldEmail || !newEmail || oldEmail === newEmail) return;
+
+ const suffix = `.${oldEmail}`;
+ const keysToMigrate: string[] = [];
+
+ for (let i = 0; i < localStorage.length; i++) {
+ const key = localStorage.key(i);
+ if (key?.endsWith(suffix)) {
+ keysToMigrate.push(key);
+ }
+ }
+
+ for (const key of keysToMigrate) {
+ const newKey = key.slice(0, -suffix.length) + `.${newEmail}`;
+ const value = localStorage.getItem(key);
+ if (value !== null) {
+ localStorage.setItem(newKey, value);
+ localStorage.removeItem(key);
+ }
+ }
+}
diff --git a/frontend/src/views/ProfileDashboard.vue b/frontend/src/views/ProfileDashboard.vue
index d65af1ed16..b9a8fa1524 100644
--- a/frontend/src/views/ProfileDashboard.vue
+++ b/frontend/src/views/ProfileDashboard.vue
@@ -265,6 +265,7 @@ import {
UserType,
} from "@/types/proto-es/v1/user_service_pb";
import { displayRoleTitle, hasWorkspacePermissionV2, sortRoles } from "@/utils";
+import { migrateUserStorage } from "@/utils/storage-migrate";
interface LocalState {
editing: boolean;
@@ -429,7 +430,9 @@ const saveEdit = async () => {
try {
// Update email using dedicated UpdateEmail API if changed
if (emailChanged) {
- await userStore.updateEmail(user.value.email, userPatch.email);
+ const oldEmail = user.value.email;
+ await userStore.updateEmail(oldEmail, userPatch.email);
+ migrateUserStorage(oldEmail, userPatch.email);
}
// Update other fields using UpdateUser API if any changed