Issue 6969 - Implement abort-on-property-read snippet

lib/content/snippets.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 475 matching lines @@
     {
       event.preventDefault();
     }
   },
   true);
 }
 
 exports["prevent-inline-scripts"] = preventInlineScripts;
 
 /**
- * Generates a random alphanumeric ID consisting 6 base-36 digits

[Manish Jethani, 2018/10/28 21:34:06]

Nit: consisting *of*

[hub, 2018/10/29 16:34:02]

Done.

+ * Generates a random alphanumeric ID consisting of 6 base-36 digits
  * from the range 100000..zzzzzz (both inclusive).
  *
  * @returns {string} The random ID.
  */
 function randomId()
 {
   // 2176782336 is 36^6 which mean 6 chars [a-z0-9]
   // 60466176 is 36^5
   // 2176782336 - 60466176 = 2116316160. This ensure to always have 6
   // chars even if Math.random() returns its minimum value 0.0
   //
   return Math.floor(Math.random() * 2116316160 + 60466176).toString(36);
 }
 
 function wrapPropertyAccess(object, property, descriptor)
 {
   let currentDescriptor = Object.getOwnPropertyDescriptor(object, property);
-  if (!currentDescriptor)
-    currentDescriptor = {};
-  if (typeof descriptor.get != "undefined")
-    currentDescriptor.get = descriptor.get;
-  if (typeof descriptor.set != "undefined")
-    currentDescriptor.set = descriptor.set;
-  Object.defineProperty(object, property, currentDescriptor);
-}
-
-/**
- * Will patch a property on the window object to abort when read.

[Manish Jethani, 2018/10/28 21:34:05]

Suggestion: Patches a property on the window object to abort execution when the
property is read.

(Even if you don't like the entire suggestion, I think it should be "patches"
instead of "will patch" because this is the tense we use in the rest of the
JSDoc.)

[hub, 2018/10/29 16:34:02]

Done.

- * It will intercept the onerror callback and block it if tagged.

[Manish Jethani, 2018/10/28 21:34:05]

I don't think the onerror part is necessary, it really looks like an
implementation detail.

[hub, 2018/10/29 16:34:02]

I'll rephrase as "no error will be printed in the console".

+  if (currentDescriptor && !currentDescriptor.configurable)
+    return false;
+
+  Object.defineProperty(object, property, descriptor);
+  return true;
+}
+
+/**
+ * Patches a property on the window object to abort execution when the
+ * property is read.
+ *
+ * No error is be printed to the console.
+ *
  * The idea originates from

[Manish Jethani, 2018/10/28 21:34:05]

Since we are now using JSDoc, how about using a link?

  The idea originates from {@link [url] uBlock Origin}.

[hub, 2018/10/29 16:34:02]

Done.

- * https://github.com/uBlockOrigin/uAssets/blob/80b195436f8f8d78ba713237bfc268ecfc9d9d2b/filters/resources.txt#L1703
- *
- * @todo handle properties of properties.

[Manish Jethani, 2018/10/28 21:34:05]

I searched adblockpluscore, adblockpluschrome, and adblockplusui, and couldn't
find a single instance of @todo. I don't think we leave todo comments in the
code (but you can file an issue if you like).

[hub, 2018/10/29 16:34:03]

I'll remove it.

- *
- * @param {string} property the name of the property.

[Manish Jethani, 2018/10/28 21:34:05]

Suggestion:

  @param {string} property The name of the property.

(The description is a complete sentence, starting with a capital letter.)

[hub, 2018/10/29 16:34:02]

Done.

+ * {@link https://github.com/uBlockOrigin/uAssets/blob/80b195436f8f8d78ba713237bfc268ecfc9d9d2b/filters/resources.txt#L1703 uBlock Origin}.
+ *
+ * @param {string} property The name of the property.
  */
 function abortOnPropertyRead(property)
 {
   if (!property)
     return;
 
   let rid = randomId();
 
   function abort()
   {
     throw new ReferenceError(rid);
   }
 
   let {onerror} = window;
-  window.onerror = (message, ...rest) =>
-  {
-    if (typeof message == "string" && message.includes(rid))
-      return true;
-    if (typeof onerror == "function")
-      return (() => {}).call.call(onerror, this, message, ...rest);
-  };
-
-  wrapPropertyAccess(window, property, {get: abort, set() {}});
+  if (wrapPropertyAccess(window, property, {get: abort, set() {}}))
+  {
+    window.onerror = (message, ...rest) =>
+    {
+      if (typeof message == "string" && message.includes(rid))
+        return true;
+      if (typeof onerror == "function")
+        return (() => {}).call.call(onerror, this, message, ...rest);
+    };
+  }
 }
 
 exports["abort-on-property-read"] = makeInjector(abortOnPropertyRead,
                                                  wrapPropertyAccess,
                                                  randomId);