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

import 'dart:async';

7 8
import 'package:meta/meta.dart';

9
import 'base/io.dart';
10
import 'base/logger.dart';
11
import 'device.dart';
12
import 'globals.dart' as globals;
13

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

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

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

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

68
  StreamSubscription<String> _deviceLogSubscription;
69
  _BufferedStreamController<Uri> _uriStreamController;
70

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

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

101
  Future<void> cancel() => _stopScrapingLogs();
102

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

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

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

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

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

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

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

/// 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: () {
173
      for (final dynamic event in _events) {
174
        assert(T is! List);
175 176 177 178 179 180 181 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
        if (event is T) {
          _streamControllerInstance.add(event);
        } else {
          _streamControllerInstance.addError(
            event.first as Object,
            event.last as StackTrace,
          );
        }
      }
      _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)`.
220
/// The events `a`, `c`, and `d` will be produced as a result.
221 222 223 224 225 226 227 228
StreamTransformer<S, S> _throttle<S>({
  @required Duration waitDuration,
}) {
  assert(waitDuration != null);

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

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

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

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