a9850b25c3
The helper was needed because `jest.spyOn` would not work on this special window object property. The only way we could successfully spy on `localStorage` was with this helper.
41 lines
1.1 KiB
JavaScript
41 lines
1.1 KiB
JavaScript
/**
|
|
* Manage the instance of a custom `window.localStorage`
|
|
*
|
|
* This only encapsulates the setup / teardown logic so that it can easily be
|
|
* reused with different implementations (i.e. a spy or a [fake][1])
|
|
*
|
|
* [1]: https://stackoverflow.com/a/41434763/1708147
|
|
*
|
|
* @param {() => any} fn Function that returns the object to use for localStorage
|
|
*/
|
|
const useLocalStorage = fn => {
|
|
const origLocalStorage = window.localStorage;
|
|
let currentLocalStorage;
|
|
|
|
Object.defineProperty(window, 'localStorage', {
|
|
get: () => currentLocalStorage,
|
|
});
|
|
|
|
beforeEach(() => {
|
|
currentLocalStorage = fn();
|
|
});
|
|
|
|
afterEach(() => {
|
|
currentLocalStorage = origLocalStorage;
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Create an object with the localStorage interface but `jest.fn()` implementations.
|
|
*/
|
|
export const createLocalStorageSpy = () => ({
|
|
clear: jest.fn(),
|
|
getItem: jest.fn(),
|
|
setItem: jest.fn(),
|
|
removeItem: jest.fn(),
|
|
});
|
|
|
|
/**
|
|
* Before each test, overwrite `window.localStorage` with a spy implementation.
|
|
*/
|
|
export const useLocalStorageSpy = () => useLocalStorage(createLocalStorageSpy);
|