Made linter more robust to non-utf8 files (#190012)
Fixing a problem a ran into locally.
## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel
on [Discord].
If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.
**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
diff --git a/engine/src/flutter/tools/clang_tidy/lib/src/command.dart b/engine/src/flutter/tools/clang_tidy/lib/src/command.dart
index a371965..fb60831 100644
--- a/engine/src/flutter/tools/clang_tidy/lib/src/command.dart
+++ b/engine/src/flutter/tools/clang_tidy/lib/src/command.dart
@@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
-import 'dart:convert' show LineSplitter, utf8;
+import 'dart:convert' show LineSplitter, Utf8Decoder;
import 'dart:io' as io;
import 'package:meta/meta.dart';
@@ -111,7 +111,7 @@
}
final Stream<String> lines = file
.openRead()
- .transform(utf8.decoder)
+ .transform(const Utf8Decoder(allowMalformed: true))
.transform(const LineSplitter());
return lintActionFromContents(lines);
}
diff --git a/engine/src/flutter/tools/clang_tidy/test/clang_tidy_test.dart b/engine/src/flutter/tools/clang_tidy/test/clang_tidy_test.dart
index 4889df3..c767363 100644
--- a/engine/src/flutter/tools/clang_tidy/test/clang_tidy_test.dart
+++ b/engine/src/flutter/tools/clang_tidy/test/clang_tidy_test.dart
@@ -532,6 +532,18 @@
expect(lintAction, equals(LintAction.skipMissing));
});
+ test('Command getLintAction handles non-UTF8 files without throwing', () async {
+ final io.Directory tempDir = io.Directory.systemTemp.createTempSync('clang_tidy_test_');
+ final tempFile = io.File(path.join(tempDir.path, 'non_utf8_file.cc'));
+ tempFile.writeAsBytesSync(<int>[0x80, 0x81, 0xFE, 0xFF, 0x0A]);
+ try {
+ final LintAction lintAction = await Command.getLintAction(tempFile.path);
+ expect(lintAction, equals(LintAction.lint));
+ } finally {
+ tempDir.deleteSync(recursive: true);
+ }
+ });
+
test('Command getLintActionFromContents flags FLUTTER_NOLINT', () async {
final LintAction lintAction = await Command.lintActionFromContents(
Stream<String>.fromIterable(<String>[
