change: replace browserify-incremental w/rebundler

browserify-incremental doesn’t work with multiple bundles compiled at
the same time. This makes it very unreliable and can produce very hard
to trace errors in client-side code. This uses rebundler instead, which,
as long as it’s given the `persistKey` option, doesn’t have the same
problem.

Author: joeybaker

README.md

@@ -117,7 +117,7 @@ If `true`, minifies source code and sets debug to true. If object, passed as opt
 If `true`, [watchify](https://github.com/substack/watchify) will be used to create a file watcher and speed up subsequent builds.
 
 #### opts.cache
-If truthy, will use [browserify-incremental](https://github.com/jsdf/browserify-incremental) to cache the result of a build. This can give you dramatically faster build times if you're not using `opts.watch`.
+If truthy, will use [rebundler](https://github.com/bjoerge/rebundler) to cache the result of a build. This can give you dramatically faster build times if you're not using `opts.watch`.
 
 If `opts.cache` is a string, it will be used as the file path to save the cache file to.
 

index.js

@@ -1,9 +1,10 @@
 'use strict'
 
 var browserify = require('browserify')
-  , browserifyInc = require('browserify-incremental')
+  , rebundler = require('rebundler')
   , path = require('path')
   , fs = require('fs')
+  , md5 = require('MD5')
   , events = require('events')
   , mkdirp = require('mkdirp')
   , watchify = require('watchify')
@@ -30,6 +31,8 @@ ctor = module.exports = function atomifyJs (opts, cb) {
     , _outputcb
     , _buffercb
     , browserifyOptions
+    , persistKey
+    , cacheChecker
     , transforms
     , assets
     , outputs
@@ -90,25 +93,33 @@ ctor = module.exports = function atomifyJs (opts, cb) {
   // remove the default 600ms delay because speed is tood
   // ignoreWatch to true to ignore node_modules
   if (opts.watch) _.extend({delay: 0, ignoreWatch: true}, browserifyOptions, watchify.args)
-  // mixin the required browserifyInc options if we need to cache
-  if (opts.cache) _.extend(browserifyOptions, browserifyInc.args)
-
-  b = browserify(browserifyOptions)
 
   if (opts.cache) {
-    b = browserifyInc(b
-      , _.isString(opts.cache) ? {cacheFile: opts.cache} : {}
-    )
+    persistKey = md5(opts.entry || opts.entries.toString() || opts.require.toString())
+
+    b = browserify(_.extend(browserifyOptions, {
+      fullPaths: true
+    }))
+    emitter.emit('browserify', b)
+
+    cacheChecker = rebundler({persist: true, persistKey: persistKey, cacheDir: typeof opts.cache === 'string' ? opts.cache : null}, function rebundle (cache, packageCache) {
+      b._mdeps.cache = {
+        deps: cache
+        , pkgs: packageCache
+        , mtimes: b._mdeps.cache.mtimes
+      }
+      return b
+    })
+  }
+  else {
+    b = browserify(browserifyOptions)
+    emitter.emit('browserify', b)
   }
-
-  emitter.emit('browserify', b)
 
   if (opts.watch) {
     w = watchify(b)
     emitter.emit('watchify', w)
-  }
 
-  if (opts.watch) {
     w.on('update', function onUpdate (ids) {
       ids.forEach(function eachId (id) {
         emitter.emit('changed', id)
@@ -225,7 +236,7 @@ ctor = module.exports = function atomifyJs (opts, cb) {
     })
 
     // we need to wrap the callback to output an object with all the bundles
-    return b.bundle(function bundledWithCommon (err, common) {
+    return (opts.cache ? cacheChecker() : b).bundle(function bundledWithCommon (err, common) {
       var hasCallback = _.isFunction(cb)
         , out = {}
 
@@ -249,7 +260,7 @@ ctor = module.exports = function atomifyJs (opts, cb) {
     })
   }
   // if we don't need to use factor bundle, just browserify!
-  else return b.bundle(cb)
+  else return (opts.cache ? cacheChecker() : b).bundle(cb)
 }
 
 ctor.emitter = emitter

package.json

@@ -39,7 +39,6 @@
     "babelify": "^6.1.2",
     "brfs": "^1.4.0",
     "browserify": "^7.1.0",
-    "browserify-incremental": "^1.5.0",
     "ejsify": "^1.0.0",
     "envify": "^3.4.0",
     "factor-bundle": "^2.4.1",

test/cache.js

@@ -8,19 +8,20 @@ var test = require('tape')
   , outputPath = path.join(entryPath, 'output')
   , changerPath = path.join(outputPath, 'changer.js')
   , mkdirp = require('mkdirp')
-  , cachePath = path.join(outputPath, 'cache.json')
-  , setup = function setup(value){
+  , cacheDir = path.join(outputPath, 'cache')
+  , rimraf = require('rimraf')
+  , setup = function setup (value) {
     var file = 'module.exports = ' + value || Date.now()
 
     mkdirp.sync(outputPath)
+    mkdirp.sync(cacheDir)
     fs.writeFileSync(changerPath, file)
   }
 
-test('opts.cache', function(t){
-  var parseTime = function parseTime(logMsg){
-    return parseFloat(logMsg.replace(/.*?\(([0-9\.]{1,}) seconds\)/, '$1'))
-  }
-
+test('opts.cache', function (t) {
+  var startTime = Date.now()
+    , runTests
+    , b
   setup()
 
   t.plan(5)
@@ -30,117 +31,120 @@ test('opts.cache', function(t){
     , 'should throw if opts.watch is also set'
   )
 
-  lib.emitter.once('browserify', function (b){
-    b.once('log', function(msg){
-      var initialTime = parseTime(msg)
+  lib.emitter.once('browserify', function (br) {
+    b = br
+  })
 
-      t.ok(
-        msg
-        , 'compiles once'
-      )
+  runTests = function () {
+    var firstBundleTime = Date.now()
+      , firstBundleDuration = firstBundleTime - startTime
+
+    t.ok(
+      firstBundleDuration
+      , 'compiles once'
+    )
 
-      b.bundle()
-      b.once('log', function(msg2){
-        var secondTime = parseTime(msg2)
+    b.bundle(function () {
+      var secondBundleTime = Date.now()
+        , secondBundleDuration = secondBundleTime - firstBundleTime
 
+      // wait for 1000ms, b/c rebundler does
+      setTimeout(function () {
         // wait for the second callback because some fs are slow. (linux)
         t.ok(
-          fs.existsSync(cachePath)
+          fs.existsSync(cacheDir)
           , 'writes the cache file'
         )
 
         // cleanup
-        fs.unlinkSync(cachePath)
+        rimraf.sync(cacheDir)
+      }, 1050)
 
-        t.ok(
-          msg2
-          , 'compiles a second time'
-        )
+      t.ok(
+        secondBundleDuration
+        , 'compiles a second time'
+      )
 
-        t.ok(
-          secondTime <= initialTime
-          , 'the second of ' + secondTime + ' compiles faster than ' + initialTime
-        )
-      })
+      t.ok(
+        secondBundleDuration <= firstBundleDuration
+        , 'the second bundle time of ' + secondBundleDuration + ' compiles faster than the initial ' + firstBundleDuration
+      )
     })
-  })
+  }
 
-  lib({cache: cachePath, entry: path.join(entryPath, 'index.js')})
+  lib({cache: cacheDir, entry: path.join(entryPath, 'index.js')}, runTests)
 })
 
-test('opts.cache works with opts.common', function(t){
-  var parseTime = function parseTime(logMsg){
-      return parseFloat(logMsg.replace(/.*?\(([0-9\.]{1,}) seconds\)/, '$1'))
-    }
+test('opts.cache works with opts.common', function (t) {
+  var startTime = Date.now()
     , bundleNames = ['common', 'dep-1', 'dep-2', 'index']
+    , runTests
     , b
 
   setup()
 
-  t.plan(6 + bundleNames.length)
+  t.plan(5 + bundleNames.length)
 
   t.throws(
     lib.bind(null, {watch: true, cache: true})
     , 'should throw if opts.watch is also set'
   )
 
-  lib.emitter.once('browserify', function (browserifyInstance){
+  lib.emitter.once('browserify', function (browserifyInstance) {
     b = browserifyInstance
-    b.once('log', function(msg){
-      var initialTime = parseTime(msg)
+  })
+
+  runTests = function (err, bundles) {
+    var bundleKeys = Object.keys(bundles)
+      , firstBundleTime = Date.now()
+      , firstBundleDuration = firstBundleTime - startTime
 
+    t.error(err, 'should not error')
+
+    bundleNames.forEach(function ensureEachBundleExists (bundleName) {
       t.ok(
-        msg
-        , 'compiles once'
+        bundleKeys.indexOf(bundleName) > -1
+        , 'creates the ' + bundleName + ' bundle'
       )
+    })
 
-      b.once('log', function(msg2){
-        var secondTime = parseTime(msg2)
+    t.ok(
+      firstBundleTime
+      , 'compiles once'
+    )
 
-        // wait for the second callback because some fs are slow. (linux)
-        t.ok(
-          fs.existsSync(cachePath)
-          , 'writes the cache file'
-        )
+    // trigger another bundle so that we can time the difference
+    b.bundle(function () {
+      var secondBundleTime = Date.now()
+        , secondBundleDuration = secondBundleTime - firstBundleTime
 
+      // wait for 1000ms, b/c rebundler does
+      setTimeout(function () {
         // cleanup
-        fs.unlinkSync(cachePath)
+        if (fs.existsSync(cacheDir)) rimraf.sync(cacheDir)
+      }, 1020)
 
-        t.ok(
-          msg2
-          , 'compiles a second time'
-        )
+      t.ok(
+        secondBundleDuration
+        , 'compiles a second time'
+      )
 
-        t.ok(
-          secondTime <= initialTime
-          , 'the second of ' + secondTime + ' compiles faster than ' + initialTime
-        )
-      })
+      t.ok(
+        secondBundleDuration <= firstBundleDuration
+        , 'the second bundle time of ' + secondBundleDuration + ' compiles faster than the initial ' + firstBundleDuration
+      )
     })
-  })
+  }
 
   lib({
-    cache: cachePath
+    cache: cacheDir
     , entries: [
       path.join(entryPath, 'index.js')
       , path.join(entryPath, '..', 'entry', 'dep-2.js')
       , path.join(entryPath, '..', 'entry', 'dep-1.js')
     ]
     , common: true
     , debug: true
-    }
-  , function(err, bundles){
-    var bundleKeys = Object.keys(bundles)
-    t.error(err, 'should not error')
-
-    bundleNames.forEach(function ensureEachBundleExists(bundleName){
-      t.ok(
-        bundleKeys.indexOf(bundleName) > -1
-        , 'creates the ' + bundleName + ' bundle'
-      )
-    })
-
-    // trigger another bundle so that we can time the difference
-    b.bundle()
-  })
+  }
+  , runTests)
 })