Skip to content

Commit 2bddb74

Browse files
committed
[flutter_tools] Align DeviceService emulator support with createEmulator and --platform disambiguation
Updates tool extension emulator management to support emulator creation, `--platform` disambiguation, JSON-RPC `-32002` unsupported capability errors, and `flutter daemon` `EmulatorDomain` integration: - Maps `UnsupportedError` in `ToolExtensionEntryPoint` to JSON-RPC `-32002` (`unsupportedCapabilityErrorCode`). - Updates `DeviceService.launchEmulator` to return `Future<void>` (throwing `UnsupportedError` by default) and adds `DeviceService.getEmulatorPlatform`, `DeviceService.createEmulator`, and `DeviceService.isValidPlatformName`. - Adds `--platform <platform>` disambiguation and interactive / non-interactive platform selection to `flutter emulators --create`, allows `flutter emulators` to run when extension emulator sources are active without built-in workflows, and fails non-zero via `ToolExit` when launching an extension emulator fails. - Lazily initializes `ExtensionEmulators` (fail-closed when tool extensions are disabled), caches extension create-platform discovery, and forwards `toolDependencies.emulatorManager` and optional `'platform'` through `DaemonCommand`, `Daemon`, and `EmulatorDomain`. Part of flutter#190755 Part of flutter#190750
1 parent 251b31e commit 2bddb74

14 files changed

Lines changed: 1777 additions & 442 deletions

File tree

‎packages/flutter_tools/lib/executable.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,7 @@ List<FlutterCommand> generateCommands({
297297
buildSystem: toolDependencies.buildSystem,
298298
buildTargets: toolDependencies.buildTargets,
299299
deviceManager: toolDependencies.deviceManager,
300+
emulatorManager: toolDependencies.emulatorManager,
300301
hidden: !verboseHelp,
301302
toolContext: toolContext,
302303
xcode: toolDependencies.appleContext.xcode,

‎packages/flutter_tools/lib/src/base/terminal.dart‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,64 @@ class AnsiTerminal implements Terminal {
416416
}
417417
}
418418

419+
const _defaultNumberedChoicePrompt = 'Please choose one (or "q" to quit)';
420+
421+
/// Prompts the user to pick a 1-based option from `1..optionCount` or `'q'` to
422+
/// quit, using single-character input when [optionCount] is less than `10` and
423+
/// line input otherwise.
424+
Future<String> promptForNumberedChoice({
425+
required Logger logger,
426+
required int optionCount,
427+
required Terminal terminal,
428+
void Function()? onInvalidInput,
429+
String prompt = _defaultNumberedChoicePrompt,
430+
}) async {
431+
if (optionCount >= 10) {
432+
return readNumberedChoiceLine(
433+
logger: logger,
434+
optionCount: optionCount,
435+
terminal: terminal,
436+
onInvalidInput: onInvalidInput,
437+
prompt: prompt,
438+
);
439+
}
440+
terminal.usesTerminalUi = true;
441+
return terminal.promptForCharInput(
442+
<String>[for (int i = 0; i < optionCount; i++) '${i + 1}', 'q', 'Q'],
443+
displayAcceptedCharacters: false,
444+
logger: logger,
445+
prompt: prompt,
446+
);
447+
}
448+
449+
/// Reads a line-buffered 1-based choice from `1..optionCount` or `'q'` to quit.
450+
Future<String> readNumberedChoiceLine({
451+
required Logger logger,
452+
required int optionCount,
453+
required Terminal terminal,
454+
void Function()? onInvalidInput,
455+
String prompt = _defaultNumberedChoicePrompt,
456+
}) async {
457+
while (true) {
458+
logger.printStatus(prompt, emphasis: true, newline: false);
459+
logger.printStatus(': ', emphasis: true, newline: false);
460+
final String choice;
461+
try {
462+
choice = (await terminal.readLine()).trim();
463+
} on StateError {
464+
return 'q';
465+
}
466+
if (choice.toLowerCase() == 'q') {
467+
return choice;
468+
}
469+
final int? number = int.tryParse(choice);
470+
if (number != null && number >= 1 && number <= optionCount) {
471+
return choice;
472+
}
473+
onInvalidInput?.call();
474+
}
475+
}
476+
419477
class _TestTerminal implements Terminal {
420478
_TestTerminal({this.supportsColor = false, this.supportsEmoji = false});
421479

‎packages/flutter_tools/lib/src/commands/daemon.dart‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ class DaemonCommand extends FlutterCommand {
6262
required this._xcode,
6363
this._androidWorkflow,
6464
this._deviceManager,
65+
this._emulatorManager,
6566
this.hidden = false,
6667
}) {
6768
argParser.addOption(
@@ -77,6 +78,7 @@ class DaemonCommand extends FlutterCommand {
7778
final Xcode? _xcode;
7879
final AndroidWorkflow? _androidWorkflow;
7980
final DeviceManager? _deviceManager;
81+
final EmulatorManager? _emulatorManager;
8082

8183
AndroidSdk? get _androidSdk => _androidContext.androidSdk;
8284
Java? get _java => _androidContext.java;
@@ -125,6 +127,7 @@ class DaemonCommand extends FlutterCommand {
125127
androidSdk: _androidSdk,
126128
androidWorkflow: _androidWorkflow,
127129
deviceManager: _deviceManager,
130+
emulatorManager: _emulatorManager,
128131
java: _java,
129132
notifyingLogger: asLogger<NotifyingLogger>(logger),
130133
port: port,
@@ -145,6 +148,7 @@ class DaemonCommand extends FlutterCommand {
145148
androidSdk: _androidSdk,
146149
androidWorkflow: _androidWorkflow,
147150
deviceManager: _deviceManager,
151+
emulatorManager: _emulatorManager,
148152
java: _java,
149153
notifyingLogger: asLogger<NotifyingLogger>(logger),
150154
);
@@ -171,6 +175,7 @@ class DaemonServer {
171175
this.androidWorkflow,
172176
@visibleForTesting this._bind = ServerSocket.bind,
173177
this.deviceManager,
178+
this.emulatorManager,
174179
this.java,
175180
this.notifyingLogger,
176181
this.port,
@@ -190,6 +195,7 @@ class DaemonServer {
190195

191196
final Analytics analytics;
192197
final DeviceManager? deviceManager;
198+
final EmulatorManager? emulatorManager;
193199
final Java? java;
194200
final AndroidSdk? androidSdk;
195201
final FeatureFlags featureFlags;
@@ -234,6 +240,7 @@ class DaemonServer {
234240
xcode: xcode,
235241
notifyingLogger: notifyingLogger,
236242
deviceManager: deviceManager,
243+
emulatorManager: emulatorManager,
237244
java: java,
238245
androidSdk: androidSdk,
239246
featureFlags: featureFlags,
@@ -270,6 +277,7 @@ class Daemon {
270277
AndroidSdk? androidSdk,
271278
AndroidWorkflow? androidWorkflow,
272279
DeviceManager? deviceManager,
280+
EmulatorManager? emulatorManager,
273281
FileTransfer fileTransfer = const FileTransfer(),
274282
Java? java,
275283
this.logToStdout = false,
@@ -302,6 +310,7 @@ class Daemon {
302310
iosWorkflow: iosWorkflow,
303311
xcode: xcode,
304312
androidSdk: androidSdk,
313+
emulatorManager: emulatorManager,
305314
java: java,
306315
),
307316
);
@@ -330,6 +339,7 @@ class Daemon {
330339
AndroidSdk? androidSdk,
331340
AndroidWorkflow? androidWorkflow,
332341
DeviceManager? deviceManager,
342+
EmulatorManager? emulatorManager,
333343
Java? java,
334344
}) {
335345
final ToolContext(:Logger logger, :Stdio stdio) = toolContext;
@@ -348,6 +358,7 @@ class Daemon {
348358
: NotifyingLogger(verbose: logger.isVerbose, parent: logger),
349359
logToStdout: true,
350360
deviceManager: deviceManager,
361+
emulatorManager: emulatorManager,
351362
java: java,
352363
androidSdk: androidSdk,
353364
featureFlags: featureFlags,
@@ -1879,7 +1890,8 @@ class EmulatorDomain extends Domain {
18791890

18801891
Future<Map<String, Object?>> create(Map<String, Object?> args) async {
18811892
final String? name = _getStringArg(args, 'name');
1882-
final CreateEmulatorResult res = await emulators.createEmulator(name: name);
1893+
final String? platform = _getStringArg(args, 'platform');
1894+
final CreateEmulatorResult res = await emulators.createEmulator(name: name, platform: platform);
18831895
return <String, Object?>{
18841896
'success': res.success,
18851897
'emulatorName': res.emulatorName,

‎packages/flutter_tools/lib/src/commands/emulators.dart‎

Lines changed: 112 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,20 @@ import 'package:args/args.dart';
77
import '../base/common.dart';
88
import '../base/logger.dart';
99
import '../base/platform.dart';
10+
import '../base/terminal.dart';
1011
import '../base/utils.dart';
12+
import '../context/tool_context.dart';
1113
import '../doctor.dart';
1214
import '../doctor_validator.dart';
1315
import '../emulator.dart';
1416
import '../runner/flutter_command.dart';
1517

18+
const _launchOption = 'launch';
19+
const _coldFlag = 'cold';
20+
const _createFlag = 'create';
21+
const _nameOption = 'name';
22+
const _platformOption = 'platform';
23+
1624
/// The `flutter emulators` command, which lists, launches, and creates emulators.
1725
class EmulatorsCommand extends FlutterCommand {
1826
EmulatorsCommand({
@@ -21,21 +29,29 @@ class EmulatorsCommand extends FlutterCommand {
2129
required super.toolContext,
2230
super.verboseHelp,
2331
}) {
24-
argParser.addOption('launch', help: 'The full or partial ID of the emulator to launch.');
32+
argParser.addOption(_launchOption, help: 'The full or partial ID of the emulator to launch.');
2533
argParser.addFlag(
26-
'cold',
27-
help: 'Used with the "--launch" flag to cold boot the emulator instance (Android only).',
34+
_coldFlag,
35+
help:
36+
'Used with the "--launch" flag to cold boot the emulator instance '
37+
'(Android and supported tool extensions).',
2838
negatable: false,
2939
);
3040
argParser.addFlag(
31-
'create',
32-
help: 'Creates a new Android emulator based on a Pixel device.',
41+
_createFlag,
42+
help: 'Creates a new emulator (for example, an Android AVD or a tool extension emulator).',
3343
negatable: false,
3444
);
3545
argParser.addOption(
36-
'name',
46+
_nameOption,
3747
help: 'Used with the "--create" flag. Specifies a name for the emulator being created.',
3848
);
49+
argParser.addOption(
50+
_platformOption,
51+
help:
52+
'Used with the "--create" flag. Specifies the target platform for the emulator being '
53+
'created (for example, "android" or a tool extension platform identifier).',
54+
);
3955
}
4056

4157
final Doctor _doctor;
@@ -56,20 +72,25 @@ class EmulatorsCommand extends FlutterCommand {
5672
@override
5773
Future<FlutterCommandResult> runCommand() async {
5874
final Platform platform = toolContext.platform;
75+
final ArgResults argumentResults = argResults!;
76+
77+
if (argumentResults.wasParsed(_platformOption) && !argumentResults.wasParsed(_createFlag)) {
78+
throwToolExit('The "--$_platformOption" option can only be used with "--$_createFlag".');
79+
}
5980

60-
if (_doctor.workflows.every((Workflow w) => !w.canListEmulators)) {
81+
if (_doctor.workflows.every((Workflow w) => !w.canListEmulators) &&
82+
!await _emulatorManager.hasExtensionEmulatorSources()) {
6183
throwToolExit(
6284
'Unable to find any emulator sources. Please ensure you have some\n'
6385
'Android AVD images ${platform.isMacOS ? 'or an iOS Simulator ' : ''}available.',
6486
exitCode: 1,
6587
);
6688
}
67-
final ArgResults argumentResults = argResults!;
68-
if (argumentResults.wasParsed('launch')) {
69-
final bool coldBoot = argumentResults.wasParsed('cold');
70-
await _launchEmulator(stringArg('launch')!, coldBoot: coldBoot);
71-
} else if (argumentResults.wasParsed('create')) {
72-
await _createEmulator(name: stringArg('name'));
89+
if (argumentResults.wasParsed(_launchOption)) {
90+
final bool coldBoot = argumentResults.wasParsed(_coldFlag);
91+
await _launchEmulator(stringArg(_launchOption)!, coldBoot: coldBoot);
92+
} else if (argumentResults.wasParsed(_createFlag)) {
93+
await _createEmulator(name: stringArg(_nameOption), platform: stringArg(_platformOption));
7394
} else {
7495
final String? searchText = argumentResults.rest.firstOrNull;
7596
await _listEmulators(searchText);
@@ -91,20 +112,92 @@ class EmulatorsCommand extends FlutterCommand {
91112
}
92113
}
93114

94-
Future<void> _createEmulator({String? name}) async {
95-
final Logger logger = toolContext.logger;
96-
final CreateEmulatorResult createResult = await _emulatorManager.createEmulator(name: name);
115+
Future<void> _createEmulator({String? name, String? platform}) async {
116+
final ToolContext(:Logger logger, :AnsiTerminal terminal) = toolContext;
117+
final String? resolvedPlatform;
118+
if (platform != null) {
119+
if (platform.isEmpty) {
120+
throwToolExit('The "--$_platformOption" option must not be empty.');
121+
}
122+
if (platform != EmulatorManager.androidPlatform) {
123+
final List<String> availablePlatforms = await _emulatorManager
124+
.getAvailableCreatePlatforms();
125+
if (!availablePlatforms.contains(platform)) {
126+
throwToolExit(
127+
availablePlatforms.isEmpty
128+
? 'Unknown emulator creation platform "$platform". '
129+
'No emulator creation platforms are available.'
130+
: 'Unknown emulator creation platform "$platform". '
131+
'Available platforms: ${availablePlatforms.join(', ')}.',
132+
);
133+
}
134+
}
135+
resolvedPlatform = platform;
136+
} else {
137+
final List<String> availablePlatforms = await _emulatorManager.getAvailableCreatePlatforms();
138+
if (availablePlatforms.length == 1) {
139+
resolvedPlatform = availablePlatforms.single;
140+
} else if (availablePlatforms.length > 1) {
141+
if (!terminal.stdinHasTerminal) {
142+
throwToolExit(
143+
'Multiple emulator creation platforms are available '
144+
'(${availablePlatforms.join(', ')}). '
145+
'Specify one using "--$_platformOption <platform>".',
146+
);
147+
}
148+
resolvedPlatform = await _promptForPlatform(
149+
availablePlatforms,
150+
logger: logger,
151+
terminal: terminal,
152+
);
153+
} else {
154+
resolvedPlatform = null;
155+
}
156+
}
157+
158+
final CreateEmulatorResult createResult = await _emulatorManager.createEmulator(
159+
name: name,
160+
platform: resolvedPlatform,
161+
);
97162

98163
if (createResult.success) {
99164
logger.printStatus("Emulator '${createResult.emulatorName}' created successfully.");
100165
} else {
101-
logger.printStatus("Failed to create emulator '${createResult.emulatorName}'.\n");
166+
if (createResult.emulatorName.isEmpty) {
167+
logger.printStatus('Failed to create emulator.\n');
168+
} else {
169+
logger.printStatus("Failed to create emulator '${createResult.emulatorName}'.\n");
170+
}
102171
final String? error = createResult.error;
103-
if (error != null) {
172+
if (error != null && error.trim().isNotEmpty) {
104173
logger.printStatus(error.trim());
105174
}
106-
_printAdditionalInfo();
175+
if (resolvedPlatform == null || resolvedPlatform == EmulatorManager.androidPlatform) {
176+
_printAdditionalInfo();
177+
}
178+
}
179+
}
180+
181+
Future<String> _promptForPlatform(
182+
List<String> platforms, {
183+
required Logger logger,
184+
required AnsiTerminal terminal,
185+
}) async {
186+
logger.printStatus('Multiple emulator creation platforms are available:');
187+
for (final (int index, String platform) in platforms.indexed) {
188+
logger.printStatus('[${index + 1}]: $platform');
189+
}
190+
final String choice = await promptForNumberedChoice(
191+
logger: logger,
192+
optionCount: platforms.length,
193+
terminal: terminal,
194+
);
195+
if (choice.toLowerCase() == 'q') {
196+
throwToolExit('');
107197
}
198+
final String selected = platforms[int.parse(choice) - 1];
199+
logger.printStatus('To skip this prompt in the future, pass "--$_platformOption $selected".');
200+
return selected;
108201
}
109202

110203
Future<void> _listEmulators(String? searchText) async {

0 commit comments

Comments
 (0)