Skip to content

Commit 48f9dbd

Browse files
committed
[flutter_tools] Polish screenshot Skia integration test
Update `screenshot_test.dart` to write its synthetic package configuration via `writePackageConfigFiles`, resolve local engine paths via `LocalEngineLocator` and `getLocalEngineArguments()` with a normalized absolute `flutterBin` path, and register `flutter_tester` teardown immediately after process startup with early-exit reporting. Previous output: ``` _flutter.screenshotSkp: (-32000) Cannot capture SKP screenshot with Impeller enabled. #0 new _OutstandingRequest (package:vm_service/src/vm_service.dart:280:34) #1 VmService._call.<anonymous closure> (package:vm_service/src/vm_service.dart:1962:25) #2 VmService._call (package:vm_service/src/vm_service.dart:1974:8) #3 VmService.callServiceExtension (package:vm_service/src/vm_service.dart:1905:14) #4 FlutterVmService._checkedCallServiceExtension (package:flutter_tools/src/vmservice.dart:835:28) #5 FlutterVmService.screenshotSkp (package:flutter_tools/src/vmservice.dart:1069:12) #6 ScreenshotCommand.runSkia (package:flutter_tools/src/commands/screenshot.dart:167:54) <asynchronous suspension> flutter#7 ScreenshotCommand.runCommand (package:flutter_tools/src/commands/screenshot.dart:123:19) <asynchronous suspension> flutter#8 FlutterCommand.run.<anonymous closure> (package:flutter_tools/src/runner/flutter_command.dart:876:27) <asynchronous suspension> flutter#9 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#10 CommandRunner.runCommand (package:args/command_runner.dart:212:13) <asynchronous suspension> flutter#11 FlutterCommandRunner.runCommand.<anonymous closure> (package:flutter_tools/src/runner/flutter_command_runner.dart:689:9) <asynchronous suspension> flutter#12 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#13 FlutterCommandRunner.runCommand (package:flutter_tools/src/runner/flutter_command_runner.dart:619:5) <asynchronous suspension> flutter#14 FlutterCommandRunner.run (package:flutter_tools/src/runner/flutter_command_runner.dart:379:5) <asynchronous suspension> flutter#15 run.<anonymous closure>.<anonymous closure>.<anonymous closure>.<anonymous closure> (package:flutter_tools/runner.dart:419:19) <asynchronous suspension> flutter#16 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#17 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#18 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#19 main (package:flutter_tools/executable.dart:133:3) <asynchronous suspension> Feature flags enabled: enable-web, enable-linux-desktop, enable-macos-desktop, enable-windows-desktop, enable-android, enable-ios, cli-animations, enable-native-assets, enable-record-use, enable-swift-package-manager, omit-legacy-version-file, enable-lldb-debugging, enable-uiscene-migration, enable-riscv64, enable-hcpp ``` Current output: ``` The Skia picture request failed: Cannot capture SKP screenshot with Impeller enabled. ``` Fixes flutter#196119
1 parent 9001e6c commit 48f9dbd

1 file changed

Lines changed: 102 additions & 65 deletions

File tree

‎packages/flutter_tools/test/integration.shard/screenshot_test.dart‎

Lines changed: 102 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ import 'package:file/file.dart';
99
import 'package:flutter_tools/src/artifacts.dart';
1010
import 'package:flutter_tools/src/base/io.dart';
1111
import 'package:flutter_tools/src/base/logger.dart';
12-
import 'package:flutter_tools/src/base/os.dart';
12+
import 'package:flutter_tools/src/base/user_messages.dart';
1313
import 'package:flutter_tools/src/cache.dart';
14+
import 'package:flutter_tools/src/runner/local_engine.dart';
1415

1516
import '../src/common.dart';
17+
import '../src/fakes.dart';
18+
import '../src/package_config.dart';
1619
import 'test_utils.dart';
1720

1821
const _frameRenderedMarker = 'APP_FRAME_RENDERED';
22+
const _minimalAppName = 'screenshot_test_app';
1923
const _startupTimeout = Duration(seconds: 60);
2024

2125
const _minimalAppSource =
@@ -48,22 +52,18 @@ void main() {
4852

4953
void main() {
5054
late String flutterRoot;
55+
late String absoluteFlutterBin;
5156
late Artifacts artifacts;
5257
late Directory sharedCompileDir;
5358
late File compiledDill;
54-
late File emptyPackageConfig;
59+
late File appPackageConfig;
5560
late Directory tempDir;
5661

5762
setUpAll(() async {
5863
Cache.disableLocking();
59-
flutterRoot = getFlutterRoot();
64+
flutterRoot = fileSystem.path.normalize(fileSystem.path.absolute(getFlutterRoot()));
65+
absoluteFlutterBin = fileSystem.path.normalize(fileSystem.path.absolute(flutterBin));
6066
final logger = BufferLogger.test();
61-
final osUtils = OperatingSystemUtils(
62-
fileSystem: fileSystem,
63-
logger: logger,
64-
platform: platform,
65-
processManager: processManager,
66-
);
6767
final cache = Cache.test(
6868
fileSystem: fileSystem,
6969
flutterRoot: flutterRoot,
@@ -72,28 +72,53 @@ void main() {
7272
processManager: processManager,
7373
rootOverride: fileSystem.directory(flutterRoot),
7474
);
75-
artifacts = CachedArtifacts(
76-
cache: cache,
75+
final localEngineLocator = LocalEngineLocator(
7776
fileSystem: fileSystem,
78-
operatingSystemUtils: osUtils,
77+
flutterRoot: flutterRoot,
78+
logger: logger,
7979
platform: platform,
80+
userMessages: UserMessages(),
8081
);
82+
final EngineBuildPaths? engineBuildPaths = await localEngineLocator.findEnginePath(
83+
engineSourcePath: platform.environment[kLocalEngineLocation],
84+
localEngine: platform.environment[kLocalEngineEnvironment],
85+
localHostEngine: platform.environment[kLocalEngineHostEnvironment],
86+
);
87+
artifacts = switch (engineBuildPaths) {
88+
final EngineBuildPaths paths => Artifacts.getLocalEngine(
89+
paths,
90+
toolContext: FakeToolContext(
91+
cache: cache,
92+
fs: fileSystem,
93+
logger: logger,
94+
os: cache.osUtils,
95+
platform: platform,
96+
processManager: processManager,
97+
),
98+
),
99+
null => CachedArtifacts(
100+
cache: cache,
101+
fileSystem: fileSystem,
102+
operatingSystemUtils: cache.osUtils,
103+
platform: platform,
104+
),
105+
};
81106

82107
sharedCompileDir = createResolvedTempDirectorySync('screenshot_compile.');
83108
final File appSource = sharedCompileDir.childFile('main.dart')
84109
..writeAsStringSync(_minimalAppSource);
85-
emptyPackageConfig =
86-
sharedCompileDir.childDirectory('.dart_tool').childFile('package_config.json')
87-
..createSync(recursive: true)
88-
..writeAsStringSync('{"configVersion":2,"packages":[]}');
110+
appPackageConfig = writePackageConfigFiles(
111+
directory: sharedCompileDir,
112+
mainLibName: _minimalAppName,
113+
);
89114
compiledDill = sharedCompileDir.childFile('app.dill');
90115

91116
final ProcessResult compileResult = await processManager.run(<String>[
92117
artifacts.getArtifactPath(.engineDartAotRuntime),
93118
artifacts.getArtifactPath(.frontendServerSnapshotForEngineDartSdk),
94119
'--sdk-root=${artifacts.getArtifactPath(.flutterPatchedSdkPath)}/',
95120
'--target=flutter',
96-
'--packages=${emptyPackageConfig.path}',
121+
'--packages=${appPackageConfig.path}',
97122
'--output-dill=${compiledDill.path}',
98123
appSource.path,
99124
]);
@@ -127,72 +152,84 @@ void main() {
127152
'--vm-service-port=0',
128153
'--icu-data-file-path=${artifacts.getArtifactPath(.icuData)}',
129154
if (enableImpeller) '--enable-impeller' else '--enable-software-rendering',
130-
'--packages=${emptyPackageConfig.path}',
155+
'--packages=${appPackageConfig.path}',
131156
testDill.path,
132157
]);
158+
StreamSubscription<String>? stdoutSub;
159+
StreamSubscription<String>? stderrSub;
160+
addTearDown(() async {
161+
tester.kill();
162+
await tester.exitCode;
163+
await stdoutSub?.cancel();
164+
await stderrSub?.cancel();
165+
});
133166

134-
final uriCompleter = Completer<Uri>();
135-
final frameCompleter = Completer<void>();
167+
final startupCompleter = Completer<Uri>();
168+
final stderrDone = Completer<void>();
136169
final stderrBuffer = StringBuffer();
137170
final vmServicePattern = RegExp(r'The Dart VM service is listening on (http://[^\s]+)');
171+
Uri? discoveredUri;
172+
var frameRendered = false;
173+
var startupFinished = false;
138174

139-
final StreamSubscription<String> stdoutSub = tester.stdout
140-
.transform(utf8.decoder)
141-
.transform(const LineSplitter())
142-
.listen((String line) {
143-
final RegExpMatch? match = vmServicePattern.firstMatch(line);
144-
if (match != null && !uriCompleter.isCompleted) {
145-
uriCompleter.complete(Uri.parse(match.group(1)!));
146-
}
147-
if (line.contains(_frameRenderedMarker) && !frameCompleter.isCompleted) {
148-
frameCompleter.complete();
149-
}
150-
});
151-
final StreamSubscription<String> stderrSub = tester.stderr
152-
.transform(utf8.decoder)
153-
.transform(const LineSplitter())
154-
.listen(stderrBuffer.writeln);
175+
void checkReady() {
176+
if (discoveredUri != null && frameRendered && !startupCompleter.isCompleted) {
177+
startupCompleter.complete(discoveredUri);
178+
}
179+
}
155180

156-
addTearDown(() async {
157-
tester.kill();
158-
await tester.exitCode;
159-
await stdoutSub.cancel();
160-
await stderrSub.cancel();
181+
stdoutSub = tester.stdout.transform(utf8.decoder).transform(const LineSplitter()).listen((
182+
String line,
183+
) {
184+
if (discoveredUri == null) {
185+
if (vmServicePattern.firstMatch(line) case final RegExpMatch match) {
186+
discoveredUri = Uri.parse(match.group(1)!);
187+
checkReady();
188+
}
189+
}
190+
if (!frameRendered && line.contains(_frameRenderedMarker)) {
191+
frameRendered = true;
192+
checkReady();
193+
}
161194
});
195+
stderrSub = tester.stderr
196+
.transform(utf8.decoder)
197+
.transform(const LineSplitter())
198+
.listen(
199+
stderrBuffer.writeln,
200+
onDone: () {
201+
if (!stderrDone.isCompleted) {
202+
stderrDone.complete();
203+
}
204+
},
205+
);
206+
unawaited(
207+
tester.exitCode.then((int exitCode) async {
208+
await stderrDone.future;
209+
if (!startupFinished && !startupCompleter.isCompleted) {
210+
startupCompleter.completeError(
211+
StateError(
212+
'flutter_tester exited unexpectedly with code $exitCode. Stderr:\n$stderrBuffer',
213+
),
214+
);
215+
}
216+
}),
217+
);
162218

163219
try {
164-
final Uri vmServiceUri = await uriCompleter.future.timeout(_startupTimeout);
165-
await frameCompleter.future.timeout(_startupTimeout);
166-
return vmServiceUri;
220+
return await startupCompleter.future.timeout(_startupTimeout);
167221
} on TimeoutException {
168222
fail('Timed out waiting for flutter_tester startup. Stderr:\n$stderrBuffer');
223+
} finally {
224+
startupFinished = true;
169225
}
170226
}
171227

172228
Future<ProcessResult> runScreenshotSkia({required File outputFile, required Uri vmServiceUri}) {
173-
final String toolPackageConfig = fileSystem.path.join(
174-
flutterRoot,
175-
'packages',
176-
'flutter_tools',
177-
'.dart_tool',
178-
'package_config.json',
179-
);
180-
final String packageConfigPath = fileSystem.file(toolPackageConfig).existsSync()
181-
? toolPackageConfig
182-
: fileSystem.path.join(flutterRoot, '.dart_tool', 'package_config.json');
183-
final String entryScript = fileSystem.path.join(
184-
flutterRoot,
185-
'packages',
186-
'flutter_tools',
187-
'bin',
188-
'flutter_tools.dart',
189-
);
190-
191229
return processManager.run(
192230
<String>[
193-
artifacts.getArtifactPath(.engineDartBinary),
194-
'--packages=$packageConfigPath',
195-
entryScript,
231+
absoluteFlutterBin,
232+
...getLocalEngineArguments(),
196233
'--suppress-analytics',
197234
'--no-version-check',
198235
'screenshot',

0 commit comments

Comments
 (0)