Skip to content
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.

Sign up for GitHub

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

Core data: Fall back to default API batch size of 25. #39524

Closed
wants to merge 2 commits into from
Closed

Core data: Fall back to default API batch size of 25. #39524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f23f16
Core data: Fall back to default API batch size of 25.
dmsnell Mar 17, 2022
f930527
Handle failures in batch size fetching with the default batch size
dmsnell Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 49 additions & 13 deletions packages/core-data/src/batch/default-processor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,71 @@ import { chunk } from 'lodash';
*/
import apiFetch from '@wordpress/api-fetch';

/** How long to wait to hear back from the server for batch size before defaulting. */
const BATCH_SIZE_FETCH_TIMEOUT_MS = 1000;

/** Default value shipped with Core */
const DEFAULT_BATCH_SIZE = 25;

/**
* Maximum number of requests to place in a single batch request. Obtained by
* sending a preflight OPTIONS request to /batch/v1/.
*
* @type {number?}
* @type {number|null}
* @default 25 (set by Core)
*/
let maxItems = null;

/**
* Waits a given number of milliseconds then resolves.
*
* @param {number} msDelay How many milliseconds to wait before resolving.
*/
const wait = ( msDelay ) =>
new Promise( ( resolve ) => setTimeout( resolve, msDelay ) );

/**
* Returns the batching API batch size, updated from the server.
*
* @return {Promise<number>} How many API requests to send in one batch.
*/
const batchSize = async () => {
if ( null !== maxItems ) {
return maxItems;
}

const fetcher = apiFetch( { path: '/batch/v1', method: 'OPTIONS' } ).then(
( { endpoints } ) => {
try {
maxItems = endpoints[ 0 ].args.requests.maxItems;
} catch ( e ) {
// Catching and re-throwing in a new task lets us fall back
// to the default value while still surfacing the error.
// We do this so that we don't block the batched API calls.
setTimeout( () => {
throw e;
}, 0 );
}
}
);

await Promise.race( [ wait( BATCH_SIZE_FETCH_TIMEOUT_MS ), fetcher ] );

return maxItems ?? DEFAULT_BATCH_SIZE;
};

/**
* Default batch processor. Sends its input requests to /batch/v1.
*
* @param {Array} requests List of API requests to perform at once.
*
* @return {Promise} Promise that resolves to a list of objects containing
* either `output` (if that request was succesful) or `error`
* (if not ).
* @return {Promise} Resolves to a list of objects containing either
* `output` if that request was successful else `error`.
*/
export default async function defaultProcessor( requests ) {
if ( maxItems === null ) {
const preflightResponse = await apiFetch( {
path: '/batch/v1',
method: 'OPTIONS',
} );
maxItems = preflightResponse.endpoints[ 0 ].args.requests.maxItems;
}

const results = [];

for ( const batchRequests of chunk( requests, maxItems ) ) {
for ( const batchRequests of chunk( requests, await batchSize() ) ) {
const batchResponse = await apiFetch( {
path: '/batch/v1',
method: 'POST',
Expand Down