@meltwater/conversations-api-services 1.0.11 → 1.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meltwater/conversations-api-services",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "Repository to contain all conversations api services shared across our services",
   "type": "module",
   "main": "src/data-access/index.js",

package/src/data-access/http/asset-manager-tvm.client.js

@@ -1,11 +1,12 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 const { ASSET_MANAGER_TVM_API_KEY, ASSET_MANAGER_TVM_URL } = process.env;
 
 class AssetManagerTVMRepository {
     apiKey;
-    constructor() {}
+    constructor() { }
 
     async get(companyId) {
         let response;
@@ -21,7 +22,9 @@ class AssetManagerTVMRepository {
                 })
                 .then((result) => result.body);
         } catch (error) {
-            logger.error(error, { 'meltwater.company.id': companyId });
+            logger.error("Failed requesting Asset Manager TVM API", error, {
+                [MeltwaterAttributes.COMPANYID]: companyId
+            });
             throw error;
         }
 

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class CompanyApiClient {
     constructor({ services }) {
@@ -20,10 +21,9 @@ export class CompanyApiClient {
                 .then((result) => result.body);
         } catch (error) {
             logger.error(
-                `Failed requesting Companies Api for companyId ${companyId} retry ${retries}`,
-                error,
-                { 'meltwater.company.id': companyId }
-            );
+                `Failed requesting Companies Api for companyId ${companyId} retry ${retries}`, error, {
+                [MeltwaterAttributes.COMPANYID]: companyId
+            });
 
             if (retries <= 3) {
                 return this.getById(companyId, jwt, ++retries);

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent'; // @todo remove superagent
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class CredentialsApiClient {
     constructor() {
@@ -39,8 +40,8 @@ export class CredentialsApiClient {
         userPermissionsEnabled
     ) {
         const loggerChild = logger.child({
-            'meltwater.company.id': companyId,
-            'user.id': userId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.USERID]: userId,
         });
 
         let credentials;
@@ -88,8 +89,8 @@ export class CredentialsApiClient {
     // todo: will this need to ever use productArea?
     async getToken(credentialId, companyId) {
         const loggerChild = logger.child({
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         let token;

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class EntitlementsApiClient {
     constructor({ services }) {
@@ -11,7 +12,7 @@ export class EntitlementsApiClient {
 
     async getById(entitlementId, companyId, jwt, retries = 0) {
         const loggerChild = logger.child({
-            'meltwater.company.id': companyId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
         });
 
         let entitlement;

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

@@ -2,6 +2,7 @@ import superagent from 'superagent'; // @todo remove superagent
 import logger from '../../lib/logger.js';
 import { removePrefix } from '../../lib/externalId.helpers.js';
 import { CredentialsApiClient } from '../http/credentialsApi.client.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 const FACEBOOK_URL = 'https://graph.facebook.com';
 export class FacebookApiClient {
@@ -37,14 +38,12 @@ export class FacebookApiClient {
             return response.body.shares && response.body.shares.count;
         } catch (error) {
             logger.error(
-                `${documentId} - error recieved - ${error.code}`,
-                error,
-                {
-                    'meltwater.document.id': documentId,
-                    'meltwater.company.id': companyId,
-                    'meltwater.social.credential_id': credentialId,
-                }
-            );
+                `${documentId} - error recieved - ${error.code}`, error, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            });
+
             return undefined;
         }
     }
@@ -68,27 +67,24 @@ export class FacebookApiClient {
                 `${FACEBOOK_URL}?ids=${documents
                     .map((doc) => removePrefix(doc.metaData.externalId))
                     .join(',')}&fields=` +
-                    `reactions.limit(0).summary(viewer_reaction).as(fb_post_reaction_of_user),` +
-                    `reactions.type(LOVE).limit(0).summary(total_count).as(fb_post_reactions_love),` +
-                    `reactions.type(WOW).limit(0).summary(total_count).as(fb_post_reactions_wow),` +
-                    `reactions.type(SAD).limit(0).summary(total_count).as(fb_post_reactions_sad),` +
-                    `reactions.type(LIKE).limit(0).summary(total_count).as(fb_post_reactions_like),` +
-                    `reactions.type(ANGRY).limit(0).summary(total_count).as(fb_post_reactions_angry),` +
-                    `reactions.type(HAHA).limit(0).summary(total_count).as(fb_post_reactions_haha)`,
+                `reactions.limit(0).summary(viewer_reaction).as(fb_post_reaction_of_user),` +
+                `reactions.type(LOVE).limit(0).summary(total_count).as(fb_post_reactions_love),` +
+                `reactions.type(WOW).limit(0).summary(total_count).as(fb_post_reactions_wow),` +
+                `reactions.type(SAD).limit(0).summary(total_count).as(fb_post_reactions_sad),` +
+                `reactions.type(LIKE).limit(0).summary(total_count).as(fb_post_reactions_like),` +
+                `reactions.type(ANGRY).limit(0).summary(total_count).as(fb_post_reactions_angry),` +
+                `reactions.type(HAHA).limit(0).summary(total_count).as(fb_post_reactions_haha)`,
                 token.token,
                 documentId
             );
             return response.body;
         } catch (error) {
             logger.error(
-                `${documentId} - error recieved - ${error.code}`,
-                error,
-                {
-                    'meltwater.document.id': documentId,
-                    'meltwater.company.id': companyId,
-                    'meltwater.social.credential_id': credentialId,
-                }
-            );
+                `${documentId} - error recieved - ${error.code}`, error, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            });
             return undefined;
         }
     }
@@ -98,12 +94,12 @@ export class FacebookApiClient {
         const { inReplyToId, text, documentId, attachment } = payload;
         const isGif = attachment && attachment.mimeType === 'image/gif';
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call facebook comment api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         response = await this.postApi(
@@ -121,9 +117,9 @@ export class FacebookApiClient {
         loggerChild.info(
             `Native Facebook API Publish Comment Response for documentId ${documentId}`,
             {
-                'meltwater.document.id': documentId,
-                status: response.status,
                 ok: response.ok,
+                status: response.status,
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
             }
         );
         return response.body;
@@ -135,12 +131,12 @@ export class FacebookApiClient {
             payload;
         const isGif = attachment && attachment.mimeType === 'image/gif';
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call facebook messages api for documentId ${documentId}`,
-            payload
+            { payload: JSON.stringify(payload) }
         );
 
         response = await this.postApi(
@@ -178,7 +174,7 @@ export class FacebookApiClient {
 
     async getApi(apiUrl, accessToken, documentId, payload, queryParams = {}) {
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         let response = {};
@@ -210,7 +206,7 @@ export class FacebookApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call facebook api for documentId ${documentId}`
@@ -225,7 +221,7 @@ export class FacebookApiClient {
     async postApi(apiUrl, accessToken, documentId, payload) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         try {
@@ -256,7 +252,7 @@ export class FacebookApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call facebook api for documentId ${documentId}`
@@ -270,7 +266,7 @@ export class FacebookApiClient {
 
     async deleteApi(apiUrl, accessToken, documentId, payload) {
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         let response = {};
@@ -302,7 +298,7 @@ export class FacebookApiClient {
         if (response.status !== 200) {
             loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
-                response.body
+                { response: JSON.stringify(response.body) }
             );
             let error = new Error(
                 `Failed to call facebook api for documentId ${documentId}`
@@ -332,9 +328,9 @@ export class FacebookApiClient {
         } = document;
 
         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;
@@ -397,10 +393,7 @@ export class FacebookApiClient {
                 );
             }
         } catch (exception) {
-            loggerChild.error(
-                documentId + ' - exception details ' + exception,
-                exception
-            );
+            loggerChild.error(`${documentId} - exception details`, exception);
             let findQuery = { documentId };
             findQuery['systemData.policies.storage.privateTo'] = companyId;
 
@@ -433,9 +426,9 @@ export class FacebookApiClient {
         let hideResponse;
 
         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,
         });
 
         try {
@@ -466,7 +459,7 @@ export class FacebookApiClient {
 
             loggerChild.debug(
                 `finished hiding in facebook for ${documentId} on company ${companyId} `,
-                { hideResponse }
+                { hideResponse: JSON.stringify(hideResponse) }
             );
 
             return hideResponse;
@@ -493,9 +486,9 @@ export class FacebookApiClient {
         } = document;
 
         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 banResponse;
@@ -529,7 +522,7 @@ export class FacebookApiClient {
 
             loggerChild.debug(
                 `finished banning in facebook for ${authorId} on company ${companyId} `,
-                { banResponse }
+                { banResponse: JSON.stringify(banResponse) }
             );
         } catch (error) {
             loggerChild.error(
@@ -553,9 +546,9 @@ export class FacebookApiClient {
             version,
         } = document;
         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,
         });
 
         try {
@@ -581,13 +574,10 @@ export class FacebookApiClient {
 
             loggerChild.debug(
                 `finished liking in facebook for ${documentId} on company ${companyId} `,
-                { likeResponse }
+                { likeResponse: JSON.stringify(likeResponse) }
             );
         } catch (error) {
-            loggerChild.error(
-                `${document} - error recieved - ${error.code}`,
-                error
-            );
+            loggerChild.error(`${document} - error recieved - ${error.code}`, error);
             throw error;
         }
     }
@@ -596,12 +586,12 @@ export class FacebookApiClient {
         let response;
         const { externalId, documentId } = command;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call facebook like api for documentId ${documentId}`,
-            { command }
+            { command: JSON.stringify(command) }
         );
 
         response = await this.postApi(
@@ -621,12 +611,12 @@ export class FacebookApiClient {
         let response;
         const { externalId, documentId } = command;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
         });
 
         loggerChild.debug(
             `Starting to call facebook unlike api for documentId ${documentId}`,
-            command
+            { command: JSON.stringify(command) }
         );
 
         response = await this.deleteApi(
@@ -646,13 +636,13 @@ export class FacebookApiClient {
         let response;
         const { externalId, documentId } = command;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
-            'meltwater.document.external_id': externalId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
         });
 
         loggerChild.debug(
             `Starting to call facebook hide api for documentId ${documentId}`,
-            { command }
+            { command: JSON.stringify(command) }
         );
 
         response = await this.postApi(
@@ -673,13 +663,13 @@ export class FacebookApiClient {
         let response;
         const { externalId, documentId } = command;
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
-            'meltwater.document.external_id': externalId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
         });
 
         loggerChild.debug(
             `Starting to call facebook unhide api for documentId ${documentId}`,
-            command
+            { command: JSON.stringify(command) }
         );
 
         response = await this.postApi(
@@ -727,15 +717,14 @@ export class FacebookApiClient {
         }
 
         logger.info(
-            `Native Facebook API is User Banned Response was invalid for userId ${userId} ${credentialId}`,
-            { status: response.status, ok: response.ok },
-            {
-                'meltwater.document.id': documentId,
-                'meltwater.social.credential_id': credentialId,
-                'meltwater.company.id': companyId,
-                'user.id': userId,
-            }
-        );
+            `Native Facebook API is User Banned Response was invalid for userId ${userId} ${credentialId}`, {
+            ok: response.ok,
+            status: response.status,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.USERID]: userId,
+        });
 
         return false;
     }
@@ -746,7 +735,7 @@ export class FacebookApiClient {
 
         logger.debug(
             `Starting to call facebook ban api for externalAuthorId ${authorId}`,
-            { command }
+            { command: JSON.stringify(command) }
         );
 
         response = await this.postApi(
@@ -769,7 +758,7 @@ export class FacebookApiClient {
 
         logger.debug(
             `Starting to call facebook unban api for externalAuthorId ${authorId}`,
-            command
+            { command: JSON.stringify(command) }
         );
 
         response = await this.deleteApi(

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class FeatureToggleClient {
     constructor() {
@@ -27,9 +28,9 @@ export class FeatureToggleClient {
             return result.body.treatments;
         } catch (error) {
             logger.error(
-                `Failed requesting Feature Toggle service for feature toggle get `,
-                { error, 'meltwater.company.id': companyId }
-            );
+                `Failed requesting Feature Toggle service for feature toggle get `, error, {
+                [MeltwaterAttributes.COMPANYID]: companyId
+            });
         }
     }
 }

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class IdentityServicesClient {
     constructor({ companyId, services }) {
@@ -15,8 +16,8 @@ export class IdentityServicesClient {
         try {
             let resignedToken = await this.authService.getResignedToken(jwt);
             const loggerChild = logger.child({
-                'meltwater.user.id': userId,
-                'meltwater.company.id': this.companyId,
+                [MeltwaterAttributes.USERID]: userId,
+                [MeltwaterAttributes.COMPANYID]: this.companyId,
             });
 
             user = await superagent
@@ -46,7 +47,7 @@ export class IdentityServicesClient {
     async getAllUsers(jwt, retries = 0) {
         let users;
         const loggerChild = logger.child({
-            'meltwater.company.id': this.companyId,
+            [MeltwaterAttributes.COMPANYID]: this.companyId,
         });
 
         try {