mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
ed9afbbc72
* Extract some of startApp into a reusable method * Get basic attach --machine working * Attach --machine tweaks Move validation to validate method and create daemon early so we get the startup event before trying to get a connection. * Bump daemon version so we know whether it's valid to flutter attach * Tweak output text * Swap package imports for relative * Review tweaks (naming, formatting, typedefs) * Separate arguments from process spawning This will make calling attach easier * Add a basic test for flutter attach --machine * Fix crash if port unforward modifies the list of forwarded ports * Add a no-op port forwarder for flutter-tester * Switch to using BasicProject instead of our own inline code * Fix expectation in test now we have a portForwarder * Remove stale TODO (this is done) * Tweak formatting * Change some Completers to void to fix Dart 2 issues
421 lines
15 KiB
Dart
421 lines
15 KiB
Dart
// Copyright 2015 The Chromium Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'dart:async';
|
|
|
|
import '../base/common.dart';
|
|
import '../base/file_system.dart';
|
|
import '../base/io.dart';
|
|
import '../base/utils.dart';
|
|
import '../build_info.dart';
|
|
import '../cache.dart';
|
|
import '../device.dart';
|
|
import '../globals.dart';
|
|
import '../ios/mac.dart';
|
|
import '../resident_runner.dart';
|
|
import '../run_cold.dart';
|
|
import '../run_hot.dart';
|
|
import '../runner/flutter_command.dart';
|
|
import 'daemon.dart';
|
|
|
|
abstract class RunCommandBase extends FlutterCommand {
|
|
// Used by run and drive commands.
|
|
RunCommandBase() {
|
|
addBuildModeFlags(defaultToRelease: false);
|
|
usesFlavorOption();
|
|
argParser
|
|
..addFlag('trace-startup',
|
|
negatable: false,
|
|
help: 'Start tracing during startup.',
|
|
)
|
|
..addFlag('ipv6',
|
|
hide: true,
|
|
negatable: false,
|
|
help: 'Binds to IPv6 localhost instead of IPv4 when the flutter tool\n'
|
|
'forwards the host port to a device port.',
|
|
)
|
|
..addOption('route',
|
|
help: 'Which route to load when running the app.',
|
|
)
|
|
..addOption('target-platform',
|
|
defaultsTo: 'default',
|
|
allowed: <String>['default', 'android-arm', 'android-arm64'],
|
|
help: 'Specify the target platform when building the app for an '
|
|
'Android device.\nIgnored on iOS.');
|
|
usesTargetOption();
|
|
usesPortOptions();
|
|
usesPubOption();
|
|
}
|
|
|
|
bool get traceStartup => argResults['trace-startup'];
|
|
bool get ipv6 => argResults['ipv6'];
|
|
String get route => argResults['route'];
|
|
|
|
void usesPortOptions() {
|
|
argParser.addOption('observatory-port',
|
|
help: 'Listen to the given port for an observatory debugger connection.\n'
|
|
'Specifying port 0 (the default) will find a random free port.'
|
|
);
|
|
}
|
|
|
|
int get observatoryPort {
|
|
if (argResults['observatory-port'] != null) {
|
|
try {
|
|
return int.parse(argResults['observatory-port']);
|
|
} catch (error) {
|
|
throwToolExit('Invalid port for `--observatory-port`: $error');
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
}
|
|
|
|
class RunCommand extends RunCommandBase {
|
|
@override
|
|
final String name = 'run';
|
|
|
|
@override
|
|
final String description = 'Run your Flutter app on an attached device.';
|
|
|
|
RunCommand({ bool verboseHelp = false }) {
|
|
requiresPubspecYaml();
|
|
|
|
argParser
|
|
..addFlag('start-paused',
|
|
negatable: false,
|
|
help: 'Start in a paused mode and wait for a debugger to connect.',
|
|
)
|
|
..addFlag('enable-software-rendering',
|
|
negatable: false,
|
|
help: 'Enable rendering using the Skia software backend. This is useful\n'
|
|
'when testing Flutter on emulators. By default, Flutter will\n'
|
|
'attempt to either use OpenGL or Vulkan and fall back to software\n'
|
|
'when neither is available.',
|
|
)
|
|
..addFlag('skia-deterministic-rendering',
|
|
negatable: false,
|
|
help: 'When combined with --enable-software-rendering, provides 100%\n'
|
|
'deterministic Skia rendering.',
|
|
)
|
|
..addFlag('trace-skia',
|
|
negatable: false,
|
|
help: 'Enable tracing of Skia code. This is useful when debugging\n'
|
|
'the GPU thread. By default, Flutter will not log skia code.',
|
|
)
|
|
..addFlag('use-test-fonts',
|
|
negatable: true,
|
|
help: 'Enable (and default to) the "Ahem" font. This is a special font\n'
|
|
'used in tests to remove any dependencies on the font metrics. It\n'
|
|
'is enabled when you use "flutter test". Set this flag when running\n'
|
|
'a test using "flutter run" for debugging purposes. This flag is\n'
|
|
'only available when running in debug mode.',
|
|
)
|
|
..addFlag('build',
|
|
defaultsTo: true,
|
|
help: 'If necessary, build the app before running.',
|
|
)
|
|
..addOption('use-application-binary',
|
|
hide: !verboseHelp,
|
|
help: 'Specify a pre-built application binary to use when running.',
|
|
)
|
|
..addFlag('preview-dart-2',
|
|
defaultsTo: true,
|
|
hide: !verboseHelp,
|
|
help: 'Preview Dart 2.0 functionality.',
|
|
)
|
|
..addFlag('build-snapshot',
|
|
hide: !verboseHelp,
|
|
defaultsTo: false,
|
|
help: 'Build and use application-specific VM snapshot instead of\n'
|
|
'prebuilt one provided by the engine.',
|
|
)
|
|
..addFlag('track-widget-creation',
|
|
hide: !verboseHelp,
|
|
help: 'Track widget creation locations. Requires Dart 2.0 functionality.',
|
|
)
|
|
..addOption('project-root',
|
|
hide: !verboseHelp,
|
|
help: 'Specify the project root directory.',
|
|
)
|
|
..addFlag('machine',
|
|
hide: !verboseHelp,
|
|
negatable: false,
|
|
help: 'Handle machine structured JSON command input and provide output\n'
|
|
'and progress in machine friendly format.',
|
|
)
|
|
..addFlag('hot',
|
|
negatable: true,
|
|
defaultsTo: kHotReloadDefault,
|
|
help: 'Run with support for hot reloading.',
|
|
)
|
|
..addOption('pid-file',
|
|
help: 'Specify a file to write the process id to.\n'
|
|
'You can send SIGUSR1 to trigger a hot reload\n'
|
|
'and SIGUSR2 to trigger a hot restart.',
|
|
)
|
|
..addFlag('resident',
|
|
negatable: true,
|
|
defaultsTo: true,
|
|
hide: !verboseHelp,
|
|
help: 'Stay resident after launching the application.',
|
|
)
|
|
..addFlag('benchmark',
|
|
negatable: false,
|
|
hide: !verboseHelp,
|
|
help: 'Enable a benchmarking mode. This will run the given application,\n'
|
|
'measure the startup time and the app restart time, write the\n'
|
|
'results out to "refresh_benchmark.json", and exit. This flag is\n'
|
|
'intended for use in generating automated flutter benchmarks.',
|
|
)
|
|
..addOption('output-dill',
|
|
hide: !verboseHelp,
|
|
help: 'Specify the path to frontend server output kernel file.',
|
|
)
|
|
..addOption(FlutterOptions.kExtraFrontEndOptions, hide: true)
|
|
..addOption(FlutterOptions.kExtraGenSnapshotOptions, hide: true)
|
|
..addMultiOption('filesystem-root',
|
|
hide: !verboseHelp,
|
|
help: 'Specify the path, that is used as root in a virtual file system\n'
|
|
'for compilation. Input file name should be specified as Uri in\n'
|
|
'filesystem-scheme scheme. Use only in Dart 2 mode.\n'
|
|
'Requires --output-dill option to be explicitly specified.\n')
|
|
..addOption('filesystem-scheme',
|
|
defaultsTo: 'org-dartlang-root',
|
|
hide: !verboseHelp,
|
|
help: 'Specify the scheme that is used for virtual file system used in\n'
|
|
'compilation. See more details on filesystem-root option.\n');
|
|
}
|
|
|
|
List<Device> devices;
|
|
|
|
@override
|
|
Future<String> get usagePath async {
|
|
final String command = await super.usagePath;
|
|
|
|
if (devices == null)
|
|
return command;
|
|
else if (devices.length > 1)
|
|
return '$command/all';
|
|
else
|
|
return '$command/${getNameForTargetPlatform(await devices[0].targetPlatform)}';
|
|
}
|
|
|
|
@override
|
|
Future<Map<String, String>> get usageValues async {
|
|
final bool isEmulator = await devices[0].isLocalEmulator;
|
|
final String deviceType = devices.length == 1
|
|
? getNameForTargetPlatform(await devices[0].targetPlatform)
|
|
: 'multiple';
|
|
|
|
return <String, String>{ 'cd3': '$isEmulator', 'cd4': deviceType };
|
|
}
|
|
|
|
@override
|
|
void printNoConnectedDevices() {
|
|
super.printNoConnectedDevices();
|
|
if (getCurrentHostPlatform() == HostPlatform.darwin_x64 &&
|
|
xcode.isInstalledAndMeetsVersionCheck) {
|
|
printStatus('');
|
|
printStatus("Run 'flutter emulators' to list and start any available device emulators.");
|
|
printStatus('');
|
|
printStatus('If you expected your device to be detected, please run "flutter doctor" to diagnose');
|
|
printStatus('potential issues, or visit https://flutter.io/setup/ for troubleshooting tips.');
|
|
}
|
|
}
|
|
|
|
@override
|
|
bool get shouldRunPub {
|
|
// If we are running with a prebuilt application, do not run pub.
|
|
if (runningWithPrebuiltApplication)
|
|
return false;
|
|
|
|
return super.shouldRunPub;
|
|
}
|
|
|
|
bool shouldUseHotMode() {
|
|
final bool hotArg = argResults['hot'] ?? false;
|
|
final bool shouldUseHotMode = hotArg;
|
|
return getBuildInfo().isDebug && shouldUseHotMode;
|
|
}
|
|
|
|
bool get runningWithPrebuiltApplication =>
|
|
argResults['use-application-binary'] != null;
|
|
|
|
bool get stayResident => argResults['resident'];
|
|
|
|
@override
|
|
Future<Null> validateCommand() async {
|
|
// When running with a prebuilt application, no command validation is
|
|
// necessary.
|
|
if (!runningWithPrebuiltApplication)
|
|
await super.validateCommand();
|
|
devices = await findAllTargetDevices();
|
|
if (devices == null)
|
|
throwToolExit(null);
|
|
if (deviceManager.hasSpecifiedAllDevices && runningWithPrebuiltApplication)
|
|
throwToolExit('Using -d all with --use-application-binary is not supported');
|
|
}
|
|
|
|
DebuggingOptions _createDebuggingOptions() {
|
|
final BuildInfo buildInfo = getBuildInfo();
|
|
if (buildInfo.isRelease) {
|
|
return new DebuggingOptions.disabled(buildInfo);
|
|
} else {
|
|
return new DebuggingOptions.enabled(
|
|
buildInfo,
|
|
startPaused: argResults['start-paused'],
|
|
useTestFonts: argResults['use-test-fonts'],
|
|
enableSoftwareRendering: argResults['enable-software-rendering'],
|
|
skiaDeterministicRendering: argResults['skia-deterministic-rendering'],
|
|
traceSkia: argResults['trace-skia'],
|
|
observatoryPort: observatoryPort,
|
|
);
|
|
}
|
|
}
|
|
|
|
@override
|
|
Future<FlutterCommandResult> runCommand() async {
|
|
Cache.releaseLockEarly();
|
|
|
|
// Enable hot mode by default if `--no-hot` was not passed and we are in
|
|
// debug mode.
|
|
final bool hotMode = shouldUseHotMode();
|
|
|
|
if (argResults['machine']) {
|
|
if (devices.length > 1)
|
|
throwToolExit('--machine does not support -d all.');
|
|
final Daemon daemon = new Daemon(stdinCommandStream, stdoutCommandResponse,
|
|
notifyingLogger: new NotifyingLogger(), logToStdout: true);
|
|
AppInstance app;
|
|
try {
|
|
app = await daemon.appDomain.startApp(
|
|
devices.first, fs.currentDirectory.path, targetFile, route,
|
|
_createDebuggingOptions(), hotMode,
|
|
applicationBinary: argResults['use-application-binary'],
|
|
trackWidgetCreation: argResults['track-widget-creation'],
|
|
projectRootPath: argResults['project-root'],
|
|
packagesFilePath: globalResults['packages'],
|
|
dillOutputPath: argResults['output-dill'],
|
|
ipv6: ipv6,
|
|
);
|
|
} catch (error) {
|
|
throwToolExit(error.toString());
|
|
}
|
|
final DateTime appStartedTime = clock.now();
|
|
final int result = await app.runner.waitForAppToFinish();
|
|
if (result != 0)
|
|
throwToolExit(null, exitCode: result);
|
|
return new FlutterCommandResult(
|
|
ExitStatus.success,
|
|
timingLabelParts: <String>['daemon'],
|
|
endTimeOverride: appStartedTime,
|
|
);
|
|
}
|
|
|
|
for (Device device in devices) {
|
|
if (await device.isLocalEmulator) {
|
|
if (await device.supportsHardwareRendering) {
|
|
final bool enableSoftwareRendering = argResults['enable-software-rendering'] == true;
|
|
if (enableSoftwareRendering) {
|
|
printStatus(
|
|
'Using software rendering with device ${device.name}. You may get better performance '
|
|
'with hardware mode by configuring hardware rendering for your device.'
|
|
);
|
|
} else {
|
|
printStatus(
|
|
'Using hardware rendering with device ${device.name}. If you get graphics artifacts, '
|
|
'consider enabling software rendering with "--enable-software-rendering".'
|
|
);
|
|
}
|
|
}
|
|
|
|
if (!isEmulatorBuildMode(getBuildMode())) {
|
|
throwToolExit('${toTitleCase(getModeName(getBuildMode()))} mode is not supported for emulators.');
|
|
}
|
|
}
|
|
}
|
|
|
|
if (hotMode) {
|
|
for (Device device in devices) {
|
|
if (!device.supportsHotMode)
|
|
throwToolExit('Hot mode is not supported by ${device.name}. Run with --no-hot.');
|
|
}
|
|
}
|
|
|
|
final String pidFile = argResults['pid-file'];
|
|
if (pidFile != null) {
|
|
// Write our pid to the file.
|
|
fs.file(pidFile).writeAsStringSync(pid.toString());
|
|
}
|
|
|
|
final List<FlutterDevice> flutterDevices = devices.map((Device device) {
|
|
return new FlutterDevice(
|
|
device,
|
|
previewDart2: argResults['preview-dart-2'],
|
|
trackWidgetCreation: argResults['track-widget-creation'],
|
|
dillOutputPath: argResults['output-dill'],
|
|
fileSystemRoots: argResults['filesystem-root'],
|
|
fileSystemScheme: argResults['filesystem-scheme'],
|
|
);
|
|
}).toList();
|
|
|
|
ResidentRunner runner;
|
|
if (hotMode) {
|
|
runner = new HotRunner(
|
|
flutterDevices,
|
|
target: targetFile,
|
|
debuggingOptions: _createDebuggingOptions(),
|
|
benchmarkMode: argResults['benchmark'],
|
|
applicationBinary: argResults['use-application-binary'],
|
|
projectRootPath: argResults['project-root'],
|
|
packagesFilePath: globalResults['packages'],
|
|
dillOutputPath: argResults['output-dill'],
|
|
stayResident: stayResident,
|
|
ipv6: ipv6,
|
|
);
|
|
} else {
|
|
runner = new ColdRunner(
|
|
flutterDevices,
|
|
target: targetFile,
|
|
debuggingOptions: _createDebuggingOptions(),
|
|
traceStartup: traceStartup,
|
|
applicationBinary: argResults['use-application-binary'],
|
|
stayResident: stayResident,
|
|
ipv6: ipv6,
|
|
);
|
|
}
|
|
|
|
DateTime appStartedTime;
|
|
// Sync completer so the completing agent attaching to the resident doesn't
|
|
// need to know about analytics.
|
|
//
|
|
// Do not add more operations to the future.
|
|
final Completer<void> appStartedTimeRecorder = new Completer<void>.sync();
|
|
// This callback can't throw.
|
|
appStartedTimeRecorder.future.then( // ignore: unawaited_futures
|
|
(_) { appStartedTime = clock.now(); }
|
|
);
|
|
|
|
final int result = await runner.run(
|
|
appStartedCompleter: appStartedTimeRecorder,
|
|
route: route,
|
|
shouldBuild: !runningWithPrebuiltApplication && argResults['build'],
|
|
);
|
|
if (result != 0)
|
|
throwToolExit(null, exitCode: result);
|
|
return new FlutterCommandResult(
|
|
ExitStatus.success,
|
|
timingLabelParts: <String>[
|
|
hotMode ? 'hot' : 'cold',
|
|
getModeName(getBuildMode()),
|
|
devices.length == 1
|
|
? getNameForTargetPlatform(await devices[0].targetPlatform)
|
|
: 'multiple',
|
|
devices.length == 1 && await devices[0].isLocalEmulator ? 'emulator' : null
|
|
],
|
|
endTimeOverride: appStartedTime,
|
|
);
|
|
}
|
|
}
|