feat!: migrate from deprecated request module to axios (#1058)

Makefile

@@ -5,6 +5,7 @@ clean:
 
 install: clean
 	npm install
+	npx lerna bootstrap
 
 test: install
 	yarn test:files

packages/client/package.json

@@ -28,8 +28,7 @@
   },
   "dependencies": {
     "@sendgrid/helpers": "^6.5.5",
-    "@types/request": "^2.48.4",
-    "request": "^2.88.0"
+    "axios": "^0.19.2"
   },
   "tags": [
     "http",

packages/client/src/classes/client.js

@@ -3,13 +3,14 @@
 /**
  * Dependencies
  */
-const http = require('request');
+const axios = require('axios');
 const pkg = require('../../package.json');
 const {
   helpers: {
     mergeData,
   },
   classes: {
+    Response,
     ResponseError,
   },
 } = require('@sendgrid/helpers');
@@ -18,7 +19,6 @@ const {
  * Twilio SendGrid REST Client
  */
 class Client {
-
   /**
    * Constructor
    */
@@ -29,13 +29,13 @@ class Client {
 
     //Default headers
     this.defaultHeaders = {
-      Accept: 'application/json',
+      'Accept': 'application/json',
+      'Content-Type': 'application/json',
       'User-agent': 'sendgrid/' + pkg.version + ';nodejs',
     };
 
     //Empty default request
     this.defaultRequest = {
-      json: true,
       baseUrl: 'https://api.sendgrid.com/',
       url: '',
       method: 'GET',
@@ -88,18 +88,22 @@ class Client {
    */
   createRequest(data) {
 
-    //Keep URL parameter consistent
-    if (data.uri) {
-      data.url = data.uri;
-      delete data.uri;
-    }
+    let options = {
+      url: data.uri || data.url,
+      baseUrl: data.baseUrl,
+      method: data.method,
+      data: data.body,
+      params: data.qs,
+      headers: data.headers,
+    };
 
     //Merge data with empty request
-    const request = mergeData(this.defaultRequest, data);
+    options = mergeData(this.defaultRequest, options);
+    options.headers = this.createHeaders(options.headers);
+    options.baseURL = options.baseUrl;
+    delete options.baseUrl;
 
-    //Add headers
-    request.headers = this.createHeaders(request.headers);
-    return request;
+    return options;
   }
 
   /**
@@ -108,25 +112,28 @@ class Client {
   request(data, cb) {
 
     //Create request
-    const request = this.createRequest(data);
+    data = this.createRequest(data);
 
     //Perform request
     const promise = new Promise((resolve, reject) => {
-      http(request, (error, response, body) => {
-
-        //Request error
-        if (error) {
+      axios(data)
+        .then(response => {
+          // Successful response
+          return resolve([
+            new Response(response.status, response.data, response.headers),
+            response.data,
+          ]);
+        })
+        .catch(error => {
+          // Response error
+          if (error.response) {
+            if (error.response.status >= 400) {
+              return reject(new ResponseError(error.response));
+            }
+          }
+          // Request error
           return reject(error);
-        }
-
-        //Response error
-        if (response.statusCode >= 400) {
-          return reject(new ResponseError(response));
-        }
-
-        //Successful response
-        resolve([response, body]);
-      });
+        });
     });
 
     // Throw and error incase function not passed

packages/client/src/client.d.ts

@@ -3,6 +3,7 @@ import {ClientRequest} from "@sendgrid/client/src/request";
 import {ClientResponse} from "@sendgrid/client/src/response";
 
 declare class Client {
+  constructor();
   /**
    * Set API key
    */

packages/client/src/request.d.ts

@@ -1,3 +1,3 @@
-import {OptionsWithUrl} from "request";
+import RequestOptions from "@sendgrid/helpers/classes/request";
 
-export type ClientRequest = OptionsWithUrl;
+export type ClientRequest = RequestOptions;

packages/client/src/response.d.ts

@@ -1,3 +1,3 @@
-import {RequestResponse} from "request";
+import Response from "@sendgrid/helpers/classes/response";
 
-export type ClientResponse = RequestResponse;
+export type ClientResponse = Response;

packages/helpers/classes/index.d.ts

@@ -2,12 +2,14 @@ import Attachment from "@sendgrid/helpers/classes/attachment";
 import EmailAddress from "@sendgrid/helpers/classes/email-address";
 import Mail from "@sendgrid/helpers/classes/mail"
 import Personalization from "@sendgrid/helpers/classes/personalization";
+import Response from "@sendgrid/helpers/classes/response";
 import ResponseError from "@sendgrid/helpers/classes/response-error";
 
 export {
   Attachment,
   EmailAddress,
   Mail,
   Personalization,
+  Response,
   ResponseError,
-}
+}

packages/helpers/classes/index.js

@@ -7,6 +7,7 @@ const Attachment = require('./attachment');
 const EmailAddress = require('./email-address');
 const Mail = require('./mail');
 const Personalization = require('./personalization');
+const Response = require('./response');
 const ResponseError = require('./response-error');
 const Statistics = require('./statistics');
 
@@ -18,6 +19,7 @@ module.exports = {
   EmailAddress,
   Mail,
   Personalization,
+  Response,
   ResponseError,
   Statistics,
 };

packages/helpers/classes/request.d.ts

@@ -0,0 +1,10 @@
+type HttpMethod = 'get'|'GET'|'post'|'POST'|'put'|'PUT'|'patch'|'PATCH'|'delete'|'DELETE';
+
+export default interface RequestOptions<TData = any, TParams = object> {
+    url: string;
+    method?: HttpMethod;
+    baseUrl?: string;
+    qs?: TParams;
+    body?: TData;
+    headers?: object;
+}

packages/helpers/classes/response-error.js

@@ -19,12 +19,12 @@ class ResponseError extends Error {
     super();
 
     //Extract data from response
-    const {headers, statusCode, statusMessage, body} = response;
+    const {headers, status, statusText, data} = response;
 
     //Set data
-    this.code = statusCode;
-    this.message = statusMessage;
-    this.response = {headers, body};
+    this.code = status;
+    this.message = statusText;
+    this.response = {headers, body: data};
 
     //Capture stack trace
     if (!this.stack) {

packages/helpers/classes/response.d.ts

@@ -0,0 +1,7 @@
+export default class Response<TPayload = object> {
+    statusCode: number;
+    body: TPayload;
+    headers: any;
+    constructor(statusCode: number, body: TPayload, headers?: any);
+    toString(): string;
+}

packages/helpers/classes/response.js

@@ -0,0 +1,15 @@
+'use strict';
+
+class Response {
+  constructor(statusCode, body, headers) {
+    this.statusCode = statusCode;
+    this.body = body;
+    this.headers = headers;
+  }
+
+  toString() {
+    return 'HTTP ' + this.statusCode + ' ' + this.body;
+  }
+}
+
+module.exports = Response;

packages/helpers/helpers/merge-data.js

@@ -24,7 +24,7 @@ module.exports = function mergeData(base, data) {
         merged[key] = data[key];
       } else if (data[key] && typeof data[key] === 'object') {
         merged[key] = Object.assign({}, data[key]);
-      } else {
+      } else if (data[key]) {
         merged[key] = data[key];
       }
     }

test/typescript/client.ts

@@ -26,5 +26,5 @@ const req = Client.createRequest({
 Client.request({
   url: "/test"
 }).then(res => {
-  res[0].headers
-})
+  res[0].statusCode;
+});