Add support for asynchronous event notification to the observatory.

runtime/bin/vmservice/client/lib/src/service/object.dart

 // Copyright (c) 2014, 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.
 
 part of service;
 
 /// A [ServiceObject] is an object known to the VM service and is tied
 /// to an owning [Isolate].
 abstract class ServiceObject extends Observable {
   /// The owner of this [ServiceObject].  This can be an [Isolate], a
@@ skipping 54 matching lines @@
       case 'Class':
         obj = new Class._empty(owner);
         break;
       case 'Code':
         obj = new Code._empty(owner);
         break;
       case 'Error':
         obj = new DartError._empty(owner);
         break;
       case 'Isolate':
-        obj = new Isolate._empty(owner);
+        obj = new Isolate._empty(owner.vm);
         break;
       case 'Library':
         obj = new Library._empty(owner);
         break;
       case 'ServiceError':
         obj = new ServiceError._empty(owner);
         break;
+      case 'ServiceEvent':
+        obj = new ServiceEvent._empty(owner);
+        break;
       case 'ServiceException':
         obj = new ServiceException._empty(owner);
         break;
       case 'Script':
         obj = new Script._empty(owner);
         break;
       case 'Socket':
         obj = new Socket._empty(owner);
         break;
       default:
@@ skipping 104 matching lines @@
     name = 'vm';
     vmName = 'vm';
     _cache['vm'] = this;
     update(toObservable({'id':'vm', 'type':'@VM'}));
   }
 
   final StreamController<ServiceException> exceptions =
       new StreamController.broadcast();
   final StreamController<ServiceError> errors =
       new StreamController.broadcast();
+  final StreamController<ServiceEvent> events =
+      new StreamController.broadcast();
+
+  void postEventMessage(String eventMessage) {

[Cutch, 2014/06/27 16:03:49]

Why isn't the event just upgraded like other service objects?

[turnidge, 2014/06/27 18:15:06]

I don't understand.  Let's chat in person.

+      var map;
+      try {
+        map = _parseJSON(eventMessage);
+      } catch (e, st) {
+        Logger.root.severe('Ignoring malformed event message: ${eventMessage}');
+        return;
+      }
+      if (map['type'] != 'ServiceEvent') {
+        Logger.root.severe(
+            "Expected 'ServiceEvent' but found '${map['type']}'");
+        return;
+      }
+      // Extract the owning isolate from the event itself.
+      String owningIsolateId = map['isolate']['id'];
+      _getIsolate(owningIsolateId).then((owningIsolate) {
+          var event = new ServiceObject._fromMap(owningIsolate, map);
+          events.add(event);
+      });
+  }
 
   static final RegExp _currentIsolateMatcher = new RegExp(r'isolates/\d+');
   static final RegExp _currentObjectMatcher = new RegExp(r'isolates/\d+/');
   static final String _isolatesPrefix = 'isolates/';
 
   String _parseObjectId(String id) {
     Match m = _currentObjectMatcher.matchAsPrefix(id);
     if (m == null) {
       return null;
     }
@@ skipping 289 matching lines @@
 }
 
 /// State for a running isolate.
 class Isolate extends ServiceObjectOwner {
   @reflectable VM get vm => owner;
   @reflectable Isolate get isolate => this;
   @observable ObservableMap counters = new ObservableMap();
 
   String get link => '/${_id}';
 
-  @observable ServiceMap pauseEvent = null;
+  @observable ServiceEvent pauseEvent = null;
   bool get _isPaused => pauseEvent != null;
 
   @observable bool running = false;
   @observable bool idle = false;
   @observable bool loading = true;
   @observable bool ioEnabled = false;
 
   Map<String,ServiceObject> _cache = new Map<String,ServiceObject>();
   final TagProfile tagProfile = new TagProfile(20);
 
@@ skipping 235 matching lines @@
           ioEnabled = true;
         }
       }
     }
     // Isolate status
     pauseEvent = map['pauseEvent'];
     running = (!_isPaused && map['topFrame'] != null);
     idle = (!_isPaused && map['topFrame'] == null);
     error = map['error'];
 
+    // Synthesize a resume event if this isolate is not paused.
+    if (pauseEvent == null) {
+      var event = new ServiceObject._fromMap(this, toObservable({
+            'type': 'ServiceEvent',
+            'id': '',
+            'eventType': 'IsolateResumed',
+            'isolate': id,
+          }));
+      vm.events.add(event);

[Cutch, 2014/06/27 16:03:49]

Why do we synthesize a resume event every time we update an isolate?

[turnidge, 2014/06/27 18:15:06]

I was using a fake resume event to clear out any pause notifications that were
currently showing.  There really isn't an IsolateResumed event at all from the
VM.

This was a bit clumsy so I have removed it.  Now I just call removePauseEvents
directly from isolate_summary.dart when the resume request completes.  I forgot
that I added access to "app" from all observatory elements, so this is more
direct.

+    }
+
     libraries.clear();
     for (var lib in map['libraries']) {
       libraries.add(lib);
     }
     libraries.sort((a,b) => a.name.compareTo(b.name));
   }
 
   Future<TagProfile> updateTagProfile() {
     return vm.getAsMap(relativeLink('profile/tag')).then((ObservableMap m) {
       var seconds = new DateTime.now().millisecondsSinceEpoch / 1000.0;
@@ skipping 161 matching lines @@
 
   void _update(ObservableMap map, bool mapIsRef) {
     kind = map['kind'];
     message = map['message'];
     response = map['response'];
     name = 'ServiceException $kind';
     vmName = name;
   }
 }
 
+/// A [ServiceEvent] is an asynchronous event notification from the vm.
+class ServiceEvent extends ServiceObject {
+  ServiceEvent._empty(ServiceObjectOwner owner) : super._empty(owner);
+
+  @observable String eventType;
+  @observable ServiceMap breakpoint;
+  @observable ServiceMap exception;
+
+  void _update(ObservableMap map, bool mapIsRef) {
+    _loaded = true;
+    _upgradeCollection(map, owner);
+    eventType = map['eventType'];
+    name = 'ServiceEvent $eventType';
+    vmName = name;
+    if (map['breakpoint'] != null) {
+      breakpoint = map['breakpoint'];
+    }
+    if (map['exception'] != null) {
+      exception = map['exception'];
+    }
+  }
+}
+
 class Library extends ServiceObject {
   @observable String url;
   @reflectable final imports = new ObservableList<Library>();
   @reflectable final scripts = new ObservableList<Script>();
   @reflectable final classes = new ObservableList<Class>();
   @reflectable final variables = new ObservableList<ServiceMap>();
   @reflectable final functions = new ObservableList<ServiceMap>();
 
   bool get canCache => true;
   bool get immutable => false;
@@ skipping 412 matching lines @@
     }
   }
 
   void _resolveJumpTarget(List<CodeInstruction> instructions) {
     if (!_isJumpInstruction()) {
       return;
     }
     int address = _getJumpAddress();
     if (address == 0) {
       // Could not determine jump address.
-      print('Could not determine jump address for $human');
+      Logger.root.severe('Could not determine jump address for $human');
       return;
     }
     for (var i = 0; i < instructions.length; i++) {
       var instruction = instructions[i];
       if (instruction.address == address) {
         jumpTarget = instruction;
         return;
       }
     }
-    print('Could not find instruction at ${address.toRadixString(16)}');
+    Logger.root.severe(
+        'Could not find instruction at ${address.toRadixString(16)}');
   }
 }
 
 class CodeKind {
   final _value;
   const CodeKind._internal(this._value);
   String toString() => '$_value';
 
   static CodeKind fromString(String s) {
     if (s == 'Native') {
@@ skipping 421 matching lines @@
     var v = list[i];
     if ((v is ObservableMap) && _isServiceMap(v)) {
       list[i] = owner.getFromMap(v);
     } else if (v is ObservableList) {
       _upgradeObservableList(v, owner);
     } else if (v is ObservableMap) {
       _upgradeObservableMap(v, owner);
     }
   }
 }