flutter/shorebird
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix(shorebird_cli): probe verbose help so hidden --shorebird-trace is detected (#3848)

Browse Source
This commit is contained in:
Eric Seidel
2026-07-10 15:58:12 -07:00
committed by GitHub
parent b0149caf5b
commit d6647dbf65
2 changed files with 81 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/shorebird_cli/lib/src/artifact_builder/artifact_builder.dart
+8 -1
View File
@@ -125,13 +125,20 @@ ${link(uri: Uri.parse('https://github.com/shorebirdtech/shorebird/issues/new'))}
/// Probes the command's help output and caches the result per [command]
/// so that subsequent calls for the same command are free.
/// Returns `false` if the help check fails for any reason.
///
/// The probe uses verbose help (`-h -v`): `--shorebird-trace` is registered
/// with `hide: !verboseHelp` in Flutter, so it does not appear in plain
/// `-h` output. Probing with `-h` alone therefore returned `false` even on
/// Flutter versions that fully support the flag, silently disabling build
/// tracing for everyone. `-h -v` lists hidden options so support is
/// detected correctly.
Future<bool> _supportsTraceFlag(String command) async {
if (_traceSupport.containsKey(command)) return _traceSupport[command]!;
try {
final result = await process.run(
'flutter',
['build', command, '-h'],
['build', command, '-h', '-v'],
runInShell: false,
);
final supported = result.stdout.toString().contains('--shorebird-trace');
packages/shorebird_cli/test/src/artifact_builder/artifact_builder_test.dart
+73 -7
View File
@@ -347,12 +347,78 @@ Either run `flutter pub get` manually, or follow the steps in ${cannotRunInVSCod
verify(
() => shorebirdProcess.run(
'flutter',
['build', 'appbundle', '-h'],
['build', 'appbundle', '-h', '-v'],
runInShell: false,
),
).called(1);
});
test(
'detects --shorebird-trace even though it is hidden from -h',
() async {
when(
() => shorebirdFlutter.resolveFlutterVersion(any()),
).thenAnswer((_) async => Version(3, 41, 7));
// Flutter registers --shorebird-trace with `hide: !verboseHelp`, so it
// only appears in verbose help. Model that: plain `-h` omits the flag,
// `-h -v` includes it. Probing without `-v` (the original bug) would
// miss it and silently disable tracing on every supported build.
when(
() => shorebirdProcess.run(
'flutter',
['build', 'appbundle', '-h'],
runInShell: false,
),
).thenAnswer(
(_) async => ShorebirdProcessResult(
exitCode: ExitCode.success.code,
stdout: '--release',
stderr: '',
),
);
when(
() => shorebirdProcess.run(
'flutter',
['build', 'appbundle', '-h', '-v'],
runInShell: false,
),
).thenAnswer(
(_) async => ShorebirdProcessResult(
exitCode: ExitCode.success.code,
stdout: '--release\n--shorebird-trace',
stderr: '',
),
);
await runWithOverrides(() async {
await builder.prepareBuildTrace(platform: 'android');
await builder.buildAppBundle();
});
final expectedTracePath = p.join(
projectRoot.path,
'build',
'shorebird',
'debug',
'build-trace-android.json',
);
verify(
() => shorebirdProcess.stream(
'flutter',
[
'build',
'appbundle',
'--release',
'--shorebird-trace=$expectedTracePath',
],
environment: any(named: 'environment'),
runInShell: false,
onStart: any(named: 'onStart'),
),
).called(1);
},
);
test('skips trace when help probe throws', () async {
when(
() => shorebirdFlutter.resolveFlutterVersion(any()),
@@ -360,7 +426,7 @@ Either run `flutter pub get` manually, or follow the steps in ${cannotRunInVSCod
when(
() => shorebirdProcess.run(
'flutter',
['build', 'appbundle', '-h'],
['build', 'appbundle', '-h', '-v'],
runInShell: false,
),
).thenThrow(Exception('process failed'));
@@ -921,7 +987,7 @@ Either run `flutter pub get` manually, or follow the steps in ${cannotRunInVSCod
when(
() => shorebirdProcess.run(
'flutter',
['build', 'aar', '-h'],
['build', 'aar', '-h', '-v'],
runInShell: false,
),
).thenAnswer(
@@ -1123,7 +1189,7 @@ Either run `flutter pub get` manually, or follow the steps in ${cannotRunInVSCod
when(
() => shorebirdProcess.run(
'flutter',
['build', 'linux', '-h'],
['build', 'linux', '-h', '-v'],
runInShell: false,
),
).thenAnswer(
@@ -1300,7 +1366,7 @@ Reason: Exited with code 70.'''),
when(
() => shorebirdProcess.run(
'flutter',
['build', 'macos', '-h'],
['build', 'macos', '-h', '-v'],
runInShell: false,
),
).thenAnswer(
@@ -1789,7 +1855,7 @@ Reason: Exited with code 70.'''),
when(
() => shorebirdProcess.run(
'flutter',
['build', 'ios-framework', '-h'],
['build', 'ios-framework', '-h', '-v'],
runInShell: false,
),
).thenAnswer(
@@ -2081,7 +2147,7 @@ Reason: Exited with code 70.'''),
when(
() => shorebirdProcess.run(
'flutter',
['build', 'windows', '-h'],
['build', 'windows', '-h', '-v'],
runInShell: false,
),
).thenAnswer(