1.1.41

.gitlab-ci.yml

@@ -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:

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'
@@ -31,23 +46,24 @@ let options: smartrequest.ISmartRequestOptions = { // typed options
         "Content-Type": "application/json"
         "Authorization": "Bearer token"
     },
-    requestBody: {
+    requestBody: JSON.stringify({
         key1: 'value1',
         key2: 3
-    }
+    })
 }
 
-smartrequest.post('https://example.com', options).then(res => {
+smartrequest.request('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(...)
+// dedicated JSON metods are available:
+smartrequest.getJson(...)
+smartrequest.postJson(...)
+smartrequest.putJson(...)
+smartrequest.delJson(...)
 
 // streaming
 smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.30",
+  "version": "1.1.41",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -407,6 +407,16 @@
       "integrity": "sha512-SOhuU4wNBxhhTHxYaiG5NY4HBhDIDnJF60GU+2LqHAdKKer86//e4yg69aENCtQ04n0ovz+tq2YPME5t5yp4pw==",
       "dev": true
     },
+    "agentkeepalive": {
+      "version": "4.0.2",
+      "resolved": "https://verdaccio.lossless.one/agentkeepalive/-/agentkeepalive-4.0.2.tgz",
+      "integrity": "sha512-A5gSniD4xMCYtSD4ilUHpQRB9ZbNjtIPittKUv7bA0j0UCwbT3EJBUYLKPJ/dtmaXRYWI2mG4/O90xbi7oahNw==",
+      "requires": {
+        "debug": "^4.1.0",
+        "depd": "^1.1.2",
+        "humanize-ms": "^1.2.1"
+      }
+    },
     "ansi-256-colors": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/ansi-256-colors/-/ansi-256-colors-1.1.0.tgz",
@@ -658,6 +668,14 @@
         "which": "^1.2.9"
       }
     },
+    "debug": {
+      "version": "4.1.1",
+      "resolved": "https://verdaccio.lossless.one/debug/-/debug-4.1.1.tgz",
+      "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
+      "requires": {
+        "ms": "^2.1.1"
+      }
+    },
     "decamelize": {
       "version": "1.2.0",
       "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz",
@@ -695,6 +713,11 @@
       "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
       "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk="
     },
+    "depd": {
+      "version": "1.1.2",
+      "resolved": "https://verdaccio.lossless.one/depd/-/depd-1.1.2.tgz",
+      "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak="
+    },
     "diff": {
       "version": "4.0.1",
       "resolved": "https://verdaccio.lossless.one/diff/-/diff-4.0.1.tgz",
@@ -844,6 +867,14 @@
       "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=",
       "dev": true
     },
+    "humanize-ms": {
+      "version": "1.2.1",
+      "resolved": "https://verdaccio.lossless.one/humanize-ms/-/humanize-ms-1.2.1.tgz",
+      "integrity": "sha1-xG4xWaKT9riW2ikxbYtv6Lt5u+0=",
+      "requires": {
+        "ms": "^2.0.0"
+      }
+    },
     "inflight": {
       "version": "1.0.6",
       "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
@@ -1045,6 +1076,11 @@
         "moment": ">= 2.9.0"
       }
     },
+    "ms": {
+      "version": "2.1.2",
+      "resolved": "https://verdaccio.lossless.one/ms/-/ms-2.1.2.tgz",
+      "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+    },
     "nice-try": {
       "version": "1.0.5",
       "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.30",
+  "version": "1.1.41",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -25,6 +25,7 @@
   "dependencies": {
     "@pushrocks/smartpromise": "^3.0.5",
     "@types/form-data": "^2.5.0",
+    "agentkeepalive": "^4.0.2",
     "form-data": "^2.5.1"
   },
   "devDependencies": {

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));
-    formDataArg.append('file', fileData, {
-      filename: 'upload.pdf',
-      contentType: 'application/pdf'
-    });
+  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: 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.plugins.ts

@@ -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

@@ -57,10 +57,7 @@ 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
-});
+const httpAgent = new plugins.agentkeepalive.default();
 
 /**
  * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
@@ -74,10 +71,7 @@ const httpAgentKeepAliveFalse = new plugins.http.Agent({
 /**
  * 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
-});
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
 
 /**
  * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
@@ -91,7 +85,8 @@ const httpsAgentKeepAliveFalse = new plugins.https.Agent({
 export let request = async (
   domainArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {},
-  streamArg: boolean = false
+  responseStreamArg: boolean = false,
+  requestDataFunc: (req: plugins.http.ClientRequest) => void = null
 ): Promise<IExtendedIncomingMessage> => {
   const done = plugins.smartpromise.defer<any>();
 
@@ -130,13 +125,13 @@ export let request = async (
       case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
         optionsArg.agent = httpsAgent;
         return plugins.https;
-      case parsedUrl.protocol === 'https:' && (!optionsArg.keepAlive):
+      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):
+      case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
         optionsArg.agent = httpAgentKeepAliveFalse;
         return plugins.http;
     }
@@ -144,7 +139,7 @@ export let request = async (
 
   // lets perform the actual request
   const requestToFire = requestModule.request(optionsArg, async response => {
-    if (streamArg) {
+    if (responseStreamArg) {
       done.resolve(response);
     } else {
       const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
@@ -165,6 +160,8 @@ export let request = async (
       requestToFire.write(optionsArg.requestBody);
       requestToFire.end();
     }
+  } else if (requestDataFunc) {
+    requestDataFunc(requestToFire);
   } else {
     requestToFire.end();
   }