🔀 Merge pull request #569 from FrostCo/bookmarklet_fixes

Bookmarklet Fixes

Author: richardfrost

src/script/bookmarkletFilter.ts

@@ -19,7 +19,6 @@ export default class BookmarkletFilter extends Filter {
   processNode: (node: Document | HTMLElement | Node | ShadowRoot, wordlistId: number, statsType?: string | null) => void;
   shadowObserver: MutationObserver;
   stats?: Statistics; // Bookmarklet: Not used
-  updateCounterBadge: () => void; // Bookmarklet: Not used - Needed to match signature of WebFilter
 
   //#region Class reference helpers
   // Can be overridden in children classes
@@ -104,6 +103,7 @@ export default class BookmarkletFilter extends Filter {
 
   cleanPage(config?: WebConfig) {
     this.cfg = new this.Class.Config(config);
+    this.cfg.collectStats = false; // Bookmarklet: Force disable collection of stats
     this.filterText = this.cfg.filterMethod !== this.Class.Constants.FILTER_METHODS.OFF;
     this.domain = this.Class.Domain.byHostname(this.hostname, this.cfg.domains);
 
@@ -286,4 +286,8 @@ export default class BookmarkletFilter extends Filter {
     observer.disconnect();
     if (mutations) { this.processMutations(mutations); }
   }
+
+  updateCounterBadge() {
+    // Bookmarklet: Not used - Needed to match signature of WebFilter
+  }
 }

src/script/lib/helper.ts

@@ -4,6 +4,10 @@ export function booleanToNumber(value: boolean): number {
   return value ? Constants.TRUE : Constants.FALSE;
 }
 
+export function deepCloneJson(object) {
+  return JSON.parse(JSON.stringify(object));
+}
+
 /* istanbul ignore next */
 export function dynamicList(list: string[], select: HTMLSelectElement, upperCaseFirstChar: boolean = false, title?: string) {
   removeChildren(select);

src/script/optionPage.ts

@@ -8,6 +8,7 @@ import Bookmarklet from '@APF/bookmarklet';
 import Logger from '@APF/lib/logger';
 import {
   booleanToNumber,
+  deepCloneJson,
   dynamicList,
   exportToFile,
   lastElement,
@@ -262,6 +263,15 @@ export default class OptionPage {
     configText.value = JSON.stringify(config, null, 2);
   }
 
+  get bookmarkletConfig() {
+    const clone = deepCloneJson(this.cfg);
+    const keysToRemove = [...this.cfg.Class._localOnlyKeys];
+    Object.keys(clone).forEach((key) => {
+      if (keysToRemove.includes(key)) delete clone[key];
+    });
+    return clone;
+  }
+
   bulkEditorAddRow(word: string = '', data: WordOptions | undefined = undefined) {
     const table = document.querySelector('#bulkWordEditorModal table#bulkWordEditorTable') as HTMLTableElement;
     if (data === undefined) {
@@ -864,7 +874,7 @@ export default class OptionPage {
 
     const bookmarkletConfig = document.querySelector('input[name="bookmarkletConfig"]:checked') as HTMLInputElement;
     const bookmarkletLink = document.getElementById('bookmarkletLink') as HTMLAnchorElement;
-    const cfg = bookmarkletConfig.value == 'default' ? null : this.cfg;
+    const cfg = bookmarkletConfig.value == 'default' ? null : this.bookmarkletConfig;
     const href = this.bookmarklet.href(cfg);
     bookmarkletLink.href = href;
     this.Class.enableBtn(bookmarkletLink);

test/spec/lib/helper.spec.ts

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import Constants from '@APF/lib/constants';
 import {
   booleanToNumber,
+  deepCloneJson,
   formatNumber,
   getParent,
   getVersion,
@@ -33,6 +34,50 @@ describe('Helper', function() {
     });
   });
 
+  describe('deepJsonClone()', function() {
+    const deepObject = {
+      children: {
+        deep: false,
+        name: 'shallow',
+        shallow: true,
+      },
+      deep: true,
+      name: 'deep',
+      numbers: [1, 2],
+      shallow: false,
+      strings: ['one', 'two'],
+    };
+
+    const shallowObject = {
+      deep: false,
+      name: 'shallow',
+      shallow: true,
+    };
+
+    it('Shallow clones object', function() {
+      expect(JSON.stringify(deepCloneJson(shallowObject))).to.eql(JSON.stringify(shallowObject));
+    });
+
+    it('Deep clones object', function() {
+      expect(JSON.stringify(deepCloneJson(deepObject))).to.eql(JSON.stringify(deepObject));
+    });
+
+    it('Is a clone (delete)', function() {
+      const clone = deepCloneJson(deepObject);
+      delete clone.name;
+      expect(clone.name).to.be.undefined;
+      expect(deepObject.name).to.not.be.undefined;
+    });
+
+    it('Is a clone (update)', function() {
+      const clone = deepCloneJson(deepObject);
+      const key = 'name2';
+      clone[key] = 'deep2';
+      expect(clone[key]).to.not.be.undefined;
+      expect(deepObject[key]).to.be.undefined;
+    });
+  });
+
   describe('formatNumber()', function() {
     it('Format numbers for counter display', function() {
       expect(formatNumber(999)).to.eql('999');