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

Check localstorage availability before accessing it #5616

Merged
merged 3 commits into from
Sep 15, 2020
Merged

Check localstorage availability before accessing it #5616

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59a8262
Check localstorage availability before accessint it
Aug 17, 2020
d5204ad
Fix UTest for IE11
Sep 8, 2020
cf3f014
Restore window.localStorage property descriptor after each test
Sep 14, 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
6 changes: 3 additions & 3 deletions src/storageManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ export function newStorageManager({gvlid, moduleName, moduleType} = {}) {
*/
const setDataInLocalStorage = function (key, value, done) {
let cb = function (result) {
if (result && result.valid) {
if (result && result.valid && hasLocalStorage()) {
window.localStorage.setItem(key, value);
}
}
Expand All @@ -174,7 +174,7 @@ export function newStorageManager({gvlid, moduleName, moduleType} = {}) {
*/
const getDataFromLocalStorage = function (key, done) {
let cb = function (result) {
if (result && result.valid) {
if (result && result.valid && hasLocalStorage()) {
return window.localStorage.getItem(key);
}
return null;
Expand All @@ -194,7 +194,7 @@ export function newStorageManager({gvlid, moduleName, moduleType} = {}) {
*/
const removeDataFromLocalStorage = function (key, done) {
let cb = function (result) {
if (result && result.valid) {
if (result && result.valid && hasLocalStorage()) {
window.localStorage.removeItem(key);
}
}
Expand Down
17 changes: 17 additions & 0 deletions test/spec/unit/core/storageManager_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,22 @@ describe('storage manager', function() {
storage.setCookie('foo1', 'baz1');
expect(deviceAccessSpy.calledOnce).to.equal(true);
deviceAccessSpy.restore();
});

it('should not throw if the localstorage is not accessible when setting/getting/removing from localstorage', function() {
const coreStorage = getStorageManager();

const localstorageStub = sinon.stub(global.window, 'localStorage').get(() => { throw Error });
const errorLogSpy = sinon.spy(utils, 'logError');

coreStorage.setDataInLocalStorage('key', 'value');
const val = coreStorage.getDataFromLocalStorage('key');
coreStorage.removeDataFromLocalStorage('key');

expect(val).to.be.null;
sinon.assert.calledThrice(errorLogSpy);

localstorageStub.restore();
errorLogSpy.restore();
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you move the stubs (and the subsequent restores) into a before/after function surrounding this test? This will help ensure these objects are properly handled in case the test fails. If you don't want to have these stubs effect the other tests, please feel free to create another describe block to nest it altogether.

Copy link
Contributor Author

@Swiiip Swiiip Sep 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Ok 👍

Btw, in this case what is "third party context"? Is that just JS loaded from 3p domain?

access window.localstorage in a third-party context

Indeed, 3rd-party context refers to scripts run inside an iframe whose src domain is not the 1p domain for instance.

})
});