add agent interceptor into global fetch instance (#48)

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0-alpha.1.ethers.6",
+  "version": "1.0.0-alpha.2.ethers.6",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",

src/index.ts

@@ -5,6 +5,7 @@ import URI from './specs/uri';
 import * as utils from './utils';
 import {
   BaseError,
+  createAgentAdapter,
   createCacheAdapter,
   fetch,
   getImageURI,
@@ -36,6 +37,9 @@ export class AvatarResolver implements AvatarResolver {
     if (options?.cache && options?.cache > 0) {
       createCacheAdapter(fetch, options?.cache);
     }
+    if (options?.agents) {
+      createAgentAdapter(fetch, options?.agents);
+    }
   }
 
   async getMetadata(ens: string) {

src/specs/erc1155.ts

@@ -1,6 +1,11 @@
 import { Contract, Provider } from 'ethers';
 import { Buffer } from 'buffer/';
-import { fetch, resolveURI } from '../utils';
+import {
+  createAgentAdapter,
+  createCacheAdapter,
+  fetch,
+  resolveURI,
+} from '../utils';
 import { AvatarResolverOpts } from '../types';
 
 const abi = [
@@ -26,6 +31,13 @@ export default class ERC1155 {
     tokenID: string,
     options?: AvatarResolverOpts
   ) {
+    if (options?.cache && options?.cache > 0) {
+      createCacheAdapter(fetch, options?.cache);
+    }
+    if (options?.agents) {
+      createAgentAdapter(fetch, options?.agents);
+    }
+
     // exclude opensea api which does not follow erc1155 spec
     const tokenIDHex = !tokenID.startsWith('https://api.opensea.io/')
       ? tokenID.replace('0x', '').padStart(64, '0')

src/specs/erc721.ts

@@ -1,6 +1,11 @@
 import { Contract, Provider } from 'ethers';
 import { Buffer } from 'buffer/';
-import { fetch, resolveURI } from '../utils';
+import {
+  createAgentAdapter,
+  createCacheAdapter,
+  fetch,
+  resolveURI,
+} from '../utils';
 import { AvatarResolverOpts } from '../types';
 
 const abi = [
@@ -16,6 +21,13 @@ export default class ERC721 {
     tokenID: string,
     options?: AvatarResolverOpts
   ) {
+    if (options?.cache && options?.cache > 0) {
+      createCacheAdapter(fetch, options?.cache);
+    }
+    if (options?.agents) {
+      createAgentAdapter(fetch, options?.agents);
+    }
+
     const contract = new Contract(contractAddress, abi, provider);
     const [tokenURI, owner] = await Promise.all([
       contract.tokenURI(tokenID),

src/specs/uri.ts

@@ -1,8 +1,21 @@
 import { AvatarResolverOpts } from '../types';
-import { fetch, isImageURI, resolveURI } from '../utils';
+import {
+  createAgentAdapter,
+  createCacheAdapter,
+  fetch,
+  isImageURI,
+  resolveURI,
+} from '../utils';
 
 export default class URI {
   async getMetadata(uri: string, options?: AvatarResolverOpts) {
+    if (options?.cache && options?.cache > 0) {
+      createCacheAdapter(fetch, options?.cache);
+    }
+    if (options?.agents) {
+      createAgentAdapter(fetch, options?.agents);
+    }
+
     const { uri: resolvedURI, isOnChain } = resolveURI(uri, options);
     if (isOnChain) {
       return resolvedURI;

src/types.ts

@@ -17,12 +17,18 @@ export type MarketplaceAPIKey = Partial<
   }
 >;
 
+export interface AxiosAgents {
+  httpAgent?: Function;
+  httpsAgent?: Function;
+}
+
 export interface AvatarResolverOpts {
   cache?: number;
   ipfs?: string;
   arweave?: string;
   apiKey?: MarketplaceAPIKey;
   urlDenyList?: string[];
+  agents?: AxiosAgents;
 }
 
 export interface AvatarRequestOpts {

src/utils/detectPlatform.ts

@@ -0,0 +1,4 @@
+const isBrowser: boolean =
+  typeof window !== 'undefined' && typeof window.document !== 'undefined';
+
+export { isBrowser };

src/utils/fetch.ts

@@ -1,4 +1,16 @@
 import axios, { Axios } from 'axios';
+import { isBrowser } from './detectPlatform';
+import { AxiosAgents } from '../types';
+
+export function createAgentAdapter(fetch: Axios, agents?: AxiosAgents) {
+  if (!isBrowser && agents && Object.values(agents || {}).length) {
+    fetch.interceptors.request.use(config => {
+      config.httpAgent = agents.httpAgent;
+      config.httpsAgent = agents.httpsAgent;
+      return config;
+    });
+  }
+}
 
 export function createCacheAdapter(fetch: Axios, ttl: number) {
   // creates cache adapter for axios
@@ -8,11 +20,22 @@ export function createCacheAdapter(fetch: Axios, ttl: number) {
   });
 }
 
-function createFetcher({ ttl }: { ttl?: number }) {
-  const _fetch = axios.create({ proxy: false });
+function createFetcher({
+  ttl,
+  agents,
+}: {
+  ttl?: number;
+  agents?: AxiosAgents;
+}) {
+  const _fetch = axios.create({
+    proxy: false,
+  });
   if (ttl && ttl > 0) {
     createCacheAdapter(_fetch, ttl);
   }
+  if (Object.values(agents || {}).length) {
+    createAgentAdapter(_fetch, agents);
+  }
   return _fetch;
 }
 

src/utils/index.ts

@@ -4,14 +4,15 @@ import { parseNFT } from './parseNFT';
 import { BaseError } from './error';
 import { convertToRawSVG, getImageURI } from './getImageURI';
 import { resolveURI } from './resolveURI';
-import { createCacheAdapter, fetch } from './fetch';
+import { createAgentAdapter, createCacheAdapter, fetch } from './fetch';
 import { isCID } from './isCID';
 import { isImageURI } from './isImageURI';
 
 export {
   BaseError,
   assert,
   convertToRawSVG,
+  createAgentAdapter,
   createCacheAdapter,
   fetch,
   getImageURI,