@meltwater/conversations-api-services 1.1.19 → 1.1.21

package/.nvmrc

@@ -1 +1 @@
-20.11.0
+20.17.0

package/dist/cjs/data-access/http/ir.client.js

@@ -36,9 +36,6 @@ class IRClient {
     this.traceId = traceId;
     this.metrics = metrics;
   }
-  async addRevisionsToDocuments(operations) {
-    return await addRevisionsToDocuments(operations, this.company._id, _logger.default);
-  }
   async modifyDocuments(operations) {
     let retryAttempt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
     await this.init();
@@ -217,23 +214,14 @@ class IRClient {
     return `engage_${this.company._id}_${this.traceId}_${(0, _uuid.v4)()}`;
   }
 }
+
+// everywhere in use it is surrounded by try catch so not needed here for better logging
 exports.default = IRClient;
-async function addRevisionsToDocuments(operations, companyId, logger) {
+async function addRevisionsToDocuments(operations, companyId) {
   const url = `${documentRevisionsServiceUrl}/${companyId}/`;
-  let result;
-  try {
-    result = await _superagent.default.patch(url).query({
-      apikey: documentServiceKey
-    }).set('x-client-name', 'engage-conversations').send(operations).then(result => result.body);
-  } catch (error) {
-    (0, _loggerHelpers.loggerError)(logger, `Failed adding a revisions with operations`, error, {
-      url,
-      [_loggerHelpers.MeltwaterAttributes.COMPANYID]: companyId,
-      operations: JSON.stringify(operations)
-    });
-    return;
-  }
-  return result;
+  return await _superagent.default.patch(url).query({
+    apikey: documentServiceKey
+  }).set('x-client-name', 'engage-conversations').send(operations).then(result => result.body);
 }
 async function markAsComplete(messageIds, companyId, logger) {
   return reviseDocumentHelper(messageIds, 'markAsComplete', companyId, logger);
@@ -295,11 +283,9 @@ async function reviseDocumentHelper(messageIds, revisionType, companyId, logger)
       (0, _loggerHelpers.loggerInfo)(logger, `Sending revision for ${revisionType} for companyId: ${companyId}`, {
         operations: JSON.stringify(operations)
       });
-      revisionPromises.push(addRevisionsToDocuments(operations, companyId, logger));
+      revisionPromises.push(addRevisionsToDocuments(operations, companyId));
     } catch (error) {
-      (0, _loggerHelpers.loggerError)(logger, `Error marking as ${revisionType} in IR for ${messageIds.length} document(s). Unable to save revision.`, error, {
-        messageIds
-      });
+      (0, _loggerHelpers.loggerError)(logger, `Error marking as ${revisionType} in IR for ${messageIds.length} document(s). Unable to save revision.`, error);
     }
   }
   return await Promise.all(revisionPromises);

package/dist/cjs/data-access/http/linkedin.native.js

@@ -354,7 +354,7 @@ async function getProfile(urn, token, logger) {
   let [,,, id] = urn.split(':');
   let profile;
   try {
-    profile = await _superagent.default.get(`${LINKEDIN_API}/people/(id:${id})`).query({
+    profile = await _superagent.default.get(`${LINKEDIN_API}/people/(id:${fixedEncodeURIComponent(id)})`).query({
       projection: '(id,localizedFirstName,localizedLastName,vanityName,profilePicture(displayImage~:playableStreams))'
     }).timeout(5000).set({
       Authorization: `Bearer ${token}`,
@@ -374,7 +374,7 @@ async function getOrganization(urn, token, logger) {
   let [,,, id] = urn.split(':');
   let organization;
   try {
-    organization = await _superagent.default.get(`${LINKEDIN_API}/organizations/${id}`).query({
+    organization = await _superagent.default.get(`${LINKEDIN_API}/organizations/${fixedEncodeURIComponent(id)}`).query({
       projection: '(id,localizedName,vanityName,logoV2(original~:playableStreams))'
     }).timeout(5000) // 5 seconds
     .set({

package/dist/cjs/data-access/http/tiktok.native.js

@@ -194,7 +194,7 @@ async function sendRequest(token) {
   }
   if (response.status !== 200) {
     (0, _loggerHelpers.loggerError)(logger, `Failed to call tiktok api`, {
-      responseBody: JSON.stringify(response.body)
+      [_loggerHelpers.MeltwaterAttributes.PAYLOADDATA]: JSON.stringify(response.body)
     });
     let error = new Error(`Failed to call tiktok api`);
     error.code = response.status;

package/dist/cjs/lib/logger.helpers.js

@@ -8,6 +8,17 @@ exports.loggerDebug = loggerDebug;
 exports.loggerError = loggerError;
 exports.loggerInfo = loggerInfo;
 exports.loggerWarn = loggerWarn;
+const {
+  RUN_PRECOG_AS = 'Conversations-Services',
+  LOGNAMESPACE = 'phoenix-local'
+} = process.env;
+const getServiceName = () => {
+  const rep = RUN_PRECOG_AS.replace(/_/g, '-');
+  return `precog-service-${rep.toLowerCase()}-${process.env.NODE_ENV}`;
+};
+const getInternalHeader = key => {
+  return `internal.${LOGNAMESPACE}.${key || 'unknown'}`;
+};
 const MeltwaterAttributes = exports.MeltwaterAttributes = {
   COMPANYID: 'meltwater.company.id',
   // Unique identifier of a company as it applies to meltwater search
@@ -53,7 +64,9 @@ const MeltwaterAttributes = exports.MeltwaterAttributes = {
   // The expiration of the auth credentials.
   AUTHPERMISSIONS: 'meltwater.auth.permissions',
   // List of auth permermissions.
-  USERID: 'user.id' // ID of the user
+  USERID: 'user.id',
+  // ID of the user
+  PAYLOADDATA: getInternalHeader('payloadData') // Post data for warpzone
 };
 function loggerDebug(logger, message) {
   let meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};

package/dist/esm/data-access/http/ir.client.js

@@ -25,9 +25,6 @@ export default class IRClient {
     this.traceId = traceId;
     this.metrics = metrics;
   }
-  async addRevisionsToDocuments(operations) {
-    return await addRevisionsToDocuments(operations, this.company._id, logger);
-  }
   async modifyDocuments(operations) {
     let retryAttempt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
     await this.init();
@@ -206,22 +203,13 @@ export default class IRClient {
     return `engage_${this.company._id}_${this.traceId}_${v4()}`;
   }
 }
-export async function addRevisionsToDocuments(operations, companyId, logger) {
+
+// everywhere in use it is surrounded by try catch so not needed here for better logging
+export async function addRevisionsToDocuments(operations, companyId) {
   const url = `${documentRevisionsServiceUrl}/${companyId}/`;
-  let result;
-  try {
-    result = await superagent.patch(url).query({
-      apikey: documentServiceKey
-    }).set('x-client-name', 'engage-conversations').send(operations).then(result => result.body);
-  } catch (error) {
-    loggerError(logger, `Failed adding a revisions with operations`, error, {
-      url,
-      [MeltwaterAttributes.COMPANYID]: companyId,
-      operations: JSON.stringify(operations)
-    });
-    return;
-  }
-  return result;
+  return await superagent.patch(url).query({
+    apikey: documentServiceKey
+  }).set('x-client-name', 'engage-conversations').send(operations).then(result => result.body);
 }
 export async function markAsComplete(messageIds, companyId, logger) {
   return reviseDocumentHelper(messageIds, 'markAsComplete', companyId, logger);
@@ -283,11 +271,9 @@ async function reviseDocumentHelper(messageIds, revisionType, companyId, logger)
       loggerInfo(logger, `Sending revision for ${revisionType} for companyId: ${companyId}`, {
         operations: JSON.stringify(operations)
       });
-      revisionPromises.push(addRevisionsToDocuments(operations, companyId, logger));
+      revisionPromises.push(addRevisionsToDocuments(operations, companyId));
     } catch (error) {
-      loggerError(logger, `Error marking as ${revisionType} in IR for ${messageIds.length} document(s). Unable to save revision.`, error, {
-        messageIds
-      });
+      loggerError(logger, `Error marking as ${revisionType} in IR for ${messageIds.length} document(s). Unable to save revision.`, error);
     }
   }
   return await Promise.all(revisionPromises);

package/dist/esm/data-access/http/linkedin.native.js

@@ -332,7 +332,7 @@ export async function getProfile(urn, token, logger) {
   let [,,, id] = urn.split(':');
   let profile;
   try {
-    profile = await superagent.get(`${LINKEDIN_API}/people/(id:${id})`).query({
+    profile = await superagent.get(`${LINKEDIN_API}/people/(id:${fixedEncodeURIComponent(id)})`).query({
       projection: '(id,localizedFirstName,localizedLastName,vanityName,profilePicture(displayImage~:playableStreams))'
     }).timeout(5000).set({
       Authorization: `Bearer ${token}`,
@@ -352,7 +352,7 @@ export async function getOrganization(urn, token, logger) {
   let [,,, id] = urn.split(':');
   let organization;
   try {
-    organization = await superagent.get(`${LINKEDIN_API}/organizations/${id}`).query({
+    organization = await superagent.get(`${LINKEDIN_API}/organizations/${fixedEncodeURIComponent(id)}`).query({
       projection: '(id,localizedName,vanityName,logoV2(original~:playableStreams))'
     }).timeout(5000) // 5 seconds
     .set({

package/dist/esm/data-access/http/tiktok.native.js

@@ -1,5 +1,5 @@
 import superagent from 'superagent';
-import { loggerError } from '../../lib/logger.helpers.js';
+import { loggerError, MeltwaterAttributes } from '../../lib/logger.helpers.js';
 import { removePrefix } from '../../lib/externalId.helpers.js';
 const TIKTOK_API_URL = 'https://business-api.tiktok.com/open_api/v1.3/business/';
 export async function comment(token, business_id, video_id, text, logger) {
@@ -177,7 +177,7 @@ async function sendRequest(token) {
   }
   if (response.status !== 200) {
     loggerError(logger, `Failed to call tiktok api`, {
-      responseBody: JSON.stringify(response.body)
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify(response.body)
     });
     let error = new Error(`Failed to call tiktok api`);
     error.code = response.status;

package/dist/esm/lib/logger.helpers.js

@@ -1,3 +1,14 @@
+const {
+  RUN_PRECOG_AS = 'Conversations-Services',
+  LOGNAMESPACE = 'phoenix-local'
+} = process.env;
+const getServiceName = () => {
+  const rep = RUN_PRECOG_AS.replace(/_/g, '-');
+  return `precog-service-${rep.toLowerCase()}-${process.env.NODE_ENV}`;
+};
+const getInternalHeader = key => {
+  return `internal.${LOGNAMESPACE}.${key || 'unknown'}`;
+};
 const MeltwaterAttributes = {
   COMPANYID: 'meltwater.company.id',
   // Unique identifier of a company as it applies to meltwater search
@@ -43,7 +54,9 @@ const MeltwaterAttributes = {
   // The expiration of the auth credentials.
   AUTHPERMISSIONS: 'meltwater.auth.permissions',
   // List of auth permermissions.
-  USERID: 'user.id' // ID of the user
+  USERID: 'user.id',
+  // ID of the user
+  PAYLOADDATA: getInternalHeader('payloadData') // Post data for warpzone
 };
 export function loggerDebug(logger, message) {
   let meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meltwater/conversations-api-services",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Repository to contain all conversations api services shared across our services",
   "main": "dist/cjs/data-access/index.js",
   "module": "dist/esm/data-access/index.js",
@@ -50,6 +50,7 @@
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
     "prom-client": "^15.1.0",
+    "sha.js": ">=2.4.12",
     "superagent": "^8.1.2",
     "winston": "^3.11.0"
   },

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

@@ -27,10 +27,6 @@ export default class IRClient {
         this.metrics = metrics;
     }
 
-    async addRevisionsToDocuments(operations) {
-        return await addRevisionsToDocuments(operations,this.company._id,logger);
-    }
-
     async modifyDocuments(operations, retryAttempt = 0) {
         await this.init();
         const wait = 100;
@@ -276,29 +272,18 @@ export default class IRClient {
     }
 }
 
-export async function addRevisionsToDocuments(operations, companyId, logger) {
+// everywhere in use it is surrounded by try catch so not needed here for better logging
+export async function addRevisionsToDocuments(operations, companyId) {
     const url = `${documentRevisionsServiceUrl}/${companyId}/`;
-    let result;
-
-    try {
-        result = await superagent
-            .patch(url)
-            .query({
-                apikey: documentServiceKey,
-            })
-            .set('x-client-name', 'engage-conversations')
-            .send(operations)
-            .then((result) => result.body);
-    } catch (error) {
-        loggerError(logger,`Failed adding a revisions with operations`, error, {
-            url,
-            [MeltwaterAttributes.COMPANYID]: companyId,
-            operations: JSON.stringify(operations)
-        });
-        return;
-    }
 
-    return result;
+    return await superagent
+        .patch(url)
+        .query({
+            apikey: documentServiceKey,
+        })
+        .set('x-client-name', 'engage-conversations')
+        .send(operations)
+        .then((result) => result.body);
 }
 
 export async function markAsComplete(messageIds, companyId, logger) {
@@ -386,13 +371,12 @@ async function reviseDocumentHelper(messageIds, revisionType, companyId, logger)
                 { operations: JSON.stringify(operations) }
             );
             revisionPromises.push(
-                addRevisionsToDocuments(operations,companyId,logger)
+                addRevisionsToDocuments(operations,companyId)
             );
         } catch (error) {
             loggerError(logger,
                 `Error marking as ${revisionType} in IR for ${messageIds.length} document(s). Unable to save revision.`,
-                error,
-                { messageIds }
+                error
             );
         }
     }

package/src/data-access/http/linkedin.native.js

@@ -441,7 +441,7 @@ export async function getProfile(urn, token, logger) {
     let profile;
     try {
         profile = await superagent
-            .get(`${LINKEDIN_API}/people/(id:${id})`)
+            .get(`${LINKEDIN_API}/people/(id:${fixedEncodeURIComponent(id)})`)
             .query({
                 projection:
                     '(id,localizedFirstName,localizedLastName,vanityName,profilePicture(displayImage~:playableStreams))',
@@ -475,7 +475,7 @@ export async function getOrganization(urn, token, logger) {
     let organization;
     try {
         organization = await superagent
-            .get(`${LINKEDIN_API}/organizations/${id}`)
+            .get(`${LINKEDIN_API}/organizations/${fixedEncodeURIComponent(id)}`)
             .query({
                 projection:
                     '(id,localizedName,vanityName,logoV2(original~:playableStreams))',

package/src/data-access/http/tiktok.native.js

@@ -1,5 +1,5 @@
 import superagent from 'superagent';
-import { loggerError } from '../../lib/logger.helpers.js';
+import { loggerError, MeltwaterAttributes } from '../../lib/logger.helpers.js';
 import { removePrefix } from '../../lib/externalId.helpers.js';
 
 const TIKTOK_API_URL =
@@ -267,7 +267,7 @@ async function sendRequest(token, paramString = '', logger) {
 
     if (response.status !== 200) {
         loggerError(logger, `Failed to call tiktok api`, {
-            responseBody: JSON.stringify(response.body),
+            [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify(response.body),
         });
         let error = new Error(`Failed to call tiktok api`);
         error.code = response.status;

package/src/lib/logger.helpers.js

@@ -1,3 +1,15 @@
+const { RUN_PRECOG_AS = 'Conversations-Services', LOGNAMESPACE = 'phoenix-local' } = process.env;
+
+const getServiceName = () => {
+    const rep = RUN_PRECOG_AS.replace(/_/g, '-');
+    return `precog-service-${rep.toLowerCase()}-${process.env.NODE_ENV}`;
+};
+
+
+const getInternalHeader = (key) => {
+    return `internal.${LOGNAMESPACE}.${key || 'unknown'}`;
+};
+
 const MeltwaterAttributes = {
     COMPANYID: 'meltwater.company.id', // Unique identifier of a company as it applies to meltwater search
     DOCUMENTID: 'meltwater.document.id', // Unique identifier of a document indexed into search
@@ -22,6 +34,7 @@ const MeltwaterAttributes = {
     AUTHEXP: 'meltwater.auth.exp', // The expiration of the auth credentials.
     AUTHPERMISSIONS: 'meltwater.auth.permissions', // List of auth permermissions.
     USERID: 'user.id', // ID of the user
+    PAYLOADDATA: getInternalHeader('payloadData'), // Post data for warpzone
 };
 
 export function loggerDebug(logger, message, meta = {}) {