protocol_discovery.dart 7.63 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 8
import 'dart:async';

9 10
import 'package:meta/meta.dart';

11
import 'base/io.dart';
12
import 'base/logger.dart';
13
import 'device.dart';
14
import 'device_port_forwarder.dart';
15

16
/// Discovers a specific service protocol on a device, and forwards the service
17
/// protocol device port to the host.
18
class ProtocolDiscovery {
19
  ProtocolDiscovery._(
20 21
    this.logReader,
    this.serviceName, {
22
    this.portForwarder,
23
    this.throttleDuration,
24
    this.hostPort,
25
    this.devicePort,
26
    this.ipv6,
27 28 29
    Logger logger,
  }) : _logger = logger,
       assert(logReader != null) {
30 31 32 33 34
    _deviceLogSubscription = logReader.logLines.listen(
      _handleLine,
      onDone: _stopScrapingLogs,
    );
    _uriStreamController = _BufferedStreamController<Uri>();
35 36 37 38 39
  }

  factory ProtocolDiscovery.observatory(
    DeviceLogReader logReader, {
    DevicePortForwarder portForwarder,
40
    Duration throttleDuration,
41 42 43
    @required int hostPort,
    @required int devicePort,
    @required bool ipv6,
44
    @required Logger logger,
45 46
  }) {
    const String kObservatoryService = 'Observatory';
47
    return ProtocolDiscovery._(
48 49
      logReader,
      kObservatoryService,
50
      portForwarder: portForwarder,
51
      throttleDuration: throttleDuration ?? const Duration(milliseconds: 200),
52
      hostPort: hostPort,
53
      devicePort: devicePort,
54
      ipv6: ipv6,
55
      logger: logger,
56
    );
57 58
  }

59 60
  final DeviceLogReader logReader;
  final String serviceName;
61
  final DevicePortForwarder portForwarder;
62
  final int hostPort;
63
  final int devicePort;
64
  final bool ipv6;
65
  final Logger _logger;
66

67 68
  /// The time to wait before forwarding a new observatory URIs from [logReader].
  final Duration throttleDuration;
Devon Carew's avatar
Devon Carew committed
69

70
  StreamSubscription<String> _deviceLogSubscription;
71
  _BufferedStreamController<Uri> _uriStreamController;
72

73
  /// The discovered service URL.
74 75 76
  ///
  /// Returns null if the log reader shuts down before any uri is found.
  ///
77 78
  /// Use [uris] instead.
  // TODO(egarciad): replace `uri` for `uris`.
79 80 81 82 83 84
  Future<Uri> get uri async {
    try {
      return await uris.first;
    } on StateError {
      return null;
    }
85 86
  }

87
  /// The discovered service URLs.
88
  ///
89 90
  /// When a new observatory URL: is available in [logReader],
  /// the URLs are forwarded at most once every [throttleDuration].
91
  /// Returns when no event has been observed for [throttleTimeout].
92 93
  ///
  /// Port forwarding is only attempted when this is invoked,
94
  /// for each observatory URL in the stream.
95
  Stream<Uri> get uris {
96
    final Stream<Uri> uriStream = _uriStreamController.stream
97 98
      .transform(_throttle<Uri>(
        waitDuration: throttleDuration,
99 100
      ));
    return uriStream.asyncMap<Uri>(_forwardPort);
101
  }
102

103
  Future<void> cancel() => _stopScrapingLogs();
104

105
  Future<void> _stopScrapingLogs() async {
106
    await _uriStreamController?.close();
107 108
    await _deviceLogSubscription?.cancel();
    _deviceLogSubscription = null;
Devon Carew's avatar
Devon Carew committed
109 110
  }

111
  Match _getPatternMatch(String line) {
112
    final RegExp r = RegExp(RegExp.escape(serviceName) + r' listening on ((http|//)[a-zA-Z0-9:/=_\-\.\[\]]+)');
113 114
    return r.firstMatch(line);
  }
115

116 117
  Uri _getObservatoryUri(String line) {
    final Match match = _getPatternMatch(line);
118
    if (match != null) {
119 120 121 122 123 124 125 126 127
      return Uri.parse(match[1]);
    }
    return null;
  }

  void _handleLine(String line) {
    Uri uri;
    try {
      uri = _getObservatoryUri(line);
128
    } on FormatException catch (error, stackTrace) {
129
      _uriStreamController.addError(error, stackTrace);
130
    }
131
    if (uri == null || uri.host.isEmpty) {
132
      return;
133
    }
134
    if (devicePort != null && uri.port != devicePort) {
135
      _logger.printTrace('skipping potential observatory $uri due to device port mismatch');
136 137
      return;
    }
138
    _uriStreamController.add(uri);
139 140
  }

141
  Future<Uri> _forwardPort(Uri deviceUri) async {
142
    _logger.printTrace('$serviceName URL on device: $deviceUri');
143 144 145
    Uri hostUri = deviceUri;

    if (portForwarder != null) {
146 147
      final int actualDevicePort = deviceUri.port;
      final int actualHostPort = await portForwarder.forward(actualDevicePort, hostPort: hostPort);
148
      _logger.printTrace('Forwarded host port $actualHostPort to device port $actualDevicePort for $serviceName');
149
      hostUri = deviceUri.replace(port: actualHostPort);
150
    }
Devon Carew's avatar
Devon Carew committed
151

152
    if (InternetAddress(hostUri.host).isLoopback && ipv6) {
153
      hostUri = hostUri.replace(host: InternetAddress.loopbackIPv6.host);
154
    }
155
    return hostUri;
156 157
  }
}
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

/// Provides a broadcast stream controller that buffers the events
/// if there isn't a listener attached.
/// The events are then delivered when a listener is attached to the stream.
class _BufferedStreamController<T> {
  _BufferedStreamController() : _events = <dynamic>[];

  /// The stream that this controller is controlling.
  Stream<T> get stream {
    return _streamController.stream;
  }

  StreamController<T> _streamControllerInstance;

  StreamController<T> get _streamController {
    _streamControllerInstance ??= StreamController<T>.broadcast(onListen: () {
174
      for (final dynamic event in _events) {
175
        assert(T is! List);
176 177 178 179
        if (event is T) {
          _streamControllerInstance.add(event);
        } else {
          _streamControllerInstance.addError(
180 181
            (event as Iterable<dynamic>).first as Object,
            (event as Iterable<dynamic>).last as StackTrace,
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
          );
        }
      }
      _events.clear();
    });
    return _streamControllerInstance;
  }

  final List<dynamic> _events;

  /// Sends [event] if there is a listener attached to the broadcast stream.
  /// Otherwise, it enqueues [event] until a listener is attached.
  void add(T event) {
    if (_streamController.hasListener) {
      _streamController.add(event);
    } else {
      _events.add(event);
    }
  }

  /// Sends or enqueues an error event.
  void addError(Object error, [StackTrace stackTrace]) {
    if (_streamController.hasListener) {
      _streamController.addError(error, stackTrace);
    } else {
      _events.add(<dynamic>[error, stackTrace]);
    }
  }

  /// Closes the stream.
  Future<void> close() {
    return _streamController.close();
  }
}

/// This transformer will produce an event at most once every [waitDuration].
///
/// For example, consider a `waitDuration` of `10ms`, and list of event names
/// and arrival times: `a (0ms), b (5ms), c (11ms), d (21ms)`.
221
/// The events `a`, `c`, and `d` will be produced as a result.
222 223 224 225 226 227 228 229
StreamTransformer<S, S> _throttle<S>({
  @required Duration waitDuration,
}) {
  assert(waitDuration != null);

  S latestLine;
  int lastExecution;
  Future<void> throttleFuture;
230
  bool done = false;
231 232 233 234 235 236

  return StreamTransformer<S, S>
    .fromHandlers(
      handleData: (S value, EventSink<S> sink) {
        latestLine = value;

237
        final bool isFirstMessage = lastExecution == null;
238 239 240
        final int currentTime = DateTime.now().millisecondsSinceEpoch;
        lastExecution ??= currentTime;
        final int remainingTime = currentTime - lastExecution;
241 242 243

        // Always send the first event immediately.
        final int nextExecutionTime = isFirstMessage || remainingTime > waitDuration.inMilliseconds
244 245 246 247 248
          ? 0
          : waitDuration.inMilliseconds - remainingTime;
        throttleFuture ??= Future<void>
          .delayed(Duration(milliseconds: nextExecutionTime))
          .whenComplete(() {
249 250 251
            if (done) {
              return;
            }
252 253 254 255
            sink.add(latestLine);
            throttleFuture = null;
            lastExecution = DateTime.now().millisecondsSinceEpoch;
          });
256 257 258 259
      },
      handleDone: (EventSink<S> sink) {
        done = true;
        sink.close();
260 261 262
      }
    );
}