1.1.26

.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/
@@ -100,7 +100,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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.18",
+  "version": "1.1.26",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -28,11 +28,13 @@
     "form-data": "^2.3.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.5",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^11.13.6"
+    "@types/node": "^11.13.6",
+    "tslint": "^5.19.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/*",

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';

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,52 @@ 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.http.Agent({
+  keepAlive: true,
+  keepAliveMsecs: 600000
+});
+
+/**
+ * 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.https.Agent({
+  keepAlive: true,
+  keepAliveMsecs: 600000
+});
+
+/**
+ * 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
 ): 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 +108,10 @@ export let request = async (
   };
 
   // parse url
-  let parsedUrl: plugins.url.Url;
+  const parsedUrl = plugins.url.parse(domainArg);
-  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;
 
@@ -88,19 +122,28 @@ export let request = async (
     optionsArg.path = detailedUnixPath.path;
   }
 
+  // TODO: support tcp sockets
+
   // lets determine the request module to use
   const requestModule = (() => {
-    if (parsedUrl.protocol === 'https:') {
+    switch (true) {
-      return plugins.https;
+      case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
-    } else if (parsedUrl.protocol === 'http:') {
+        optionsArg.agent = httpsAgent;
-      return plugins.http;
+        return plugins.https;
-    } else {
+      case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
-      throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
+        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;
     }
   })() as typeof plugins.https;
 
   // lets perform the actual request
-  let request = requestModule.request(optionsArg);
+  const requestToFire = requestModule.request(optionsArg);
 
   // lets write the requestBody
   if (optionsArg.requestBody) {
@@ -108,24 +151,24 @@ export let request = async (
       if (typeof optionsArg.requestBody !== 'string') {
         optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
       }
-      request.write(optionsArg.requestBody);
+      requestToFire.write(optionsArg.requestBody);
-      request.end();
+      requestToFire.end();
     } else if (optionsArg.requestBody instanceof plugins.formData) {
-      optionsArg.requestBody.pipe(request).on('finish', event => {
+      optionsArg.requestBody.pipe(requestToFire).on('finish', event => {
-        request.end();
+        requestToFire.end();
       });
     }
   } else {
-    request.end();
+    requestToFire.end();
   }
 
   // lets handle an error
-  request.on('error', e => {
+  requestToFire.on('error', e => {
     console.error(e);
   });
 
   // lets handle the response
-  request.on('response', async response => {
+  requestToFire.on('response', async response => {
     if (streamArg) {
       done.resolve(response);
     } else {