Skip to content
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

Jump to bottom

fix: dom-exception on access to localStorage #999

Merged
merged 2 commits into from
Feb 7, 2020
Merged

fix: dom-exception on access to localStorage #999

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
d8895c8
fix(dom-exception): delays access to localStorage to async api
nunomaduro Feb 7, 2020
b57d851
fix(dom-exception): memoize storage compution
nunomaduro Feb 7, 2020
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
32 changes: 31 additions & 1 deletion packages/cache-browser-local-storage/src/__tests__/unit/browser-local-storage-cache.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,37 @@ describe('browser local storage cache', () => {
expect(localStorage.length).toBe(0);
});

it('do throws localstorage related exceptions', async () => {
it('do throws localstorage exceptions on access', async () => {
const message =
"Failed to read the 'localStorage' property from 'Window': Access is denied for this document.";

const cache = createBrowserLocalStorageCache(
new Proxy(
{ key: 'foo' },
{
get(_, key) {
if (key === 'key') {
return 'foo';
}

// Simulates a window.localStorage access.
throw new DOMException(message);
},
}
)
);
const key = { foo: 'bar' };
const value = 'foo';
const fallback = 'bar';

await expect(cache.delete(key)).rejects.toEqual(new DOMException(message));
await expect(cache.set(key, value)).rejects.toEqual(new DOMException(message));
await expect(cache.get(key, () => Promise.resolve(fallback))).rejects.toEqual(
new DOMException(message)
);
});

it('do throws localstorage exceptions after access', async () => {
const cache = createBrowserLocalStorageCache({
key: version,
localStorage: notAvailableStorage,
Expand Down
19 changes: 14 additions & 5 deletions packages/cache-browser-local-storage/src/createBrowserLocalStorageCache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,20 @@ import { Cache, CacheEvents } from '@algolia/cache-common';
import { BrowserLocalStorageOptions } from '.';

export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptions): Cache {
const storage = options.localStorage || window.localStorage;
const namespaceKey = `algoliasearch-client-js-${options.key}`;

// eslint-disable-next-line functional/no-let
let storage: Storage;
const getStorage = () => {
if (storage === undefined) {
storage = options.localStorage || window.localStorage;
}

return storage;
};

const getNamespace = <TValue>(): Record<string, TValue> => {
return JSON.parse(storage.getItem(namespaceKey) || '{}');
return JSON.parse(getStorage().getItem(namespaceKey) || '{}');
};

return {
Expand Down Expand Up @@ -38,7 +47,7 @@ export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptio
// eslint-disable-next-line functional/immutable-data
namespace[JSON.stringify(key)] = value;

storage.setItem(namespaceKey, JSON.stringify(namespace));
getStorage().setItem(namespaceKey, JSON.stringify(namespace));

return value;
});
Expand All @@ -51,13 +60,13 @@ export function createBrowserLocalStorageCache(options: BrowserLocalStorageOptio
// eslint-disable-next-line functional/immutable-data
delete namespace[JSON.stringify(key)];

storage.setItem(namespaceKey, JSON.stringify(namespace));
getStorage().setItem(namespaceKey, JSON.stringify(namespace));
});
},

clear(): Readonly<Promise<void>> {
return Promise.resolve().then(() => {
storage.removeItem(namespaceKey);
getStorage().removeItem(namespaceKey);
});
},
};
Expand Down