@envoy/envoy-integrations-sdk 2.0.1-beta.5 → 2.0.2

package/lib/axios.js

@@ -1,34 +0,0 @@
-const { AxiosError } = require('axios');
-const axios = require('axios');
-
-function createAxiosClient(config) {
-    const client = axios.create(config);
-    client.interceptors.response.use(
-        (response) => {
-           return response 
-        },
-        (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);
-        },
-    );
-
-    return client;
-}
-
-module.exports = createAxiosClient;

package/lib/errorMiddleware.js

@@ -1,27 +0,0 @@
-const HttpStatus = require('./HttpStatus');
-
-/**
- *
- * @param {Function} onError
- * @returns {Function}
- */
-function errorMiddleware(onError = () => {}) {
-
-  /**
-   * @param err
-   * @param req
-   * @param res
-   * @param next
-   */
-  return (err, req, res, next) => {
-    onError(err);
-    if (res.headersSent) {
-      return next(err);
-    }
-    res.statusCode = HttpStatus.UNEXPECTED_FAILURE;
-    res.setHeader('Content-Type', 'application/json');
-    res.end(JSON.stringify({ message: err.message }));
-  };
-}
-
-module.exports = errorMiddleware;

package/lib/middleware.js

@@ -1,110 +0,0 @@
-const bodyParser = require('body-parser');
-const EnvoyAPI = require('./EnvoyAPI');
-const EnvoyPluginSDK = require('./EnvoyPluginSDK');
-const EnvoySignatureVerifier = require('./EnvoySignatureVerifier');
-const HttpStatus = require('./HttpStatus');
-
-const VERIFIED = Symbol('verified');
-
-/**
- * Express/connect middleware.
- *
- * @callback connectMiddleware
- * @param req
- * @param res
- * @param {Function} next
- */
-
-/**
- * @typedef {Object} EnvoyRequest
- * @property {EnvoyPluginSDK} envoy - the SDK
- */
-
-/**
- * @typedef {Object} EnvoyResponse
- * @property {Function} sendOngoing
- * @property {Function} sendIgnored
- * @property {Function} sendFailed
- */
-
-/**
- * Returns an instance of bodyParser.json,
- * which also verifies that the request came from Envoy.
- *
- * @param {SignatureVerifierOptions} [options]
- * @returns {connectMiddleware}
- */
-function middleware(options) {
-
-  const signatureVerifier = new EnvoySignatureVerifier(options);
-  const verify = (req, res, rawBody) => {
-
-    req[VERIFIED] = signatureVerifier.verify(req, rawBody);
-  };
-  const json = bodyParser.json({ verify });
-  let accessToken = null;
-  let threshold = 0;
-
-  return (req, res, next) => {
-
-    json(req, res, async err => {
-
-      if (err) {
-        return next(err);
-      }
-      try {
-        const now = Date.now();
-        if (now > threshold) {
-          const {
-            access_token: rawAccessToken,
-            expires_in: expiresIn,
-          } = await EnvoyAPI.login();
-          accessToken = rawAccessToken;
-          threshold = now + (expiresIn * 1000) - (1000 * 60 * 10);
-        }
-
-        /**
-         * @type {EnvoyPluginSDK}
-         */
-        req.envoy = new EnvoyPluginSDK(req.body, req[VERIFIED], accessToken);
-        /**
-         * @param {object} [data]
-         */
-        res.sendOngoing = (data = {}) => {
-          res.statusCode = HttpStatus.ONGOING;
-          res.setHeader('Content-Type', 'application/json');
-          res.end(JSON.stringify(data));
-        };
-        /**
-         * @param {string} [message]
-         * @param {object} [data]
-         */
-        res.sendIgnored = (message = '', data = {}) => {
-          if (message && data.message) {
-            console.warn('Data to be sent already has a message.');
-          }
-          res.statusCode = HttpStatus.IGNORED;
-          res.setHeader('Content-Type', 'application/json');
-          res.end(JSON.stringify(Object.assign({ message }, data)));
-        };
-        /**
-         * @param {string} [message]
-         * @param {object} [data]
-         */
-        res.sendFailed = (message = '', data = {}) => {
-          if (message && data.message) {
-            console.warn('Data to be sent already has a message.');
-          }
-          res.statusCode = HttpStatus.FAILED;
-          res.setHeader('Content-Type', 'application/json');
-          res.end(JSON.stringify(Object.assign({ message }, data)));
-        };
-        next();
-      } catch (err) {
-        next(err);
-      }
-    });
-  };
-}
-
-module.exports = middleware;

package/middleware.md

@@ -1,53 +0,0 @@
----
-description: Use this middleware to automatically and safely include Envoy in your plugin.
----
-
-# middleware
-
-## Example
-
-```javascript
-const express = require('express');
-const { middleware } = require('envoy-integrations-sdk-nodejs');
-
-const app = express();
-app.use(middleware());
-```
-
-## Functions
-
-### middleware\(\[options\]\) ⇒ `connectMiddleware`
-
-Returns an instance of `bodyParser.json`, which also verifies that the request came from Envoy. It also attaches an instance of `EnvoyPluginSDK` attached to the `req` object, accessible at `req.envoy`.
-
-**Kind**: global function
-
-| Param | Type |
-| :--- | :--- |
-| \[options\] | `SignatureVerifierOptions` |
-
-### Related Functions and Classes
-
-### connectMiddleware : `function`
-
-Express/connect middleware.
-
-**Kind**: global typedef
-
-| Param | Type |
-| :--- | :--- |
-| req | [http://expressjs.com/en/4x/api.html\#req](http://expressjs.com/en/4x/api.html#req) |
-| res | [http://expressjs.com/en/4x/api.html\#res](http://expressjs.com/en/4x/api.html#res) |
-| next | `function` |
-
-### SignatureVerifierOptions : `Object`
-
-**Properties**
-
-| Name | Type | Default |
-| :--- | :--- | :--- |
-| algorithm | `string` | `"sha256"` |
-| encoding | `string` | `"base64"` |
-| secret | `string` | `process.env.ENVOY_CLIENT_SECRET` |
-| header | `string` | `"x-envoy-signature"` |
-

package/test/axios.test.js

@@ -1,57 +0,0 @@
-const axios = require('axios');
-const createClient = require('../lib/axios');
-
-describe('axios', () => {
-    it('default client should leak credentials in AxiosError', async () => {
-        const client = axios.create({
-            headers: {
-                Authorization: 'Bearer 1234',
-            },
-            proxy: {
-                host: 'localhost',
-                auth: {
-                    username: 'myWhackyUsername',
-                    password: 'myWhackyPassword',
-                }
-            }
-        });
-        try {
-            await client.get('http://localhost:3000/axios-error');
-        } catch (error) {
-            expect(error.config).toBeDefined();
-            const errorStr = JSON.stringify(error);
-            expect(errorStr).toContain('Bearer 1234');
-            expect(errorStr).toContain('myWhackyUsername');
-            expect(errorStr).toContain('myWhackyPassword');
-        }
-    });
-
-    it('should sanitize AxiosError response', async () => {
-        const client = createClient({
-            headers: {
-                Authorization: 'Bearer 1234',
-            },
-            proxy: {
-                host: 'localhost',
-                auth: {
-                    username: 'myWhackyUsername',
-                    password: 'myWhackyPassword',
-                }
-            }
-        });
-        try {
-            await client.get('http://localhost:3000/axios-error');
-        } catch (error) {
-            expect(error.config).toBeUndefined();
-            expect(error.code).toBe('ECONNREFUSED');
-            expect(error.message).toBe('connect ECONNREFUSED 127.0.0.1:80');
-            expect(error.name).toBe('Error');
-            expect(error.url).toBe('http://localhost:3000/axios-error');
-            expect(error.method).toBe('get');
-            const errorStr = JSON.stringify(error);
-            expect(errorStr).not.toContain('Bearer 1234');
-            expect(errorStr).not.toContain('myWhackyUsername');
-            expect(errorStr).not.toContain('myWhackyPassword');
-        }
-    });
-});

package/test/promises.test.js

@@ -1,82 +0,0 @@
-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"');
-        }
-    });
-});