Increase body limits & fix dependencies (#62)

Author: EmptyInfinity

circle.yml renamed to .circleci/circle.yml

@@ -2,11 +2,14 @@ version: 2
 jobs:
   test:
     docker:
-      - image: circleci/node:12-stretch
+      - image: circleci/node:14-stretch
     steps:
       - checkout
       - restore_cache:
           key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: Audit Dependencies
+          command: npm audit --audit-level=high
       - run:
           name: Installing Dependencies
           command: npm install

.eslintrc.js

@@ -0,0 +1,58 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+    mocha: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: [
+    '@typescript-eslint',
+  ],
+  rules: {
+    'import/no-extraneous-dependencies': ['error', { devDependencies: ['spec/**/*', 'spec-integration/**/*'] }],
+    'no-plusplus': 0,
+    'no-unused-vars': 0,
+    'no-await-in-loop': 0,
+    'prefer-default-export': 0,
+    'import/prefer-default-export': 0,
+    'class-methods-use-this': 1,
+    'max-len': ['error', { code: 180 }],
+    'no-param-reassign': 1,
+    'no-return-assign': 1,
+    'no-use-before-define': 0,
+    'comma-dangle': 0,
+    'object-curly-newline': 0,
+    camelcase: 0,
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        js: 'never',
+        jsx: 'never',
+        ts: 'never',
+        tsx: 'never',
+      },
+    ],
+  },
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
+      },
+    },
+  },
+};

.gitignore

@@ -1,16 +1,13 @@
-*.js
-*.map
-*.d.ts
-!*.json
 # Logs
 logs
 *.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+lerna-debug.log*
 
-# IDEA files
-.idea
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
@@ -23,11 +20,12 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
 # Bower dependency directory (https://bower.io/)
@@ -46,12 +44,21 @@ jspm_packages/
 # TypeScript v1 declaration files
 typings/
 
+# TypeScript cache
+*.tsbuildinfo
+
 # Optional npm cache directory
 .npm
 
 # Optional eslint cache
 .eslintcache
 
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
 # Optional REPL history
 .node_repl_history
 
@@ -63,9 +70,38 @@ typings/
 
 # dotenv environment variables file
 .env
+.env.test
 
-# next.js build output
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
 .next
 
-# TypeScript output directory
-out
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+.vscode
+.idea
+!.eslintrc.js
+*.d.ts

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.2 (April 13, 2022)
+* Fix dependencies
+
+## 2.0.1 (March 29, 2022)
+- Increase `REQUEST_MAX_BODY_LENGTH` to 100MB
+
 ## 2.0.0 (January 14, 2022)
 * Now method `uploadAttachment` from `AttachmentProcessor` saves attachments directly to `Maester`
 * Now method `uploadAttachment` from `AttachmentProcessor` accepts additional argument `contentType`

README.md

@@ -36,7 +36,7 @@ A number of REST Client classes are available to use and extend to create Client
 Each of the REST Clients extends from the `NoAuthRestClient`, overriding the relevant methods. Exception is PlatformApiRestClient and PlatformApiLogicClient.
 
 ### NoAuthRestClient
-[NoAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/NoAuthRestClient.ts) class to make rest requests no no auth APIs by provided options.
+[NoAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/NoAuthRestClient.ts) class to make rest requests no no auth APIs by provided options.
 
 #### constructor(emitter, cfg)
 - emitter - EIO emitting context.
@@ -80,7 +80,7 @@ class MyClient extends NoAuthRestClient {
 ```
 
 ### BasicAuthRestClient
-[BasicAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/BasicAuthRestClient.ts)
+[BasicAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/BasicAuthRestClient.ts)
 class extends [NoAuthRestClient](#NoAuthRestClient) class.
 Makes requests to resource with basic auth.
 
@@ -94,7 +94,7 @@ const Client = new BasicAuthRestClient(emitter, cfg, user, pass);
 
 
 ### ApiKeyRestClient
-[ApiKeyRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/ApiKeyRestClient.ts)
+[ApiKeyRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/ApiKeyRestClient.ts)
 class extends [NoAuthRestClient](#NoAuthRestClient) class.
 Makes requests to resource with api key (custom header) auth.
 
@@ -107,13 +107,13 @@ const Client = new BasicAuthRestClient(emitter, cfg, user, pass);
 ```
 
 ### CookieRestClient
-[CookieRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/CookieRestClient.ts)
+[CookieRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/CookieRestClient.ts)
 class extends [NoAuthRestClient](#NoAuthRestClient) class.
 
 TBD
 
 ### OAuth2AuthorizationCodeRestClient
-[OAuth2RestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/OAuth2AuthorizationCodeRestClient.ts)
+[OAuth2RestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/OAuth2AuthorizationCodeRestClient.ts)
 class extends [NoAuthRestClient](#NoAuthRestClient) class.
 Makes requests to resource with oauth2 access token auth.
 
@@ -125,7 +125,7 @@ const Client = new OAuth2AuthorizationCodeRestClient(emitter, cfg);
 This class can handle, refresh and emit oauth2 EIO configuration.
 
 ### NtlmRestClient
-[NtlmRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/NtlmRestClient.ts)
+[NtlmRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/NtlmRestClient.ts)
 class extends [NoAuthRestClient](#NoAuthRestClient) class.
 Makes requests to resource with [NTLM authentication](https://en.wikipedia.org/wiki/NT_LAN_Manager).
 Falls back to basic authentication if NTLM authentication fails.
@@ -143,7 +143,7 @@ const Client = new NtlmRestClient(emitter, cfg);
 A number of Platform API Client classes are available to use and extend them to create Clients for Platform API.
 
 ### PlatformApiRestClient
-[PlatformApiRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiRestClient.ts)
+[PlatformApiRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/PlatformApiRestClient.ts)
 class extends [BasicAuthRestClient](#BasicAuthRestClient) class.
 The method inside this class checks for the status code 200, if not, then throws an error. And also checks that the response came with the correct data in the JSON format and the other expected response headers.
 
@@ -156,7 +156,7 @@ const Client = new PlatformApiRestClient(emitter, cfg);
 ```
 
 ### PlatformApiLogicClient
-[PlatformApiLogicClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiLogicClient.ts)
+[PlatformApiLogicClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/PlatformApiLogicClient.ts)
 class extends [PlatformApiRestClient](#PlatformApiRestClient) class.
 Contains useful methods to manipulate flow's state to set it either to active running or to inactive stopped, searching flows, workspaces, credentials and more.
 
@@ -225,7 +225,7 @@ const result = await new AttachmentProcessor().getAttachment('http://example.com
 ```
 
 ## Logger
-The built in logger uses Bunyan Logger as its base implementation. The available logger methods can be found [here](https://github.com/elasticio/component-commons-library/blob/master/lib/logger/logger.ts#L19).
+The built in logger uses Bunyan Logger as its base implementation. The available logger methods can be found [here](https://github.com/elasticio/component-commons-library/blob/master/src/logger/logger.ts#L19).
 
 Example:
 

dist/spec-integration/attachmentProcessor.spec.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const chai_1 = require("chai");
+const common_1 = require("./common");
+const AttachmentProcessor_1 = require("../src/attachment/AttachmentProcessor");
+(0, common_1.setEnvs)();
+describe('AttachmentProcessor', () => {
+    describe('uploadAttachment', () => {
+        it('uploadAttachment (/samples/sample.json)', async () => {
+            const file = fs_1.default.createReadStream(path_1.default.join(__dirname, './samples/sample.json'));
+            const res = await new AttachmentProcessor_1.AttachmentProcessor().uploadAttachment(file, 'application/octet-stream');
+            (0, chai_1.expect)(res.data.contentType).to.be.equal('application/octet-stream');
+        });
+        it('uploadAttachment (/samples/image.png)', async () => {
+            const file = fs_1.default.createReadStream(path_1.default.join(__dirname, './samples/image.png'));
+            const res = await new AttachmentProcessor_1.AttachmentProcessor().uploadAttachment(file, 'image/png');
+            (0, chai_1.expect)(res.data.contentType).to.be.equal('image/png');
+        });
+    });
+});

dist/spec-integration/common.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setEnvs = void 0;
+const fs_1 = require("fs");
+const dotenv_1 = require("dotenv");
+const setEnvs = () => {
+    if ((0, fs_1.existsSync)('.env')) {
+        (0, dotenv_1.config)();
+    }
+};
+exports.setEnvs = setEnvs;

dist/spec/attachment/AttachmentProcessor.spec.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-buffer-constructor */
+const chai_1 = __importDefault(require("chai"));
+const fs_1 = __importDefault(require("fs"));
+const stream_1 = require("stream");
+const sinon_1 = __importDefault(require("sinon"));
+const dist_1 = require("@elastic.io/maester-client/dist");
+const AttachmentProcessor_1 = require("../../src/attachment/AttachmentProcessor");
+const { expect } = chai_1.default;
+const maesterUri = 'https://ma.estr';
+process.env.ELASTICIO_OBJECT_STORAGE_TOKEN = 'token';
+process.env.ELASTICIO_OBJECT_STORAGE_URI = maesterUri;
+const formStream = (dataString) => {
+    const stream = new stream_1.Readable();
+    stream.push(dataString);
+    stream.push(null);
+    return stream;
+};
+describe('AttachmentProcessor', () => {
+    const attachmentProcessor = new AttachmentProcessor_1.AttachmentProcessor();
+    describe('Steward', () => {
+        it('Should successfully retrieve csv', async () => {
+            const attachmentOptions = {
+                'content-type': 'arraybuffer',
+                url: 'http://insight.dev.schoolwires.com/HelpAssets/C2Assets/C2Files/C2ImportCalEventSample.csv',
+            };
+            const result = await attachmentProcessor.getAttachment(attachmentOptions.url, attachmentOptions['content-type']);
+            const encodedResult = new Buffer(result.data, 'binary').toString('base64');
+            const expectedResult = fs_1.default.readFileSync('spec/attachment/resources/base64csv.txt').toString();
+            expect(encodedResult).to.be.equal(expectedResult);
+        });
+        it('Should successfully retrieve png image', async () => {
+            const attachmentOptions = {
+                'content-type': 'arraybuffer',
+                url: `https://httpbin.org/image/png?${AttachmentProcessor_1.STORAGE_TYPE_PARAMETER}=steward`,
+            };
+            const result = await attachmentProcessor.getAttachment(attachmentOptions.url, 'arraybuffer');
+            const encodedResult = new Buffer(result.data, 'binary').toString('base64');
+            const expectedResult = fs_1.default.readFileSync('spec/attachment/resources/base64Png.txt').toString();
+            expect(encodedResult).to.be.equal(expectedResult);
+        });
+    });
+    describe('maester', () => {
+        let getById;
+        beforeEach(() => {
+            getById = sinon_1.default.stub(dist_1.ObjectStorage.prototype, 'getById').callsFake(async () => ({ data: formStream('i`m a stream') }));
+        });
+        afterEach(() => {
+            sinon_1.default.restore();
+        });
+        it('Should successfully retrieve response (stream)', async () => {
+            const attachmentOptions = {
+                'content-type': 'stream',
+                url: `${maesterUri}${AttachmentProcessor_1.MAESTER_OBJECT_ID_ENDPOINT}object_id?${AttachmentProcessor_1.STORAGE_TYPE_PARAMETER}=maester`,
+            };
+            const result = await attachmentProcessor.getAttachment(attachmentOptions.url, attachmentOptions['content-type']);
+            expect(result.toString('base64')).to.be.equal({ data: formStream('i`m a stream') }.toString());
+            expect(getById.getCall(0).args[0]).to.be.equal('object_id');
+            expect(getById.getCall(0).args[1]).to.be.equal('stream');
+        });
+    });
+});