Adobe I/O Lib Core Networking
npm install @adobe/aio-lib-core-networking
``bash`
$ npm install @adobe/aio-lib-core-networking
`javascript`
const { HttpExponentialBackoff, createFetch } = require('@adobe/aio-lib-core-networking')
const fetchRetry = new HttpExponentialBackoff()
const proxyFetch = createFetch()
2) Call methods using the initialized SDK
`javascript
const { HttpExponentialBackoff, createFetch } = require('@adobe/aio-lib-core-networking')
const fetchRetry = new HttpExponentialBackoff()
async function sdkTest() {
return new Promise((resolve, reject) => {
fetchRetry.exponentialBackoff(url, requestOptions, retryOptions, retryOn, retryDelay)
.then((response) => {
if (!response.ok) {
throw Error(reduceError(response))
}
resolve(response.json())
})
.catch(err => {
reject(
new codes.ERROR_GET_SOMETHING({ sdkDetails, messageValues: err }))
})
})
}
let proxyFetch
// this will get the proxy settings from the the HTTP_PROXY or HTTPS_PROXY environment variables, if set
proxyFetch = createFetch()
// this will use the passed in proxy settings. Embed basic auth in the url, if required
proxyFetch = createFetch({ proxyUrl: 'http://my.proxy:8080' })
// if the proxy settings are not passed in, and not available in the HTTP_PROXY or HTTPS_PROXY environment variables, it falls back to a simple fetch
const simpleFetch = createFetch()
`
This class provides methods to implement fetch with retries.
The retries use exponential backoff strategy
with defaults set to max of 3 retries and initial Delay as 100ms
This provides a wrapper for fetch that facilitates proxy auth authorization.
functionReturn the appropriate Fetch function depending on proxy settings.
numberParse the Retry-After header
Spec: https://tools.ietf.org/html/rfc7231#section-7.1.3
objectFetch Retry Options
objectProxy Auth Options
Kind: global class
* HttpExponentialBackoff
* [new HttpExponentialBackoff([options])](#new_HttpExponentialBackoff_new)
* [.exponentialBackoff(url, requestOptions, [retryOptions], [retryOn], [retryDelay])](#HttpExponentialBackoff+exponentialBackoff) ⇒ Promise.<Response>
| Param | Type | Description |
| --- | --- | --- |
| [options] | object | configuration options |
| [options.logLevel] | string | the log level to use (default: process.env.LOG_LEVEL or 'info') |
| [options.logRetryAfterSeconds] | number | the number of seconds after which to log a warning if the Retry-After header is greater than the number of seconds. Set to 0 to disable. |
Kind: instance method of HttpExponentialBackoff
Returns: Promise.<Response> - Promise object representing the http response
| Param | Type | Description |
| --- | --- | --- |
| url | string | endpoint url |
| requestOptions | object \| Request | request options |
| [retryOptions] | RetryOptions | (optional) retry options |
| [retryOn] | function \| Array | (optional) Function or Array. If provided, will be used instead of the default |
| [retryDelay] | function \| number | (optional) Function or number. If provided, will be used instead of the default |
Kind: global class
* ProxyFetch
* new ProxyFetch(proxyOptions)
* .fetch(resource, options) ⇒ Promise.<Response>
| Param | Type | Description |
| --- | --- | --- |
| proxyOptions | ProxyOptions | the auth options to connect with |
Kind: instance method of ProxyFetch
Returns: Promise.<Response> - Promise object representing the http response
| Param | Type | Description |
| --- | --- | --- |
| resource | string \| Request | the url or Request object to fetch from |
| options | object | the fetch options |
functionKind: global function
Returns: function - the Fetch API function
| Param | Type | Description |
| --- | --- | --- |
| [proxyOptions] | ProxyOptions | the proxy options |
numberKind: global function
Returns: number - Number of milliseconds to sleep until the next call to getEventsFromJournal
| Param | Type | Description |
| --- | --- | --- |
| header | string | Retry-After header value |
objectKind: global typedef
Properties
| Name | Type | Description |
| --- | --- | --- |
| maxRetries | number | the maximum number of retries to try (default:3) |
| initialDelayInMillis | number | the initial delay in milliseconds (default:100ms) |
| proxy | ProxyOptions | the (optional) proxy auth options |
objectKind: global typedef
Properties
| Name | Type | Description |
| --- | --- | --- |
| proxyUrl | string | the proxy's url |
| [username] | string | the username for basic auth |
| [password] | string | the password for basic auth |
| rejectUnauthorized | boolean | set to false to not reject unauthorized server certs |
| [logLevel] | string | the log level to use (default: process.env.LOG_LEVEL or 'info') |
`bash`
LOG_LEVEL=debug
Prepend the LOG_LEVEL environment variable and debug` value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.
Contributions are welcome! Read the Contributing Guide for more information.
This project is licensed under the Apache V2 License. See LICENSE for more information.