pkg/vm_service_client: add getSourceReport to VMServiceReference

lib/src/isolate.dart

 // Copyright (c) 2015, 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.
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:convert';
 
 import 'package:async/async.dart';
 import 'package:json_rpc_2/json_rpc_2.dart' as rpc;
 
 import 'breakpoint.dart';
 import 'error.dart';
 import 'exceptions.dart';
 import 'library.dart';
 import 'pause_event.dart';
 import 'scope.dart';
 import 'sentinel.dart';
+import 'source_report.dart';
 import 'stack.dart';
 import 'stream_manager.dart';
 import 'utils.dart';
 
 VMIsolateRef newVMIsolateRef(rpc.Peer peer, StreamManager streams, Map json) {
   if (json == null) return null;
   assert(json["type"] == "@Isolate" || json["type"] == "Isolate");
   var scope = new Scope(peer, streams, json["id"]);
   return new VMIsolateRef._(scope, json);
 }
@@ skipping 307 matching lines @@
   ///
   /// This is supported as of VM service version 3.1, or Dart SDK version 1.14.
   Future<Object> invokeExtension(String method, [Map<String, String> params]) {
     if (!method.startsWith('ext.')) {
       throw new ArgumentError.value(method, 'method',
           'must begin with "ext." prefix');
     }
     return _scope.sendRequest(method, params);
   }
 
+  /// Generates a report of code coverage information and possible break points
+  /// for the scripts in this isolate.
+  ///
+  /// If [includeCoverageReport] is `true`, the report includes code coverage
+  /// information via [VMSourceReportRange.hits] and
+  /// [VMSourceReportRange.misses] in
+  /// [VMSourceReport.ranges].
+  /// Otherwise, [VMSourceReportRange.coverage] is `null`.

[nweiz, 2016/05/04 23:05:51]

Reflow this text so there isn't unnecessary whitespace at the end of each line.
Same goes for a bunch of other paragraphs. Small diffs are less important than
readable comments.

[kevmoo, 2016/05/05 20:46:26]

Done – mostly.

I like to start new sentences on new lines. Easier to read the source and less
likely to require cascading changes later

[nweiz, 2016/05/11 23:03:31]

That's contrary to the style elsewhere in this package, in Dart, and indeed in
English prose in general. Please just reflow it.

[kevmoo, 2016/05/12 05:22:34]

Markdown ignores single-line breaks – so no humans are harmed. It doc comment
easier to maintain..

..but okay

+  ///
+  /// If [includePossibleBreakpoints] is `true`, the report includes a list of
+  /// token positions which correspond to possible breakpoints via
+  /// [VMSourceReportRange.possibleBreakpoints] in [VMSourceReport.ranges].
+  /// Otherwise, [VMSourceReportRange.possibleBreakpoints] is `null`.
+  ///
+  /// If [forceCompile] is `true`, all functions in the range of the report
+  /// will be compiled. If `false`, functions that are never used may not appear
+  /// in [VMSourceReportRange.misses].
+  /// Forcing compilation can cause a compilation error, which could terminate
+  /// the running Dart program.
+  Future<VMSourceReport> getSourceReport(
+      {bool includeCoverageReport: false,
+      bool includePossibleBreakpoints: false,

[nweiz, 2016/05/04 23:05:51]

It doesn't seem particularly useful to have the source report default to
containing no information. I'd make both of these default to true, and allow
users to narrow it if that's an optimization that makes sense for them.

[kevmoo, 2016/05/05 20:46:26]

Done.

+      bool forceCompile: false}) async {
+    var reports = <String>[];
+    if (includeCoverageReport) {
+      reports.add('Coverage');
+    }
+
+    if (includePossibleBreakpoints) {
+      reports.add('PossibleBreakpoints');
+    }
+
+    var params = {'reports': reports};
+    if (forceCompile) {
+      params['forceCompile'] = true;
+    }

[nweiz, 2016/05/04 23:05:51]

Good thing you tested this! :D

[kevmoo, 2016/05/05 20:46:26]

Acknowledged.

+
+    var json = await _scope.sendRequest('getSourceReport', params);
+    return newSourceReport(_scope, json);
+  }
+
   bool operator ==(other) => other is VMIsolateRef &&
       other._scope.isolateId == _scope.isolateId;
 
   int get hashCode => _scope.isolateId.hashCode;
 
   String toString() => name;
 }
 
 /// A full isolate on the remote VM.
 class VMIsolate extends VMIsolateRef {
@@ skipping 105 matching lines @@
   /// The kind, which identifies the type of event and its source.
   final String kind;
 
   /// The event's payload.
   final Map data;
 
   VMExtensionEvent._(Map json)
       : kind = json['extensionKind'],
         data = json['extensionData'];
 }