1.1.43

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -20,17 +20,19 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -38,19 +40,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  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:
   stage: test
   script:
     - npmci npm prepare
@@ -59,6 +49,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -70,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +83,14 @@ 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - 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:
+    - lossless
     - docker
     - notpriv
   only:

README.md

@@ -1,69 +0,0 @@
-# @pushrocks/smartrequest
-dropin replacement for request
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
-* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartrequest/badges/master/build.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartrequest.svg)](https://www.npmjs.com/package/@pushrocks/smartrequest)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartrequest/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartrequest)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
-
-```javascript
-import * as smartrequest from 'smartrequest'
-
-// simple post
-let options: smartrequest.ISmartRequestOptions = { // typed options
-    headers: {
-        "Content-Type": "application/json"
-        "Authorization": "Bearer token"
-    },
-    requestBody: {
-        key1: 'value1',
-        key2: 3
-    }
-}
-
-smartrequest.post('https://example.com', options).then(res => {
-    console.log(res.status)
-    console.log(res.body) // if json, body will be parsed automatically
-}).catch(err => {
-    console.log(err)
-})
-
-// also available
-smartrequest.get(...)
-smartrequest.put(...)
-smartrequest.del(...)
-
-// streaming
-smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
-    console.log(res.status)
-    res.on('data', data => {
-        // do something with the data chunk here
-    }
-    res.on('end', () => {
-        // do something when things have ended
-    })
-})
-```
-
-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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.15",
+  "version": "1.1.43",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -23,15 +23,29 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpromise": "^3.0.5",
-    "@types/form-data": "^2.2.1",
+    "@types/form-data": "^2.5.0",
-    "form-data": "^2.3.3"
+    "agentkeepalive": "^4.0.2",
+    "form-data": "^2.5.1"
   },
   "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": "^12.7.8",
-  }
+    "tslint": "^5.20.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

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,37 @@ 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') {
+  switch (formDataField.type) {
-    let fileData = plugins.fs.readFileSync(plugins.path.join(process.cwd(), formDataField.payload));
+    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 +51,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,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';
@@ -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';
 
@@ -9,21 +8,26 @@ 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() {
+  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);
   });
   return done.promise;
@@ -50,19 +54,59 @@ 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 = {
+    // agent: agent,
+    autoJsonParse: true,
+    keepAlive: true
+  };
+
+  optionsArg = {
+    ...defaultOptions,
+    ...optionsArg
+  };
 
   // 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;
 
@@ -73,52 +117,60 @@ 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) {
+      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);
+  const requestToFire = requestModule.request(optionsArg, async response => {
+    if (responseStreamArg) {
+      done.resolve(response);
+    } else {
+      const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
+      done.resolve(builtResponse);
+    }
+  });
 
   // lets write the requestBody
   if (optionsArg.requestBody) {
-    if (!(optionsArg.requestBody instanceof plugins.formData)) {
+    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);
       }
-      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 => {
-        request.end();
-      });
     }
+  } else if (requestDataFunc) {
+    requestDataFunc(requestToFire);
   } 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 => {
-    if (streamArg) {
-      done.resolve(response);
-    } else {
-      const builtResponse = await buildUtf8Response(response);
-      done.resolve(builtResponse);
-    }
-  });
-
   const result = await done.promise;
   return result;
 };