@envoy/envoy-integrations-sdk 1.3.4 → 1.4.0

package/lib/EnvoyAPI.js

@@ -536,7 +536,7 @@ class EnvoyAPI {
       method: error.request?.method ?? error.options?.method,
       stack: error.stack,
     }
-    return Promise.reject(safeError)
+    throw safeError;
   }
 }
 

package/lib/EnvoyPluginStorage.js

@@ -104,6 +104,18 @@ class EnvoyPluginStorage {
 
     return this.pipeline().unset(key).executeSingle();
   }
+
+  /**
+   * Wrapper for single pipeline update.
+   *
+   * @param {string} key
+   * @param {*} value
+   * @returns {Promise<PluginStorageItem>}
+   */
+  update(key, value) {
+
+    return this.pipeline().update(key, value).executeSingle();
+  }
 }
 
 module.exports = EnvoyPluginStorage;

package/lib/EnvoyPluginStoragePipeline.js

@@ -137,6 +137,19 @@ class EnvoyPluginStoragePipeline {
 
     return this.addCommand({ action: 'unset', key });
   }
+
+  /**
+   * Updates a value for a storage item,
+   * and returns that item.
+   *
+   * @param {string} key
+   * @param value
+   * @returns {EnvoyPluginStoragePipeline}
+   */
+  update(key, value) {
+
+    return this.addCommand({ action: 'update', key, value });
+  }
 }
 
 module.exports = EnvoyPluginStoragePipeline;

package/lib/axios.js

@@ -10,12 +10,19 @@ function createAxiosClient(config) {
         (error) => {
             const safeError = {
                 code: error.code,
+                response: {
+                    code: error.response?.code,
+                    status: error.response?.status,
+                    statusText: error.response?.statusText,
+                    data: error.response?.data,
+                },
                 message: error.message,
                 name: error.name,
                 baseURL: error.request?.baseURL ?? error.config?.baseURL,
                 url: error.request?.url ?? error.config?.url,
                 method: error.request?.method ?? error.config?.method,
                 stack: error.stack,
+                data: error.data,
             }
             return Promise.reject(safeError);
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/test/promises.test.js

@@ -0,0 +1,82 @@
+const request = require('request-promise-native');
+const EnvoyAPI = require('../lib/EnvoyAPI');
+
+describe('request-promise-native', () => {
+    it('default client should leak credentials in error', async () => {
+        const client = request.defaults({
+            headers: {
+                Authorization: 'Bearer 1234',
+            },
+        });
+        try {
+            await client('http://localhost:3000/axios-error');
+        } catch (error) {
+            expect(error.options).toBeDefined();
+            const errorStr = JSON.stringify(error);
+            expect(errorStr).toContain('Bearer 1234');
+        }
+    });
+
+    it('should sanitize requests error response', async () => {
+        const client = request.defaults({
+            headers: {
+                Authorization: 'Bearer 1234',
+            },
+        });
+        try {
+            await client('http://localhost:3000/axios-error').catch(EnvoyAPI.safeRequestsError);
+        } catch (error) {
+            expect(error.options).toBeUndefined();
+            expect(error.message).toBe('Error: connect ECONNREFUSED 127.0.0.1:3000');
+            expect(error.name).toBe('RequestError');
+            const errorStr = JSON.stringify(error);
+            expect(errorStr).not.toContain('Bearer 1234');
+        }
+    });
+
+    it('should return rejected promise and leak credentials', () => {
+        const client = request.defaults({
+            headers: {
+                Authorization: 'Bearer 1234',
+            },
+        });
+        const response = client('http://localhost:3000/axios-error');
+        response.then((data) => {
+            expect(false).toBe(true);
+        }).catch((error) => {
+            expect(error.options).toBeDefined();
+            const errorStr = JSON.stringify(error);
+            expect(errorStr).toContain('Bearer 1234');
+        });
+    });
+
+    it('should return rejected promise', () => {
+        const client = request.defaults({
+            headers: {
+                Authorization: 'Bearer 1234',
+            },
+        });
+        const response = client('http://localhost:3000/axios-error').catch(EnvoyAPI.safeRequestsError);
+        response.then((data) => {
+            expect(false).toBe(true);
+        }).catch((error) => {
+            expect(error.message).toBe('Error: connect ECONNREFUSED 127.0.0.1:3000');
+            expect(error.name).toBe('RequestError');
+            const errorStr = JSON.stringify(error);
+            expect(errorStr).not.toContain('Bearer 1234');
+        });
+    });
+
+    it('should make a successful request', async () => {
+        const response = await request('https://httpstat.us/200').catch(EnvoyAPI.safeRequestsError);
+        expect(response).toBe('200 OK');
+    });
+
+    it('should throw an error', async () => {
+        try {
+            await request('https://httpstat.us/500').catch(EnvoyAPI.safeRequestsError);
+        } catch (error) {
+            expect(error.message).toBe('500 - "500 Internal Server Error"');
+        }
+    });
+});