Replace request-promise with node-fetch (#201)

Author: kelnei

package.json

@@ -4,7 +4,7 @@
   "description": "Browserstack TestCafe browser provider plugin.",
   "repository": "https://github.com/DevExpress/testcafe-browser-provider-browserstack",
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=10"
   },
   "homepage": "https://github.com/DevExpress/testcafe-browser-provider-browserstack",
   "author": {
@@ -34,13 +34,13 @@
     "dedent": "^0.7.0",
     "desired-capabilities": "^0.1.0",
     "firefox-profile": "^4.2.2",
+    "https-proxy-agent": "^7.0.0",
     "lodash": "^4.17.15",
     "mime-db": "^1.43.0",
+    "node-fetch": "^2.6.11",
     "os-family": "^1.0.0",
     "pinkie": "^2.0.4",
     "promisify-event": "^1.0.0",
-    "request": "^2.88.0",
-    "request-promise": "^4.2.4",
     "sharp": "^0.30.7",
     "tmp": "0.0.31"
   },

src/backends/automate.js

@@ -151,8 +151,6 @@ export default class AutomateBackend extends BaseBackend {
 
         this.sessions[id] = await requestApi(BROWSERSTACK_API_PATHS.newSession, {
             body: { desiredCapabilities: capabilities },
-
-            executeImmediately: true
         });
 
         AutomateBackend._ensureSessionId(this.sessions[id]);
@@ -168,7 +166,7 @@ export default class AutomateBackend extends BaseBackend {
 
         var sessionId = this.sessions[id].sessionId;
 
-        this.sessions[id].interval = setInterval(() => requestApi(BROWSERSTACK_API_PATHS.getUrl(sessionId), { executeImmediately: true }), API_POLLING_INTERVAL);
+        this.sessions[id].interval = setInterval(() => requestApi(BROWSERSTACK_API_PATHS.getUrl(sessionId)), API_POLLING_INTERVAL);
 
         await requestApi(BROWSERSTACK_API_PATHS.openUrl(sessionId), { body: { url: pageUrl } });
     }
@@ -191,7 +189,7 @@ export default class AutomateBackend extends BaseBackend {
     async takeScreenshot (id, screenshotPath) {
         var base64Data  = await requestApi(BROWSERSTACK_API_PATHS.screenshot(this.sessions[id].sessionId));
         var buffer      = Buffer.from(base64Data.value, 'base64');
-        
+
         await sharp(buffer).toFile(screenshotPath);
     }
 

src/backends/js-testing.js

@@ -83,9 +83,7 @@ export default class JSTestingBackend extends BaseBackend {
         };
 
         this.workers[id] = await requestApi(BROWSERSTACK_API_PATHS.newWorker, {
-            executeImmediately: true,
-
-            ...capabilities,
+            body: { ...capabilities }
         });
 
         const sessionInfo = await this._requestSessionInfo(id);

src/utils/request-api.js

@@ -1,53 +1,48 @@
-import Promise from 'pinkie';
-import request from 'request-promise';
+import fetch from 'node-fetch';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 import * as ERROR_MESSAGES from '../templates/error-messages';
 
-const apiRequestPromise = Promise.resolve(null);
-
-export default function (apiPath, params = {}) {
+export default async function (apiPath, params = {}) {
     if (!process.env['BROWSERSTACK_USERNAME'] || !process.env['BROWSERSTACK_ACCESS_KEY'])
         throw new Error(ERROR_MESSAGES.BROWSERSTACK_AUTHENTICATION_FAILED());
 
-    var { body, executeImmediately, ...queryParams } = params;
+    const { body, ...queryParams } = params;
 
-    var opts = {
-        url:  apiPath.url,
-        auth: {
-            user: process.env['BROWSERSTACK_USERNAME'],
-            pass: process.env['BROWSERSTACK_ACCESS_KEY'],
-        },
+    const urlObj = new URL(apiPath.url);
 
-        headers: {
-            'user-agent': 'testcafe-browserstack',
-        },
+    for (const [key, value] of Object.entries(queryParams))
+        urlObj.searchParams.append(key, value);
+
+    const url = urlObj.toString();
 
-        qs: { ...queryParams },
+    const user = process.env['BROWSERSTACK_USERNAME'];
+    const pass = process.env['BROWSERSTACK_ACCESS_KEY'];
 
-        method: apiPath.method || 'GET',
-        json:   apiPath.encoding === void 0
+    const options = {
+        method:  apiPath.method || 'GET',
+        headers: {
+            'Authorization': `Basic ${Buffer.from(user + ':' + pass).toString('base64')}`,
+            'User-Agent':    'testcafe-browserstack',
+        },
     };
 
     const proxy = process.env['BROWSERSTACK_PROXY'];
 
     if (proxy)
-        opts.proxy = `http://${proxy}`;
+        options.agent = new HttpsProxyAgent(`http://${proxy}`);
 
-    if (body)
-        opts.body = body;
+    if (body) {
+        options.body = JSON.stringify(body);
+        options.headers['Content-Type'] = 'application/json';
+    }
 
-    if (apiPath.encoding !== void 0)
-        opts.encoding = apiPath.encoding;
+    const res = await fetch(url, options);
 
-    const chainPromise = executeImmediately ? Promise.resolve(null) : apiRequestPromise;
-
-    const currentRequestPromise = chainPromise
-        .then(() => request(opts))
-        .catch(error => {
-            if (error.statusCode === 401)
-                throw new Error(ERROR_MESSAGES.BROWSERSTACK_AUTHENTICATION_FAILED());
+    if (res.status === 401)
+        throw new Error(ERROR_MESSAGES.BROWSERSTACK_AUTHENTICATION_FAILED());
 
-            throw error;
-        });
+    if (apiPath.encoding === null)
+        return Buffer.from(await res.arrayBuffer());
 
-    return currentRequestPromise;
+    return res.json();
 }