Skip to content

refactor(storage): remove legacy storage key after migration #3037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
afonsojramos wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −31
Open

refactor(storage): remove legacy storage key after migration #3037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions src/renderer/utils/core/storage.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ describe('renderer/utils/core/storage.ts', () => {
expect(localStorage.getItem(Constants.STORAGE.LEGACY)).toBeNull();
});

it('migrates legacy auth and settings into the stores and marks the key as migrated', () => {
it('migrates legacy auth and settings into the stores and removes the legacy key', () => {
localStorage.setItem(
Constants.STORAGE.LEGACY,
JSON.stringify({
Expand All @@ -36,9 +36,7 @@ describe('renderer/utils/core/storage.ts', () => {
expect(useSettingsStore.getState().theme).toBe(Theme.DARK);
expect(useSettingsStore.getState().playSound).toBe(false);

const marker = JSON.parse(localStorage.getItem(Constants.STORAGE.LEGACY)!);
expect(marker.migrated).toBe(true);
expect(marker.migratedAt).toBeDefined();
expect(localStorage.getItem(Constants.STORAGE.LEGACY)).toBeNull();
});

it('drops legacy accounts with invalid hostnames during migration', () => {
Expand Down Expand Up @@ -68,17 +66,13 @@ describe('renderer/utils/core/storage.ts', () => {
expect(useAccountsStore.getState().accounts).toHaveLength(1);
});

it('skips migration when already migrated', () => {
localStorage.setItem(
Constants.STORAGE.LEGACY,
JSON.stringify({ migrated: true, migratedAt: '2026-01-01T00:00:00Z' }),
);
it('removes a legacy key with no migratable data', () => {
localStorage.setItem(Constants.STORAGE.LEGACY, JSON.stringify({}));

migrateLegacyStoreToZustand();

expect(useAccountsStore.getState().accounts).toEqual([]);
const marker = JSON.parse(localStorage.getItem(Constants.STORAGE.LEGACY)!);
expect(marker.migratedAt).toBe('2026-01-01T00:00:00Z');
expect(localStorage.getItem(Constants.STORAGE.LEGACY)).toBeNull();
});

it('logs an error and leaves stores untouched on malformed legacy data', () => {
Expand Down
23 changes: 3 additions & 20 deletions src/renderer/utils/core/storage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,7 @@ export function migrateLegacyStoreToZustand() {
}

try {
const parsed = JSON.parse(existing);

// Skip if already migrated
if (parsed.migrated) {
rendererLogInfo(
'migrateLegacyStoreToZustand',
`Storage already migrated on ${parsed.migratedAt}`,
);
return;
}

const { auth, settings } = parsed;
const { auth, settings } = JSON.parse(existing);

// Migrate auth to AccountsStore if it exists and store is empty
if (auth?.accounts && useAccountsStore.getState().accounts.length === 0) {
Expand All @@ -49,14 +38,8 @@ export function migrateLegacyStoreToZustand() {
useSettingsStore.setState(knownSettings);
}

// Mark old storage key as migrated instead of removing it
localStorage.setItem(
Constants.STORAGE.LEGACY,
JSON.stringify({
migrated: true,
migratedAt: new Date().toISOString(),
}),
);
// Remove the legacy key so subsequent launches skip migration entirely
localStorage.removeItem(Constants.STORAGE.LEGACY);

rendererLogInfo(
'migrateLegacyStoreToZustand',
Expand Down