Skip to content

F
Front-End
Unverified Commit 1725a26e authored by Naud Ghebre's avatar Naud Ghebre Committed by GitHub
Browse files
Options

Switch the way we retrieve the vm_service_port from /hub to iquery, on device. (#114834)

parent a84e369b
Show whitespace changes
Inline Side-by-side
Showing with 174 additions and 100 deletions
packages/fuchsia_remote_debug_protocol/lib/src/fuchsia_remote_connection.dart
View file @ 1725a26e
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
// found in the LICENSE file. // found in the LICENSE file.
import 'dart:async'; import 'dart:async';
import 'dart:convert';
import 'dart:io'; import 'dart:io';
import 'package:process/process.dart'; import 'package:process/process.dart';
...@@ -506,32 +507,55 @@ class FuchsiaRemoteConnection { ...@@ -506,32 +507,55 @@ class FuchsiaRemoteConnection {
_pollDartVms = true; _pollDartVms = true;
} }
/// Gets the open Dart VM service ports on a remote Fuchsia device. /// Helper for getDeviceServicePorts() to extract the vm_service_port from
/// /// json response.
/// The method attempts to get service ports through an SSH connection. Upon List<int> getVmServicePortFromInspectSnapshot(dynamic inspectSnapshot) {
/// successfully getting the VM service ports, returns them as a list of final List<Map<String, dynamic>> snapshot =
/// integers. If an empty list is returned, then no Dart VM instances could be List<Map<String, dynamic>>.from(inspectSnapshot as List<dynamic>);
/// found. An exception is thrown in the event of an actual error when
/// attempting to acquire the ports.
Future<List<int>> getDeviceServicePorts() async {
final List<String> portPaths = await _sshCommandRunner
.run('/bin/find /hub -name vmservice-port');
final List<int> ports = <int>[]; final List<int> ports = <int>[];
for (final String path in portPaths) {
if (path == '') { for (final Map<String, dynamic> item in snapshot) {
if (!item.containsKey('payload') || item['payload'] == null) {
continue;
}
final Map<String, dynamic> payload =
Map<String, dynamic>.from(item['payload'] as Map<String, dynamic>);
if (!payload.containsKey('root') || payload['root'] == null) {
continue; continue;
} }
final List<String> lsOutput = final Map<String, dynamic> root =
await _sshCommandRunner.run('/bin/ls $path'); Map<String, dynamic>.from(payload['root'] as Map<String, dynamic>);
for (final String line in lsOutput) {
if (line == '') { if (!root.containsKey('vm_service_port') ||
root['vm_service_port'] == null) {
continue; continue;
} }
final int? port = int.tryParse(line);
final int? port = int.tryParse(root['vm_service_port'] as String);
if (port != null) { if (port != null) {
ports.add(port); ports.add(port);
} }
} }
return ports;
}
/// Gets the open Dart VM service ports on a remote Fuchsia device.
///
/// The method attempts to get service ports through an SSH connection. Upon
/// successfully getting the VM service ports, returns them as a list of
/// integers. If an empty list is returned, then no Dart VM instances could be
/// found. An exception is thrown in the event of an actual error when
/// attempting to acquire the ports.
Future<List<int>> getDeviceServicePorts() async {
final List<String> inspectResult = await _sshCommandRunner
.run("iquery --format json show '**:root:vm_service_port'");
final dynamic inspectOutputJson = jsonDecode(inspectResult.join('\n'));
final List<int> ports =
getVmServicePortFromInspectSnapshot(inspectOutputJson);
if (ports.length > 1) {
throw StateError('More than one Flutter observatory port found');
} }
return ports; return ports;
} }
......
packages/fuchsia_remote_debug_protocol/test/fuchsia_remote_connection_test.dart
View file @ 1725a26e
...@@ -82,7 +82,7 @@ void main() { ...@@ -82,7 +82,7 @@ void main() {
restoreVmServiceConnectionFunction(); restoreVmServiceConnectionFunction();
}); });
test('end-to-end with three vm connections and flutter view query', () async { test('end-to-end with one vm connection and flutter view query', () async {
int port = 0; int port = 0;
Future<PortForwarder> fakePortForwardingFunction( Future<PortForwarder> fakePortForwardingFunction(
String address, String address,
...@@ -102,54 +102,72 @@ void main() { ...@@ -102,54 +102,72 @@ void main() {
fuchsiaPortForwardingFunction = fakePortForwardingFunction; fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner(); final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up. // Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n']; fakeRunner.iqueryResponse = <String>[
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789']; '[',
' {',
' "data_source": "Inspect",',
' "metadata": {',
' "filename": "fuchsia.inspect.Tree",',
' "component_url": "fuchsia-pkg://fuchsia.com/flutter_runner#meta/flutter_runner.cm",',
' "timestamp": 12345678901234',
' },',
' "moniker": "core/session-manager/session/flutter_runner",',
' "payload": {',
' "root": {',
' "vm_service_port": "12345",',
' "16859221": {',
' "empty_tree": "this semantic tree is empty"',
' },',
' "build_info": {',
' "dart_sdk_git_revision": "77e83fcc14fa94049f363d554579f48fbd6bb7a1",',
' "dart_sdk_semantic_version": "2.19.0-317.0.dev",',
' "flutter_engine_git_revision": "563b8e830c697a543bf0a8a9f4ae3edfad86ea86",',
' "fuchsia_sdk_version": "10.20221018.0.1"',
' },',
' "vm": {',
' "dst_status": 1,',
' "get_profile_status": 0,',
' "num_get_profile_calls": 1,',
' "num_intl_provider_errors": 0,',
' "num_on_change_calls": 0,',
' "timezone_content_status": 0,',
' "tz_data_close_status": -1,',
' "tz_data_status": -1',
' }',
' }',
' },',
' "version": 1',
' }',
' ]'
];
fakeRunner.address = 'fe80::8eae:4cff:fef4:9247'; fakeRunner.address = 'fe80::8eae:4cff:fef4:9247';
fakeRunner.interface = 'eno1'; fakeRunner.interface = 'eno1';
final FuchsiaRemoteConnection connection = final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner); await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different expect(forwardedPorts.length, 1);
// forwarded ports, incrementing the port each time by one. (Just a sanity expect(forwardedPorts[0].remotePort, 12345);
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via localhost ports given by // VMs should be accessed via localhost ports given by
// [fakePortForwardingFunction]. // [fakePortForwardingFunction].
expect(uriConnections[0], expect(uriConnections[0],
Uri(scheme:'ws', host:'[::1]', port:0, path:'/ws')); Uri(scheme: 'ws', host: '[::1]', port: 0, path: '/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'[::1]', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'[::1]', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews(); final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null)); expect(views, isNot(null));
expect(views.length, 3); expect(views.length, 1);
// Since name can be null, check for the ID on all of them. // Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0'); expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null)); expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called. // Ensure the ports are all closed after stop was called.
await connection.stop(); await connection.stop();
expect(forwardedPorts[0].stopped, true); expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
}); });
test('end-to-end with three vms and remote open port', () async { test('end-to-end with one vm and remote open port', () async {
int port = 0; int port = 0;
Future<PortForwarder> fakePortForwardingFunction( Future<PortForwarder> fakePortForwardingFunction(
String address, String address,
...@@ -170,53 +188,71 @@ void main() { ...@@ -170,53 +188,71 @@ void main() {
fuchsiaPortForwardingFunction = fakePortForwardingFunction; fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner(); final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up. // Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n']; fakeRunner.iqueryResponse = <String>[
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789']; '[',
' {',
' "data_source": "Inspect",',
' "metadata": {',
' "filename": "fuchsia.inspect.Tree",',
' "component_url": "fuchsia-pkg://fuchsia.com/flutter_runner#meta/flutter_runner.cm",',
' "timestamp": 12345678901234',
' },',
' "moniker": "core/session-manager/session/flutter_runner",',
' "payload": {',
' "root": {',
' "vm_service_port": "12345",',
' "16859221": {',
' "empty_tree": "this semantic tree is empty"',
' },',
' "build_info": {',
' "dart_sdk_git_revision": "77e83fcc14fa94049f363d554579f48fbd6bb7a1",',
' "dart_sdk_semantic_version": "2.19.0-317.0.dev",',
' "flutter_engine_git_revision": "563b8e830c697a543bf0a8a9f4ae3edfad86ea86",',
' "fuchsia_sdk_version": "10.20221018.0.1"',
' },',
' "vm": {',
' "dst_status": 1,',
' "get_profile_status": 0,',
' "num_get_profile_calls": 1,',
' "num_intl_provider_errors": 0,',
' "num_on_change_calls": 0,',
' "timezone_content_status": 0,',
' "tz_data_close_status": -1,',
' "tz_data_status": -1',
' }',
' }',
' },',
' "version": 1',
' }',
' ]'
];
fakeRunner.address = 'fe80::8eae:4cff:fef4:9247'; fakeRunner.address = 'fe80::8eae:4cff:fef4:9247';
fakeRunner.interface = 'eno1'; fakeRunner.interface = 'eno1';
final FuchsiaRemoteConnection connection = final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner); await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different expect(forwardedPorts.length, 1);
// forwarded ports, incrementing the port each time by one. (Just a sanity expect(forwardedPorts[0].remotePort, 12345);
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via the alternate address given by // VMs should be accessed via the alternate address given by
// [fakePortForwardingFunction]. // [fakePortForwardingFunction].
expect(uriConnections[0], expect(uriConnections[0],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:0, path:'/ws')); Uri(scheme: 'ws', host: '[fe80::1:2%25eno2]', port: 0, path: '/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews(); final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null)); expect(views, isNot(null));
expect(views.length, 3); expect(views.length, 1);
// Since name can be null, check for the ID on all of them. // Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0'); expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null)); expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called. // Ensure the ports are all closed after stop was called.
await connection.stop(); await connection.stop();
expect(forwardedPorts[0].stopped, true); expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
}); });
test('end-to-end with three vms and ipv4', () async { test('end-to-end with one vm and ipv4', () async {
int port = 0; int port = 0;
Future<PortForwarder> fakePortForwardingFunction( Future<PortForwarder> fakePortForwardingFunction(
String address, String address,
...@@ -236,49 +272,67 @@ void main() { ...@@ -236,49 +272,67 @@ void main() {
fuchsiaPortForwardingFunction = fakePortForwardingFunction; fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner(); final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up. // Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n']; fakeRunner.iqueryResponse = <String>[
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789']; '[',
' {',
' "data_source": "Inspect",',
' "metadata": {',
' "filename": "fuchsia.inspect.Tree",',
' "component_url": "fuchsia-pkg://fuchsia.com/flutter_runner#meta/flutter_runner.cm",',
' "timestamp": 12345678901234',
' },',
' "moniker": "core/session-manager/session/flutter_runner",',
' "payload": {',
' "root": {',
' "vm_service_port": "12345",',
' "16859221": {',
' "empty_tree": "this semantic tree is empty"',
' },',
' "build_info": {',
' "dart_sdk_git_revision": "77e83fcc14fa94049f363d554579f48fbd6bb7a1",',
' "dart_sdk_semantic_version": "2.19.0-317.0.dev",',
' "flutter_engine_git_revision": "563b8e830c697a543bf0a8a9f4ae3edfad86ea86",',
' "fuchsia_sdk_version": "10.20221018.0.1"',
' },',
' "vm": {',
' "dst_status": 1,',
' "get_profile_status": 0,',
' "num_get_profile_calls": 1,',
' "num_intl_provider_errors": 0,',
' "num_on_change_calls": 0,',
' "timezone_content_status": 0,',
' "tz_data_close_status": -1,',
' "tz_data_status": -1',
' }',
' }',
' },',
' "version": 1',
' }',
' ]'
];
fakeRunner.address = '196.168.1.4'; fakeRunner.address = '196.168.1.4';
final FuchsiaRemoteConnection connection = final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner); await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different expect(forwardedPorts.length, 1);
// forwarded ports, incrementing the port each time by one. (Just a sanity expect(forwardedPorts[0].remotePort, 12345);
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via the ipv4 loopback. // VMs should be accessed via the ipv4 loopback.
expect(uriConnections[0], expect(uriConnections[0],
Uri(scheme:'ws', host:'127.0.0.1', port:0, path:'/ws')); Uri(scheme: 'ws', host: '127.0.0.1', port: 0, path: '/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'127.0.0.1', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'127.0.0.1', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews(); final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null)); expect(views, isNot(null));
expect(views.length, 3); expect(views.length, 1);
// Since name can be null, check for the ID on all of them. // Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0'); expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null)); expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called. // Ensure the ports are all closed after stop was called.
await connection.stop(); await connection.stop();
expect(forwardedPorts[0].stopped, true); expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
}); });
test('env variable test without remote addr', () async { test('env variable test without remote addr', () async {
...@@ -294,15 +348,11 @@ void main() { ...@@ -294,15 +348,11 @@ void main() {
} }
class FakeSshCommandRunner extends Fake implements SshCommandRunner { class FakeSshCommandRunner extends Fake implements SshCommandRunner {
List<String>? findResponse; List<String>? iqueryResponse;
List<String>? lsResponse;
@override @override
Future<List<String>> run(String command) async { Future<List<String>> run(String command) async {
if (command.startsWith('/bin/find')) { if (command.startsWith('iquery --format json show')) {
return findResponse!; return iqueryResponse!;
}
if (command.startsWith('/bin/ls')) {
return lsResponse!;
} }
throw UnimplementedError(command); throw UnimplementedError(command);
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

HIAST - GitLab