@envoy/envoy-integrations-sdk 1.4.2 → 1.5.2

package/.github/workflows/package.yaml

@@ -17,7 +17,7 @@ jobs:
         run: |
           echo "::set-output name=version::$(node --version)"
       - name: Cache node_modules
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         id: cache-node-modules
         with:
           path: node_modules

package/lib/EnvoyAPI.js

@@ -1,4 +1,4 @@
-const request = require('request-promise-native');
+const request = require('./request-wrapper');
 const EnvoyResponseError = require('./EnvoyResponseError');
 
 /**
@@ -362,24 +362,6 @@ class EnvoyAPI {
     return EnvoyAPI.getDataFromBody(body);
   }
 
-  /**
-   * Fetches a plugin install.
-   *
-   * @param {number} installId
-   * @returns {Promise<{}>}
-   */
-  async getPluginInstall(installId) {
-    return new Promise((resolve, reject) => {
-      this.request({
-        method: 'GET',
-        url: `/api/v2/plugin-services/installs/${installId}`,
-      }).then(body => resolve(EnvoyAPI.getDataFromBody(body)))
-        .catch((error) => {
-          EnvoyAPI.safeRequestsError(error).catch((err) => reject(err));
-        });
-    });
-  }
-
   /**
    * Gets the plugin install's config.
    *

package/lib/request-wrapper.js

@@ -0,0 +1,122 @@
+const cypressRequest = require('@cypress/request');
+
+// RequestError class based on request-promise-native's
+function RequestError(cause, options, response) {
+  this.name = 'RequestError';
+  this.message = String(cause);
+  this.cause = cause;
+  this.error = cause; // legacy attribute
+  this.options = options;
+  this.response = response;
+
+  if (Error.captureStackTrace) {
+    Error.captureStackTrace(this);
+  }
+}
+RequestError.prototype = Object.create(Error.prototype);
+RequestError.prototype.constructor = RequestError;
+
+// StatusCodeError class for non-2xx HTTP responses
+function StatusCodeError(statusCode, body, options, response) {
+  this.name = 'StatusCodeError';
+  this.statusCode = statusCode;
+  this.message = `${statusCode} - ${JSON && JSON.stringify ? JSON.stringify(body) : body}`;
+  this.error = body; // legacy attribute
+  this.options = options;
+  this.response = response;
+
+  if (Error.captureStackTrace) {
+    Error.captureStackTrace(this);
+  }
+}
+StatusCodeError.prototype = Object.create(Error.prototype);
+StatusCodeError.prototype.constructor = StatusCodeError;
+
+function normalizeRequestParams(options, callback) {
+  if (typeof options === 'string' && typeof callback === 'object') {
+    return Object.assign({ url: options }, callback);
+  }
+  if (typeof options === 'string') {
+    return { url: options };
+  }
+  return options;
+}
+
+function createErrorWithOptions(err, options, response) {
+  return new RequestError(err, options, response);
+}
+
+function resolveResponse(resolve, reject, response, body, options) {
+  // Check for non-2xx status codes (request-promise-native's simple: true behavior)
+  const simple = options.simple !== false;
+  const is2xx = response && /^2/.test(String(response.statusCode));
+  
+  if (simple && !is2xx && response) {
+    reject(new StatusCodeError(response.statusCode, body, options, response));
+    return;
+  }
+  
+  if (options.resolveWithFullResponse) {
+    resolve(response);
+    return;
+  }
+  resolve(body);
+}
+
+// A wrapper that mimics request-promise-native behavior
+function createRequestWrapper(requestFn) {
+  return function requestWrapper(options, callback) {
+    const requestOptions = normalizeRequestParams(options, callback);
+    
+    return new Promise((resolve, reject) => {
+      requestFn(requestOptions, (err, response, body) => {
+        if (err) {
+          reject(createErrorWithOptions(err, requestOptions, response));
+          return;
+        }
+        resolveResponse(resolve, reject, response, body, requestOptions);
+      });
+    });
+  };
+}
+
+const promisifiedRequest = createRequestWrapper(cypressRequest);
+
+// Add defaults method to maintain compatibility with request-promise-native
+promisifiedRequest.defaults = function defaultHandler(defaultOptions) {
+  const requestWithDefaults = cypressRequest.defaults(defaultOptions);
+  
+  // A wrapper that also merges the default options for error handling
+  const promisifiedWithDefaults = function promisifiedWithDefaults(options, callback) {
+    const requestOptions = normalizeRequestParams(options, callback);
+    
+    // Merge default options with request options for the error.options property
+    const mergedOptions = Object.assign({}, defaultOptions, requestOptions);
+    
+    // Maintain compatibility with request-promise-native:
+    const isFullUrl = requestOptions.url 
+      && (requestOptions.url.startsWith('http://') || requestOptions.url.startsWith('https://'));
+    
+    if (defaultOptions.baseUrl && isFullUrl) {
+      const error = new Error('options.uri must be a path when using options.baseUrl');
+      return Promise.reject(createErrorWithOptions(error, mergedOptions));
+    }
+    
+    return new Promise((resolve, reject) => {
+      requestWithDefaults(requestOptions, (err, response, body) => {
+        if (err) {
+          reject(createErrorWithOptions(err, mergedOptions, response));
+          return;
+        }
+        resolveResponse(resolve, reject, response, body, mergedOptions);
+      });
+    });
+  };
+  
+  // Copy the defaults method to the new promisified version
+  promisifiedWithDefaults.defaults = promisifiedRequest.defaults;
+  
+  return promisifiedWithDefaults;
+};
+
+module.exports = promisifiedRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "1.4.2",
+  "version": "1.5.2",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -17,12 +17,11 @@
   },
   "homepage": "https://github.com/envoy/envoy-integrations-sdk-nodejs#readme",
   "dependencies": {
+    "@cypress/request": "^3.0.9",
     "axios": "^1.4.0",
     "body-parser": "^1.19.0",
     "dotenv": "^8.1.0",
-    "jsonwebtoken": "^9.0.0",
-    "request": "^2.88.0",
-    "request-promise-native": "^1.0.7"
+    "jsonwebtoken": "^9.0.0"
   },
   "devDependencies": {
     "chai": "^4.2.0",

package/test/promises.test.js

@@ -1,7 +1,7 @@
-const request = require('request-promise-native');
+const request = require('../lib/request-wrapper');
 const EnvoyAPI = require('../lib/EnvoyAPI');
 
-describe('request-promise-native', () => {
+describe('@cypress/request', () => {
     it('default client should leak credentials in error', async () => {
         const client = request.defaults({
             headers: {
@@ -68,15 +68,17 @@ describe('request-promise-native', () => {
     });
 
     it('should make a successful request', async () => {
-        const response = await request('https://httpstat.us/200').catch(EnvoyAPI.safeRequestsError);
-        expect(response).toBe('200 OK');
+        const response = await request('https://httpstatuses.maor.io/200').catch(EnvoyAPI.safeRequestsError);
+        expect(response).toContain('200');
+        expect(response).toContain('OK');
     });
 
     it('should throw an error', async () => {
         try {
-            await request('https://httpstat.us/500').catch(EnvoyAPI.safeRequestsError);
+            await request('https://httpstatuses.maor.io/500').catch(EnvoyAPI.safeRequestsError);
         } catch (error) {
-            expect(error.message).toBe('500 - "500 Internal Server Error"');
+            expect(error.message).toContain('500');
+            expect(error.message).toContain('Internal Server Error');
         }
     });
 });