1.1.29

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
-pages/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -38,19 +38,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -60,12 +48,24 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
   - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -78,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -106,13 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv

README.md

@@ -64,6 +64,6 @@ smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res =
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.15",
+  "version": "1.1.29",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -28,10 +28,23 @@
     "form-data": "^2.3.3"
   },
   "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": "^11.13.6",
+    "tslint": "^5.19.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

ts/smartrequest.interfaces.ts

@@ -2,5 +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';
 
@@ -9,19 +8,24 @@ export interface IExtendedIncomingMessage extends IncomingMessage {
 }
 
 const buildUtf8Response = (
-  incomingMessageArg: IncomingMessage
+  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() {
-    try {
-      (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
-    } catch (err) {
+  incomingMessageArg.on('end', () => {
+    if (autoJsonParse) {
+      try {
+        (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
+      } catch (err) {
+        (incomingMessageArg as IExtendedIncomingMessage).body = body;
+      }
+    } else {
       (incomingMessageArg as IExtendedIncomingMessage).body = body;
     }
     done.resolve(incomingMessageArg as IExtendedIncomingMessage);
@@ -50,19 +54,64 @@ 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 = {
+    // agent: agent,
+    autoJsonParse: true,
+    keepAlive: true
+  };
+
+  optionsArg = {
+    ...defaultOptions,
+    ...optionsArg
+  };
 
   // 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;
 
@@ -73,52 +122,58 @@ 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:') {
-      return plugins.https;
-    } else if (parsedUrl.protocol === 'http:') {
-      return plugins.http;
-    } else {
-      throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
+    switch (true) {
+      case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
+        optionsArg.agent = httpsAgent;
+        return plugins.https;
+      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;
     }
   })() 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 => {
+  const requestToFire = requestModule.request(optionsArg, async response => {
     if (streamArg) {
       done.resolve(response);
     } else {
-      const builtResponse = await buildUtf8Response(response);
+      const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
       done.resolve(builtResponse);
     }
   });
 
+  // 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 {
+    requestToFire.end();
+  }
+
+  // lets handle an error
+  requestToFire.on('error', e => {
+    console.error(e);
+  });
+
   const result = await done.promise;
   return result;
 };