Request retry strategy

type

server hook

The request retry strategy lets you retry failed requests. Use it for important requests.

Features

• Customize the number of retries or determine whether to retry based on conditions;

• Retry delay mechanism;

Usage

Basic usage

const { retry } = require('alova/server');
const { alovaInstance } = require('./api');

const request = alovaInstance.Get('/api/user');
const hookedMethod = retry(request);

retry's maximum request retry count defaults to 3, and each retry will be delayed by 1 second.

Set the maximum number of static retries

The maximum number of retries indicates the maximum number of times a request is retried after the first request fails. If the request succeeds during this period, it will stop retrying. The default maximum number of retries is 3 times, and you can customize the setting in the following way.

const hookedMethod = retry(request, {
  // ...
  // Set the maximum number of retries to 5
  retry: 5
});

Dynamically set the maximum number of retries

Sometimes you may want to determine whether to continue retrying based on a certain condition. In this case, you can set retry to a function that returns a boolean value to dynamically determine whether to continue retrying.

const hookedMethod = retry(request, {
  // ...
  // The first parameter is the last error instance, and the second parameter is the parameter passed in by send
  retry(error) {
    // If the request times out, continue to retry
    return /network timeout/i.test(error.message);
  }
});

Set the delay time

The default retry delay time is 1 second, and you can customize it in the following way.

retry(request, {
  // ...
  backoff: {
    // Set the delay time to 2 seconds
    delay: 2000
  }
});

Set an unfixed retry delay time

Sometimes you want each retry's delay to vary. You can set a delay growth multiple as follows, and the delay will increase exponentially with the number of retries.

retry(request, {
  // ...
  backoff: {
    delay: 2000,
    // When multiplier is set to 2, the first retry delay is 2 seconds, the second is 4 seconds, the third is 8 seconds, and so on.
    multiplier: 2
  }
});

You can even add a random jitter to each delay to make it less predictable.

retry(request, {
// ...
backoff: {
delay: 2000,
multiplier: 2,
/**
* The starting percentage value of the delay request jitter, ranging from 0-1
* When only startQuiver is set, endQuiver defaults to 1
* For example, if it is set to 0.5, it will add a random time of 50% to 100% to the current delay time
* If endQuiver has a value, the delay time will increase by a random value in the range of startQuiver and endQuiver
*/
startQuiver: 0.5,

/**
* The ending percentage value of the delay request jitter, ranging from 0-1
* When only endQuiver is set, startQuiver defaults to 0
* For example, if it is set to 0.8, it will add a random time of 0% to 80% to the current delay time
* If startQuiver has a value, the delay time will increase by a random value in the range of startQuiver and endQuiver
*/
endQuiver: 0.8;
}
});