Axios client initial

.changeset/rude-carrots-repeat.md

@@ -0,0 +1,5 @@
+---
+'@gradientedge/axios-client': minor
+---
+
+Initial cut of axios-client package

packages/axios-client/README.md

@@ -0,0 +1,40 @@
+# `@gradientedge/axios-client`
+
+A simple factory function for creating an axios client for use in a nodejs environment. No
+options are required when calling the `getAxiosClient` function. In this case, default values
+will be used for the retry and HttpsAgent config.
+
+Note that no `HttpAgent` config is provided. We expect all requests to be made via SSL and
+therefore the only agent we care about is `HttpsAgent`.
+
+Minimal example:
+```typescript
+import { getAxiosClient } from '@gradientedge/axios-client'
+
+/**
+ * No options provided, so this will use the default retry and HttpsAgent configuration.
+ */
+const client = getAxiosClient()
+```
+
+Full config override example:
+```typescript
+import { getAxiosClient } from '@gradientedge/axios-client'
+
+const client = getAxiosClient({
+  httpsAgent: {
+    keepAlive: false,
+    timeout: 10000,
+    maxSockets: 40,
+    scheduling: 'lifo',
+
+  },
+  retry: {
+    delayMs: 100,
+    maxRetries: 5,  
+  }
+})
+```
+
+The `client` variable above is an [AxiosInstance](https://github.com/axios/axios/blob/master/index.d.ts#L235) 
+which gives you access to all the standard axios methods and functionality. 

packages/axios-client/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  verbose: true,
+  passWithNoTests: true,
+  rootDir: '.',
+  testMatch: ['**/__tests__/**/*.test.ts'],
+  testPathIgnorePatterns: ['node_modules/', 'dist/'],
+  setupFilesAfterEnv: ['jest-extended/all'],
+}

packages/axios-client/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@gradientedge/axios-client",
+  "version": "0.0.0",
+  "description": "Factory for creating an axios client object with built-in default keep-alive/retry mechanism",
+  "author": "Jimmy Thomson <[email protected]>",
+  "homepage": "https://github.com/gradientedge/common-utils#readme",
+  "license": "ISC",
+  "main": "dist/index",
+  "types": "dist/index",
+  "files": [
+    "dist",
+    "!dist/**/__tests__"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gradientedge/common-utils.git"
+  },
+  "scripts": {
+    "clean": "rimraf dist && rm -f tsconfig.tsbuildinfo",
+    "build": "tsc --build",
+    "build:watch": "tsc --build --incremental --watch",
+    "test": "pnpm test --workspace --filter @gradientedge/common-utils"
+  },
+  "bugs": {
+    "url": "https://github.com/gradientedge/common-utils/issues"
+  },
+  "dependencies": {
+    "axios": "^0.26.1",
+    "axios-retry": "^3.2.4",
+    "agentkeepalive": "^4.2.1"
+  },
+  "devDependencies": {}
+}

packages/axios-client/src/constants.ts

@@ -0,0 +1,14 @@
+import { RetryConfig } from './types'
+import { HttpsOptions } from 'agentkeepalive'
+
+export const DEFAULT_RETRY_CONFIG: RetryConfig = {
+  delayMs: 20,
+  maxRetries: 3,
+}
+
+export const DEFAULT_AGENT_CONFIG: HttpsOptions = {
+  keepAlive: true,
+  timeout: 5000,
+  maxSockets: 20,
+  scheduling: 'fifo',
+}

packages/axios-client/src/index.ts

@@ -0,0 +1,49 @@
+import { HttpsAgent } from 'agentkeepalive'
+import axios, { AxiosError } from 'axios'
+import axiosRetry, { isNetworkOrIdempotentRequestError } from 'axios-retry'
+import { RequestConfig } from './types'
+import { DEFAULT_AGENT_CONFIG, DEFAULT_RETRY_CONFIG } from './constants'
+
+/**
+ * Get an axios instance configured with the given retry mechanism
+ * and custom agent for socket re-use.
+ */
+export function getAxiosClient(options?: RequestConfig) {
+  const retry = options?.retry || DEFAULT_RETRY_CONFIG
+  const httpsAgent = new HttpsAgent({
+    ...DEFAULT_AGENT_CONFIG,
+    ...options?.httpsAgent,
+  })
+  const client = axios.create({
+    httpsAgent,
+    timeout: httpsAgent.options.timeout,
+  })
+
+  if (retry.maxRetries) {
+    axiosRetry(client, {
+      retries: retry.maxRetries,
+      retryDelay: getCalculateRetryDelayFn(retry.delayMs),
+      shouldResetTimeout: true,
+      retryCondition: function (error: AxiosError) {
+        // The error code for a timeout is ECONNABORTED. Default axios-retry
+        // behaviour doesn't consider timeouts 'retryable'.
+        return isRequestRetryable(error)
+      },
+    })
+  }
+
+  return client
+}
+
+export function getCalculateRetryDelayFn(delayMs: number) {
+  return (retryCount: number) => {
+    if (retryCount === 0) {
+      return 0
+    }
+    return delayMs * 2 ** (retryCount - 1)
+  }
+}
+
+export function isRequestRetryable(error: AxiosError) {
+  return isNetworkOrIdempotentRequestError(error) || (!error.response && error.code === 'ECONNABORTED')
+}

packages/axios-client/src/types.ts

@@ -0,0 +1,11 @@
+import { AgentOptions } from 'https'
+
+export interface RequestConfig {
+  httpsAgent: AgentOptions
+  retry: RetryConfig
+}
+
+export interface RetryConfig {
+  maxRetries: number
+  delayMs: number
+}

packages/axios-client/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}