@meltwater/conversations-api-services 1.0.7 → 1.0.9

package/.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credential: false
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: NPM Auth Setup
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify signatures
+        run: npm audit signatures
+      - name: Release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: npx semantic-release

package/README.md

@@ -2,41 +2,10 @@
 
 Repository to contain all conversations api services shared across our services
 
----
-
-This section should answer:
-
-> What is this?
-
-Adding visuals to this project description will make your project more memorable and the README easier to understand.
-
-Great examples:
-
--   [meltwater/contact-source-service](https://github.com/meltwater/contact-source-service) - _It is the backend behind the Influencers application used by Meltwater customers. It provides sources/contacts management and search capabilities._
--   [release-it/release-it](https://github.com/release-it/release-it) - _‌Generic CLI tool to automate versioning and package publishing related tasks_
-
-## Product / Business Purpose
-
-An explanation of the business purpose of this repo, e.g. the Meltwater Product that this ties into. This section should answer:
-
-> Why does this exist?
-
-Great examples:
-
--   [meltwater/chat-message-integration](https://github.com/meltwater/chat-message-integration) _The chat-message-integration project is the API that is used to configure and handle messages for Slack and Teams integrations in the MI App._
--   [meltwater/explore-compare-service](https://github.com/meltwater/explore-compare-service) - _Compares in Explorer allow users to run several saved queries at the same time and do a comparison._
-
 ## Maintainers
 
-Meltwater's current ownership model assumes that every piece of software running in Production is owned by a team. This section should answer:
-
-> Who owns this?
-> Who to contact for help?
-
-Example:
-
-> Maintained by TEAM_NAME (TEAM_EMAIL_ADDRESS@meltwater.com).
-> Contact us via #TEAM_SLACK_CHANNEL in Slack.
+> Maintained by Phoenix (phoenix@meltwater.com).
+> Contact us via #eng-team-phoenix in Slack.
 
 ## Contributing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meltwater/conversations-api-services",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Repository to contain all conversations api services shared across our services",
   "type": "module",
   "main": "src/data-access/index.js",
@@ -23,6 +23,7 @@
   },
   "homepage": "https://github.com/meltwater/conversations-api-services#readme",
   "dependencies": {
+    "@elastic/ecs-winston-format": "^1.5.3",
     "@hapi/joi": "^17.1.1",
     "@meltwater/date-range": "^3.6.0",
     "@meltwater/engage-conversations-schemas": "^2.3.10",

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

@@ -21,7 +21,7 @@ class AssetManagerTVMRepository {
                 })
                 .then((result) => result.body);
         } catch (error) {
-            logger.error(error);
+            logger.error(error, { 'meltwater.company.id': companyId });
             throw error;
         }
 

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

@@ -21,7 +21,8 @@ export class CompanyApiClient {
         } catch (error) {
             logger.error(
                 `Failed requesting Companies Api for companyId ${companyId} retry ${retries}`,
-                error
+                error,
+                { 'meltwater.company.id': companyId }
             );
 
             if (retries <= 3) {

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

@@ -38,10 +38,15 @@ export class CredentialsApiClient {
         { companyId, userId, productArea },
         userPermissionsEnabled
     ) {
+        const loggerChild = logger.child({
+            'meltwater.company.id': companyId,
+            'user.id': userId,
+        });
+
         let credentials;
         try {
             if (productArea) {
-                logger.info(
+                loggerChild.info(
                     `Get Credentials for company: ${companyId} and user: ${userId}`
                 );
                 credentials = await superagent
@@ -66,14 +71,14 @@ export class CredentialsApiClient {
                     .then((result) => result.body.data);
             }
         } catch (error) {
-            logger.error(
+            loggerChild.error(
                 `Failed requesting Credentials API for companyId ${companyId} ${userId}`,
                 error
             );
             return [];
         }
 
-        logger.info(
+        loggerChild.info(
             `Finished requesting Credentials API for companyId ${companyId}`
         );
 
@@ -82,6 +87,11 @@ 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,
+        });
+
         let token;
         try {
             token = await superagent
@@ -92,14 +102,14 @@ export class CredentialsApiClient {
                     return result.body;
                 });
         } catch (error) {
-            logger.error(
+            loggerChild.error(
                 `Failed requesting Credentials API for credentialId ${credentialId} and companyId ${companyId}`,
                 error
             );
             return;
         }
 
-        logger.info(
+        loggerChild.info(
             `Finished requesting Credentials API for credentialId ${credentialId} and companyId ${companyId}`
         );
 

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

@@ -10,6 +10,10 @@ export class EntitlementsApiClient {
     }
 
     async getById(entitlementId, companyId, jwt, retries = 0) {
+        const loggerChild = logger.child({
+            'meltwater.company.id': companyId,
+        });
+
         let entitlement;
         try {
             let resignedToken = await this.authService.getResignedToken(jwt);
@@ -21,7 +25,7 @@ export class EntitlementsApiClient {
                 .set('x-client-name', configuration.get('CLIENT_NAME_HEADER'))
                 .then((result) => result.body);
         } catch (error) {
-            logger.error(
+            loggerChild.error(
                 `Failed requesting entitlement ${entitlementId} for companyId ${companyId} retry ${retries}`,
                 error
             );
@@ -32,7 +36,7 @@ export class EntitlementsApiClient {
             return;
         }
 
-        logger.info(
+        loggerChild.info(
             `Finished requesting entitlement ${entitlementId} for companyId ${companyId}`
         );
 

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

@@ -38,7 +38,12 @@ export class FacebookApiClient {
         } catch (error) {
             logger.error(
                 `${documentId} - error recieved - ${error.code}`,
-                error
+                error,
+                {
+                    'meltwater.document.id': documentId,
+                    'meltwater.company.id': companyId,
+                    'meltwater.social.credential_id': credentialId,
+                }
             );
             return undefined;
         }
@@ -77,7 +82,12 @@ export class FacebookApiClient {
         } catch (error) {
             logger.error(
                 `${documentId} - error recieved - ${error.code}`,
-                error
+                error,
+                {
+                    'meltwater.document.id': documentId,
+                    'meltwater.company.id': companyId,
+                    'meltwater.social.credential_id': credentialId,
+                }
             );
             return undefined;
         }
@@ -87,8 +97,11 @@ export class FacebookApiClient {
         let response;
         const { inReplyToId, text, documentId, attachment } = payload;
         const isGif = attachment && attachment.mimeType === 'image/gif';
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
 
-        logger.debug(
+        loggerChild.debug(
             `Starting to call facebook comment api for documentId ${documentId}`,
             payload
         );
@@ -105,9 +118,13 @@ export class FacebookApiClient {
                     isGif && { attachment_share_url: attachment.link }),
             }
         );
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Publish Comment Response for documentId ${documentId}`,
-            { status: response.status, ok: response.ok }
+            {
+                'meltwater.document.id': documentId,
+                status: response.status,
+                ok: response.ok,
+            }
         );
         return response.body;
     }
@@ -117,7 +134,11 @@ export class FacebookApiClient {
         const { profileId, recipientId, text, documentId, attachment } =
             payload;
         const isGif = attachment && attachment.mimeType === 'image/gif';
-        logger.debug(
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
+
+        loggerChild.debug(
             `Starting to call facebook messages api for documentId ${documentId}`,
             payload
         );
@@ -145,14 +166,21 @@ export class FacebookApiClient {
                 tag: 'HUMAN_AGENT',
             }
         );
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Publish Private Message Response for documentId ${documentId}`,
-            { status: response.status, ok: response.ok }
+            {
+                status: response.status,
+                ok: response.ok,
+            }
         );
         return response.body;
     }
 
     async getApi(apiUrl, accessToken, documentId, payload, queryParams = {}) {
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
+
         let response = {};
         try {
             response = await superagent
@@ -170,17 +198,17 @@ export class FacebookApiClient {
                 err.response.body.error
             ) {
                 errorText = `Failed to call facebook api for documentId ${documentId}: ${err.response.body.error.message}`;
-                logger.error(errorText);
+                loggerChild.error(errorText);
             } else {
                 errorText = `Failed to call facebook api for documentId ${documentId}`;
-                logger.error(errorText, err);
+                loggerChild.error(errorText, err);
             }
 
             throw new Error(errorText);
         }
 
         if (response.status !== 200) {
-            logger.error(
+            loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
                 response.body
             );
@@ -196,6 +224,10 @@ export class FacebookApiClient {
 
     async postApi(apiUrl, accessToken, documentId, payload) {
         let response = {};
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
+
         try {
             response = await superagent
                 .post(apiUrl)
@@ -212,17 +244,17 @@ export class FacebookApiClient {
                 err.response.body.error
             ) {
                 errorText = `Failed to call facebook api for documentId ${documentId}: ${err.response.body.error.message}`;
-                logger.error(errorText);
+                loggerChild.error(errorText);
             } else {
                 errorText = `Failed to call facebook api for documentId ${documentId}`;
-                logger.error(errorText, err);
+                loggerChild.error(errorText, err);
             }
 
             throw new Error(errorText);
         }
 
         if (response.status !== 200) {
-            logger.error(
+            loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
                 response.body
             );
@@ -237,6 +269,10 @@ export class FacebookApiClient {
     }
 
     async deleteApi(apiUrl, accessToken, documentId, payload) {
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
+
         let response = {};
         try {
             response = await superagent
@@ -254,17 +290,17 @@ export class FacebookApiClient {
                 err.response.body.error
             ) {
                 errorText = `Failed to call facebook api for documentId ${documentId}: ${err.response.body.error.message}`;
-                logger.error(errorText);
+                loggerChild.error(errorText);
             } else {
                 errorText = `Failed to call facebook api for documentId ${documentId}`;
-                logger.error(errorText, err);
+                loggerChild.error(errorText, err);
             }
 
             throw new Error(errorText);
         }
 
         if (response.status !== 200) {
-            logger.error(
+            loggerChild.error(
                 `Failed to call facebook api for documentId ${documentId}`,
                 response.body
             );
@@ -295,6 +331,12 @@ export class FacebookApiClient {
             } = {},
         } = document;
 
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.company.id': companyId,
+            'meltwater.social.credential_id': credentialId,
+        });
+
         let updatedDocument;
         let apiResponse;
         try {
@@ -302,8 +344,8 @@ export class FacebookApiClient {
                 credentialId,
                 companyId
             );
-            logger.debug(
-                `finished fetching token for Facebook for ${documentId} on company ${companyId} `
+            loggerChild.debug(
+                `finished fetching token for Facebook for ${documentId} on company ${companyId}`
             );
             let payload;
             switch (discussionType) {
@@ -355,7 +397,7 @@ export class FacebookApiClient {
                 );
             }
         } catch (exception) {
-            logger.error(
+            loggerChild.error(
                 documentId + ' - exception details ' + exception,
                 exception
             );
@@ -390,8 +432,14 @@ export class FacebookApiClient {
         } = document;
         let hideResponse;
 
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.company.id': companyId,
+            'meltwater.social.credential_id': credentialId,
+        });
+
         try {
-            logger.debug(
+            loggerChild.debug(
                 `processing Facebook Version ${version} for documentID ${documentId} on company ${companyId}`
             );
 
@@ -400,7 +448,7 @@ export class FacebookApiClient {
                 companyId
             );
 
-            logger.debug(
+            loggerChild.debug(
                 `finished fetching token for facebook for ${documentId} on company ${companyId} `
             );
 
@@ -416,14 +464,14 @@ export class FacebookApiClient {
                 });
             }
 
-            logger.debug(
+            loggerChild.debug(
                 `finished hiding in facebook for ${documentId} on company ${companyId} `,
                 { hideResponse }
             );
 
             return hideResponse;
         } catch (error) {
-            logger.error(
+            loggerChild.error(
                 `${documentId} - error recieved - ${error.code}`,
                 error
             );
@@ -444,11 +492,17 @@ export class FacebookApiClient {
             version,
         } = document;
 
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.company.id': companyId,
+            'meltwater.social.credential_id': credentialId,
+        });
+
         let banResponse;
         let authorId = authors[0].authorInfo.externalId;
 
         try {
-            logger.debug(
+            loggerChild.debug(
                 `processing Facebook Version ${version} for profileId ${authorId} on company ${companyId}`
             );
 
@@ -457,7 +511,7 @@ export class FacebookApiClient {
                 companyId
             );
 
-            logger.debug(
+            loggerChild.debug(
                 `finished fetching token for facebook for ${authorId} on company ${companyId} `
             );
 
@@ -473,12 +527,15 @@ export class FacebookApiClient {
                 });
             }
 
-            logger.debug(
+            loggerChild.debug(
                 `finished banning in facebook for ${authorId} on company ${companyId} `,
                 { banResponse }
             );
         } catch (error) {
-            logger.error(`${authorId} - error recieved - ${error.code}`, error);
+            loggerChild.error(
+                `${authorId} - error recieved - ${error.code}`,
+                error
+            );
         }
     }
 
@@ -495,13 +552,18 @@ export class FacebookApiClient {
             } = {},
             version,
         } = document;
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.company.id': companyId,
+            'meltwater.social.credential_id': credentialId,
+        });
 
         try {
-            logger.debug(
+            loggerChild.debug(
                 `processing Facebook Version ${version} for documentID ${documentId}`
             );
 
-            logger.debug(
+            loggerChild.debug(
                 `starting to fetch tokens for facebook for ${documentId} on company ${companyId} `
             );
             const token = await this.credentialsAPI.getToken(
@@ -509,7 +571,7 @@ export class FacebookApiClient {
                 companyId
             );
 
-            logger.debug(
+            loggerChild.debug(
                 `finished fetching token for facebook for ${documentId} on company ${companyId} `
             );
 
@@ -517,12 +579,15 @@ export class FacebookApiClient {
                 ? this.like(token, { externalId, documentId })
                 : this.unlike(token, { externalId, documentId }));
 
-            logger.debug(
+            loggerChild.debug(
                 `finished liking in facebook for ${documentId} on company ${companyId} `,
                 { likeResponse }
             );
         } catch (error) {
-            logger.error(`${document} - error recieved - ${error.code}`, error);
+            loggerChild.error(
+                `${document} - error recieved - ${error.code}`,
+                error
+            );
             throw error;
         }
     }
@@ -530,8 +595,11 @@ export class FacebookApiClient {
     async like(accessToken, command) {
         let response;
         const { externalId, documentId } = command;
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
 
-        logger.debug(
+        loggerChild.debug(
             `Starting to call facebook like api for documentId ${documentId}`,
             { command }
         );
@@ -542,7 +610,7 @@ export class FacebookApiClient {
             documentId
         );
 
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Like Response for documentId ${documentId}`,
             { status: response.status, ok: response.ok }
         );
@@ -552,8 +620,11 @@ export class FacebookApiClient {
     async unlike(accessToken, command) {
         let response;
         const { externalId, documentId } = command;
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+        });
 
-        logger.debug(
+        loggerChild.debug(
             `Starting to call facebook unlike api for documentId ${documentId}`,
             command
         );
@@ -564,7 +635,7 @@ export class FacebookApiClient {
             documentId
         );
 
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Unlike Response for documentId ${documentId}`,
             { status: response.status, ok: response.ok }
         );
@@ -574,8 +645,12 @@ export class FacebookApiClient {
     async hide(accessToken, command) {
         let response;
         const { externalId, documentId } = command;
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.document.external_id': externalId,
+        });
 
-        logger.debug(
+        loggerChild.debug(
             `Starting to call facebook hide api for documentId ${documentId}`,
             { command }
         );
@@ -587,7 +662,7 @@ export class FacebookApiClient {
             { is_hidden: true }
         );
 
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Hide Response for documentId ${documentId}`,
             { status: response.status, ok: response.ok }
         );
@@ -597,8 +672,12 @@ export class FacebookApiClient {
     async unhide(accessToken, command) {
         let response;
         const { externalId, documentId } = command;
+        const loggerChild = logger.child({
+            'meltwater.document.id': documentId,
+            'meltwater.document.external_id': externalId,
+        });
 
-        logger.debug(
+        loggerChild.debug(
             `Starting to call facebook unhide api for documentId ${documentId}`,
             command
         );
@@ -610,7 +689,7 @@ export class FacebookApiClient {
             { is_hidden: false }
         );
 
-        logger.info(
+        loggerChild.info(
             `Native Facebook API Unhide Response for documentId ${documentId}`,
             { status: response.status, ok: response.ok }
         );
@@ -646,10 +725,18 @@ export class FacebookApiClient {
                 return false;
             }
         }
+
         logger.info(
             `Native Facebook API is User Banned Response was invalid for userId ${userId} ${credentialId}`,
-            { status: response.status, ok: response.ok }
+            { status: response.status, ok: response.ok },
+            {
+                'meltwater.document.id': documentId,
+                'meltwater.social.credential_id': credentialId,
+                'meltwater.company.id': companyId,
+                'user.id': userId,
+            }
         );
+
         return false;
     }
 

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

@@ -28,7 +28,7 @@ export class FeatureToggleClient {
         } catch (error) {
             logger.error(
                 `Failed requesting Feature Toggle service for feature toggle get `,
-                { error, companyId }
+                { error, 'meltwater.company.id': companyId }
             );
         }
     }