prefer localStorage over window.localStorage (#3646)

graphql · Jul 24, 2024 · 56c6f45 · 56c6f45
1 parent 32ea9f1
commit 56c6f45
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 11 deletions.
diff --git a/.changeset/light-geckos-vanish.md b/.changeset/light-geckos-vanish.md
@@ -0,0 +1,5 @@
+---
+"@graphiql/toolkit": patch
+---
+
+prefer `localStorage` over `window.localStorage`
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -133,7 +133,14 @@ module.exports = {
         'no-octal-escape': 'error',
         'no-param-reassign': 'error',
         'no-proto': 'error',
-        'no-restricted-properties': 'off',
+        'no-restricted-properties': [
+          'error',
+          {
+            object: 'window',
+            property: 'localStorage',
+            message: 'Use `localStorage` instead',
+          },
+        ],
         'no-return-assign': 'error',
         'no-return-await': 'error',
         'no-script-url': 'error',

diff --git a/packages/graphiql-toolkit/src/storage/base.ts b/packages/graphiql-toolkit/src/storage/base.ts
@@ -64,13 +64,13 @@ export class StorageAPI {
       this.storage = null;
     } else {
       this.storage = {
-        getItem: window.localStorage.getItem.bind(window.localStorage),
-        setItem: window.localStorage.setItem.bind(window.localStorage),
-        removeItem: window.localStorage.removeItem.bind(window.localStorage),
+        getItem: localStorage.getItem.bind(localStorage),
+        setItem: localStorage.setItem.bind(localStorage),
+        removeItem: localStorage.removeItem.bind(localStorage),
 
         get length() {
           let keys = 0;
-          for (const key in window.localStorage) {
+          for (const key in localStorage) {
             if (key.indexOf(`${STORAGE_NAMESPACE}:`) === 0) {
               keys += 1;
             }
@@ -80,9 +80,9 @@ export class StorageAPI {
 
         clear() {
           // We only want to clear the namespaced items
-          for (const key in window.localStorage) {
+          for (const key in localStorage) {
             if (key.indexOf(`${STORAGE_NAMESPACE}:`) === 0) {
-              window.localStorage.removeItem(key);
+              localStorage.removeItem(key);
             }
           }
         },

diff --git a/packages/graphiql-toolkit/src/storage/custom.ts b/packages/graphiql-toolkit/src/storage/custom.ts
@@ -25,7 +25,7 @@ export function createLocalStorage({
     removeItem: key => localStorage.removeItem(getStorageKey(key)),
     get length() {
       let keys = 0;
-      for (const key in window.localStorage) {
+      for (const key in localStorage) {
         if (key.indexOf(storageKeyPrefix) === 0) {
           keys += 1;
         }
@@ -35,9 +35,9 @@ export function createLocalStorage({
 
     clear() {
       // We only want to clear the namespaced items
-      for (const key in window.localStorage) {
+      for (const key in localStorage) {
         if (key.indexOf(storageKeyPrefix) === 0) {
-          window.localStorage.removeItem(key);
+          localStorage.removeItem(key);
         }
       }
     },

diff --git a/packages/graphiql/src/components/__tests__/GraphiQL.spec.tsx b/packages/graphiql/src/components/__tests__/GraphiQL.spec.tsx
@@ -29,7 +29,7 @@ const simpleIntrospection = {
 };
 
 beforeEach(() => {
-  window.localStorage.clear();
+  localStorage.clear();
 });
 
 describe('GraphiQL', () => {