-
Notifications
You must be signed in to change notification settings - Fork 104
feat(suppression): automatically unsuppress and re-suppress tests on GitHub issue events #5126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| // Copyright 2026 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| import 'package:cocoon_server/logging.dart'; | ||
| import 'package:github/github.dart'; | ||
| import 'package:github/hooks.dart'; | ||
|
|
||
| import '../model/firestore/suppressed_test.dart'; | ||
| import 'firestore.dart'; | ||
| import 'test_suppression.dart'; | ||
|
|
||
| /// Processes GitHub issue events to unsuppress or re-suppress matching tests. | ||
| final class IssueService { | ||
| const IssueService({ | ||
| required this.firestore, | ||
| required this.suppressionService, | ||
| }); | ||
|
|
||
| final FirestoreService firestore; | ||
| final TestSuppression suppressionService; | ||
|
|
||
| /// Re-opens or closes suppressed tests matching a GitHub [IssueEvent]. | ||
| Future<void> handleIssueEvent(IssueEvent event) async { | ||
| if (event.issue?.htmlUrl case final issueUrl? when issueUrl.isNotEmpty) { | ||
| switch (event.action) { | ||
| case 'closed': | ||
| await _handleIssueClosed(event, issueUrl); | ||
| case 'reopened': | ||
| await _handleIssueReopened(event, issueUrl); | ||
| case final action: | ||
| log.debug('Ignoring issue event action: $action'); | ||
| } | ||
| return; | ||
| } | ||
| log.debug('IssueEvent has no htmlUrl; skipping.'); | ||
| } | ||
|
|
||
| Future<void> _handleIssueClosed(IssueEvent event, String issueUrl) async { | ||
| final docs = await SuppressedTest.getByIssueLink(firestore, issueUrl); | ||
| final processed = <String>{}; | ||
|
|
||
| for (final doc in docs) { | ||
| // Tests can be suppressed at different times; we only need to handle | ||
| // this event once per unique test. | ||
| final key = '${doc.repository}/${doc.testName}'; | ||
| if (!processed.add(key)) { | ||
| continue; | ||
| } | ||
|
|
||
| final latest = await SuppressedTest.getLatest( | ||
|
jtmcdole marked this conversation as resolved.
|
||
| firestore, | ||
| doc.repository, | ||
| doc.testName, | ||
| ); | ||
| if (latest == null || | ||
| latest.issueLink != issueUrl || | ||
| !latest.isSuppressed) { | ||
| continue; | ||
| } | ||
|
|
||
| log.info( | ||
| 'Unsuppressing test ${doc.testName} in ${doc.repository} due to issue closed ($issueUrl)', | ||
| ); | ||
| await suppressionService.updateSuppression( | ||
| testName: doc.testName, | ||
| email: event.sender?.login ?? 'github-webhook', | ||
| repository: RepositorySlug.full(doc.repository), | ||
| action: SuppressingAction.unsuppress, | ||
| note: 'Automatic unsuppression: issue $issueUrl was closed.', | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| Future<void> _handleIssueReopened(IssueEvent event, String issueUrl) async { | ||
| final docs = await SuppressedTest.getByIssueLink(firestore, issueUrl); | ||
| final processed = <String>{}; | ||
|
|
||
| for (final doc in docs) { | ||
| // Tests can be suppressed at different times; we only need to handle | ||
| // this event once per unique test. | ||
| final key = '${doc.repository}/${doc.testName}'; | ||
| if (!processed.add(key)) { | ||
| continue; | ||
| } | ||
|
|
||
| final latest = await SuppressedTest.getLatest( | ||
|
jtmcdole marked this conversation as resolved.
|
||
| firestore, | ||
| doc.repository, | ||
| doc.testName, | ||
| ); | ||
| if (latest == null || | ||
| latest.issueLink != issueUrl || | ||
| latest.isSuppressed) { | ||
| continue; | ||
| } | ||
|
|
||
| log.info( | ||
| 'Re-suppressing test ${doc.testName} in ${doc.repository} due to issue reopened ($issueUrl)', | ||
| ); | ||
| await suppressionService.updateSuppression( | ||
| testName: doc.testName, | ||
| email: event.sender?.login ?? 'github-webhook', | ||
| repository: RepositorySlug.full(doc.repository), | ||
| action: SuppressingAction.suppress, | ||
| issueLink: issueUrl, | ||
| note: 'Automatic re-suppression: issue $issueUrl was reopened.', | ||
| ); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.