Barback transforms now pass through the primary input by default.

pkg/barback/lib/src/phase_input.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library barback.phase_input;
 
 import 'dart:async';
 import 'dart:collection';
 
 import 'asset.dart';
 import 'asset_forwarder.dart';
 import 'asset_node.dart';
+import 'asset_node_set.dart';
 import 'errors.dart';
 import 'log.dart';
 import 'phase.dart';
 import 'stream_pool.dart';
 import 'transform_node.dart';
 import 'transformer.dart';
 import 'utils.dart';
 
 /// A class for watching a single [AssetNode] and running any transforms that
 /// take that node as a primary input.
@@ skipping 15 matching lines @@
   final _transforms = new Set<TransformNode>();
 
   /// A forwarder for the input [AssetNode] for this phase.
   ///
   /// This is used to mark the node as removed should the input ever be removed.
   final AssetForwarder _inputForwarder;
 
   /// The asset node for this input.
   AssetNode get input => _inputForwarder.node;
 
-  /// The controller that's used for the output node if [input] isn't consumed
-  /// by any transformers.
+  /// The controller that's used for the output node if [input] isn't
+  /// overwritten by any transformers.
   ///
   /// This needs an intervening controller to ensure that the output can be
-  /// marked dirty when determining whether transforms apply, and removed if
-  /// they do. It's null if the asset is not being passed through.
+  /// marked dirty when determining whether transforms will overwrite it, and
+  /// removed if they do. It's null if the asset is not being passed through.

[Bob Nystrom, 2014/02/26 01:09:15]

do -> will

[nweiz, 2014/02/26 19:37:14]

I don't think that's right -- we don't emit the pass-through when transforms
will overwrite the primary input in the future, we emit it when they actually do
overwrite it in the present.

[Bob Nystrom, 2014/02/26 20:28:50]

Oh, now I get it. That sentence is hairy. "removed" -> "be marked removed".

[nweiz, 2014/02/27 21:04:20]

Done.

   AssetNodeController _passThroughController;
 
   /// Whether [_passThroughController] has been newly created since [process]
   /// last completed.
   bool _newPassThrough = false;
 
+  final _outputs = new AssetNodeSet();
+
   /// A Future that will complete once the transformers that consume [input] are
   /// determined.
   Future _adjustTransformersFuture;
 
   /// A stream that emits an event whenever this input becomes dirty and needs
   /// [process] to be called.
   ///
   /// This may emit events when the input was already dirty or while processing
   /// transforms. Events are emitted synchronously to ensure that the dirty
   /// state is thoroughly propagated as soon as any assets are changed.
@@ skipping 60 matching lines @@
       // automatically pick up on [removedTransformer] being gone.
       if (_adjustTransformersFuture != null) continue;
 
       _transforms.removeWhere((transform) {
         if (transform.transformer != removedTransformer) return false;
         transform.remove();
         return true;
       });
     }
 
-    if (_transforms.isEmpty && _adjustTransformersFuture == null &&
-        _passThroughController == null) {
-      _passThroughController = new AssetNodeController.from(input);
-      _newPassThrough = true;
-    }
-
     var brandNewTransformers = newTransformers.difference(oldTransformers);
     if (brandNewTransformers.isEmpty) return;
 
     brandNewTransformers.forEach(_transformers.add);
     if (_adjustTransformersFuture == null) _adjustTransformers();
   }
 
   /// Force all [LazyTransformer]s' transforms in this input to begin producing
   /// concrete assets.
   void forceAllTransforms() {
     for (var transform in _transforms) {
       transform.force();
     }
   }
 
   /// Asynchronously determines which transformers can consume [input] as a
   /// primary input and creates transforms for them.
   ///
   /// This ensures that if [input] is modified or removed during or after the
   /// time it takes to adjust its transformers, they're appropriately
   /// re-adjusted. Its progress can be tracked in [_adjustTransformersFuture].
   void _adjustTransformers() {
     // Mark the input as dirty. This may not actually end up creating any new
     // transforms, but we want adding or removing a source asset to consistently
     // kick off a build, even if that build does nothing.
     _onDirtyController.add(null);
 
-    // If there's a pass-through for this input, mark it dirty while we figure
-    // out whether we need to add any transforms for it.
+    // If there's a pass-through for this input, mark it dirty until we figure
+    // out if a transformer will emit an asset with that id.
     if (_passThroughController != null) _passThroughController.setDirty();
 
     // Once the input is available, hook up transformers for it. If it changes
     // while that's happening, try again.
     _adjustTransformersFuture = _tryUntilStable((asset, transformers) {
       var oldTransformers =
           _transforms.map((transform) => transform.transformer).toSet();
 
       return _removeStaleTransforms(asset, transformers).then((_) =>
           _addFreshTransforms(transformers, oldTransformers));
@@ skipping 51 matching lines @@
       // We can safely access [input.asset] here even though it might have
       // changed since (as above) if it has, [_adjustTransformers] will just be
       // re-run.
       // TODO(rnystrom): Catch all errors from isPrimary() and redirect to
       // results.
       return transformer.isPrimary(input.asset).then((isPrimary) {
         if (!isPrimary) return;
         var transform = new TransformNode(
             _phase, transformer, input, _location);
         _transforms.add(transform);
+        transform.onDirty.listen((_) {
+          if (_passThroughController != null) _passThroughController.setDirty();
+        });
         _onDirtyPool.add(transform.onDirty);
         _onLogPool.add(transform.onLog);
       });
     }));
   }
 
-  /// Adjust whether [input] is passed through the phase unmodified, based on
-  /// whether it's consumed by other transforms in this phase.
-  ///
-  /// If [input] was already passed-through, this will update the passed-through
-  /// value.
-  void _adjustPassThrough() {
-    assert(input.state.isAvailable);
-
-    if (_transforms.isEmpty) {
-      if (_passThroughController != null) {
-        _passThroughController.setAvailable(input.asset);
-      } else {
-        _passThroughController = new AssetNodeController.from(input);
-        _newPassThrough = true;
-      }
-    } else if (_passThroughController != null) {
-      _passThroughController.setRemoved();
-      _passThroughController = null;
-      _newPassThrough = false;
-    }
-  }
-
   /// Like [AssetNode.tryUntilStable], but also re-runs [callback] if this
   /// phase's transformers are modified.
   Future _tryUntilStable(
       Future callback(Asset asset, Set<Transformer> transformers)) {
     var oldTransformers;
     return input.tryUntilStable((asset) {
       oldTransformers = _transformers.toSet();
       return callback(asset, _transformers);
     }).then((result) {
       if (setEquals(oldTransformers, _transformers)) return result;
       return _tryUntilStable(callback);
     });
   }
 
   /// Processes the transforms for this input.
   ///
   /// Returns the set of newly-created asset nodes that transforms have emitted
   /// for this input. The assets returned this way are guaranteed not to be
   /// [AssetState.REMOVED].
   Future<Set<AssetNode>> process() {
-    return _waitForTransformers(() => _processTransforms()).then((outputs) {
+    return _waitForTransformers(() {
+      if (input.state.isRemoved) return new Future.value(new Set());
+
+      return Future.wait(_transforms.map((transform) {
+        if (!transform.isDirty) return new Future.value(new Set());
+        return transform.apply();
+      })).then((outputs) => unionAll(outputs));
+    }).then((outputs) {
       if (input.state.isRemoved) return new Set();
+
+      for (var output in outputs) {
+        assert(!output.state.isRemoved);
+        _outputs.add(output);
+        output.whenRemoved(_adjustPassThrough);
+      }
+
+      _adjustPassThrough();
+      if (_newPassThrough) {
+        outputs.add(_passThroughController.node);
+        _newPassThrough = false;
+      }
       return outputs;
     });
   }
 
   /// Runs [callback] once all the transformers are adjusted correctly and the
   /// input is ready to be processed.
   ///
   /// If the transformers are already properly adjusted, [callback] is called
   /// synchronously to ensure that [_adjustTransformers] isn't called before the
   /// callback.
   Future _waitForTransformers(callback()) {
     if (_adjustTransformersFuture == null) return syncFuture(callback);
     return _adjustTransformersFuture.then(
         (_) => _waitForTransformers(callback));
   }
 
-  /// Applies all currently wired up and dirty transforms.
-  Future<Set<AssetNode>> _processTransforms() {
-    if (input.state.isRemoved) return new Future.value(new Set());
+  /// Adjust whether [input] is passed through the phase unmodified, based on
+  /// whether it's overwritten by other transforms in this phase.
+  ///
+  /// If [input] was already passed-through, this will update the passed-through
+  /// value.
+  void _adjustPassThrough() {
+    if (!input.state.isAvailable) return;
 
-    if (_passThroughController != null) {
-      if (!_newPassThrough) return new Future.value(new Set());
-      _newPassThrough = false;
-      return new Future.value(
-          new Set<AssetNode>.from([_passThroughController.node]));
+    // If there's an output with the same id as the primary input, that
+    // overwrites the input so it doesn't get passed through. Otherwise,
+    // create a pass-through controller if none exists, or set the existing
+    // one available.
+    if (_outputs.any((output) => output.id == input.id)) {
+      if (_passThroughController != null) {
+        _passThroughController.setRemoved();
+        _passThroughController = null;
+        _newPassThrough = false;
+      }
+    } else if (_passThroughController == null) {
+      _passThroughController = new AssetNodeController.from(input);
+      _newPassThrough = true;
+    } else if (_passThroughController.node.state.isDirty) {
+      _passThroughController.setAvailable(input.asset);
     }
-
-    return Future.wait(_transforms.map((transform) {
-      if (!transform.isDirty) return new Future.value(new Set());
-      return transform.apply();
-    })).then((outputs) => unionAll(outputs));
   }
 
   String toString() => "phase input in $_location for $input";
 }