Skip to content

Commit 60fca9f

Browse files
authored
Condense firehose package publishing table in PR validation (#445)
Condense the package publishing table posted by firehose during PR validation to reduce noise in monorepos. * Only include packages affected by the PR, packages ready to publish, and packages with validation errors in the markdown table. * Summarize unaffected WIP and already published packages below the table. * Add unit and integration tests covering table filtering and summary generation.
1 parent b79f68c commit 60fca9f

3 files changed

Lines changed: 248 additions & 26 deletions

File tree

‎pkgs/firehose/CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## 0.13.2-wip
22

3+
- Condense PR package publishing table to show only packages affected by the PR,
4+
packages ready to publish, and errors, summarizing unaffected WIP and published
5+
packages.
36
- Remove 3rd-party Coveralls action and `upload_coverage` input from health workflows.
47
- Add `--tag-prefix` option to `firehose` and `tag-prefix` input to `publish.yaml` to allow configuring the release tag prefix (defaults to `'v'`).
58
- Run `pub get` before `dart format` in `groundskeeper`.

‎pkgs/firehose/lib/firehose.dart‎

Lines changed: 102 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,20 @@ Saving existing comment id $existingCommentId to file ${idFile.path}''');
110110
final repo = Repository(directory);
111111
final packages = repo.locatePackages(ignore: ignoredPackages);
112112

113+
final filesInPR = await allowFailure(
114+
github.listFilesForPR(directory, ignoredPackages),
115+
logError: print,
116+
);
117+
final relevantFiles = filesInPR?.where((f) => f.status.isRelevant).toList();
118+
113119
final pub = Pub();
114120

115121
final results = VerificationResults();
116122

117123
for (final package in packages) {
124+
final isAffected = relevantFiles == null ||
125+
relevantFiles.any((f) => f.isInPackage(package));
126+
118127
final repoTag = repo.calculateRepoTag(package, tagPrefix: tagPrefix);
119128

120129
print('');
@@ -126,6 +135,7 @@ Saving existing comment id $existingCommentId to file ${idFile.path}''');
126135
final result = Result.fail(
127136
package,
128137
"no version specified (perhaps you need a' publish_to: none' entry?)",
138+
isAffected: isAffected,
129139
);
130140
print(result);
131141
results.addResult(result);
@@ -142,18 +152,27 @@ Saving existing comment id $existingCommentId to file ${idFile.path}''');
142152
package,
143153
'pubspec version ($pubspecVersion) and changelog ($changelogVersion) '
144154
"don't agree",
155+
isAffected: isAffected,
145156
);
146157
print(result);
147158
results.addResult(result);
148159
continue;
149160
}
150161

151162
if (await pub.hasPublishedVersion(package.name, pubspecVersion)) {
152-
final result = Result.info(package, 'already published at pub.dev');
163+
final result = Result.info(
164+
package,
165+
Result.alreadyPublishedMessage,
166+
isAffected: isAffected,
167+
);
153168
print(result);
154169
results.addResult(result);
155170
} else if (package.pubspec.version!.wip) {
156-
final result = Result.info(package, 'WIP (no publish necessary)');
171+
final result = Result.info(
172+
package,
173+
Result.wipMessage,
174+
isAffected: isAffected,
175+
);
157176
print(result);
158177
results.addResult(result);
159178
} else {
@@ -172,17 +191,20 @@ Saving existing comment id $existingCommentId to file ${idFile.path}''');
172191
'pub publish dry-run failed; add the `$_ignoreWarningsLabel` '
173192
'label to ignore';
174193
github.notice(message: message);
175-
results.addResult(Result.fail(package, message));
194+
results.addResult(
195+
Result.fail(package, message, isAffected: isAffected),
196+
);
176197
} else {
177198
final result = Result.success(
178199
package,
179200
'**ready to publish**',
180-
repoTag,
181-
repo.calculateReleaseUri(
201+
gitTag: repoTag,
202+
publishReleaseUri: repo.calculateReleaseUri(
182203
package,
183204
github,
184205
tagPrefix: tagPrefix,
185206
),
207+
isAffected: isAffected,
186208
);
187209
print(result);
188210
results.addResult(result);
@@ -323,51 +345,105 @@ class VerificationResults {
323345

324346
bool get hasError => results.any((r) => r.severity == Severity.error);
325347

326-
String describeAsMarkdown({bool withTag = true}) => results.map((r) {
327-
final sev = r.severity == Severity.error ? '(error) ' : '';
328-
var tagColumn = '';
329-
if (withTag) {
330-
var tag = r.gitTag == null ? '' : '`${r.gitTag}`';
331-
final publishReleaseUri = r.publishReleaseUri;
332-
if (publishReleaseUri != null) {
333-
tag = '[$tag]($publishReleaseUri)';
334-
}
335-
336-
tagColumn = ' | $tag';
348+
Iterable<Result> get visibleResults =>
349+
results.where((r) => r.isVisibleInTable);
350+
351+
Iterable<Result> get hiddenResults =>
352+
results.where((r) => !r.isVisibleInTable);
353+
354+
String describeAsMarkdown({bool withTag = true}) {
355+
final buffer = StringBuffer();
356+
for (final r in visibleResults) {
357+
final sev = r.severity == Severity.error ? '(error) ' : '';
358+
var tagColumn = '';
359+
if (withTag) {
360+
var tag = r.gitTag == null ? '' : '`${r.gitTag}`';
361+
final publishReleaseUri = r.publishReleaseUri;
362+
if (publishReleaseUri != null) {
363+
tag = '[$tag]($publishReleaseUri)';
337364
}
338-
return '| package:${r.package.name} | ${r.package.version} | '
339-
'$sev${r.message}$tagColumn |';
340-
}).join('\n');
365+
366+
tagColumn = ' | $tag';
367+
}
368+
final pkgName = r.isAffected
369+
? '**package:${r.package.name}** ⭐'
370+
: 'package:${r.package.name}';
371+
buffer.writeln(
372+
'| $pkgName | ${r.package.version} | '
373+
'$sev${r.message}$tagColumn |',
374+
);
375+
}
376+
377+
final hidden = hiddenResults.toList();
378+
final alreadyPublishedCount =
379+
hidden.where((r) => r.message == Result.alreadyPublishedMessage).length;
380+
final wipCount = hidden.where((r) => r.message == Result.wipMessage).length;
381+
382+
final summaryLines = <String>[];
383+
if (alreadyPublishedCount > 0) {
384+
summaryLines.add('* $alreadyPublishedCount already published.');
385+
}
386+
if (wipCount > 0) {
387+
summaryLines.add('* $wipCount WIP (no publish necessary).');
388+
}
389+
390+
if (summaryLines.isNotEmpty) {
391+
if (visibleResults.isNotEmpty) {
392+
buffer.writeln();
393+
}
394+
buffer.write(summaryLines.join('\n'));
395+
}
396+
397+
return buffer.toString().trimRight();
398+
}
341399
}
342400

343401
class Result {
402+
static const String alreadyPublishedMessage = 'already published at pub.dev';
403+
static const String wipMessage = 'WIP (no publish necessary)';
404+
344405
final Severity severity;
345406
final Package package;
346407
final String message;
347408
final String? gitTag;
348409
final Uri? publishReleaseUri;
410+
final bool isAffected;
349411

350412
Result(
351413
this.severity,
352414
this.package,
353415
this.message, [
354416
this.gitTag,
355417
this.publishReleaseUri,
418+
this.isAffected = false,
356419
]);
357420

358-
factory Result.fail(Package package, String message) =>
359-
Result(Severity.error, package, message);
421+
factory Result.fail(
422+
Package package,
423+
String message, {
424+
bool isAffected = false,
425+
}) =>
426+
Result(Severity.error, package, message, null, null, isAffected);
360427

361-
factory Result.info(Package package, String message) =>
362-
Result(Severity.info, package, message);
428+
factory Result.info(
429+
Package package,
430+
String message, {
431+
bool isAffected = false,
432+
}) =>
433+
Result(Severity.info, package, message, null, null, isAffected);
363434

364435
factory Result.success(
365436
Package package,
366-
String message, [
437+
String message, {
367438
String? gitTag,
368439
Uri? publishReleaseUri,
369-
]) =>
370-
Result(Severity.success, package, message, gitTag, publishReleaseUri);
440+
bool isAffected = false,
441+
}) =>
442+
Result(Severity.success, package, message, gitTag, publishReleaseUri,
443+
isAffected);
444+
445+
bool get isVisibleInTable =>
446+
isAffected || severity == Severity.success || severity == Severity.error;
371447

372448
@override
373449
String toString() {
Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
// Copyright (c) 2026, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
@TestOn('vm')
6+
library;
7+
8+
import 'dart:io';
9+
10+
import 'package:firehose/firehose.dart';
11+
import 'package:firehose/src/local_github_api.dart';
12+
import 'package:test/test.dart';
13+
14+
void main() {
15+
group('VerificationResults', () {
16+
late Repository repo;
17+
late Package pkgA;
18+
late Package pkgB;
19+
late Package pkgC;
20+
late Package pkgD;
21+
late Package pkgE;
22+
23+
setUp(() {
24+
repo = Repository();
25+
pkgA = Package(Directory('test_data/workspace_repo/pkg_1'), repo);
26+
pkgB = Package(Directory('test_data/workspace_repo/pkg_2'), repo);
27+
pkgC = Package(Directory('test_data/test_repo/pkgs/package1'), repo);
28+
pkgD = Package(Directory('test_data/test_repo/pkgs/package2'), repo);
29+
pkgE = Package(Directory('test_data/test_repo/pkgs/package3'), repo);
30+
});
31+
32+
test('all packages affected are visible in table and highlighted', () {
33+
final results = VerificationResults()
34+
..addResult(Result.info(pkgA, Result.wipMessage, isAffected: true))
35+
..addResult(Result.info(pkgB, Result.alreadyPublishedMessage,
36+
isAffected: true));
37+
38+
expect(results.visibleResults.length, 2);
39+
expect(results.hiddenResults, isEmpty);
40+
41+
final markdown = results.describeAsMarkdown(withTag: false);
42+
expect(markdown, contains('| **package:pkg_1** ⭐ |'));
43+
expect(markdown, contains('| **package:pkg_2** ⭐ |'));
44+
expect(markdown, isNot(contains('already published.')));
45+
expect(markdown, isNot(contains('WIP (no publish necessary).')));
46+
});
47+
48+
test('unaffected ready-to-publish and error packages are not starred', () {
49+
final results = VerificationResults()
50+
..addResult(
51+
Result.success(pkgA, '**ready to publish**', isAffected: false))
52+
..addResult(Result.fail(pkgB, 'version mismatch', isAffected: false));
53+
54+
expect(results.visibleResults.length, 2);
55+
expect(results.hiddenResults, isEmpty);
56+
57+
final markdown = results.describeAsMarkdown(withTag: false);
58+
expect(markdown, contains('| package:pkg_1 |'));
59+
expect(markdown, contains('| package:pkg_2 |'));
60+
expect(markdown, isNot(contains('⭐')));
61+
});
62+
63+
test('unaffected WIP and already-published packages are summarized', () {
64+
final results = VerificationResults()
65+
..addResult(
66+
Result.success(pkgA, '**ready to publish**', isAffected: false))
67+
..addResult(Result.info(pkgB, Result.wipMessage, isAffected: true))
68+
..addResult(Result.info(pkgC, Result.wipMessage, isAffected: false))
69+
..addResult(Result.info(pkgD, Result.wipMessage, isAffected: false))
70+
..addResult(Result.info(pkgE, Result.alreadyPublishedMessage,
71+
isAffected: false));
72+
73+
expect(results.visibleResults.length, 2);
74+
expect(results.hiddenResults.length, 3);
75+
76+
final markdown = results.describeAsMarkdown(withTag: false);
77+
expect(markdown, contains('| package:pkg_1 |'));
78+
expect(markdown, contains('| **package:pkg_2** ⭐ |'));
79+
expect(markdown, isNot(contains('| package:package1 |')));
80+
expect(markdown, isNot(contains('| package:package2 |')));
81+
expect(markdown, isNot(contains('| package:package3 |')));
82+
83+
expect(markdown, contains('* 1 already published.'));
84+
expect(markdown, contains('* 2 WIP (no publish necessary).'));
85+
});
86+
87+
test('summary omitted when counts are zero', () {
88+
final results = VerificationResults()
89+
..addResult(
90+
Result.success(pkgA, '**ready to publish**', isAffected: true));
91+
92+
final markdown = results.describeAsMarkdown(withTag: false);
93+
expect(markdown, contains('| **package:pkg_1** ⭐ |'));
94+
expect(markdown, isNot(contains('already published.')));
95+
expect(markdown, isNot(contains('WIP (no publish necessary).')));
96+
});
97+
98+
test('only summary when no packages visible in table', () {
99+
final results = VerificationResults()
100+
..addResult(Result.info(pkgA, Result.alreadyPublishedMessage,
101+
isAffected: false))
102+
..addResult(Result.info(pkgB, Result.wipMessage, isAffected: false));
103+
104+
expect(results.visibleResults, isEmpty);
105+
expect(results.hiddenResults.length, 2);
106+
107+
final markdown = results.describeAsMarkdown(withTag: false);
108+
expect(
109+
markdown,
110+
equals('* 1 already published.\n* 1 WIP (no publish necessary).'),
111+
);
112+
});
113+
});
114+
115+
group('Firehose.verify with LocalGithubApi', () {
116+
test('filters packages based on PR file changes', () async {
117+
final testDir = Directory('test_data/test_repo');
118+
final firehose = Firehose(testDir, false, []);
119+
final github = LocalGithubApi(
120+
prLabels: [],
121+
files: [
122+
GitFile(
123+
'pkgs/package1/lib/package1.dart',
124+
FileStatus.modified,
125+
testDir,
126+
),
127+
],
128+
);
129+
130+
final results = await firehose.verify(github);
131+
final affectedResults =
132+
results.results.where((r) => r.isAffected).toList();
133+
final unaffectedResults =
134+
results.results.where((r) => !r.isAffected).toList();
135+
136+
expect(affectedResults.map((r) => r.package.name), ['package1']);
137+
expect(
138+
unaffectedResults.map((r) => r.package.name),
139+
containsAll(['package2', 'package3', 'package4', 'package5']),
140+
);
141+
});
142+
});
143+
}

0 commit comments

Comments
 (0)