Track async causal stack traces

runtime/observatory/tests/service/causal_async_star_stack_contents_test.dart

+// Copyright (c) 2017, 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.
+// VMOptions=--error_on_bad_type --error_on_bad_override  --verbose_debug
+
+import 'dart:developer';
+import 'package:observatory/models.dart' as M;
+import 'package:observatory/service_io.dart';
+import 'package:unittest/unittest.dart';
+import 'service_test_common.dart';
+import 'test_helper.dart';
+
+const LINE_A = 26;
+const LINE_B = 19;
+const LINE_C = 21;
+
+foobar() async* {
+  debugger();
+  yield 1;     // LINE_B.
+  debugger();
+  yield 2;     // LINE_C.
+}
+
+helper() async {
+  debugger();
+  print('helper');  // LINE_A.
+  await for (var i in foobar()) {
+    print('helper $i');
+  }
+}
+
+testMain() {
+  helper();
+}
+
+var tests = [
+  hasStoppedAtBreakpoint,
+  stoppedAtLine(LINE_A),
+  (Isolate isolate) async {
+    ServiceMap stack = await isolate.getStack();
+    // No causal frames because we are in a completely synchronous stack.
+    expect(stack['asyncCausalFrames'], isNotNull);
+    var asyncStack = stack['asyncCausalFrames'];
+    expect(asyncStack[0].toString(), contains('helper_async_body'));
+    expect(asyncStack[1].kind, equals(M.FrameKind.asyncSuspensionMarker));
+    expect(asyncStack[2].toString(), contains('helper'));
+  },
+  resumeIsolate,
+  hasStoppedAtBreakpoint,
+  stoppedAtLine(LINE_B),
+
+  (Isolate isolate) async {
+    ServiceMap stack = await isolate.getStack();
+    // Has causal frames (we are inside an async function)
+    expect(stack['asyncCausalFrames'], isNotNull);
+    var asyncStack = stack['asyncCausalFrames'];
+    expect(asyncStack[0].toString(), contains('foobar_async_gen_body'));
+    expect(asyncStack[1].kind, equals(M.FrameKind.asyncSuspensionMarker));
+    expect(asyncStack[2].toString(), contains('foobar'));
+    expect(asyncStack[3].toString(), contains('helper_async_body'));
+    expect(asyncStack[4].kind, equals(M.FrameKind.asyncSuspensionMarker));
+    expect(asyncStack[5].toString(), contains('helper'));
+    expect(asyncStack[6].toString(), contains('testMain'));
+  },
+
+  resumeIsolate,
+  hasStoppedAtBreakpoint,
+  stoppedAtLine(LINE_C),
+
+  (Isolate isolate) async {
+    ServiceMap stack = await isolate.getStack();
+    // Has causal frames (we are inside a function called by an async function)
+    expect(stack['asyncCausalFrames'], isNotNull);
+    var asyncStack = stack['asyncCausalFrames'];
+    expect(asyncStack[0].toString(), contains('foobar_async_gen_body'));
+    expect(asyncStack[1].kind, equals(M.FrameKind.asyncSuspensionMarker));
+    expect(asyncStack[2].toString(), contains('foobar'));
+    expect(asyncStack[3].toString(), contains('helper_async_body'));
+    expect(asyncStack[4].kind, equals(M.FrameKind.asyncSuspensionMarker));
+    expect(asyncStack[5].toString(), contains('helper'));
+    expect(asyncStack[6].toString(), contains('testMain'));
+  },
+];
+
+main(args) => runIsolateTestsSynchronous(args,
+                                         tests,
+                                         testeeConcurrent: testMain);