Skip to content

Commit b8fd23c

Browse files
bc-leeJonah Williams
andauthored
Improve the test for clangd --check to choose files deterministically (#161072)
It seems that not all files in the Flutter repository are compatible with clangd. This change improves the clangd invocation in CI to choose files that are known to work with clangd. Reason for the change: In flutter/flutter#161012, I'm trying to update GN to the latest version. However, this change made the order of files in the compile_commands.json. This caused [the clangd check to fail](https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20clangd/10395/overview) because `engine/src/flutter/tools/clangd_check/bin/main.dart` currently chooses the first file in the compile_commands.json, and the newly chosen file (`engine/src/flutter/third_party/skia/modules/skparagraph/src/Decorations.cpp`) is not compatible with clangd. To fix this, I'm making the test choose the file that is known to work with clangd. (`gen/flutter/assets/_fl__fl_assets_fixtures.cc`) ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [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]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] 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]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [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: Jonah Williams <[email protected]>
1 parent 56190fb commit b8fd23c

File tree

1 file changed

+25
-4
lines changed
  • engine/src/flutter/tools/clangd_check/bin

1 file changed

+25
-4
lines changed

engine/src/flutter/tools/clangd_check/bin/main.dart

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,30 @@ void main(List<String> args) {
5151
}
5252

5353
String? clangd = results['clangd'] as String?;
54-
final Map<String, Object?> entry = compileCommands.first! as Map<String, Object?>;
54+
// To improve determinism, check the first clangd item that matches the asset fixture file.
55+
Map<String, Object?>? selectedEntry;
56+
for (final Object? entry in compileCommands) {
57+
if (entry is Map<String, Object?>) {
58+
final String? file = entry['file'] as String?;
59+
if (file != null && file.endsWith('_fl__fl_assets_fixtures.cc')) {
60+
selectedEntry = entry;
61+
break;
62+
}
63+
} else {
64+
io.stderr.writeln('Unexpected: compile_commands.json has an unexpected format');
65+
io.stderr.writeln('First entry: ${const JsonEncoder.withIndent(' ').convert(entry)}');
66+
io.exitCode = 1;
67+
return;
68+
}
69+
}
70+
if (selectedEntry == null) {
71+
io.stderr.writeln('No compile_commands.json entry found for _fl__fl_assets_fixtures.cc');
72+
io.exitCode = 1;
73+
return;
74+
}
75+
5576
final String checkFile;
56-
if (entry case {
77+
if (selectedEntry case {
5778
'command': final String command,
5879
'directory': final String directory,
5980
'file': final String file,
@@ -94,7 +115,7 @@ void main(List<String> args) {
94115
}
95116
} else {
96117
io.stderr.writeln('Unexpected: compile_commands.json has an unexpected format');
97-
io.stderr.writeln('First entry: ${const JsonEncoder.withIndent(' ').convert(entry)}');
118+
io.stderr.writeln('First entry: ${const JsonEncoder.withIndent(' ').convert(selectedEntry)}');
98119
io.exitCode = 1;
99120
return;
100121
}
@@ -134,7 +155,7 @@ void main(List<String> args) {
134155
}
135156
} on io.ProcessException catch (e) {
136157
io.stderr.writeln('Failed to run clangd: $e');
137-
io.stderr.writeln(const JsonEncoder.withIndent(' ').convert(entry));
158+
io.stderr.writeln(const JsonEncoder.withIndent(' ').convert(selectedEntry));
138159
io.exitCode = 1;
139160
} finally {
140161
// Remove the copied .clangd file from the engine root directory.

0 commit comments

Comments
 (0)