jest-webextension-mock 3.8.16 → 3.9.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # jest-webextension-mock
 
+## 3.9.1
+
+### Patch Changes
+
+- Fix storage returning undefined for unknown keys
+
+## 3.9.0
+
+### Minor Changes
+
+- Add support for storage.session
+
 ## 3.8.16
 
 ### Patch Changes

package/__tests__/storage.test.js

@@ -11,7 +11,7 @@ describe('browser.storage', () => {
 });
 
 describe('browser.storage', () => {
-  ['sync', 'local', 'managed'].forEach((type) => {
+  ['sync', 'local', 'managed', 'session'].forEach((type) => {
     describe(type, () => {
       const storage = browser.storage[type];
       describe('get', () => {
@@ -19,32 +19,21 @@ describe('browser.storage', () => {
         test('a string key', (done) => {
           const key = 'test';
           storage.get(key, (result) => {
-            expect(result).toBeDefined();
-            expect(typeof result === 'object').toBeTruthy();
-            expect(result).toHaveProperty(key, undefined);
+            expect(result).toStrictEqual({});
             done();
           });
         });
         test('an array key', (done) => {
           const keys = ['test1', 'test2'];
           storage.get(keys, (result) => {
-            expect(result).toBeDefined();
-            expect(typeof result === 'object').toBeTruthy();
-            keys.forEach((k) => {
-              expect(result).toHaveProperty(k, undefined);
-            });
+            expect(result).toStrictEqual({});
             done();
           });
         });
         test('an object key', (done) => {
           const key = { test: [] };
           storage.get(key, (result) => {
-            expect(result).toBeDefined();
-            expect(typeof result === 'object').toBeTruthy();
-            Object.keys(key).forEach((k) => {
-              expect(result).toHaveProperty(k);
-              expect(result[k]).toEqual(key[k]);
-            });
+            expect(result).toStrictEqual({ test: [] });
             done();
           });
         });
@@ -71,8 +60,8 @@ describe('browser.storage', () => {
         const key = 'key';
         return expect(storage.get(key)).resolves.toEqual({ key: undefined });
       });
-      test('getBytesInUse', (done) => {
-        const callback = jest.fn(() => done());
+      test('getBytesInUse', () => {
+        const callback = jest.fn();
         expect(jest.isMockFunction(storage.getBytesInUse)).toBe(true);
         storage.getBytesInUse('key', callback);
         expect(storage.getBytesInUse).toHaveBeenCalledTimes(1);
@@ -81,8 +70,8 @@ describe('browser.storage', () => {
       test('getBytesInUse promise', () => {
         return expect(storage.getBytesInUse('key')).resolves.toBe(0);
       });
-      test('set', (done) => {
-        const callback = jest.fn(() => done());
+      test('set', () => {
+        const callback = jest.fn();
         expect(jest.isMockFunction(storage.set)).toBe(true);
         storage.set({ key: 'foo' }, callback);
         expect(storage.set).toHaveBeenCalledTimes(1);
@@ -91,8 +80,8 @@ describe('browser.storage', () => {
       test('set promise', () => {
         return expect(storage.set(1)).resolves.toBeUndefined();
       });
-      test('remove', (done) => {
-        const callback = jest.fn(() => done());
+      test('remove', () => {
+        const callback = jest.fn();
         expect(jest.isMockFunction(storage.remove)).toBe(true);
         storage.remove('key', callback);
         expect(storage.remove).toHaveBeenCalledTimes(1);
@@ -101,8 +90,8 @@ describe('browser.storage', () => {
       test('remove promise', () => {
         return expect(storage.remove(['foo', 'bar'])).resolves.toBeUndefined();
       });
-      test('clear', (done) => {
-        const callback = jest.fn(() => done());
+      test('clear', () => {
+        const callback = jest.fn();
         expect(jest.isMockFunction(browser.storage.sync.clear)).toBe(true);
         storage.clear(callback);
         expect(storage.clear).toHaveBeenCalledTimes(1);
@@ -120,24 +109,16 @@ describe('browser.storage', () => {
         storage.set({ key: 'value', foo: 'bar', foo2: 'bar2' }, () => {
           // get 'key'
           storage.get(['key'], (result) => {
-            expect(result).toBeDefined();
-            expect(typeof result === 'object').toBeTruthy();
-            expect(result).toHaveProperty('key', 'value');
-            expect(result).not.toHaveProperty('foo');
-            expect(result).not.toHaveProperty('foo2');
+            expect(result).toStrictEqual({ key: 'value' });
             // remove 'key'
             storage.remove('key', () => {
               // get all values
               storage.get(null, (result) => {
-                expect(result).toHaveProperty('key', undefined);
-                expect(result).toHaveProperty('foo', 'bar');
-                expect(result).toHaveProperty('foo2', 'bar2');
+                expect(result).toStrictEqual({ foo: 'bar', foo2: 'bar2' });
                 // clear values
                 storage.clear(() => {
                   storage.get(['key', 'foo', 'foo2'], (result) => {
-                    expect(result).toHaveProperty('key', undefined);
-                    expect(result).toHaveProperty('foo', undefined);
-                    expect(result).toHaveProperty('foo2', undefined);
+                    expect(result).toStrictEqual({});
                     done();
                   });
                 });

package/dist/setup.js

@@ -43,6 +43,52 @@ function _defineProperty(obj, key, value) {
   }
   return obj;
 }
+function _slicedToArray(arr, i) {
+  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+function _arrayWithHoles(arr) {
+  if (Array.isArray(arr)) return arr;
+}
+function _iterableToArrayLimit(arr, i) {
+  var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+  if (_i == null) return;
+  var _arr = [];
+  var _n = true;
+  var _d = false;
+  var _s, _e;
+  try {
+    for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
+      _arr.push(_s.value);
+      if (i && _arr.length === i) break;
+    }
+  } catch (err) {
+    _d = true;
+    _e = err;
+  } finally {
+    try {
+      if (!_n && _i["return"] != null) _i["return"]();
+    } finally {
+      if (_d) throw _e;
+    }
+  }
+  return _arr;
+}
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(o);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
+  return arr2;
+}
+function _nonIterableRest() {
+  throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
 
 // https://developer.chrome.com/extensions/omnibox
 
@@ -259,73 +305,34 @@ var createEventListeners = function createEventListeners() {
   };
 };
 
-var syncStore = {};
-var localStore = {};
-var managedStore = {};
 function resolveKey(key, store) {
   if (typeof key === 'string') {
-    var result = {};
-    result[key] = store[key];
-    return result;
+    if (key in store) {
+      return {
+        key: store[key]
+      };
+    } else {
+      return {};
+    }
   } else if (Array.isArray(key)) {
-    return key.reduce(function (acc, curr) {
-      acc[curr] = store[curr];
-      return acc;
+    return key.reduce(function (acc, currKey) {
+      return _objectSpread2(_objectSpread2({}, acc), resolveKey(currKey, store));
     }, {});
   } else if (_typeof(key) === 'object') {
-    return Object.keys(key).reduce(function (acc, curr) {
-      acc[curr] = store[curr] || key[curr];
-      return acc;
+    return Object.entries(key).reduce(function (acc, _ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+        currKey = _ref2[0],
+        fallbackValue = _ref2[1];
+      return _objectSpread2(_objectSpread2({}, acc), {}, _defineProperty({}, currKey, fallbackValue), resolveKey(currKey, store));
     }, {});
   }
   throw new Error('Wrong key given');
 }
-var storage = {
-  sync: {
-    get: jest.fn(function (id, cb) {
-      var result = id === null || id === undefined ? syncStore : resolveKey(id, syncStore);
-      if (cb !== undefined) {
-        return cb(result);
-      }
-      return Promise.resolve(result);
-    }),
-    getBytesInUse: jest.fn(function (id, cb) {
-      if (cb !== undefined) {
-        return cb(0);
-      }
-      return Promise.resolve(0);
-    }),
-    set: jest.fn(function (payload, cb) {
-      Object.keys(payload).forEach(function (key) {
-        return syncStore[key] = payload[key];
-      });
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    remove: jest.fn(function (id, cb) {
-      var keys = typeof id === 'string' ? [id] : id;
-      keys.forEach(function (key) {
-        return delete syncStore[key];
-      });
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    clear: jest.fn(function (cb) {
-      syncStore = {};
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    onChanged: createEventListeners()
-  },
-  local: {
+function mockStore() {
+  var store = {};
+  return {
     get: jest.fn(function (id, cb) {
-      var result = id === null || id === undefined ? localStore : resolveKey(id, localStore);
+      var result = id === null || id === undefined ? store : resolveKey(id, store);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -339,7 +346,7 @@ var storage = {
     }),
     set: jest.fn(function (payload, cb) {
       Object.keys(payload).forEach(function (key) {
-        return localStore[key] = payload[key];
+        return store[key] = payload[key];
       });
       if (cb !== undefined) {
         return cb();
@@ -349,7 +356,7 @@ var storage = {
     remove: jest.fn(function (id, cb) {
       var keys = typeof id === 'string' ? [id] : id;
       keys.forEach(function (key) {
-        return delete localStore[key];
+        return delete store[key];
       });
       if (cb !== undefined) {
         return cb();
@@ -357,56 +364,22 @@ var storage = {
       return Promise.resolve();
     }),
     clear: jest.fn(function (cb) {
-      localStore = {};
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    onChanged: createEventListeners()
-  },
-  managed: {
-    get: jest.fn(function (id, cb) {
-      var result = id === null || id === undefined ? managedStore : resolveKey(id, managedStore);
-      if (cb !== undefined) {
-        return cb(result);
-      }
-      return Promise.resolve(result);
-    }),
-    getBytesInUse: jest.fn(function (id, cb) {
-      if (cb !== undefined) {
-        return cb(0);
-      }
-      return Promise.resolve(0);
-    }),
-    set: jest.fn(function (payload, cb) {
-      Object.keys(payload).forEach(function (key) {
-        return managedStore[key] = payload[key];
-      });
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    remove: jest.fn(function (id, cb) {
-      var keys = typeof id === 'string' ? [id] : id;
-      keys.forEach(function (key) {
-        return delete managedStore[key];
+      Object.keys(store).forEach(function (key) {
+        return delete store[key];
       });
       if (cb !== undefined) {
         return cb();
       }
       return Promise.resolve();
     }),
-    clear: jest.fn(function (cb) {
-      managedStore = {};
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
     onChanged: createEventListeners()
-  },
+  };
+}
+var storage = {
+  sync: mockStore(),
+  local: mockStore(),
+  session: mockStore(),
+  managed: mockStore(),
   onChanged: createEventListeners()
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-webextension-mock",
-  "version": "3.8.16",
+  "version": "3.9.1",
   "description": "Mock the components of a WebExtension",
   "main": "dist/setup.js",
   "module": "src/setup.js",

package/src/storage.js

@@ -1,115 +1,40 @@
 import { createEventListeners } from './createEventListeners';
 
-let syncStore = {};
-let localStore = {};
-let managedStore = {};
-
 function resolveKey(key, store) {
   if (typeof key === 'string') {
-    const result = {};
-    result[key] = store[key];
-    return result;
+    if (key in store) {
+      return { key: store[key] };
+    } else {
+      return {};
+    }
   } else if (Array.isArray(key)) {
-    return key.reduce((acc, curr) => {
-      acc[curr] = store[curr];
-      return acc;
-    }, {});
+    return key.reduce(
+      (acc, currKey) => ({
+        ...acc,
+        ...resolveKey(currKey, store),
+      }),
+      {}
+    );
   } else if (typeof key === 'object') {
-    return Object.keys(key).reduce((acc, curr) => {
-      acc[curr] = store[curr] || key[curr];
-      return acc;
-    }, {});
+    return Object.entries(key).reduce(
+      (acc, [currKey, fallbackValue]) => ({
+        ...acc,
+        [currKey]: fallbackValue,
+        ...resolveKey(currKey, store),
+      }),
+      {}
+    );
   }
   throw new Error('Wrong key given');
 }
 
-export const storage = {
-  sync: {
-    get: jest.fn((id, cb) => {
-      const result =
-        id === null || id === undefined ? syncStore : resolveKey(id, syncStore);
-      if (cb !== undefined) {
-        return cb(result);
-      }
-      return Promise.resolve(result);
-    }),
-    getBytesInUse: jest.fn((id, cb) => {
-      if (cb !== undefined) {
-        return cb(0);
-      }
-      return Promise.resolve(0);
-    }),
-    set: jest.fn((payload, cb) => {
-      Object.keys(payload).forEach((key) => (syncStore[key] = payload[key]));
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    remove: jest.fn((id, cb) => {
-      const keys = typeof id === 'string' ? [id] : id;
-      keys.forEach((key) => delete syncStore[key]);
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    clear: jest.fn((cb) => {
-      syncStore = {};
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    onChanged: createEventListeners(),
-  },
-  local: {
-    get: jest.fn((id, cb) => {
-      const result =
-        id === null || id === undefined
-          ? localStore
-          : resolveKey(id, localStore);
-      if (cb !== undefined) {
-        return cb(result);
-      }
-      return Promise.resolve(result);
-    }),
-    getBytesInUse: jest.fn((id, cb) => {
-      if (cb !== undefined) {
-        return cb(0);
-      }
-      return Promise.resolve(0);
-    }),
-    set: jest.fn((payload, cb) => {
-      Object.keys(payload).forEach((key) => (localStore[key] = payload[key]));
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    remove: jest.fn((id, cb) => {
-      const keys = typeof id === 'string' ? [id] : id;
-      keys.forEach((key) => delete localStore[key]);
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    clear: jest.fn((cb) => {
-      localStore = {};
-      if (cb !== undefined) {
-        return cb();
-      }
-      return Promise.resolve();
-    }),
-    onChanged: createEventListeners(),
-  },
-  managed: {
+function mockStore() {
+  const store = {};
+
+  return {
     get: jest.fn((id, cb) => {
       const result =
-        id === null || id === undefined
-          ? managedStore
-          : resolveKey(id, managedStore);
+        id === null || id === undefined ? store : resolveKey(id, store);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -122,7 +47,7 @@ export const storage = {
       return Promise.resolve(0);
     }),
     set: jest.fn((payload, cb) => {
-      Object.keys(payload).forEach((key) => (managedStore[key] = payload[key]));
+      Object.keys(payload).forEach((key) => (store[key] = payload[key]));
       if (cb !== undefined) {
         return cb();
       }
@@ -130,20 +55,27 @@ export const storage = {
     }),
     remove: jest.fn((id, cb) => {
       const keys = typeof id === 'string' ? [id] : id;
-      keys.forEach((key) => delete managedStore[key]);
+      keys.forEach((key) => delete store[key]);
       if (cb !== undefined) {
         return cb();
       }
       return Promise.resolve();
     }),
     clear: jest.fn((cb) => {
-      managedStore = {};
+      Object.keys(store).forEach((key) => delete store[key]);
       if (cb !== undefined) {
         return cb();
       }
       return Promise.resolve();
     }),
     onChanged: createEventListeners(),
-  },
+  };
+}
+
+export const storage = {
+  sync: mockStore(),
+  local: mockStore(),
+  session: mockStore(),
+  managed: mockStore(),
   onChanged: createEventListeners(),
 };