feat(lookup-fn): added support for returning a single IP string inste…

…ad of a tuple
axios · Apr 25, 2023 · b6c089e · b6c089e
1 parent 544d3b5
commit b6c089e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/index.d.cts b/index.d.cts
@@ -374,7 +374,7 @@ declare namespace axios {
     formSerializer?: FormSerializerOptions;
     family?: 4 | 6 | undefined;
     lookup?: ((hostname: string, options: object, cb: (err: Error | null, address: string, family: number) => void) => void) |
-        ((hostname: string, options: object) => Promise<[address: string, family: number]>);
+        ((hostname: string, options: object) => Promise<[address: string, family: number] | string>);
   }
 
   interface HeadersDefaults {

diff --git a/index.d.ts b/index.d.ts
@@ -323,7 +323,7 @@ export interface AxiosRequestConfig<D = any> {
   formSerializer?: FormSerializerOptions;
   family?: 4 | 6 | undefined;
   lookup?: ((hostname: string, options: object, cb: (err: Error | null, address: string, family: number) => void) => void) |
-      ((hostname: string, options: object) => Promise<[address: string, family: number]>);
+      ((hostname: string, options: object) => Promise<[address: string, family: number] | string>);
 }
 
 export interface HeadersDefaults {

diff --git a/lib/adapters/http.js b/lib/adapters/http.js
@@ -117,7 +117,9 @@ export default isHttpAdapterSupported && function httpAdapter(config) {
 
     if (lookup && utils.isAsyncFn(lookup)) {
       lookup = callbackify(lookup, (entry) => {
-        if (!utils.isArray(entry)) {
+        if(utils.isString(entry)) {
+          entry = [entry, entry.indexOf('.') < 0 ? 6 : 4]
+        } else if (!utils.isArray(entry)) {
           throw new TypeError('lookup async function must return an array [ip: string, family: number]]')
         }
         return entry;

diff --git a/test/unit/adapters/http.js b/test/unit/adapters/http.js
@@ -1983,5 +1983,24 @@ describe('supports http with nodejs', function () {
 
       assert.strictEqual(data, payload);
     });
+
+    it('should support custom DNS lookup function that returns only IP address (async)', async function () {
+      server = await startHTTPServer(SERVER_HANDLER_STREAM_ECHO);
+
+      const payload = 'test';
+
+      let isCalled = false;
+
+      const {data} = await axios.post(`http://fake-name.axios:4444`, payload,{
+        lookup: async (hostname, opt) =>  {
+          isCalled = true;
+          return '127.0.0.1';
+        }
+      });
+
+      assert.ok(isCalled);
+
+      assert.strictEqual(data, payload);
+    });
   });
 });