1.1.40

.gitlab-ci.yml

@@ -38,11 +38,11 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
@@ -54,7 +54,7 @@ testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm install
   - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
@@ -65,7 +65,7 @@ testBuild:
 release:
   stage: release
   script:
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
@@ -81,6 +81,7 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
@@ -100,7 +101,7 @@ trigger:
 pages:
   image: hosttoday/ht-docker-dbase:npmci
   services:
-   - docker:18-dind
+   - docker:stable-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

README.md

@@ -20,7 +20,22 @@ dropin replacement for request
 
 Use TypeScript for best in class instellisense.
 
-> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
+### Features
+
+* supports http
+* supports https
+* supports unix socks
+* supports formData
+* supports file uploads
+* supports best practice keepAlive
+* dedicated functions for working with JSON request/response cycles
+* written in TypeScript
+* continuously updated
+* uses node native http and https modules
+* used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
+* commercial support available at [https://lossless.support](https://lossless.support)
+
+> note: smartrequest uses the **native** node http/https modules under the hood (not the bloated one from npm)
 
 ```javascript
 import * as smartrequest from 'smartrequest'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.19",
+  "version": "1.1.40",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -23,16 +23,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@types/form-data": "^2.2.1",
-    "form-data": "^2.3.3"
+    "@pushrocks/smartpromise": "^3.0.5",
+    "@types/form-data": "^2.5.0",
+    "agentkeepalive": "^4.0.2",
+    "form-data": "^2.5.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.2.5",
-    "@gitzone/tstest": "^1.0.20",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^11.13.6"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.8",
+    "tslint": "^5.20.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/*",

test/test.ts

@@ -6,6 +6,12 @@ tap.test('should request a html document over https', async () => {
   await expect(smartrequest.getJson('https://encrypted.google.com/'))
     .to.eventually.property('body')
     .be.a('string');
+  await expect(smartrequest.getJson('https://encrypted.google.com/'))
+    .to.eventually.property('body')
+    .be.a('string');
+  await expect(smartrequest.getJson('https://encrypted.google.com/'))
+    .to.eventually.property('body')
+    .be.a('string');
 });
 
 tap.test('should request a JSON document over https', async () => {
@@ -15,7 +21,7 @@ tap.test('should request a JSON document over https', async () => {
     .equal(1);
 });
 
-tap.test('should post a JSON document over http', async () => {
+tap.skip.test('should post a JSON document over http', async () => {
   await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
     .to.eventually.property('body')
     .property('md5')

ts/smartrequest.formdata.ts

@@ -8,16 +8,33 @@ import { request } from './smartrequest.request';
 export interface IFormField {
   name: string;
   type: 'string' | 'filePath' | 'Buffer';
-  payload: string;
+  payload: string | Buffer;
+  fileName?: string;
 }
 
 const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
-  if (formDataField.type === 'filePath') {
-    let fileData = plugins.fs.readFileSync(plugins.path.join(process.cwd(), formDataField.payload));
+  switch (formDataField.type) {
+    case 'string':
+      formDataArg.append(formDataField.name, formDataField.payload);
+      break;
+    case 'filePath':
+      if (typeof formDataField.payload !== 'string') {
+        throw new Error(`Payload for key ${formDataField.name} must be of type string. Got ${typeof formDataField.payload} instead.`);
+      }
+      const fileData = plugins.fs.readFileSync(
+        plugins.path.join(process.cwd(), formDataField.payload)
+      );
       formDataArg.append('file', fileData, {
-      filename: 'upload.pdf',
+        filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
         contentType: 'application/pdf'
       });
+      break;
+    case 'Buffer':
+      formDataArg.append('file', formDataField.payload, {
+        filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
+        contentType: 'application/pdf'
+      });
+      break;
   }
 };
 
@@ -30,14 +47,15 @@ export const postFormData = async (
   for (const formField of payloadArg) {
     await appendFormField(form, formField);
   }
-  const requestOptions = Object.assign({}, optionsArg, {
+  const requestOptions = {
+    ...optionsArg,
     method: 'POST',
     headers: {
       ...optionsArg.headers,
       ...form.getHeaders()
     },
     requestBody: form
-  });
+  };
 
   // lets fire the actual request for sending the formdata
   const response = await request(urlArg, requestOptions);

ts/smartrequest.interfaces.ts

@@ -2,6 +2,7 @@ import * as plugins from './smartrequest.plugins';
 import * as https from 'https';
 
 export interface ISmartRequestOptions extends https.RequestOptions {
+  keepAlive?: boolean;
   requestBody?: any;
   autoJsonParse?: boolean;
 }

ts/smartrequest.plugins.ts

@@ -1,4 +1,4 @@
-import * as formData from 'form-data';
+import formData from 'form-data';
 import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
@@ -8,3 +8,8 @@ import * as url from 'url';
 import * as smartpromise from '@pushrocks/smartpromise';
 
 export { formData, http, https, fs, path, url, smartpromise };
+
+// third party scope
+import * as agentkeepalive from 'agentkeepalive';
+
+export { agentkeepalive };

ts/smartrequest.request.ts

@@ -1,4 +1,3 @@
-import * as https from 'https';
 import * as plugins from './smartrequest.plugins';
 import * as interfaces from './smartrequest.interfaces';
 
@@ -12,14 +11,14 @@ const buildUtf8Response = (
   incomingMessageArg: IncomingMessage,
   autoJsonParse = true
 ): Promise<IExtendedIncomingMessage> => {
-  let done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
+  const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
   // Continuously update stream with data
   let body = '';
-  incomingMessageArg.on('data', function(chunkArg) {
+  incomingMessageArg.on('data', chunkArg => {
     body += chunkArg;
   });
 
-  incomingMessageArg.on('end', function() {
+  incomingMessageArg.on('end', () => {
     if (autoJsonParse) {
       try {
         (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
@@ -55,16 +54,47 @@ const parseSocketPathAndRoute = (stringToParseArg: string) => {
   };
 };
 
+/**
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpAgent = new plugins.agentkeepalive.default();
+
+/**
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpAgentKeepAliveFalse = new plugins.http.Agent({
+  maxFreeSockets: 0,
+  keepAlive: false,
+  keepAliveMsecs: 0
+});
+
+/**
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
+
+/**
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpsAgentKeepAliveFalse = new plugins.https.Agent({
+  maxFreeSockets: 0,
+  keepAlive: false,
+  keepAliveMsecs: 0
+});
+
 export let request = async (
   domainArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {},
-  streamArg: boolean = false
+  responseStreamArg: boolean = false,
+  requestDataFunc: (req: plugins.http.ClientRequest) => void = null
 ): Promise<IExtendedIncomingMessage> => {
-  let done = plugins.smartpromise.defer<any>();
+  const done = plugins.smartpromise.defer<any>();
 
   // merge options
   const defaultOptions: interfaces.ISmartRequestOptions = {
-    autoJsonParse: true
+    // agent: agent,
+    autoJsonParse: true,
+    keepAlive: true
   };
 
   optionsArg = {
@@ -73,11 +103,10 @@ export let request = async (
   };
 
   // parse url
-  let parsedUrl: plugins.url.Url;
-  parsedUrl = plugins.url.parse(domainArg);
+  const parsedUrl = plugins.url.parse(domainArg);
   optionsArg.hostname = parsedUrl.hostname;
   if (parsedUrl.port) {
-    optionsArg.port = parseInt(parsedUrl.port);
+    optionsArg.port = parseInt(parsedUrl.port, 10);
   }
   optionsArg.path = parsedUrl.path;
 
@@ -92,43 +121,25 @@ export let request = async (
 
   // lets determine the request module to use
   const requestModule = (() => {
-    if (parsedUrl.protocol === 'https:') {
+    switch (true) {
+      case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
+        optionsArg.agent = httpsAgent;
         return plugins.https;
-    } else if (parsedUrl.protocol === 'http:') {
+      case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
+        optionsArg.agent = httpsAgentKeepAliveFalse;
+        return plugins.https;
+      case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
+        optionsArg.agent = httpAgent;
+        return plugins.http;
+      case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
+        optionsArg.agent = httpAgentKeepAliveFalse;
         return plugins.http;
-    } else {
-      throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
     }
   })() as typeof plugins.https;
 
   // lets perform the actual request
-  let request = requestModule.request(optionsArg);
-
-  // lets write the requestBody
-  if (optionsArg.requestBody) {
-    if (!(optionsArg.requestBody instanceof plugins.formData)) {
-      if (typeof optionsArg.requestBody !== 'string') {
-        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-      }
-      request.write(optionsArg.requestBody);
-      request.end();
-    } else if (optionsArg.requestBody instanceof plugins.formData) {
-      optionsArg.requestBody.pipe(request).on('finish', event => {
-        request.end();
-      });
-    }
-  } else {
-    request.end();
-  }
-
-  // lets handle an error
-  request.on('error', e => {
-    console.error(e);
-  });
-
-  // lets handle the response
-  request.on('response', async response => {
-    if (streamArg) {
+  const requestToFire = requestModule.request(optionsArg, async response => {
+    if (responseStreamArg) {
       done.resolve(response);
     } else {
       const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
@@ -136,6 +147,30 @@ export let request = async (
     }
   });
 
+  // lets write the requestBody
+  if (optionsArg.requestBody) {
+    if (optionsArg.requestBody instanceof plugins.formData) {
+      optionsArg.requestBody.pipe(requestToFire).on('finish', event => {
+        requestToFire.end();
+      });
+    } else {
+      if (typeof optionsArg.requestBody !== 'string') {
+        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
+      }
+      requestToFire.write(optionsArg.requestBody);
+      requestToFire.end();
+    }
+  } else if (requestDataFunc) {
+    requestDataFunc(requestToFire);
+  } else {
+    requestToFire.end();
+  }
+
+  // lets handle an error
+  requestToFire.on('error', e => {
+    console.error(e);
+  });
+
   const result = await done.promise;
   return result;
 };