[ package:dds ] Add IPv6 support; 1.3.2 release

Change-Id: I62ca85c2340d8c91fd2f08c945bf981ac36adad3
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/161400
Reviewed-by: Ryan Macnak <[email protected]>
Commit-Queue: Ben Konyi <[email protected]>

Author: bkonyi

pkg/dds/CHANGELOG.md

@@ -1,5 +1,6 @@
-# 1.3.2-dev
+# 1.3.2
 
+- Add IPv6 hosting support.
 - Fix handling of requests that are outstanding when a client channel is closed.
 
 # 1.3.1

pkg/dds/lib/dds.dart

@@ -51,18 +51,23 @@ abstract class DartDevelopmentService {
   /// development service will communicate with.
   ///
   /// If provided, [serviceUri] will determine the address and port of the
-  /// spawned Dart Development Service.
+  /// spawned Dart Development Service. The format of [serviceUri] must be
+  /// consistent with the protocol determined by [ipv6].
   ///
   /// [enableAuthCodes] controls whether or not an authentication code must
   /// be provided by clients when communicating with this instance of
   /// [DartDevelopmentService]. Authentication codes take the form of a base64
   /// encoded string provided as the first element of the DDS path and is meant
   /// to make it more difficult for unintended clients to connect to this
   /// service. Authentication codes are enabled by default.
+  ///
+  /// [ipv6] controls whether or not DDS is served via IPv6. IPv4 is enabled by
+  /// default.
   static Future<DartDevelopmentService> startDartDevelopmentService(
     Uri remoteVmServiceUri, {
     Uri serviceUri,
     bool enableAuthCodes = true,
+    bool ipv6 = false,
   }) async {
     if (remoteVmServiceUri == null) {
       throw ArgumentError.notNull('remoteVmServiceUri');
@@ -72,15 +77,29 @@ abstract class DartDevelopmentService {
         'remoteVmServiceUri must have an HTTP scheme. Actual: ${remoteVmServiceUri.scheme}',
       );
     }
-    if (serviceUri != null && serviceUri.scheme != 'http') {
-      throw ArgumentError(
-        'serviceUri must have an HTTP scheme. Actual: ${serviceUri.scheme}',
-      );
+    if (serviceUri != null) {
+      if (serviceUri.scheme != 'http') {
+        throw ArgumentError(
+          'serviceUri must have an HTTP scheme. Actual: ${serviceUri.scheme}',
+        );
+      }
+
+      // If provided an address to bind to, ensure it uses a protocol consistent
+      // with that used to spawn DDS.
+      final address = (await InternetAddress.lookup(serviceUri.host)).first;
+      if ((ipv6 && address.type != InternetAddressType.IPv6) ||
+          (!ipv6 && address.type != InternetAddressType.IPv4)) {
+        throw ArgumentError(
+          "serviceUri '$serviceUri' is not an IPv${ipv6 ? "6" : "4"} address.",
+        );
+      }
     }
+
     final service = _DartDevelopmentService(
       remoteVmServiceUri,
       serviceUri,
       enableAuthCodes,
+      ipv6,
     );
     await service.startService();
     return service;

pkg/dds/lib/src/dds_impl.dart

@@ -6,10 +6,7 @@ part of dds;
 
 class _DartDevelopmentService implements DartDevelopmentService {
   _DartDevelopmentService(
-    this._remoteVmServiceUri,
-    this._uri,
-    this._authCodesEnabled,
-  ) {
+      this._remoteVmServiceUri, this._uri, this._authCodesEnabled, this._ipv6) {
     _clientManager = _ClientManager(this);
     _expressionEvaluator = _ExpressionEvaluator(this);
     _isolateManager = _IsolateManager(this);
@@ -38,8 +35,9 @@ class _DartDevelopmentService implements DartDevelopmentService {
 
   Future<void> _startDDSServer() async {
     // No provided address, bind to an available port on localhost.
-    // TODO(bkonyi): handle case where there's no IPv4 loopback.
-    final host = uri?.host ?? InternetAddress.loopbackIPv4.host;
+    final host = uri?.host ??
+        (_ipv6 ? InternetAddress.loopbackIPv6 : InternetAddress.loopbackIPv4)
+            .host;
     final port = uri?.port ?? 0;
 
     // Start the DDS server.
@@ -226,6 +224,8 @@ class _DartDevelopmentService implements DartDevelopmentService {
   Uri get wsUri => _toWebSocket(_uri);
   Uri _uri;
 
+  final bool _ipv6;
+
   bool get isRunning => _uri != null;
 
   Future<void> get done => _done.future;

pkg/dds/pubspec.yaml

@@ -3,7 +3,7 @@ description: >-
   A library used to spawn the Dart Developer Service, used to communicate with
   a Dart VM Service instance.
 
-version: 1.3.2-dev
+version: 1.3.2
 
 homepage: https://github.com/dart-lang/sdk/tree/master/pkg/dds
 

pkg/dds/test/smoke_test.dart

@@ -27,16 +27,26 @@ void main() {
       process = null;
     });
 
-    void createSmokeTest(bool useAuthCodes) {
+    void createSmokeTest(bool useAuthCodes, bool ipv6) {
+      final protocol = ipv6 ? 'IPv6' : 'IPv4';
       test(
-        'Smoke Test with ${useAuthCodes ? "" : "no "} authentication codes',
+        'Smoke Test with ${useAuthCodes ? "" : "no"} authentication codes '
+        'with $protocol',
         () async {
           dds = await DartDevelopmentService.startDartDevelopmentService(
             remoteVmServiceUri,
             enableAuthCodes: useAuthCodes,
+            ipv6: ipv6,
           );
           expect(dds.isRunning, true);
 
+          try {
+            Uri.parseIPv6Address(dds.uri.host);
+            expect(ipv6, true);
+          } on FormatException {
+            expect(ipv6, false);
+          }
+
           // Ensure basic websocket requests are forwarded correctly to the VM service.
           final service = await vmServiceConnectUri(dds.wsUri.toString());
           final version = await service.getVersion();
@@ -69,8 +79,9 @@ void main() {
       );
     }
 
-    createSmokeTest(true);
-    createSmokeTest(false);
+    createSmokeTest(true, false);
+    createSmokeTest(false, false);
+    createSmokeTest(true, true);
 
     test('startup fails when VM service has existing clients', () async {
       Uri httpToWebSocketUri(Uri httpUri) {
@@ -121,5 +132,23 @@ void main() {
               serviceUri: Uri.parse('dart-lang://localhost:2345'),
             ),
         throwsA(TypeMatcher<ArgumentError>()));
+
+    // Protocol mismatch
+    expect(
+        () async => await DartDevelopmentService.startDartDevelopmentService(
+              Uri.parse('http://localhost:1234'),
+              serviceUri: Uri.parse('http://127.0.0.1:2345'),
+              ipv6: true,
+            ),
+        throwsA(TypeMatcher<ArgumentError>()));
+
+    // Protocol mismatch
+    expect(
+        () async => await DartDevelopmentService.startDartDevelopmentService(
+              Uri.parse('http://localhost:1234'),
+              serviceUri: Uri.parse('http://[::1]:2345'),
+              ipv6: false,
+            ),
+        throwsA(TypeMatcher<ArgumentError>()));
   });
 }