image_cache_tracing_test.dart 3.76 KB
Newer Older
Dan Field's avatar
Dan Field committed
1 2 3 4 5 6 7 8 9 10
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:convert';
import 'dart:developer' as developer;
import 'dart:isolate' as isolate;

import 'package:flutter/painting.dart';
import 'package:flutter_test/flutter_test.dart';
11 12
import 'package:vm_service/vm_service.dart';
import 'package:vm_service/vm_service_io.dart';
Dan Field's avatar
Dan Field committed
13 14

void main() {
15 16
  late VmService vmService;
  late String isolateId;
Dan Field's avatar
Dan Field committed
17 18 19 20
  setUpAll(() async {
    final developer.ServiceProtocolInfo info = await developer.Service.getInfo();

    if (info.serverUri == null) {
Dan Field's avatar
Dan Field committed
21
      fail('This test _must_ be run with --enable-vmservice.');
Dan Field's avatar
Dan Field committed
22
    }
23

24
    vmService = await vmServiceConnectUri('ws://localhost:${info.serverUri!.port}${info.serverUri!.path}ws');
25
    await vmService.setVMTimelineFlags(<String>['Dart']);
26
    isolateId = developer.Service.getIsolateID(isolate.Isolate.current)!;
Dan Field's avatar
Dan Field committed
27 28 29 30 31 32 33

    // Initialize the image cache.
    TestWidgetsFlutterBinding.ensureInitialized();
  });

  test('Image cache tracing', () async {
    final TestImageStreamCompleter completer1 = TestImageStreamCompleter();
34
    final TestImageStreamCompleter completer2 = TestImageStreamCompleter();
35
    PaintingBinding.instance!.imageCache!.putIfAbsent(
Dan Field's avatar
Dan Field committed
36 37 38
      'Test',
      () => completer1,
    );
39
    PaintingBinding.instance!.imageCache!.clear();
Dan Field's avatar
Dan Field committed
40

41
    completer2.testSetImage(ImageInfo(image: await createTestImage()));
42
    PaintingBinding.instance!.imageCache!.putIfAbsent(
43 44 45
      'Test2',
      () => completer2,
    );
46
    PaintingBinding.instance!.imageCache!.evict('Test2');
47

48
    final Timeline timeline = await vmService.getVMTimeline();
Dan Field's avatar
Dan Field committed
49
    _expectTimelineEvents(
50
      timeline.traceEvents!,
Dan Field's avatar
Dan Field committed
51 52 53 54 55 56 57
      <Map<String, dynamic>>[
        <String, dynamic>{
          'name': 'ImageCache.putIfAbsent',
          'args': <String, dynamic>{'key': 'Test', 'isolateId': isolateId}
        },
        <String, dynamic>{
          'name': 'listener',
58
          'args': <String, dynamic>{'parentId': '1', 'isolateId': isolateId}
Dan Field's avatar
Dan Field committed
59 60 61 62 63
        },
        <String, dynamic>{
          'name': 'ImageCache.clear',
          'args': <String, dynamic>{
            'pendingImages': 1,
Dan Field's avatar
Dan Field committed
64 65
            'keepAliveImages': 0,
            'liveImages': 1,
Dan Field's avatar
Dan Field committed
66 67 68 69
            'currentSizeInBytes': 0,
            'isolateId': isolateId,
          }
        },
70 71 72 73 74 75
        <String, dynamic>{
          'name': 'ImageCache.putIfAbsent',
          'args': <String, dynamic>{'key': 'Test2', 'isolateId': isolateId}
        },
        <String, dynamic>{
          'name': 'ImageCache.evict',
76
          'args': <String, dynamic>{'sizeInBytes': 4, 'isolateId': isolateId}
77
        },
Dan Field's avatar
Dan Field committed
78 79
      ],
    );
80
  }, skip: isBrowser); // [intended] uses dart:isolate and io.
Dan Field's avatar
Dan Field committed
81 82
}

83 84
void _expectTimelineEvents(List<TimelineEvent> events, List<Map<String, dynamic>> expected) {
  for (final TimelineEvent event in events) {
Dan Field's avatar
Dan Field committed
85
    for (int index = 0; index < expected.length; index += 1) {
86
      if (expected[index]['name'] == event.json!['name']) {
Dan Field's avatar
Dan Field committed
87
        final Map<String, dynamic> expectedArgs = expected[index]['args'] as Map<String, dynamic>;
88
        final Map<String, dynamic> args = event.json!['args'] as Map<String, dynamic>;
Dan Field's avatar
Dan Field committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
        if (_mapsEqual(expectedArgs, args)) {
          expected.removeAt(index);
        }
      }
    }
  }
  if (expected.isNotEmpty) {
    final String encodedEvents = jsonEncode(events);
    fail('Timeline did not contain expected events: $expected\nactual: $encodedEvents');
  }
}

bool _mapsEqual(Map<String, dynamic> expectedArgs, Map<String, dynamic> args) {
  for (final String key in expectedArgs.keys) {
    if (expectedArgs[key] != args[key]) {
      return false;
    }
  }
  return true;
}

110 111 112
class TestImageStreamCompleter extends ImageStreamCompleter {
  void testSetImage(ImageInfo image) {
    setImage(image);
113 114
  }
}