Skip to content

fix: enable InMemoryDriver localStorage persistence in MSW browser mode #992

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

Merged
hotlong merged 2 commits into from
Mar 3, 2026
Merged

fix: enable InMemoryDriver localStorage persistence in MSW browser mode #992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec8a46a
Initial plan
Copilot Mar 3, 2026
0f85464
fix: call driver.connect() and flush() to enable localStorage persist…
Copilot Mar 3, 2026
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
27 changes: 25 additions & 2 deletions apps/console/src/mocks/createKernel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ export interface KernelOptions {
skipSystemValidation?: boolean;
/** MSWPlugin options; when provided, MSWPlugin is added to the kernel. */
mswOptions?: MSWPluginOptions;
/**
* InMemoryDriver persistence configuration.
*
* - `'auto'` (default) — auto-detect environment (browser → localStorage, Node.js → file)
* - `'local'` — force localStorage persistence (browser only)
* - `false` — disable persistence entirely (useful in tests)
*
* When omitted, defaults to `'auto'`.
*/
persistence?: false | 'auto' | 'local' | 'file';
Comment on lines +28 to +37
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSDoc for persistence lists auto, local, and false, but the type also allows 'file'. Either document the 'file' mode in the comment (including when it’s valid) or remove it from the union to keep the API contract consistent.

Copilot uses AI. Check for mistakes.
}

export interface KernelResult {
Expand Down Expand Up @@ -154,9 +164,11 @@ function patchDriverCreate(driver: InMemoryDriver): void {
* so that kernel setup logic is not duplicated.
*/
export async function createKernel(options: KernelOptions): Promise<KernelResult> {
const { appConfig, skipSystemValidation = true, mswOptions } = options;
const { appConfig, skipSystemValidation = true, mswOptions, persistence } = options;

const driver = new InMemoryDriver();
const driver = new InMemoryDriver(
persistence !== undefined ? { persistence } : undefined,
);

const kernel = new ObjectKernel({
skipSystemValidation
Expand Down Expand Up @@ -190,5 +202,16 @@ export async function createKernel(options: KernelOptions): Promise<KernelResult
await installBrokerShim(kernel);
}

// Initialise persistence adapter and load any previously persisted data.
// On first load this is a no-op (empty localStorage); on subsequent page
// refreshes the persisted data overwrites the seed data so that user
// changes survive a browser reload.
await driver.connect();

// Ensure the current database state (seed data on first load, or the
// just-restored persisted snapshot) is flushed to the persistence layer
// so that localStorage always contains the latest data.
await driver.flush();

return { kernel, driver, mswPlugin };
}
1 change: 1 addition & 0 deletions apps/console/src/mocks/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export async function startMockServer() {

const result = await createKernel({
appConfig,
persistence: false,
mswOptions: {
enableBrowser: false,
baseUrl: '/api/v1',
Expand Down