Move Barback to a more thoroughly push-based model.

pkg/barback/lib/src/transform_node.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.transform_node;
 
 import 'dart:async';
 
 import 'package:source_maps/span.dart';
 
@@ skipping 24 matching lines @@
 
   /// The node for the primary asset this transform depends on.
   final AssetNode primary;
 
   /// A string describing the location of [this] in the transformer graph.
   final String _location;
 
   /// The subscription to [primary]'s [AssetNode.onStateChange] stream.
   StreamSubscription _primarySubscription;
 
-  /// True if an input has been modified since the last time this transform
-  /// began running.
-  bool get isDirty => _isDirty;
-  var _isDirty = true;
+  // TODO(nweiz): remove this and move isPrimary computation into TransformNode.

[Bob Nystrom, 2014/03/05 22:13:25]

"remove" -> "Remove".

[nweiz, 2014/03/06 00:29:08]

Done.

+  /// Whether the parent [PhaseInput] is currently computing whether its input
+  /// is primary for [this].
+  bool _pendingIsPrimary = false;
+
+  /// Whether [this] is dirty and still has more processing to do.
+  bool get isDirty => _pendingIsPrimary || _isApplying;
+
+  /// Whether any input has become dirty since [_apply] last started running.
+  var _hasBecomeDirty = false;
+
+  /// Whether [_apply] is currently running.
+  var _isApplying = false;

[Bob Nystrom, 2014/03/05 22:13:25]

I think a state enum would be a better fit than a few flags.

[nweiz, 2014/03/06 00:29:08]

See previous comment.

 
   /// Whether [transformer] is lazy and this transform has yet to be forced.
   bool _isLazy;
 
   /// The subscriptions to each input's [AssetNode.onStateChange] stream.
   var _inputSubscriptions = new Map<AssetId, StreamSubscription>();
 
   /// The controllers for the asset nodes emitted by this node.
   var _outputControllers = new Map<AssetId, AssetNodeController>();
 
-  /// A stream that emits an event whenever this transform becomes dirty and
-  /// needs to be re-run.
+  /// A stream that emits an event whenever [this] is no longer dirty.
   ///
-  /// This may emit events when the transform 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.
-  Stream get onDirty => _onDirtyController.stream;
-  final _onDirtyController = new StreamController.broadcast(sync: true);
+  /// This is synchronous in order to guarantee that it will emit an event as
+  /// soon as [isDirty] flips from `true` to `false`.
+  Stream get onDone => _onDoneController.stream;
+  final _onDoneController = new StreamController.broadcast(sync: true);
+
+  /// A stream that emits any new assets emitted by [this].
+  ///
+  /// Assets are emitted synchronously to ensure that any changes are thoroughly
+  /// propagated as soon as they occur.
+  Stream<AssetNode> get onAsset => _onAssetController.stream;
+  final _onAssetController = new StreamController<AssetNode>(sync: true);
 
   /// A stream that emits an event whenever this transform logs an entry.
   ///
   /// This is synchronous because error logs can cause the transform to fail, so
   /// we need to ensure that their processing isn't delayed until after the
   /// transform or build has finished.
   Stream<LogEntry> get onLog => _onLogController.stream;
   final _onLogController = new StreamController<LogEntry>.broadcast(sync: true);
 
   TransformNode(this.phase, Transformer transformer, this.primary,
       this._location)
       : transformer = transformer,
         _isLazy = transformer is LazyTransformer {
     _primarySubscription = primary.onStateChange.listen((state) {
       if (state.isRemoved) {
         remove();
       } else {
+        if (state.isDirty) _pendingIsPrimary = true;
         _dirty();
       }
     });
+
+    _apply();
   }
 
   /// The [TransformInfo] describing this node.
   ///
   /// [TransformInfo] is the publicly-visible representation of a transform
   /// node.
   TransformInfo get info => new TransformInfo(transformer, primary.id);
 
   /// Marks this transform as removed.
   ///
   /// This causes all of the transform's outputs to be marked as removed as
   /// well. Normally this will be automatically done internally based on events
   /// from the primary input, but it's possible for a transform to no longer be
   /// valid even if its primary input still exists.
   void remove() {
-    _isDirty = true;
-    _onDirtyController.close();
+    _hasBecomeDirty = false;
+    _onAssetController.close();
+    _onDoneController.close();
     _primarySubscription.cancel();
     for (var subscription in _inputSubscriptions.values) {
       subscription.cancel();
     }
     for (var controller in _outputControllers.values) {
       controller.setRemoved();
     }
   }
 
   /// If [transformer] is lazy, ensures that its concrete outputs will be
   /// generated.
   void force() {
     // TODO(nweiz): we might want to have a timeout after which, if the
     // transform's outputs have gone unused, we switch it back to lazy mode.
     if (!_isLazy) return;
     _isLazy = false;
     _dirty();
   }
 
+  // TODO(nweiz): remove this and move isPrimary computation into TransformNode.
+  /// Mark that the parent [PhaseInput] has determined that its input is indeed
+  /// primary for [this].
+  void markPrimary() {
+    if (!_pendingIsPrimary) return;
+    _pendingIsPrimary = false;
+    if (!_isApplying) _apply();
+  }
+
   /// Marks this transform as dirty.
   ///
   /// This causes all of the transform's outputs to be marked as dirty as well.
   void _dirty() {
-    _isDirty = true;
     for (var controller in _outputControllers.values) {
       controller.setDirty();
     }
-    _onDirtyController.add(null);
+
+    _hasBecomeDirty = true;
+    if (!_isApplying && !_pendingIsPrimary) _apply();
   }
 
   /// Applies this transform.
-  ///
-  /// Returns a set of asset nodes representing the outputs from this transform
-  /// that weren't emitted last time it was run.
-  Future<Set<AssetNode>> apply() {
-    assert(!_onDirtyController.isClosed);
+  void _apply() {
+    assert(!_onAssetController.isClosed);
 
     // Clear all the old input subscriptions. If an input is re-used, we'll
     // re-subscribe.
     for (var subscription in _inputSubscriptions.values) {
       subscription.cancel();
     }
     _inputSubscriptions.clear();
 
-    _isDirty = false;
+    _isApplying = true;
+    primary.whenAvailable((_) {
+      _hasBecomeDirty = false;
 
-    return syncFuture(() {
       // TODO(nweiz): If [transformer] is a [DeclaringTransformer] but not a
       // [LazyTransformer], we can get some mileage out of doing a declarative
       // first so we know how to hook up the assets.
       if (_isLazy) return _declareLazy();
       return _applyImmediate();
     }).catchError((error, stackTrace) {
       // If the transform became dirty while processing, ignore any errors from
       // it.
-      if (_isDirty) return new Set();
+      if (_hasBecomeDirty) return;
 
       if (error is! MissingInputException) {
         error = new TransformerException(info, error, stackTrace);
       }
 
       // Catch all transformer errors and pipe them to the results stream. This
       // is so a broken transformer doesn't take down the whole graph.
       phase.cascade.reportError(error);
 
-      return new Set();
+      // Remove all the previously-emitted assets.
+      for (var controller in _outputControllers.values) {
+        controller.setRemoved();
+      }
+      _outputControllers.clear();
+    }).then((_) {
+      if (_onAssetController.isClosed) return;
+
+      _isApplying = false;
+      if (_hasBecomeDirty) {
+        // Re-apply the transform if it became dirty while applying.
+        if (!_pendingIsPrimary) _apply();
+      } else {
+        assert(!isDirty);
+        // Otherwise, notify the parent nodes that it's no longer dirty.
+        _onDoneController.add(null);
+      }
     });
   }
 
   /// Gets the asset for an input [id].
   ///
   /// If an input with that ID cannot be found, throws an
   /// [AssetNotFoundException].
   Future<Asset> getInput(AssetId id) {
     return phase.getInput(id).then((node) {
       // Throw if the input isn't found. This ensures the transformer's apply
@@ skipping 12 matching lines @@
         if (error is! AssetNotFoundException || error.id != id) throw error;
         // If the node was removed before it could be loaded, treat it as though
         // it never existed and throw a MissingInputException.
         throw new MissingInputException(info, id);
       });
     });
   }
 
   /// Applies the transform so that it produces concrete (as opposed to lazy)
   /// outputs.
-  Future<Set<AssetNode>> _applyImmediate() {
+  Future _applyImmediate() {
     var newOutputs = new AssetSet();
     var transform = new Transform(this, newOutputs, _log);
 
     return syncFuture(() => transformer.apply(transform)).then((_) {
-      if (_isDirty) return new Set();
+      if (_hasBecomeDirty) return;
 
       // Any ids that are for a different package are invalid.
       var invalidIds = newOutputs
           .map((asset) => asset.id)
           .where((id) => id.package != phase.cascade.package)
           .toSet();
       for (var id in invalidIds) {
         newOutputs.removeId(id);
         // TODO(nweiz): report this as a warning rather than a failing error.
         phase.cascade.reportError(new InvalidOutputException(info, id));
       }
 
       // Remove outputs that used to exist but don't anymore.
       for (var id in _outputControllers.keys.toList()) {
         if (newOutputs.containsId(id)) continue;
         _outputControllers.remove(id).setRemoved();
       }
 
-      var brandNewOutputs = new Set<AssetNode>();
       // Store any new outputs or new contents for existing outputs.
       for (var asset in newOutputs) {
         var controller = _outputControllers[asset.id];
         if (controller != null) {
           controller.setAvailable(asset);
         } else {
           var controller = new AssetNodeController.available(asset, this);
           _outputControllers[asset.id] = controller;
-          brandNewOutputs.add(controller.node);
+          _onAssetController.add(controller.node);
         }
       }
-
-      return brandNewOutputs;
     });
   }
 
   /// Applies the transform in declarative mode so that it produces lazy
   /// outputs.
-  Future<Set<AssetNode>> _declareLazy() {
+  Future _declareLazy() {
     var newIds = new Set();
     var transform = new DeclaringTransform(this, newIds, _log);
 
     return syncFuture(() {
       return (transformer as LazyTransformer).declareOutputs(transform);
     }).then((_) {
-      if (_isDirty) return new Set();
+      if (_hasBecomeDirty) return;
 
       var invalidIds =
           newIds.where((id) => id.package != phase.cascade.package).toSet();
       for (var id in invalidIds) {
         newIds.remove(id);
         // TODO(nweiz): report this as a warning rather than a failing error.
         phase.cascade.reportError(new InvalidOutputException(info, id));
       }
 
       // Remove outputs that used to exist but don't anymore.
       for (var id in _outputControllers.keys.toList()) {
         if (newIds.contains(id)) continue;
         _outputControllers.remove(id).setRemoved();
       }
 
-      var brandNewOutputs = new Set<AssetNode>();
       for (var id in newIds) {
         var controller = _outputControllers[id];
         if (controller != null) {
           controller.setLazy(force);
         } else {
           var controller = new AssetNodeController.lazy(id, force, this);
           _outputControllers[id] = controller;
-          brandNewOutputs.add(controller.node);
+          _onAssetController.add(controller.node);
         }
       }
-
-      return brandNewOutputs;
     });
   }
 
   void _log(AssetId asset, LogLevel level, String message, Span span) {
     // If the log isn't already associated with an asset, use the primary.
     if (asset == null) asset = primary.id;
     var entry = new LogEntry(info, asset, level, message, span);
     _onLogController.add(entry);
   }
 
   String toString() =>
     "transform node in $_location for $transformer on $primary";
 }