Allow vacuuming a specific repository and branch. (#4682)

Closes flutter/flutter#168833.

Better supports branches such as flutter/flutter#168738.

Author: matanlurey

app_dart/lib/src/request_handlers/vacuum_github_commits.dart

@@ -26,15 +26,31 @@ final class VacuumGithubCommits extends ApiRequestHandler {
   }) : _scheduler = scheduler;
 
   final Scheduler _scheduler;
-  static const String branchParam = 'branch';
+
+  static const _paramRepo = 'repo';
+  static const _paramBranch = 'branch';
 
   @override
   Future<Response> get(Request request) async {
-    for (var slug in config.supportedRepos) {
-      final branch =
-          request.uri.queryParameters[branchParam] ??
-          Config.defaultBranch(slug);
-      await _vacuumRepository(slug, branch: branch);
+    final Iterable<gh.RepositorySlug> repos;
+    if (request.uri.queryParameters[_paramRepo] case final specific?) {
+      repos = [gh.RepositorySlug.full(specific)];
+    } else {
+      repos = config.supportedRepos;
+    }
+
+    final String? branch;
+    if (request.uri.queryParameters[_paramBranch] case final specific?) {
+      branch = specific;
+    } else {
+      branch = null;
+    }
+
+    for (final slug in repos) {
+      await _vacuumRepository(
+        slug,
+        branch: branch ?? Config.defaultBranch(slug),
+      );
     }
 
     return Response.emptyOk;

app_dart/test/request_handlers/vacuum_github_commits_test.dart

@@ -97,31 +97,51 @@ void main() {
   });
 
   test('succeeds when GitHub returns no commits', () async {
-    fakeGithubCommitShas = <String>[];
-    config.supportedBranchesValue = <String>['master'];
+    fakeGithubCommitShas = [];
+    config.supportedBranchesValue = ['master'];
     final body = await tester.get(handler);
 
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
     expect(await body.body.toList(), isEmpty);
   });
 
+  test('succeeds on specific repo and branch set', () async {
+    fakeGithubCommitShas = ['123'];
+    config.supportedReposValue = {RepositorySlug('flutter', 'cocoon')};
+
+    tester.request.uri = tester.request.uri.replace(
+      queryParameters: {'repo': 'flutter/cocoon', 'branch': 'a-new-branch'},
+    );
+
+    await tester.get(handler);
+    expect(
+      firestore,
+      existsInStorage(fs.Commit.metadata, [
+        isCommit
+            .hasSha('123')
+            .hasRepositoryPath('flutter/cocoon')
+            .hasBranch('a-new-branch'),
+      ]),
+    );
+  });
+
   test('does not fail on empty commit list', () async {
-    fakeGithubCommitShas = <String>[];
+    fakeGithubCommitShas = [];
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
     await tester.get(handler);
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
   });
 
   test('does not add recent commits', () async {
-    fakeGithubCommitShas = <String>['${DateTime.now().millisecondsSinceEpoch}'];
+    fakeGithubCommitShas = ['${DateTime.now().millisecondsSinceEpoch}'];
 
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
     await tester.get(handler);
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
   });
 
   test('inserts all relevant fields of the commit', () async {
-    fakeGithubCommitShas = <String>['1'];
+    fakeGithubCommitShas = ['1'];
     expect(firestore, existsInStorage(fs.Commit.metadata, isEmpty));
     await tester.get(handler);
     expect(

dashboard/lib/service/appengine_cocoon.dart

@@ -189,8 +189,15 @@ class AppEngineCocoonService implements CocoonService {
   }
 
   @override
-  Future<CocoonResponse<bool>> vacuumGitHubCommits(String idToken) async {
-    final refreshGitHubCommitsUrl = apiEndpoint('/api/vacuum-github-commits');
+  Future<CocoonResponse<bool>> vacuumGitHubCommits(
+    String idToken, {
+    required String repo,
+    required String branch,
+  }) async {
+    final refreshGitHubCommitsUrl = apiEndpoint(
+      '/api/vacuum-github-commits',
+      queryParameters: {'repo': repo, 'branch': branch},
+    );
     final response = await _client.get(
       refreshGitHubCommitsUrl,
       headers: <String, String>{'X-Flutter-IdToken': idToken},

dashboard/lib/service/cocoon.dart

@@ -70,7 +70,11 @@ abstract class CocoonService {
   });
 
   /// Force update Cocoon to get the latest commits.
-  Future<CocoonResponse<bool>> vacuumGitHubCommits(String idToken);
+  Future<CocoonResponse<bool>> vacuumGitHubCommits(
+    String idToken, {
+    required String repo,
+    required String branch,
+  });
 }
 
 /// Wrapper class for data this state serves.

dashboard/lib/service/dev_cocoon.dart

@@ -126,7 +126,11 @@ class DevelopmentCocoonService implements CocoonService {
   }
 
   @override
-  Future<CocoonResponse<bool>> vacuumGitHubCommits(String idToken) async {
+  Future<CocoonResponse<bool>> vacuumGitHubCommits(
+    String idToken, {
+    required String repo,
+    required String branch,
+  }) async {
     return const CocoonResponse<bool>.error(
       'Unable to vacuum against fake data. Try building the app to use prod data.',
       statusCode: 501 /* Not implemented */,

dashboard/lib/state/build.dart

@@ -360,6 +360,8 @@ class BuildState extends ChangeNotifier {
     }
     final response = await cocoonService.vacuumGitHubCommits(
       await authService.idToken,
+      repo: currentRepo,
+      branch: currentBranch,
     );
     if (response.error != null) {
       _errors.send('$errorMessageRefreshGitHubCommits: ${response.error}');

dashboard/test/service/appengine_cocoon_test.dart

@@ -254,7 +254,11 @@ void main() {
 
     test('should return true if request succeeds', () async {
       await expectLater(
-        service.vacuumGitHubCommits('fakeIdToken'),
+        service.vacuumGitHubCommits(
+          'fakeIdToken',
+          repo: 'flutter',
+          branch: 'master',
+        ),
         completion(
           isA<CocoonResponse<bool>>().having((r) => r.data, 'data', isTrue),
         ),
@@ -268,7 +272,11 @@ void main() {
         }),
       );
       await expectLater(
-        service.vacuumGitHubCommits('fakeIdToken'),
+        service.vacuumGitHubCommits(
+          'fakeIdToken',
+          repo: 'flutter',
+          branch: 'master',
+        ),
         completion(
           isA<CocoonResponse<bool>>().having((r) => r.error, 'data', isNotNull),
         ),

dashboard/test/state/build_test.dart

@@ -544,7 +544,13 @@ void main() {
       final result = await buildState.refreshGitHubCommits();
 
       expect(result, isFalse);
-      verifyNever(cocoonService.vacuumGitHubCommits(any));
+      verifyNever(
+        cocoonService.vacuumGitHubCommits(
+          any,
+          branch: anyNamed('branch'),
+          repo: anyNamed('repo'),
+        ),
+      );
     });
 
     testWidgets(
@@ -553,7 +559,13 @@ void main() {
         const idToken = 'id_token';
         when(authService.isAuthenticated).thenReturn(true);
         when(authService.idToken).thenAnswer((_) async => idToken);
-        when(cocoonService.vacuumGitHubCommits(idToken)).thenAnswer(
+        when(
+          cocoonService.vacuumGitHubCommits(
+            idToken,
+            branch: anyNamed('branch'),
+            repo: anyNamed('repo'),
+          ),
+        ).thenAnswer(
           (_) async => const CocoonResponse.error('Bad user', statusCode: 401),
         );
 
@@ -574,7 +586,11 @@ void main() {
       when(authService.isAuthenticated).thenReturn(true);
       when(authService.idToken).thenAnswer((_) async => idToken);
       when(
-        cocoonService.vacuumGitHubCommits(idToken),
+        cocoonService.vacuumGitHubCommits(
+          idToken,
+          branch: anyNamed('branch'),
+          repo: anyNamed('repo'),
+        ),
       ).thenAnswer((_) async => const CocoonResponse.data(true));
 
       final buildState = BuildState(