Issue 3200 - Delay initialization for prerendered documents

safari/ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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 169 matching lines @@
 
   var pages = Object.create(null);
   var pageCounter = 0;
 
   var Page = function(id, tab, url)
   {
     this.id = id;
     this._tab = tab;
     this._frames = [{url: new URL(url), parent: null}];
 
-    if (tab.page)
-      this._messageProxy = new ext._MessageProxy(tab.page);
-    else
-      // while the new tab page is shown on Safari 7, the 'page' property
-      // of the tab is undefined, and we can't send messages to that page
-      this._messageProxy = {
-        handleRequest: function() {},
-        handleResponse: function() {},
-        sendMessage: function() {}
-      };
-
     this.browserAction = new BrowserAction(this);
     this.contextMenus = new ContextMenus(this);

[kzar, 2017/05/19 12:33:05]

I guess we should assign this._messageProxy to undefined (or null?) here
explicitly, since the modified logic in _getMessageProxy will sometimes return
that?

[Manish Jethani, 2017/05/19 23:58:48]

Yeah, it'll always return undefined or a non-null object. I think I'll just
assign it to null just to make it clear.

   };
   Page.prototype = {
     get url()
     {
       return this._frames[0].url;
     },
     sendMessage: function(message, responseCallback)
     {
       var documentIds = [];
       for (var documentId in this._tab._documentLookup)
         if (this._tab._documentLookup[documentId].pageId == this.id)
           documentIds.push(documentId);
 
-      this._messageProxy.sendMessage(message, responseCallback,
-                                     {targetDocuments: documentIds});
+      var messageProxy = this._getMessageProxy();
+      if (messageProxy)
+      {
+        messageProxy.sendMessage(message, responseCallback,
+                                 {targetDocuments: documentIds});
+      }
+    },
+    _getMessageProxy: function()
+    {
+      // Instantiate the message proxy only if the page object is available.
+      // For prerendered documents, the page object becomes available only once
+      // the document is made visible.
+      if (!this._messageProxy && this._tab.page)
+        this._messageProxy = new ext._MessageProxy(this._tab.page);
+
+      return this._messageProxy;
+    },
+    _handleRequest: function(request, sender)
+    {
+      var messageProxy = this._getMessageProxy();
+      if (messageProxy)
+        messageProxy.handleRequest(request, sender);
+    },
+    _handleResponse: function(response)
+    {
+      var messageProxy = this._getMessageProxy();
+      if (messageProxy)
+        messageProxy.handleResponse(response);
     }
   };
 
   ext.getPage = function(id)
   {
     return pages[id];
   };
 
   var isPageActive = function(page)
   {
@@ skipping 189 matching lines @@
             var response = null;
             var sendResponse = function(message) { response = message; };
 
             ext.onMessage._dispatch(message.payload, sender, sendResponse);
 
             event.message = response;
             break;
         }
         break;
       case "request":
-        sender.page._messageProxy.handleRequest(message, sender);
+        sender.page._handleRequest(message, sender);
         break;
       case "response":
         // All documents within a page have the same pageId and that's all we
         // care about here.
         var pageId = tab._documentLookup[message.targetDocuments[0]].pageId;
-        pages[pageId]._messageProxy.handleResponse(message);
+        pages[pageId]._handleResponse(message);
         break;
       case "replaced":
         // when a prerendered page is shown, forget the previous page
         // associated with its tab, and reset the toolbar item if necessary.
         // Note that it wouldn't be sufficient to do that when the old
         // page is unloading, because Safari dispatches window.onunload
         // only when reloading the page or following links, but not when
         // the current page is replaced with a prerendered page.
         replacePage(sender.page);
         break;
@@ skipping 153 matching lines @@
   /* Windows */
   ext.windows = {
     // Safari doesn't provide as rich a windows API as Chrome does, so instead
     // of chrome.windows.create we have to fall back to just opening a new tab.
     create: function(createData, callback)
     {
       ext.pages.open(createData.url, callback);
     }
   };
 })();