Merge pull request #2159 from skaut/fix-empty-batch

Fixed an error with empty batch request when trying to select root folder from a list of drives

Author: marekdedic

src/php/admin/settings-pages/basic/root-selection/class-list-ajax-endpoint.php

@@ -70,9 +70,7 @@ public static function ajax_handler_body() {
 		}
 
 		$path_ids = GET_Helpers::get_array_variable( 'path' );
-		API_Client::preamble();
-
-		$promise = Utils::all(
+		$promise  = Utils::all(
 			array(
 				'path'     => self::path_ids_to_names( $path_ids ),
 				'path_ids' => $path_ids,

src/php/class-api-client.php

@@ -144,7 +144,7 @@ public static function get_drive_client() {
 	 *
 	 * @return void
 	 */
-	public static function preamble() {
+	public static function initialize_batch() {
 		if ( ! is_null( self::$current_batch ) ) {
 			return;
 		}
@@ -163,7 +163,7 @@ public static function preamble() {
 	 *
 	 * @return PromiseInterface A promise that will be resolved in `$callback`.
 	 *
-	 * @throws Internal_Exception The method was called without the preamble.
+	 * @throws Internal_Exception The method was called without an initialized batch.
 	 */
 	public static function async_request( $request, $transform, $rejection_handler = null ) {
 		if ( null === self::$current_batch ) {
@@ -205,7 +205,7 @@ public static function async_paginated_request(
 		/**
 		 * Gets one page.
 		 *
-		 * @throws Internal_Exception The method was called without the preamble.
+		 * @throws Internal_Exception The method was called without an initialized batch.
 		 *
 		 * phpcs:disable SlevomatCodingStandard.PHP.DisallowReference.DisallowedInheritingVariableByReference
 		 */
@@ -261,21 +261,36 @@ public static function async_paginated_request(
 	}
 
 	/**
-	 * Executes all requests and resolves all promises.
+	 * Executes all queued requests and resolves all promises repeatedly until there is nothing to be done.
 	 *
 	 * @param array<int|string, PromiseInterface> $promises The promises to resolve and throw exceptions if they reject.
 	 *
 	 * @return array<int|string, mixed> A list of results from the promises. Is in the same format as the parameter `$promises`, i.e. if an associative array of promises is passed, an associative array of results will be returned.
 	 */
 	public static function execute( $promises = array() ) {
-		if ( is_null( self::$current_batch ) ) {
-			Utils::queue()->run();
+		self::execute_current_batch();
+		Utils::queue()->run();
+
+		if ( count( self::$pending_requests ) > 0 ) {
+			self::execute();
+		}
+
+		return Utils::all( $promises )->wait();
+	}
 
-			return Utils::all( $promises )->wait();
+	/**
+	 * Executes the current batch request and calls its callbacks
+	 *
+	 * @return void
+	 */
+	private static function execute_current_batch() {
+		$batch = self::$current_batch;
+
+		if ( is_null( $batch ) ) {
+			return;
 		}
 
-		$batch               = self::$current_batch;
-		self::$current_batch = self::get_drive_client()->createBatch();
+		self::$current_batch = null;
 		/**
 		 * The closure executes the batch and throws the exception if it is a rate limit exceeded exception (this is needed by the task runner).
 		 *
@@ -287,14 +302,14 @@ public static function execute( $promises = array() ) {
 			),
 			'Batch Drive call',
 			static function () use ( $batch ) {
-				// @phan-suppress-next-line PhanPossiblyNonClassMethodCall
 				$ret = $batch->execute();
 
 				foreach ( $ret as $response ) {
 					$exception = self::wrap_response_exception( $response );
 
 					if (
-						$response instanceof Google_Service_Exception && $exception instanceof API_Rate_Limit_Exception
+						$response instanceof Google_Service_Exception &&
+						$exception instanceof API_Rate_Limit_Exception
 					) {
 						throw $response;
 					}
@@ -304,22 +319,12 @@ static function () use ( $batch ) {
 			}
 		);
 		$responses = $task->run();
+		self::get_drive_client()->getClient()->setUseBatch( false );
 
 		foreach ( $responses as $key => $response ) {
 			call_user_func( self::$pending_requests[ $key ], $response );
 			unset( self::$pending_requests[ $key ] );
 		}
-
-		Utils::queue()->run();
-
-		if ( count( self::$pending_requests ) > 0 ) {
-			self::execute();
-		}
-
-		self::$current_batch = null;
-		self::get_drive_client()->getClient()->setUseBatch( false );
-
-		return Utils::all( $promises )->wait();
 	}
 
 	/**

src/php/class-api-facade.php

@@ -36,7 +36,7 @@ final class API_Facade {
 	 * @throws API_Exception|API_Rate_Limit_Exception A problem with the API.
 	 */
 	public static function get_directory_id( $parent_id, $name ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 		$params = array(
 			'fields'                    => 'files(id, name, mimeType, shortcutDetails(targetId))',
 			'includeItemsFromAllDrives' => true,
@@ -84,7 +84,7 @@ static function ( $response ) use ( $name ) {
 	 * @SuppressWarnings(PHPMD.ShortVariable)
 	 */
 	public static function get_drive_name( $id ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 
 		return API_Client::async_request(
 			// @phan-suppress-next-line PhanTypeMismatchArgument
@@ -119,7 +119,7 @@ static function ( $exception ) {
 	 * @SuppressWarnings(PHPMD.ShortVariable)
 	 */
 	public static function get_file_name( $id ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 
 		/**
 		 * `$transform` transforms the raw Google API response into the structured response this function returns.
@@ -163,7 +163,7 @@ static function ( $exception ) {
 	 * @SuppressWarnings(PHPMD.ShortVariable)
 	 */
 	public static function check_directory_in_directory( $id, $parent_id ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 
 		return API_Client::async_request(
 			// @phan-suppress-next-line PhanTypeMismatchArgument
@@ -218,7 +218,7 @@ static function ( $exception ) {
 	 * @throws API_Exception|API_Rate_Limit_Exception A problem with the API.
 	 */
 	public static function list_drives( $pagination_helper ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 
 		return API_Client::async_paginated_request(
 			static function ( $page_token ) {
@@ -316,7 +316,7 @@ public static function list_videos( $parent_id, $fields, $pagination_helper, $or
 	 * @throws Unsupported_Value_Exception A field that is not supported was passed in `$fields`.
 	 */
 	private static function list_files( $parent_id, $fields, $order_by, $pagination_helper, $mime_type_prefix ) {
-		API_Client::preamble();
+		API_Client::initialize_batch();
 
 		if ( ! $fields->check(
 			array(