Merge pull request #75 from defmethodinc/troubleshooting

Performance fixes

.gitignore

@@ -1,3 +1,4 @@
 just-not-sorry*.zip
 .idea
 node_modules
+.DS_Store

gulpfile.js

@@ -4,6 +4,8 @@ const watch = require('gulp-watch');
 const open = require('gulp-open');
 
 const filesForTest = [
+    'lib/fastdom.js',
+    'lib/fastdom-promised.js',
     'src/Warnings.js',
     'src/WarningChecker.js',
     'src/HighlightGenerator.js',

lib/fastdom-promised.js

@@ -0,0 +1,86 @@
+!(function() {
+
+    /**
+     * Wraps fastdom in a Promise API
+     * for improved control-flow.
+     *
+     * @example
+     *
+     * // returning a result
+     * fastdom.measure(() => el.clientWidth)
+     *   .then(result => ...);
+     *
+     * // returning promises from tasks
+     * fastdom.measure(() => {
+     *   var w = el1.clientWidth;
+     *   return fastdom.mutate(() => el2.style.width = w + 'px');
+     * }).then(() => console.log('all done'));
+     *
+     * // clearing pending tasks
+     * var promise = fastdom.measure(...)
+     * fastdom.clear(promise);
+     *
+     * @type {Object}
+     *
+     * (The MIT License)
+     * Copyright (c) 2016 Wilson Page [email protected]
+     *
+     * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+     *
+     * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+     *
+     * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+     */
+    var exports = {
+        initialize: function() {
+            this._tasks = new Map();
+        },
+
+        mutate: function(fn, ctx) {
+            return create(this, 'mutate', fn, ctx);
+        },
+
+        measure: function(fn, ctx) {
+            return create(this, 'measure', fn, ctx);
+        },
+
+        clear: function(promise) {
+            var tasks = this._tasks;
+            var task = tasks.get(promise);
+            this.fastdom.clear(task);
+            tasks.delete(promise);
+        }
+    };
+
+    /**
+     * Create a fastdom task wrapped in
+     * a 'cancellable' Promise.
+     *
+     * @param  {FastDom}  fastdom
+     * @param  {String}   type - 'measure'|'muatate'
+     * @param  {Function} fn
+     * @return {Promise}
+     */
+    function create(promised, type, fn, ctx) {
+        var tasks = promised._tasks;
+        var fastdom = promised.fastdom;
+        var task;
+
+        var promise = new Promise(function(resolve, reject) {
+            task = fastdom[type](function() {
+                tasks.delete(promise);
+                try { resolve(ctx ? fn.call(ctx) : fn()); }
+                catch (e) { reject(e); }
+            }, ctx);
+        });
+
+        tasks.set(promise, task);
+        return promise;
+    }
+
+// Expose to CJS, AMD or global
+    if ((typeof define)[0] == 'f') define(function() { return exports; });
+    else if ((typeof module)[0] == 'o') module.exports = exports;
+    else window.fastdomPromised = exports;
+
+})();

lib/fastdom.js

@@ -0,0 +1,253 @@
+!(function(win) {
+
+/**
+ * FastDom
+ *
+ * Eliminates layout thrashing
+ * by batching DOM read/write
+ * interactions.
+ *
+ * @author Wilson Page <[email protected]>
+ * @author Kornel Lesinski <[email protected]>
+ *
+ * (The MIT License)
+ * Copyright (c) 2016 Wilson Page [email protected]
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+'use strict';
+
+/**
+ * Mini logger
+ *
+ * @return {Function}
+ */
+var debug = 0 ? console.log.bind(console, '[fastdom]') : function() {};
+
+/**
+ * Normalized rAF
+ *
+ * @type {Function}
+ */
+var raf = win.requestAnimationFrame
+  || win.webkitRequestAnimationFrame
+  || win.mozRequestAnimationFrame
+  || win.msRequestAnimationFrame
+  || function(cb) { return setTimeout(cb, 16); };
+
+/**
+ * Initialize a `FastDom`.
+ *
+ * @constructor
+ */
+function FastDom() {
+  var self = this;
+  self.reads = [];
+  self.writes = [];
+  self.raf = raf.bind(win); // test hook
+  debug('initialized', self);
+}
+
+FastDom.prototype = {
+  constructor: FastDom,
+
+  /**
+   * We run this inside a try catch
+   * so that if any jobs error, we
+   * are able to recover and continue
+   * to flush the batch until it's empty.
+   *
+   * @param {Array} tasks
+   */
+  runTasks: function(tasks) {
+    debug('run tasks');
+    var task; while (task = tasks.shift()) task();
+  },
+
+  /**
+   * Adds a job to the read batch and
+   * schedules a new frame if need be.
+   *
+   * @param  {Function} fn
+   * @param  {Object} ctx the context to be bound to `fn` (optional).
+   * @public
+   */
+  measure: function(fn, ctx) {
+    debug('measure');
+    var task = !ctx ? fn : fn.bind(ctx);
+    this.reads.push(task);
+    scheduleFlush(this);
+    return task;
+  },
+
+  /**
+   * Adds a job to the
+   * write batch and schedules
+   * a new frame if need be.
+   *
+   * @param  {Function} fn
+   * @param  {Object} ctx the context to be bound to `fn` (optional).
+   * @public
+   */
+  mutate: function(fn, ctx) {
+    debug('mutate');
+    var task = !ctx ? fn : fn.bind(ctx);
+    this.writes.push(task);
+    scheduleFlush(this);
+    return task;
+  },
+
+  /**
+   * Clears a scheduled 'read' or 'write' task.
+   *
+   * @param {Object} task
+   * @return {Boolean} success
+   * @public
+   */
+  clear: function(task) {
+    debug('clear', task);
+    return remove(this.reads, task) || remove(this.writes, task);
+  },
+
+  /**
+   * Extend this FastDom with some
+   * custom functionality.
+   *
+   * Because fastdom must *always* be a
+   * singleton, we're actually extending
+   * the fastdom instance. This means tasks
+   * scheduled by an extension still enter
+   * fastdom's global task queue.
+   *
+   * The 'super' instance can be accessed
+   * from `this.fastdom`.
+   *
+   * @example
+   *
+   * var myFastdom = fastdom.extend({
+   *   initialize: function() {
+   *     // runs on creation
+   *   },
+   *
+   *   // override a method
+   *   measure: function(fn) {
+   *     // do extra stuff ...
+   *
+   *     // then call the original
+   *     return this.fastdom.measure(fn);
+   *   },
+   *
+   *   ...
+   * });
+   *
+   * @param  {Object} props  properties to mixin
+   * @return {FastDom}
+   */
+  extend: function(props) {
+    debug('extend', props);
+    if (typeof props != 'object') throw new Error('expected object');
+
+    var child = Object.create(this);
+    mixin(child, props);
+    child.fastdom = this;
+
+    // run optional creation hook
+    if (child.initialize) child.initialize();
+
+    return child;
+  },
+
+  // override this with a function
+  // to prevent Errors in console
+  // when tasks throw
+  catch: null
+};
+
+/**
+ * Schedules a new read/write
+ * batch if one isn't pending.
+ *
+ * @private
+ */
+function scheduleFlush(fastdom) {
+  if (!fastdom.scheduled) {
+    fastdom.scheduled = true;
+    fastdom.raf(flush.bind(null, fastdom));
+    debug('flush scheduled');
+  }
+}
+
+/**
+ * Runs queued `read` and `write` tasks.
+ *
+ * Errors are caught and thrown by default.
+ * If a `.catch` function has been defined
+ * it is called instead.
+ *
+ * @private
+ */
+function flush(fastdom) {
+  debug('flush');
+
+  var writes = fastdom.writes;
+  var reads = fastdom.reads;
+  var error;
+
+  try {
+    debug('flushing reads', reads.length);
+    fastdom.runTasks(reads);
+    debug('flushing writes', writes.length);
+    fastdom.runTasks(writes);
+  } catch (e) { error = e; }
+
+  fastdom.scheduled = false;
+
+  // If the batch errored we may still have tasks queued
+  if (reads.length || writes.length) scheduleFlush(fastdom);
+
+  if (error) {
+    debug('task errored', error.message);
+    if (fastdom.catch) fastdom.catch(error);
+    else throw error;
+  }
+}
+
+/**
+ * Remove an item from an Array.
+ *
+ * @param  {Array} array
+ * @param  {*} item
+ * @return {Boolean}
+ */
+function remove(array, item) {
+  var index = array.indexOf(item);
+  return !!~index && !!array.splice(index, 1);
+}
+
+/**
+ * Mixin own properties of source
+ * object into the target.
+ *
+ * @param  {Object} target
+ * @param  {Object} source
+ */
+function mixin(target, source) {
+  for (var key in source) {
+    if (source.hasOwnProperty(key)) target[key] = source[key];
+  }
+}
+
+// There should never be more than
+// one instance of `FastDom` in an app
+var exports = win.fastdom = (win.fastdom || new FastDom()); // jshint ignore:line
+
+// Expose to CJS & AMD
+if ((typeof define) == 'function') define(function() { return exports; });
+else if ((typeof module) == 'object') module.exports = exports;
+
+})( typeof window !== 'undefined' ? window : this);

manifest.json

@@ -3,7 +3,7 @@
   "name": "Just Not Sorry -- the Gmail Plug-in",
   "short_name": "JustNotSorry",
   "author": "Steve Brudz, Manish Kakwani, Tami Reiss, and Eric Tillberg of Def Method",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "description": "A Gmail Plug-in that warns you when you write emails using words which undermine your message",
   "icons": { "16": "img/JustNotSorry-16.png",
              "48": "img/JustNotSorry-48.png",
@@ -35,6 +35,8 @@
   },
   "web_accessible_resources": [
     "lib/dom-regexp-match-1.1.0.js",
+    "lib/fastdom.js",
+    "lib/fastdom-promised.js",
     "src/HighlightGenerator.js",
     "src/WarningChecker.js",
     "src/Warnings.js",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "just-not-sorry",
   "description": "Gmail Plug-in that warns you when you write emails using words which undermine your message",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "author": "Steve Brudz, Manish Kakwani, Tami Reiss, and Eric Tillberg of Def Method",
   "license": "MIT",
   "repository": "https://github.com/defmethodinc/just-not-sorry",