Skip to content

Commit 0e1f50f

Browse files
authored
[flutter_tools] Forward encoding in ErrorHandlingFile.readAsStringSync (flutter#196136)
Previously, `ErrorHandlingFile.readAsStringSync` dropped its `encoding` parameter when calling `delegate.readAsStringSync()`, forcing UTF-8 decoding even when callers requested another encoding (unlike `readAsString`, `readAsLines`, and `readAsLinesSync`, which already forwarded `encoding`). Because `flutter_tools` wraps `LocalFileSystem` in `ErrorHandlingFileSystem`, callers such as `ScreenshotCommand.ensureOutputIsNotJsonRpcError` (which passes `AsciiCodec(allowInvalid: true)` when checking small screenshot files for JSON-RPC error payloads) crashed with a `FileSystemException`. Forward `encoding` to `delegate.readAsStringSync(encoding: encoding)` and add regression tests covering `ErrorHandlingFile.readAsStringSync` backed by `LocalFileSystem` and `ScreenshotCommand.ensureOutputIsNotJsonRpcError` on `ErrorHandlingFileSystem`. Fixes flutter#196225 Previous output: ``` Screenshot written to flutter_01.skp (0kB). FileSystemException: Failed to decode data using encoding 'utf-8', path = '/tmp/repro_screenshot_skp.QPQNLT/flutter_01.skp' #0 _File._tryDecode (dart:io/file_impl.dart:704:7) #1 _File.readAsStringSync (dart:io/file_impl.dart:715:7) #2 ForwardingFile.readAsStringSync (package:file/src/forwarding/forwarding_file.dart:99:16) #3 ErrorHandlingFile.readAsStringSync.<anonymous closure> (package:flutter_tools/src/base/error_handling_io.dart:258:22) #4 _runSync (package:flutter_tools/src/base/error_handling_io.dart:1116:16) #5 ErrorHandlingFile.readAsStringSync (package:flutter_tools/src/base/error_handling_io.dart:257:12) #6 ScreenshotCommand.ensureOutputIsNotJsonRpcError (package:flutter_tools/src/commands/screenshot.dart:198:39) flutter#7 ScreenshotCommand.runSkia (package:flutter_tools/src/commands/screenshot.dart:180:5) <asynchronous suspension> flutter#8 ScreenshotCommand.runCommand (package:flutter_tools/src/commands/screenshot.dart:123:19) <asynchronous suspension> flutter#9 FlutterCommand.run.<anonymous closure> (package:flutter_tools/src/runner/flutter_command.dart:876:27) <asynchronous suspension> flutter#10 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#11 CommandRunner.runCommand (package:args/command_runner.dart:212:13) <asynchronous suspension> flutter#12 FlutterCommandRunner.runCommand.<anonymous closure> (package:flutter_tools/src/runner/flutter_command_runner.dart:689:9) <asynchronous suspension> flutter#13 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#14 FlutterCommandRunner.runCommand (package:flutter_tools/src/runner/flutter_command_runner.dart:619:5) <asynchronous suspension> flutter#15 FlutterCommandRunner.run (package:flutter_tools/src/runner/flutter_command_runner.dart:379:5) <asynchronous suspension> flutter#16 run.<anonymous closure>.<anonymous closure>.<anonymous closure>.<anonymous closure> (package:flutter_tools/runner.dart:419: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 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:174:19) <asynchronous suspension> flutter#20 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: ``` Screenshot written to flutter_01.skp (0kB). ```
1 parent 2229a60 commit 0e1f50f

3 files changed

Lines changed: 47 additions & 3 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ class ErrorHandlingFile extends ForwardingFileSystemEntity<File, io.File> with F
255255
@override
256256
String readAsStringSync({Encoding encoding = utf8}) {
257257
return _runSync<String>(
258-
() => delegate.readAsStringSync(),
258+
() => delegate.readAsStringSync(encoding: encoding),
259259
platform: _platform,
260260
failureMessage: 'Flutter failed to read a file at "${delegate.path}"',
261261
posixPermissionSuggestion: _posixPermissionSuggestion(<String>[delegate.path]),

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
// found in the LICENSE file.
44

55
import 'package:file/memory.dart';
6+
import 'package:flutter_tools/src/base/error_handling_io.dart';
67
import 'package:flutter_tools/src/base/file_system.dart';
78
import 'package:flutter_tools/src/base/io.dart';
89
import 'package:flutter_tools/src/base/logger.dart';
10+
import 'package:flutter_tools/src/base/platform.dart';
911
import 'package:flutter_tools/src/build_info.dart';
1012
import 'package:flutter_tools/src/cache.dart';
1113
import 'package:flutter_tools/src/commands/screenshot.dart';
@@ -161,6 +163,20 @@ void main() {
161163
),
162164
);
163165
});
166+
167+
testWithoutContext(
168+
'succeeds for binary non-UTF-8 file under 1000 bytes on ErrorHandlingFileSystem',
169+
() {
170+
final fs = ErrorHandlingFileSystem(
171+
delegate: MemoryFileSystem.test(),
172+
platform: FakePlatform(),
173+
);
174+
final File outputFile = fs.file('flutter_01.skp')
175+
..writeAsBytesSync(const <int>[0x89, 0x50, 0x4E, 0x47, 0xFF, 0xFE, 0xFD]);
176+
177+
expect(() => ScreenshotCommand.ensureOutputIsNotJsonRpcError(outputFile), returnsNormally);
178+
},
179+
);
164180
});
165181

166182
group('Screenshot for devices unsupported for project', () {

‎packages/flutter_tools/test/general.shard/base/error_handling_io_test.dart‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
import 'dart:io' as io; // flutter_ignore: dart_io_import;
66

7-
import 'package:file/file.dart';
87
import 'package:file/memory.dart';
98
import 'package:file_testing/file_testing.dart';
109
import 'package:flutter_tools/src/base/common.dart';
1110
import 'package:flutter_tools/src/base/error_handling_io.dart';
1211
import 'package:flutter_tools/src/base/file_system.dart';
1312
import 'package:flutter_tools/src/base/io.dart';
1413
import 'package:flutter_tools/src/base/platform.dart';
14+
import 'package:flutter_tools/src/convert.dart';
1515
import 'package:process/process.dart';
1616
import 'package:test/fake.dart';
1717
import 'package:unified_analytics/unified_analytics.dart';
1818

1919
import '../../src/common.dart';
20-
import '../../src/fake_process_manager.dart';
20+
import '../../src/context.dart';
2121

2222
final _FakeAnalytics fakeAnalytics = _FakeAnalytics();
2323

@@ -2169,6 +2169,34 @@ Please ensure that the SDK and/or project is installed in a location that has re
21692169
expect(fileSystem.typeSync(file.path, followLinks: false), FileSystemEntityType.notFound);
21702170
});
21712171
});
2172+
2173+
group('readAsStringSync', () {
2174+
const invalidUtf8Bytes = <int>[0xFF, 0xFE, 0x41];
2175+
2176+
for (final (String encodingName, Encoding encoding, String expected)
2177+
in <(String, Encoding, String)>[
2178+
('AsciiCodec(allowInvalid: true)', const AsciiCodec(allowInvalid: true), '\uFFFD\uFFFDA'),
2179+
('latin1', latin1, '\u00FF\u00FEA'),
2180+
]) {
2181+
testWithoutContext('forwards $encodingName to LocalFileSystem delegate', () {
2182+
final localFileSystem = LocalFileSystem.test(signals: FakeSignals());
2183+
addTearDown(localFileSystem.dispose);
2184+
final Directory tempDir = localFileSystem.systemTempDirectory.createTempSync(
2185+
'flutter_tools_read_as_string_sync_test.',
2186+
);
2187+
addTearDown(() => tryToDelete(tempDir));
2188+
2189+
final fileSystem = ErrorHandlingFileSystem(
2190+
delegate: localFileSystem,
2191+
platform: linuxPlatform,
2192+
);
2193+
final File file = fileSystem.file(fileSystem.path.join(tempDir.path, 'binary.bin'))
2194+
..writeAsBytesSync(invalidUtf8Bytes);
2195+
2196+
expect(file.readAsStringSync(encoding: encoding), expected);
2197+
});
2198+
}
2199+
});
21722200
}
21732201

21742202
class FakeSignalProcessManager extends Fake implements ProcessManager {

0 commit comments

Comments
 (0)