print detailed info about the leaked APIs to stdout in the workflow (#…

…339)
dart-lang · Jan 23, 2025 · c4a163a · c4a163a
1 parent 682c8ef
commit c4a163a
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 9 deletions.
diff --git a/pkgs/firehose/CHANGELOG.md b/pkgs/firehose/CHANGELOG.md
@@ -1,8 +1,9 @@
-## 0.10.2-wip
+## 0.10.2
 
 - Don't check licenses of generated files in PR health workflow.
 - Add generalized ignore-per-checks to health workflow.
 - Update dart_apitool version in health workflow.
+- Print detailed info about the leaked APIs to stdout in the workflow.
 
 ## 0.10.1
 

diff --git a/pkgs/firehose/lib/firehose.dart b/pkgs/firehose/lib/firehose.dart
@@ -305,8 +305,6 @@ class VerificationResults {
   bool get hasError => results.any((r) => r.severity == Severity.error);
 
   String describeAsMarkdown({bool withTag = true}) {
-    results.sort((a, b) => Enum.compareByIndex(a.severity, b.severity));
-
     return results.map((r) {
       var sev = r.severity == Severity.error ? '(error) ' : '';
       var tagColumn = '';

diff --git a/pkgs/firehose/lib/src/health/health.dart b/pkgs/firehose/lib/src/health/health.dart
@@ -173,6 +173,7 @@ class Health {
           ...['-sgit', 'https://github.com/bmw-tech/dart_apitool.git'],
           ...['--git-ref', apiToolHash],
         ],
+        logStdout: false,
       );
 
       runDashProcess(
@@ -223,16 +224,26 @@ ${changeForPackage.entries.map((e) => '|${e.key.name}|${e.value.toMarkdownRow()}
   String getCurrentVersionOfPackage(Package package) => 'pub://${package.name}';
 
   ProcessResult runDashProcess(
-      List<Package> flutterPackages, Package package, List<String> arguments) {
+    List<Package> flutterPackages,
+    Package package,
+    List<String> arguments, {
+    bool logStdout = true,
+  }) {
     var exec = executable(flutterPackages.any((p) => p.name == package.name));
     log('Running `$exec ${arguments.join(' ')}` in ${directory.path}');
     var runApiTool = Process.runSync(
       exec,
       arguments,
       workingDirectory: directory.path,
     );
-    log('StdOut:\n ${runApiTool.stdout as String}');
-    log('StdErr:\n ${runApiTool.stderr as String}');
+    final out = (runApiTool.stdout as String).trimRight();
+    if (logStdout && out.isNotEmpty) {
+      print(out);
+    }
+    final err = (runApiTool.stderr as String).trimRight();
+    if (err.isNotEmpty) {
+      print(err);
+    }
     return runApiTool;
   }
 
@@ -257,8 +268,11 @@ ${changeForPackage.entries.map((e) => '|${e.key.name}|${e.value.toMarkdownRow()}
     final flutterPackages =
         packagesContaining(filesInPR, only: flutterPackageGlobs);
     log('This list of Flutter packages is $flutterPackages');
+
     for (var package in packagesContaining(filesInPR)) {
-      log('Look for leaks in $package');
+      log('');
+      log('--- ${package.name} ---');
+      log('Look for leaks in ${package.name}');
       var relativePath =
           path.relative(package.directory.path, from: directory.path);
       var tempDirectory = Directory.systemTemp.createTempSync();
@@ -274,6 +288,7 @@ ${changeForPackage.entries.map((e) => '|${e.key.name}|${e.value.toMarkdownRow()}
           ...['-sgit', 'https://github.com/bmw-tech/dart_apitool.git'],
           ...['--git-ref', apiToolHash],
         ],
+        logStdout: false,
       );
 
       var arguments = [
@@ -289,15 +304,28 @@ ${changeForPackage.entries.map((e) => '|${e.key.name}|${e.value.toMarkdownRow()}
         arguments,
       );
 
+      log('');
+
       if (runApiTool.exitCode == 0) {
         var fullReportString = await File(reportPath).readAsString();
         var decoded = jsonDecode(fullReportString) as Map<String, dynamic>;
         var leaks = decoded['missingEntryPoints'] as List<dynamic>;
 
-        log('Leaking symbols in API:\n$leaks');
         if (leaks.isNotEmpty) {
           leaksForPackage[package] = leaks.cast();
+
+          final desc = leaks.map((item) => '$item').join(', ');
+          log('Leaked symbols found: $desc.');
+
+          log('');
+
+          final report = const JsonEncoder.withIndent('  ').convert(decoded);
+          log(report);
+        } else {
+          log('No leaks found.');
         }
+
+        log('');
       } else {
         throw ProcessException(
           executable(flutterPackages.contains(package)),

diff --git a/pkgs/firehose/pubspec.yaml b/pkgs/firehose/pubspec.yaml
@@ -1,6 +1,6 @@
 name: firehose
 description: A tool to automate publishing of Pub packages from GitHub actions.
-version: 0.10.2-wip
+version: 0.10.2
 repository: https://github.com/dart-lang/ecosystem/tree/main/pkgs/firehose
 
 environment: