@algolia/requester-node-http 5.0.0-alpha.1 → 5.0.0-alpha.4

package/dist/requester-node-http.cjs.js

@@ -18,9 +18,11 @@ function echoRequester(status = 200) {
 
 // Global agents allow us to reuse the TCP protocol with multiple clients
 const agentOptions = { keepAlive: true };
-const httpAgent = new http__default["default"].Agent(agentOptions);
-const httpsAgent = new https__default["default"].Agent(agentOptions);
-function createHttpRequester() {
+const defaultHttpAgent = new http__default["default"].Agent(agentOptions);
+const defaultHttpsAgent = new https__default["default"].Agent(agentOptions);
+function createHttpRequester({ agent: userGlobalAgent, httpAgent: userHttpAgent, httpsAgent: userHttpsAgent, requesterOptions = {}, } = {}) {
+    const httpAgent = userHttpAgent || userGlobalAgent || defaultHttpAgent;
+    const httpsAgent = userHttpsAgent || userGlobalAgent || defaultHttpsAgent;
     function send(request) {
         return new Promise((resolve) => {
             let responseTimeout;
@@ -33,9 +35,15 @@ function createHttpRequester() {
                 hostname: url$1.hostname,
                 path,
                 method: request.method,
-                headers: request.headers,
-                ...(url$1.port !== undefined ? { port: url$1.port || '' } : {}),
+                ...requesterOptions,
+                headers: {
+                    ...request.headers,
+                    ...requesterOptions.headers,
+                },
             };
+            if (url$1.port && !requesterOptions.port) {
+                options.port = url$1.port;
+            }
             const req = (url$1.protocol === 'https:' ? https__default["default"] : http__default["default"]).request(options, (response) => {
                 let contentBuffers = [];
                 response.on('data', (chunk) => {

package/dist/requester-node-http.esm.node.js

@@ -9,9 +9,11 @@ function echoRequester(status = 200) {
 
 // Global agents allow us to reuse the TCP protocol with multiple clients
 const agentOptions = { keepAlive: true };
-const httpAgent = new http.Agent(agentOptions);
-const httpsAgent = new https.Agent(agentOptions);
-function createHttpRequester() {
+const defaultHttpAgent = new http.Agent(agentOptions);
+const defaultHttpsAgent = new https.Agent(agentOptions);
+function createHttpRequester({ agent: userGlobalAgent, httpAgent: userHttpAgent, httpsAgent: userHttpsAgent, requesterOptions = {}, } = {}) {
+    const httpAgent = userHttpAgent || userGlobalAgent || defaultHttpAgent;
+    const httpsAgent = userHttpsAgent || userGlobalAgent || defaultHttpsAgent;
     function send(request) {
         return new Promise((resolve) => {
             let responseTimeout;
@@ -24,9 +26,15 @@ function createHttpRequester() {
                 hostname: url.hostname,
                 path,
                 method: request.method,
-                headers: request.headers,
-                ...(url.port !== undefined ? { port: url.port || '' } : {}),
+                ...requesterOptions,
+                headers: {
+                    ...request.headers,
+                    ...requesterOptions.headers,
+                },
             };
+            if (url.port && !requesterOptions.port) {
+                options.port = url.port;
+            }
             const req = (url.protocol === 'https:' ? https : http).request(options, (response) => {
                 let contentBuffers = [];
                 response.on('data', (chunk) => {

package/dist/src/createHttpRequester.d.ts

@@ -1,3 +1,16 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
 import type { Requester } from '@algolia/client-common';
-export declare function createHttpRequester(): Requester;
+export declare type CreateHttpRequesterOptions = Partial<{
+    agent: http.Agent | https.Agent;
+    httpAgent: http.Agent;
+    httpsAgent: https.Agent;
+    /**
+     * RequestOptions to be merged with the end request, it will override default options if provided.
+     */
+    requesterOptions: https.RequestOptions;
+}>;
+export declare function createHttpRequester({ agent: userGlobalAgent, httpAgent: userHttpAgent, httpsAgent: userHttpsAgent, requesterOptions, }?: CreateHttpRequesterOptions): Requester;
 //# sourceMappingURL=createHttpRequester.d.ts.map

package/dist/src/createHttpRequester.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createHttpRequester.d.ts","sourceRoot":"","sources":["../../../../packages/requester-node-http/src/createHttpRequester.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAc,SAAS,EAAY,MAAM,wBAAwB,CAAC;AAO9E,wBAAgB,mBAAmB,IAAI,SAAS,CAmF/C"}
+{"version":3,"file":"createHttpRequester.d.ts","sourceRoot":"","sources":["../../../../packages/requester-node-http/src/createHttpRequester.ts"],"names":[],"mappings":";;AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,KAAK,EAAc,SAAS,EAAY,MAAM,wBAAwB,CAAC;AAE9E,oBAAY,0BAA0B,GAAG,OAAO,CAAC;IAC/C,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAChC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC;IACtB,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC;IACxB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,cAAc,CAAC;CACxC,CAAC,CAAC;AAOH,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EAAE,eAAe,EACtB,SAAS,EAAE,aAAa,EACxB,UAAU,EAAE,cAAc,EAC1B,gBAAqB,GACtB,GAAE,0BAA+B,GAAG,SAAS,CA6F7C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/requester-node-http",
-  "version": "5.0.0-alpha.1",
+  "version": "5.0.0-alpha.4",
   "description": "Promise-based request library for node using the native http module.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -18,11 +18,11 @@
     "test": "jest"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.1"
+    "@algolia/client-common": "5.0.0-alpha.4"
   },
   "devDependencies": {
     "@types/jest": "28.1.6",
-    "@types/node": "16.11.45",
+    "@types/node": "16.11.47",
     "jest": "28.1.3",
     "nock": "13.2.9",
     "ts-jest": "28.0.5",

package/src/__tests__/node-http-requester.test.ts

@@ -1,4 +1,5 @@
-import type http from 'http';
+import http from 'http';
+import https from 'https';
 import { Readable } from 'stream';
 
 import type { EndRequest } from '@algolia/client-common';
@@ -17,6 +18,72 @@ import {
 
 const requester = createHttpRequester();
 
+const httpsBaseRequest = https.request;
+const httpBaseRequest = http.request;
+
+describe('api', () => {
+  const mockedRequestResponse = {
+    destroy: jest.fn(),
+    on: jest.fn(),
+    once: jest.fn(),
+    write: jest.fn(),
+    end: jest.fn(),
+  };
+
+  beforeAll(() => {
+    // @ts-expect-error we don't care about the response for those tests
+    https.request = jest.fn(() => mockedRequestResponse);
+  });
+
+  afterAll(() => {
+    https.request = httpsBaseRequest;
+    http.request = httpBaseRequest;
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+  });
+
+  it('allow init without parameters', () => {
+    expect(() => createHttpRequester()).not.toThrow();
+  });
+
+  it('allow providing custom agent', async () => {
+    const agent = new http.Agent();
+    // @ts-expect-error we don't care about the response for those tests
+    http.request = jest.fn(() => mockedRequestResponse);
+    const tmpRequester = createHttpRequester({
+      agent,
+    });
+
+    await tmpRequester.send({
+      ...requestStub,
+      url: 'http://algolia-dns.net/foo?x-algolia-header=bar',
+    });
+
+    expect(http.request).toHaveBeenCalled();
+  });
+
+  it('allow overriding default options', async () => {
+    const tmpRequester = createHttpRequester({
+      requesterOptions: {
+        headers: {
+          'my-extra-header': 'algolia',
+        },
+      },
+    });
+
+    await tmpRequester.send(requestStub);
+
+    expect(https.request).toHaveBeenCalledWith(
+      expect.objectContaining({
+        headers: expect.objectContaining({
+          'my-extra-header': 'algolia',
+        }),
+      }),
+      expect.any(Function)
+    );
+  });
+});
+
 describe('status code handling', () => {
   it('sends requests', async () => {
     const body = getStringifiedBody();

package/src/createHttpRequester.ts

@@ -4,12 +4,30 @@ import { URL } from 'url';
 
 import type { EndRequest, Requester, Response } from '@algolia/client-common';
 
+export type CreateHttpRequesterOptions = Partial<{
+  agent: http.Agent | https.Agent;
+  httpAgent: http.Agent;
+  httpsAgent: https.Agent;
+  /**
+   * RequestOptions to be merged with the end request, it will override default options if provided.
+   */
+  requesterOptions: https.RequestOptions;
+}>;
+
 // Global agents allow us to reuse the TCP protocol with multiple clients
 const agentOptions = { keepAlive: true };
-const httpAgent = new http.Agent(agentOptions);
-const httpsAgent = new https.Agent(agentOptions);
+const defaultHttpAgent = new http.Agent(agentOptions);
+const defaultHttpsAgent = new https.Agent(agentOptions);
+
+export function createHttpRequester({
+  agent: userGlobalAgent,
+  httpAgent: userHttpAgent,
+  httpsAgent: userHttpsAgent,
+  requesterOptions = {},
+}: CreateHttpRequesterOptions = {}): Requester {
+  const httpAgent = userHttpAgent || userGlobalAgent || defaultHttpAgent;
+  const httpsAgent = userHttpsAgent || userGlobalAgent || defaultHttpsAgent;
 
-export function createHttpRequester(): Requester {
   function send(request: EndRequest): Promise<Response> {
     return new Promise((resolve) => {
       let responseTimeout: NodeJS.Timeout | undefined;
@@ -23,10 +41,17 @@ export function createHttpRequester(): Requester {
         hostname: url.hostname,
         path,
         method: request.method,
-        headers: request.headers,
-        ...(url.port !== undefined ? { port: url.port || '' } : {}),
+        ...requesterOptions,
+        headers: {
+          ...request.headers,
+          ...requesterOptions.headers,
+        },
       };
 
+      if (url.port && !requesterOptions.port) {
+        options.port = url.port;
+      }
+
       const req = (url.protocol === 'https:' ? https : http).request(
         options,
         (response) => {