@meltwater/conversations-api-services 1.0.11 → 1.0.13

package/src/data-access/http/instagramApi.client.js

@@ -3,6 +3,7 @@ import logger from '../../lib/logger.js';
 import { removePrefix } from '../../lib/externalId.helpers.js';
 import assert from 'assert';
 import { CredentialsApiClient } from '../http/credentialsApi.client.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 const INSTAGRAM_URL = 'https://graph.facebook.com';
 export class InstagramApiClient {
@@ -28,7 +29,7 @@ export class InstagramApiClient {
     ) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         try {
@@ -67,7 +68,7 @@ export class InstagramApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call instagram api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call instagram api for documentId ${documentId}`
@@ -76,7 +77,7 @@ export class InstagramApiClient {
             throw error;
         }
         loggerChild.debug('Instagram Response status', response.status);
-        loggerChild.debug('Instagram Response body', response.body);
+        loggerChild.debug('Instagram Response body', JSON.stringify(response.body));
         loggerChild.debug('Instagram Response body.id', response.body.id);
         return response;
     }
@@ -85,12 +86,12 @@ export class InstagramApiClient {
         let response;
         const { externalId, documentId } = payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram getPost api for documentId ${documentId}`,
-            { payload }
+            { payload: JSON.stringify(payload) }
         );
         try {
             response = await this.getPost(
@@ -106,7 +107,7 @@ export class InstagramApiClient {
             );
             return response.body;
         } catch (err) {
-            loggerChild.error('Error getLikes Instagram', { payload });
+            loggerChild.error('Error getLikes Instagram', { payload: JSON.stringify(payload) });
             return 0;
         }
     }
@@ -120,7 +121,7 @@ export class InstagramApiClient {
     ) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         try {
@@ -152,7 +153,7 @@ export class InstagramApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call instagram api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call instagram api for documentId ${documentId}`
@@ -161,7 +162,7 @@ export class InstagramApiClient {
             throw error;
         }
         loggerChild.debug('Instagram Response status', response.status);
-        loggerChild.debug('Instagram Response body', response.body);
+        loggerChild.debug('Instagram Response body', { response: JSON.stringify(response.body) });
         loggerChild.debug('Instagram Response body.id', response.body.id);
         return response;
     }
@@ -169,7 +170,7 @@ export class InstagramApiClient {
     async hideApi(apiUrl, accessToken, hideStatus, documentId) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         try {
@@ -195,7 +196,7 @@ export class InstagramApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call instagram api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call instagram api for documentId ${documentId}`
@@ -204,7 +205,7 @@ export class InstagramApiClient {
             throw error;
         }
         loggerChild.debug('Instagram Response status', response.status);
-        loggerChild.debug('Instagram Response body', response.body);
+        loggerChild.debug('Instagram Response body', { response: JSON.stringify(response.body) });
         loggerChild.debug('Instagram Response body.id', response.body.id);
         return response;
     }
@@ -212,7 +213,7 @@ export class InstagramApiClient {
     async getPost(apiUrl, accessToken, fields, documentId) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         try {
@@ -236,9 +237,8 @@ export class InstagramApiClient {
         }
 
         if (response.status !== 200) {
-            loggerChild.error(
-                `Failed to call instagram api for documentId ${documentId}`,
-                response.body
+            loggerChild.error(`Failed to call instagram api for documentId ${documentId}`,
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call instagram api for documentId ${documentId}`
@@ -247,7 +247,7 @@ export class InstagramApiClient {
             throw error;
         }
         loggerChild.debug('Instagram Response status', response.status);
-        loggerChild.debug('Instagram Response body', response.body);
+        loggerChild.debug('Instagram Response body', { response: JSON.stringify(response.body) });
         loggerChild.debug('Instagram Response body.id', response.body.id);
         return response;
     }
@@ -256,12 +256,12 @@ export class InstagramApiClient {
         let response;
         const { inReplyToId, text, documentId, isMention, sourceId } = payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram comment api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         this.validate(accessToken, payload);
@@ -304,12 +304,12 @@ export class InstagramApiClient {
             adCampaign,
         } = payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram comment api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         this.validate(accessToken, payload);
@@ -377,9 +377,9 @@ export class InstagramApiClient {
         };
 
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         let updatedDocument;
@@ -392,7 +392,7 @@ export class InstagramApiClient {
 
             loggerChild.debug(
                 `finished fetching token for instagram for ${documentId} on company ${companyId} `,
-                payload
+                { payload: JSON.stringify(payload) }
             );
 
             switch (discussionType) {
@@ -433,7 +433,7 @@ export class InstagramApiClient {
                     throw new Error('Unsupported discussion type');
             }
         } catch (err) {
-            loggerChild.error(documentId + ' - exception details ' + err, err);
+            loggerChild.error(`${documentId} - exception details`, err);
         }
 
         return apiResponse;
@@ -443,12 +443,12 @@ export class InstagramApiClient {
         let response;
         const { externalId, documentId } = payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram hide api for documentId ${documentId}`,
-            { payload }
+            { payload: JSON.stringify(payload) }
         );
 
         response = await this.hideApi(
@@ -469,12 +469,12 @@ export class InstagramApiClient {
         let response;
         const { externalId, documentId } = payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram unhide api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         response = await this.hideApi(
@@ -496,12 +496,12 @@ export class InstagramApiClient {
         const { profileId, text, documentId, isMention, sourceId, threadId } =
             payload;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call instagram private message api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         this.validate(accessToken, payload);

package/src/data-access/http/ir.client.js

@@ -3,6 +3,7 @@ import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
 import { metricN } from '../../lib/metrics.helper.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class IRClient {
     RETRY_COUNT = 50;
@@ -35,7 +36,7 @@ export class IRClient {
         const wait = 100;
         const url = `${this.documentRevisionsServiceUrl}/${this.company._id}/`;
         const loggerChild = logger.child({
-            'meltwater.company.id': this.company._id,
+            [MeltwaterAttributes.COMPANYID]: this.company._id,
         });
 
         let result;
@@ -51,16 +52,17 @@ export class IRClient {
                 .send(operations)
                 .then((result) => result.body);
         } catch (error) {
-            loggerChild.error(
-                `Failed adding a revisions with operation:${JSON.stringify(
-                    operations
-                )}`,
-                { error, url, companyId: this.company._id, operations }
-            );
+            loggerChild.error(`Failed adding a revisions with operations`, error, {
+                url,
+                [MeltwaterAttributes.COMPANYID]: this.company._id,
+                operations: JSON.stringify(operations)
+            });
             return;
         }
 
-        loggerChild.info(`Finished adding revision operations`, { operations });
+        loggerChild.info(`Finished adding revision operations`, {
+            operations: JSON.stringify(operations)
+        });
 
         return result;
     }
@@ -70,7 +72,7 @@ export class IRClient {
         const wait = 100;
         const url = `${this.documentServiceUrl}/`;
         const loggerChild = logger.child({
-            'meltwater.company.id': this.company._id,
+            [MeltwaterAttributes.COMPANYID]: this.company._id,
         });
 
         let result;
@@ -88,9 +90,9 @@ export class IRClient {
             retryAttempt++;
             if (retryAttempt > this.RETRY_COUNT) {
                 loggerChild.error(
-                    `Maximum Retrys hit for method modifyDocuments ${err.status} ${err.message}`,
-                    { err, companyId: this.company._id }
-                );
+                    `Maximum Retrys hit for method modifyDocuments ${err.status} ${err.message}`, err, {
+                    [MeltwaterAttributes.COMPANYID]: this.company._id
+                });
             } else if (
                 await this.retryBecauseRateLimiting(err, 'modifyDocuments')
             ) {
@@ -99,7 +101,7 @@ export class IRClient {
         }
 
         loggerChild.info(`Finished modifying documents operations`, {
-            operations,
+            operations: JSON.stringify(operations),
         });
 
         return result;
@@ -118,8 +120,8 @@ export class IRClient {
             retryAttempt++;
             if (retryAttempt > this.RETRY_COUNT) {
                 logger.error(
-                    `Maximum Retrys hit for method getDocumentById ${err.status} ${err.message}`,
-                    { err, 'meltwater.company.id': this.company._id }
+                    `Maximum Retrys hit for method getDocumentById ${err.status} ${err.message}`, err,
+                    { [MeltwaterAttributes.COMPANYID]: this.company._id }
                 );
             } else if (
                 await this.retryBecauseRateLimiting(err, 'getDocumentById')
@@ -131,15 +133,14 @@ export class IRClient {
 
     async retryBecauseRateLimiting(err, name) {
         const loggerChild = logger.child({
-            'meltwater.company.id': this.company._id,
+            [MeltwaterAttributes.COMPANYID]: this.company._id,
         });
 
         // rate limit error
         if (err.status === 429) {
             this.metrics.count(metricNames.irRatelimited);
             loggerChild.error(
-                `Error Accessing ir.client method because rate limit: trying again ${name}`,
-                { err }
+                `Error Accessing ir.client method because rate limit: trying again ${name}`, err
             );
             // should not be hitting rate limit in production
             // this is a patch for staging testing
@@ -148,13 +149,11 @@ export class IRClient {
         }
         if (err.status == 404) {
             loggerChild.info(
-                `Document Not Found ir.client method ${name} ${err.status} ${err.message}`,
-                { err }
+                `Document Not Found ir.client method ${name} ${err.status} ${err.message}`, err
             );
         } else {
             loggerChild.info(
-                `Could not access ir.client method ${name} ${err.status} ${err.message}`,
-                { err }
+                `Could not access ir.client method ${name} ${err.status} ${err.message}`, err
             );
         }
         return false;
@@ -189,9 +188,7 @@ export class IRClient {
 
             return result.body.exportKey;
         } catch (err) {
-            logger.error('Error executing search against Export API', {
-                err,
-            });
+            logger.error('Error executing search against Export API', err);
         }
     }
 
@@ -227,7 +224,7 @@ export class IRClient {
                         !index ||
                         (acc.length <= limitActual &&
                             acc[acc.length - 1].documentId !==
-                                document.quiddity.id)
+                            document.quiddity.id)
                     ) {
                         acc.push(document.quiddity);
                     } else if (
@@ -235,23 +232,20 @@ export class IRClient {
                         acc.length <= limitActual &&
                         acc[acc.length - 1].documentId === document.quiddity.id
                     ) {
-                        logger.info(
-                            `Duplicates in IR Search Results for DocumentId ` +
-                                document.quiddity.id,
-                            { document, irTraceId: traceId }
-                        );
+                        logger.info(`Duplicates in IR Search Results for DocumentId`, {
+                            irTraceId: traceId,
+                            document: JSON.stringify(document),
+                            [MeltwaterAttributes.DOCUMENTID]: document.quiddity.id,
+                        });
                     }
                     return acc;
                 },
                 []
             );
 
-            logger.info(
-                `Final Results Calculated, ${
-                    finalResults ? finalResults.length : 'no results'
-                }`,
-                { irTraceId: traceId, rune }
-            );
+            logger.info(`Final Results Calculated, ${finalResults ? finalResults.length : 'no results'}`, {
+                irTraceId: traceId, rune
+            });
 
             return finalResults;
             // original return function
@@ -259,8 +253,7 @@ export class IRClient {
             //     return document.quiddity;
             // })
         } catch (err) {
-            logger.error('Error executing search against Search Service', {
-                err,
+            logger.error('Error executing search against Search Service', err, {
                 irTraceId: traceId,
                 rune,
             });
@@ -280,8 +273,8 @@ export class IRClient {
             retryAttempt++;
             if (retryAttempt > this.RETRY_COUNT) {
                 logger.error(
-                    `Maximum Retrys hit for method latest ${err.status} ${err.message}`,
-                    { err, 'meltwater.company.id': this.company._id }
+                    `Maximum Retrys hit for method latest ${err.status} ${err.message}`, err,
+                    { [MeltwaterAttributes.COMPANYID]: this.company._id }
                 );
             } else if (await this.retryBecauseRateLimiting(err, 'latest')) {
                 return await this.latest(rune, retryAttempt);