Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 19 additions & 7 deletions examples/browser/browser-local.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,20 @@ function snapshotDirectory(fs, directory, files) {
}

/** Create a localStorage-backed persistence adapter for BashKit's browser VFS. */
export function browserLocal({
storage = globalThis.localStorage,
key = DEFAULT_KEY,
root = DEFAULT_ROOT,
} = {}) {
if (!storage) throw new Error("browserLocal requires a Storage implementation");
export function browserLocal({ storage: configuredStorage, key = DEFAULT_KEY, root = DEFAULT_ROOT } = {}) {
let storage = configuredStorage;
let storageBlocked = false;
if (storage === undefined) {
try {
storage = globalThis.localStorage;
} catch {
// Access itself can throw in sandboxed or storage-blocked browser contexts.
storageBlocked = true;
}
}
if (!storage && !storageBlocked) {
throw new Error("browserLocal requires a Storage implementation");
}

return {
load(defaultFiles = {}) {
Expand All @@ -70,7 +78,11 @@ export function browserLocal({
},

clear() {
storage.removeItem(key);
try {
storage.removeItem(key);
} catch {
// Unavailable storage must not prevent the browser shell from running.
}
},
};
}
20 changes: 20 additions & 0 deletions examples/browser/browser-local.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,26 @@ test("reports localStorage write failures without throwing", () => {
})), false);
});

test("tolerates blocked access to the global localStorage", () => {
const descriptor = Object.getOwnPropertyDescriptor(globalThis, "localStorage");
Object.defineProperty(globalThis, "localStorage", {
configurable: true,
get() { throw new DOMException("blocked", "SecurityError"); },
});

try {
const backend = browserLocal();
assert.deepEqual(backend.load({ "/home/user/welcome.txt": "hello\n" }), {
"/home/user/welcome.txt": "hello\n",
});
assert.equal(backend.save(fakeFs({})), false);
assert.doesNotThrow(() => backend.clear());
} finally {
if (descriptor) Object.defineProperty(globalThis, "localStorage", descriptor);
else delete globalThis.localStorage;
}
});

test("clear removes the persisted filesystem", () => {
const storage = new MemoryStorage();
storage.setItem("bashkit:fs", "saved");
Expand Down