update (#73)

Author: EmptyInfinity

.gitignore

@@ -104,4 +104,6 @@ typings/
 .vscode
 .idea
 !.eslintrc.js
-*.d.ts
+*.d.ts
+
+/dist/package.json

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.2 (August 26, 2022)
+* Updated @elasticio/maester-client to v4.0.3
+
 ## 3.0.1 (August 12, 2022)
 * Increase default values and limits for envs `API_RETRIES_COUNT` and `API_REQUEST_TIMEOUT`
 * Add `axiosReqWithRetryOnServerError` function to proceed with most commons use cases of making query to external API

dist/src/attachment/AttachmentProcessor.js

@@ -13,15 +13,17 @@ const logger_1 = require("../logger/logger");
 const package_json_1 = __importDefault(require("../../package.json"));
 const logger = (0, logger_1.getLogger)();
 const maesterClientVersion = package_json_1.default.dependencies['@elastic.io/maester-client'];
+const axiosVersion = package_json_1.default.dependencies.axios;
 exports.STORAGE_TYPE_PARAMETER = 'storage_type';
 exports.DEFAULT_STORAGE_TYPE = 'steward';
 exports.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 DEFAULT_ATTACHMENT_REQUEST_TIMEOUT = process.env.REQUEST_TIMEOUT ? parseInt(process.env.REQUEST_TIMEOUT, 10) : interfaces_1.REQUEST_TIMEOUT.maxValue; // 20s
 class AttachmentProcessor {
-    constructor(userAgent) {
-        this.userAgent = `${userAgent} maester-client/${maesterClientVersion}`;
+    constructor(userAgent, msgId) {
+        this.userAgent = userAgent;
+        this.msgId = msgId;
     }
     async getAttachment(url, responseType) {
         const storageType = this.getStorageTypeByUrl(url);
@@ -31,7 +33,6 @@ class AttachmentProcessor {
             method: 'get',
             timeout: DEFAULT_ATTACHMENT_REQUEST_TIMEOUT,
             retry: interfaces_1.RETRIES_COUNT.defaultValue,
-            headers: { 'User-Agent': this.userAgent }
         };
         switch (storageType) {
             case 'steward': return this.getStewardAttachment(axConfig);
@@ -58,10 +59,18 @@ class AttachmentProcessor {
     async getStewardAttachment(axConfig) {
         const ax = axios_1.default.create();
         this.addRetryCountInterceptorToAxios(ax);
-        return ax(axConfig);
+        const userAgent = `${this.userAgent} axios/${axiosVersion}`;
+        return ax({
+            ...axConfig,
+            headers: {
+                'User-Agent': userAgent,
+                'x-request-id': `f:${process.env.ELASTICIO_FLOW_ID};s:${process.env.ELASTICIO_STEP_ID};m:${this.msgId}`,
+            }
+        });
     }
     async getMaesterAttachment({ url, responseType }) {
-        const objectStorage = new maester_client_1.ObjectStorage({ ...maesterCreds, userAgent: this.userAgent });
+        const userAgent = `${this.userAgent} maester-client/${maesterClientVersion}`;
+        const objectStorage = new maester_client_1.ObjectStorage({ ...maesterCreds, userAgent, msgId: this.msgId });
         const maesterAttachmentId = this.getMaesterAttachmentIdByUrl(url);
         const response = await objectStorage.getOne(maesterAttachmentId, { responseType });
         return { data: response };

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic.io/component-commons-library",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Library for most common component development cases",
   "author": {
     "name": "elastic.io GmbH",
@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "@elastic.io/jsonata-moment": "1.1.4",
-    "@elastic.io/maester-client": "4.0.2",
+    "@elastic.io/maester-client": "4.0.3",
     "@elastic.io/ntlm-client": "1.0.0",
     "async": "3.2.3",
     "axios": "0.27.2",

package.json

@@ -9,6 +9,7 @@ import packageJson from '../../package.json';
 
 const logger = getLogger();
 const maesterClientVersion = packageJson.dependencies['@elastic.io/maester-client'];
+const axiosVersion = packageJson.dependencies.axios;
 
 export const STORAGE_TYPE_PARAMETER = 'storage_type';
 export const DEFAULT_STORAGE_TYPE = 'steward';
@@ -20,8 +21,11 @@ const DEFAULT_ATTACHMENT_REQUEST_TIMEOUT = process.env.REQUEST_TIMEOUT ? parseIn
 export class AttachmentProcessor {
   private userAgent: string;
 
-  public constructor(userAgent: string) {
-    this.userAgent = `${userAgent} maester-client/${maesterClientVersion}`;
+  private msgId: string;
+
+  public constructor(userAgent?: string, msgId?: string) {
+    this.userAgent = userAgent;
+    this.msgId = msgId;
   }
 
   async getAttachment(url: string, responseType: string) {
@@ -32,7 +36,6 @@ export class AttachmentProcessor {
       method: 'get',
       timeout: DEFAULT_ATTACHMENT_REQUEST_TIMEOUT,
       retry: RETRIES_COUNT.defaultValue,
-      headers: { 'User-Agent': this.userAgent }
     } as AxiosRequestConfig;
 
     switch (storageType) {
@@ -62,11 +65,19 @@ export class AttachmentProcessor {
   private async getStewardAttachment(axConfig) {
     const ax = axios.create();
     this.addRetryCountInterceptorToAxios(ax);
-    return ax(axConfig);
+    const userAgent = `${this.userAgent} axios/${axiosVersion}`;
+    return ax({
+      ...axConfig,
+      headers: {
+        'User-Agent': userAgent,
+        'x-request-id': `f:${process.env.ELASTICIO_FLOW_ID};s:${process.env.ELASTICIO_STEP_ID};m:${this.msgId}`,
+      }
+    });
   }
 
   private async getMaesterAttachment({ url, responseType }: { url: string, responseType: ResponseType }) {
-    const objectStorage = new ObjectStorage({ ...maesterCreds, userAgent: this.userAgent });
+    const userAgent = `${this.userAgent} maester-client/${maesterClientVersion}`;
+    const objectStorage = new ObjectStorage({ ...maesterCreds, userAgent, msgId: this.msgId });
     const maesterAttachmentId = this.getMaesterAttachmentIdByUrl(url);
     const response = await objectStorage.getOne(maesterAttachmentId, { responseType });
     return { data: response };