Remove MockFirestoreService, add transactions to FakeFiretoreService (#4511)

Closes flutter/flutter#167016.

Author: matanlurey

app_dart/lib/src/model/firestore/ci_staging.dart

@@ -168,6 +168,25 @@ final class CiStaging extends AppDocument<CiStaging> {
   /// The check_run to complete when this stage is closed.
   String get checkRunGuard => fields[kCheckRunGuardField]!.stringValue!;
 
+  static const keysOfImport = [
+    kRemainingField,
+    kTotalField,
+    kFailedField,
+    kCheckRunGuardField,
+    fieldRepoFullPath,
+    fieldCommitSha,
+    fieldStage,
+  ];
+
+  /// The recorded check-runs, a map of "test_name": "check_run id".
+  Map<String, TaskConclusion> get checkRuns {
+    return {
+      for (final MapEntry(:key, :value) in fields.entries)
+        if (!keysOfImport.contains(key))
+          key: TaskConclusion.fromName(value.stringValue),
+    };
+  }
+
   /// Mark a [checkRun] for a given [stage] with [conclusion].
   ///
   /// Returns a [StagingConclusion] record or throws. If the check_run was
@@ -190,17 +209,7 @@ final class CiStaging extends AppDocument<CiStaging> {
     // updated correctly. For that to happen correctly; we need to perform a
     // read of the document in the transaction as well. So start the transaction
     // first thing.
-    final docRes = await firestoreService.documentResource();
-    final transactionResponse = await docRes.beginTransaction(
-      BeginTransactionRequest(
-        options: TransactionOptions(readWrite: ReadWrite()),
-      ),
-      kDatabase,
-    );
-    final transaction = transactionResponse.transaction;
-    if (transaction == null) {
-      throw '$logCrumb: transaction was null when updating $conclusion';
-    }
+    final transaction = await firestoreService.beginTransaction();
 
     var remaining = -1;
     var failed = -1;
@@ -215,7 +224,10 @@ final class CiStaging extends AppDocument<CiStaging> {
     try {
       // First: read the fields we want to change.
       final documentName = documentNameFor(slug: slug, stage: stage, sha: sha);
-      doc = await docRes.get(documentName, transaction: transaction);
+      doc = await firestoreService.getDocument(
+        documentName,
+        transaction: transaction,
+      );
 
       final fields = doc.fields;
       if (fields == null) {
@@ -254,10 +266,7 @@ final class CiStaging extends AppDocument<CiStaging> {
         log.info(
           '$logCrumb: $checkRun not present in doc for $transaction / $doc',
         );
-        await docRes.rollback(
-          RollbackRequest(transaction: transaction),
-          kDatabase,
-        );
+        await firestoreService.rollback(transaction);
         return StagingConclusion(
           result: StagingConclusionResult.missing,
           remaining: remaining,
@@ -326,10 +335,7 @@ final class CiStaging extends AppDocument<CiStaging> {
       if (e.status == 404) {
         // An attempt to read a document not in firestore should not be retried.
         log.info('$logCrumb: staging document not found for $transaction');
-        await docRes.rollback(
-          RollbackRequest(transaction: transaction),
-          kDatabase,
-        );
+        await firestoreService.rollback(transaction);
         return StagingConclusion(
           result: StagingConclusionResult.internalError,
           remaining: -1,
@@ -347,28 +353,21 @@ $stack
         );
       }
       // All other errors should bubble up and be retried.
-      await docRes.rollback(
-        RollbackRequest(transaction: transaction),
-        kDatabase,
-      );
+      await firestoreService.rollback(transaction);
       rethrow;
     } catch (e) {
       // All other errors should bubble up and be retried.
-      await docRes.rollback(
-        RollbackRequest(transaction: transaction),
-        kDatabase,
-      );
+      await firestoreService.rollback(transaction);
       rethrow;
     }
 
     // Commit this write firebase and if no one else was writing at the same time, return success.
     // If this commit fails, that means someone else modified firestore and the caller should try again.
     // We do not need to rollback the transaction; firebase documentation says a failed commit takes care of that.
-    final commitRequest = CommitRequest(
-      transaction: transaction,
-      writes: documentsToWrites([doc], exists: true),
+    final response = await firestoreService.commit(
+      transaction,
+      documentsToWrites([doc], exists: true),
     );
-    final response = await docRes.commit(commitRequest, kDatabase);
     log.info(
       '$logCrumb: results = ${response.writeResults?.map((e) => e.toJson())}',
     );
@@ -433,12 +432,9 @@ For CI stage $stage:
       // Calling createDocument multiple times for the same documentId will return a 409 - ALREADY_EXISTS error;
       // this is good because it means we don't have to do any transactions.
       // curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" "https://firestore.googleapis.com/v1beta1/projects/flutter-dashboard/databases/cocoon/documents/ciStaging?documentId=foo_bar_baz" -d '{"fields": {"test": {"stringValue": "baz"}}}'
-      final databasesDocumentsResource =
-          await firestoreService.documentResource();
-      final newDoc = await databasesDocumentsResource.createDocument(
+      final newDoc = await firestoreService.createDocument(
         document,
-        kDocumentParent,
-        _collectionId,
+        collectionId: _collectionId,
         documentId:
             documentIdFor(
               slug: slug,

app_dart/lib/src/model/firestore/github_build_status.dart

@@ -25,8 +25,7 @@ const String kGithubBuildStatusUpdatesField = 'updates';
 ///  /projects/flutter-dashboard/databases/cocoon/commits/
 ///    document: <this.head>
 /// ```
-/*final - TODO(matanlurey): Can't add because of MockFirestoreService. */
-class GithubBuildStatus extends AppDocument<GithubBuildStatus> {
+final class GithubBuildStatus extends AppDocument<GithubBuildStatus> {
   static AppDocumentId<GithubBuildStatus> documentIdFor({
     required String headSha,
   }) {

app_dart/lib/src/model/firestore/github_gold_status.dart

@@ -25,8 +25,7 @@ const String kGithubGoldStatusRepositoryField = 'repository';
 ///  /projects/flutter-dashboard/databases/cocoon/commits/
 ///    document: <this.slug.owner>_<this.slug.name>_<this.prNumber>
 /// ```
-/*final - TODO(matanlurey): Can't add because of MockFirestoreService. */
-class GithubGoldStatus extends AppDocument<GithubGoldStatus> {
+final class GithubGoldStatus extends AppDocument<GithubGoldStatus> {
   static AppDocumentId<GithubGoldStatus> documentIdFor({
     required String owner,
     required String repo,

app_dart/lib/src/request_handlers/rerun_prod_task.dart

@@ -13,7 +13,7 @@ import '../model/firestore/task.dart' as fs;
 import '../request_handling/api_request_handler.dart';
 import '../request_handling/body.dart';
 import '../request_handling/exceptions.dart';
-import '../service/firestore.dart';
+import '../service/firestore/commit_and_tasks.dart';
 import '../service/luci_build_service.dart';
 import '../service/luci_build_service/build_tags.dart';
 import '../service/luci_build_service/opaque_commit.dart';

app_dart/lib/src/request_handlers/scheduler/vacuum_stale_tasks.dart

@@ -17,6 +17,7 @@ import '../../model/appengine/task.dart' as ds;
 import '../../model/firestore/commit.dart' as fs;
 import '../../model/firestore/task.dart' as fs;
 import '../../service/datastore.dart';
+import '../../service/firestore/commit_and_tasks.dart';
 
 /// Vacuum stale tasks.
 ///

app_dart/lib/src/service/build_status_provider.dart

@@ -4,6 +4,7 @@
 
 import 'dart:async';
 
+import 'package:cocoon_server/logging.dart';
 import 'package:github/github.dart';
 import 'package:meta/meta.dart';
 
@@ -49,44 +50,47 @@ interface class BuildStatusService {
   ///
   /// Tree status is only for [defaultBranches].
   Future<BuildStatus?> calculateCumulativeStatus(RepositorySlug slug) async {
-    final statuses = await retrieveCommitStatusFirestore(
+    final commits = await retrieveCommitStatusFirestore(
       limit: numberOfCommitsToReferenceForTreeStatus,
       slug: slug,
     );
-    if (statuses.isEmpty) {
+    if (commits.isEmpty) {
+      log.info('Tree status of failure for $slug: no commits found');
       return BuildStatus.failure();
     }
 
-    final tasksInProgress = _findTasksRelevantToLatestStatus(statuses);
-    if (tasksInProgress.isEmpty) {
+    final mostRecentTasks = _findTasksRelevantToLatestStatus(commits);
+    if (mostRecentTasks.isEmpty) {
+      log.info('Tree status of failure for $slug: no recent tasks found');
       return BuildStatus.failure();
     }
 
     final failedTasks = <String>[];
-    for (var status in statuses) {
+    for (var status in commits) {
       for (var task in status.tasks) {
         /// If a task [isRelevantToLatestStatus] but has not run yet, we look
         /// for a previous run of the task from the previous commit.
-        final isRelevantToLatestStatus = tasksInProgress.containsKey(
+        final isRelevantToLatestStatus = mostRecentTasks.containsKey(
           task.taskName,
         );
 
         /// Tasks that are not relevant to the latest status will have a
         /// null value in the map.
-        final taskInProgress = tasksInProgress[task.taskName] ?? true;
+        final taskInProgress = mostRecentTasks[task.taskName] ?? true;
 
         if (isRelevantToLatestStatus && taskInProgress) {
           if (task.bringup || _isSuccessful(task)) {
             /// This task no longer needs to be checked to see if it causing
             /// the build status to fail.
-            tasksInProgress[task.taskName] = false;
+            mostRecentTasks[task.taskName] = false;
           } else if (_isFailed(task) || _isRerunning(task)) {
+            log.debug('${task.taskName} (${task.commitSha}) is failing');
             failedTasks.add(task.taskName);
 
             /// This task no longer needs to be checked to see if its causing
             /// the build status to fail since its been
             /// added to the failedTasks list.
-            tasksInProgress[task.taskName] = false;
+            mostRecentTasks[task.taskName] = false;
           }
         }
       }
@@ -129,6 +133,7 @@ interface class BuildStatusService {
     );
     return [
       for (final commit in commits)
+        // It's not obvious, but this is ordered by task creation time, descending.
         CommitTasksStatus(commit, await firestore.queryCommitTasks(commit.sha)),
     ];
   }