@autofleet/network 1.7.1 → 1.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.cjs ADDED
@@ -0,0 +1,3 @@
1
+ 'use strict';var node_module=require('node:module'),y=require('axios'),p=require('axios-retry'),d=require('@autofleet/logger'),A=require('deepmerge'),R=require('@autofleet/axios-cache-adapter'),agentkeepalive=require('agentkeepalive');var _documentCurrentScript=typeof document!=='undefined'?document.currentScript:null;function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var y__default=/*#__PURE__*/_interopDefault(y);var p__default=/*#__PURE__*/_interopDefault(p);var d__default=/*#__PURE__*/_interopDefault(d);var A__default=/*#__PURE__*/_interopDefault(A);var R__default=/*#__PURE__*/_interopDefault(R);var {setup:b}=R__default.default,E=node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))),u,T=(...s)=>(u??=E("qs").stringify,u(...s)),I=["get","post","delete","head","put","patch","options"],S={arrayFormat:"brackets"},w={timeout:1e4,headers:{"X-AF-AUTH":"ANYONE","X-IAF-ORIGIN-SERVICE":process.env.AF_SERVICE_NAME||null},paramsSerializer:s=>T(s,S),"axios-retry":{shouldResetTimeout:true},keepAlive:true},l=s=>`[${(s.method||"").toUpperCase()}] ${s.baseURL??"unknown-base-url"}${s.url??"/unknown-url"}`,g=Number.parseInt(process.env.FREE_SOCKET_TIMEOUT,10)||5e3,c=class{constructor(e={}){this.settings=A__default.default(w,e),this.settings.keepAlive&&(this.settings.httpAgent=new agentkeepalive.HttpAgent({freeSocketTimeout:g}),this.settings.httpsAgent=new agentkeepalive.HttpsAgent({freeSocketTimeout:g}),delete this.settings.keepAlive),this.#s(),e.cache&&(this.settings.cache={maxAge:15*60*1e3,exclude:{query:false},...e.cache}),this.axios=e.cache?b(this.settings):y__default.default.create(this.settings),this.#e(e),this.#i(),this.#t();}#e(e){p__default.default(this.axios,{retries:0,retryDelay:p__default.default.exponentialDelay,...e});}#t(){let e=this.settings.logger??d__default.default();this.axios.interceptors.request.use(t=>(e.info(`Start Request: ${l(t)}`),t)),this.axios.interceptors.response.use(t=>(e.info(`Finish Request: ${l(t.config)}`),t),t=>{if(t.request?._currentRequest?.reusedSocket&&["ECONNRESET","EPIPE"].includes(t.code))return e.warn(`${t.code} issue, will retry`,{req:t.request._currentRequest._currentUrl}),this.axios.request(t.config);let i=t.config?.baseURL?t.config:t.request;throw e.error(`Finish Request with error ${i?l(i):""}`,{status:t.status,data:t.response?.data}),t});}#s(){if(!this.settings.serviceUrl&&!this.settings.serviceName)throw new Error("At least one of the settings Missing serviceUrl or serviceName");let{settings:e}=this;if(e.serviceUrl)e.baseURL=e.serviceUrl;else if(e.serviceName){let t=`${e.serviceName}_SERVICE_HOST`;if(e.baseURL=`http://${process.env[t]}`,!e.baseURL)throw new Error(`Missing environment variable: ${t}`)}}#i(){I.forEach(e=>{this[e]=async(...t)=>this.axios[e](...t);});}async getAllPages(e,t={}){let i=[],n=null,o=null,r={params:{page:1},...t};for(;(r.params.page===1||o===n)&&o!==0;){let{data:a}=await this.get(e,r);o=a.length,r.params.page===1&&(n=a.length),r.params.page+=1,Array.prototype.push.apply(i,a);}return i}async getAllPagesFromQueryEndpoint(e,t={},i=100){let n=[],o=true,r=1;for(;o&&(i===-1||r<i);){let{data:a}=await this.post(e,{...t,page:r}),{rows:h,count:f}=a;r+=1,Array.prototype.push.apply(n,h),o=n.length<f;}return n}};
2
+ module.exports=c;//# sourceMappingURL=index.cjs.map
3
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":["setup","axiosCacheAdapter","safeRequire","createRequire","qsStringify","lazilyLoadQsStringify","args","HTTPMethods","qsStringifyOptions","defaultSettings","params","createRequestString","request","FREE_SOCKET_TIMEOUT","Network","settings","merge","HttpAgent","HttpsAgent","#createBaseUrl","axios","#addRetry","#buildClassHttpMethods","#addLogs","axiosRetry","logger","Logger","response","error","envServiceHostName","method","url","options","currentResult","resultsInFirstPage","lastResultsSize","localOptions","data","pageLimit","moreResultsToLoad","page","rows","count"],"mappings":"4mBASA,IAAM,CAAE,KAAA,CAAAA,CAAM,CAAA,CAAIC,mBACZC,CAAcC,CAAAA,yBAAAA,CAAc,2PAAe,CAE7CC,CAAAA,CAAAA,CACEC,CAAwB,CAAA,CAAA,GAAIC,CAChCF,IAAAA,CAAAA,GAAgBF,CAAY,CAAA,IAAI,CAAE,CAAA,SAAA,CAC3BE,CAAY,CAAA,GAAGE,CAAI,CAGtBC,CAAAA,CAAAA,CAAAA,CAAc,CAClB,KAAA,CACA,MACA,CAAA,QAAA,CACA,MACA,CAAA,KAAA,CACA,OACA,CAAA,SACF,CAEMC,CAAAA,CAAAA,CAAmE,CAAE,WAAA,CAAa,UAAW,CAAA,CAS7FC,EAAmC,CACvC,OAAA,CAAS,GACT,CAAA,OAAA,CAAS,CACP,WAAA,CAAa,QACb,CAAA,sBAAA,CAAwB,OAAQ,CAAA,GAAA,CAAI,eAAmB,EAAA,IACzD,CACA,CAAA,gBAAA,CAAkBC,CAAUL,EAAAA,CAAAA,CAAsBK,EAAQF,CAAkB,CAAA,CAC5E,aAAe,CAAA,CACb,kBAAoB,CAAA,IACtB,CACA,CAAA,SAAA,CAAW,IACb,CAAA,CAEMG,CAAuBC,CAAAA,CAAAA,EAAwC,CAAKA,CAAAA,EAAAA,CAAAA,CAAAA,CAAQ,MAAU,EAAA,EAAA,EAAI,aAAa,CAAA,EAAA,EAAKA,CAAQ,CAAA,OAAA,EAAW,kBAAkB,CAAA,EAAGA,CAAQ,CAAA,GAAA,EAAO,cAAc,CAAA,CAAA,CAWjLC,CAAsB,CAAA,MAAA,CAAO,QAAS,CAAA,OAAA,CAAQ,GAAI,CAAA,mBAAA,CAAqB,EAAE,CAAK,EAAA,GAAA,CAE/DC,CAArB,CAAA,KAA6B,CAY3B,WAAA,CAAYC,CAA4B,CAAA,GAAI,CAC1C,IAAA,CAAK,QAAWC,CAAAA,kBAAAA,CAAMP,CAAiBM,CAAAA,CAAQ,CAC3C,CAAA,IAAA,CAAK,SAAS,SAChB,GAAA,IAAA,CAAK,QAAS,CAAA,SAAA,CAAY,IAAIE,wBAAAA,CAAU,CAAE,iBAAA,CAAmBJ,CAAoB,CAAC,CAClF,CAAA,IAAA,CAAK,QAAS,CAAA,UAAA,CAAa,IAAIK,yBAAAA,CAAW,CAAE,iBAAmBL,CAAAA,CAAoB,CAAC,CAAA,CACpF,OAAO,IAAA,CAAK,QAAS,CAAA,SAAA,CAAA,CAEvB,IAAKM,CAAAA,EAAAA,EAEFJ,CAAAA,CAAAA,CAAS,KACV,GAAA,IAAA,CAAK,QAAS,CAAA,KAAA,CAAQ,CACpB,MAAQ,CAAA,EAAA,CAAK,EAAK,CAAA,GAAA,CAElB,OAAS,CAAA,CAAE,KAAO,CAAA,KAAM,CACxB,CAAA,GAAGA,CAAS,CAAA,KACd,CAGF,CAAA,CAAA,IAAA,CAAK,KAAQA,CAAAA,CAAAA,CAAS,MAAQf,CAAM,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAIoB,kBAAM,CAAA,MAAA,CAAO,IAAK,CAAA,QAAQ,CAC/E,CAAA,IAAA,CAAKC,EAAUN,CAAAA,CAAQ,CACvB,CAAA,IAAA,CAAKO,EAAuB,EAAA,CAC5B,KAAKC,EAAS,GAChB,CAEAF,EAAAA,CAAUN,CAAiC,CAAA,CACzCS,kBAAW,CAAA,IAAA,CAAK,KAAO,CAAA,CACrB,OAAS,CAAA,CAAA,CACT,UAAYA,CAAAA,kBAAAA,CAAW,gBACvB,CAAA,GAAGT,CACL,CAAC,EACH,CAEAQ,EAAAA,EAAiB,CACf,IAAME,CAAS,CAAA,IAAA,CAAK,QAAS,CAAA,MAAA,EAAUC,kBAAO,EAAA,CAC9C,IAAK,CAAA,KAAA,CAAM,YAAa,CAAA,OAAA,CAAQ,IAAKd,CACnCa,GAAAA,CAAAA,CAAO,IAAK,CAAA,CAAA,eAAA,EAAkBd,CAAoBC,CAAAA,CAAO,CAAC,CAAA,CAAE,CACrDA,CAAAA,CAAAA,CACR,CAED,CAAA,IAAA,CAAK,KAAM,CAAA,YAAA,CAAa,QAAS,CAAA,GAAA,CAAKe,IACpCF,CAAO,CAAA,IAAA,CAAK,CAAmBd,gBAAAA,EAAAA,CAAAA,CAAoBgB,CAAS,CAAA,MAAM,CAAC,CAAA,CAAE,EAC9DA,CACLC,CAAAA,CAAAA,CAAAA,EAAU,CACZ,GAAGA,CAAM,CAAA,OAAA,EAAS,eAAiB,EAAA,YAAA,EAAgB,CAAC,YAAc,CAAA,OAAO,CAAE,CAAA,QAAA,CAASA,CAAM,CAAA,IAAI,CAI5F,CAAA,OAAAH,CAAO,CAAA,IAAA,CAAK,CAAGG,EAAAA,CAAAA,CAAM,IAAI,CAAA,kBAAA,CAAA,CAAsB,CAC7C,GAAA,CAAKA,EAAM,OAAQ,CAAA,eAAA,CAAgB,WAErC,CAAC,CACM,CAAA,IAAA,CAAK,KAAM,CAAA,OAAA,CAAQA,CAAM,CAAA,MAAM,CAExC,CAAA,IAAMhB,CAAUgB,CAAAA,CAAAA,CAAM,MAAQ,EAAA,OAAA,CAAUA,EAAM,MAASA,CAAAA,CAAAA,CAAM,OAC7D,CAAA,MAAAH,CAAO,CAAA,KAAA,CAAM,CAA6Bb,0BAAAA,EAAAA,CAAAA,CAAUD,CAAoBC,CAAAA,CAAO,CAAI,CAAA,EAAE,CAAI,CAAA,CAAA,CACvF,MAAQgB,CAAAA,CAAAA,CAAM,OACd,IAAMA,CAAAA,CAAAA,CAAM,QAAU,EAAA,IACxB,CAAC,CAAA,CACKA,CACR,CAAC,EACH,CAEAT,EAAuB,EAAA,CACrB,GAAI,CAAC,IAAK,CAAA,QAAA,CAAS,YAAc,CAAC,IAAA,CAAK,QAAS,CAAA,WAAA,CAC9C,MAAM,IAAI,KAAM,CAAA,gEAAgE,CAGlF,CAAA,GAAM,CAAE,QAAA,CAAAJ,CAAS,CAAA,CAAI,IACrB,CAAA,GAAIA,EAAS,UACXA,CAAAA,CAAAA,CAAS,OAAUA,CAAAA,CAAAA,CAAS,UACnBA,CAAAA,KAAAA,GAAAA,CAAAA,CAAS,WAAa,CAAA,CAC/B,IAAMc,CAAAA,CAAqB,CAAGd,EAAAA,CAAAA,CAAS,WAAW,CAAA,aAAA,CAAA,CAElD,GADAA,CAAAA,CAAS,QAAU,CAAU,OAAA,EAAA,OAAA,CAAQ,GAAIc,CAAAA,CAAkB,CAAC,CAAA,CAAA,CACxD,CAACd,CAAAA,CAAS,OACZ,CAAA,MAAM,IAAI,KAAA,CAAM,CAAiCc,8BAAAA,EAAAA,CAAkB,CAAE,CAAA,CAEzE,CACF,CAKAP,EAAAA,EAA+B,CAC7Bf,CAAAA,CAAY,OAASuB,CAAAA,CAAAA,EAAW,CAC9B,IAAA,CAAKA,CAAM,CAAI,CAAA,MAAA,GAAyCxB,CAA+D,GAAA,IAAA,CAAK,KAAMwB,CAAAA,CAAM,CAAE,CAAA,GAAGxB,CAA6C,EAC5L,CAAC,EACH,CAOA,MAAa,WAAA,CAAeyB,CAAaC,CAAAA,CAAAA,CAAkB,EAAC,CAAiB,CAC3E,IAAIC,CAAqB,CAAA,EACrBC,CAAAA,CAAAA,CAAoC,KACpCC,CAAiC,CAAA,IAAA,CAE/BC,CAAe,CAAA,CAAE,MAAQ,CAAA,CAAE,IAAM,CAAA,CAAE,CAAG,CAAA,GAAGJ,CAAQ,CAAA,CACvD,KAAQI,CAAAA,CAAAA,CAAa,MAAO,CAAA,IAAA,GAAS,GAAKD,CAAoBD,GAAAA,CAAAA,GAAuBC,CAAoB,GAAA,CAAA,EAAG,CAC1G,GAAM,CAAE,IAAA,CAAAE,CAAK,CAAA,CAAI,MAAM,IAAA,CAAK,GAASN,CAAAA,CAAAA,CAAKK,CAAY,CAAA,CACtDD,EAAkBE,CAAK,CAAA,MAAA,CACnBD,CAAa,CAAA,MAAA,CAAO,IAAS,GAAA,CAAA,GAC/BF,CAAqBG,CAAAA,CAAAA,CAAK,QAG5BD,CAAa,CAAA,MAAA,CAAO,IAAQ,EAAA,CAAA,CAC5B,KAAM,CAAA,SAAA,CAAU,IAAK,CAAA,KAAA,CAAMH,EAAeI,CAAI,EAChD,CAEA,OAAOJ,CACT,CAWA,MAAa,4BAAA,CAAgCF,CAAaC,CAAAA,CAAAA,CAAkB,EAAC,CAAGM,CAAoB,CAAA,GAAA,CAAmB,CACrH,IAAIL,EAAqB,EAAC,CAEtBM,CAAoB,CAAA,IAAA,CACpBC,CAAO,CAAA,CAAA,CACX,KAAOD,CAAAA,GAAsBD,CAAc,GAAA,EAAA,EAAME,CAAOF,CAAAA,CAAAA,CAAAA,EAAY,CAClE,GAAM,CAAE,IAAA,CAAAD,CAAK,CAAI,CAAA,MAAM,IAAK,CAAA,IAAA,CAAoCN,CAAK,CAAA,CACnE,GAAGC,CAAAA,CACH,IAAAQ,CAAAA,CACF,CAAC,CAAA,CACK,CAAE,IAAA,CAAAC,CAAM,CAAA,KAAA,CAAAC,CAAM,CAAIL,CAAAA,CAAAA,CACxBG,CAAQ,EAAA,CAAA,CACR,KAAM,CAAA,SAAA,CAAU,IAAK,CAAA,KAAA,CAAMP,EAAeQ,CAAI,CAAA,CAC9CF,CAAoBN,CAAAA,CAAAA,CAAc,MAASS,CAAAA,EAC7C,CAEA,OAAOT,CACT,CACF","file":"index.cjs","sourcesContent":["import { createRequire } from 'node:module';\nimport axios, { type CreateAxiosDefaults, type AxiosRequestConfig, type AxiosInstance, type AxiosResponse } from 'axios';\nimport axiosRetry, { type IAxiosRetryConfig } from 'axios-retry';\nimport Logger from '@autofleet/logger';\nimport merge from 'deepmerge';\nimport axiosCacheAdapter from '@autofleet/axios-cache-adapter';\nimport { HttpAgent, HttpsAgent } from 'agentkeepalive';\nimport type { stringify } from 'qs';\n\nconst { setup } = axiosCacheAdapter;\nconst safeRequire = createRequire(import.meta.url);\n\nlet qsStringify: typeof stringify | undefined;\nconst lazilyLoadQsStringify = (...args: Parameters<typeof stringify>) => {\n qsStringify ??= safeRequire('qs').stringify;\n return qsStringify(...args);\n}\n\nconst HTTPMethods = [\n 'get',\n 'post',\n 'delete',\n 'head',\n 'put',\n 'patch',\n 'options',\n] as const;\n\nconst qsStringifyOptions: NonNullable<Parameters<typeof stringify>[1]> = { arrayFormat: 'brackets' };\n\ninterface NetworkSettings extends CreateAxiosDefaults, IAxiosRetryConfig {\n serviceName?: string;\n serviceUrl?: string;\n keepAlive?: boolean;\n logger?: import('@autofleet/logger').LoggerInstanceManager;\n}\n\nconst defaultSettings: NetworkSettings = {\n timeout: 10_000,\n headers: {\n 'X-AF-AUTH': 'ANYONE',\n 'X-IAF-ORIGIN-SERVICE': process.env.AF_SERVICE_NAME || null,\n },\n paramsSerializer: params => lazilyLoadQsStringify(params, qsStringifyOptions),\n 'axios-retry': {\n shouldResetTimeout: true,\n },\n keepAlive: true,\n};\n\nconst createRequestString = (request: AxiosRequestConfig): string => `[${(request.method || '').toUpperCase()}] ${request.baseURL ?? 'unknown-base-url'}${request.url ?? '/unknown-url'}`;\n\n/*\n The default free socket keepalive timeout, in milliseconds.\n Setting to 5000 (5 seconds) as default because out grace period is 10 seconds\n and we want to make sure we don't have any socket issues.\n See https://www.npmjs.com/package/agentkeepalive\n\n There is also autoscaling reason for that, if we don't timeout at some point,\n new pods that were auto scaled will not be used.\n*/\nconst FREE_SOCKET_TIMEOUT = Number.parseInt(process.env.FREE_SOCKET_TIMEOUT, 10) || 5_000;\n\nexport default class Network {\n private readonly settings: NetworkSettings;\n private readonly axios: AxiosInstance;\n\n public get: AxiosInstance['get'];\n public post: AxiosInstance['post'];\n public delete: AxiosInstance['delete'];\n public head: AxiosInstance['head'];\n public put: AxiosInstance['put'];\n public patch: AxiosInstance['patch'];\n public options: AxiosInstance['options'];\n\n constructor(settings: NetworkSettings = {}) {\n this.settings = merge(defaultSettings, settings);\n if (this.settings.keepAlive) {\n this.settings.httpAgent = new HttpAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });\n this.settings.httpsAgent = new HttpsAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });\n delete this.settings.keepAlive;\n }\n this.#createBaseUrl();\n\n if(settings.cache) {\n this.settings.cache = {\n maxAge: 15 * 60 * 1000,\n // Store responses from requests with query parameters in cache\n exclude: { query: false },\n ...settings.cache,\n }\n }\n\n this.axios = settings.cache ? setup(this.settings) : axios.create(this.settings);\n this.#addRetry(settings);\n this.#buildClassHttpMethods();\n this.#addLogs();\n }\n\n #addRetry(settings: NetworkSettings): void {\n axiosRetry(this.axios, {\n retries: 0,\n retryDelay: axiosRetry.exponentialDelay,\n ...settings,\n });\n }\n\n #addLogs(): void {\n const logger = this.settings.logger ?? Logger();\n this.axios.interceptors.request.use((request) => {\n logger.info(`Start Request: ${createRequestString(request)}`);\n return request;\n });\n\n this.axios.interceptors.response.use((response) => {\n logger.info(`Finish Request: ${createRequestString(response.config)}`);\n return response;\n }, (error) => {\n if(error.request?._currentRequest?.reusedSocket && ['ECONNRESET', 'EPIPE'].includes(error.code)) {\n // See https://www.npmjs.com/package/agentkeepalive\n // Support req.reusedSocket\n // https://code-examples.net/en/q/28a8069\n logger.warn(`${error.code} issue, will retry`, {\n req: error.request._currentRequest._currentUrl,\n // method: error.request._currentRequest._options.method,\n })\n return this.axios.request(error.config);\n }\n const request = error.config?.baseURL ? error.config : error.request;\n logger.error(`Finish Request with error ${request ? createRequestString(request) : ''}`, {\n status: error.status,\n data: error.response?.data,\n });\n throw error;\n });\n }\n\n #createBaseUrl(): void {\n if (!this.settings.serviceUrl && !this.settings.serviceName) {\n throw new Error('At least one of the settings Missing serviceUrl or serviceName');\n }\n\n const { settings } = this;\n if (settings.serviceUrl) {\n settings.baseURL = settings.serviceUrl;\n } else if (settings.serviceName) {\n const envServiceHostName = `${settings.serviceName}_SERVICE_HOST`;\n settings.baseURL = `http://${process.env[envServiceHostName]}`;\n if (!settings.baseURL) {\n throw new Error(`Missing environment variable: ${envServiceHostName}`);\n }\n }\n }\n\n /**\n * Build class methods that wrap axios methods\n */\n #buildClassHttpMethods(): void {\n HTTPMethods.forEach((method) => {\n this[method] = async <T = any, R = AxiosResponse<T>>(...args: Parameters<AxiosInstance[typeof method]>): Promise<R> => this.axios[method](...args as [url: string, leaveUsAlone?: unknown]);\n });\n }\n\n /**\n * @param url The endpoint URL to send the request to.\n * @param options Additional options to include in the request payload.\n * @returns A promise that resolves to an array of all results.\n */\n public async getAllPages<T>(url: string, options: object = {}): Promise<T[]> {\n let currentResult: T[] = [];\n let resultsInFirstPage: number | null = null;\n let lastResultsSize: number | null = null;\n\n const localOptions = { params: { page: 1 }, ...options };\n while ((localOptions.params.page === 1 || lastResultsSize === resultsInFirstPage) && lastResultsSize !== 0) {\n const { data } = await this.get<T[]>(url, localOptions);\n lastResultsSize = data.length;\n if (localOptions.params.page === 1) {\n resultsInFirstPage = data.length;\n }\n\n localOptions.params.page += 1;\n Array.prototype.push.apply(currentResult, data);\n }\n\n return currentResult;\n }\n\n /**\n * Fetches all pages from a paginated API endpoint until all results are retrieved \n * or an optional page limit is reached.\n *\n * @param url The endpoint URL to send the request to.\n * @param options Additional options to include in the request payload.\n * @param pageLimit The maximum number of pages to fetch. Set to -1 for no limit.\n * @returns A promise that resolves to an array of all results.\n */\n public async getAllPagesFromQueryEndpoint<T>(url: string, options: object = {}, pageLimit: number = 100): Promise<T[]> {\n let currentResult: T[] = [];\n\n let moreResultsToLoad = true;\n let page = 1;\n while (moreResultsToLoad && (pageLimit === -1 || page < pageLimit)) {\n const { data } = await this.post<{ rows: T[]; count: number; }>(url, {\n ...options,\n page,\n });\n const { rows, count } = data;\n page += 1;\n Array.prototype.push.apply(currentResult, rows);\n moreResultsToLoad = currentResult.length < count;\n }\n\n return currentResult;\n }\n};\n"]}
@@ -0,0 +1,27 @@
1
+ import * as _autofleet_logger from '@autofleet/logger';
2
+ import { AxiosInstance, CreateAxiosDefaults } from 'axios';
3
+ import { IAxiosRetryConfig } from 'axios-retry';
4
+
5
+ interface NetworkSettings extends CreateAxiosDefaults, IAxiosRetryConfig {
6
+ serviceName?: string;
7
+ serviceUrl?: string;
8
+ keepAlive?: boolean;
9
+ logger?: _autofleet_logger.LoggerInstanceManager;
10
+ }
11
+ declare class Network {
12
+ #private;
13
+ private readonly settings;
14
+ private readonly axios;
15
+ get: AxiosInstance['get'];
16
+ post: AxiosInstance['post'];
17
+ delete: AxiosInstance['delete'];
18
+ head: AxiosInstance['head'];
19
+ put: AxiosInstance['put'];
20
+ patch: AxiosInstance['patch'];
21
+ options: AxiosInstance['options'];
22
+ constructor(settings?: NetworkSettings);
23
+ getAllPages<T>(url: string, options?: object): Promise<T[]>;
24
+ getAllPagesFromQueryEndpoint<T>(url: string, options?: object, pageLimit?: number): Promise<T[]>;
25
+ }
26
+
27
+ export { Network as default };
package/lib/index.d.ts ADDED
@@ -0,0 +1,27 @@
1
+ import * as _autofleet_logger from '@autofleet/logger';
2
+ import { AxiosInstance, CreateAxiosDefaults } from 'axios';
3
+ import { IAxiosRetryConfig } from 'axios-retry';
4
+
5
+ interface NetworkSettings extends CreateAxiosDefaults, IAxiosRetryConfig {
6
+ serviceName?: string;
7
+ serviceUrl?: string;
8
+ keepAlive?: boolean;
9
+ logger?: _autofleet_logger.LoggerInstanceManager;
10
+ }
11
+ declare class Network {
12
+ #private;
13
+ private readonly settings;
14
+ private readonly axios;
15
+ get: AxiosInstance['get'];
16
+ post: AxiosInstance['post'];
17
+ delete: AxiosInstance['delete'];
18
+ head: AxiosInstance['head'];
19
+ put: AxiosInstance['put'];
20
+ patch: AxiosInstance['patch'];
21
+ options: AxiosInstance['options'];
22
+ constructor(settings?: NetworkSettings);
23
+ getAllPages<T>(url: string, options?: object): Promise<T[]>;
24
+ getAllPagesFromQueryEndpoint<T>(url: string, options?: object, pageLimit?: number): Promise<T[]>;
25
+ }
26
+
27
+ export { Network as default };
package/lib/index.js ADDED
@@ -0,0 +1,3 @@
1
+ import {createRequire}from'node:module';import y from'axios';import p from'axios-retry';import d from'@autofleet/logger';import A from'deepmerge';import R from'@autofleet/axios-cache-adapter';import {HttpAgent,HttpsAgent}from'agentkeepalive';var {setup:b}=R,E=createRequire(import.meta.url),u,T=(...s)=>(u??=E("qs").stringify,u(...s)),I=["get","post","delete","head","put","patch","options"],S={arrayFormat:"brackets"},w={timeout:1e4,headers:{"X-AF-AUTH":"ANYONE","X-IAF-ORIGIN-SERVICE":process.env.AF_SERVICE_NAME||null},paramsSerializer:s=>T(s,S),"axios-retry":{shouldResetTimeout:true},keepAlive:true},l=s=>`[${(s.method||"").toUpperCase()}] ${s.baseURL??"unknown-base-url"}${s.url??"/unknown-url"}`,g=Number.parseInt(process.env.FREE_SOCKET_TIMEOUT,10)||5e3,c=class{constructor(e={}){this.settings=A(w,e),this.settings.keepAlive&&(this.settings.httpAgent=new HttpAgent({freeSocketTimeout:g}),this.settings.httpsAgent=new HttpsAgent({freeSocketTimeout:g}),delete this.settings.keepAlive),this.#s(),e.cache&&(this.settings.cache={maxAge:15*60*1e3,exclude:{query:false},...e.cache}),this.axios=e.cache?b(this.settings):y.create(this.settings),this.#e(e),this.#i(),this.#t();}#e(e){p(this.axios,{retries:0,retryDelay:p.exponentialDelay,...e});}#t(){let e=this.settings.logger??d();this.axios.interceptors.request.use(t=>(e.info(`Start Request: ${l(t)}`),t)),this.axios.interceptors.response.use(t=>(e.info(`Finish Request: ${l(t.config)}`),t),t=>{if(t.request?._currentRequest?.reusedSocket&&["ECONNRESET","EPIPE"].includes(t.code))return e.warn(`${t.code} issue, will retry`,{req:t.request._currentRequest._currentUrl}),this.axios.request(t.config);let i=t.config?.baseURL?t.config:t.request;throw e.error(`Finish Request with error ${i?l(i):""}`,{status:t.status,data:t.response?.data}),t});}#s(){if(!this.settings.serviceUrl&&!this.settings.serviceName)throw new Error("At least one of the settings Missing serviceUrl or serviceName");let{settings:e}=this;if(e.serviceUrl)e.baseURL=e.serviceUrl;else if(e.serviceName){let t=`${e.serviceName}_SERVICE_HOST`;if(e.baseURL=`http://${process.env[t]}`,!e.baseURL)throw new Error(`Missing environment variable: ${t}`)}}#i(){I.forEach(e=>{this[e]=async(...t)=>this.axios[e](...t);});}async getAllPages(e,t={}){let i=[],n=null,o=null,r={params:{page:1},...t};for(;(r.params.page===1||o===n)&&o!==0;){let{data:a}=await this.get(e,r);o=a.length,r.params.page===1&&(n=a.length),r.params.page+=1,Array.prototype.push.apply(i,a);}return i}async getAllPagesFromQueryEndpoint(e,t={},i=100){let n=[],o=true,r=1;for(;o&&(i===-1||r<i);){let{data:a}=await this.post(e,{...t,page:r}),{rows:h,count:f}=a;r+=1,Array.prototype.push.apply(n,h),o=n.length<f;}return n}};
2
+ export{c as default};//# sourceMappingURL=index.js.map
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":["setup","axiosCacheAdapter","safeRequire","createRequire","qsStringify","lazilyLoadQsStringify","args","HTTPMethods","qsStringifyOptions","defaultSettings","params","createRequestString","request","FREE_SOCKET_TIMEOUT","Network","settings","merge","HttpAgent","HttpsAgent","#createBaseUrl","axios","#addRetry","#buildClassHttpMethods","#addLogs","axiosRetry","logger","Logger","response","error","envServiceHostName","method","url","options","currentResult","resultsInFirstPage","lastResultsSize","localOptions","data","pageLimit","moreResultsToLoad","page","rows","count"],"mappings":"kPASA,IAAM,CAAE,KAAA,CAAAA,CAAM,CAAA,CAAIC,EACZC,CAAcC,CAAAA,aAAAA,CAAc,MAAY,CAAA,IAAA,CAAA,GAAG,CAE7CC,CAAAA,CAAAA,CACEC,CAAwB,CAAA,CAAA,GAAIC,CAChCF,IAAAA,CAAAA,GAAgBF,CAAY,CAAA,IAAI,CAAE,CAAA,SAAA,CAC3BE,CAAY,CAAA,GAAGE,CAAI,CAGtBC,CAAAA,CAAAA,CAAAA,CAAc,CAClB,KAAA,CACA,MACA,CAAA,QAAA,CACA,MACA,CAAA,KAAA,CACA,OACA,CAAA,SACF,CAEMC,CAAAA,CAAAA,CAAmE,CAAE,WAAA,CAAa,UAAW,CAAA,CAS7FC,EAAmC,CACvC,OAAA,CAAS,GACT,CAAA,OAAA,CAAS,CACP,WAAA,CAAa,QACb,CAAA,sBAAA,CAAwB,OAAQ,CAAA,GAAA,CAAI,eAAmB,EAAA,IACzD,CACA,CAAA,gBAAA,CAAkBC,CAAUL,EAAAA,CAAAA,CAAsBK,EAAQF,CAAkB,CAAA,CAC5E,aAAe,CAAA,CACb,kBAAoB,CAAA,IACtB,CACA,CAAA,SAAA,CAAW,IACb,CAAA,CAEMG,CAAuBC,CAAAA,CAAAA,EAAwC,CAAKA,CAAAA,EAAAA,CAAAA,CAAAA,CAAQ,MAAU,EAAA,EAAA,EAAI,aAAa,CAAA,EAAA,EAAKA,CAAQ,CAAA,OAAA,EAAW,kBAAkB,CAAA,EAAGA,CAAQ,CAAA,GAAA,EAAO,cAAc,CAAA,CAAA,CAWjLC,CAAsB,CAAA,MAAA,CAAO,QAAS,CAAA,OAAA,CAAQ,GAAI,CAAA,mBAAA,CAAqB,EAAE,CAAK,EAAA,GAAA,CAE/DC,CAArB,CAAA,KAA6B,CAY3B,WAAA,CAAYC,CAA4B,CAAA,GAAI,CAC1C,IAAA,CAAK,QAAWC,CAAAA,CAAAA,CAAMP,CAAiBM,CAAAA,CAAQ,CAC3C,CAAA,IAAA,CAAK,SAAS,SAChB,GAAA,IAAA,CAAK,QAAS,CAAA,SAAA,CAAY,IAAIE,SAAAA,CAAU,CAAE,iBAAA,CAAmBJ,CAAoB,CAAC,CAClF,CAAA,IAAA,CAAK,QAAS,CAAA,UAAA,CAAa,IAAIK,UAAAA,CAAW,CAAE,iBAAmBL,CAAAA,CAAoB,CAAC,CAAA,CACpF,OAAO,IAAA,CAAK,QAAS,CAAA,SAAA,CAAA,CAEvB,IAAKM,CAAAA,EAAAA,EAEFJ,CAAAA,CAAAA,CAAS,KACV,GAAA,IAAA,CAAK,QAAS,CAAA,KAAA,CAAQ,CACpB,MAAQ,CAAA,EAAA,CAAK,EAAK,CAAA,GAAA,CAElB,OAAS,CAAA,CAAE,KAAO,CAAA,KAAM,CACxB,CAAA,GAAGA,CAAS,CAAA,KACd,CAGF,CAAA,CAAA,IAAA,CAAK,KAAQA,CAAAA,CAAAA,CAAS,MAAQf,CAAM,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAIoB,CAAM,CAAA,MAAA,CAAO,IAAK,CAAA,QAAQ,CAC/E,CAAA,IAAA,CAAKC,EAAUN,CAAAA,CAAQ,CACvB,CAAA,IAAA,CAAKO,EAAuB,EAAA,CAC5B,KAAKC,EAAS,GAChB,CAEAF,EAAAA,CAAUN,CAAiC,CAAA,CACzCS,CAAW,CAAA,IAAA,CAAK,KAAO,CAAA,CACrB,OAAS,CAAA,CAAA,CACT,UAAYA,CAAAA,CAAAA,CAAW,gBACvB,CAAA,GAAGT,CACL,CAAC,EACH,CAEAQ,EAAAA,EAAiB,CACf,IAAME,CAAS,CAAA,IAAA,CAAK,QAAS,CAAA,MAAA,EAAUC,CAAO,EAAA,CAC9C,IAAK,CAAA,KAAA,CAAM,YAAa,CAAA,OAAA,CAAQ,IAAKd,CACnCa,GAAAA,CAAAA,CAAO,IAAK,CAAA,CAAA,eAAA,EAAkBd,CAAoBC,CAAAA,CAAO,CAAC,CAAA,CAAE,CACrDA,CAAAA,CAAAA,CACR,CAED,CAAA,IAAA,CAAK,KAAM,CAAA,YAAA,CAAa,QAAS,CAAA,GAAA,CAAKe,IACpCF,CAAO,CAAA,IAAA,CAAK,CAAmBd,gBAAAA,EAAAA,CAAAA,CAAoBgB,CAAS,CAAA,MAAM,CAAC,CAAA,CAAE,EAC9DA,CACLC,CAAAA,CAAAA,CAAAA,EAAU,CACZ,GAAGA,CAAM,CAAA,OAAA,EAAS,eAAiB,EAAA,YAAA,EAAgB,CAAC,YAAc,CAAA,OAAO,CAAE,CAAA,QAAA,CAASA,CAAM,CAAA,IAAI,CAI5F,CAAA,OAAAH,CAAO,CAAA,IAAA,CAAK,CAAGG,EAAAA,CAAAA,CAAM,IAAI,CAAA,kBAAA,CAAA,CAAsB,CAC7C,GAAA,CAAKA,EAAM,OAAQ,CAAA,eAAA,CAAgB,WAErC,CAAC,CACM,CAAA,IAAA,CAAK,KAAM,CAAA,OAAA,CAAQA,CAAM,CAAA,MAAM,CAExC,CAAA,IAAMhB,CAAUgB,CAAAA,CAAAA,CAAM,MAAQ,EAAA,OAAA,CAAUA,EAAM,MAASA,CAAAA,CAAAA,CAAM,OAC7D,CAAA,MAAAH,CAAO,CAAA,KAAA,CAAM,CAA6Bb,0BAAAA,EAAAA,CAAAA,CAAUD,CAAoBC,CAAAA,CAAO,CAAI,CAAA,EAAE,CAAI,CAAA,CAAA,CACvF,MAAQgB,CAAAA,CAAAA,CAAM,OACd,IAAMA,CAAAA,CAAAA,CAAM,QAAU,EAAA,IACxB,CAAC,CAAA,CACKA,CACR,CAAC,EACH,CAEAT,EAAuB,EAAA,CACrB,GAAI,CAAC,IAAK,CAAA,QAAA,CAAS,YAAc,CAAC,IAAA,CAAK,QAAS,CAAA,WAAA,CAC9C,MAAM,IAAI,KAAM,CAAA,gEAAgE,CAGlF,CAAA,GAAM,CAAE,QAAA,CAAAJ,CAAS,CAAA,CAAI,IACrB,CAAA,GAAIA,EAAS,UACXA,CAAAA,CAAAA,CAAS,OAAUA,CAAAA,CAAAA,CAAS,UACnBA,CAAAA,KAAAA,GAAAA,CAAAA,CAAS,WAAa,CAAA,CAC/B,IAAMc,CAAAA,CAAqB,CAAGd,EAAAA,CAAAA,CAAS,WAAW,CAAA,aAAA,CAAA,CAElD,GADAA,CAAAA,CAAS,QAAU,CAAU,OAAA,EAAA,OAAA,CAAQ,GAAIc,CAAAA,CAAkB,CAAC,CAAA,CAAA,CACxD,CAACd,CAAAA,CAAS,OACZ,CAAA,MAAM,IAAI,KAAA,CAAM,CAAiCc,8BAAAA,EAAAA,CAAkB,CAAE,CAAA,CAEzE,CACF,CAKAP,EAAAA,EAA+B,CAC7Bf,CAAAA,CAAY,OAASuB,CAAAA,CAAAA,EAAW,CAC9B,IAAA,CAAKA,CAAM,CAAI,CAAA,MAAA,GAAyCxB,CAA+D,GAAA,IAAA,CAAK,KAAMwB,CAAAA,CAAM,CAAE,CAAA,GAAGxB,CAA6C,EAC5L,CAAC,EACH,CAOA,MAAa,WAAA,CAAeyB,CAAaC,CAAAA,CAAAA,CAAkB,EAAC,CAAiB,CAC3E,IAAIC,CAAqB,CAAA,EACrBC,CAAAA,CAAAA,CAAoC,KACpCC,CAAiC,CAAA,IAAA,CAE/BC,CAAe,CAAA,CAAE,MAAQ,CAAA,CAAE,IAAM,CAAA,CAAE,CAAG,CAAA,GAAGJ,CAAQ,CAAA,CACvD,KAAQI,CAAAA,CAAAA,CAAa,MAAO,CAAA,IAAA,GAAS,GAAKD,CAAoBD,GAAAA,CAAAA,GAAuBC,CAAoB,GAAA,CAAA,EAAG,CAC1G,GAAM,CAAE,IAAA,CAAAE,CAAK,CAAA,CAAI,MAAM,IAAA,CAAK,GAASN,CAAAA,CAAAA,CAAKK,CAAY,CAAA,CACtDD,EAAkBE,CAAK,CAAA,MAAA,CACnBD,CAAa,CAAA,MAAA,CAAO,IAAS,GAAA,CAAA,GAC/BF,CAAqBG,CAAAA,CAAAA,CAAK,QAG5BD,CAAa,CAAA,MAAA,CAAO,IAAQ,EAAA,CAAA,CAC5B,KAAM,CAAA,SAAA,CAAU,IAAK,CAAA,KAAA,CAAMH,EAAeI,CAAI,EAChD,CAEA,OAAOJ,CACT,CAWA,MAAa,4BAAA,CAAgCF,CAAaC,CAAAA,CAAAA,CAAkB,EAAC,CAAGM,CAAoB,CAAA,GAAA,CAAmB,CACrH,IAAIL,EAAqB,EAAC,CAEtBM,CAAoB,CAAA,IAAA,CACpBC,CAAO,CAAA,CAAA,CACX,KAAOD,CAAAA,GAAsBD,CAAc,GAAA,EAAA,EAAME,CAAOF,CAAAA,CAAAA,CAAAA,EAAY,CAClE,GAAM,CAAE,IAAA,CAAAD,CAAK,CAAI,CAAA,MAAM,IAAK,CAAA,IAAA,CAAoCN,CAAK,CAAA,CACnE,GAAGC,CAAAA,CACH,IAAAQ,CAAAA,CACF,CAAC,CAAA,CACK,CAAE,IAAA,CAAAC,CAAM,CAAA,KAAA,CAAAC,CAAM,CAAIL,CAAAA,CAAAA,CACxBG,CAAQ,EAAA,CAAA,CACR,KAAM,CAAA,SAAA,CAAU,IAAK,CAAA,KAAA,CAAMP,EAAeQ,CAAI,CAAA,CAC9CF,CAAoBN,CAAAA,CAAAA,CAAc,MAASS,CAAAA,EAC7C,CAEA,OAAOT,CACT,CACF","file":"index.js","sourcesContent":["import { createRequire } from 'node:module';\nimport axios, { type CreateAxiosDefaults, type AxiosRequestConfig, type AxiosInstance, type AxiosResponse } from 'axios';\nimport axiosRetry, { type IAxiosRetryConfig } from 'axios-retry';\nimport Logger from '@autofleet/logger';\nimport merge from 'deepmerge';\nimport axiosCacheAdapter from '@autofleet/axios-cache-adapter';\nimport { HttpAgent, HttpsAgent } from 'agentkeepalive';\nimport type { stringify } from 'qs';\n\nconst { setup } = axiosCacheAdapter;\nconst safeRequire = createRequire(import.meta.url);\n\nlet qsStringify: typeof stringify | undefined;\nconst lazilyLoadQsStringify = (...args: Parameters<typeof stringify>) => {\n qsStringify ??= safeRequire('qs').stringify;\n return qsStringify(...args);\n}\n\nconst HTTPMethods = [\n 'get',\n 'post',\n 'delete',\n 'head',\n 'put',\n 'patch',\n 'options',\n] as const;\n\nconst qsStringifyOptions: NonNullable<Parameters<typeof stringify>[1]> = { arrayFormat: 'brackets' };\n\ninterface NetworkSettings extends CreateAxiosDefaults, IAxiosRetryConfig {\n serviceName?: string;\n serviceUrl?: string;\n keepAlive?: boolean;\n logger?: import('@autofleet/logger').LoggerInstanceManager;\n}\n\nconst defaultSettings: NetworkSettings = {\n timeout: 10_000,\n headers: {\n 'X-AF-AUTH': 'ANYONE',\n 'X-IAF-ORIGIN-SERVICE': process.env.AF_SERVICE_NAME || null,\n },\n paramsSerializer: params => lazilyLoadQsStringify(params, qsStringifyOptions),\n 'axios-retry': {\n shouldResetTimeout: true,\n },\n keepAlive: true,\n};\n\nconst createRequestString = (request: AxiosRequestConfig): string => `[${(request.method || '').toUpperCase()}] ${request.baseURL ?? 'unknown-base-url'}${request.url ?? '/unknown-url'}`;\n\n/*\n The default free socket keepalive timeout, in milliseconds.\n Setting to 5000 (5 seconds) as default because out grace period is 10 seconds\n and we want to make sure we don't have any socket issues.\n See https://www.npmjs.com/package/agentkeepalive\n\n There is also autoscaling reason for that, if we don't timeout at some point,\n new pods that were auto scaled will not be used.\n*/\nconst FREE_SOCKET_TIMEOUT = Number.parseInt(process.env.FREE_SOCKET_TIMEOUT, 10) || 5_000;\n\nexport default class Network {\n private readonly settings: NetworkSettings;\n private readonly axios: AxiosInstance;\n\n public get: AxiosInstance['get'];\n public post: AxiosInstance['post'];\n public delete: AxiosInstance['delete'];\n public head: AxiosInstance['head'];\n public put: AxiosInstance['put'];\n public patch: AxiosInstance['patch'];\n public options: AxiosInstance['options'];\n\n constructor(settings: NetworkSettings = {}) {\n this.settings = merge(defaultSettings, settings);\n if (this.settings.keepAlive) {\n this.settings.httpAgent = new HttpAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });\n this.settings.httpsAgent = new HttpsAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });\n delete this.settings.keepAlive;\n }\n this.#createBaseUrl();\n\n if(settings.cache) {\n this.settings.cache = {\n maxAge: 15 * 60 * 1000,\n // Store responses from requests with query parameters in cache\n exclude: { query: false },\n ...settings.cache,\n }\n }\n\n this.axios = settings.cache ? setup(this.settings) : axios.create(this.settings);\n this.#addRetry(settings);\n this.#buildClassHttpMethods();\n this.#addLogs();\n }\n\n #addRetry(settings: NetworkSettings): void {\n axiosRetry(this.axios, {\n retries: 0,\n retryDelay: axiosRetry.exponentialDelay,\n ...settings,\n });\n }\n\n #addLogs(): void {\n const logger = this.settings.logger ?? Logger();\n this.axios.interceptors.request.use((request) => {\n logger.info(`Start Request: ${createRequestString(request)}`);\n return request;\n });\n\n this.axios.interceptors.response.use((response) => {\n logger.info(`Finish Request: ${createRequestString(response.config)}`);\n return response;\n }, (error) => {\n if(error.request?._currentRequest?.reusedSocket && ['ECONNRESET', 'EPIPE'].includes(error.code)) {\n // See https://www.npmjs.com/package/agentkeepalive\n // Support req.reusedSocket\n // https://code-examples.net/en/q/28a8069\n logger.warn(`${error.code} issue, will retry`, {\n req: error.request._currentRequest._currentUrl,\n // method: error.request._currentRequest._options.method,\n })\n return this.axios.request(error.config);\n }\n const request = error.config?.baseURL ? error.config : error.request;\n logger.error(`Finish Request with error ${request ? createRequestString(request) : ''}`, {\n status: error.status,\n data: error.response?.data,\n });\n throw error;\n });\n }\n\n #createBaseUrl(): void {\n if (!this.settings.serviceUrl && !this.settings.serviceName) {\n throw new Error('At least one of the settings Missing serviceUrl or serviceName');\n }\n\n const { settings } = this;\n if (settings.serviceUrl) {\n settings.baseURL = settings.serviceUrl;\n } else if (settings.serviceName) {\n const envServiceHostName = `${settings.serviceName}_SERVICE_HOST`;\n settings.baseURL = `http://${process.env[envServiceHostName]}`;\n if (!settings.baseURL) {\n throw new Error(`Missing environment variable: ${envServiceHostName}`);\n }\n }\n }\n\n /**\n * Build class methods that wrap axios methods\n */\n #buildClassHttpMethods(): void {\n HTTPMethods.forEach((method) => {\n this[method] = async <T = any, R = AxiosResponse<T>>(...args: Parameters<AxiosInstance[typeof method]>): Promise<R> => this.axios[method](...args as [url: string, leaveUsAlone?: unknown]);\n });\n }\n\n /**\n * @param url The endpoint URL to send the request to.\n * @param options Additional options to include in the request payload.\n * @returns A promise that resolves to an array of all results.\n */\n public async getAllPages<T>(url: string, options: object = {}): Promise<T[]> {\n let currentResult: T[] = [];\n let resultsInFirstPage: number | null = null;\n let lastResultsSize: number | null = null;\n\n const localOptions = { params: { page: 1 }, ...options };\n while ((localOptions.params.page === 1 || lastResultsSize === resultsInFirstPage) && lastResultsSize !== 0) {\n const { data } = await this.get<T[]>(url, localOptions);\n lastResultsSize = data.length;\n if (localOptions.params.page === 1) {\n resultsInFirstPage = data.length;\n }\n\n localOptions.params.page += 1;\n Array.prototype.push.apply(currentResult, data);\n }\n\n return currentResult;\n }\n\n /**\n * Fetches all pages from a paginated API endpoint until all results are retrieved \n * or an optional page limit is reached.\n *\n * @param url The endpoint URL to send the request to.\n * @param options Additional options to include in the request payload.\n * @param pageLimit The maximum number of pages to fetch. Set to -1 for no limit.\n * @returns A promise that resolves to an array of all results.\n */\n public async getAllPagesFromQueryEndpoint<T>(url: string, options: object = {}, pageLimit: number = 100): Promise<T[]> {\n let currentResult: T[] = [];\n\n let moreResultsToLoad = true;\n let page = 1;\n while (moreResultsToLoad && (pageLimit === -1 || page < pageLimit)) {\n const { data } = await this.post<{ rows: T[]; count: number; }>(url, {\n ...options,\n page,\n });\n const { rows, count } = data;\n page += 1;\n Array.prototype.push.apply(currentResult, rows);\n moreResultsToLoad = currentResult.length < count;\n }\n\n return currentResult;\n }\n};\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@autofleet/network",
3
- "version": "1.7.1",
3
+ "version": "1.7.3",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "main": "./lib/index.cjs",
@@ -18,6 +18,9 @@
18
18
  }
19
19
  }
20
20
  },
21
+ "files": [
22
+ "lib"
23
+ ],
21
24
  "scripts": {
22
25
  "test": "tsx index.test.js",
23
26
  "build": "tsup"
package/src/index.ts DELETED
@@ -1,216 +0,0 @@
1
- import { createRequire } from 'node:module';
2
- import axios, { type CreateAxiosDefaults, type AxiosRequestConfig, type AxiosInstance, type AxiosResponse } from 'axios';
3
- import axiosRetry from 'axios-retry';
4
- import Logger from '@autofleet/logger';
5
- import merge from 'deepmerge';
6
- import axiosCacheAdapter from '@autofleet/axios-cache-adapter';
7
- import { HttpAgent, HttpsAgent } from 'agentkeepalive';
8
- import type { stringify } from 'qs';
9
-
10
- const { setup } = axiosCacheAdapter;
11
- const safeRequire = createRequire(import.meta.url);
12
-
13
- let qsStringify: typeof stringify | undefined;
14
- const lazilyLoadQsStringify = (...args: Parameters<typeof stringify>) => {
15
- qsStringify ??= safeRequire('qs').stringify;
16
- return qsStringify(...args);
17
- }
18
-
19
- const HTTPMethods = [
20
- 'get',
21
- 'post',
22
- 'delete',
23
- 'head',
24
- 'put',
25
- 'patch',
26
- 'options',
27
- ] as const;
28
-
29
- const qsStringifyOptions: NonNullable<Parameters<typeof stringify>[1]> = { arrayFormat: 'brackets' };
30
-
31
- interface NetworkSettings extends CreateAxiosDefaults {
32
- serviceName?: string;
33
- serviceUrl?: string;
34
- keepAlive?: boolean;
35
- logger?: import('@autofleet/logger').LoggerInstanceManager;
36
- }
37
-
38
- const defaultSettings: NetworkSettings = {
39
- timeout: 10_000,
40
- headers: {
41
- 'X-AF-AUTH': 'ANYONE',
42
- 'X-IAF-ORIGIN-SERVICE': process.env.AF_SERVICE_NAME || null,
43
- },
44
- paramsSerializer: params => lazilyLoadQsStringify(params, qsStringifyOptions),
45
- 'axios-retry': {
46
- shouldResetTimeout: true,
47
- },
48
- keepAlive: true,
49
- };
50
-
51
- const createRequestString = (request: AxiosRequestConfig): string => `[${(request.method || '').toUpperCase()}] ${request.baseURL ?? 'unknown-base-url'}${request.url ?? '/unknown-url'}`;
52
-
53
- /*
54
- The default free socket keepalive timeout, in milliseconds.
55
- Setting to 5000 (5 seconds) as default because out grace period is 10 seconds
56
- and we want to make sure we don't have any socket issues.
57
- See https://www.npmjs.com/package/agentkeepalive
58
-
59
- There is also autoscaling reason for that, if we don't timeout at some point,
60
- new pods that were auto scaled will not be used.
61
- */
62
- const FREE_SOCKET_TIMEOUT = Number.parseInt(process.env.FREE_SOCKET_TIMEOUT, 10) || 5_000;
63
-
64
- export default class Network {
65
- private readonly settings: NetworkSettings;
66
- private readonly axios: AxiosInstance;
67
-
68
- public get: AxiosInstance['get'];
69
- public post: AxiosInstance['post'];
70
- public delete: AxiosInstance['delete'];
71
- public head: AxiosInstance['head'];
72
- public put: AxiosInstance['put'];
73
- public patch: AxiosInstance['patch'];
74
- public options: AxiosInstance['options'];
75
-
76
- constructor(settings: NetworkSettings = {}) {
77
- this.settings = merge(defaultSettings, settings);
78
- if (this.settings.keepAlive) {
79
- this.settings.httpAgent = new HttpAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });
80
- this.settings.httpsAgent = new HttpsAgent({ freeSocketTimeout: FREE_SOCKET_TIMEOUT });
81
- delete this.settings.keepAlive;
82
- }
83
- this.#createBaseUrl();
84
-
85
- if(settings.cache) {
86
- this.settings.cache = {
87
- maxAge: 15 * 60 * 1000,
88
- // Store responses from requests with query parameters in cache
89
- exclude: { query: false },
90
- ...settings.cache,
91
- }
92
- }
93
-
94
- this.axios = settings.cache ? setup(this.settings) : axios.create(this.settings);
95
- this.#addRetry(settings);
96
- this.#buildClassHttpMethods();
97
- this.#addLogs();
98
- }
99
-
100
- #addRetry(settings: NetworkSettings): void {
101
- axiosRetry(this.axios, {
102
- retries: 0,
103
- retryDelay: axiosRetry.exponentialDelay,
104
- ...settings,
105
- });
106
- }
107
-
108
- #addLogs(): void {
109
- const logger = this.settings.logger ?? Logger();
110
- this.axios.interceptors.request.use((request) => {
111
- logger.info(`Start Request: ${createRequestString(request)}`);
112
- return request;
113
- });
114
-
115
- this.axios.interceptors.response.use((response) => {
116
- logger.info(`Finish Request: ${createRequestString(response.config)}`);
117
- return response;
118
- }, (error) => {
119
- if(error.request?._currentRequest?.reusedSocket && ['ECONNRESET', 'EPIPE'].includes(error.code)) {
120
- // See https://www.npmjs.com/package/agentkeepalive
121
- // Support req.reusedSocket
122
- // https://code-examples.net/en/q/28a8069
123
- logger.warn(`${error.code} issue, will retry`, {
124
- req: error.request._currentRequest._currentUrl,
125
- // method: error.request._currentRequest._options.method,
126
- })
127
- return this.axios.request(error.config);
128
- }
129
- const request = error.config?.baseURL ? error.config : error.request;
130
- logger.error(`Finish Request with error ${request ? createRequestString(request) : ''}`, {
131
- status: error.status,
132
- data: error.response?.data,
133
- });
134
- throw error;
135
- });
136
- }
137
-
138
- #createBaseUrl(): void {
139
- if (!this.settings.serviceUrl && !this.settings.serviceName) {
140
- throw new Error('At least one of the settings Missing serviceUrl or serviceName');
141
- }
142
-
143
- const { settings } = this;
144
- if (settings.serviceUrl) {
145
- settings.baseURL = settings.serviceUrl;
146
- } else if (settings.serviceName) {
147
- const envServiceHostName = `${settings.serviceName}_SERVICE_HOST`;
148
- settings.baseURL = `http://${process.env[envServiceHostName]}`;
149
- if (!settings.baseURL) {
150
- throw new Error(`Missing environment variable: ${envServiceHostName}`);
151
- }
152
- }
153
- }
154
-
155
- /**
156
- * Build class methods that wrap axios methods
157
- */
158
- #buildClassHttpMethods(): void {
159
- HTTPMethods.forEach((method) => {
160
- this[method] = async <T = any, R = AxiosResponse<T>>(...args: Parameters<AxiosInstance[typeof method]>): Promise<R> => this.axios[method](...args as [url: string, leaveUsAlone?: unknown]);
161
- });
162
- }
163
-
164
- /**
165
- * @param url The endpoint URL to send the request to.
166
- * @param options Additional options to include in the request payload.
167
- * @returns A promise that resolves to an array of all results.
168
- */
169
- public async getAllPages<T>(url: string, options: object = {}): Promise<T[]> {
170
- let currentResult: T[] = [];
171
- let resultsInFirstPage: number | null = null;
172
- let lastResultsSize: number | null = null;
173
-
174
- const localOptions = { params: { page: 1 }, ...options };
175
- while ((localOptions.params.page === 1 || lastResultsSize === resultsInFirstPage) && lastResultsSize !== 0) {
176
- const { data } = await this.get<T[]>(url, localOptions);
177
- lastResultsSize = data.length;
178
- if (localOptions.params.page === 1) {
179
- resultsInFirstPage = data.length;
180
- }
181
-
182
- localOptions.params.page += 1;
183
- Array.prototype.push.apply(currentResult, data);
184
- }
185
-
186
- return currentResult;
187
- }
188
-
189
- /**
190
- * Fetches all pages from a paginated API endpoint until all results are retrieved
191
- * or an optional page limit is reached.
192
- *
193
- * @param url The endpoint URL to send the request to.
194
- * @param options Additional options to include in the request payload.
195
- * @param pageLimit The maximum number of pages to fetch. Set to -1 for no limit.
196
- * @returns A promise that resolves to an array of all results.
197
- */
198
- public async getAllPagesFromQueryEndpoint<T>(url: string, options: object = {}, pageLimit: number = 100): Promise<T[]> {
199
- let currentResult: T[] = [];
200
-
201
- let moreResultsToLoad = true;
202
- let page = 1;
203
- while (moreResultsToLoad && (pageLimit === -1 || page < pageLimit)) {
204
- const { data } = await this.post<{ rows: T[]; count: number; }>(url, {
205
- ...options,
206
- page,
207
- });
208
- const { rows, count } = data;
209
- page += 1;
210
- Array.prototype.push.apply(currentResult, rows);
211
- moreResultsToLoad = currentResult.length < count;
212
- }
213
-
214
- return currentResult;
215
- }
216
- };
package/tsconfig.json DELETED
@@ -1,18 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "ES2020",
4
- "module": "ES2022",
5
- "moduleResolution": "node",
6
- "declaration": true,
7
- "outDir": "./lib",
8
- "esModuleInterop": true,
9
- "skipLibCheck": true,
10
- "experimentalDecorators": false,
11
- "emitDecoratorMetadata": false,
12
- "allowJs": true,
13
- "isolatedModules": true,
14
- "removeComments": true,
15
- },
16
- "include": ["src", "tsup.config.ts"],
17
- "exclude": ["node_modules"]
18
- }
package/tsup.config.ts DELETED
@@ -1,14 +0,0 @@
1
- import { defineConfig } from 'tsup';
2
-
3
- export default defineConfig((options) => ({
4
- entry: ['src/index.ts'],
5
- target: 'node18.0',
6
- dts: true,
7
- outDir: 'lib',
8
- format: ['esm', 'cjs'],
9
- clean: !options.watch,
10
- minify: !options.watch,
11
- removeNodeProtocol: false,
12
- treeshake: true,
13
- sourcemap: true,
14
- }));