resident_devtools_handler.dart 9.81 KB
Newer Older
1 2 3 4 5 6 7 8
// 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.

// @dart = 2.8

import 'dart:async';

9
import 'package:browser_launcher/browser_launcher.dart';
10 11 12
import 'package:meta/meta.dart';

import 'base/logger.dart';
13
import 'build_info.dart';
14 15 16
import 'resident_runner.dart';
import 'vmservice.dart';

17 18 19 20 21 22
typedef ResidentDevtoolsHandlerFactory = ResidentDevtoolsHandler Function(DevtoolsLauncher, ResidentRunner, Logger);

ResidentDevtoolsHandler createDefaultHandler(DevtoolsLauncher launcher, ResidentRunner runner, Logger logger) {
  return FlutterResidentDevtoolsHandler(launcher, runner, logger);
}

23 24
/// Helper class to manage the life-cycle of devtools and its interaction with
/// the resident runner.
25 26 27 28
abstract class ResidentDevtoolsHandler {
  /// The current devtools server, or null if one is not running.
  DevToolsServerAddress get activeDevToolsServer;

29 30 31 32 33 34
  /// Whether it's ok to announce the [activeDevToolsServer].
  ///
  /// This should only return true once all the devices have been notified
  /// of the DevTools.
  bool get readyToAnnounce;

35 36
  Future<void> hotRestart(List<FlutterDevice> flutterDevices);

37 38 39 40 41 42
  Future<void> serveAndAnnounceDevTools({
    Uri devToolsServerAddress,
    @required List<FlutterDevice> flutterDevices,
  });

  bool launchDevToolsInBrowser({@required List<FlutterDevice> flutterDevices});
43 44 45 46 47 48

  Future<void> shutdown();
}

class FlutterResidentDevtoolsHandler implements ResidentDevtoolsHandler {
  FlutterResidentDevtoolsHandler(this._devToolsLauncher, this._residentRunner, this._logger);
49

50 51
  static const Duration launchInBrowserTimeout = Duration(seconds: 15);

52 53 54 55 56 57
  final DevtoolsLauncher _devToolsLauncher;
  final ResidentRunner _residentRunner;
  final Logger _logger;
  bool _shutdown = false;
  bool _served = false;

58 59 60
  @visibleForTesting
  bool launchedInBrowser = false;

61
  @override
62 63 64 65
  DevToolsServerAddress get activeDevToolsServer {
    assert(!_readyToAnnounce || _devToolsLauncher?.activeDevToolsServer != null);
    return _devToolsLauncher?.activeDevToolsServer;
  }
66

67 68 69 70
  @override
  bool get readyToAnnounce => _readyToAnnounce;
  bool _readyToAnnounce = false;

71
  // This must be guaranteed not to return a Future that fails.
72
  @override
73 74 75 76
  Future<void> serveAndAnnounceDevTools({
    Uri devToolsServerAddress,
    @required List<FlutterDevice> flutterDevices,
  }) async {
77
    assert(!_readyToAnnounce);
78 79 80 81 82 83 84
    if (!_residentRunner.supportsServiceProtocol || _devToolsLauncher == null) {
      return;
    }
    if (devToolsServerAddress != null) {
      _devToolsLauncher.devToolsUrl = devToolsServerAddress;
    } else {
      await _devToolsLauncher.serve();
85
      _served = true;
86 87
    }
    await _devToolsLauncher.ready;
88 89 90
    // Do not attempt to print debugger list if the connection has failed or if we're shutting down.
    if (_devToolsLauncher.activeDevToolsServer == null || _shutdown) {
      assert(!_readyToAnnounce);
91 92
      return;
    }
93 94 95
    final List<FlutterDevice> devicesWithExtension = await _devicesWithExtensions(flutterDevices);
    await _maybeCallDevToolsUriServiceExtension(devicesWithExtension);
    await _callConnectedVmServiceUriExtension(devicesWithExtension);
96 97 98 99
    if (_shutdown) {
      // If we're shutting down, no point reporting the debugger list.
      return;
    }
100
    _readyToAnnounce = true;
101
    assert(_devToolsLauncher.activeDevToolsServer != null);
102 103 104 105 106 107 108
    if (_residentRunner.reportedDebuggers) {
      // Since the DevTools only just became available, we haven't had a chance to
      // report their URLs yet. Do so now.
      _residentRunner.printDebuggerList(includeObservatory: false);
    }
  }

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
  // This must be guaranteed not to return a Future that fails.
  @override
  bool launchDevToolsInBrowser({@required List<FlutterDevice> flutterDevices}) {
    if (!_residentRunner.supportsServiceProtocol || _devToolsLauncher == null) {
      return false;
    }
    if (_devToolsLauncher.devToolsUrl == null) {
      _logger.startProgress('Waiting for Flutter DevTools to be served...');
      unawaited(_devToolsLauncher.ready.then((_) {
        _launchDevToolsForDevices(flutterDevices);
      }));
    } else {
      _launchDevToolsForDevices(flutterDevices);
    }
    return true;
  }

  void _launchDevToolsForDevices(List<FlutterDevice> flutterDevices) {
    assert(activeDevToolsServer != null);
    for (final FlutterDevice device in flutterDevices) {
      final String devToolsUrl = activeDevToolsServer.uri?.replace(
        queryParameters: <String, dynamic>{'uri': '${device.vmService.httpAddress}'},
      ).toString();
      _logger.printStatus('Launching Flutter DevTools for ${device.device.name} at $devToolsUrl');
      unawaited(Chrome.start(<String>[devToolsUrl]));
    }
    launchedInBrowser = true;
  }

138 139 140 141 142 143
  Future<void> _maybeCallDevToolsUriServiceExtension(
    List<FlutterDevice> flutterDevices,
  ) async {
    if (_devToolsLauncher?.activeDevToolsServer == null) {
      return;
    }
144 145
    await Future.wait(<Future<void>>[
      for (final FlutterDevice device in flutterDevices)
146
        if (device.vmService != null) _callDevToolsUriExtension(device),
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    ]);
  }

  Future<void> _callDevToolsUriExtension(
    FlutterDevice device,
  ) async {
    try {
      await _invokeRpcOnFirstView(
        'ext.flutter.activeDevToolsServerAddress',
        device: device,
        params: <String, dynamic>{
          'value': _devToolsLauncher.activeDevToolsServer.uri.toString(),
        },
      );
    } on Exception catch (e) {
      _logger.printError(
163
        'Failed to set DevTools server address: $e. Deep links to'
164 165 166 167 168
        ' DevTools will not show in Flutter errors.',
      );
    }
  }

169 170
  Future<List<FlutterDevice>> _devicesWithExtensions(List<FlutterDevice> flutterDevices) async {
    final List<FlutterDevice> devices = await Future.wait(<Future<FlutterDevice>>[
171
      for (final FlutterDevice device in flutterDevices) _waitForExtensionsForDevice(device),
172
    ]);
173 174 175 176 177 178 179
    return devices.where((FlutterDevice device) => device != null).toList();
  }

  /// Returns null if the service extension cannot be found on the device.
  Future<FlutterDevice> _waitForExtensionsForDevice(FlutterDevice flutterDevice) async {
    const String extension = 'ext.flutter.connectedVmServiceUri';
    try {
180 181 182
      await flutterDevice.vmService?.findExtensionIsolate(
        extension,
      );
183 184 185 186 187 188 189 190 191
      return flutterDevice;
    } on VmServiceDisappearedException {
      _logger.printTrace(
        'The VM Service for ${flutterDevice.device} disappeared while trying to'
        ' find the $extension service extension. Skipping subsequent DevTools '
        'setup for this device.',
      );
      return null;
    }
192 193 194
  }

  Future<void> _callConnectedVmServiceUriExtension(List<FlutterDevice> flutterDevices) async {
195 196
    await Future.wait(<Future<void>>[
      for (final FlutterDevice device in flutterDevices)
197
        if (device.vmService != null) _callConnectedVmServiceExtension(device),
198 199 200 201
    ]);
  }

  Future<void> _callConnectedVmServiceExtension(FlutterDevice device) async {
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    final Uri uri = device.vmService.httpAddress ?? device.vmService.wsAddress;
    if (uri == null) {
      return;
    }
    try {
      await _invokeRpcOnFirstView(
        'ext.flutter.connectedVmServiceUri',
        device: device,
        params: <String, dynamic>{
          'value': uri.toString(),
        },
      );
    } on Exception catch (e) {
      _logger.printError(e.toString());
      _logger.printError(
217
        'Failed to set vm service URI: $e. Deep links to DevTools'
218 219
        ' will not show in Flutter errors.',
      );
220 221 222
    }
  }

223 224
  Future<void> _invokeRpcOnFirstView(
    String method, {
225 226 227
    @required FlutterDevice device,
    @required Map<String, dynamic> params,
  }) async {
228 229 230 231 232 233
    if (device.targetPlatform == TargetPlatform.web_javascript) {
      return device.vmService.callMethodWrapper(
        method,
        args: params,
      );
    }
234
    final List<FlutterView> views = await device.vmService.getFlutterViews();
235 236 237
    if (views.isEmpty) {
      return;
    }
238 239 240 241 242
    await device.vmService.invokeFlutterExtensionRpcRaw(
      method,
      args: params,
      isolateId: views.first.uiIsolate.id,
    );
243 244
  }

245
  @override
246
  Future<void> hotRestart(List<FlutterDevice> flutterDevices) async {
247
    final List<FlutterDevice> devicesWithExtension = await _devicesWithExtensions(flutterDevices);
248
    await Future.wait(<Future<void>>[
249 250
      _maybeCallDevToolsUriServiceExtension(devicesWithExtension),
      _callConnectedVmServiceUriExtension(devicesWithExtension),
251 252 253
    ]);
  }

254
  @override
255 256 257 258 259
  Future<void> shutdown() async {
    if (_devToolsLauncher == null || _shutdown || !_served) {
      return;
    }
    _shutdown = true;
260
    _readyToAnnounce = false;
261 262 263 264
    await _devToolsLauncher.close();
  }
}

265 266 267 268 269 270 271
@visibleForTesting
NoOpDevtoolsHandler createNoOpHandler(DevtoolsLauncher launcher, ResidentRunner runner, Logger logger) {
  return NoOpDevtoolsHandler();
}

@visibleForTesting
class NoOpDevtoolsHandler implements ResidentDevtoolsHandler {
272 273
  bool wasShutdown = false;

274 275 276
  @override
  DevToolsServerAddress get activeDevToolsServer => null;

277 278 279
  @override
  bool get readyToAnnounce => false;

280 281 282 283 284 285 286 287 288 289
  @override
  Future<void> hotRestart(List<FlutterDevice> flutterDevices) async {
    return;
  }

  @override
  Future<void> serveAndAnnounceDevTools({Uri devToolsServerAddress, List<FlutterDevice> flutterDevices}) async {
    return;
  }

290 291 292 293 294
  @override
  bool launchDevToolsInBrowser({List<FlutterDevice> flutterDevices}) {
    return false;
  }

295 296
  @override
  Future<void> shutdown() async {
297
    wasShutdown = true;
298 299 300
    return;
  }
}
301 302 303 304 305 306 307 308 309 310

/// Convert a [URI] with query parameters into a display format instead
/// of the default URI encoding.
String urlToDisplayString(Uri uri) {
  final StringBuffer base = StringBuffer(uri.replace(
    queryParameters: <String, String>{},
  ).toString());
  base.write(uri.queryParameters.keys.map((String key) => '$key=${uri.queryParameters[key]}').join('&'));
  return base.toString();
}