Merge pull request #790 from strongloop/feature/merge-phases

Simplify `app.defineMiddlewarePhases`

lib/server-app.js

@@ -84,44 +84,11 @@ proto.middlewareFromConfig = function(factory, config) {
  */
 proto.defineMiddlewarePhases = function(nameOrArray) {
   this.lazyrouter();
-  if (!Array.isArray(nameOrArray)) {
+
+  if (Array.isArray(nameOrArray)) {
+    this._requestHandlingPhases.zipMerge(nameOrArray);
+  } else {
     this._requestHandlingPhases.addBefore('routes', nameOrArray);
-    return;
-  }
-
-  var sourcePhases = nameOrArray;
-  if (!sourcePhases.length) return;
-
-  var targetPhases = this._requestHandlingPhases.getPhaseNames();
-  var targetIx = targetPhases.indexOf(nameOrArray[0]);
-
-  if (targetIx === -1) {
-    // the first new phase does not match any existing one
-    // add all phases before "routes"
-    sourcePhases.forEach(function(it) {
-      this._requestHandlingPhases.addBefore('routes', it);
-    }, this);
-    return;
-  }
-
-  // merge (zip) two arrays of phases
-  for (var sourceIx = 1; sourceIx < sourcePhases.length; sourceIx++) {
-    var nameToAdd = sourcePhases[sourceIx];
-    var previousPhase = sourcePhases[sourceIx - 1];
-    var existingIx = targetPhases.indexOf(nameToAdd, targetIx);
-    if (existingIx === -1) {
-      // A new phase - try to add it after the last one,
-      // unless it was already registered
-      if (targetPhases.indexOf(nameToAdd) !== -1) {
-        throw new Error('Phase ordering conflict: cannot add "' + nameToAdd +
-        '" after "' + previousPhase + '", because the opposite order was ' +
-        ' already specified');
-      }
-      this._requestHandlingPhases.addAfter(previousPhase, nameToAdd);
-    } else {
-      // An existing phase - move the pointer
-      targetIx = existingIx;
-    }
   }
 };
 

test/app.test.js

@@ -157,9 +157,14 @@ describe('app', function() {
       verifyMiddlewarePhases(['custom', 'routes'], done);
     });
 
-    it('adds an array of phases just before "routes"', function(done) {
-      app.defineMiddlewarePhases(['custom1', 'custom2']);
-      verifyMiddlewarePhases(['custom1', 'custom2', 'routes'], done);
+    it('merges phases adding to the start of the list', function(done) {
+      app.defineMiddlewarePhases(['first', 'routes', 'subapps']);
+      verifyMiddlewarePhases([
+        'first',
+        'initial', // this was the original first phase
+        'routes',
+        'subapps'
+      ], done);
     });
 
     it('merges phases preserving the order', function(done) {