Ticket #139: remove_timeline.patch

lib/contentPolicy.js

@@ -22 +22 @@
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
-let {TimeLine} = require("timeline");
 let {Utils} = require("utils");
 let {Prefs} = require("prefs");
 let {FilterStorage} = require("filterStorage");
@@ -90 +89 @@
    */
   init: function()
   {
-    TimeLine.enter("Entered content policy initialization");
-
     // type constant by type description and type description by type constant
     let iface = Ci.nsIContentPolicy;
     for (let typeName of contentTypes)
@@ -120 +117 @@
     for (let scheme of Prefs.whitelistschemes.toLowerCase().split(" "))
       this.whitelistSchemes[scheme] = true;
 
-    TimeLine.log("done initializing types");
-
     // Generate class identifier used to collapse node and register corresponding
     // stylesheet.
-    TimeLine.log("registering global stylesheet");
-
     let offset = "a".charCodeAt(0);
     for (let i = 0; i < 20; i++)
       collapsedClass +=  String.fromCharCode(offset + Math.random() * 26);
@@ -138 +131 @@
     {
       Utils.styleService.unregisterSheet(collapseStyle, Ci.nsIStyleSheetService.USER_SHEET);
     })
-    TimeLine.log("done registering stylesheet");
-
-    TimeLine.leave("Done initializing content policy");
   },
 
   /**

lib/elemHide.js

@@ -27 +27 @@
 let {ElemHideException} = require("filterClasses");
 let {FilterNotifier} = require("filterNotifier");
 let {AboutHandler} = require("elemHideHitRegistration");
-let {TimeLine} = require("timeline");
 
 /**
  * Lookup table, filters by their associated key
@@ -82 +81 @@
    */
   init: function()
   {
-    TimeLine.enter("Entered ElemHide.init()");
     Prefs.addListener(function(name)
     {
       if (name == "enabled")
@@ -93 +91 @@
       ElemHide.unapply();
     });
 
-    TimeLine.log("done adding prefs listener");
-
     let styleFile = IO.resolveFilePath(Prefs.data_directory);
     styleFile.append("elemhide.css");
     styleURL = Services.io.newFileURI(styleFile).QueryInterface(Ci.nsIFileURL);
-    TimeLine.log("done determining stylesheet URL");
-
-    TimeLine.leave("ElemHide.init() done");
   },
 
   /**
@@ -220 +213 @@
       return;
     }
 
-    TimeLine.enter("Entered ElemHide.apply()");
-
     if (!ElemHide.isDirty || !Prefs.enabled)
     {
       // Nothing changed, looks like we merely got enabled/disabled
@@ -236 +227 @@
         {
           Cu.reportError(e);
         }
-        TimeLine.log("Applying existing stylesheet finished");
       }
       else if (!Prefs.enabled && ElemHide.applied)
       {
         ElemHide.unapply();
-        TimeLine.log("ElemHide.unapply() finished");
       }
 
-      TimeLine.leave("ElemHide.apply() done (no file changes)");
       return;
     }
 
     IO.writeToFile(styleURL.file, this._generateCSSContent(), function(e)
     {
-      TimeLine.enter("ElemHide.apply() write callback");
       this._applying = false;
 
       // _generateCSSContent is throwing NS_ERROR_NOT_AVAILABLE to indicate that
@@ -275 +262 @@
         ElemHide.isDirty = false;
 
         ElemHide.unapply();
-        TimeLine.log("ElemHide.unapply() finished");
 
         if (!noFilters)
         {
@@ -288 +274 @@
           {
             Cu.reportError(e);
           }
-          TimeLine.log("Applying stylesheet finished");
         }
 
         FilterNotifier.triggerListeners("elemhideupdate");
       }
-      TimeLine.leave("ElemHide.apply() write callback done");
     }.bind(this), "ElemHideWrite");
 
     this._applying = true;
 
-    TimeLine.leave("ElemHide.apply() done", "ElemHideWrite");
   },
 
   _generateCSSContent: function()
   {
     // Grouping selectors by domains
-    TimeLine.log("start grouping selectors");
     let domains = {__proto__: null};
     let hasFilters = false;
     for (let key in filterByKey)
@@ -323 +305 @@
       list[filter.selector] = key;
       hasFilters = true;
     }
-    TimeLine.log("done grouping selectors");
 
     if (!hasFilters)
       throw Cr.NS_ERROR_NOT_AVAILABLE;

lib/filterListener.js

@@ -22 +22 @@
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
-let {TimeLine} = require("timeline");
 let {FilterStorage} = require("filterStorage");
 let {FilterNotifier} = require("filterNotifier");
 let {ElemHide} = require("elemHide");
@@ -103 +102 @@
  */
 function init()
 {
-  TimeLine.enter("Entered filter listener initialization()");
-
   FilterNotifier.addListener(function(action, item, newValue, oldValue)
   {
     let match = /^(\w+)\.(.*)/.exec(action);
@@ -122 +119 @@
     flushElemHide = function() {};    // No global stylesheet in Chrome & Co.
   FilterStorage.loadFromDisk();
 
-  TimeLine.log("done initializing data structures");
-
   Services.obs.addObserver(HistoryPurgeObserver, "browser:purge-session-history", true);
   onShutdown.add(function()
   {
     Services.obs.removeObserver(HistoryPurgeObserver, "browser:purge-session-history");
   });
-  TimeLine.log("done adding observers");
-
-  TimeLine.leave("Filter listener initialization done");
 }
 init();
 

lib/filterStorage.js

@@ -29 +29 @@
 let {Subscription, SpecialSubscription, ExternalSubscription} = require("subscriptionClasses");
 let {FilterNotifier} = require("filterNotifier");
 let {Utils} = require("utils");
-let {TimeLine} = require("timeline");
 
 /**
  * Version number of the filter storage file format.
@@ -365 +364 @@
     if (this._loading)
       return;
 
-    TimeLine.enter("Entered FilterStorage.loadFromDisk()");
     this._loading = true;
 
     let readFile = function(sourceFile, backupIndex)
     {
-      TimeLine.enter("FilterStorage.loadFromDisk() -> readFile()");
 
       let parser = new INIParser();
       IO.readFromFile(sourceFile, parser, function(e)
       {
-        TimeLine.enter("FilterStorage.loadFromDisk() read callback");
         if (!e && parser.subscriptions.length == 0)
         {
           // No filter subscriptions in the file, this isn't right.
@@ -403 +399 @@
               else
                 doneReading(parser);
             });
-            TimeLine.leave("FilterStorage.loadFromDisk() read callback done");
             return;
           }
         }
         doneReading(parser);
       }.bind(this), "FilterStorageRead");
 
-      TimeLine.leave("FilterStorage.loadFromDisk() <- readFile()", "FilterStorageRead");
     }.bind(this);
 
     var doneReading = function(parser)
@@ -441 +435 @@
           this.addFilter(filter, null, undefined, true);
         }
       }
-      TimeLine.log("Initializing data done, triggering observers")
 
       this._loading = false;
       FilterNotifier.triggerListeners("load");
@@ -449 +442 @@
       if (sourceFile != this.sourceFile)
         this.saveToDisk();
 
-      TimeLine.leave("FilterStorage.loadFromDisk() read callback done");
     }.bind(this);
 
     let explicitFile;
@@ -471 +463 @@
           this._loading = false;
           FilterNotifier.triggerListeners("load");
 
-          TimeLine.leave("FilterStorage.loadFromDisk() read callback done");
         }
         else
           readFile(sourceFile, 0);
@@ -483 +474 @@
         callback(true);
     }
 
-    TimeLine.leave("FilterStorage.loadFromDisk() done");
   },
 
   _generateFilterData: function(subscriptions)
@@ -565 +555 @@
       return;
     }
 
-    TimeLine.enter("Entered FilterStorage.saveToDisk()");
-
     // Make sure the file's parent directory exists
     try {
       targetFile.parent.create(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);
@@ -574 +562 @@
 
     let writeFilters = function()
     {
-      TimeLine.enter("FilterStorage.saveToDisk() -> writeFilters()");
       IO.writeToFile(targetFile, this._generateFilterData(subscriptions), function(e)
       {
-        TimeLine.enter("FilterStorage.saveToDisk() write callback");
         if (!explicitFile)
           this._saving = false;
 
@@ -591 +577 @@
         }
         else
           FilterNotifier.triggerListeners("save");
-        TimeLine.leave("FilterStorage.saveToDisk() write callback done");
       }.bind(this), "FilterStorageWrite");
-      TimeLine.leave("FilterStorage.saveToDisk() -> writeFilters()", "FilterStorageWrite");
     }.bind(this);
 
     let checkBackupRequired = function(callbackNotRequired, callbackRequired)
@@ -625 +609 @@
 
     let removeLastBackup = function(part1, part2)
     {
-      TimeLine.enter("FilterStorage.saveToDisk() -> removeLastBackup()");
       let file = targetFile.clone();
       file.leafName = part1 + "-backup" + Prefs.patternsbackups + part2;
       IO.removeFile(file, function(e) renameBackup(part1, part2, Prefs.patternsbackups - 1));
-      TimeLine.leave("FilterStorage.saveToDisk() <- removeLastBackup()");
     }.bind(this);
 
     let renameBackup = function(part1, part2, index)
     {
-      TimeLine.enter("FilterStorage.saveToDisk() -> renameBackup()");
       if (index > 0)
       {
         let fromFile = targetFile.clone();
@@ -651 +632 @@
 
         IO.copyFile(targetFile, toFile, writeFilters);
       }
-      TimeLine.leave("FilterStorage.saveToDisk() <- renameBackup()");
     }.bind(this);
 
     // Do not persist external subscriptions
@@ -661 +641 @@
 
     checkBackupRequired(writeFilters, removeLastBackup);
 
-    TimeLine.leave("FilterStorage.saveToDisk() done");
   },
 
   /**

lib/io.js

@@ -24 +24 @@
 let {OS} = Cu.import("resource://gre/modules/osfile.jsm", null);
 let {Task} = Cu.import("resource://gre/modules/Task.jsm", null);
 
-let {TimeLine} = require("timeline");
 let {Utils} = require("utils");
 
 const BUFFER_SIZE = 0x8000;  // 32kB
@@ -69 +68 @@
    * each line read and with a null parameter once the read operation is done.
    * The callback will be called when the operation is done.
    */
-  readFromFile: function(/**nsIFile*/ file, /**Object*/ listener, /**Function*/ callback, /**String*/ timeLineID)
+  readFromFile: function(/**nsIFile*/ file, /**Object*/ listener, /**Function*/ callback)
   {
     try
     {
@@ -80 +79 @@
 
       let onProgress = function(data)
       {
-        if (timeLineID)
-        {
-          TimeLine.asyncStart(timeLineID);
-        }
 
         let index = (processing ? -1 : Math.max(data.lastIndexOf("\n"), data.lastIndexOf("\r")));
         if (index >= 0)
@@ -125 +120 @@
         else
           buffer += data;
 
-        if (timeLineID)
-        {
-          TimeLine.asyncEnd(timeLineID);
-        }
       };
 
       let onSuccess = function()
@@ -140 +131 @@
           return;
         }
 
-        if (timeLineID)
-        {
-          TimeLine.asyncStart(timeLineID);
-        }
-
         if (buffer !== "")
           listener.process(buffer);
         listener.process(null);
 
-        if (timeLineID)
-        {
-          TimeLine.asyncEnd(timeLineID);
-          TimeLine.asyncDone(timeLineID);
-        }
-
         callback(null);
       };
 
@@ -169 +149 @@
 
         callback(e);
 
-        if (timeLineID)
-        {
-          TimeLine.asyncDone(timeLineID);
-        }
       };
 
       let decoder = new TextDecoder();
@@ -206 +182 @@
    * Writes string data to a file in UTF-8 format asynchronously. The callback
    * will be called when the write operation is done.
    */
-  writeToFile: function(/**nsIFile*/ file, /**Iterator*/ data, /**Function*/ callback, /**String*/ timeLineID)
+  writeToFile: function(/**nsIFile*/ file, /**Iterator*/ data, /**Function*/ callback)
   {
     try
     {

lib/main.js

@@ -22 +22 @@
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
-let {TimeLine} = require("timeline");
-
-TimeLine.enter("Adblock Plus startup");
 registerPublicAPI();
-TimeLine.log("Done registering public API");
 require("filterListener");
-TimeLine.log("Done loading filter listener");
 require("contentPolicy");
-TimeLine.log("Done loading content policy");
 require("synchronizer");
-TimeLine.log("Done loading subscription synchronizer");
 require("notification");
-TimeLine.log("Done loading notification downloader");
 require("sync");
-TimeLine.log("Done loading sync support");
 require("ui");
-TimeLine.log("Done loading UI integration code");
-TimeLine.leave("Started up");
 
 function registerPublicAPI()
 {

lib/notification.js

@@ -21 +21 @@
 
 Cu.import("resource://gre/modules/Services.jsm");
 
-let {TimeLine} = require("timeline");
 let {Prefs} = require("prefs");
 let {Downloader, Downloadable, MILLIS_IN_MINUTE, MILLIS_IN_HOUR, MILLIS_IN_DAY} = require("downloader");
 let {Utils} = require("utils");
@@ -81 +80 @@
    */
   init: function()
   {
-    TimeLine.enter("Entered Notification.init()");
-
     downloader = new Downloader(this._getDownloadables.bind(this), INITIAL_DELAY, CHECK_INTERVAL);
     onShutdown.add(function()
     {
@@ -92 +89 @@
     downloader.onExpirationChange = this._onExpirationChange.bind(this);
     downloader.onDownloadSuccess = this._onDownloadSuccess.bind(this);
     downloader.onDownloadError = this._onDownloadError.bind(this);
-
-    TimeLine.leave("Notification.init() done");
   },
 
   /**

lib/synchronizer.js

@@ -22 +22 @@
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
-let {TimeLine} = require("timeline");
 let {Downloader, Downloadable,
     MILLIS_IN_SECOND, MILLIS_IN_MINUTE, MILLIS_IN_HOUR, MILLIS_IN_DAY} = require("downloader");
 let {Filter, CommentFilter} = require("filterClasses");
@@ -54 +53 @@
    */
   init: function()
   {
-    TimeLine.enter("Entered Synchronizer.init()");
-
     downloader = new Downloader(this._getDownloadables.bind(this), INITIAL_DELAY, CHECK_INTERVAL);
     onShutdown.add(function()
     {
@@ -66 +63 @@
     downloader.onDownloadStarted = this._onDownloadStarted.bind(this);
     downloader.onDownloadSuccess = this._onDownloadSuccess.bind(this);
     downloader.onDownloadError = this._onDownloadError.bind(this);
-
-    TimeLine.leave("Synchronizer.init() done");
   },
 
   /**

deleted file lib/timeline.js

@@ -1 @@
-/*
- * This file is part of Adblock Plus <http://adblockplus.org/>,
- * Copyright (C) 2006-2014 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
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * @fileOverview Debugging module used for load time measurements.
- */
-
-let nestingCounter = 0;
-let firstTimeStamp = null;
-let lastTimeStamp = null;
-
-let asyncActions = {__proto__: null};
-
-/**
- * Time logging module, used to measure startup time of Adblock Plus (development builds only).
- * @class
- */
-let TimeLine = exports.TimeLine = {
-  /**
-   * Logs an event to console together with the time it took to get there.
-   */
-  log: function(/**String*/ message, /**Boolean*/ _forceDisplay)
-  {
-    if (!_forceDisplay && nestingCounter <= 0)
-      return;
-
-    let now = Date.now();
-    let diff = lastTimeStamp ? Math.round(now - lastTimeStamp) : "first event";
-    lastTimeStamp = now;
-
-    // Indent message depending on current nesting level
-    for (let i = 0; i < nestingCounter; i++)
-      message = "* " + message;
-
-    // Pad message with spaces
-    let padding = [];
-    for (let i = message.toString().length; i < 80; i++)
-      padding.push(" ");
-    dump("[" + now + "] ABP timeline: " + message + padding.join("") + "\t (" + diff + ")\n");
-  },
-
-  /**
-   * Called to indicate that application entered a block that needs to be timed.
-   */
-  enter: function(/**String*/ message)
-  {
-    if (nestingCounter <= 0)
-      firstTimeStamp = Date.now();
-
-    this.log(message, true);
-    nestingCounter = (nestingCounter <= 0 ? 1 : nestingCounter + 1);
-  },
-
-  /**
-   * Called when application exited a block that TimeLine.enter() was called for.
-   * @param {String} message  message to be logged
-   * @param {String} [asyncAction]  identifier of a pending async action
-   */
-  leave: function(message, asyncAction)
-  {
-    if (typeof asyncAction != "undefined")
-      message += " (async action pending)";
-
-    nestingCounter--;
-    this.log(message, true);
-
-    if (nestingCounter <= 0)
-    {
-      if (firstTimeStamp !== null)
-        dump("ABP timeline: Total time elapsed: " + Math.round(Date.now() - firstTimeStamp) + "\n");
-      firstTimeStamp = null;
-      lastTimeStamp = null;
-    }
-
-    if (typeof asyncAction != "undefined")
-    {
-      if (asyncAction in asyncActions)
-        dump("ABP timeline: Warning: Async action " + asyncAction + " already executing\n");
-      asyncActions[asyncAction] = {start: Date.now(), total: 0};
-    }
-  },
-
-  /**
-   * Called when the application starts processing of an async action.
-   */
-  asyncStart: function(/**String*/ asyncAction)
-  {
-    if (asyncAction in asyncActions)
-    {
-      let action = asyncActions[asyncAction];
-      if ("currentStart" in action)
-        dump("ABP timeline: Warning: Processing reentered for async action " + asyncAction + "\n");
-      action.currentStart = Date.now();
-    }
-    else
-      dump("ABP timeline: Warning: Async action " + asyncAction + " is unknown\n");
-  },
-
-  /**
-   * Called when the application finishes processing of an async action.
-   */
-  asyncEnd: function(/**String*/ asyncAction)
-  {
-    if (asyncAction in asyncActions)
-    {
-      let action = asyncActions[asyncAction];
-      if ("currentStart" in action)
-      {
-        action.total += Date.now() - action.currentStart;
-        delete action.currentStart;
-      }
-      else
-        dump("ABP timeline: Warning: Processing not entered for async action " + asyncAction + "\n");
-    }
-    else
-      dump("ABP timeline: Warning: Async action " + asyncAction + " is unknown\n");
-  },
-
-  /**
-   * Called when an async action is done and its time can be logged.
-   */
-  asyncDone: function(/**String*/ asyncAction)
-  {
-    if (asyncAction in asyncActions)
-    {
-      let action = asyncActions[asyncAction];
-      let now = Date.now();
-      let diff = now - action.start;
-      if ("currentStart" in action)
-        dump("ABP timeline: Warning: Still processing for async action " + asyncAction + "\n");
-
-      let message = "Async action " + asyncAction + " done";
-      let padding = [];
-      for (let i = message.toString().length; i < 80; i++)
-        padding.push(" ");
-      dump("[" + now + "] ABP timeline: " + message + padding.join("") + "\t (" + action.total + "/" + diff + ")\n");
-    }
-    else
-      dump("ABP timeline: Warning: Async action " + asyncAction + " is unknown\n");
-  }
-};