request-retry

Example

import { rpRetry } from '@mimik/request-retry';
or
import rp from '@mimik/request-retry';

request-retry~rpRetry(options) ⇒ Promise

Make a request with retries.

Kind: inner method of request-retry
Category: async
Throws:

• Error An error produced by getRichError, wrapping an error from request-promise or a TimeoutError.

The following properties may be added to the options object under the retry property:

• retries {int}: Maximum number of retries, independent of the retryStrategy. Default: 2. If the value is < 0 it is set to 0; if > 15 it is set to 15.
• delay {int}: Delay between retries in milliseconds when no delayStrategy is provided. Default: 1000. If the value is < 20 it is set to 20; if > 30000 it is set to 30000.
• delayStrategy {function}: A function that returns the delay (in milliseconds) to wait before the next retry. Signature: (nbRetry, err, options, correlationId). Must return a number > 0 and < 30000; otherwise delay is used.
• logLevel {object}: Controls logging behavior:
  • response: Log level for responses. Default: silly (invalid values fall back to silly).
  • error: Log level for errors. Default: silly (invalid values fall back to silly).
  • request: Log level for requests. Default: silly (invalid values fall back to silly).
  • responseDetails: Detail level when displaying the response: count, type, or full. Default: type (invalid values fall back to type).
  • responseName: Label associated with the response. Default: response (non-string or empty values fall back to response).
• timeout {int}: Request timeout (in seconds) applied to the initial request and all retries. If reached, a TimeoutError is thrown. Default: 50. Values < 10 are set to 10; values > 120 are set to 120.
• retryStrategy {function}: A function that decides whether to retry. Signature: (nbRetry, err, options, correlationId). Must return a boolean; otherwise it is ignored.

The following properties may be added to the options object under the metrics property:

• HTTPRequestDuration {function}: A prom-client metric function to measure request duration.
• url {string}: Optional URL label for the metric. If omitted, the request URL is used.

The default retryStrategy is:

defaultRetry = (...args) => {
  const { statusCode } = args[1]; // err
  // Retry on 5xx and 429. If there is no statusCode, retry unless it's an "Invalid URI" error.
  return (statusCode && (Math.floor(statusCode / 100) === 5 || statusCode === 429))
         || (!statusCode && !args[1].message.includes('Invalid URI'));
};

If logLevel is empty, requests and responses are logged at info, the response is logged with full details under the response property, and request errors generate a warn. If logLevel is provided but incomplete, the provided keys override the defaults.

If not already set, the User-Agent header is set to: mimik-{serverType}/{serverVersion}/{serverId} {architecture} {node}.

To ease migration from request-promise, the following adjustments are applied to options:

• uri takes precedence over url.
• If json is an object, body takes precedence over json; both are mapped to Axios data.
• qs is mapped to Axios params.

Requires: module:@mimik/sumologic-winston-logger, module:@mimik/response-helper
Fulfil: object - The Axios response when resolveWithFullResponse is true; otherwise response.data.

| Param | Type | Description | | --- | --- | --- | | options | object | Options for the request (similar to axios). The validateStatus option is disabled: an error is thrown for status codes outside [200, 300). An additional option, resolveWithFullResponse, controls the return shape: when true, the full Axios response object is returned; when false or omitted, only response.data is returned. |