Added maester-implementation for getAttachment, maxContentLength fix (#46)

* Fixed bug with misspelling maxContentLength and maxBodyLenth of request config
* added maester implementation for getAttachment

Author: EmptyInfinity

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.6 (July 29, 2021)
+* Now `getAttachment` from `AttachmentProcessor` may retrieve items from `Maester`
+
 ## 1.1.5 (October 29, 2020)
 * Allow the response handler to be overridden at a per request level.
 * Bump dependencies.

README.md

@@ -18,7 +18,7 @@
 # Description
 This library provides some of the most common component development functionality in a simple, reusable way.
 
-To install, type 
+To install, type
 
 ```
 npm install @elastic.io/component-commons-library
@@ -32,7 +32,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.
 
 ### 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/lib/authentication/NoAuthRestClient.ts) class to make rest requests no no auth APIs by provided options.
 
 #### constructor(emitter, cfg)
 - emitter - EIO emitting context.
@@ -123,12 +123,12 @@ 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)
 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. 
+Makes requests to resource with [NTLM authentication](https://en.wikipedia.org/wiki/NT_LAN_Manager).
+Falls back to basic authentication if NTLM authentication fails.
 Handles both V1 and V2 of the NTLM Protocol.
 
 #### constructor(emitter, cfg)
-- cfg.username - mandatory cfg parameter contains username for authorization.  Domain information should be combined with this field. (e.g. `SOMEDOMAIN\SomeUser`) 
+- cfg.username - mandatory cfg parameter contains username for authorization.  Domain information should be combined with this field. (e.g. `SOMEDOMAIN\SomeUser`)
 - cfg.password - mandatory cfg parameter contains password for authorization.
 
 ```
@@ -150,7 +150,9 @@ Contains functions to transform platform data that contains JSONata expressions
 The attachment processor function can be used to store attachments on the platform. It exposes the following functions
 
 - `uploadAttachment(streamContent)`, which will upload an attachment to the platform and return the result and file url
-- `getAttachment(url, contentType)`, which will retrieve an attachment from the platform
+- `getAttachment(url, contentType)`, which will retrieve an attachment from `steward` or `maester` storage. To specify the storage - query parameter
+`storage_type` must be provided. To get items from `maester` storage - `?storage_type=maester` should added to the `url` argument. By default attachments are retrieved from `steward` storage, so `?storage_type=steward` is not obligated to be added to the `url` argument. `contentType` -
+one of [`stream`, `arraybuffer` ]
 
 Example:
 
@@ -162,6 +164,13 @@ const result = await new AttachmentProcessor().uploadAttachment(stream);
 
 const storedFileUrl = result.config.url;
 ```
+```javascript
+const { AttachmentProcessor } = require('@elastic.io/component-commons-library');
+
+const result = await new AttachmentProcessor().getAttachment('http://example.com', 'stream'); // steward storage
+const result = await new AttachmentProcessor().getAttachment('http://example.com?storage_type=steward', 'arraybuffer'); // steward storage
+const result = await new AttachmentProcessor().getAttachment('http://example.com?storage_type=maester', 'stream'); // maester storage
+```
 
 ## 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).

lib/attachment/AttachmentProcessor.ts

@@ -1,17 +1,22 @@
 import axios, { AxiosRequestConfig } from 'axios';
+import { URL } from 'url';
+import { StorageClient, ObjectStorage } from '@elastic.io/maester-client/dist';
 const restNodeClient = require('elasticio-rest-node')();
 
+export const STORAGE_TYPE_PARAMETER = 'storage_type';
+export const DEFAULT_STORAGE_TYPE = 'steward';
+export const MAESTER_OBJECT_ID_ENDPOINT = '/objects/';
+const { ELASTICIO_OBJECT_STORAGE_TOKEN = '' , ELASTICIO_OBJECT_STORAGE_URI = '' } = process.env;
+const maesterCreds = { jwtSecret: ELASTICIO_OBJECT_STORAGE_TOKEN, uri: ELASTICIO_OBJECT_STORAGE_URI };
 const REQUEST_TIMEOUT = process.env.REQUEST_TIMEOUT ? parseInt(process.env.REQUEST_TIMEOUT, 10) : 10000; // 10s
 const REQUEST_MAX_RETRY = process.env.REQUEST_MAX_RETRY ? parseInt(process.env.REQUEST_MAX_RETRY, 10) : 7; // 10s
 const REQUEST_RETRY_DELAY = process.env.REQUEST_RETRY_DELAY ? parseInt(process.env.REQUEST_RETRY_DELAY, 10) : 7000; // 7s
-const REQUEST_MAX_CONTENT_LENGTH = process.env.REQUEST_MAX_CONTENT_LENGTH ? parseInt(process.env.REQUEST_MAX_CONTENT_LENGTH, 10) : 10485760; // 10MB
+const REQUEST_MAX_BODY_LENGTH = process.env.REQUEST_MAX_BODY_LENGTH ? parseInt(process.env.REQUEST_MAX_BODY_LENGTH, 10) : 10485760; // 10MB
 
 export class AttachmentProcessor {
 
   async getAttachment(url: string, responseType: string) {
-    const ax = axios.create();
-    AttachmentProcessor.addRetryCountInterceptorToAxios(ax);
-
+    const storageType = AttachmentProcessor.getStorageTypeByUrl(url);
     const axConfig = {
       url,
       responseType,
@@ -21,7 +26,11 @@ export class AttachmentProcessor {
       delay: REQUEST_RETRY_DELAY,
     } as AxiosRequestConfig;
 
-    return ax(axConfig);
+    switch (storageType) {
+      case 'steward': return AttachmentProcessor.getStewardAttachment(axConfig);
+      case 'maester': return AttachmentProcessor.getMaesterAttachment(axConfig);
+      default: throw new Error(`Storage type "${storageType}" is not supported`);
+    }
   }
 
   async uploadAttachment(body) {
@@ -36,7 +45,7 @@ export class AttachmentProcessor {
       timeout: REQUEST_TIMEOUT,
       retry: REQUEST_MAX_RETRY,
       delay: REQUEST_RETRY_DELAY,
-      maxContentLength: REQUEST_MAX_CONTENT_LENGTH,
+      maxBodyLength: REQUEST_MAX_BODY_LENGTH,
     } as AxiosRequestConfig;
 
     return ax(axConfig);
@@ -47,6 +56,35 @@ export class AttachmentProcessor {
     return signedUrl.put_url;
   }
 
+  static async getStewardAttachment(axConfig) {
+    const ax = axios.create();
+    AttachmentProcessor.addRetryCountInterceptorToAxios(ax);
+    return ax(axConfig);
+  }
+
+  static async getMaesterAttachment(axConfig) {
+    const client = new StorageClient(maesterCreds);
+    const objectStorage = new ObjectStorage(maesterCreds, client);
+    const maesterAttachmentId = AttachmentProcessor.getMaesterAttachmentIdByUrl(axConfig.url);
+    const response = await objectStorage.getById(maesterAttachmentId, axConfig.responseType);
+    return { data: response };
+  }
+
+  static getStorageTypeByUrl(urlString) {
+    const url = new URL(urlString);
+    const storageType = url.searchParams.get(STORAGE_TYPE_PARAMETER);
+    return storageType || DEFAULT_STORAGE_TYPE;
+  }
+
+  static getMaesterAttachmentIdByUrl(urlString): string {
+    const { pathname } = new URL(urlString);
+    const maesterAttachmentId = pathname.split(MAESTER_OBJECT_ID_ENDPOINT)[1];
+    if (!maesterAttachmentId) {
+      throw new Error('Invalid Maester Endpoint');
+    }
+    return maesterAttachmentId;
+  }
+
   static addRetryCountInterceptorToAxios(ax) {
     ax.interceptors.response.use(undefined, (err) => { //  Retry count interceptor for axios
       const { config } = err;