Skip to content

Commit 4d5e75f

Browse files
temoorxbkonyi
andauthored
[flutter_tools] Fix flutter drive --chrome-binary being ignored on web (#185481)
## Description Fixes a mismatch in the internal web platform args used by `flutter drive`. For web runs, `DriveCommand` was passing `--no-launch-chrome`, but `ChromiumDevice.startApp` checks for `no-launch-chrome`. Because of that, Flutter still launched its default Chrome instance instead of leaving browser startup to WebDriver, which made `--chrome-binary` ineffective. This change updates the platform arg key to match what the web device expects and adds a regression test covering the web `flutter drive` path. Fixes #171504 ## Tests - `FLUTTER_ROOT=/Users/temoor/Documents/Codex/2026-04-23-so-i-wanna-be-contributor-on/flutter ../../bin/cache/dart-sdk/bin/dart test test/commands.shard/hermetic/drive_test.dart -r expanded` - `FLUTTER_ROOT=/Users/temoor/Documents/Codex/2026-04-23-so-i-wanna-be-contributor-on/flutter ../../bin/cache/dart-sdk/bin/dart test test/general.shard/drive/web_driver_service_test.dart -r expanded` --------- Co-authored-by: Ben Konyi <[email protected]>
1 parent 5cc01fe commit 4d5e75f

8 files changed

Lines changed: 223 additions & 24 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ class DriveCommand extends RunCommandBase {
352352
mainPath: targetFile,
353353
platformArgs: <String, Object>{
354354
if (traceStartup) 'trace-startup': traceStartup,
355-
if (web) '--no-launch-chrome': true,
355+
if (web) 'no-launch-chrome': true,
356356
},
357357
);
358358
} else {

‎packages/flutter_tools/lib/src/drive/web_driver_service.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ class WebDriverService extends DriverService {
9696
webRenderer: debuggingOptions.webRenderer,
9797
webUseWasm: debuggingOptions.webUseWasm,
9898
),
99+
platformArgs: platformArgs,
99100
stayResident: true,
100101
flutterProject: FlutterProject.current(),
101102
fileSystem: globals.fs,

‎packages/flutter_tools/lib/src/isolated/resident_web_runner.dart‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ class DwdsWebRunnerFactory extends WebRunnerFactory {
5454
required bool stayResident,
5555
required FlutterProject flutterProject,
5656
required DebuggingOptions debuggingOptions,
57+
Map<String, Object?> platformArgs = const <String, Object?>{},
5758
UrlTunneller? urlTunneller,
5859
required Logger logger,
5960
required Terminal terminal,
@@ -70,6 +71,7 @@ class DwdsWebRunnerFactory extends WebRunnerFactory {
7071
target: target,
7172
flutterProject: flutterProject,
7273
debuggingOptions: debuggingOptions,
74+
platformArgs: platformArgs,
7375
stayResident: stayResident,
7476
urlTunneller: urlTunneller,
7577
machine: machine,
@@ -101,6 +103,7 @@ class ResidentWebRunner extends ResidentRunner {
101103
super.projectRootPath,
102104
required this.flutterProject,
103105
required super.debuggingOptions,
106+
this.platformArgs = const <String, Object?>{},
104107
required FileSystem fileSystem,
105108
required Logger logger,
106109
required Terminal terminal,
@@ -136,6 +139,7 @@ class ResidentWebRunner extends ResidentRunner {
136139
final Analytics _analytics;
137140
final UrlTunneller? _urlTunneller;
138141
final Map<String, String> _webDefines;
142+
final Map<String, Object?> platformArgs;
139143

140144
@override
141145
Logger get logger => _logger;
@@ -365,7 +369,7 @@ class ResidentWebRunner extends ResidentRunner {
365369
package,
366370
mainPath: target,
367371
debuggingOptions: debuggingOptions,
368-
platformArgs: <String, Object>{'uri': url.toString()},
372+
platformArgs: <String, Object?>{...platformArgs, 'uri': url.toString()},
369373
);
370374
return attach(
371375
connectionInfoCompleter: connectionInfoCompleter,

‎packages/flutter_tools/lib/src/web/web_runner.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ abstract class WebRunnerFactory {
2828
required bool stayResident,
2929
required FlutterProject flutterProject,
3030
required DebuggingOptions debuggingOptions,
31+
Map<String, Object?> platformArgs = const <String, Object?>{},
3132
UrlTunneller? urlTunneller,
3233
required Logger logger,
3334
required Terminal terminal,

‎packages/flutter_tools/test/commands.shard/hermetic/drive_test.dart‎

Lines changed: 151 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import 'package:flutter_tools/src/device.dart';
2424
import 'package:flutter_tools/src/drive/drive_service.dart';
2525
import 'package:flutter_tools/src/ios/devices.dart';
2626
import 'package:flutter_tools/src/project.dart';
27+
import 'package:flutter_tools/src/web/web_device.dart';
2728
import 'package:package_config/package_config.dart';
2829
import 'package:test/fake.dart';
2930

@@ -58,6 +59,47 @@ void main() {
5859
Cache.enableLocking();
5960
});
6061

62+
testUsingContext(
63+
'web drive runs without launching Chrome directly',
64+
() async {
65+
final capturingDriverService = CapturingDriverService();
66+
final command = DriveCommand(
67+
fileSystem: fileSystem,
68+
logger: logger,
69+
platform: platform,
70+
terminal: terminal,
71+
outputPreferences: outputPreferences,
72+
signals: signals,
73+
flutterDriverFactory: CapturingFlutterDriverFactory(capturingDriverService),
74+
);
75+
76+
fileSystem.file('lib/main.dart').createSync(recursive: true);
77+
fileSystem.file('test_driver/main_test.dart').createSync(recursive: true);
78+
fileSystem.file('pubspec.yaml').createSync();
79+
fileSystem.file('web/index.html').createSync(recursive: true);
80+
81+
fakeDeviceManager.attachedDevices = <Device>[FakeChromiumDriveDevice()];
82+
83+
await createTestCommandRunner(command).run(<String>[
84+
'drive',
85+
'--no-pub',
86+
'-d',
87+
'chrome',
88+
'--browser-name=chrome',
89+
'--chrome-binary=/tmp/custom-chrome',
90+
]);
91+
92+
expect(capturingDriverService.platformArgs, containsPair('no-launch-chrome', true));
93+
expect(capturingDriverService.platformArgs, isNot(contains('--no-launch-chrome')));
94+
},
95+
overrides: <Type, Generator>{
96+
FileSystem: () => fileSystem,
97+
ProcessManager: () => FakeProcessManager.any(),
98+
Pub: () => FakePub(),
99+
DeviceManager: () => fakeDeviceManager,
100+
},
101+
);
102+
61103
testUsingContext(
62104
'fails if the specified --target is not found',
63105
() async {
@@ -836,27 +878,23 @@ void main() {
836878
},
837879
);
838880

839-
testUsingContext(
840-
'flutter drive --help explains how to use the command',
841-
() async {
842-
final command = DriveCommand(
843-
fileSystem: fileSystem,
844-
logger: logger,
845-
platform: platform,
846-
terminal: terminal,
847-
outputPreferences: outputPreferences,
848-
signals: signals,
849-
);
850-
851-
await createTestCommandRunner(command).run(<String>['drive', '--help']);
852-
853-
expect(
854-
logger.statusText,
855-
stringContainsInOrder(<String>['flutter drive', '--target', '--driver']),
856-
);
857-
},
858-
overrides: <Type, Generator>{Logger: () => logger},
859-
);
881+
testUsingContext('flutter drive --help explains how to use the command', () async {
882+
final command = DriveCommand(
883+
fileSystem: fileSystem,
884+
logger: logger,
885+
platform: platform,
886+
terminal: terminal,
887+
outputPreferences: outputPreferences,
888+
signals: signals,
889+
);
890+
891+
await createTestCommandRunner(command).run(<String>['drive', '--help']);
892+
893+
expect(
894+
logger.statusText,
895+
stringContainsInOrder(<String>['flutter drive', '--target', '--driver']),
896+
);
897+
}, overrides: <Type, Generator>{Logger: () => logger});
860898
}
861899

862900
class ThrowingScreenshotDevice extends ScreenshotDevice {
@@ -955,6 +993,15 @@ class FakeFlutterDriverFactory extends Fake implements FlutterDriverFactory {
955993
}
956994
}
957995

996+
class CapturingFlutterDriverFactory extends Fake implements FlutterDriverFactory {
997+
CapturingFlutterDriverFactory(this.driverService);
998+
999+
final CapturingDriverService driverService;
1000+
1001+
@override
1002+
DriverService createDriverService(bool web) => driverService;
1003+
}
1004+
9581005
/// A [DriverService] that will return a Future from [startTest] that will never complete.
9591006
///
9601007
/// This is to simulate when the test will take a long time, but a signal is
@@ -996,6 +1043,49 @@ class FakeDriverService extends Fake implements DriverService {
9961043
}
9971044
}
9981045

1046+
class CapturingDriverService extends Fake implements DriverService {
1047+
Map<String, Object>? platformArgs;
1048+
1049+
@override
1050+
Future<void> start(
1051+
BuildInfo buildInfo,
1052+
Device device,
1053+
DebuggingOptions debuggingOptions, {
1054+
File? applicationBinary,
1055+
String? route,
1056+
String? userIdentifier,
1057+
String? mainPath,
1058+
Map<String, Object> platformArgs = const <String, Object>{},
1059+
}) async {
1060+
this.platformArgs = platformArgs;
1061+
}
1062+
1063+
@override
1064+
Future<void> reuseApplication(
1065+
Uri vmServiceUri,
1066+
Device device,
1067+
DebuggingOptions debuggingOptions,
1068+
) async {}
1069+
1070+
@override
1071+
Future<int> startTest(
1072+
String testFile,
1073+
List<String> arguments,
1074+
PackageConfig packageConfig, {
1075+
bool? headless,
1076+
String? chromeBinary,
1077+
String? browserName,
1078+
bool? androidEmulator,
1079+
int? driverPort,
1080+
List<String>? webBrowserFlags,
1081+
List<String>? browserDimension,
1082+
String? profileMemory,
1083+
}) async => 0;
1084+
1085+
@override
1086+
Future<void> stop({String? userIdentifier}) async {}
1087+
}
1088+
9991089
class FailingFakeFlutterDriverFactory extends Fake implements FlutterDriverFactory {
10001090
@override
10011091
DriverService createDriverService(bool web) => FailingFakeDriverService();
@@ -1043,6 +1133,46 @@ class FakeIosDevice extends Fake implements IOSDevice {
10431133
Future<TargetPlatform> get targetPlatform async => TargetPlatform.ios;
10441134
}
10451135

1136+
class FakeChromiumDriveDevice extends Fake implements ChromiumDevice {
1137+
@override
1138+
final String id = 'chrome';
1139+
1140+
@override
1141+
String get name => 'Chrome';
1142+
1143+
@override
1144+
String get displayName => name;
1145+
1146+
@override
1147+
bool get isConnected => true;
1148+
1149+
@override
1150+
bool get supportsScreenshot => false;
1151+
1152+
@override
1153+
Category get category => Category.web;
1154+
1155+
@override
1156+
PlatformType get platformType => PlatformType.web;
1157+
1158+
@override
1159+
Future<bool> get isLocalEmulator async => false;
1160+
1161+
@override
1162+
Future<String> get sdkNameAndVersion async => 'Google Chrome 0.0';
1163+
1164+
@override
1165+
Future<TargetPlatform> get targetPlatform async => TargetPlatform.web_javascript;
1166+
1167+
@override
1168+
DeviceLogReader getLogReader({ApplicationPackage? app, bool includePastLogs = false}) {
1169+
return NoOpDeviceLogReader(app?.name);
1170+
}
1171+
1172+
@override
1173+
bool supportsRuntimeMode(BuildMode buildMode) => true;
1174+
}
1175+
10461176
class FakeSignals extends Fake implements Signals {
10471177
List<SignalHandler> addedHandlers = <SignalHandler>[];
10481178

‎packages/flutter_tools/test/commands.shard/hermetic/run_test.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2249,6 +2249,7 @@ class FakeWebRunnerFactory extends Fake implements WebRunnerFactory {
22492249
required analytics.Analytics analytics,
22502250
required FileSystem fileSystem,
22512251
required FlutterProject flutterProject,
2252+
Map<String, Object?> platformArgs = const <String, Object?>{},
22522253
required Logger logger,
22532254
required OutputPreferences outputPreferences,
22542255
required Platform platform,

‎packages/flutter_tools/test/general.shard/drive/web_driver_service_test.dart‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ const kChromeArgs = <String>[
3838
];
3939

4040
void main() {
41+
late FakeWebRunnerFactory fakeWebRunnerFactory;
42+
4143
testWithoutContext('getDesiredCapabilities Chrome with headless on', () {
4244
final expected = <String, dynamic>{
4345
'acceptInsecureCerts': true,
@@ -250,6 +252,25 @@ void main() {
250252
expect(FakeResidentRunner.instance.callLog, <String>['run', 'exitApp', 'cleanupAtFinish']);
251253
}, overrides: <Type, Generator>{WebRunnerFactory: () => FakeWebRunnerFactory()});
252254

255+
testUsingContext(
256+
'WebDriverService forwards platform args to the web runner',
257+
() async {
258+
final WebDriverService service = setUpDriverService();
259+
final device = FakeDevice();
260+
await service.start(
261+
BuildInfo.profile,
262+
device,
263+
DebuggingOptions.enabled(BuildInfo.profile, ipv6: true),
264+
platformArgs: <String, Object>{'no-launch-chrome': true},
265+
);
266+
await service.stop();
267+
expect(fakeWebRunnerFactory.lastPlatformArgs, <String, Object?>{'no-launch-chrome': true});
268+
},
269+
overrides: <Type, Generator>{
270+
WebRunnerFactory: () => fakeWebRunnerFactory = FakeWebRunnerFactory(),
271+
},
272+
);
273+
253274
testUsingContext('WebDriverService can start an app with a launch url provided', () async {
254275
final WebDriverService service = setUpDriverService();
255276
final device = FakeDevice();
@@ -322,6 +343,7 @@ class FakeWebRunnerFactory implements WebRunnerFactory {
322343
FakeWebRunnerFactory({this.doResolveToError = false});
323344

324345
final bool doResolveToError;
346+
Map<String, Object?>? lastPlatformArgs;
325347

326348
@override
327349
ResidentRunner createWebRunner(
@@ -331,6 +353,7 @@ class FakeWebRunnerFactory implements WebRunnerFactory {
331353
FlutterProject? flutterProject,
332354
bool? ipv6,
333355
required DebuggingOptions debuggingOptions,
356+
Map<String, Object?> platformArgs = const <String, Object?>{},
334357
UrlTunneller? urlTunneller,
335358
Logger? logger,
336359
Terminal? terminal,
@@ -343,6 +366,7 @@ class FakeWebRunnerFactory implements WebRunnerFactory {
343366
Map<String, String> webDefines = const <String, String>{},
344367
}) {
345368
expect(stayResident, isTrue);
369+
lastPlatformArgs = platformArgs;
346370
return FakeResidentRunner(
347371
doResolveToError: doResolveToError,
348372
debuggingOptions: debuggingOptions,

0 commit comments

Comments
 (0)