Unverified Commit a07e8a6a authored by Victoria Ashworth's avatar Victoria Ashworth Committed by GitHub

[reland] Support wireless debugging (#118895)

* Reland "Support iOS wireless debugging (#118104)"

This reverts commit cbf2e168.

* Remove device loading status
parent bf72f5eb
...@@ -24,6 +24,7 @@ import '../device.dart'; ...@@ -24,6 +24,7 @@ import '../device.dart';
import '../device_port_forwarder.dart'; import '../device_port_forwarder.dart';
import '../fuchsia/fuchsia_device.dart'; import '../fuchsia/fuchsia_device.dart';
import '../ios/devices.dart'; import '../ios/devices.dart';
import '../ios/iproxy.dart';
import '../ios/simulators.dart'; import '../ios/simulators.dart';
import '../macos/macos_ipad_device.dart'; import '../macos/macos_ipad_device.dart';
import '../mdns_discovery.dart'; import '../mdns_discovery.dart';
...@@ -229,7 +230,7 @@ known, it can be explicitly provided to attach via the command-line, e.g. ...@@ -229,7 +230,7 @@ known, it can be explicitly provided to attach via the command-line, e.g.
} }
if (debugPort != null && debugUri != null) { if (debugPort != null && debugUri != null) {
throwToolExit( throwToolExit(
'Either --debugPort or --debugUri can be provided, not both.'); 'Either --debug-port or --debug-url can be provided, not both.');
} }
if (userIdentifier != null) { if (userIdentifier != null) {
...@@ -282,8 +283,9 @@ known, it can be explicitly provided to attach via the command-line, e.g. ...@@ -282,8 +283,9 @@ known, it can be explicitly provided to attach via the command-line, e.g.
final String ipv6Loopback = InternetAddress.loopbackIPv6.address; final String ipv6Loopback = InternetAddress.loopbackIPv6.address;
final String ipv4Loopback = InternetAddress.loopbackIPv4.address; final String ipv4Loopback = InternetAddress.loopbackIPv4.address;
final String hostname = usesIpv6 ? ipv6Loopback : ipv4Loopback; final String hostname = usesIpv6 ? ipv6Loopback : ipv4Loopback;
final bool isNetworkDevice = (device is IOSDevice) && device.interfaceType == IOSDeviceConnectionInterface.network;
if (debugPort == null && debugUri == null) { if ((debugPort == null && debugUri == null) || isNetworkDevice) {
if (device is FuchsiaDevice) { if (device is FuchsiaDevice) {
final String module = stringArgDeprecated('module')!; final String module = stringArgDeprecated('module')!;
if (module == null) { if (module == null) {
...@@ -303,16 +305,73 @@ known, it can be explicitly provided to attach via the command-line, e.g. ...@@ -303,16 +305,73 @@ known, it can be explicitly provided to attach via the command-line, e.g.
rethrow; rethrow;
} }
} else if ((device is IOSDevice) || (device is IOSSimulator) || (device is MacOSDesignedForIPadDevice)) { } else if ((device is IOSDevice) || (device is IOSSimulator) || (device is MacOSDesignedForIPadDevice)) {
final Uri? uriFromMdns = // Protocol Discovery relies on logging. On iOS earlier than 13, logging is gathered using syslog.
await MDnsObservatoryDiscovery.instance!.getObservatoryUri( // syslog is not available for iOS 13+. For iOS 13+, Protocol Discovery gathers logs from the VMService.
// Since we don't have access to the VMService yet, Protocol Discovery cannot be used for iOS 13+.
// Also, network devices must be found using mDNS and cannot use Protocol Discovery.
final bool compatibleWithProtocolDiscovery = (device is IOSDevice) &&
device.majorSdkVersion < IOSDeviceLogReader.minimumUniversalLoggingSdkVersion &&
!isNetworkDevice;
_logger.printStatus('Waiting for a connection from Flutter on ${device.name}...');
final Status discoveryStatus = _logger.startSpinner(
timeout: const Duration(seconds: 30),
slowWarningCallback: () {
// If relying on mDNS to find Dart VM Service, remind the user to allow local network permissions.
if (!compatibleWithProtocolDiscovery) {
return 'The Dart VM Service was not discovered after 30 seconds. This is taking much longer than expected...\n\n'
'Click "Allow" to the prompt asking if you would like to find and connect devices on your local network. '
'If you selected "Don\'t Allow", you can turn it on in Settings > Your App Name > Local Network. '
"If you don't see your app in the Settings, uninstall the app and rerun to see the prompt again.\n";
}
return 'The Dart VM Service was not discovered after 30 seconds. This is taking much longer than expected...\n';
},
);
int? devicePort;
if (debugPort != null) {
devicePort = debugPort;
} else if (debugUri != null) {
devicePort = debugUri?.port;
} else if (deviceVmservicePort != null) {
devicePort = deviceVmservicePort;
}
final Future<Uri?> mDNSDiscoveryFuture = MDnsVmServiceDiscovery.instance!.getVMServiceUriForAttach(
appId, appId,
device, device,
usesIpv6: usesIpv6, usesIpv6: usesIpv6,
deviceVmservicePort: deviceVmservicePort, isNetworkDevice: isNetworkDevice,
deviceVmservicePort: devicePort,
); );
observatoryUri = uriFromMdns == null
Future<Uri?>? protocolDiscoveryFuture;
if (compatibleWithProtocolDiscovery) {
final ProtocolDiscovery vmServiceDiscovery = ProtocolDiscovery.observatory(
device.getLogReader(),
portForwarder: device.portForwarder,
ipv6: ipv6!,
devicePort: devicePort,
hostPort: hostVmservicePort,
logger: _logger,
);
protocolDiscoveryFuture = vmServiceDiscovery.uri;
}
final Uri? foundUrl;
if (protocolDiscoveryFuture == null) {
foundUrl = await mDNSDiscoveryFuture;
} else {
foundUrl = await Future.any(
<Future<Uri?>>[mDNSDiscoveryFuture, protocolDiscoveryFuture]
);
}
discoveryStatus.stop();
observatoryUri = foundUrl == null
? null ? null
: Stream<Uri>.value(uriFromMdns).asBroadcastStream(); : Stream<Uri>.value(foundUrl).asBroadcastStream();
} }
// If MDNS discovery fails or we're not on iOS, fallback to ProtocolDiscovery. // If MDNS discovery fails or we're not on iOS, fallback to ProtocolDiscovery.
if (observatoryUri == null) { if (observatoryUri == null) {
...@@ -335,7 +394,7 @@ known, it can be explicitly provided to attach via the command-line, e.g. ...@@ -335,7 +394,7 @@ known, it can be explicitly provided to attach via the command-line, e.g.
} else { } else {
observatoryUri = Stream<Uri> observatoryUri = Stream<Uri>
.fromFuture( .fromFuture(
buildObservatoryUri( buildVMServiceUri(
device, device,
debugUri?.host ?? hostname, debugUri?.host ?? hostname,
debugPort ?? debugUri!.port, debugPort ?? debugUri!.port,
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
import 'dart:async'; import 'dart:async';
import 'package:args/args.dart';
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
import 'package:package_config/package_config_types.dart'; import 'package:package_config/package_config_types.dart';
...@@ -21,6 +22,8 @@ import '../dart/package_map.dart'; ...@@ -21,6 +22,8 @@ import '../dart/package_map.dart';
import '../device.dart'; import '../device.dart';
import '../drive/drive_service.dart'; import '../drive/drive_service.dart';
import '../globals.dart' as globals; import '../globals.dart' as globals;
import '../ios/devices.dart';
import '../ios/iproxy.dart';
import '../resident_runner.dart'; import '../resident_runner.dart';
import '../runner/flutter_command.dart' show FlutterCommandCategory, FlutterCommandResult, FlutterOptions; import '../runner/flutter_command.dart' show FlutterCommandCategory, FlutterCommandResult, FlutterOptions;
import '../web/web_device.dart'; import '../web/web_device.dart';
...@@ -203,6 +206,27 @@ class DriveCommand extends RunCommandBase { ...@@ -203,6 +206,27 @@ class DriveCommand extends RunCommandBase {
@override @override
bool get cachePubGet => false; bool get cachePubGet => false;
String? get applicationBinaryPath => stringArgDeprecated(FlutterOptions.kUseApplicationBinary);
Future<Device?> get targetedDevice async {
return findTargetDevice(includeUnsupportedDevices: applicationBinaryPath == null);
}
// Network devices need `publish-port` to be enabled because it requires mDNS.
// If the flag wasn't provided as an actual argument and it's a network device,
// change it to be enabled.
@override
Future<bool> get disablePortPublication async {
final ArgResults? localArgResults = argResults;
final Device? device = await targetedDevice;
final bool isNetworkDevice = device is IOSDevice && device.interfaceType == IOSDeviceConnectionInterface.network;
if (isNetworkDevice && localArgResults != null && !localArgResults.wasParsed('publish-port')) {
_logger.printTrace('Network device is being used. Changing `publish-port` to be enabled.');
return false;
}
return !boolArgDeprecated('publish-port');
}
@override @override
Future<void> validateCommand() async { Future<void> validateCommand() async {
if (userIdentifier != null) { if (userIdentifier != null) {
...@@ -223,8 +247,7 @@ class DriveCommand extends RunCommandBase { ...@@ -223,8 +247,7 @@ class DriveCommand extends RunCommandBase {
if (await _fileSystem.type(testFile) != FileSystemEntityType.file) { if (await _fileSystem.type(testFile) != FileSystemEntityType.file) {
throwToolExit('Test file not found: $testFile'); throwToolExit('Test file not found: $testFile');
} }
final String? applicationBinaryPath = stringArgDeprecated(FlutterOptions.kUseApplicationBinary); final Device? device = await targetedDevice;
final Device? device = await findTargetDevice(includeUnsupportedDevices: applicationBinaryPath == null);
if (device == null) { if (device == null) {
throwToolExit(null); throwToolExit(null);
} }
......
...@@ -254,7 +254,7 @@ abstract class RunCommandBase extends FlutterCommand with DeviceBasedDevelopment ...@@ -254,7 +254,7 @@ abstract class RunCommandBase extends FlutterCommand with DeviceBasedDevelopment
purgePersistentCache: purgePersistentCache, purgePersistentCache: purgePersistentCache,
deviceVmServicePort: deviceVmservicePort, deviceVmServicePort: deviceVmservicePort,
hostVmServicePort: hostVmservicePort, hostVmServicePort: hostVmservicePort,
disablePortPublication: disablePortPublication, disablePortPublication: await disablePortPublication,
ddsPort: ddsPort, ddsPort: ddsPort,
devToolsServerAddress: devToolsServerAddress, devToolsServerAddress: devToolsServerAddress,
verboseSystemLogs: boolArgDeprecated('verbose-system-logs'), verboseSystemLogs: boolArgDeprecated('verbose-system-logs'),
......
...@@ -275,7 +275,7 @@ Future<T> runInContext<T>( ...@@ -275,7 +275,7 @@ Future<T> runInContext<T>(
featureFlags: featureFlags, featureFlags: featureFlags,
platform: globals.platform, platform: globals.platform,
), ),
MDnsObservatoryDiscovery: () => MDnsObservatoryDiscovery( MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
logger: globals.logger, logger: globals.logger,
flutterUsage: globals.flutterUsage, flutterUsage: globals.flutterUsage,
), ),
......
...@@ -17,6 +17,7 @@ import 'base/utils.dart'; ...@@ -17,6 +17,7 @@ import 'base/utils.dart';
import 'build_info.dart'; import 'build_info.dart';
import 'devfs.dart'; import 'devfs.dart';
import 'device_port_forwarder.dart'; import 'device_port_forwarder.dart';
import 'ios/iproxy.dart';
import 'project.dart'; import 'project.dart';
import 'vmservice.dart'; import 'vmservice.dart';
...@@ -917,7 +918,13 @@ class DebuggingOptions { ...@@ -917,7 +918,13 @@ class DebuggingOptions {
/// * https://github.com/dart-lang/sdk/blob/main/sdk/lib/html/doc/NATIVE_NULL_ASSERTIONS.md /// * https://github.com/dart-lang/sdk/blob/main/sdk/lib/html/doc/NATIVE_NULL_ASSERTIONS.md
final bool nativeNullAssertions; final bool nativeNullAssertions;
List<String> getIOSLaunchArguments(EnvironmentType environmentType, String? route, Map<String, Object?> platformArgs) { List<String> getIOSLaunchArguments(
EnvironmentType environmentType,
String? route,
Map<String, Object?> platformArgs, {
bool ipv6 = false,
IOSDeviceConnectionInterface interfaceType = IOSDeviceConnectionInterface.none
}) {
final String dartVmFlags = computeDartVmFlags(this); final String dartVmFlags = computeDartVmFlags(this);
return <String>[ return <String>[
if (enableDartProfiling) '--enable-dart-profiling', if (enableDartProfiling) '--enable-dart-profiling',
...@@ -954,6 +961,9 @@ class DebuggingOptions { ...@@ -954,6 +961,9 @@ class DebuggingOptions {
// Use the suggested host port. // Use the suggested host port.
if (environmentType == EnvironmentType.simulator && hostVmServicePort != null) if (environmentType == EnvironmentType.simulator && hostVmServicePort != null)
'--observatory-port=$hostVmServicePort', '--observatory-port=$hostVmServicePort',
// Tell the observatory to listen on all interfaces, don't restrict to the loopback.
if (interfaceType == IOSDeviceConnectionInterface.network)
'--observatory-host=${ipv6 ? '::0' : '0.0.0.0'}',
]; ];
} }
......
...@@ -9,6 +9,7 @@ import 'package:process/process.dart'; ...@@ -9,6 +9,7 @@ import 'package:process/process.dart';
import 'package:vm_service/vm_service.dart' as vm_service; import 'package:vm_service/vm_service.dart' as vm_service;
import '../application_package.dart'; import '../application_package.dart';
import '../base/common.dart';
import '../base/file_system.dart'; import '../base/file_system.dart';
import '../base/io.dart'; import '../base/io.dart';
import '../base/logger.dart'; import '../base/logger.dart';
...@@ -21,6 +22,7 @@ import '../device.dart'; ...@@ -21,6 +22,7 @@ import '../device.dart';
import '../device_port_forwarder.dart'; import '../device_port_forwarder.dart';
import '../globals.dart' as globals; import '../globals.dart' as globals;
import '../macos/xcdevice.dart'; import '../macos/xcdevice.dart';
import '../mdns_discovery.dart';
import '../project.dart'; import '../project.dart';
import '../protocol_discovery.dart'; import '../protocol_discovery.dart';
import '../vmservice.dart'; import '../vmservice.dart';
...@@ -189,15 +191,6 @@ class IOSDevice extends Device { ...@@ -189,15 +191,6 @@ class IOSDevice extends Device {
return majorVersionString != null ? int.tryParse(majorVersionString) ?? 0 : 0; return majorVersionString != null ? int.tryParse(majorVersionString) ?? 0 : 0;
} }
@override
bool get supportsHotReload => interfaceType == IOSDeviceConnectionInterface.usb;
@override
bool get supportsHotRestart => interfaceType == IOSDeviceConnectionInterface.usb;
@override
bool get supportsFlutterExit => interfaceType == IOSDeviceConnectionInterface.usb;
@override @override
final String name; final String name;
...@@ -318,7 +311,11 @@ class IOSDevice extends Device { ...@@ -318,7 +311,11 @@ class IOSDevice extends Device {
@visibleForTesting Duration? discoveryTimeout, @visibleForTesting Duration? discoveryTimeout,
}) async { }) async {
String? packageId; String? packageId;
if (interfaceType == IOSDeviceConnectionInterface.network &&
debuggingOptions.debuggingEnabled &&
debuggingOptions.disablePortPublication) {
throwToolExit('Cannot start app on wirelessly tethered iOS device. Try running again with the --publish-port flag');
}
if (!prebuiltApplication) { if (!prebuiltApplication) {
_logger.printTrace('Building ${package.name} for $id'); _logger.printTrace('Building ${package.name} for $id');
...@@ -353,8 +350,10 @@ class IOSDevice extends Device { ...@@ -353,8 +350,10 @@ class IOSDevice extends Device {
EnvironmentType.physical, EnvironmentType.physical,
route, route,
platformArgs, platformArgs,
ipv6: ipv6,
interfaceType: interfaceType,
); );
final Status installStatus = _logger.startProgress( Status startAppStatus = _logger.startProgress(
'Installing and launching...', 'Installing and launching...',
); );
try { try {
...@@ -379,9 +378,10 @@ class IOSDevice extends Device { ...@@ -379,9 +378,10 @@ class IOSDevice extends Device {
deviceLogReader.debuggerStream = iosDeployDebugger; deviceLogReader.debuggerStream = iosDeployDebugger;
} }
} }
// Don't port foward if debugging with a network device.
observatoryDiscovery = ProtocolDiscovery.observatory( observatoryDiscovery = ProtocolDiscovery.observatory(
deviceLogReader, deviceLogReader,
portForwarder: portForwarder, portForwarder: interfaceType == IOSDeviceConnectionInterface.network ? null : portForwarder,
hostPort: debuggingOptions.hostVmServicePort, hostPort: debuggingOptions.hostVmServicePort,
devicePort: debuggingOptions.deviceVmServicePort, devicePort: debuggingOptions.deviceVmServicePort,
ipv6: ipv6, ipv6: ipv6,
...@@ -412,12 +412,59 @@ class IOSDevice extends Device { ...@@ -412,12 +412,59 @@ class IOSDevice extends Device {
return LaunchResult.succeeded(); return LaunchResult.succeeded();
} }
_logger.printTrace('Application launched on the device. Waiting for observatory url.'); _logger.printTrace('Application launched on the device. Waiting for Dart VM Service url.');
final Timer timer = Timer(discoveryTimeout ?? const Duration(seconds: 30), () {
_logger.printError('iOS Observatory not discovered after 30 seconds. This is taking much longer than expected...'); final int defaultTimeout = interfaceType == IOSDeviceConnectionInterface.network ? 45 : 30;
final Timer timer = Timer(discoveryTimeout ?? Duration(seconds: defaultTimeout), () {
_logger.printError('The Dart VM Service was not discovered after $defaultTimeout seconds. This is taking much longer than expected...');
// If debugging with a wireless device and the timeout is reached, remind the
// user to allow local network permissions.
if (interfaceType == IOSDeviceConnectionInterface.network) {
_logger.printError(
'\nClick "Allow" to the prompt asking if you would like to find and connect devices on your local network. '
'This is required for wireless debugging. If you selected "Don\'t Allow", '
'you can turn it on in Settings > Your App Name > Local Network. '
"If you don't see your app in the Settings, uninstall the app and rerun to see the prompt again."
);
} else {
iosDeployDebugger?.pauseDumpBacktraceResume(); iosDeployDebugger?.pauseDumpBacktraceResume();
}
}); });
final Uri? localUri = await observatoryDiscovery?.uri;
Uri? localUri;
if (interfaceType == IOSDeviceConnectionInterface.network) {
// Wait for Dart VM Service to start up.
final Uri? serviceURL = await observatoryDiscovery?.uri;
if (serviceURL == null) {
await iosDeployDebugger?.stopAndDumpBacktrace();
return LaunchResult.failed();
}
// If Dart VM Service URL with the device IP is not found within 5 seconds,
// change the status message to prompt users to click Allow. Wait 5 seconds because it
// should only show this message if they have not already approved the permissions.
// MDnsVmServiceDiscovery usually takes less than 5 seconds to find it.
final Timer mDNSLookupTimer = Timer(const Duration(seconds: 5), () {
startAppStatus.stop();
startAppStatus = _logger.startProgress(
'Waiting for approval of local network permissions...',
);
});
// Get Dart VM Service URL with the device IP as the host.
localUri = await MDnsVmServiceDiscovery.instance!.getVMServiceUriForLaunch(
packageId,
this,
usesIpv6: ipv6,
deviceVmservicePort: serviceURL.port,
isNetworkDevice: true,
);
mDNSLookupTimer.cancel();
} else {
localUri = await observatoryDiscovery?.uri;
}
timer.cancel(); timer.cancel();
if (localUri == null) { if (localUri == null) {
await iosDeployDebugger?.stopAndDumpBacktrace(); await iosDeployDebugger?.stopAndDumpBacktrace();
...@@ -429,7 +476,7 @@ class IOSDevice extends Device { ...@@ -429,7 +476,7 @@ class IOSDevice extends Device {
_logger.printError(e.message); _logger.printError(e.message);
return LaunchResult.failed(); return LaunchResult.failed();
} finally { } finally {
installStatus.stop(); startAppStatus.stop();
} }
} }
...@@ -569,7 +616,6 @@ String decodeSyslog(String line) { ...@@ -569,7 +616,6 @@ String decodeSyslog(String line) {
} }
} }
@visibleForTesting
class IOSDeviceLogReader extends DeviceLogReader { class IOSDeviceLogReader extends DeviceLogReader {
IOSDeviceLogReader._( IOSDeviceLogReader._(
this._iMobileDevice, this._iMobileDevice,
......
...@@ -305,12 +305,6 @@ class XCDevice { ...@@ -305,12 +305,6 @@ class XCDevice {
final IOSDeviceConnectionInterface interface = _interfaceType(device); final IOSDeviceConnectionInterface interface = _interfaceType(device);
// Only support USB devices, skip "network" interface (Xcode > Window > Devices and Simulators > Connect via network).
// TODO(jmagman): Remove this check once wirelessly detected devices can be observed and attached, https://github.com/flutter/flutter/issues/15072.
if (interface != IOSDeviceConnectionInterface.usb) {
continue;
}
String? sdkVersion = _sdkVersion(device); String? sdkVersion = _sdkVersion(device);
if (sdkVersion != null) { if (sdkVersion != null) {
......
...@@ -569,7 +569,7 @@ abstract class FlutterCommand extends Command<void> { ...@@ -569,7 +569,7 @@ abstract class FlutterCommand extends Command<void> {
); );
} }
bool get disablePortPublication => !boolArgDeprecated('publish-port'); Future<bool> get disablePortPublication async => !boolArgDeprecated('publish-port');
void usesIpv6Flag({required bool verboseHelp}) { void usesIpv6Flag({required bool verboseHelp}) {
argParser.addFlag(ipv6Flag, argParser.addFlag(ipv6Flag,
......
...@@ -21,6 +21,8 @@ import 'package:flutter_tools/src/commands/drive.dart'; ...@@ -21,6 +21,8 @@ import 'package:flutter_tools/src/commands/drive.dart';
import 'package:flutter_tools/src/dart/pub.dart'; import 'package:flutter_tools/src/dart/pub.dart';
import 'package:flutter_tools/src/device.dart'; import 'package:flutter_tools/src/device.dart';
import 'package:flutter_tools/src/drive/drive_service.dart'; import 'package:flutter_tools/src/drive/drive_service.dart';
import 'package:flutter_tools/src/ios/devices.dart';
import 'package:flutter_tools/src/ios/iproxy.dart';
import 'package:flutter_tools/src/project.dart'; import 'package:flutter_tools/src/project.dart';
import 'package:package_config/package_config.dart'; import 'package:package_config/package_config.dart';
import 'package:test/fake.dart'; import 'package:test/fake.dart';
...@@ -406,6 +408,94 @@ void main() { ...@@ -406,6 +408,94 @@ void main() {
FileSystem: () => MemoryFileSystem.test(), FileSystem: () => MemoryFileSystem.test(),
ProcessManager: () => FakeProcessManager.any(), ProcessManager: () => FakeProcessManager.any(),
}); });
testUsingContext('Port publication not disabled for network device', () async {
final DriveCommand command = DriveCommand(
fileSystem: fileSystem,
logger: logger,
platform: platform,
signals: signals,
);
fileSystem.file('lib/main.dart').createSync(recursive: true);
fileSystem.file('test_driver/main_test.dart').createSync(recursive: true);
fileSystem.file('pubspec.yaml').createSync();
final Device networkDevice = FakeIosDevice()
..interfaceType = IOSDeviceConnectionInterface.network;
fakeDeviceManager.devices = <Device>[networkDevice];
await expectLater(() => createTestCommandRunner(command).run(<String>[
'drive',
]), throwsToolExit());
final DebuggingOptions options = await command.createDebuggingOptions(false);
expect(options.disablePortPublication, false);
}, overrides: <Type, Generator>{
Cache: () => Cache.test(processManager: FakeProcessManager.any()),
FileSystem: () => MemoryFileSystem.test(),
ProcessManager: () => FakeProcessManager.any(),
DeviceManager: () => fakeDeviceManager,
});
testUsingContext('Port publication is disabled for wired device', () async {
final DriveCommand command = DriveCommand(
fileSystem: fileSystem,
logger: logger,
platform: platform,
signals: signals,
);
fileSystem.file('lib/main.dart').createSync(recursive: true);
fileSystem.file('test_driver/main_test.dart').createSync(recursive: true);
fileSystem.file('pubspec.yaml').createSync();
await expectLater(() => createTestCommandRunner(command).run(<String>[
'drive',
]), throwsToolExit());
final Device usbDevice = FakeIosDevice()
..interfaceType = IOSDeviceConnectionInterface.usb;
fakeDeviceManager.devices = <Device>[usbDevice];
final DebuggingOptions options = await command.createDebuggingOptions(false);
expect(options.disablePortPublication, true);
}, overrides: <Type, Generator>{
Cache: () => Cache.test(processManager: FakeProcessManager.any()),
FileSystem: () => MemoryFileSystem.test(),
ProcessManager: () => FakeProcessManager.any(),
DeviceManager: () => fakeDeviceManager,
});
testUsingContext('Port publication does not default to enabled for network device if flag manually added', () async {
final DriveCommand command = DriveCommand(
fileSystem: fileSystem,
logger: logger,
platform: platform,
signals: signals,
);
fileSystem.file('lib/main.dart').createSync(recursive: true);
fileSystem.file('test_driver/main_test.dart').createSync(recursive: true);
fileSystem.file('pubspec.yaml').createSync();
final Device networkDevice = FakeIosDevice()
..interfaceType = IOSDeviceConnectionInterface.network;
fakeDeviceManager.devices = <Device>[networkDevice];
await expectLater(() => createTestCommandRunner(command).run(<String>[
'drive',
'--no-publish-port'
]), throwsToolExit());
final DebuggingOptions options = await command.createDebuggingOptions(false);
expect(options.disablePortPublication, true);
}, overrides: <Type, Generator>{
Cache: () => Cache.test(processManager: FakeProcessManager.any()),
FileSystem: () => MemoryFileSystem.test(),
ProcessManager: () => FakeProcessManager.any(),
DeviceManager: () => fakeDeviceManager,
});
} }
// Unfortunately Device, despite not being immutable, has an `operator ==`. // Unfortunately Device, despite not being immutable, has an `operator ==`.
...@@ -577,3 +667,14 @@ class FakeProcessSignal extends Fake implements io.ProcessSignal { ...@@ -577,3 +667,14 @@ class FakeProcessSignal extends Fake implements io.ProcessSignal {
@override @override
Stream<io.ProcessSignal> watch() => controller.stream; Stream<io.ProcessSignal> watch() => controller.stream;
} }
// Unfortunately Device, despite not being immutable, has an `operator ==`.
// Until we fix that, we have to also ignore related lints here.
// ignore: avoid_implementing_value_types
class FakeIosDevice extends Fake implements IOSDevice {
@override
IOSDeviceConnectionInterface interfaceType = IOSDeviceConnectionInterface.usb;
@override
Future<TargetPlatform> get targetPlatform async => TargetPlatform.ios;
}
...@@ -11,6 +11,7 @@ import 'package:flutter_tools/src/base/utils.dart'; ...@@ -11,6 +11,7 @@ import 'package:flutter_tools/src/base/utils.dart';
import 'package:flutter_tools/src/build_info.dart'; import 'package:flutter_tools/src/build_info.dart';
import 'package:flutter_tools/src/convert.dart'; import 'package:flutter_tools/src/convert.dart';
import 'package:flutter_tools/src/device.dart'; import 'package:flutter_tools/src/device.dart';
import 'package:flutter_tools/src/ios/iproxy.dart';
import 'package:flutter_tools/src/project.dart'; import 'package:flutter_tools/src/project.dart';
import 'package:test/fake.dart'; import 'package:test/fake.dart';
...@@ -554,6 +555,53 @@ void main() { ...@@ -554,6 +555,53 @@ void main() {
); );
}); });
testWithoutContext('Get launch arguments for physical device with iPv4 network connection', () {
final DebuggingOptions original = DebuggingOptions.enabled(
BuildInfo.debug,
);
final List<String> launchArguments = original.getIOSLaunchArguments(
EnvironmentType.physical,
null,
<String, Object?>{},
interfaceType: IOSDeviceConnectionInterface.network,
);
expect(
launchArguments.join(' '),
<String>[
'--enable-dart-profiling',
'--enable-checked-mode',
'--verify-entry-points',
'--observatory-host=0.0.0.0',
].join(' '),
);
});
testWithoutContext('Get launch arguments for physical device with iPv6 network connection', () {
final DebuggingOptions original = DebuggingOptions.enabled(
BuildInfo.debug,
);
final List<String> launchArguments = original.getIOSLaunchArguments(
EnvironmentType.physical,
null,
<String, Object?>{},
ipv6: true,
interfaceType: IOSDeviceConnectionInterface.network,
);
expect(
launchArguments.join(' '),
<String>[
'--enable-dart-profiling',
'--enable-checked-mode',
'--verify-entry-points',
'--observatory-host=::0',
].join(' '),
);
});
testWithoutContext('Get launch arguments for physical device with debugging disabled with available launch arguments', () { testWithoutContext('Get launch arguments for physical device with debugging disabled with available launch arguments', () {
final DebuggingOptions original = DebuggingOptions.disabled( final DebuggingOptions original = DebuggingOptions.disabled(
BuildInfo.debug, BuildInfo.debug,
......
...@@ -19,9 +19,11 @@ import 'package:flutter_tools/src/ios/devices.dart'; ...@@ -19,9 +19,11 @@ import 'package:flutter_tools/src/ios/devices.dart';
import 'package:flutter_tools/src/ios/ios_deploy.dart'; import 'package:flutter_tools/src/ios/ios_deploy.dart';
import 'package:flutter_tools/src/ios/iproxy.dart'; import 'package:flutter_tools/src/ios/iproxy.dart';
import 'package:flutter_tools/src/ios/mac.dart'; import 'package:flutter_tools/src/ios/mac.dart';
import 'package:flutter_tools/src/mdns_discovery.dart';
import 'package:test/fake.dart'; import 'package:test/fake.dart';
import '../../src/common.dart'; import '../../src/common.dart';
import '../../src/context.dart';
import '../../src/fake_devices.dart'; import '../../src/fake_devices.dart';
import '../../src/fake_process_manager.dart'; import '../../src/fake_process_manager.dart';
import '../../src/fakes.dart'; import '../../src/fakes.dart';
...@@ -66,9 +68,10 @@ const FakeCommand kLaunchDebugCommand = FakeCommand(command: <String>[ ...@@ -66,9 +68,10 @@ const FakeCommand kLaunchDebugCommand = FakeCommand(command: <String>[
FakeCommand attachDebuggerCommand({ FakeCommand attachDebuggerCommand({
IOSink? stdin, IOSink? stdin,
Completer<void>? completer, Completer<void>? completer,
bool isNetworkDevice = false,
}) { }) {
return FakeCommand( return FakeCommand(
command: const <String>[ command: <String>[
'script', 'script',
'-t', '-t',
'0', '0',
...@@ -79,8 +82,11 @@ FakeCommand attachDebuggerCommand({ ...@@ -79,8 +82,11 @@ FakeCommand attachDebuggerCommand({
'--bundle', '--bundle',
'/', '/',
'--debug', '--debug',
'--no-wifi', if (!isNetworkDevice) '--no-wifi',
'--args', '--args',
if (isNetworkDevice)
'--enable-dart-profiling --enable-checked-mode --verify-entry-points --observatory-host=0.0.0.0'
else
'--enable-dart-profiling --enable-checked-mode --verify-entry-points', '--enable-dart-profiling --enable-checked-mode --verify-entry-points',
], ],
completer: completer, completer: completer,
...@@ -188,7 +194,7 @@ void main() { ...@@ -188,7 +194,7 @@ void main() {
expect(await device.stopApp(iosApp), false); expect(await device.stopApp(iosApp), false);
}); });
testWithoutContext('IOSDevice.startApp prints warning message if discovery takes longer than configured timeout', () async { testWithoutContext('IOSDevice.startApp prints warning message if discovery takes longer than configured timeout for wired device', () async {
final FileSystem fileSystem = MemoryFileSystem.test(); final FileSystem fileSystem = MemoryFileSystem.test();
final BufferLogger logger = BufferLogger.test(); final BufferLogger logger = BufferLogger.test();
final CompleterIOSink stdin = CompleterIOSink(); final CompleterIOSink stdin = CompleterIOSink();
...@@ -226,12 +232,59 @@ void main() { ...@@ -226,12 +232,59 @@ void main() {
expect(launchResult.started, true); expect(launchResult.started, true);
expect(launchResult.hasObservatory, true); expect(launchResult.hasObservatory, true);
expect(await device.stopApp(iosApp), false); expect(await device.stopApp(iosApp), false);
expect(logger.errorText, contains('iOS Observatory not discovered after 30 seconds. This is taking much longer than expected...')); expect(logger.errorText, contains('The Dart VM Service was not discovered after 30 seconds. This is taking much longer than expected...'));
expect(utf8.decoder.convert(stdin.writes.first), contains('process interrupt')); expect(utf8.decoder.convert(stdin.writes.first), contains('process interrupt'));
completer.complete(); completer.complete();
expect(processManager, hasNoRemainingExpectations); expect(processManager, hasNoRemainingExpectations);
}); });
testUsingContext('IOSDevice.startApp prints warning message if discovery takes longer than configured timeout for wireless device', () async {
final FileSystem fileSystem = MemoryFileSystem.test();
final BufferLogger logger = BufferLogger.test();
final CompleterIOSink stdin = CompleterIOSink();
final Completer<void> completer = Completer<void>();
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
attachDebuggerCommand(stdin: stdin, completer: completer, isNetworkDevice: true),
]);
final IOSDevice device = setUpIOSDevice(
processManager: processManager,
fileSystem: fileSystem,
logger: logger,
interfaceType: IOSDeviceConnectionInterface.network,
);
final IOSApp iosApp = PrebuiltIOSApp(
projectBundleId: 'app',
bundleName: 'Runner',
uncompressedBundle: fileSystem.currentDirectory,
applicationPackage: fileSystem.currentDirectory,
);
final FakeDeviceLogReader deviceLogReader = FakeDeviceLogReader();
device.portForwarder = const NoOpDevicePortForwarder();
device.setLogReader(iosApp, deviceLogReader);
// Start writing messages to the log reader.
deviceLogReader.addLine('Foo');
deviceLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:456');
final LaunchResult launchResult = await device.startApp(iosApp,
prebuiltApplication: true,
debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
platformArgs: <String, dynamic>{},
discoveryTimeout: Duration.zero,
);
expect(launchResult.started, true);
expect(launchResult.hasObservatory, true);
expect(await device.stopApp(iosApp), false);
expect(logger.errorText, contains('The Dart VM Service was not discovered after 45 seconds. This is taking much longer than expected...'));
expect(logger.errorText, contains('Click "Allow" to the prompt asking if you would like to find and connect devices on your local network.'));
completer.complete();
expect(processManager, hasNoRemainingExpectations);
}, overrides: <Type, Generator>{
MDnsVmServiceDiscovery: () => FakeMDnsVmServiceDiscovery(),
});
testWithoutContext('IOSDevice.startApp succeeds in release mode', () async { testWithoutContext('IOSDevice.startApp succeeds in release mode', () async {
final FileSystem fileSystem = MemoryFileSystem.test(); final FileSystem fileSystem = MemoryFileSystem.test();
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[ final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
...@@ -505,6 +558,7 @@ IOSDevice setUpIOSDevice({ ...@@ -505,6 +558,7 @@ IOSDevice setUpIOSDevice({
Logger? logger, Logger? logger,
ProcessManager? processManager, ProcessManager? processManager,
IOSDeploy? iosDeploy, IOSDeploy? iosDeploy,
IOSDeviceConnectionInterface interfaceType = IOSDeviceConnectionInterface.usb,
}) { }) {
final Artifacts artifacts = Artifacts.test(); final Artifacts artifacts = Artifacts.test();
final FakePlatform macPlatform = FakePlatform( final FakePlatform macPlatform = FakePlatform(
...@@ -542,7 +596,7 @@ IOSDevice setUpIOSDevice({ ...@@ -542,7 +596,7 @@ IOSDevice setUpIOSDevice({
cache: cache, cache: cache,
), ),
cpuArchitecture: DarwinArch.arm64, cpuArchitecture: DarwinArch.arm64,
interfaceType: IOSDeviceConnectionInterface.usb, interfaceType: interfaceType,
); );
} }
...@@ -554,3 +608,18 @@ class FakeDevicePortForwarder extends Fake implements DevicePortForwarder { ...@@ -554,3 +608,18 @@ class FakeDevicePortForwarder extends Fake implements DevicePortForwarder {
disposed = true; disposed = true;
} }
} }
class FakeMDnsVmServiceDiscovery extends Fake implements MDnsVmServiceDiscovery {
@override
Future<Uri?> getVMServiceUriForLaunch(
String applicationId,
Device device, {
bool usesIpv6 = false,
int? hostVmservicePort,
required int deviceVmservicePort,
bool isNetworkDevice = false,
Duration timeout = Duration.zero,
}) async {
return Uri.tryParse('http://0.0.0.0:1234');
}
}
...@@ -479,7 +479,7 @@ void main() { ...@@ -479,7 +479,7 @@ void main() {
stdout: devicesOutput, stdout: devicesOutput,
)); ));
final List<IOSDevice> devices = await xcdevice.getAvailableIOSDevices(); final List<IOSDevice> devices = await xcdevice.getAvailableIOSDevices();
expect(devices, hasLength(3)); expect(devices, hasLength(4));
expect(devices[0].id, '00008027-00192736010F802E'); expect(devices[0].id, '00008027-00192736010F802E');
expect(devices[0].name, 'An iPhone (Space Gray)'); expect(devices[0].name, 'An iPhone (Space Gray)');
expect(await devices[0].sdkNameAndVersion, 'iOS 13.3 17C54'); expect(await devices[0].sdkNameAndVersion, 'iOS 13.3 17C54');
...@@ -488,10 +488,14 @@ void main() { ...@@ -488,10 +488,14 @@ void main() {
expect(devices[1].name, 'iPad 1'); expect(devices[1].name, 'iPad 1');
expect(await devices[1].sdkNameAndVersion, 'iOS 10.1 14C54'); expect(await devices[1].sdkNameAndVersion, 'iOS 10.1 14C54');
expect(devices[1].cpuArchitecture, DarwinArch.armv7); expect(devices[1].cpuArchitecture, DarwinArch.armv7);
expect(devices[2].id, 'f577a7903cc54959be2e34bc4f7f80b7009efcf4'); expect(devices[2].id, '234234234234234234345445687594e089dede3c44');
expect(devices[2].name, 'iPad 2'); expect(devices[2].name, 'A networked iPad');
expect(await devices[2].sdkNameAndVersion, 'iOS 10.1 14C54'); expect(await devices[2].sdkNameAndVersion, 'iOS 10.1 14C54');
expect(devices[2].cpuArchitecture, DarwinArch.arm64); // Defaults to arm64 for unknown architecture. expect(devices[2].cpuArchitecture, DarwinArch.arm64); // Defaults to arm64 for unknown architecture.
expect(devices[3].id, 'f577a7903cc54959be2e34bc4f7f80b7009efcf4');
expect(devices[3].name, 'iPad 2');
expect(await devices[3].sdkNameAndVersion, 'iOS 10.1 14C54');
expect(devices[3].cpuArchitecture, DarwinArch.arm64); // Defaults to arm64 for unknown architecture.
expect(fakeProcessManager, hasNoRemainingExpectations); expect(fakeProcessManager, hasNoRemainingExpectations);
}, overrides: <Type, Generator>{ }, overrides: <Type, Generator>{
Platform: () => macPlatform, Platform: () => macPlatform,
......
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