app_dart/lib/src/request_handlers/reset_prod_task_v2.dart - mirrors/cocoon - Git at Google

 // Copyright 2020 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 'dart:async';

 import 'package:buildbucket/buildbucket_pb.dart' as bbv2;
 import 'package:cocoon_service/src/service/luci_build_service_v2.dart';
 import 'package:cocoon_service/src/service/scheduler_v2.dart';
 import 'package:gcloud/db.dart';
 import 'package:github/github.dart';
 import 'package:meta/meta.dart';

 import '../model/appengine/commit.dart';
 import '../model/appengine/key_helper.dart';
 import '../model/appengine/task.dart';
 import '../model/firestore/task.dart' as firestore;
 import '../model/ci_yaml/ci_yaml.dart';
 import '../model/ci_yaml/target.dart';
 import '../model/google/token_info.dart';
 import '../request_handling/api_request_handler.dart';
 import '../request_handling/body.dart';
 import '../request_handling/exceptions.dart';
 import '../service/config.dart';
 import '../service/datastore.dart';
 import '../service/firestore.dart';

 /// Reruns a postsubmit LUCI build.
 ///
 /// Expects either [taskKeyParam] or a set of params that give enough detail to lookup a task in datastore.
 @immutable
 class ResetProdTaskV2 extends ApiRequestHandler<Body> {
   const ResetProdTaskV2({
     required super.config,
     required super.authenticationProvider,
     required this.luciBuildService,
     required this.scheduler,
     @visibleForTesting DatastoreServiceProvider? datastoreProvider,
   }) : datastoreProvider = datastoreProvider ?? DatastoreService.defaultProvider;

   final DatastoreServiceProvider datastoreProvider;
   final LuciBuildServiceV2 luciBuildService;
   final SchedulerV2 scheduler;

   static const String branchParam = 'Branch';
   static const String taskKeyParam = 'Key';
   static const String ownerParam = 'Owner';
   static const String repoParam = 'Repo';
   static const String commitShaParam = 'Commit';
   static const String taskDocumentNameParam = 'taskDocumentName';

   /// Name of the task to be retried.
   ///
   /// If "all" is given, all failed tasks will be retried. This enables
   /// oncalls to quickly recover a commit without the tedium of the UI.
   static const String taskParam = 'Task';

   @override
   Future<Body> post() async {
     final DatastoreService datastore = datastoreProvider(config.db);
     final FirestoreService firestoreService = await config.createFirestoreService();
     final String? encodedKey = requestData![taskKeyParam] as String?;
     String? branch = requestData![branchParam] as String?;
     final String owner = requestData![ownerParam] as String? ?? 'flutter';
     final String? repo = requestData![repoParam] as String?;
     final String? sha = requestData![commitShaParam] as String?;
     final TokenInfo token = await tokenInfo(request!);
     final String? taskName = requestData![taskParam] as String?;
     // When Frontend is switched to Firstore, the task document name will be passed over.
     final String? taskDocumentName = requestData![taskDocumentNameParam] as String?;

     RepositorySlug? slug;
     if (encodedKey != null && encodedKey.isNotEmpty) {
       // Check params required for dashboard.
       checkRequiredParameters(<String>[taskKeyParam]);
     } else {
       // Checks params required when this API is called with curl.
       checkRequiredParameters(<String>[commitShaParam, taskParam, repoParam]);
       slug = RepositorySlug(owner, repo!);
       branch ??= Config.defaultBranch(slug);
     }

     if (taskName == 'all') {
       final Key<String> commitKey = Commit.createKey(
         db: datastore.db,
         slug: slug!,
         gitBranch: branch!,
         sha: sha!,
       );
       final List<Task> tasks = await datastore.db.query<Task>(ancestorKey: commitKey).run().toList();
       final List<Future<void>> futures = <Future<void>>[];
       for (final Task task in tasks) {
         if (!Task.taskFailStatusSet.contains(task.status)) continue;
         futures.add(
           rerun(
             datastore: datastore,
             firestoreService: firestoreService,
             branch: branch,
             sha: sha,
             taskName: task.name,
             slug: slug,
             email: token.email!,
           ),
         );
       }
       await Future.wait(futures);
     } else {
       await rerun(
         datastore: datastore,
         firestoreService: firestoreService,
         encodedKey: encodedKey,
         branch: branch,
         sha: sha,
         taskName: taskName,
         taskDocumentName: taskDocumentName,
         slug: slug,
         email: token.email!,
         ignoreChecks: true,
       );
     }

     return Body.empty;
   }

   Future<void> rerun({
     required DatastoreService datastore,
     required FirestoreService firestoreService,
     String? encodedKey,
     String? branch,
     String? sha,
     String? taskName,
     RepositorySlug? slug,
     String? taskDocumentName,
     required String email,
     bool ignoreChecks = false,
   }) async {
     // Prepares Datastore task.
     final Task task = await _getTaskFromNamedParams(
       datastore: datastore,
       encodedKey: encodedKey,
       branch: branch,
       name: taskName,
       sha: sha,
       slug: slug,
     );
     final Commit commit = await _getCommitFromTask(datastore, task);
     sha ??= commit.id!.split('/').last;
     taskName ??= task.name;

     final CiYaml ciYaml = await scheduler.getCiYaml(commit);
     final Target target = ciYaml.postsubmitTargets.singleWhere((Target target) => target.value.name == task.name);

     // Prepares Firestore task.
     firestore.Task? taskDocument;
     if (taskDocumentName == null) {
       final int currentAttempt = task.attempts!;
       taskDocumentName = '$kDatabase/documents/${firestore.kTaskCollectionId}/${sha}_${taskName}_$currentAttempt';
     }
     taskDocument = await firestore.Task.fromFirestore(
       firestoreService: firestoreService,
       documentName: taskDocumentName,
     );

     final List<bbv2.StringPair> tags = <bbv2.StringPair>[
       bbv2.StringPair(
         key: 'triggered_by',
         value: email,
       ),
       bbv2.StringPair(
         key: 'trigger_type',
         value: 'manual_retry',
       ),
     ];

     final bool isRerunning = await luciBuildService.checkRerunBuilder(
       commit: commit,
       task: task,
       target: target,
       datastore: datastore,
       tags: tags,
       ignoreChecks: ignoreChecks,
       firestoreService: firestoreService,
       taskDocument: taskDocument,
     );

     // For human retries from the dashboard, notify if a task failed to rerun.
     if (ignoreChecks && isRerunning == false) {
       throw InternalServerError('Failed to rerun $taskName');
     }
   }

   /// Retrieve [Task] from [DatastoreService] from either an encoded key or commit + task name info.
   ///
   /// If [encodedKey] is passed, [KeyHelper] will decode it directly and return the associated entity.
   ///
   /// Otherwise, [name], [branch], [sha], and [slug] must be passed to find the [Task].
   Future<Task> _getTaskFromNamedParams({
     required DatastoreService datastore,
     String? encodedKey,
     String? branch,
     String? name,
     String? sha,
     RepositorySlug? slug,
   }) async {
     if (encodedKey != null && encodedKey.isNotEmpty) {
       final Key<int> key = config.keyHelper.decode(encodedKey) as Key<int>;
       return datastore.lookupByValue<Task>(key);
     }
     final Key<String> commitKey = Commit.createKey(
       db: datastore.db,
       slug: slug!,
       gitBranch: branch!,
       sha: sha!,
     );
     return Task.fromDatastore(
       datastore: datastore,
       commitKey: commitKey,
       name: name!,
     );
   }

   /// Returns the [Commit] associated with [Task].
   Future<Commit> _getCommitFromTask(DatastoreService datastore, Task task) async {
     return (await datastore.lookupByKey<Commit>(<Key<dynamic>>[task.parentKey!])).single!;
   }
 }
	// Copyright 2020 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 'dart:async';

	import 'package:buildbucket/buildbucket_pb.dart' as bbv2;
	import 'package:cocoon_service/src/service/luci_build_service_v2.dart';
	import 'package:cocoon_service/src/service/scheduler_v2.dart';
	import 'package:gcloud/db.dart';
	import 'package:github/github.dart';
	import 'package:meta/meta.dart';

	import '../model/appengine/commit.dart';
	import '../model/appengine/key_helper.dart';
	import '../model/appengine/task.dart';
	import '../model/firestore/task.dart' as firestore;
	import '../model/ci_yaml/ci_yaml.dart';
	import '../model/ci_yaml/target.dart';
	import '../model/google/token_info.dart';
	import '../request_handling/api_request_handler.dart';
	import '../request_handling/body.dart';
	import '../request_handling/exceptions.dart';
	import '../service/config.dart';
	import '../service/datastore.dart';
	import '../service/firestore.dart';

	/// Reruns a postsubmit LUCI build.
	///
	/// Expects either [taskKeyParam] or a set of params that give enough detail to lookup a task in datastore.
	@immutable
	class ResetProdTaskV2 extends ApiRequestHandler<Body> {
	const ResetProdTaskV2({
	required super.config,
	required super.authenticationProvider,
	required this.luciBuildService,
	required this.scheduler,
	@visibleForTesting DatastoreServiceProvider? datastoreProvider,
	}) : datastoreProvider = datastoreProvider ?? DatastoreService.defaultProvider;

	final DatastoreServiceProvider datastoreProvider;
	final LuciBuildServiceV2 luciBuildService;
	final SchedulerV2 scheduler;

	static const String branchParam = 'Branch';
	static const String taskKeyParam = 'Key';
	static const String ownerParam = 'Owner';
	static const String repoParam = 'Repo';
	static const String commitShaParam = 'Commit';
	static const String taskDocumentNameParam = 'taskDocumentName';

	/// Name of the task to be retried.
	///
	/// If "all" is given, all failed tasks will be retried. This enables
	/// oncalls to quickly recover a commit without the tedium of the UI.
	static const String taskParam = 'Task';

	@override
	Future<Body> post() async {
	final DatastoreService datastore = datastoreProvider(config.db);
	final FirestoreService firestoreService = await config.createFirestoreService();
	final String? encodedKey = requestData![taskKeyParam] as String?;
	String? branch = requestData![branchParam] as String?;
	final String owner = requestData![ownerParam] as String? ?? 'flutter';
	final String? repo = requestData![repoParam] as String?;
	final String? sha = requestData![commitShaParam] as String?;
	final TokenInfo token = await tokenInfo(request!);
	final String? taskName = requestData![taskParam] as String?;
	// When Frontend is switched to Firstore, the task document name will be passed over.
	final String? taskDocumentName = requestData![taskDocumentNameParam] as String?;

	RepositorySlug? slug;
	if (encodedKey != null && encodedKey.isNotEmpty) {
	// Check params required for dashboard.
	checkRequiredParameters(<String>[taskKeyParam]);
	} else {
	// Checks params required when this API is called with curl.
	checkRequiredParameters(<String>[commitShaParam, taskParam, repoParam]);
	slug = RepositorySlug(owner, repo!);
	branch ??= Config.defaultBranch(slug);
	}

	if (taskName == 'all') {
	final Key<String> commitKey = Commit.createKey(
	db: datastore.db,
	slug: slug!,
	gitBranch: branch!,
	sha: sha!,
	);
	final List<Task> tasks = await datastore.db.query<Task>(ancestorKey: commitKey).run().toList();
	final List<Future<void>> futures = <Future<void>>[];
	for (final Task task in tasks) {
	if (!Task.taskFailStatusSet.contains(task.status)) continue;
	futures.add(
	rerun(
	datastore: datastore,
	firestoreService: firestoreService,
	branch: branch,
	sha: sha,
	taskName: task.name,
	slug: slug,
	email: token.email!,
	),
	);
	}
	await Future.wait(futures);
	} else {
	await rerun(
	datastore: datastore,
	firestoreService: firestoreService,
	encodedKey: encodedKey,
	branch: branch,
	sha: sha,
	taskName: taskName,
	taskDocumentName: taskDocumentName,
	slug: slug,
	email: token.email!,
	ignoreChecks: true,
	);
	}

	return Body.empty;
	}

	Future<void> rerun({
	required DatastoreService datastore,
	required FirestoreService firestoreService,
	String? encodedKey,
	String? branch,
	String? sha,
	String? taskName,
	RepositorySlug? slug,
	String? taskDocumentName,
	required String email,
	bool ignoreChecks = false,
	}) async {
	// Prepares Datastore task.
	final Task task = await _getTaskFromNamedParams(
	datastore: datastore,
	encodedKey: encodedKey,
	branch: branch,
	name: taskName,
	sha: sha,
	slug: slug,
	);
	final Commit commit = await _getCommitFromTask(datastore, task);
	sha ??= commit.id!.split('/').last;
	taskName ??= task.name;

	final CiYaml ciYaml = await scheduler.getCiYaml(commit);
	final Target target = ciYaml.postsubmitTargets.singleWhere((Target target) => target.value.name == task.name);

	// Prepares Firestore task.
	firestore.Task? taskDocument;
	if (taskDocumentName == null) {
	final int currentAttempt = task.attempts!;
	taskDocumentName = '$kDatabase/documents/${firestore.kTaskCollectionId}/${sha}_${taskName}_$currentAttempt';
	}
	taskDocument = await firestore.Task.fromFirestore(
	firestoreService: firestoreService,
	documentName: taskDocumentName,
	);

	final List<bbv2.StringPair> tags = <bbv2.StringPair>[
	bbv2.StringPair(
	key: 'triggered_by',
	value: email,
	),
	bbv2.StringPair(
	key: 'trigger_type',
	value: 'manual_retry',
	),
	];

	final bool isRerunning = await luciBuildService.checkRerunBuilder(
	commit: commit,
	task: task,
	target: target,
	datastore: datastore,
	tags: tags,
	ignoreChecks: ignoreChecks,
	firestoreService: firestoreService,
	taskDocument: taskDocument,
	);

	// For human retries from the dashboard, notify if a task failed to rerun.
	if (ignoreChecks && isRerunning == false) {
	throw InternalServerError('Failed to rerun $taskName');
	}
	}

	/// Retrieve [Task] from [DatastoreService] from either an encoded key or commit + task name info.
	///
	/// If [encodedKey] is passed, [KeyHelper] will decode it directly and return the associated entity.
	///
	/// Otherwise, [name], [branch], [sha], and [slug] must be passed to find the [Task].
	Future<Task> _getTaskFromNamedParams({
	required DatastoreService datastore,
	String? encodedKey,
	String? branch,
	String? name,
	String? sha,
	RepositorySlug? slug,
	}) async {
	if (encodedKey != null && encodedKey.isNotEmpty) {
	final Key<int> key = config.keyHelper.decode(encodedKey) as Key<int>;
	return datastore.lookupByValue<Task>(key);
	}
	final Key<String> commitKey = Commit.createKey(
	db: datastore.db,
	slug: slug!,
	gitBranch: branch!,
	sha: sha!,
	);
	return Task.fromDatastore(
	datastore: datastore,
	commitKey: commitKey,
	name: name!,
	);
	}

	/// Returns the [Commit] associated with [Task].
	Future<Commit> _getCommitFromTask(DatastoreService datastore, Task task) async {
	return (await datastore.lookupByKey<Commit>(<Key<dynamic>>[task.parentKey!])).single!;
	}
	}