Files
openchamber/packages/ui/src/lib/filesViewShowGitignored.ts
T
Tom RochetteandBohdan Triapitsyn 1505274f94 perf(stores): defer safeStorage writes off the interaction path (#1941)
* perf(stores): defer safeStorage writes off the interaction path

Session switches funnel every persisted store slice through safeStorage.setItem,
and doing those large JSON.stringify writes synchronously blocked the main
thread for over a second. Add a write-behind buffer that:

- Defers each setItem/removeItem to a later task via setTimeout(0) so the
  click-to-paint path is not blocked.
- Coalesces repeated writes to the same key into a single backing flush.
- Serves pending values from memory so read-after-write stays consistent
  within the deferral window.
- Flushes synchronously on pagehide/beforeunload/visibilitychange/freeze so
  deferred state survives tab close, reload, and the mobile freeze lifecycle.

Adds a test covering write deferral, coalescing, and pending read serving.

* fix(stores): defer persisted JSON serialization

* fix(stores): defer direct safeStorage writes

---------

Co-authored-by: Bohdan Triapitsyn <artmore@protonmail.com>
2026-06-30 11:47:52 +03:00

68 lines
1.8 KiB
TypeScript

import React from 'react';
import { getDeferredSafeStorage } from '@/stores/utils/safeStorage';
import { updateDesktopSettings } from '@/lib/persistence';
const SHOW_GITIGNORED_STORAGE_KEY = 'filesViewShowGitignored';
const SHOW_GITIGNORED_EVENT = 'files-view-show-gitignored-change';
const readStoredShowGitignored = (): boolean => {
if (typeof window === 'undefined') {
return false;
}
try {
const stored = getDeferredSafeStorage().getItem(SHOW_GITIGNORED_STORAGE_KEY);
return stored === 'true';
} catch {
return false;
}
};
const notifyFilesViewShowGitignoredChanged = () => {
if (typeof window === 'undefined') {
return;
}
window.dispatchEvent(new Event(SHOW_GITIGNORED_EVENT));
};
export const setFilesViewShowGitignored = (
value: boolean,
options: { persist?: boolean } = {}
) => {
if (typeof window === 'undefined') {
return;
}
try {
getDeferredSafeStorage().setItem(SHOW_GITIGNORED_STORAGE_KEY, value ? 'true' : 'false');
notifyFilesViewShowGitignoredChanged();
} catch {
// ignore storage errors
}
if (options.persist !== false) {
void updateDesktopSettings({ filesViewShowGitignored: value });
}
};
export const useFilesViewShowGitignored = (): boolean => {
const [showGitignored, setShowGitignored] = React.useState(readStoredShowGitignored);
React.useEffect(() => {
if (typeof window === 'undefined') {
return;
}
const handleChange = () => {
setShowGitignored(readStoredShowGitignored());
};
window.addEventListener('storage', handleChange);
window.addEventListener(SHOW_GITIGNORED_EVENT, handleChange);
return () => {
window.removeEventListener('storage', handleChange);
window.removeEventListener(SHOW_GITIGNORED_EVENT, handleChange);
};
}, []);
return showGitignored;
};