diff --git a/dart/CHANGELOG.md b/dart/CHANGELOG.md index b594106..3d81edd 100644 --- a/dart/CHANGELOG.md +++ b/dart/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 3.15.1 +- Add `getVmWsUriFromObservatoryUri`, a helper function to convert observatory URIs + into the required WebSocket URI for connecting to the VM service. + ## 3.15.0 - support service protocol version 3.15 - fix an issue decoding null `Script.tokenPosTable` values diff --git a/dart/lib/utils.dart b/dart/lib/utils.dart new file mode 100644 index 0000000..75cc0a2 --- /dev/null +++ b/dart/lib/utils.dart @@ -0,0 +1,18 @@ +// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +/// Map the URI (which may already be Observatory web app) to a WebSocket URI +/// for the VM service. +/// +/// If the URI is already a VM Service WebSocket URI it will not be modified. +Uri getVmWsUriFromObservatoryUri(Uri uri) { + final isSecure = uri.isScheme('wss') || uri.isScheme('https'); + final scheme = isSecure ? 'wss' : 'ws'; + + final path = uri.path.endsWith('/ws') + ? uri.path + : (uri.path.endsWith('/') ? '${uri.path}ws' : '${uri.path}/ws'); + + return uri.replace(scheme: scheme, path: path); +} diff --git a/dart/pubspec.yaml b/dart/pubspec.yaml index a271ab7..54c1eb6 100644 --- a/dart/pubspec.yaml +++ b/dart/pubspec.yaml @@ -1,6 +1,6 @@ name: vm_service_lib description: A library to access the VM Service API. -version: 3.15.0 +version: 3.15.1 author: Dart Team homepage: https://github.com/dart-lang/vm_service_drivers diff --git a/dart/test/utils_test.dart b/dart/test/utils_test.dart new file mode 100644 index 0000000..fc2379b --- /dev/null +++ b/dart/test/utils_test.dart @@ -0,0 +1,35 @@ +// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +import 'package:test/test.dart'; +import 'package:vm_service_lib/utils.dart'; + +void main() { + test('getVmWsUriFromObservatoryUri maps URIs correctly', () { + final testCases = { + 'http://localhost:123/': 'ws://localhost:123/ws', + 'https://localhost:123/': 'wss://localhost:123/ws', + 'ws://localhost:123/': 'ws://localhost:123/ws', + 'wss://localhost:123/': 'wss://localhost:123/ws', + 'http://localhost:123/ABCDEF=/': 'ws://localhost:123/ABCDEF=/ws', + 'https://localhost:123/ABCDEF=/': 'wss://localhost:123/ABCDEF=/ws', + 'ws://localhost:123/ABCDEF=/': 'ws://localhost:123/ABCDEF=/ws', + 'wss://localhost:123/ABCDEF=/': 'wss://localhost:123/ABCDEF=/ws', + 'http://localhost:123': 'ws://localhost:123/ws', + 'https://localhost:123': 'wss://localhost:123/ws', + 'ws://localhost:123': 'ws://localhost:123/ws', + 'wss://localhost:123': 'wss://localhost:123/ws', + 'http://localhost:123/ABCDEF=': 'ws://localhost:123/ABCDEF=/ws', + 'https://localhost:123/ABCDEF=': 'wss://localhost:123/ABCDEF=/ws', + 'ws://localhost:123/ABCDEF=': 'ws://localhost:123/ABCDEF=/ws', + 'wss://localhost:123/ABCDEF=': 'wss://localhost:123/ABCDEF=/ws', + }; + + testCases.forEach((String input, String expected) { + final inputUri = Uri.parse(input); + final actualUri = getVmWsUriFromObservatoryUri(inputUri); + expect(actualUri.toString(), equals(expected)); + }); + }); +}