Issue 7016 - Convert serialization functions into generators

lib/filterClasses.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 125 matching lines @@
           this._subscriptions = [...this._subscriptions][0];
       }
       else if (subscription == this._subscriptions)
       {
         this._subscriptions = null;
       }
     }
   },
 
   /**
-   * Serializes the filter to an array of strings for writing out on the disk.
-   * @param {string[]} buffer  buffer to push the serialization results into
+   * Generates serialized filter.
+   * @yields {string}
    */
-  serialize(buffer)
+  *serialize()
   {
-    buffer.push("[Filter]");
-    buffer.push("text=" + this.text);
+    yield "[Filter]";

[Manish Jethani, 2018/10/09 15:11:03]

Let's extract the value of the text property first:

  let {text} = this;
  yield "[Filter]";
  yield "text=" + text;

[Jon Sonesen, 2018/10/12 03:50:05]

Done.

+    yield "text=" + this.text;
   },
 
   toString()
   {
     return this.text;
   }
 };
 
 /**
  * Cache for known filters, maps string representation to filter objects.
@@ skipping 156 matching lines @@
   /**
    * Reason why this filter is invalid
    * @type {string}
    */
   reason: null,
 
   /**
    * See Filter.serialize()
    * @inheritdoc
    */
-  serialize(buffer) {}
+  *serialize() {}
 });
 
 /**
  * Class for comments
  * @param {string} text see {@link Filter Filter()}
  * @constructor
  * @augments Filter
  */
 function CommentFilter(text)
 {
   Filter.call(this, text);
 }
 exports.CommentFilter = CommentFilter;
 
 CommentFilter.prototype = extend(Filter, {
   type: "comment",
 
   /**
    * See Filter.serialize()
    * @inheritdoc
    */
-  serialize(buffer) {}
+  *serialize() {}
 });
 
 /**
  * Abstract base class for filters that can get hits
  * @param {string} text
  *   see {@link Filter Filter()}
  * @param {string} [domains]
  *   Domains that the filter is restricted to separated by domainSeparator
  *   e.g. "foo.com|bar.com|~baz.com"
  * @constructor
@@ skipping 245 matching lines @@
   {
     let {sitekeys, domains} = this;
 
     return !(sitekeys && sitekeys.length) && (!domains || domains.get(""));
   },
 
   /**
    * See Filter.serialize()
    * @inheritdoc
    */
-  serialize(buffer)
+  *serialize()
   {
     if (this._disabled || this._hitCount || this._lastHit)

[Manish Jethani, 2018/10/09 15:11:03]

Similarly, let's extract the values here first:

  let {_disabled, _hitCount, _lastHit} = this;

The reason for doing this is that the values being serialized should be
consistent. Inconsistent values would be, for example, when hit count is 0 but
last hit is set.

[Jon Sonesen, 2018/10/12 03:50:05]

Done.

     {
-      Filter.prototype.serialize.call(this, buffer);
+      yield* Filter.prototype.serialize.call(this);
       if (this._disabled)
-        buffer.push("disabled=true");
+        yield "disabled=true";
       if (this._hitCount)
-        buffer.push("hitCount=" + this._hitCount);
+        yield "hitCount=" + this._hitCount;
       if (this._lastHit)
-        buffer.push("lastHit=" + this._lastHit);
+        yield "lastHit=" + this._lastHit;
     }
   }
 });
 
 /**
  * Abstract base class for RegExp-based filters
  * @param {string} text see {@link Filter Filter()}
  * @param {string} regexpSource
  *   filter part that the regular expression should be build from
  * @param {number} [contentType]
@@ skipping 599 matching lines @@
 
   /**
    * Script that should be executed
    * @type {string}
    */
   get script()
   {
     return this.body;
   }
 });