From b8fd23c76fc59f7290f7e60bcacc194ee863206e Mon Sep 17 00:00:00 2001
From: Byoungchan Lee <byoungchan.lee@gmx.com>
Date: Tue, 4 Feb 2025 08:59:42 +0900
Subject: [PATCH] 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 https://github.com/flutter/flutter/pull/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 <jonahwilliams@google.com>
---
 .../flutter/tools/clangd_check/bin/main.dart  | 29 ++++++++++++++++---
 1 file changed, 25 insertions(+), 4 deletions(-)

diff --git a/engine/src/flutter/tools/clangd_check/bin/main.dart b/engine/src/flutter/tools/clangd_check/bin/main.dart
index e024ac2cd6..fe3570531b 100644
--- a/engine/src/flutter/tools/clangd_check/bin/main.dart
+++ b/engine/src/flutter/tools/clangd_check/bin/main.dart
@@ -51,9 +51,30 @@ void main(List<String> args) {
   }
 
   String? clangd = results['clangd'] as String?;
-  final Map<String, Object?> entry = compileCommands.first! as Map<String, Object?>;
+  // To improve determinism, check the first clangd item that matches the asset fixture file.
+  Map<String, Object?>? selectedEntry;
+  for (final Object? entry in compileCommands) {
+    if (entry is Map<String, Object?>) {
+      final String? file = entry['file'] as String?;
+      if (file != null && file.endsWith('_fl__fl_assets_fixtures.cc')) {
+        selectedEntry = entry;
+        break;
+      }
+    } else {
+      io.stderr.writeln('Unexpected: compile_commands.json has an unexpected format');
+      io.stderr.writeln('First entry: ${const JsonEncoder.withIndent('  ').convert(entry)}');
+      io.exitCode = 1;
+      return;
+    }
+  }
+  if (selectedEntry == null) {
+    io.stderr.writeln('No compile_commands.json entry found for _fl__fl_assets_fixtures.cc');
+    io.exitCode = 1;
+    return;
+  }
+
   final String checkFile;
-  if (entry case {
+  if (selectedEntry case {
     'command': final String command,
     'directory': final String directory,
     'file': final String file,
@@ -94,7 +115,7 @@ void main(List<String> args) {
     }
   } else {
     io.stderr.writeln('Unexpected: compile_commands.json has an unexpected format');
-    io.stderr.writeln('First entry: ${const JsonEncoder.withIndent('  ').convert(entry)}');
+    io.stderr.writeln('First entry: ${const JsonEncoder.withIndent('  ').convert(selectedEntry)}');
     io.exitCode = 1;
     return;
   }
@@ -134,7 +155,7 @@ void main(List<String> args) {
     }
   } on io.ProcessException catch (e) {
     io.stderr.writeln('Failed to run clangd: $e');
-    io.stderr.writeln(const JsonEncoder.withIndent('  ').convert(entry));
+    io.stderr.writeln(const JsonEncoder.withIndent('  ').convert(selectedEntry));
     io.exitCode = 1;
   } finally {
     // Remove the copied .clangd file from the engine root directory.