@meltwater/conversations-api-services 1.3.2 → 1.4.0

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

@@ -1,6 +1,6 @@
 import superagent from 'superagent';
 import { removePrefix } from '../../lib/externalId.helpers.js';
-import { loggerDebug, loggerError, loggerInfo, loggerWarn } from '../../lib/logger.helpers.js';
+import { loggerDebug, loggerInfo, loggerWarn, MeltwaterAttributes } from '../../lib/logger.helpers.js';
 import OAuth from 'oauth-1.0a';
 import crypto from 'crypto';
 import axios from 'axios';
@@ -69,7 +69,12 @@ async function makeTwitterV2Request(v2Endpoint, v1FallbackQuery, token, logger)
           source: 'v1.1'
         };
       } catch (fallbackError) {
-        loggerError(logger, `Both v2 and v1.1 APIs failed for ${v2Endpoint}`, fallbackError);
+        loggerInfo(logger, `Failed to call twitter api - makeTwitterV2Request`, {
+          [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+            v2Endpoint,
+            error: fallbackError?.message
+          })
+        });
       }
     }
     return {
@@ -119,17 +124,25 @@ function normalizeUsersData(users) {
  * @returns {Promise<Object>} User data from v2 API
  */
 export async function getAuthenticatedUser(token, logger) {
+  const apiUrl = 'https://api.x.com/2/users/me';
   try {
     const result = await getRequest({
       token,
-      uri: 'https://api.x.com/2/users/me',
+      uri: apiUrl,
       attachUrlPrefix: false,
       convertPayloadToUri: false,
       logger
     });
     return result.data;
   } catch (e) {
-    loggerError(logger, `Error getting authenticated user info`, e);
+    loggerInfo(logger, `Failed to call twitter api - getAuthenticatedUser`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        apiUrl,
+        status: e?.response?.status,
+        responseBody: e?.response?.body,
+        error: e?.response?.body?.errors?.[0]?.message ?? e?.message
+      })
+    });
     throw e;
   }
 }
@@ -173,8 +186,12 @@ export async function getUserInfoFromHandles(token, handles, logger) {
     const normalizedData = normalizeUsersData(result.data, result.source);
     return normalizedData || [];
   } catch (e) {
-    loggerError(logger, `Unexpected error in getUserInfoFromHandles`, e);
-    return [];
+    loggerInfo(logger, `Failed to call twitter api - getUserInfoFromHandles`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        error: e?.message
+      })
+    });
+    throw e;
   }
 }
 export async function getUserInfoFromHandle(token, handleId, logger) {
@@ -196,7 +213,13 @@ export async function getUserInfoFromHandle(token, handleId, logger) {
       throw result.error || new Error('Failed to get user info from both APIs');
     }
   } catch (e) {
-    loggerError(logger, `Error in getUserInfoFromHandle with handleId: ${JSON.stringify(handleId)}`, e);
+    loggerInfo(logger, `Failed to call twitter api - getUserInfoFromHandle`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        handleId,
+        error: e?.message
+      })
+    });
+    throw e;
   }
 }
 export async function getDirectMessageImage(token, imageUrl, logger) {
@@ -212,7 +235,12 @@ export async function getDirectMessageImage(token, imageUrl, logger) {
       contentType: result.contentType
     };
   } catch (e) {
-    loggerError(logger, `Error getting image`, e);
+    loggerInfo(logger, `Failed to call twitter api - getDirectMessageImage`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        imageUrl,
+        error: e?.message
+      })
+    });
     throw e;
   }
 }
@@ -232,7 +260,13 @@ export async function getCurrentInfo(token, externalId, logger) {
     result.data.retweeted = !!result.data.current_user_retweet;
     return result.data.data[0].public_metrics;
   } catch (error) {
-    loggerDebug(logger, 'Error in twitter getCurrentInfo', error);
+    loggerInfo(logger, `Failed to call twitter api - getCurrentInfo`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        externalId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function getMentionHandleInfo(token, externalId, logger) {
@@ -247,7 +281,13 @@ export async function getMentionHandleInfo(token, externalId, logger) {
     });
     return result.data;
   } catch (error) {
-    loggerDebug(logger, 'Error in twitter getMentionHandleInfo', error);
+    loggerInfo(logger, `Failed to call twitter api - getMentionHandleInfo`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        externalId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function retweet(token, sourceId, externalId, logger) {
@@ -268,7 +308,14 @@ export async function retweet(token, sourceId, externalId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Error in retweet user: ${sourceId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - retweet`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        sourceId,
+        externalId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function unRetweet(token, sourceId, externalId, logger) {
@@ -284,15 +331,20 @@ export async function unRetweet(token, sourceId, externalId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Error in unretweet user: ${sourceId}`, error, {
-      [MeltwaterAttributes.SOCIALEXTERNALID]: externalId
+    loggerInfo(logger, `Failed to call twitter api - unRetweet`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        sourceId,
+        externalId,
+        error: error?.message
+      })
     });
+    throw error;
   }
 }
 export async function like(token, externalId, logger) {
+  let authenticatedUser = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
   try {
-    // Get the authenticated user's ID first
-    const userInfo = await getAuthenticatedUser(token, logger);
+    const userInfo = authenticatedUser ?? (await getAuthenticatedUser(token, logger));
     const userId = userInfo.data.id;
     let response = await postRequest({
       token,
@@ -313,14 +365,19 @@ export async function like(token, externalId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Twitter Error in like user: ${externalId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - like`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        externalId,
+        error: error?.message
+      })
+    });
     throw error;
   }
 }
 export async function unLike(token, externalId, logger) {
+  let authenticatedUser = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
   try {
-    // Get the authenticated user's ID first
-    const userInfo = await getAuthenticatedUser(token, logger);
+    const userInfo = authenticatedUser ?? (await getAuthenticatedUser(token, logger));
     const userId = userInfo.data.id;
     let response = await deleteRequest({
       token,
@@ -335,14 +392,19 @@ export async function unLike(token, externalId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Error in unlike user: ${externalId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - unLike`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        externalId,
+        error: error?.message
+      })
+    });
     throw error;
   }
 }
 export async function followUser(token, profileId, logger) {
+  let authenticatedUser = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
   try {
-    // Get the authenticated user's ID first
-    const userInfo = await getAuthenticatedUser(token, logger);
+    const userInfo = authenticatedUser ?? (await getAuthenticatedUser(token, logger));
     const userId = userInfo.data.id;
     let response = await postRequest({
       token,
@@ -360,13 +422,19 @@ export async function followUser(token, profileId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Error in following user: ${profileId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - followUser`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        profileId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function unFollowUser(token, profileId, logger) {
+  let authenticatedUser = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
   try {
-    // Get the authenticated user's ID first
-    const userInfo = await getAuthenticatedUser(token, logger);
+    const userInfo = authenticatedUser ?? (await getAuthenticatedUser(token, logger));
     const userId = userInfo.data.id;
     let response = await deleteRequest({
       token,
@@ -381,13 +449,19 @@ export async function unFollowUser(token, profileId, logger) {
       return false;
     }
   } catch (error) {
-    loggerDebug(logger, `Error in unfollowing user: ${profileId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - unFollowUser`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        profileId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function userFollowStatus(token, profileId, logger) {
+  let authenticatedUser = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
   try {
-    // Get the authenticated user's ID first
-    const userInfo = await getAuthenticatedUser(token, logger);
+    const userInfo = authenticatedUser ?? (await getAuthenticatedUser(token, logger));
     const userId = userInfo.data.id;
 
     // Check if authenticated user is following the target user
@@ -419,7 +493,7 @@ export async function userFollowStatus(token, profileId, logger) {
     if (error.message != 'Bad Request') {
       // if we hit a minor rate limit here, we wait for 5 seconds before attempting again, usually long enough to continue
       await new Promise(r => setTimeout(r, 5000));
-      return userFollowStatus(token, profileId, logger);
+      return userFollowStatus(token, profileId, logger, authenticatedUser);
     }
   }
 }
@@ -478,7 +552,14 @@ export async function getBrandUserRelationship(token, profileId, brandProfileId,
       }
     };
   } catch (error) {
-    loggerDebug(logger, `Error in getting user brand friendship info: ${profileId} and ${brandProfileId}`, error);
+    loggerInfo(logger, `Failed to call twitter api - getBrandUserRelationship`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        profileId,
+        brandProfileId,
+        error: error?.message
+      })
+    });
+    throw error;
   }
 }
 export async function createTweet(token, text, attachment, logger) {
@@ -690,7 +771,6 @@ async function publishTweet(token, payload, query, isDirectMessage, logger) {
     );
     return normalizedResponse;
   } catch (err) {
-    loggerError(logger, `Twitter publish exception details`, err);
     throw err;
   }
 }
@@ -723,7 +803,6 @@ async function publishDirectMessage(token, payload, query, logger) {
     const normalizedResponse = normalizeTwitterResponse(response, 'dm', logger);
     return normalizedResponse;
   } catch (err) {
-    loggerError(logger, `Twitter DM send failed`, err);
     throw err;
   }
 }
@@ -844,10 +923,14 @@ async function doRequest(_ref5) {
         });
         return reject(e);
       }
-      loggerError(logger, `Error in twitter doRequest`, e, {
-        url,
-        convertPayloadToUri,
-        payload: JSON.stringify(payload)
+      loggerInfo(logger, `Failed to call twitter api - doRequest`, {
+        [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+          url,
+          convertPayloadToUri,
+          payload: JSON.stringify(payload),
+          status: e?.response?.status,
+          error: e?.response?.body?.errors?.[0]?.message ?? e?.message
+        })
       });
       reject(e);
     }
@@ -917,7 +1000,6 @@ async function uploadMedia(attachment, token, discussionType, logger) {
       return mediaIdString;
     }
   } catch (e) {
-    loggerError(logger, `Failed uploading media`, e);
     if (filePath) {
       removeMedia(filePath, logger);
     }
@@ -952,7 +1034,13 @@ async function simpleMediaUpload(fileData, mimeType, mediaCategory, token, logge
     });
     return result.body.media_id_string;
   } catch (e) {
-    loggerError(logger, 'Error in simple media upload', e);
+    loggerInfo(logger, `Failed to call twitter api - simpleMediaUpload`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        mimeType,
+        mediaCategory,
+        error: e?.message
+      })
+    });
     throw e;
   }
 }
@@ -1009,7 +1097,6 @@ async function chunkedMediaUpload(filePath, fileSize, mimeType, mediaCategory, t
     }
     return mediaId;
   } catch (e) {
-    loggerError(logger, 'Error in chunked media upload', e);
     throw e;
   }
 }
@@ -1060,7 +1147,12 @@ async function mediaUploadRequest(params, token, logger) {
     const result = await request;
     return result.body;
   } catch (e) {
-    loggerError(logger, `Media upload request failed for command: ${params.command}`, e);
+    loggerInfo(logger, `Failed to call twitter api - mediaUploadRequest`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        command: params.command,
+        error: e?.message
+      })
+    });
     throw e;
   }
 }
@@ -1101,10 +1193,20 @@ function removeMedia(file, logger) {
   try {
     fs.unlink(file, function (err) {
       if (err) {
-        loggerError(logger, `Failed removing ${file}`, err);
+        loggerInfo(logger, `Failed to call twitter api - removeMedia`, {
+          [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+            file,
+            error: err?.message
+          })
+        });
       }
     });
   } catch (e) {
-    loggerError(logger, `failed trying to remove media ${file} it may have already been removed`);
+    loggerInfo(logger, `Failed to call twitter api - removeMedia`, {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        file,
+        error: e?.message
+      })
+    });
   }
 }

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

@@ -1,6 +1,6 @@
 import superagent from 'superagent';
 import { removePrefix } from '../../lib/externalId.helpers.js';
-import { loggerDebug, loggerError, loggerInfo } from '../../lib/logger.helpers.js';
+import { loggerInfo, MeltwaterAttributes } from '../../lib/logger.helpers.js';
 const YOUTUBE_API_URL = "https://www.googleapis.com/youtube/v3/";
 async function sendPost(token) {
   let paramString = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
@@ -10,11 +10,12 @@ async function sendPost(token) {
   try {
     response = await superagent.post(YOUTUBE_API_URL + paramString).set('Accept', 'application/json').set('Content-Type', 'application/json').set('Authorization', `Bearer ${token}`).send(postData);
   } catch (err) {
-    if (err && err.response && err.response.body && err.response.body.error) {
-      loggerError(logger, `Failed to call youtube api for paramString ${paramString}: ${err.response.body.error.message}`);
-    } else {
-      loggerError(logger, `Failed to call youtube api for paramString ${paramString}`, err);
-    }
+    loggerInfo(logger, 'Failed to call youtube api - sendPost', {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        paramString,
+        error: err?.response?.body?.error?.message ?? err?.message
+      })
+    });
     throw err;
   }
   return response;
@@ -26,18 +27,23 @@ export async function sendRequest(token) {
   try {
     response = await superagent.get(YOUTUBE_API_URL + paramString).set('Accept', 'application/json').set('Content-Type', 'application/json').set('Authorization', `Bearer ${token}`).send();
   } catch (err) {
-    if (err && err.response && err.response.body && err.response.body.error) {
-      loggerError(logger, `Failed to call youtube api for paramString ${paramString}: ${err.response.body.error.message}`);
-    } else {
-      loggerError(logger, `Failed to call youtube api for paramString ${paramString}`, err);
-    }
+    loggerInfo(logger, 'Failed to call youtube api - sendRequest', {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        paramString,
+        error: err?.response?.body?.error?.message ?? err?.message
+      })
+    });
     throw err;
   }
   if (response.status !== 200) {
-    loggerError(logger, `Failed to call facebook api`, {
-      responseBody: JSON.stringify(response.body)
+    loggerInfo(logger, 'Failed to call youtube api - sendRequest', {
+      [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        paramString,
+        status: response.status,
+        body: response.body
+      })
     });
-    let error = new Error(`Failed to call facebook api`);
+    let error = new Error(`Failed to call youtube api`);
     error.code = response.status;
     throw error;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@meltwater/conversations-api-services",
-    "version": "1.3.2",
+    "version": "1.4.0",
     "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",
@@ -39,8 +39,6 @@
         "@hapi/joi": "^17.1.1",
         "@meltwater/date-range": "^3.6.0",
         "@meltwater/engage-conversations-schemas": "^2.3.10",
-        "@meltwater/xrunes": "^1.1.1",
-        "@meltwater/xrunes-core": "^3.0.2",
         "apollo-server-hapi": "^3.13.0",
         "aws-sdk": "^2.1562.0",
         "dataloader": "^2.2.2",

package/src/data-access/http/README.md

@@ -0,0 +1,50 @@
+# Native API HTTP Modules
+
+Files matching `*.native.js` in this directory are thin HTTP clients for third-party social platform APIs (Instagram, Facebook, Twitter, LinkedIn, TikTok, YouTube, Threads). We do not control these APIs.
+
+## Logging contract
+
+Because external API failures are expected and noisy, these modules follow a strict logging convention:
+
+- **No `loggerError`** — use `loggerInfo` for all failures
+- **`loggerWarn`** is allowed for known/expected failure cases
+- **Every log must include a `PAYLOADDATA` block** — structured context that makes the log searchable and useful without being noisy
+
+### Pattern
+
+```js
+loggerInfo(logger, 'Failed to call <platform> api', {
+    [MeltwaterAttributes.PAYLOADDATA]: JSON.stringify({
+        apiUrl,        // endpoint called (no tokens in the URL)
+        someId,        // relevant IDs
+        status,        // HTTP status if available
+        error: err?.response?.body?.error ?? err?.message,
+    }),
+});
+```
+
+### Rules for PAYLOADDATA contents
+
+| Include | Exclude |
+|---|---|
+| API URL (path only, no credentials) | `accessToken`, `token`, any keys |
+| IDs: `externalId`, `sourceId`, `inReplyToId`, etc. | Raw `err` objects |
+| Operation params: `discussionType`, `hideStatus`, `fields`, etc. | Stack traces |
+| HTTP `status` and `responseBody` on non-200 | |
+| `error: err?.response?.body?.error ?? err?.message` | |
+
+## Reference implementation
+
+See [instagram.native.js](./instagram.native.js) for a fully converted example.
+
+## Files
+
+| File | Platform |
+|---|---|
+| `instagram.native.js` | Instagram Graph API |
+| `facebook.native.js` | Facebook Graph API |
+| `twitter.native.js` | Twitter/X API |
+| `linkedin.native.js` | LinkedIn API |
+| `tiktok.native.js` | TikTok API |
+| `youtube.native.js` | YouTube Data API |
+| `threads.native.js` | Threads API |