widget_inspector_test.dart 113 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
// @dart = 2.8

7
import 'dart:async';
8
import 'dart:convert';
9
import 'dart:math';
10
import 'dart:ui' as ui;
11

12
import 'package:flutter/foundation.dart';
13
import 'package:flutter/gestures.dart' show DragStartBehavior;
14
import 'package:flutter/material.dart';
15
import 'package:flutter/rendering.dart';
16
import 'package:flutter/widgets.dart';
17 18
import 'package:flutter_test/flutter_test.dart';

19 20
import 'widget_inspector_test_utils.dart';

21 22 23 24
// Start of block of code where widget creation location line numbers and
// columns will impact whether tests pass.

class ClockDemo extends StatefulWidget {
25
  const ClockDemo({ Key key }) : super(key: key);
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
  @override
  _ClockDemoState createState() => _ClockDemoState();
}

class _ClockDemoState extends State<ClockDemo> {
  @override
  Widget build(BuildContext context) {
    return Directionality(
      textDirection: TextDirection.ltr,
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          const Text('World Clock'),
          makeClock('Local', DateTime.now().timeZoneOffset.inHours),
          makeClock('UTC', 0),
          makeClock('New York, NY', -4),
          makeClock('Chicago, IL', -5),
          makeClock('Denver, CO', -6),
          makeClock('Los Angeles, CA', -7),
        ],
      ),
    );
  }

50
  Widget makeClock(String label, int utcOffset) {
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    return Stack(
      children: <Widget>[
        const Icon(Icons.watch),
        Text(label),
        ClockText(utcOffset: utcOffset),
      ],
    );
  }
}

class ClockText extends StatefulWidget {
  const ClockText({
    Key key,
    this.utcOffset = 0,
  }) : super(key: key);

67
  final int utcOffset;
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

  @override
  _ClockTextState createState() => _ClockTextState();
}

class _ClockTextState extends State<ClockText> {
  DateTime currentTime = DateTime.now();

  void updateTime() {
    setState(() {
      currentTime = DateTime.now();
    });
  }

  void stopClock() {
    setState(() {
      currentTime = null;
    });
  }

  @override
  Widget build(BuildContext context) {
    if (currentTime == null) {
      return const Text('stopped');
    }
    return Text(
      currentTime
          .toUtc()
          .add(Duration(hours: widget.utcOffset))
          .toIso8601String(),
    );
  }
}

// End of block of code where widget creation location line numbers and
// columns will impact whether tests pass.

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
// Class to enable building trees of nodes with cycles between properties of
// nodes and the properties of those properties.
// This exposed a bug in code serializing DiagnosticsNode objects that did not
// handle these sorts of cycles robustly.
class CyclicDiagnostic extends DiagnosticableTree {
  CyclicDiagnostic(this.name);

  // Field used to create cyclic relationships.
  CyclicDiagnostic related;
  final List<DiagnosticsNode> children = <DiagnosticsNode>[];

  final String name;

  @override
  String toStringShort() => '$runtimeType-$name';

  // We have to override toString to avoid the toString call itself triggering a
  // stack overflow.
  @override
124
  String toString({ DiagnosticLevel minLevel = DiagnosticLevel.info }) {
125 126 127 128 129 130 131 132 133 134 135 136 137
    return toStringShort();
  }

  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(DiagnosticsProperty<CyclicDiagnostic>('related', related));
  }

  @override
  List<DiagnosticsNode> debugDescribeChildren() => children;
}

138 139 140 141 142 143 144 145 146 147 148 149 150 151
class _CreationLocation {
  const _CreationLocation({
    @required this.file,
    @required this.line,
    @required this.column,
    @required this.id,
  });

  final String file;
  final int line;
  final int column;
  final int id;
}

152
typedef InspectorServiceExtensionCallback = FutureOr<Map<String, Object>> Function(Map<String, String> parameters);
153

154 155 156 157 158 159 160
class RenderRepaintBoundaryWithDebugPaint extends RenderRepaintBoundary {
  @override
  void debugPaintSize(PaintingContext context, Offset offset) {
    super.debugPaintSize(context, offset);
    assert(() {
      // Draw some debug paint UI interleaving creating layers and drawing
      // directly to the context's canvas.
161
      final Paint paint = Paint()
162 163 164 165
        ..style = PaintingStyle.stroke
        ..strokeWidth = 1.0
        ..color = Colors.red;
      {
166 167 168
        final PictureLayer pictureLayer = PictureLayer(Offset.zero & size);
        final ui.PictureRecorder recorder = ui.PictureRecorder();
        final Canvas pictureCanvas = Canvas(recorder);
169 170 171
        pictureCanvas.drawCircle(Offset.zero, 20.0, paint);
        pictureLayer.picture = recorder.endRecording();
        context.addLayer(
172
          OffsetLayer()
173 174 175 176 177 178 179 180 181 182
            ..offset = offset
            ..append(pictureLayer),
        );
      }
      context.canvas.drawLine(
        offset,
        offset.translate(size.width, size.height),
        paint,
      );
      {
183 184 185
        final PictureLayer pictureLayer = PictureLayer(Offset.zero & size);
        final ui.PictureRecorder recorder = ui.PictureRecorder();
        final Canvas pictureCanvas = Canvas(recorder);
186 187 188
        pictureCanvas.drawCircle(const Offset(20.0, 20.0), 20.0, paint);
        pictureLayer.picture = recorder.endRecording();
        context.addLayer(
189
          OffsetLayer()
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
            ..offset = offset
            ..append(pictureLayer),
        );
      }
      paint.color = Colors.blue;
      context.canvas.drawLine(
        offset,
        offset.translate(size.width * 0.5, size.height * 0.5),
        paint,
      );
      return true;
    }());
  }
}

class RepaintBoundaryWithDebugPaint extends RepaintBoundary {
  /// Creates a widget that isolates repaints.
  const RepaintBoundaryWithDebugPaint({
    Key key,
    Widget child,
  }) : super(key: key, child: child);

  @override
  RenderRepaintBoundary createRenderObject(BuildContext context) {
214
    return RenderRepaintBoundaryWithDebugPaint();
215 216 217 218 219 220 221 222 223 224 225 226 227
  }
}

int getChildLayerCount(OffsetLayer layer) {
  Layer child = layer.firstChild;
  int count = 0;
  while (child != null) {
    count++;
    child = child.nextSibling;
  }
  return count;
}

228
void main() {
229
  _TestWidgetInspectorService.runTests();
230 231
}

232
class _TestWidgetInspectorService extends TestWidgetInspectorService {
233 234
  // These tests need access to protected members of WidgetInspectorService.
  static void runTests() {
235
    final TestWidgetInspectorService service = TestWidgetInspectorService();
236 237 238 239 240
    WidgetInspectorService.instance = service;

    testWidgets('WidgetInspector smoke test', (WidgetTester tester) async {
      // This is a smoke test to verify that adding the inspector doesn't crash.
      await tester.pumpWidget(
241
        Directionality(
242
          textDirection: TextDirection.ltr,
243
          child: Stack(
244
            children: const <Widget>[
245 246 247
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
248 249 250
            ],
          ),
        ),
251 252 253
      );

      await tester.pumpWidget(
254
        Directionality(
255
          textDirection: TextDirection.ltr,
256
          child: WidgetInspector(
257
            selectButtonBuilder: null,
258
            child: Stack(
259
              children: const <Widget>[
260 261 262
                Text('a', textDirection: TextDirection.ltr),
                Text('b', textDirection: TextDirection.ltr),
                Text('c', textDirection: TextDirection.ltr),
263 264 265 266
              ],
            ),
          ),
        ),
267 268 269 270 271 272 273
      );

      expect(true, isTrue); // Expect that we reach here without crashing.
    });

    testWidgets('WidgetInspector interaction test', (WidgetTester tester) async {
      final List<String> log = <String>[];
274 275 276
      final GlobalKey selectButtonKey = GlobalKey();
      final GlobalKey inspectorKey = GlobalKey();
      final GlobalKey topButtonKey = GlobalKey();
277 278

      Widget selectButtonBuilder(BuildContext context, VoidCallback onPressed) {
279
        return Material(child: RaisedButton(onPressed: onPressed, key: selectButtonKey));
280 281 282
      }
      // State type is private, hence using dynamic.
      dynamic getInspectorState() => inspectorKey.currentState;
283
      String paragraphText(RenderParagraph paragraph) {
284
        final TextSpan textSpan = paragraph.text as TextSpan;
285 286
        return textSpan.text;
      }
287 288

      await tester.pumpWidget(
289
        Directionality(
290
          textDirection: TextDirection.ltr,
291
          child: WidgetInspector(
292 293
            key: inspectorKey,
            selectButtonBuilder: selectButtonBuilder,
294 295
            child: Material(
              child: ListView(
296
                children: <Widget>[
297
                  RaisedButton(
298 299 300 301 302 303
                    key: topButtonKey,
                    onPressed: () {
                      log.add('top');
                    },
                    child: const Text('TOP'),
                  ),
304
                  RaisedButton(
305 306 307 308 309 310
                    onPressed: () {
                      log.add('bottom');
                    },
                    child: const Text('BOTTOM'),
                  ),
                ],
311
              ),
312 313 314 315 316 317 318 319 320 321
            ),
          ),
        ),
      );

      expect(getInspectorState().selection.current, isNull);
      await tester.tap(find.text('TOP'));
      await tester.pump();
      // Tap intercepted by the inspector
      expect(log, equals(<String>[]));
322 323
      final InspectorSelection selection = getInspectorState().selection as InspectorSelection;
      expect(paragraphText(selection.current as RenderParagraph), equals('TOP'));
324
      final RenderObject topButton = find.byKey(topButtonKey).evaluate().first.renderObject;
325
      expect(selection.candidates, contains(topButton));
326 327 328 329 330 331 332 333 334

      await tester.tap(find.text('TOP'));
      expect(log, equals(<String>['top']));
      log.clear();

      await tester.tap(find.text('BOTTOM'));
      expect(log, equals(<String>['bottom']));
      log.clear();
      // Ensure the inspector selection has not changed to bottom.
335
      expect(paragraphText(getInspectorState().selection.current as RenderParagraph), equals('TOP'));
336 337 338 339 340 341 342 343 344

      await tester.tap(find.byKey(selectButtonKey));
      await tester.pump();

      // We are now back in select mode so tapping the bottom button will have
      // not trigger a click but will cause it to be selected.
      await tester.tap(find.text('BOTTOM'));
      expect(log, equals(<String>[]));
      log.clear();
345
      expect(paragraphText(getInspectorState().selection.current as RenderParagraph), equals('BOTTOM'));
346 347 348 349
    });

    testWidgets('WidgetInspector non-invertible transform regression test', (WidgetTester tester) async {
      await tester.pumpWidget(
350
        Directionality(
351
          textDirection: TextDirection.ltr,
352
          child: WidgetInspector(
353
            selectButtonBuilder: null,
354 355 356
            child: Transform(
              transform: Matrix4.identity()..scale(0.0),
              child: Stack(
357
                children: const <Widget>[
358 359 360
                  Text('a', textDirection: TextDirection.ltr),
                  Text('b', textDirection: TextDirection.ltr),
                  Text('c', textDirection: TextDirection.ltr),
361 362 363
                ],
              ),
            ),
364
          ),
365
        ),
366 367 368
      );

      await tester.tap(find.byType(Transform));
369

370 371
      expect(true, isTrue); // Expect that we reach here without crashing.
    });
372

373
    testWidgets('WidgetInspector scroll test', (WidgetTester tester) async {
374 375 376
      final Key childKey = UniqueKey();
      final GlobalKey selectButtonKey = GlobalKey();
      final GlobalKey inspectorKey = GlobalKey();
377

378
      Widget selectButtonBuilder(BuildContext context, VoidCallback onPressed) {
379
        return Material(child: RaisedButton(onPressed: onPressed, key: selectButtonKey));
380 381 382 383 384
      }
      // State type is private, hence using dynamic.
      dynamic getInspectorState() => inspectorKey.currentState;

      await tester.pumpWidget(
385
        Directionality(
386
          textDirection: TextDirection.ltr,
387
          child: WidgetInspector(
388 389
            key: inspectorKey,
            selectButtonBuilder: selectButtonBuilder,
390
            child: ListView(
391
              dragStartBehavior: DragStartBehavior.down,
392
              children: <Widget>[
393
                Container(
394 395 396 397 398 399 400 401 402
                  key: childKey,
                  height: 5000.0,
                ),
              ],
            ),
          ),
        ),
      );
      expect(tester.getTopLeft(find.byKey(childKey)).dy, equals(0.0));
403

404 405
      await tester.fling(find.byType(ListView), const Offset(0.0, -200.0), 200.0);
      await tester.pump();
406

407 408
      // Fling does nothing as are in inspect mode.
      expect(tester.getTopLeft(find.byKey(childKey)).dy, equals(0.0));
409

410 411
      await tester.fling(find.byType(ListView), const Offset(200.0, 0.0), 200.0);
      await tester.pump();
412

413 414
      // Fling still does nothing as are in inspect mode.
      expect(tester.getTopLeft(find.byKey(childKey)).dy, equals(0.0));
415

416 417 418
      await tester.tap(find.byType(ListView));
      await tester.pump();
      expect(getInspectorState().selection.current, isNotNull);
419

420 421 422
      // Now out of inspect mode due to the click.
      await tester.fling(find.byType(ListView), const Offset(0.0, -200.0), 200.0);
      await tester.pump();
423

424
      expect(tester.getTopLeft(find.byKey(childKey)).dy, equals(-200.0));
425

426 427 428 429
      await tester.fling(find.byType(ListView), const Offset(0.0, 200.0), 200.0);
      await tester.pump();

      expect(tester.getTopLeft(find.byKey(childKey)).dy, equals(0.0));
430
    }, skip: true); // https://github.com/flutter/flutter/issues/29108
431 432 433 434 435

    testWidgets('WidgetInspector long press', (WidgetTester tester) async {
      bool didLongPress = false;

      await tester.pumpWidget(
436
        Directionality(
437
          textDirection: TextDirection.ltr,
438
          child: WidgetInspector(
439
            selectButtonBuilder: null,
440
            child: GestureDetector(
441 442 443 444 445 446
              onLongPress: () {
                expect(didLongPress, isFalse);
                didLongPress = true;
              },
              child: const Text('target', textDirection: TextDirection.ltr),
            ),
447
          ),
448
        ),
449 450 451 452 453 454 455 456
      );

      await tester.longPress(find.text('target'));
      // The inspector will swallow the long press.
      expect(didLongPress, isFalse);
    });

    testWidgets('WidgetInspector offstage', (WidgetTester tester) async {
457 458
      final GlobalKey inspectorKey = GlobalKey();
      final GlobalKey clickTarget = GlobalKey();
459 460

      Widget createSubtree({ double width, Key key }) {
461
        return Stack(
462
          children: <Widget>[
463
            Positioned(
464 465 466 467 468
              key: key,
              left: 0.0,
              top: 0.0,
              width: width,
              height: 100.0,
469
              child: Text(width.toString(), textDirection: TextDirection.ltr),
470 471 472 473 474
            ),
          ],
        );
      }
      await tester.pumpWidget(
475
        Directionality(
476
          textDirection: TextDirection.ltr,
477
          child: WidgetInspector(
478 479
            key: inspectorKey,
            selectButtonBuilder: null,
480
            child: Overlay(
481
              initialEntries: <OverlayEntry>[
482
                OverlayEntry(
483 484 485 486
                  opaque: false,
                  maintainState: true,
                  builder: (BuildContext _) => createSubtree(width: 94.0),
                ),
487
                OverlayEntry(
488 489 490 491
                  opaque: true,
                  maintainState: true,
                  builder: (BuildContext _) => createSubtree(width: 95.0),
                ),
492
                OverlayEntry(
493 494 495 496 497 498
                  opaque: false,
                  maintainState: true,
                  builder: (BuildContext _) => createSubtree(width: 96.0, key: clickTarget),
                ),
              ],
            ),
499
          ),
500
        ),
501
      );
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522

      await tester.longPress(find.byKey(clickTarget));
      // State type is private, hence using dynamic.
      final dynamic inspectorState = inspectorKey.currentState;
      // The object with width 95.0 wins over the object with width 94.0 because
      // the subtree with width 94.0 is offstage.
      expect(inspectorState.selection.current.semanticBounds.width, equals(95.0));

      // Exactly 2 out of the 3 text elements should be in the candidate list of
      // objects to select as only 2 are onstage.
      expect(inspectorState.selection.candidates.where((RenderObject object) => object is RenderParagraph).length, equals(2));
    });

    test('WidgetInspectorService null id', () {
      service.disposeAllGroups();
      expect(service.toObject(null), isNull);
      expect(service.toId(null, 'test-group'), isNull);
    });

    test('WidgetInspectorService dispose group', () {
      service.disposeAllGroups();
523
      final Object a = Object();
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
      const String group1 = 'group-1';
      const String group2 = 'group-2';
      const String group3 = 'group-3';
      final String aId = service.toId(a, group1);
      expect(service.toId(a, group2), equals(aId));
      expect(service.toId(a, group3), equals(aId));
      service.disposeGroup(group1);
      service.disposeGroup(group2);
      expect(service.toObject(aId), equals(a));
      service.disposeGroup(group3);
      expect(() => service.toObject(aId), throwsFlutterError);
    });

    test('WidgetInspectorService dispose id', () {
      service.disposeAllGroups();
539 540
      final Object a = Object();
      final Object b = Object();
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
      const String group1 = 'group-1';
      const String group2 = 'group-2';
      final String aId = service.toId(a, group1);
      final String bId = service.toId(b, group1);
      expect(service.toId(a, group2), equals(aId));
      service.disposeId(bId, group1);
      expect(() => service.toObject(bId), throwsFlutterError);
      service.disposeId(aId, group1);
      expect(service.toObject(aId), equals(a));
      service.disposeId(aId, group2);
      expect(() => service.toObject(aId), throwsFlutterError);
    });

    test('WidgetInspectorService toObjectForSourceLocation', () {
      const String group = 'test-group';
556
      const Text widget = Text('a', textDirection: TextDirection.ltr);
557 558 559 560 561 562 563 564 565 566 567 568
      service.disposeAllGroups();
      final String id = service.toId(widget, group);
      expect(service.toObjectForSourceLocation(id), equals(widget));
      final Element element = widget.createElement();
      final String elementId = service.toId(element, group);
      expect(service.toObjectForSourceLocation(elementId), equals(widget));
      expect(element, isNot(equals(widget)));
      service.disposeGroup(group);
      expect(() => service.toObjectForSourceLocation(elementId), throwsFlutterError);
    });

    test('WidgetInspectorService object id test', () {
569 570 571 572
      const Text a = Text('a', textDirection: TextDirection.ltr);
      const Text b = Text('b', textDirection: TextDirection.ltr);
      const Text c = Text('c', textDirection: TextDirection.ltr);
      const Text d = Text('d', textDirection: TextDirection.ltr);
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601

      const String group1 = 'group-1';
      const String group2 = 'group-2';
      const String group3 = 'group-3';
      service.disposeAllGroups();

      final String aId = service.toId(a, group1);
      final String bId = service.toId(b, group2);
      final String cId = service.toId(c, group3);
      final String dId = service.toId(d, group1);
      // Make sure we get a consistent id if we add the object to a group multiple
      // times.
      expect(aId, equals(service.toId(a, group1)));
      expect(service.toObject(aId), equals(a));
      expect(service.toObject(aId), isNot(equals(b)));
      expect(service.toObject(bId), equals(b));
      expect(service.toObject(cId), equals(c));
      expect(service.toObject(dId), equals(d));
      // Make sure we get a consistent id even if we add the object to a different
      // group.
      expect(aId, equals(service.toId(a, group3)));
      expect(aId, isNot(equals(bId)));
      expect(aId, isNot(equals(cId)));

      service.disposeGroup(group3);
    });

    testWidgets('WidgetInspectorService maybeSetSelection', (WidgetTester tester) async {
      await tester.pumpWidget(
602
        Directionality(
603
          textDirection: TextDirection.ltr,
604
          child: Stack(
605
            children: const <Widget>[
606 607 608
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
609 610
            ],
          ),
611
        ),
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
      );
      final Element elementA = find.text('a').evaluate().first;
      final Element elementB = find.text('b').evaluate().first;

      service.disposeAllGroups();
      service.selection.clear();
      int selectionChangedCount = 0;
      service.selectionChangedCallback = () => selectionChangedCount++;
      service.setSelection('invalid selection');
      expect(selectionChangedCount, equals(0));
      expect(service.selection.currentElement, isNull);
      service.setSelection(elementA);
      expect(selectionChangedCount, equals(1));
      expect(service.selection.currentElement, equals(elementA));
      expect(service.selection.current, equals(elementA.renderObject));

      service.setSelection(elementB.renderObject);
      expect(selectionChangedCount, equals(2));
      expect(service.selection.current, equals(elementB.renderObject));
      expect(service.selection.currentElement, equals(elementB.renderObject.debugCreator.element));

      service.setSelection('invalid selection');
      expect(selectionChangedCount, equals(2));
      expect(service.selection.current, equals(elementB.renderObject));

      service.setSelectionById(service.toId(elementA, 'my-group'));
      expect(selectionChangedCount, equals(3));
      expect(service.selection.currentElement, equals(elementA));
      expect(service.selection.current, equals(elementA.renderObject));

      service.setSelectionById(service.toId(elementA, 'my-group'));
      expect(selectionChangedCount, equals(3));
      expect(service.selection.currentElement, equals(elementA));
    });

    testWidgets('WidgetInspectorService getParentChain', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
651
        Directionality(
652
          textDirection: TextDirection.ltr,
653
          child: Stack(
654
            children: const <Widget>[
655 656 657
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
658 659
            ],
          ),
660
        ),
661 662 663 664 665 666 667
      );

      service.disposeAllGroups();
      final Element elementB = find.text('b').evaluate().first;
      final String bId = service.toId(elementB, group);
      final Object jsonList = json.decode(service.getParentChain(bId, group));
      expect(jsonList, isList);
668
      final List<Object> chainElements = jsonList as List<Object>;
669 670 671 672 673 674 675
      final List<Element> expectedChain = elementB.debugGetDiagnosticChain()?.reversed?.toList();
      // Sanity check that the chain goes back to the root.
      expect(expectedChain.first, tester.binding.renderViewElement);

      expect(chainElements.length, equals(expectedChain.length));
      for (int i = 0; i < expectedChain.length; i += 1) {
        expect(chainElements[i], isMap);
676
        final Map<String, Object> chainNode = chainElements[i] as Map<String, Object>;
677 678
        final Element element = expectedChain[i];
        expect(chainNode['node'], isMap);
679 680
        final Map<String, Object> jsonNode = chainNode['node'] as Map<String, Object>;
        expect(service.toObject(jsonNode['valueId'] as String), equals(element));
Dan Field's avatar
Dan Field committed
681
        expect(service.toObject(jsonNode['objectId'] as String), isA<DiagnosticsNode>());
682 683

        expect(chainNode['children'], isList);
684
        final List<Object> jsonChildren = chainNode['children'] as List<Object>;
685 686 687 688 689 690 691 692 693 694
        final List<Element> childrenElements = <Element>[];
        element.visitChildren(childrenElements.add);
        expect(jsonChildren.length, equals(childrenElements.length));
        if (i + 1 == expectedChain.length) {
          expect(chainNode['childIndex'], isNull);
        } else {
          expect(chainNode['childIndex'], equals(childrenElements.indexOf(expectedChain[i+1])));
        }
        for (int j = 0; j < childrenElements.length; j += 1) {
          expect(jsonChildren[j], isMap);
695 696
          final Map<String, Object> childJson = jsonChildren[j] as Map<String, Object>;
          expect(service.toObject(childJson['valueId'] as String), equals(childrenElements[j]));
Dan Field's avatar
Dan Field committed
697
          expect(service.toObject(childJson['objectId'] as String), isA<DiagnosticsNode>());
698 699 700 701 702 703 704 705 706
        }
      }
    });

    test('WidgetInspectorService getProperties', () {
      final DiagnosticsNode diagnostic = const Text('a', textDirection: TextDirection.ltr).toDiagnosticsNode();
      const String group = 'group';
      service.disposeAllGroups();
      final String id = service.toId(diagnostic, group);
707
      final List<Object> propertiesJson = json.decode(service.getProperties(id, group)) as List<Object>;
708 709 710 711
      final List<DiagnosticsNode> properties = diagnostic.getProperties();
      expect(properties, isNotEmpty);
      expect(propertiesJson.length, equals(properties.length));
      for (int i = 0; i < propertiesJson.length; ++i) {
712 713
        final Map<String, Object> propertyJson = propertiesJson[i] as Map<String, Object>;
        expect(service.toObject(propertyJson['valueId'] as String), equals(properties[i].value));
Dan Field's avatar
Dan Field committed
714
        expect(service.toObject(propertyJson['objectId'] as String), isA<DiagnosticsNode>());
715 716 717 718 719 720 721
      }
    });

    testWidgets('WidgetInspectorService getChildren', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
722
        Directionality(
723
          textDirection: TextDirection.ltr,
724
          child: Stack(
725
            children: const <Widget>[
726 727 728
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
729 730 731 732 733 734 735
            ],
          ),
        ),
      );
      final DiagnosticsNode diagnostic = find.byType(Stack).evaluate().first.toDiagnosticsNode();
      service.disposeAllGroups();
      final String id = service.toId(diagnostic, group);
736
      final List<Object> propertiesJson = json.decode(service.getChildren(id, group)) as List<Object>;
737 738 739 740
      final List<DiagnosticsNode> children = diagnostic.getChildren();
      expect(children.length, equals(3));
      expect(propertiesJson.length, equals(children.length));
      for (int i = 0; i < propertiesJson.length; ++i) {
741 742
        final Map<String, Object> propertyJson = propertiesJson[i] as Map<String, Object>;
        expect(service.toObject(propertyJson['valueId'] as String), equals(children[i].value));
Dan Field's avatar
Dan Field committed
743
        expect(service.toObject(propertyJson['objectId'] as String), isA<DiagnosticsNode>());
744 745 746 747 748
      }
    });

    testWidgets('WidgetInspectorService creationLocation', (WidgetTester tester) async {
      await tester.pumpWidget(
749
        Directionality(
750
          textDirection: TextDirection.ltr,
751
          child: Stack(
752
            children: const <Widget>[
753 754 755
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
756 757 758 759 760 761 762 763
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;
      final Element elementB = find.text('b').evaluate().first;

      service.disposeAllGroups();
764
      service.setPubRootDirectories(<String>[]);
765
      service.setSelection(elementA, 'my-group');
766 767
      final Map<String, Object> jsonA = json.decode(service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
      final Map<String, Object> creationLocationA = jsonA['creationLocation'] as Map<String, Object>;
768
      expect(creationLocationA, isNotNull);
769 770 771 772
      final String fileA = creationLocationA['file'] as String;
      final int lineA = creationLocationA['line'] as int;
      final int columnA = creationLocationA['column'] as int;
      final List<Object> parameterLocationsA = creationLocationA['parameterLocations'] as List<Object>;
773 774

      service.setSelection(elementB, 'my-group');
775 776
      final Map<String, Object> jsonB = json.decode(service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
      final Map<String, Object> creationLocationB = jsonB['creationLocation'] as Map<String, Object>;
777
      expect(creationLocationB, isNotNull);
778 779 780 781
      final String fileB = creationLocationB['file'] as String;
      final int lineB = creationLocationB['line'] as int;
      final int columnB = creationLocationB['column'] as int;
      final List<Object> parameterLocationsB = creationLocationB['parameterLocations'] as List<Object>;
782 783 784 785 786 787
      expect(fileA, endsWith('widget_inspector_test.dart'));
      expect(fileA, equals(fileB));
      // We don't hardcode the actual lines the widgets are created on as that
      // would make this test fragile.
      expect(lineA + 1, equals(lineB));
      // Column numbers are more stable than line numbers.
788
      expect(columnA, equals(15));
789 790
      expect(columnA, equals(columnB));
      expect(parameterLocationsA.length, equals(1));
791
      final Map<String, Object> paramA = parameterLocationsA[0] as Map<String, Object>;
792 793
      expect(paramA['name'], equals('data'));
      expect(paramA['line'], equals(lineA));
794
      expect(paramA['column'], equals(20));
795 796

      expect(parameterLocationsB.length, equals(2));
797
      final Map<String, Object> paramB1 = parameterLocationsB[0] as Map<String, Object>;
798 799
      expect(paramB1['name'], equals('data'));
      expect(paramB1['line'], equals(lineB));
800
      expect(paramB1['column'], equals(20));
801
      final Map<String, Object> paramB2 = parameterLocationsB[1] as Map<String, Object>;
802 803
      expect(paramB2['name'], equals('textDirection'));
      expect(paramB2['line'], equals(lineB));
804
      expect(paramB2['column'], equals(25));
805 806
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
    testWidgets('test transformDebugCreator will re-order if after stack trace', (WidgetTester tester) async {
      final bool widgetTracked = WidgetInspectorService.instance.isWidgetCreationTracked();
      await tester.pumpWidget(
        Directionality(
          textDirection: TextDirection.ltr,
          child: Stack(
            children: const <Widget>[
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;
      String pubRootTest;
      if (widgetTracked) {
        final Map<String, Object> jsonObject = json.decode(
825 826
          service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
        final Map<String, Object> creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
827
        expect(creationLocation, isNotNull);
828
        final String fileA = creationLocation['file'] as String;
829 830 831 832 833 834 835 836 837
        expect(fileA, endsWith('widget_inspector_test.dart'));
        expect(jsonObject, isNot(contains('createdByLocalProject')));
        final List<String> segments = Uri
          .parse(fileA)
          .pathSegments;
        // Strip a couple subdirectories away to generate a plausible pub root
        // directory.
        pubRootTest = '/' +
          segments.take(segments.length - 2).join('/');
838
        service.setPubRootDirectories(<String>[pubRootTest]);
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
      }
      final DiagnosticPropertiesBuilder builder = DiagnosticPropertiesBuilder();
      builder.add(StringProperty('dummy1', 'value'));
      builder.add(StringProperty('dummy2', 'value'));
      builder.add(DiagnosticsStackTrace('When the exception was thrown, this was the stack', null));
      builder.add(DiagnosticsDebugCreator(DebugCreator(elementA)));

      final List<DiagnosticsNode> nodes = List<DiagnosticsNode>.from(transformDebugCreator(builder.properties));
      expect(nodes.length, 5);
      expect(nodes[0].runtimeType, StringProperty);
      expect(nodes[0].name, 'dummy1');
      expect(nodes[1].runtimeType, StringProperty);
      expect(nodes[1].name, 'dummy2');
      // transformed node should come in front of stack trace.
      if (widgetTracked) {
        expect(nodes[2].runtimeType, DiagnosticsBlock);
855
        final DiagnosticsBlock node = nodes[2] as DiagnosticsBlock;
856 857
        final List<DiagnosticsNode> children = node.getChildren();
        expect(children.length, 1);
858
        final ErrorDescription child = children[0] as ErrorDescription;
859
        expect(child.valueToString(), contains(Uri.parse(pubRootTest).path));
860 861
      } else {
        expect(nodes[2].runtimeType, ErrorDescription);
862
        final ErrorDescription node = nodes[2] as ErrorDescription;
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
        expect(node.valueToString().startsWith('Widget creation tracking is currently disabled.'), true);
      }
      expect(nodes[3].runtimeType, ErrorSpacer);
      expect(nodes[4].runtimeType, DiagnosticsStackTrace);
    });

    testWidgets('test transformDebugCreator will not re-order if before stack trace', (WidgetTester tester) async {
      final bool widgetTracked = WidgetInspectorService.instance.isWidgetCreationTracked();
      await tester.pumpWidget(
        Directionality(
          textDirection: TextDirection.ltr,
          child: Stack(
            children: const <Widget>[
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;
      String pubRootTest;
      if (widgetTracked) {
        final Map<String, Object> jsonObject = json.decode(
887 888
          service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
        final Map<String, Object> creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
889
        expect(creationLocation, isNotNull);
890
        final String fileA = creationLocation['file'] as String;
891 892 893 894 895 896 897 898 899
        expect(fileA, endsWith('widget_inspector_test.dart'));
        expect(jsonObject, isNot(contains('createdByLocalProject')));
        final List<String> segments = Uri
          .parse(fileA)
          .pathSegments;
        // Strip a couple subdirectories away to generate a plausible pub root
        // directory.
        pubRootTest = '/' +
          segments.take(segments.length - 2).join('/');
900
        service.setPubRootDirectories(<String>[pubRootTest]);
901 902 903 904 905 906 907 908 909 910 911 912 913 914
      }
      final DiagnosticPropertiesBuilder builder = DiagnosticPropertiesBuilder();
      builder.add(StringProperty('dummy1', 'value'));
      builder.add(DiagnosticsDebugCreator(DebugCreator(elementA)));
      builder.add(StringProperty('dummy2', 'value'));
      builder.add(DiagnosticsStackTrace('When the exception was thrown, this was the stack', null));

      final List<DiagnosticsNode> nodes = List<DiagnosticsNode>.from(transformDebugCreator(builder.properties));
      expect(nodes.length, 5);
      expect(nodes[0].runtimeType, StringProperty);
      expect(nodes[0].name, 'dummy1');
      // transformed node stays at original place.
      if (widgetTracked) {
        expect(nodes[1].runtimeType, DiagnosticsBlock);
915
        final DiagnosticsBlock node = nodes[1] as DiagnosticsBlock;
916 917
        final List<DiagnosticsNode> children = node.getChildren();
        expect(children.length, 1);
918
        final ErrorDescription child = children[0] as ErrorDescription;
919
        expect(child.valueToString(), contains(Uri.parse(pubRootTest).path));
920 921
      } else {
        expect(nodes[1].runtimeType, ErrorDescription);
922
        final ErrorDescription node = nodes[1] as ErrorDescription;
923 924 925 926 927 928 929 930
        expect(node.valueToString().startsWith('Widget creation tracking is currently disabled.'), true);
      }
      expect(nodes[2].runtimeType, ErrorSpacer);
      expect(nodes[3].runtimeType, StringProperty);
      expect(nodes[3].name, 'dummy2');
      expect(nodes[4].runtimeType, DiagnosticsStackTrace);
    }, skip: WidgetInspectorService.instance.isWidgetCreationTracked());

931 932
    testWidgets('WidgetInspectorService setPubRootDirectories', (WidgetTester tester) async {
      await tester.pumpWidget(
933
        Directionality(
934
          textDirection: TextDirection.ltr,
935
          child: Stack(
936
            children: const <Widget>[
937 938 939
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
940 941 942 943 944 945 946
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;

      service.disposeAllGroups();
947
      service.setPubRootDirectories(<String>[]);
948
      service.setSelection(elementA, 'my-group');
949 950
      Map<String, Object> jsonObject = json.decode(service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
      Map<String, Object> creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
951
      expect(creationLocation, isNotNull);
952
      final String fileA = creationLocation['file'] as String;
953 954 955 956 957 958
      expect(fileA, endsWith('widget_inspector_test.dart'));
      expect(jsonObject, isNot(contains('createdByLocalProject')));
      final List<String> segments = Uri.parse(fileA).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest = '/' + segments.take(segments.length - 2).join('/');
959
      service.setPubRootDirectories(<String>[pubRootTest]);
960 961 962 963

      service.setSelection(elementA, 'my-group');
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));

964
      service.setPubRootDirectories(<String>['/invalid/$pubRootTest']);
965 966
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), isNot(contains('createdByLocalProject')));

967
      service.setPubRootDirectories(<String>['file://$pubRootTest']);
968 969
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));

970
      service.setPubRootDirectories(<String>['$pubRootTest/different']);
971 972
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), isNot(contains('createdByLocalProject')));

973
      service.setPubRootDirectories(<String>[
974 975 976 977 978 979 980 981 982 983 984 985
        '/invalid/$pubRootTest',
        pubRootTest,
      ]);
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));

      // The RichText child of the Text widget is created by the core framework
      // not the current package.
      final Element richText = find.descendant(
        of: find.text('a'),
        matching: find.byType(RichText),
      ).evaluate().first;
      service.setSelection(richText, 'my-group');
986
      service.setPubRootDirectories(<String>[pubRootTest]);
987
      jsonObject = json.decode(service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
988
      expect(jsonObject, isNot(contains('createdByLocalProject')));
989
      creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
990 991 992
      expect(creationLocation, isNotNull);
      // This RichText widget is created by the build method of the Text widget
      // thus the creation location is in text.dart not basic.dart
993
      final List<String> pathSegmentsFramework = Uri.parse(creationLocation['file'] as String).pathSegments;
994
      expect(pathSegmentsFramework.join('/'), endsWith('/flutter/lib/src/widgets/text.dart'));
995 996 997

      // Strip off /src/widgets/text.dart.
      final String pubRootFramework = '/' + pathSegmentsFramework.take(pathSegmentsFramework.length - 3).join('/');
998
      service.setPubRootDirectories(<String>[pubRootFramework]);
999 1000 1001 1002
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));
      service.setSelection(elementA, 'my-group');
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), isNot(contains('createdByLocalProject')));

1003
      service.setPubRootDirectories(<String>[pubRootFramework, pubRootTest]);
1004 1005 1006 1007
      service.setSelection(elementA, 'my-group');
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));
      service.setSelection(richText, 'my-group');
      expect(json.decode(service.getSelectedWidget(null, 'my-group')), contains('createdByLocalProject'));
1008
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked() || isBrowser); // Test requires --track-widget-creation flag.
1009 1010

    test('ext.flutter.inspector.disposeGroup', () async {
1011
      final Object a = Object();
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
      const String group1 = 'group-1';
      const String group2 = 'group-2';
      const String group3 = 'group-3';
      final String aId = service.toId(a, group1);
      expect(service.toId(a, group2), equals(aId));
      expect(service.toId(a, group3), equals(aId));
      await service.testExtension('disposeGroup', <String, String>{'objectGroup': group1});
      await service.testExtension('disposeGroup', <String, String>{'objectGroup': group2});
      expect(service.toObject(aId), equals(a));
      await service.testExtension('disposeGroup', <String, String>{'objectGroup': group3});
      expect(() => service.toObject(aId), throwsFlutterError);
    });

    test('ext.flutter.inspector.disposeId', () async {
1026 1027
      final Object a = Object();
      final Object b = Object();
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
      const String group1 = 'group-1';
      const String group2 = 'group-2';
      final String aId = service.toId(a, group1);
      final String bId = service.toId(b, group1);
      expect(service.toId(a, group2), equals(aId));
      await service.testExtension('disposeId', <String, String>{'arg': bId, 'objectGroup': group1});
      expect(() => service.toObject(bId), throwsFlutterError);
      await service.testExtension('disposeId', <String, String>{'arg': aId, 'objectGroup': group1});
      expect(service.toObject(aId), equals(a));
      await service.testExtension('disposeId', <String, String>{'arg': aId, 'objectGroup': group2});
      expect(() => service.toObject(aId), throwsFlutterError);
    });

    testWidgets('ext.flutter.inspector.setSelection', (WidgetTester tester) async {
      await tester.pumpWidget(
1043
        Directionality(
1044
          textDirection: TextDirection.ltr,
1045
          child: Stack(
1046
            children: const <Widget>[
1047 1048 1049
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;
      final Element elementB = find.text('b').evaluate().first;

      service.disposeAllGroups();
      service.selection.clear();
      int selectionChangedCount = 0;
      service.selectionChangedCallback = () => selectionChangedCount++;
      service.setSelection('invalid selection');
      expect(selectionChangedCount, equals(0));
      expect(service.selection.currentElement, isNull);
      service.setSelection(elementA);
      expect(selectionChangedCount, equals(1));
      expect(service.selection.currentElement, equals(elementA));
      expect(service.selection.current, equals(elementA.renderObject));

      service.setSelection(elementB.renderObject);
      expect(selectionChangedCount, equals(2));
      expect(service.selection.current, equals(elementB.renderObject));
      expect(service.selection.currentElement, equals(elementB.renderObject.debugCreator.element));

      service.setSelection('invalid selection');
      expect(selectionChangedCount, equals(2));
      expect(service.selection.current, equals(elementB.renderObject));

1078
      await service.testExtension('setSelectionById', <String, String>{'arg': service.toId(elementA, 'my-group'), 'objectGroup': 'my-group'});
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
      expect(selectionChangedCount, equals(3));
      expect(service.selection.currentElement, equals(elementA));
      expect(service.selection.current, equals(elementA.renderObject));

      service.setSelectionById(service.toId(elementA, 'my-group'));
      expect(selectionChangedCount, equals(3));
      expect(service.selection.currentElement, equals(elementA));
    });

    testWidgets('ext.flutter.inspector.getParentChain', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1092
        Directionality(
1093
          textDirection: TextDirection.ltr,
1094
          child: Stack(
1095
            children: const <Widget>[
1096 1097 1098
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1099 1100
            ],
          ),
1101
        ),
1102 1103 1104 1105 1106 1107
      );

      final Element elementB = find.text('b').evaluate().first;
      final String bId = service.toId(elementB, group);
      final Object jsonList = await service.testExtension('getParentChain', <String, String>{'arg': bId, 'objectGroup': group});
      expect(jsonList, isList);
1108
      final List<Object> chainElements = jsonList as List<Object>;
1109 1110 1111 1112 1113 1114 1115
      final List<Element> expectedChain = elementB.debugGetDiagnosticChain()?.reversed?.toList();
      // Sanity check that the chain goes back to the root.
      expect(expectedChain.first, tester.binding.renderViewElement);

      expect(chainElements.length, equals(expectedChain.length));
      for (int i = 0; i < expectedChain.length; i += 1) {
        expect(chainElements[i], isMap);
1116
        final Map<String, Object> chainNode = chainElements[i] as Map<String, Object>;
1117 1118
        final Element element = expectedChain[i];
        expect(chainNode['node'], isMap);
1119 1120
        final Map<String, Object> jsonNode = chainNode['node'] as Map<String, Object>;
        expect(service.toObject(jsonNode['valueId'] as String), equals(element));
Dan Field's avatar
Dan Field committed
1121
        expect(service.toObject(jsonNode['objectId'] as String), isA<DiagnosticsNode>());
1122 1123

        expect(chainNode['children'], isList);
1124
        final List<Object> jsonChildren = chainNode['children'] as List<Object>;
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
        final List<Element> childrenElements = <Element>[];
        element.visitChildren(childrenElements.add);
        expect(jsonChildren.length, equals(childrenElements.length));
        if (i + 1 == expectedChain.length) {
          expect(chainNode['childIndex'], isNull);
        } else {
          expect(chainNode['childIndex'], equals(childrenElements.indexOf(expectedChain[i+1])));
        }
        for (int j = 0; j < childrenElements.length; j += 1) {
          expect(jsonChildren[j], isMap);
1135 1136
          final Map<String, Object> childJson = jsonChildren[j] as Map<String, Object>;
          expect(service.toObject(childJson['valueId'] as String), equals(childrenElements[j]));
Dan Field's avatar
Dan Field committed
1137
          expect(service.toObject(childJson['objectId'] as String), isA<DiagnosticsNode>());
1138
        }
1139
      }
1140 1141 1142 1143 1144 1145
    });

    test('ext.flutter.inspector.getProperties', () async {
      final DiagnosticsNode diagnostic = const Text('a', textDirection: TextDirection.ltr).toDiagnosticsNode();
      const String group = 'group';
      final String id = service.toId(diagnostic, group);
1146
      final List<Object> propertiesJson = await service.testExtension('getProperties', <String, String>{'arg': id, 'objectGroup': group}) as List<Object>;
1147 1148 1149 1150
      final List<DiagnosticsNode> properties = diagnostic.getProperties();
      expect(properties, isNotEmpty);
      expect(propertiesJson.length, equals(properties.length));
      for (int i = 0; i < propertiesJson.length; ++i) {
1151 1152
        final Map<String, Object> propertyJson = propertiesJson[i] as Map<String, Object>;
        expect(service.toObject(propertyJson['valueId'] as String), equals(properties[i].value));
Dan Field's avatar
Dan Field committed
1153
        expect(service.toObject(propertyJson['objectId'] as String), isA<DiagnosticsNode>());
1154
      }
1155 1156 1157 1158 1159 1160
    });

    testWidgets('ext.flutter.inspector.getChildren', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1161
        Directionality(
1162
          textDirection: TextDirection.ltr,
1163
          child: Stack(
1164
            children: const <Widget>[
1165 1166 1167
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1168 1169
            ],
          ),
1170
        ),
1171 1172 1173
      );
      final DiagnosticsNode diagnostic = find.byType(Stack).evaluate().first.toDiagnosticsNode();
      final String id = service.toId(diagnostic, group);
1174
      final List<Object> propertiesJson = await service.testExtension('getChildren', <String, String>{'arg': id, 'objectGroup': group}) as List<Object>;
1175 1176 1177 1178
      final List<DiagnosticsNode> children = diagnostic.getChildren();
      expect(children.length, equals(3));
      expect(propertiesJson.length, equals(children.length));
      for (int i = 0; i < propertiesJson.length; ++i) {
1179 1180
        final Map<String, Object> propertyJson = propertiesJson[i] as Map<String, Object>;
        expect(service.toObject(propertyJson['valueId'] as String), equals(children[i].value));
Dan Field's avatar
Dan Field committed
1181
        expect(service.toObject(propertyJson['objectId'] as String), isA<DiagnosticsNode>());
1182 1183 1184
      }
    });

1185 1186 1187 1188
    testWidgets('ext.flutter.inspector.getChildrenDetailsSubtree', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1189
        Directionality(
1190
          textDirection: TextDirection.ltr,
1191
          child: Stack(
1192
            children: const <Widget>[
1193 1194 1195
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1196 1197 1198 1199 1200 1201
            ],
          ),
        ),
      );
      final DiagnosticsNode diagnostic = find.byType(Stack).evaluate().first.toDiagnosticsNode();
      final String id = service.toId(diagnostic, group);
1202
      final List<Object> childrenJson = await service.testExtension('getChildrenDetailsSubtree', <String, String>{'arg': id, 'objectGroup': group}) as List<Object>;
1203 1204 1205 1206
      final List<DiagnosticsNode> children = diagnostic.getChildren();
      expect(children.length, equals(3));
      expect(childrenJson.length, equals(children.length));
      for (int i = 0; i < childrenJson.length; ++i) {
1207 1208
        final Map<String, Object> childJson = childrenJson[i] as Map<String, Object>;
        expect(service.toObject(childJson['valueId'] as String), equals(children[i].value));
Dan Field's avatar
Dan Field committed
1209
        expect(service.toObject(childJson['objectId'] as String), isA<DiagnosticsNode>());
1210 1211
        final List<Object> propertiesJson = childJson['properties'] as List<Object>;
        final DiagnosticsNode diagnosticsNode = service.toObject(childJson['objectId'] as String) as DiagnosticsNode;
1212
        final List<DiagnosticsNode> expectedProperties = diagnosticsNode.getProperties();
1213
        for (final Map<String, Object> propertyJson in propertiesJson.cast<Map<String, Object>>()) {
1214
          final Object property = service.toObject(propertyJson['objectId'] as String);
Dan Field's avatar
Dan Field committed
1215
          expect(property, isA<DiagnosticsNode>());
1216
          expect(expectedProperties, contains(property));
1217 1218 1219 1220 1221 1222 1223 1224
        }
      }
    });

    testWidgets('WidgetInspectorService getDetailsSubtree', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1225
        Directionality(
1226
          textDirection: TextDirection.ltr,
1227
          child: Stack(
1228
            children: const <Widget>[
1229 1230 1231
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1232 1233 1234 1235 1236 1237
            ],
          ),
        ),
      );
      final DiagnosticsNode diagnostic = find.byType(Stack).evaluate().first.toDiagnosticsNode();
      final String id = service.toId(diagnostic, group);
1238
      final Map<String, Object> subtreeJson = await service.testExtension('getDetailsSubtree', <String, String>{'arg': id, 'objectGroup': group}) as Map<String, Object>;
1239
      expect(subtreeJson['objectId'], equals(id));
1240
      final List<Object> childrenJson = subtreeJson['children'] as List<Object>;
1241 1242 1243 1244
      final List<DiagnosticsNode> children = diagnostic.getChildren();
      expect(children.length, equals(3));
      expect(childrenJson.length, equals(children.length));
      for (int i = 0; i < childrenJson.length; ++i) {
1245 1246
        final Map<String, Object> childJson = childrenJson[i] as Map<String, Object>;
        expect(service.toObject(childJson['valueId'] as String), equals(children[i].value));
Dan Field's avatar
Dan Field committed
1247
        expect(service.toObject(childJson['objectId'] as String), isA<DiagnosticsNode>());
1248
        final List<Object> propertiesJson = childJson['properties'] as List<Object>;
1249
        for (final Map<String, Object> propertyJson in propertiesJson.cast<Map<String, Object>>()) {
1250 1251
          expect(propertyJson, isNot(contains('children')));
        }
1252
        final DiagnosticsNode diagnosticsNode = service.toObject(childJson['objectId'] as String) as DiagnosticsNode;
1253
        final List<DiagnosticsNode> expectedProperties = diagnosticsNode.getProperties();
1254
        for (final Map<String, Object> propertyJson in propertiesJson.cast<Map<String, Object>>()) {
1255
          final Object property = service.toObject(propertyJson['objectId'] as String);
Dan Field's avatar
Dan Field committed
1256
          expect(property, isA<DiagnosticsNode>());
1257 1258 1259 1260 1261 1262 1263
          expect(expectedProperties, contains(property));
        }
      }

      final Map<String, Object> deepSubtreeJson = await service.testExtension(
        'getDetailsSubtree',
        <String, String>{'arg': id, 'objectGroup': group, 'subtreeDepth': '3'},
1264 1265
      ) as Map<String, Object>;
      final List<Object> deepChildrenJson = deepSubtreeJson['children'] as List<Object>;
1266
      for (final Map<String, Object> childJson in deepChildrenJson.cast<Map<String, Object>>()) {
1267
        final List<Object> propertiesJson = childJson['properties'] as List<Object>;
1268
        for (final Map<String, Object> propertyJson in propertiesJson.cast<Map<String, Object>>()) {
1269
          expect(propertyJson, contains('children'));
1270 1271 1272 1273
        }
      }
    });

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
    testWidgets('cyclic diagnostics regression test', (WidgetTester tester) async {
      const String group = 'test-group';
      final CyclicDiagnostic a = CyclicDiagnostic('a');
      final CyclicDiagnostic b = CyclicDiagnostic('b');
      a.related = b;
      a.children.add(b.toDiagnosticsNode());
      b.related = a;

      final DiagnosticsNode diagnostic = a.toDiagnosticsNode();
      final String id = service.toId(diagnostic, group);
1284
      final Map<String, Object> subtreeJson = await service.testExtension('getDetailsSubtree', <String, String>{'arg': id, 'objectGroup': group}) as Map<String, Object>;
1285
      expect(subtreeJson['objectId'], equals(id));
1286
      expect(subtreeJson, contains('children'));
1287
      final List<Object> propertiesJson = subtreeJson['properties'] as List<Object>;
1288
      expect(propertiesJson.length, equals(1));
1289
      final Map<String, Object> relatedProperty = propertiesJson.first as Map<String, Object>;
1290 1291
      expect(relatedProperty['name'], equals('related'));
      expect(relatedProperty['description'], equals('CyclicDiagnostic-b'));
1292 1293 1294
      expect(relatedProperty, contains('isDiagnosticableValue'));
      expect(relatedProperty, isNot(contains('children')));
      expect(relatedProperty, contains('properties'));
1295
      final List<Object> relatedWidgetProperties = relatedProperty['properties'] as List<Object>;
1296
      expect(relatedWidgetProperties.length, equals(1));
1297
      final Map<String, Object> nestedRelatedProperty = relatedWidgetProperties.first as Map<String, Object>;
1298 1299 1300 1301 1302
      expect(nestedRelatedProperty['name'], equals('related'));
      // Make sure we do not include properties or children for diagnostic a
      // which we already included as the root node as that would indicate a
      // cycle.
      expect(nestedRelatedProperty['description'], equals('CyclicDiagnostic-a'));
1303 1304 1305
      expect(nestedRelatedProperty, contains('isDiagnosticableValue'));
      expect(nestedRelatedProperty, isNot(contains('properties')));
      expect(nestedRelatedProperty, isNot(contains('children')));
1306 1307
    });

1308 1309 1310 1311
    testWidgets('ext.flutter.inspector.getRootWidgetSummaryTree', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1312
        Directionality(
1313
          textDirection: TextDirection.ltr,
1314
          child: Stack(
1315
            children: const <Widget>[
1316 1317 1318
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1319 1320 1321 1322 1323 1324 1325 1326 1327
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;

      service.disposeAllGroups();
      await service.testExtension('setPubRootDirectories', <String, String>{});
      service.setSelection(elementA, 'my-group');
1328
      final Map<String, Object> jsonA = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
1329 1330

      await service.testExtension('setPubRootDirectories', <String, String>{});
1331
      Map<String, Object> rootJson = await service.testExtension('getRootWidgetSummaryTree', <String, String>{'objectGroup': group}) as Map<String, Object>;
1332 1333 1334
      // We haven't yet properly specified which directories are summary tree
      // directories so we get an empty tree other than the root that is always
      // included.
1335
      final Object rootWidget = service.toObject(rootJson['valueId'] as String);
1336
      expect(rootWidget, equals(WidgetsBinding.instance?.renderViewElement));
1337
      List<Object> childrenJson = rootJson['children'] as List<Object>;
1338 1339 1340
      // There are no summary tree children.
      expect(childrenJson.length, equals(0));

1341
      final Map<String, Object> creationLocation = jsonA['creationLocation'] as Map<String, Object>;
1342
      expect(creationLocation, isNotNull);
1343
      final String testFile = creationLocation['file'] as String;
1344 1345 1346 1347 1348 1349 1350
      expect(testFile, endsWith('widget_inspector_test.dart'));
      final List<String> segments = Uri.parse(testFile).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest = '/' + segments.take(segments.length - 2).join('/');
      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': pubRootTest});

1351 1352
      rootJson = await service.testExtension('getRootWidgetSummaryTree', <String, String>{'objectGroup': group}) as Map<String, Object>;
      childrenJson = rootJson['children'] as List<Object>;
1353 1354
      // The tree of nodes returned contains all widgets created directly by the
      // test.
1355
      childrenJson = rootJson['children'] as List<Object>;
1356 1357
      expect(childrenJson.length, equals(1));

1358
      List<Object> alternateChildrenJson = await service.testExtension('getChildrenSummaryTree', <String, String>{'arg': rootJson['objectId'] as String, 'objectGroup': group}) as List<Object>;
1359
      expect(alternateChildrenJson.length, equals(1));
1360 1361
      Map<String, Object> childJson = childrenJson[0] as Map<String, Object>;
      Map<String, Object> alternateChildJson = alternateChildrenJson[0] as Map<String, Object>;
1362 1363 1364 1365
      expect(childJson['description'], startsWith('Directionality'));
      expect(alternateChildJson['description'], startsWith('Directionality'));
      expect(alternateChildJson['valueId'], equals(childJson['valueId']));

1366 1367
      childrenJson = childJson['children'] as List<Object>;
      alternateChildrenJson = await service.testExtension('getChildrenSummaryTree', <String, String>{'arg': childJson['objectId'] as String, 'objectGroup': group}) as List<Object>;
1368 1369
      expect(alternateChildrenJson.length, equals(1));
      expect(childrenJson.length, equals(1));
1370 1371
      alternateChildJson = alternateChildrenJson[0] as Map<String, Object>;
      childJson = childrenJson[0] as Map<String, Object>;
1372 1373 1374
      expect(childJson['description'], startsWith('Stack'));
      expect(alternateChildJson['description'], startsWith('Stack'));
      expect(alternateChildJson['valueId'], equals(childJson['valueId']));
1375
      childrenJson = childJson['children'] as List<Object>;
1376

1377 1378
      childrenJson = childJson['children'] as List<Object>;
      alternateChildrenJson = await service.testExtension('getChildrenSummaryTree', <String, String>{'arg': childJson['objectId'] as String, 'objectGroup': group}) as List<Object>;
1379 1380
      expect(alternateChildrenJson.length, equals(3));
      expect(childrenJson.length, equals(3));
1381 1382
      alternateChildJson = alternateChildrenJson[2] as Map<String, Object>;
      childJson = childrenJson[2] as Map<String, Object>;
1383 1384 1385
      expect(childJson['description'], startsWith('Text'));
      expect(alternateChildJson['description'], startsWith('Text'));
      expect(alternateChildJson['valueId'], equals(childJson['valueId']));
1386
      alternateChildrenJson = await service.testExtension('getChildrenSummaryTree', <String, String>{'arg': childJson['objectId'] as String, 'objectGroup': group}) as List<Object>;
1387 1388 1389 1390 1391 1392 1393 1394
      expect(alternateChildrenJson.length , equals(0));
      expect(childJson['chidlren'], isNull);
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.

    testWidgets('ext.flutter.inspector.getSelectedSummaryWidget', (WidgetTester tester) async {
      const String group = 'test-group';

      await tester.pumpWidget(
1395
        Directionality(
1396
          textDirection: TextDirection.ltr,
1397
          child: Stack(
1398
            children: const <Widget>[
1399 1400 1401
              Text('a', textDirection: TextDirection.ltr),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
            ],
          ),
        ),
      );
      final Element elementA = find.text('a').evaluate().first;

      final List<DiagnosticsNode> children = elementA.debugDescribeChildren();
      expect(children.length, equals(1));
      final DiagnosticsNode richTextDiagnostic = children.first;

      service.disposeAllGroups();
      await service.testExtension('setPubRootDirectories', <String, String>{});
      service.setSelection(elementA, 'my-group');
1415
      final Map<String, Object> jsonA = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
1416 1417 1418
      service.setSelection(richTextDiagnostic.value, 'my-group');

      await service.testExtension('setPubRootDirectories', <String, String>{});
1419
      Map<String, Object> summarySelection = await service.testExtension('getSelectedSummaryWidget', <String, String>{'objectGroup': group}) as Map<String, Object>;
1420 1421 1422 1423
      // No summary selection because we haven't set the pub root directories
      // yet to indicate what directories are in the summary tree.
      expect(summarySelection, isNull);

1424
      final Map<String, Object> creationLocation = jsonA['creationLocation'] as Map<String, Object>;
1425
      expect(creationLocation, isNotNull);
1426
      final String testFile = creationLocation['file'] as String;
1427 1428 1429 1430 1431 1432 1433
      expect(testFile, endsWith('widget_inspector_test.dart'));
      final List<String> segments = Uri.parse(testFile).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest = '/' + segments.take(segments.length - 2).join('/');
      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': pubRootTest});

1434
      summarySelection = await service.testExtension('getSelectedSummaryWidget', <String, String>{'objectGroup': group}) as Map<String, Object>;
1435 1436 1437
      expect(summarySelection['valueId'], isNotNull);
      // We got the Text element instead of the selected RichText element
      // because only the RichText element is part of the summary tree.
1438
      expect(service.toObject(summarySelection['valueId'] as String), elementA);
1439 1440 1441

      // Verify tha the regular getSelectedWidget method still returns
      // the RichText object not the Text element.
1442 1443
      final Map<String, Object> regularSelection = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
      expect(service.toObject(regularSelection['valueId'] as String), richTextDiagnostic.value);
1444
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.
1445

1446 1447
    testWidgets('ext.flutter.inspector creationLocation', (WidgetTester tester) async {
      await tester.pumpWidget(
1448
        Directionality(
1449
          textDirection: TextDirection.ltr,
1450
          child: Stack(
1451
            children: const <Widget>[
1452 1453 1454
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1455 1456
            ],
          ),
1457
        ),
1458 1459 1460 1461 1462 1463 1464
      );
      final Element elementA = find.text('a').evaluate().first;
      final Element elementB = find.text('b').evaluate().first;

      service.disposeAllGroups();
      await service.testExtension('setPubRootDirectories', <String, String>{});
      service.setSelection(elementA, 'my-group');
1465 1466
      final Map<String, Object> jsonA = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
      final Map<String, Object> creationLocationA = jsonA['creationLocation'] as Map<String, Object>;
1467
      expect(creationLocationA, isNotNull);
1468 1469 1470 1471
      final String fileA = creationLocationA['file'] as String;
      final int lineA = creationLocationA['line'] as int;
      final int columnA = creationLocationA['column'] as int;
      final List<Object> parameterLocationsA = creationLocationA['parameterLocations'] as List<Object>;
1472 1473

      service.setSelection(elementB, 'my-group');
1474 1475
      final Map<String, Object> jsonB = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
      final Map<String, Object> creationLocationB = jsonB['creationLocation'] as Map<String, Object>;
1476
      expect(creationLocationB, isNotNull);
1477 1478 1479 1480
      final String fileB = creationLocationB['file'] as String;
      final int lineB = creationLocationB['line'] as int;
      final int columnB = creationLocationB['column'] as int;
      final List<Object> parameterLocationsB = creationLocationB['parameterLocations'] as List<Object>;
1481 1482 1483 1484 1485 1486
      expect(fileA, endsWith('widget_inspector_test.dart'));
      expect(fileA, equals(fileB));
      // We don't hardcode the actual lines the widgets are created on as that
      // would make this test fragile.
      expect(lineA + 1, equals(lineB));
      // Column numbers are more stable than line numbers.
1487
      expect(columnA, equals(15));
1488 1489
      expect(columnA, equals(columnB));
      expect(parameterLocationsA.length, equals(1));
1490
      final Map<String, Object> paramA = parameterLocationsA[0] as Map<String, Object>;
1491 1492
      expect(paramA['name'], equals('data'));
      expect(paramA['line'], equals(lineA));
1493
      expect(paramA['column'], equals(20));
1494 1495

      expect(parameterLocationsB.length, equals(2));
1496
      final Map<String, Object> paramB1 = parameterLocationsB[0] as Map<String, Object>;
1497 1498
      expect(paramB1['name'], equals('data'));
      expect(paramB1['line'], equals(lineB));
1499
      expect(paramB1['column'], equals(20));
1500
      final Map<String, Object> paramB2 = parameterLocationsB[1] as Map<String, Object>;
1501 1502
      expect(paramB2['name'], equals('textDirection'));
      expect(paramB2['line'], equals(lineB));
1503
      expect(paramB2['column'], equals(25));
1504 1505 1506 1507
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.

    testWidgets('ext.flutter.inspector.setPubRootDirectories', (WidgetTester tester) async {
      await tester.pumpWidget(
1508
        Directionality(
1509
          textDirection: TextDirection.ltr,
1510
          child: Stack(
1511
            children: const <Widget>[
1512 1513 1514
              Text('a'),
              Text('b', textDirection: TextDirection.ltr),
              Text('c', textDirection: TextDirection.ltr),
1515 1516
            ],
          ),
1517
        ),
1518 1519 1520 1521 1522
      );
      final Element elementA = find.text('a').evaluate().first;

      await service.testExtension('setPubRootDirectories', <String, String>{});
      service.setSelection(elementA, 'my-group');
1523 1524
      Map<String, Object> jsonObject = await service.testExtension('getSelectedWidget', <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
      Map<String, Object> creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
1525
      expect(creationLocation, isNotNull);
1526
      final String fileA = creationLocation['file'] as String;
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
      expect(fileA, endsWith('widget_inspector_test.dart'));
      expect(jsonObject, isNot(contains('createdByLocalProject')));
      final List<String> segments = Uri.parse(fileA).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest = '/' + segments.take(segments.length - 2).join('/');
      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': pubRootTest});

      service.setSelection(elementA, 'my-group');
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));

      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': '/invalid/$pubRootTest'});
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), isNot(contains('createdByLocalProject')));

      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': 'file://$pubRootTest'});
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));

      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': '$pubRootTest/different'});
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), isNot(contains('createdByLocalProject')));

      await service.testExtension('setPubRootDirectories', <String, String>{
        'arg0': '/unrelated/$pubRootTest',
        'arg1': 'file://$pubRootTest',
      });

      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));

      // The RichText child of the Text widget is created by the core framework
      // not the current package.
      final Element richText = find.descendant(
        of: find.text('a'),
        matching: find.byType(RichText),
      ).evaluate().first;
      service.setSelection(richText, 'my-group');
1561
      service.setPubRootDirectories(<String>[pubRootTest]);
1562
      jsonObject = json.decode(service.getSelectedWidget(null, 'my-group')) as Map<String, Object>;
1563
      expect(jsonObject, isNot(contains('createdByLocalProject')));
1564
      creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
1565 1566 1567
      expect(creationLocation, isNotNull);
      // This RichText widget is created by the build method of the Text widget
      // thus the creation location is in text.dart not basic.dart
1568
      final List<String> pathSegmentsFramework = Uri.parse(creationLocation['file'] as String).pathSegments;
1569
      expect(pathSegmentsFramework.join('/'), endsWith('/flutter/lib/src/widgets/text.dart'));
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582

      // Strip off /src/widgets/text.dart.
      final String pubRootFramework = '/' + pathSegmentsFramework.take(pathSegmentsFramework.length - 3).join('/');
      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': pubRootFramework});
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));
      service.setSelection(elementA, 'my-group');
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), isNot(contains('createdByLocalProject')));

      await service.testExtension('setPubRootDirectories', <String, String>{'arg0': pubRootFramework, 'arg1': pubRootTest});
      service.setSelection(elementA, 'my-group');
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));
      service.setSelection(richText, 'my-group');
      expect(await service.testExtension('getSelectedWidget', <String, String>{'objectGroup': 'my-group'}), contains('createdByLocalProject'));
1583
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked() || isBrowser); // Test requires --track-widget-creation flag.
1584

1585 1586 1587
    testWidgets('ext.flutter.inspector.trackRebuildDirtyWidgets', (WidgetTester tester) async {
      service.rebuildCount = 0;

1588
      await tester.pumpWidget(const ClockDemo());
1589 1590 1591 1592 1593 1594

      final Element clockDemoElement = find.byType(ClockDemo).evaluate().first;

      service.setSelection(clockDemoElement, 'my-group');
      final Map<String, Object> jsonObject = await service.testExtension(
          'getSelectedWidget',
1595
          <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
1596
      final Map<String, Object> creationLocation =
1597
          jsonObject['creationLocation'] as Map<String, Object>;
1598
      expect(creationLocation, isNotNull);
1599
      final String file = creationLocation['file'] as String;
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
      expect(file, endsWith('widget_inspector_test.dart'));
      final List<String> segments = Uri.parse(file).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest =
          '/' + segments.take(segments.length - 2).join('/');
      await service.testExtension(
          'setPubRootDirectories', <String, String>{'arg0': pubRootTest});

      final List<Map<Object, Object>> rebuildEvents =
          service.getEventsDispatched('Flutter.RebuiltWidgets');
      expect(rebuildEvents, isEmpty);

      expect(service.rebuildCount, equals(0));
      expect(
          await service.testBoolExtension(
              'trackRebuildDirtyWidgets', <String, String>{'enabled': 'true'}),
          equals('true'));
      expect(service.rebuildCount, equals(1));
      await tester.pump();

      expect(rebuildEvents.length, equals(1));
      Map<Object, Object> event = rebuildEvents.removeLast();
Dan Field's avatar
Dan Field committed
1623
      expect(event['startTime'], isA<int>());
1624
      List<int> data = event['events'] as List<int>;
1625 1626
      expect(data.length, equals(14));
      final int numDataEntries = data.length ~/ 2;
1627
      Map<String, List<int>> newLocations = event['newLocations'] as Map<String, List<int>>;
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
      expect(newLocations, isNotNull);
      expect(newLocations.length, equals(1));
      expect(newLocations.keys.first, equals(file));
      final List<int> locationsForFile = newLocations[file];
      expect(locationsForFile.length, equals(21));
      final int numLocationEntries = locationsForFile.length ~/ 3;
      expect(numLocationEntries, equals(numDataEntries));

      final Map<int, _CreationLocation> knownLocations =
          <int, _CreationLocation>{};
      addToKnownLocationsMap(
        knownLocations: knownLocations,
        newLocations: newLocations,
      );
      int totalCount = 0;
      int maxCount = 0;
      for (int i = 0; i < data.length; i += 2) {
        final int id = data[i];
        final int count = data[i + 1];
        totalCount += count;
        maxCount = max(maxCount, count);
1649
        expect(knownLocations, contains(id));
1650 1651 1652 1653 1654 1655 1656 1657 1658
      }
      expect(totalCount, equals(27));
      // The creation locations that were rebuilt the most were rebuilt 6 times
      // as there are 6 instances of the ClockText widget.
      expect(maxCount, equals(6));

      final List<Element> clocks = find.byType(ClockText).evaluate().toList();
      expect(clocks.length, equals(6));
      // Update a single clock.
1659 1660
      StatefulElement clockElement = clocks.first as StatefulElement;
      _ClockTextState state = clockElement.state as _ClockTextState;
1661 1662 1663 1664
      state.updateTime(); // Triggers a rebuild.
      await tester.pump();
      expect(rebuildEvents.length, equals(1));
      event = rebuildEvents.removeLast();
Dan Field's avatar
Dan Field committed
1665
      expect(event['startTime'], isA<int>());
1666
      data = event['events'] as List<int>;
1667
      // No new locations were rebuilt.
1668
      expect(event, isNot(contains('newLocations')));
1669 1670 1671 1672 1673 1674 1675 1676 1677

      // There were two rebuilds: one for the ClockText element itself and one
      // for its child.
      expect(data.length, equals(4));
      int id = data[0];
      int count = data[1];
      _CreationLocation location = knownLocations[id];
      expect(location.file, equals(file));
      // ClockText widget.
1678
      expect(location.line, equals(55));
1679 1680 1681 1682 1683 1684 1685 1686
      expect(location.column, equals(9));
      expect(count, equals(1));

      id = data[2];
      count = data[3];
      location = knownLocations[id];
      expect(location.file, equals(file));
      // Text widget in _ClockTextState build method.
1687
      expect(location.line, equals(93));
1688 1689 1690 1691 1692
      expect(location.column, equals(12));
      expect(count, equals(1));

      // Update 3 of the clocks;
      for (int i = 0; i < 3; i++) {
1693 1694
        clockElement = clocks[i] as StatefulElement;
        state = clockElement.state as _ClockTextState;
1695 1696 1697 1698 1699 1700
        state.updateTime(); // Triggers a rebuild.
      }

      await tester.pump();
      expect(rebuildEvents.length, equals(1));
      event = rebuildEvents.removeLast();
Dan Field's avatar
Dan Field committed
1701
      expect(event['startTime'], isA<int>());
1702
      data = event['events'] as List<int>;
1703
      // No new locations were rebuilt.
1704
      expect(event, isNot(contains('newLocations')));
1705 1706 1707 1708 1709 1710 1711

      expect(data.length, equals(4));
      id = data[0];
      count = data[1];
      location = knownLocations[id];
      expect(location.file, equals(file));
      // ClockText widget.
1712
      expect(location.line, equals(55));
1713 1714 1715 1716 1717 1718 1719 1720
      expect(location.column, equals(9));
      expect(count, equals(3)); // 3 clock widget instances rebuilt.

      id = data[2];
      count = data[3];
      location = knownLocations[id];
      expect(location.file, equals(file));
      // Text widget in _ClockTextState build method.
1721
      expect(location.line, equals(93));
1722 1723 1724 1725
      expect(location.column, equals(12));
      expect(count, equals(3)); // 3 clock widget instances rebuilt.

      // Update one clock 3 times.
1726 1727
      clockElement = clocks.first as StatefulElement;
      state = clockElement.state as _ClockTextState;
1728 1729 1730 1731 1732 1733 1734
      state.updateTime(); // Triggers a rebuild.
      state.updateTime(); // Triggers a rebuild.
      state.updateTime(); // Triggers a rebuild.

      await tester.pump();
      expect(rebuildEvents.length, equals(1));
      event = rebuildEvents.removeLast();
Dan Field's avatar
Dan Field committed
1735
      expect(event['startTime'], isA<int>());
1736
      data = event['events'] as List<int>;
1737
      // No new locations were rebuilt.
1738
      expect(event, isNot(contains('newLocations')));
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

      expect(data.length, equals(4));
      id = data[0];
      count = data[1];
      // Even though a rebuild was triggered 3 times, only one rebuild actually
      // occurred.
      expect(count, equals(1));

      // Trigger a widget creation location that wasn't previously triggered.
      state.stopClock();
      await tester.pump();
      expect(rebuildEvents.length, equals(1));
      event = rebuildEvents.removeLast();
Dan Field's avatar
Dan Field committed
1752
      expect(event['startTime'], isA<int>());
1753 1754
      data = event['events'] as List<int>;
      newLocations = event['newLocations'] as Map<String, List<int>>;
1755 1756 1757 1758 1759 1760 1761

      expect(data.length, equals(4));
      // The second pair in data is the previously unseen rebuild location.
      id = data[2];
      count = data[3];
      expect(count, equals(1));
      // Verify the rebuild location is new.
1762
      expect(knownLocations, isNot(contains(id)));
1763 1764 1765 1766 1767
      addToKnownLocationsMap(
        knownLocations: knownLocations,
        newLocations: newLocations,
      );
      // Verify the rebuild location was included in the newLocations data.
1768
      expect(knownLocations, contains(id));
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786

      // Turn off rebuild counts.
      expect(
          await service.testBoolExtension(
              'trackRebuildDirtyWidgets', <String, String>{'enabled': 'false'}),
          equals('false'));

      state.updateTime(); // Triggers a rebuild.
      await tester.pump();
      // Verify that rebuild events are not fired once the extension is disabled.
      expect(rebuildEvents, isEmpty);
    },
        skip: !WidgetInspectorService.instance
            .isWidgetCreationTracked()); // Test requires --track-widget-creation flag.

    testWidgets('ext.flutter.inspector.trackRepaintWidgets', (WidgetTester tester) async {
      service.rebuildCount = 0;

1787
      await tester.pumpWidget(const ClockDemo());
1788 1789 1790 1791 1792 1793

      final Element clockDemoElement = find.byType(ClockDemo).evaluate().first;

      service.setSelection(clockDemoElement, 'my-group');
      final Map<String, Object> jsonObject = await service.testExtension(
          'getSelectedWidget',
1794
          <String, String>{'arg': null, 'objectGroup': 'my-group'}) as Map<String, Object>;
1795
      final Map<String, Object> creationLocation =
1796
          jsonObject['creationLocation'] as Map<String, Object>;
1797
      expect(creationLocation, isNotNull);
1798
      final String file = creationLocation['file'] as String;
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
      expect(file, endsWith('widget_inspector_test.dart'));
      final List<String> segments = Uri.parse(file).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub root
      // directory.
      final String pubRootTest =
          '/' + segments.take(segments.length - 2).join('/');
      await service.testExtension(
          'setPubRootDirectories', <String, String>{'arg0': pubRootTest});

      final List<Map<Object, Object>> repaintEvents =
          service.getEventsDispatched('Flutter.RepaintWidgets');
      expect(repaintEvents, isEmpty);

      expect(service.rebuildCount, equals(0));
      expect(
          await service.testBoolExtension(
              'trackRepaintWidgets', <String, String>{'enabled': 'true'}),
          equals('true'));
      // Unlike trackRebuildDirtyWidgets, trackRepaintWidgets doesn't force a full
      // rebuild.
      expect(service.rebuildCount, equals(0));

      await tester.pump();

      expect(repaintEvents.length, equals(1));
      Map<Object, Object> event = repaintEvents.removeLast();
Dan Field's avatar
Dan Field committed
1825
      expect(event['startTime'], isA<int>());
1826
      List<int> data = event['events'] as List<int>;
1827 1828
      expect(data.length, equals(18));
      final int numDataEntries = data.length ~/ 2;
1829
      final Map<String, List<int>> newLocations = event['newLocations'] as Map<String, List<int>>;
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
      expect(newLocations, isNotNull);
      expect(newLocations.length, equals(1));
      expect(newLocations.keys.first, equals(file));
      final List<int> locationsForFile = newLocations[file];
      expect(locationsForFile.length, equals(27));
      final int numLocationEntries = locationsForFile.length ~/ 3;
      expect(numLocationEntries, equals(numDataEntries));

      final Map<int, _CreationLocation> knownLocations =
          <int, _CreationLocation>{};
      addToKnownLocationsMap(
        knownLocations: knownLocations,
        newLocations: newLocations,
      );
      int totalCount = 0;
      int maxCount = 0;
      for (int i = 0; i < data.length; i += 2) {
        final int id = data[i];
        final int count = data[i + 1];
        totalCount += count;
        maxCount = max(maxCount, count);
1851
        expect(knownLocations, contains(id));
1852 1853 1854 1855 1856 1857 1858 1859 1860
      }
      expect(totalCount, equals(34));
      // The creation locations that were rebuilt the most were rebuilt 6 times
      // as there are 6 instances of the ClockText widget.
      expect(maxCount, equals(6));

      final List<Element> clocks = find.byType(ClockText).evaluate().toList();
      expect(clocks.length, equals(6));
      // Update a single clock.
1861 1862
      final StatefulElement clockElement = clocks.first as StatefulElement;
      final _ClockTextState state = clockElement.state as _ClockTextState;
1863 1864 1865 1866
      state.updateTime(); // Triggers a rebuild.
      await tester.pump();
      expect(repaintEvents.length, equals(1));
      event = repaintEvents.removeLast();
Dan Field's avatar
Dan Field committed
1867
      expect(event['startTime'], isA<int>());
1868
      data = event['events'] as List<int>;
1869
      // No new locations were rebuilt.
1870
      expect(event, isNot(contains('newLocations')));
1871

1872
      // Triggering a rebuild of one widget in this app causes the whole app
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
      // to repaint.
      expect(data.length, equals(18));

      // TODO(jacobr): add an additional repaint test that uses multiple repaint
      // boundaries to test more complex repaint conditions.

      // Turn off rebuild counts.
      expect(
          await service.testBoolExtension(
              'trackRepaintWidgets', <String, String>{'enabled': 'false'}),
          equals('false'));

      state.updateTime(); // Triggers a rebuild.
      await tester.pump();
1887
      // Verify that repaint events are not fired once the extension is disabled.
1888 1889 1890
      expect(repaintEvents, isEmpty);
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.

1891
    testWidgets('ext.flutter.inspector.show', (WidgetTester tester) async {
1892 1893 1894
      final Iterable<Map<Object, Object>> extensionChangedEvents = service.getServiceExtensionStateChangedEvents('ext.flutter.inspector.show');
      Map<Object, Object> extensionChangedEvent;

1895
      service.rebuildCount = 0;
1896
      expect(extensionChangedEvents, isEmpty);
1897
      expect(await service.testBoolExtension('show', <String, String>{'enabled': 'true'}), equals('true'));
1898 1899 1900 1901
      expect(extensionChangedEvents.length, equals(1));
      extensionChangedEvent = extensionChangedEvents.last;
      expect(extensionChangedEvent['extension'], equals('ext.flutter.inspector.show'));
      expect(extensionChangedEvent['value'], isTrue);
1902 1903 1904
      expect(service.rebuildCount, equals(1));
      expect(await service.testBoolExtension('show', <String, String>{}), equals('true'));
      expect(WidgetsApp.debugShowWidgetInspectorOverride, isTrue);
1905
      expect(extensionChangedEvents.length, equals(1));
1906
      expect(await service.testBoolExtension('show', <String, String>{'enabled': 'true'}), equals('true'));
1907 1908 1909 1910
      expect(extensionChangedEvents.length, equals(2));
      extensionChangedEvent = extensionChangedEvents.last;
      expect(extensionChangedEvent['extension'], equals('ext.flutter.inspector.show'));
      expect(extensionChangedEvent['value'], isTrue);
1911 1912
      expect(service.rebuildCount, equals(1));
      expect(await service.testBoolExtension('show', <String, String>{'enabled': 'false'}), equals('false'));
1913 1914 1915 1916
      expect(extensionChangedEvents.length, equals(3));
      extensionChangedEvent = extensionChangedEvents.last;
      expect(extensionChangedEvent['extension'], equals('ext.flutter.inspector.show'));
      expect(extensionChangedEvent['value'], isFalse);
1917
      expect(await service.testBoolExtension('show', <String, String>{}), equals('false'));
1918
      expect(extensionChangedEvents.length, equals(3));
1919 1920 1921
      expect(service.rebuildCount, equals(2));
      expect(WidgetsApp.debugShowWidgetInspectorOverride, isFalse);
    });
1922

1923
    testWidgets('ext.flutter.inspector.screenshot', (WidgetTester tester) async {
1924 1925 1926 1927 1928
      final GlobalKey outerContainerKey = GlobalKey();
      final GlobalKey paddingKey = GlobalKey();
      final GlobalKey redContainerKey = GlobalKey();
      final GlobalKey whiteContainerKey = GlobalKey();
      final GlobalKey sizedBoxKey = GlobalKey();
1929 1930 1931 1932 1933

      // Complex widget tree intended to exercise features such as children
      // with rotational transforms and clipping without introducing platform
      // specific behavior as text rendering would.
      await tester.pumpWidget(
1934 1935 1936
        Center(
          child: RepaintBoundaryWithDebugPaint(
            child: Container(
1937 1938
              key: outerContainerKey,
              color: Colors.white,
1939
              child: Padding(
1940 1941
                key: paddingKey,
                padding: const EdgeInsets.all(100.0),
1942
                child: SizedBox(
1943 1944 1945
                  key: sizedBoxKey,
                  height: 100.0,
                  width: 100.0,
1946
                  child: Transform.rotate(
1947
                    angle: 1.0, // radians
1948
                    child: ClipRRect(
1949 1950 1951 1952 1953 1954
                      borderRadius: const BorderRadius.only(
                        topLeft: Radius.elliptical(10.0, 20.0),
                        topRight: Radius.elliptical(5.0, 30.0),
                        bottomLeft: Radius.elliptical(2.5, 12.0),
                        bottomRight: Radius.elliptical(15.0, 6.0),
                      ),
1955
                      child: Container(
1956 1957
                        key: redContainerKey,
                        color: Colors.red,
1958
                        child: Container(
1959 1960
                          key: whiteContainerKey,
                          color: Colors.white,
1961 1962 1963
                          child: RepaintBoundary(
                            child: Center(
                              child: Container(
1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
                                color: Colors.black,
                                height: 10.0,
                                width: 10.0,
                              ),
                            ),
                          ),
                        ),
                      ),
                    ),
                  ),
                ),
              ),
            ),
          ),
        ),
      );

      final Element repaintBoundary =
          find.byType(RepaintBoundaryWithDebugPaint).evaluate().single;

1984
      final RenderRepaintBoundary renderObject = repaintBoundary.renderObject as RenderRepaintBoundary;
1985

1986
      final OffsetLayer layer = renderObject.debugLayer as OffsetLayer;
1987 1988 1989 1990
      final int expectedChildLayerCount = getChildLayerCount(layer);
      expect(expectedChildLayerCount, equals(2));
      await expectLater(
        layer.toImage(renderObject.semanticBounds.inflate(50.0)),
1991
        matchesGoldenFile('inspector.repaint_boundary_margin.png'),
1992 1993 1994 1995 1996 1997 1998 1999 2000
      );

      // Regression test for how rendering with a pixel scale other than 1.0
      // was handled.
      await expectLater(
        layer.toImage(
          renderObject.semanticBounds.inflate(50.0),
          pixelRatio: 0.5,
        ),
2001
        matchesGoldenFile('inspector.repaint_boundary_margin_small.png'),
2002 2003 2004 2005 2006 2007 2008
      );

      await expectLater(
        layer.toImage(
          renderObject.semanticBounds.inflate(50.0),
          pixelRatio: 2.0,
        ),
2009
        matchesGoldenFile('inspector.repaint_boundary_margin_large.png'),
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
      );

      final Layer layerParent = layer.parent;
      final Layer firstChild = layer.firstChild;

      expect(layerParent, isNotNull);
      expect(firstChild, isNotNull);

      await expectLater(
        service.screenshot(
          repaintBoundary,
          width: 300.0,
          height: 300.0,
        ),
2024
        matchesGoldenFile('inspector.repaint_boundary.png'),
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
      );

      // Verify that taking a screenshot didn't change the layers associated with
      // the renderObject.
      expect(renderObject.debugLayer, equals(layer));
      // Verify that taking a screenshot did not change the number of children
      // of the layer.
      expect(getChildLayerCount(layer), equals(expectedChildLayerCount));

      await expectLater(
        service.screenshot(
          repaintBoundary,
          width: 500.0,
          height: 500.0,
          margin: 50.0,
        ),
2041
        matchesGoldenFile('inspector.repaint_boundary_margin.png'),
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
      );

      // Verify that taking a screenshot didn't change the layers associated with
      // the renderObject.
      expect(renderObject.debugLayer, equals(layer));
      // Verify that taking a screenshot did not change the number of children
      // of the layer.
      expect(getChildLayerCount(layer), equals(expectedChildLayerCount));

      // Make sure taking a screenshot didn't change the parent of the layer.
      expect(layer.parent, equals(layerParent));

      await expectLater(
        service.screenshot(
          repaintBoundary,
          width: 300.0,
          height: 300.0,
          debugPaint: true,
        ),
2061
        matchesGoldenFile('inspector.repaint_boundary_debugPaint.png'),
2062 2063 2064 2065 2066 2067 2068 2069 2070
      );
      // Verify that taking a screenshot with debug paint on did not change
      // the number of children the layer has.
      expect(getChildLayerCount(layer), equals(expectedChildLayerCount));

      // Ensure that creating screenshots including ones with debug paint
      // hasn't changed the regular render of the widget.
      await expectLater(
        find.byType(RepaintBoundaryWithDebugPaint),
2071
        matchesGoldenFile('inspector.repaint_boundary.png'),
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
      );

      expect(renderObject.debugLayer, equals(layer));
      expect(layer.attached, isTrue);

      // Full size image
      await expectLater(
        service.screenshot(
          find.byKey(outerContainerKey).evaluate().single,
          width: 100.0,
          height: 100.0,
        ),
2084
        matchesGoldenFile('inspector.container.png'),
2085 2086 2087 2088 2089 2090 2091 2092 2093
      );

      await expectLater(
        service.screenshot(
          find.byKey(outerContainerKey).evaluate().single,
          width: 100.0,
          height: 100.0,
          debugPaint: true,
        ),
2094
        matchesGoldenFile('inspector.container_debugPaint.png'),
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
      );

      {
        // Verify calling the screenshot method still works if the RenderObject
        // needs to be laid out again.
        final RenderObject container =
            find.byKey(outerContainerKey).evaluate().single.renderObject;
        container
          ..markNeedsLayout()
          ..markNeedsPaint();
        expect(container.debugNeedsLayout, isTrue);

        await expectLater(
          service.screenshot(
            find.byKey(outerContainerKey).evaluate().single,
            width: 100.0,
            height: 100.0,
            debugPaint: true,
          ),
2114
          matchesGoldenFile('inspector.container_debugPaint.png'),
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
        );
        expect(container.debugNeedsLayout, isFalse);
      }

      // Small image
      await expectLater(
        service.screenshot(
          find.byKey(outerContainerKey).evaluate().single,
          width: 50.0,
          height: 100.0,
        ),
2126
        matchesGoldenFile('inspector.container_small.png'),
2127 2128 2129 2130 2131 2132 2133 2134 2135
      );

      await expectLater(
        service.screenshot(
          find.byKey(outerContainerKey).evaluate().single,
          width: 400.0,
          height: 400.0,
          maxPixelRatio: 3.0,
        ),
2136
        matchesGoldenFile('inspector.container_large.png'),
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
      );

      // This screenshot will show the clip rect debug paint but no other
      // debug paint.
      await expectLater(
        service.screenshot(
          find.byType(ClipRRect).evaluate().single,
          width: 100.0,
          height: 100.0,
          debugPaint: true,
        ),
2148
        matchesGoldenFile('inspector.clipRect_debugPaint.png'),
2149 2150
      );

2151 2152 2153 2154 2155 2156 2157 2158 2159
      final Element clipRect = find.byType(ClipRRect).evaluate().single;

      final Future<ui.Image> clipRectScreenshot = service.screenshot(
        clipRect,
        width: 100.0,
        height: 100.0,
        margin: 20.0,
        debugPaint: true,
      );
2160 2161 2162
      // Add a margin so that the clip icon shows up in the screenshot.
      // This golden image is platform dependent due to the clip icon.
      await expectLater(
2163
        clipRectScreenshot,
2164
        matchesGoldenFile('inspector.clipRect_debugPaint_margin.png'),
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
      );

      // Verify we get the same image if we go through the service extension
      // instead of invoking the screenshot method directly.
      final Future<Object> base64ScreenshotFuture = service.testExtension(
        'screenshot',
        <String, String>{
          'id': service.toId(clipRect, 'group'),
          'width': '100.0',
          'height': '100.0',
          'margin': '20.0',
          'debugPaint': 'true',
        },
      );

2180
      final TestWidgetsFlutterBinding binding = TestWidgetsFlutterBinding.ensureInitialized() as TestWidgetsFlutterBinding;
2181
      final ui.Image screenshotImage = await binding.runAsync<ui.Image>(() async {
2182
        final String base64Screenshot = await base64ScreenshotFuture as String;
2183 2184 2185 2186 2187 2188 2189 2190
        final ui.Codec codec = await ui.instantiateImageCodec(base64.decode(base64Screenshot));
        final ui.FrameInfo frame = await codec.getNextFrame();
        return frame.image;
      }, additionalTime: const Duration(seconds: 11));

      await expectLater(
        screenshotImage,
        matchesReferenceImage(await clipRectScreenshot),
2191
        skip: !isLinux,
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
      );

      // Test with a very visible debug paint
      await expectLater(
        service.screenshot(
          find.byKey(paddingKey).evaluate().single,
          width: 300.0,
          height: 300.0,
          debugPaint: true,
        ),
2202
        matchesGoldenFile('inspector.padding_debugPaint.png'),
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
      );

      // The bounds for this box crop its rendered content.
      await expectLater(
        service.screenshot(
          find.byKey(sizedBoxKey).evaluate().single,
          width: 300.0,
          height: 300.0,
          debugPaint: true,
        ),
2213
        matchesGoldenFile('inspector.sizedBox_debugPaint.png'),
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
      );

      // Verify that setting a margin includes the previously cropped content.
      await expectLater(
        service.screenshot(
          find.byKey(sizedBoxKey).evaluate().single,
          width: 300.0,
          height: 300.0,
          margin: 50.0,
          debugPaint: true,
        ),
2225
        matchesGoldenFile('inspector.sizedBox_debugPaint_margin.png'),
2226
      );
2227
    });
2228

2229
    test('ext.flutter.inspector.structuredErrors', () async {
2230 2231 2232
      List<Map<Object, Object>> flutterErrorEvents = service.getEventsDispatched('Flutter.Error');
      expect(flutterErrorEvents, isEmpty);

2233
      final FlutterExceptionHandler oldHandler = FlutterError.presentError;
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258

      try {
        // Enable structured errors.
        expect(await service.testBoolExtension(
            'structuredErrors', <String, String>{'enabled': 'true'}),
            equals('true'));

        // Create an error.
        FlutterError.reportError(FlutterErrorDetailsForRendering(
          library: 'rendering library',
          context: ErrorDescription('during layout'),
          exception: StackTrace.current,
        ));

        // Validate that we received an error.
        flutterErrorEvents = service.getEventsDispatched('Flutter.Error');
        expect(flutterErrorEvents, hasLength(1));

        // Validate the error contents.
        Map<Object, Object> error = flutterErrorEvents.first;
        expect(error['description'], 'Exception caught by rendering library');
        expect(error['children'], isEmpty);

        // Validate that we received an error count.
        expect(error['errorsSinceReload'], 0);
2259 2260 2261 2262
        expect(
            error['renderedErrorText'],
            startsWith(
                '══╡ EXCEPTION CAUGHT BY RENDERING LIBRARY ╞════════════'));
2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275

        // Send a second error.
        FlutterError.reportError(FlutterErrorDetailsForRendering(
          library: 'rendering library',
          context: ErrorDescription('also during layout'),
          exception: StackTrace.current,
        ));

        // Validate that the error count increased.
        flutterErrorEvents = service.getEventsDispatched('Flutter.Error');
        expect(flutterErrorEvents, hasLength(2));
        error = flutterErrorEvents.last;
        expect(error['errorsSinceReload'], 1);
2276
        expect(error['renderedErrorText'], startsWith('Another exception was thrown:'));
2277

2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
        // Reloads the app.
        final FlutterExceptionHandler oldHandler = FlutterError.onError;
        final TestWidgetsFlutterBinding binding = TestWidgetsFlutterBinding.ensureInitialized() as TestWidgetsFlutterBinding;
        // We need the runTest to setup the fake async in the test binding.
        await binding.runTest(() async {
          binding.reassembleApplication();
          await binding.pump();
        }, () { });
        // The run test overrides the flutter error handler, so we should
        // restore it back for the structure error to continue working.
        FlutterError.onError = oldHandler;
        // Cleans up the fake async so it does not bleed into next test.
        binding.postTest();
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304

        // Send another error.
        FlutterError.reportError(FlutterErrorDetailsForRendering(
          library: 'rendering library',
          context: ErrorDescription('during layout'),
          exception: StackTrace.current,
        ));

        // And, validate that the error count has been reset.
        flutterErrorEvents = service.getEventsDispatched('Flutter.Error');
        expect(flutterErrorEvents, hasLength(3));
        error = flutterErrorEvents.last;
        expect(error['errorsSinceReload'], 0);
      } finally {
2305
        FlutterError.presentError = oldHandler;
2306 2307 2308
      }
    });

2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323
    testWidgets('Screenshot of composited transforms - only offsets', (WidgetTester tester) async {
      // Composited transforms are challenging to take screenshots of as the
      // LeaderLayer and FollowerLayer classes used by CompositedTransformTarget
      // and CompositedTransformFollower depend on traversing ancestors of the
      // layer tree and mutating a [LayerLink] object when attaching layers to
      // the tree so that the FollowerLayer knows about the LeaderLayer.
      // 1. Finding the correct position for the follower layers requires
      // traversing the ancestors of the follow layer to find a common ancestor
      // with the leader layer.
      // 2. Creating a LeaderLayer and attaching it to a layer tree has side
      // effects as the leader layer will attempt to modify the mutable
      // LeaderLayer object shared by the LeaderLayer and FollowerLayer.
      // These tests verify that screenshots can still be taken and look correct
      // when the leader and follower layer are both in the screenshots and when
      // only the leader or follower layer is in the screenshot.
2324 2325 2326 2327 2328
      final LayerLink link = LayerLink();
      final GlobalKey key = GlobalKey();
      final GlobalKey mainStackKey = GlobalKey();
      final GlobalKey transformTargetParent = GlobalKey();
      final GlobalKey stackWithTransformFollower = GlobalKey();
2329 2330

      await tester.pumpWidget(
2331
        Directionality(
2332
          textDirection: TextDirection.ltr,
2333 2334
          child: RepaintBoundary(
            child: Stack(
2335 2336
              key: mainStackKey,
              children: <Widget>[
2337
                Stack(
2338 2339
                  key: transformTargetParent,
                  children: <Widget>[
2340
                    Positioned(
2341 2342
                      left: 123.0,
                      top: 456.0,
2343
                      child: CompositedTransformTarget(
2344
                        link: link,
2345
                        child: Container(height: 20.0, width: 20.0, color: const Color.fromARGB(128, 255, 0, 0)),
2346 2347 2348 2349
                      ),
                    ),
                  ],
                ),
2350
                Positioned(
2351 2352
                  left: 787.0,
                  top: 343.0,
2353
                  child: Stack(
2354 2355 2356 2357
                    key: stackWithTransformFollower,
                    children: <Widget>[
                      // Container so we can see how the follower layer was
                      // transformed relative to its initial location.
2358 2359
                      Container(height: 15.0, width: 15.0, color: const Color.fromARGB(128, 0, 0, 255)),
                      CompositedTransformFollower(
2360
                        link: link,
2361
                        child: Container(key: key, height: 10.0, width: 10.0, color: const Color.fromARGB(128, 0, 255, 0)),
2362 2363 2364 2365 2366 2367 2368 2369 2370
                      ),
                    ],
                  ),
                ),
              ],
            ),
          ),
        ),
      );
2371
      final RenderBox box = key.currentContext.findRenderObject() as RenderBox;
2372 2373 2374 2375
      expect(box.localToGlobal(Offset.zero), const Offset(123.0, 456.0));

      await expectLater(
        find.byKey(mainStackKey),
2376
        matchesGoldenFile('inspector.composited_transform.only_offsets.png'),
2377 2378 2379 2380 2381 2382 2383 2384
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(
          find.byKey(stackWithTransformFollower).evaluate().first,
          width: 5000.0,
          height: 500.0,
        ),
2385
        matchesGoldenFile('inspector.composited_transform.only_offsets_follower.png'),
2386 2387 2388 2389
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(find.byType(Stack).evaluate().first, width: 300.0, height: 300.0),
2390
        matchesGoldenFile('inspector.composited_transform.only_offsets_small.png'),
2391 2392 2393 2394 2395 2396 2397 2398
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(
          find.byKey(transformTargetParent).evaluate().first,
          width: 500.0,
          height: 500.0,
        ),
2399
        matchesGoldenFile('inspector.composited_transform.only_offsets_target.png'),
2400
      );
2401
    });
2402 2403

    testWidgets('Screenshot composited transforms - with rotations', (WidgetTester tester) async {
2404 2405 2406 2407 2408 2409 2410 2411
      final LayerLink link = LayerLink();
      final GlobalKey key1 = GlobalKey();
      final GlobalKey key2 = GlobalKey();
      final GlobalKey rotate1 = GlobalKey();
      final GlobalKey rotate2 = GlobalKey();
      final GlobalKey mainStackKey = GlobalKey();
      final GlobalKey stackWithTransformTarget = GlobalKey();
      final GlobalKey stackWithTransformFollower = GlobalKey();
2412 2413

      await tester.pumpWidget(
2414
        Directionality(
2415
          textDirection: TextDirection.ltr,
2416
          child: Stack(
2417 2418
            key: mainStackKey,
            children: <Widget>[
2419
              Stack(
2420 2421
                key: stackWithTransformTarget,
                children: <Widget>[
2422
                  Positioned(
2423 2424
                    top: 123.0,
                    left: 456.0,
2425
                    child: Transform.rotate(
2426 2427
                      key: rotate1,
                      angle: 1.0, // radians
2428
                      child: CompositedTransformTarget(
2429
                        link: link,
2430
                        child: Container(key: key1, height: 20.0, width: 20.0, color: const Color.fromARGB(128, 255, 0, 0)),
2431 2432 2433 2434 2435
                      ),
                    ),
                  ),
                ],
              ),
2436
              Positioned(
2437 2438
                top: 487.0,
                left: 243.0,
2439
                child: Stack(
2440 2441
                  key: stackWithTransformFollower,
                  children: <Widget>[
2442 2443
                    Container(height: 15.0, width: 15.0, color: const Color.fromARGB(128, 0, 0, 255)),
                    Transform.rotate(
2444 2445
                      key: rotate2,
                      angle: -0.3, // radians
2446
                      child: CompositedTransformFollower(
2447
                        link: link,
2448
                        child: Container(key: key2, height: 10.0, width: 10.0, color: const Color.fromARGB(128, 0, 255, 0)),
2449 2450 2451 2452 2453 2454 2455 2456 2457
                      ),
                    ),
                  ],
                ),
              ),
            ],
          ),
        ),
      );
2458 2459
      final RenderBox box1 = key1.currentContext.findRenderObject() as RenderBox;
      final RenderBox box2 = key2.currentContext.findRenderObject() as RenderBox;
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
      // Snapshot the positions of the two relevant boxes to ensure that taking
      // screenshots doesn't impact their positions.
      final Offset position1 = box1.localToGlobal(Offset.zero);
      final Offset position2 = box2.localToGlobal(Offset.zero);
      expect(position1.dx, moreOrLessEquals(position2.dx));
      expect(position1.dy, moreOrLessEquals(position2.dy));

      // Image of the full scene to use as reference to help validate that the
      // screenshots of specific subtrees are reasonable.
      await expectLater(
        find.byKey(mainStackKey),
2471
        matchesGoldenFile('inspector.composited_transform.with_rotations.png'),
2472 2473 2474 2475 2476 2477 2478 2479
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(
          find.byKey(mainStackKey).evaluate().first,
          width: 500.0,
          height: 500.0,
        ),
2480
        matchesGoldenFile('inspector.composited_transform.with_rotations_small.png'),
2481 2482 2483 2484 2485 2486 2487 2488
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(
          find.byKey(stackWithTransformTarget).evaluate().first,
          width: 500.0,
          height: 500.0,
        ),
2489
        matchesGoldenFile('inspector.composited_transform.with_rotations_target.png'),
2490 2491 2492 2493 2494 2495 2496 2497
      );

      await expectLater(
        WidgetInspectorService.instance.screenshot(
          find.byKey(stackWithTransformFollower).evaluate().first,
          width: 500.0,
          height: 500.0,
        ),
2498
        matchesGoldenFile('inspector.composited_transform.with_rotations_follower.png'),
2499 2500 2501 2502 2503 2504 2505 2506
      );

      // Make sure taking screenshots hasn't modified the positions of the
      // TransformTarget or TransformFollower layers.
      expect(identical(key1.currentContext.findRenderObject(), box1), isTrue);
      expect(identical(key2.currentContext.findRenderObject(), box2), isTrue);
      expect(box1.localToGlobal(Offset.zero), equals(position1));
      expect(box2.localToGlobal(Offset.zero), equals(position2));
2507
    });
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530

    testWidgets('getChildrenDetailsSubtree', (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          title: 'Hello, World',
          theme: ThemeData(
            primarySwatch: Colors.blue,
          ),
          home: Scaffold(
            appBar: AppBar(
              title: const Text('Hello, World'),
            ),
            body: const Center(
              child: Text('Hello, World!'),
            ),
          ),
        ),
      );

      // Figure out the pubRootDirectory
      final Map<String, Object> jsonObject = await service.testExtension(
          'getSelectedWidget',
          <String, String>{'arg': null, 'objectGroup': 'my-group'},
2531 2532
      ) as Map<String, Object>;
      final Map<String, Object> creationLocation = jsonObject['creationLocation'] as Map<String, Object>;
2533
      expect(creationLocation, isNotNull);
2534
      final String file = creationLocation['file'] as String;
2535 2536 2537 2538 2539 2540 2541
      expect(file, endsWith('widget_inspector_test.dart'));
      final List<String> segments = Uri.parse(file).pathSegments;
      // Strip a couple subdirectories away to generate a plausible pub rootdirectory.
      final String pubRootTest = '/' + segments.take(segments.length - 2).join('/');
      service.setPubRootDirectories(<String>[pubRootTest]);

      final String summary = service.getRootWidgetSummaryTree('foo1');
2542 2543 2544
      final List<dynamic> childrenOfRoot = json.decode(summary)['children'] as List<dynamic>;
      final List<dynamic> childrenOfMaterialApp = childrenOfRoot.first['children'] as List<dynamic>;
      final Map<String, Object> scaffold = childrenOfMaterialApp.first as Map<String, Object>;
2545
      expect(scaffold['description'], 'Scaffold');
2546
      final String objectId = scaffold['objectId'] as String;
2547
      final String details = service.getDetailsSubtree(objectId, 'foo2');
2548
      final List<dynamic> detailedChildren = json.decode(details)['children'] as List<dynamic>;
2549 2550 2551

      final List<Map<String, Object>> appBars = <Map<String, Object>>[];
      void visitChildren(List<dynamic> children) {
2552
        for (final Map<String, Object> child in children.cast<Map<String, Object>>()) {
2553 2554 2555 2556
          if (child['description'] == 'AppBar') {
            appBars.add(child);
          }
          if (child.containsKey('children')) {
2557
            visitChildren(child['children'] as List<dynamic>);
2558 2559 2560 2561
          }
        }
      }
      visitChildren(detailedChildren);
2562
      expect(appBars.single, isNot(contains('children')));
2563
    }, skip: !WidgetInspectorService.instance.isWidgetCreationTracked()); // Test requires --track-widget-creation flag.
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611

    testWidgets('InspectorSerializationDelegate addAdditionalPropertiesCallback', (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          title: 'Hello World!',
          home: Scaffold(
            appBar: AppBar(
              title: const Text('Hello World!'),
            ),
            body: Center(
              child: Column(
                children: const <Widget>[
                  Text('Hello World!'),
                ],
              ),
            ),
          ),
        )
      );
      final Finder columnWidgetFinder = find.byType(Column);
      expect(columnWidgetFinder, findsOneWidget);
      final Element columnWidgetElement = columnWidgetFinder
        .evaluate()
        .first;
      final DiagnosticsNode node = columnWidgetElement.toDiagnosticsNode();
      final InspectorSerializationDelegate delegate =
        InspectorSerializationDelegate(
          service: service,
          summaryTree: false,
          includeProperties: true,
          addAdditionalPropertiesCallback:
            (DiagnosticsNode node, InspectorSerializationDelegate delegate) {
              final Map<String, Object> additionalJson = <String, Object>{};
              final Object value = node.value;
              if (value is Element) {
                additionalJson['renderObject'] =
                  value.renderObject.toDiagnosticsNode().toJsonMap(
                    delegate.copyWith(subtreeDepth: 0),
                  );
              }
              additionalJson['callbackExecuted'] = true;
              return additionalJson;
            },
        );
      final Map<String, Object> json = node.toJsonMap(delegate);
      expect(json['callbackExecuted'], true);
      expect(json.containsKey('renderObject'), true);
      expect(json['renderObject'], isA<Map<String, dynamic>>());
2612
      final Map<String, dynamic> renderObjectJson = json['renderObject'] as Map<String, dynamic>;
2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
      expect(renderObjectJson['description'], startsWith('RenderFlex'));

      final InspectorSerializationDelegate emptyDelegate =
        InspectorSerializationDelegate(
          service: service,
          summaryTree: false,
          includeProperties: true,
          addAdditionalPropertiesCallback:
            (DiagnosticsNode node, InspectorSerializationDelegate delegate) {
              return null;
            },
        );
      final InspectorSerializationDelegate defaultDelegate =
        InspectorSerializationDelegate(
          service: service,
          summaryTree: false,
          includeProperties: true,
          addAdditionalPropertiesCallback: null,
        );
      expect(node.toJsonMap(emptyDelegate), node.toJsonMap(defaultDelegate));
    });
2634
  }
2635
}
2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652

void addToKnownLocationsMap({
  @required Map<int, _CreationLocation> knownLocations,
  @required Map<String, List<int>> newLocations,
}) {
  newLocations.forEach((String file, List<int> entries) {
    assert(entries.length % 3 == 0);
    for (int i = 0; i < entries.length; i += 3) {
      final int id = entries[i];
      final int line = entries[i + 1];
      final int column = entries[i + 2];
      assert(!knownLocations.containsKey(id));
      knownLocations[id] =
          _CreationLocation(file: file, line: line, column: column, id: id);
    }
  });
}