Add prefix to localStorage settings adapter (#159)

Avoid parsing of localStorage entries that does not contains a
configured prefix because it could contain data that has been set in
other applications under the same host.

Author: andersevenrud

__tests__/adapters/settings/localstorage.js

@@ -3,14 +3,14 @@ import adapter from '../../../src/adapters/settings/localstorage.js';
 let core;
 
 describe('LocalStorage Settings Adapter', () => {
-  beforeAll(() => {
-    localStorage.setItem('failure', '{failure}');
+  beforeAll(async () => {
+    localStorage.setItem('osjs__failure', '{failure}');
 
-    createInstance().then(c => (core = c));
+    core = await createInstance();
   });
 
   afterAll(() => {
-    localStorage.removeItem('failure');
+    localStorage.removeItem('osjs__failure');
     core.destroy();
   });
 

src/adapters/settings/localstorage.js

@@ -35,36 +35,49 @@ import logger from '../../logger';
  * @param {Core} core Core reference
  * @param {object} [options] Adapter options
  */
-const localStorageSettings = core => ({
-  clear: ns => {
-    if (ns) {
-      localStorage.removeItem(ns);
-    } else {
-      localStorage.clear();
-    }
+const localStorageSettings = (core) => {
+  const prefix = core.config('settings.prefix', '');
 
-    return Promise.resolve(true);
-  },
+  return {
+    clear(ns) {
+      if (ns) {
+        localStorage.removeItem(prefix + ns);
+      } else {
+        localStorage.clear();
+      }
 
-  save: settings => {
-    Object.keys(settings).forEach((k) => {
-      localStorage.setItem(k, JSON.stringify(settings[k]));
-    });
+      return Promise.resolve(true);
+    },
 
-    return Promise.resolve(true);
-  },
+    save(settings) {
+      Object.keys(settings).forEach((k) => {
+        localStorage.setItem(prefix + k, JSON.stringify(settings[k]));
+      });
 
-  load: () => Promise.resolve(Object.keys(localStorage).reduce((o, v) => {
-    let value = localStorage.getItem(v);
-    try {
-      value = JSON.parse(value);
-    } catch (e) {
-      logger.warn('localStorageAdapter parse error', e);
-    }
+      return Promise.resolve(true);
+    },
+
+    load() {
+      const entries = Object
+        .keys(localStorage)
+        .filter(k => prefix ? k.startsWith(prefix) : true)
+        .map((k) => {
+          const v = localStorage.getItem(k);
+          const kk = prefix ? k.substr(prefix.length) : k;
 
-    return Object.assign(o, {[v]: value});
-  }, {}))
-});
+          try {
+            return [kk, JSON.parse(v)];
+          } catch (e) {
+            logger.warn(`localStorageAdapter parse failed for '${k}'`, e);
+          }
+
+          return [kk, v];
+        });
+
+      return Promise.resolve(Object.fromEntries(entries));
+    }
+  };
+};
 
 
 export default localStorageSettings;

src/config.js

@@ -171,6 +171,7 @@ export const defaultConfiguration = {
 
   settings: {
     lock: [],
+    prefix: 'osjs__', // localStorage settings adapter key prefix
 
     defaults: {
       'osjs/default-application': {},