pkg/vm_service_client: add getSourceReport to VMServiceReference

lib/src/script.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:math' as math;
 
 import 'package:json_rpc_2/json_rpc_2.dart' as rpc;
 import 'package:source_span/source_span.dart';
 
 import 'breakpoint.dart';
 import 'class.dart';
 import 'library.dart';
 import 'object.dart';
 import 'scope.dart';
 import 'source_location.dart';
+import 'source_report.dart';
 
 VMScriptRef newVMScriptRef(Scope scope, Map json) {
   if (json == null) return null;
   assert(json["type"] == "@Script" || json["type"] == "Script");
   return new VMScriptRef._(scope, json);
 }
 
 VMScriptToken newVMScriptToken(String isolateId, String scriptId,
         int position) {
   if (position == null) return null;
@@ skipping 34 matching lines @@
     try {
       var response = await _scope.sendRequest("addBreakpoint", params);
       return newVMBreakpoint(_scope, response);
     } on rpc.RpcException catch (error) {
       // Error 102 indicates that the breakpoint couldn't be created.
       if (error.code == 102) return null;
       rethrow;
     }
   }
 
+  /// Generates a set of reports tied to this script.
+  ///
+  /// Set [includeCoverageReport] to `true` to include code coverage
+  /// information.
+  ///
+  /// Set [includePossibleBreakpoints] to `true` to  provide a list of token
+  /// positions which correspond to possible breakpoints.
+  ///
+  /// Either or both of the [tokenPos] and [endTokenPos] parameters may be
+  /// provided to restrict the analysis to a subrange of a script
+  /// (for example, these can be used to restrict the report to the range of a
+  /// particular class or function).
+  ///
+  /// Set [forceCompilation] to `true` to force compilation of all functions in
+  /// the range of the report.
+  /// Forcing compilation can cause a compilation error, which could terminate
+  /// the running Dart program.
+  Future<VMSourceReport> getSourceReport(
+      {bool includeCoverageReport,
+      bool includePossibleBreakpoints,
+      int tokenPos,
+      int endTokenPos,

[nweiz, 2016/04/29 00:52:43]

These should come after [forceCompile]. That way the parameters that this call
has in common with [Isolate.getSourceReport] are all together.

To preserve the abstraction, rather than having the user pass these explicitly,
they should probably pass a single VMSourceLocation. That was they can easily
say "get the source report for this class" or whatever and we don't make them
manually munge locations and risk getting it wrong.

[kevmoo, 2016/04/29 23:36:54]

Done
Disagree. There's no way to create a VMSourceLocation (or a VMSourceToken).

A user may want to do math to skip everything before/after some range they've
already seen.

I may have a hit on 58 and a miss on 65.

Totally valid to ask for a range starting at '59' as they are trying to hit a
desired spot in the code.

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

I don't understand how users would possibly get into a position where they're
interested in non-semantic ranges like this. If they know they have a hit on 58
and a miss on 65, and those are part of the same function, they already have the
source report for that whole function.

It makes a lot of sense to get the source report for a given function or a given
class, and we should make that as easy as possible. It's not clear there's any
reason to get arbitrary ranges between tokens, especially when you can just
ignore some results from a wider source report, so it's nor worth warping the
API to accommodate that entirely theoretical use-case.

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

This was fixed – now uses tokens

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

What I'm saying is that it should take a single SourceLocation.

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

But one cannot create a SourceLocation from whole cloth. So we'd be limiting
ourselves to requesting sections of code for which the API has already provided
a location. One cannot say "given me everything before X or after Y"

[nweiz, 2016/05/17 20:54:41]

That is not a use-case I'm concerned about.

I'm tired of going around in circles about this. Please just make the change.

[kevmoo, 2016/05/17 22:12:01]

Acknowledged.

+      bool forceCompile}) async {
+    var reports = <String>[];
+    if (includeCoverageReport == true) {
+      reports.add('Coverage');
+    }
+
+    if (includePossibleBreakpoints == true) {
+      reports.add('PossibleBreakpoints');
+    }
+
+    var params = <String, dynamic>{'reports': reports, 'scriptId': _id};
+
+    if (tokenPos != null) {
+      params['tokenPos'] = tokenPos;
+    }
+
+    if (endTokenPos != null) {
+      params['endTokenPos'] = endTokenPos;
+    }
+
+    var json = await _scope.sendRequest('getSourceReport', params);
+
+    return newSourceReport(_scope, json);
+  }

[nweiz, 2016/04/29 00:52:43]

Most of the same comments for the other method apply here as well.

[kevmoo, 2016/04/29 23:36:54]

Acknowledged.

+
   bool operator ==(other) => other is VMScriptRef &&
       (_fixedId ? _id == other._id : super == other);
 
   int get hashCode => _fixedId ? _id.hashCode : super.hashCode;
 
   String toString() => uri.toString();
 }
 
 /// A script in the Dart VM.
 class VMScript extends VMScriptRef implements VMObject {
@@ skipping 226 matching lines @@
       var start = math.min(this._start, other._start);
       var end = math.max(this._end, other._end);
       return new _ScriptSpan(_script, start, end);
     } else {
       var start = math.min(this._start, other.start.offset);
       var end = math.max(this._end, other.end.offset);
       return file.span(start, end);
     }
   }
 }