Merge pull request #103 from freshworks/transcript_error

Bug bash fixes

packages/marketplace-models/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freshworks-jaya/marketplace-models",
-  "version": "0.1.23",
+  "version": "0.1.25",
   "description": "Provides type definitions for models in marketplace product events",
   "repository": "[email protected]:freshdesk/jaya-lib.git",
   "main": "lib/index.js",

packages/marketplace-models/src/types/PayloadData.ts

@@ -122,6 +122,10 @@ export interface MessagePart {
   collection?: {
     sub_parts: MessagePart[];
   };
+  email?: {
+    content: string;
+    subject: string;
+  };
   image?: { url: string };
   quick_reply_button?: {
     custom_reply_text?: string;

packages/rule-engine/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freshworks-jaya/rule-engine",
-  "version": "0.17.23",
+  "version": "0.17.25-beta-02",
   "description": "Provides methods to process rules in product events in marketplace app",
   "repository": "[email protected]:freshdesk/jaya-lib.git",
   "main": "lib/index.js",
@@ -46,7 +46,7 @@
   "dependencies": {
     "@freshworks-jaya/freshchat-api": "0.7.33-beta-09",
     "@freshworks-jaya/kairos-api": "^0.1.5",
-    "@freshworks-jaya/marketplace-models": "0.1.23",
+    "@freshworks-jaya/marketplace-models": "0.1.25",
     "@freshworks-jaya/utilities": "^1.0.0",
     "@google-cloud/logging": "^9.3.1",
     "axios": "^0.21.4",

packages/rule-engine/src/ActionExecutor.ts

@@ -11,13 +11,15 @@ import {
   LabelCategory,
   LabelSubcategory,
 } from '@freshworks-jaya/marketplace-models';
-import { Action, Api, CustomPlaceholdersMap } from './models/rule';
+import { Action, AnyJson, Api, CustomPlaceholdersMap } from './models/rule';
 import { Integrations, RuleEngineOptions } from './models/rule-engine';
 import ruleConfig from './RuleConfig';
 import { isUsernameGenerated, PlaceholdersMap, capitalizeAll } from '@freshworks-jaya/utilities';
 import { Utils } from './Utils';
 import Freshchat from '@freshworks-jaya/freshchat-api';
 import { AxiosResponse } from 'axios';
+import { APITraceCodes } from './models/error-codes';
+import { LogSeverity } from './services/GoogleCloudLogging';
 
 export class ActionExecutor {
   /**
@@ -206,6 +208,15 @@ export class ActionExecutor {
         // Error while executing an action
         // Queietly suppressing it so that next action can be executed
         // So, doing nothing here
+        if (options.enableLogger) {
+          Utils.log(
+            productEventPayload,
+            integrations,
+            APITraceCodes.ACTION_HANDLER_ERROR,
+            err as AnyJson,
+            LogSeverity.NOTICE,
+          );
+        }
       }
     }
 

packages/rule-engine/src/RuleProcessor.ts

@@ -1,10 +1,13 @@
 // Simple library to process the rules
-import { Event } from '@freshworks-jaya/marketplace-models';
+import { Event, ProductEventPayload } from '@freshworks-jaya/marketplace-models';
 import { ProductEventData } from '@freshworks-jaya/marketplace-models';
-import { Block, Condition, MatchType, Rule, Trigger, TriggerAction, TriggerActor } from './models/rule';
+import { AnyJson, Block, Condition, MatchType, Rule, Trigger, TriggerAction, TriggerActor } from './models/rule';
 import { Integrations, RuleEngineOptions } from './models/rule-engine';
 import { Promise } from 'bluebird';
 import ruleConfig from './RuleConfig';
+import { Utils } from './Utils';
+import { APITraceCodes } from './models/error-codes';
+import { LogSeverity } from './services/GoogleCloudLogging';
 
 export class RuleProcessor {
   /**
@@ -71,9 +74,14 @@ export class RuleProcessor {
   public static isTriggerActorMatch(actor: TriggerActor, productEventData: ProductEventData): boolean {
     const triggerActorFunc = ruleConfig.triggerActors && ruleConfig.triggerActors[actor.type];
 
-    if (triggerActorFunc) {
-      return triggerActorFunc(productEventData, actor);
+    try {
+      if (triggerActorFunc) {
+        return triggerActorFunc(productEventData, actor);
+      }
+    } catch (error) {
+      throw new Error('Invalid trigger actor : ' + JSON.stringify(actor));
     }
+
     throw new Error('Invalid trigger actor');
   }
 
@@ -83,9 +91,14 @@ export class RuleProcessor {
   public static isTriggerActionMatch(action: TriggerAction, event: Event, productEventData: ProductEventData): boolean {
     const triggerActionFunc = ruleConfig.triggerActions && ruleConfig.triggerActions[action.type];
 
-    if (triggerActionFunc) {
-      return triggerActionFunc(event, productEventData, action);
+    try {
+      if (triggerActionFunc) {
+        return triggerActionFunc(event, productEventData, action);
+      }
+    } catch (error) {
+      throw new Error('Invalid trigger action : ' + action.type);
     }
+
     throw new Error('Invalid trigger action');
   }
 
@@ -196,7 +209,17 @@ export class RuleProcessor {
           await this.isRuleMatching(event, productEventData, currentRule, integrations, options);
           firstMatchingRule = currentRule;
           break;
-        } catch (err) {}
+        } catch (err) {
+          if (options.enableLogger) {
+            Utils.log(
+              productEventData as unknown as ProductEventPayload,
+              integrations,
+              APITraceCodes.FIRST_MATCHING_RULE,
+              err as AnyJson,
+              LogSeverity.NOTICE,
+            );
+          }
+        }
       }
     }
     return firstMatchingRule ? Promise.resolve(firstMatchingRule) : Promise.reject('no matching rule');

packages/rule-engine/src/TimerRuleEngine.ts

@@ -2,6 +2,7 @@ import Kairos, { KairosSchedule, KairosScheduleOptions } from '@freshworks-jaya/
 import { Event, ProductEventPayload, ProductEventData, ModelProperties } from '@freshworks-jaya/marketplace-models';
 import { ActionExecutor } from './ActionExecutor';
 import {
+  AnyJson,
   Api,
   CustomPlaceholdersMap,
   Rule,
@@ -150,10 +151,7 @@ export class TimerRuleEngine {
           integrations,
           ErrorCodes.KairosError,
           {
-            error: {
-              data: err?.response?.data,
-              responseHeaders: err?.response?.headers,
-            },
+            error: err as AnyJson,
             errorType: ErrorTypes.KairosBulkCreateSchedules,
             jobIds: schedulesToCreate.map((schedule) => schedule.jobId),
           },
@@ -200,10 +198,7 @@ export class TimerRuleEngine {
         integrations,
         ErrorCodes.KairosError,
         {
-          error: {
-            data: err?.response?.data,
-            responseHeaders: err?.response?.headers,
-          },
+          error: err as AnyJson,
           errorType: ErrorTypes.KairosDeleteCompletedSchedule,
           jobId: externalEventPayload.data?.jobId,
         },
@@ -338,16 +333,13 @@ export class TimerRuleEngine {
               );
               return Promise.resolve();
             },
-            (err) => {
+            (err: AnyJson) => {
               Utils.log(
                 payload,
                 integrations,
                 ErrorCodes.KairosError,
                 {
-                  error: {
-                    data: err?.response?.data,
-                    responseHeaders: err?.response?.headers,
-                  },
+                  error: err as AnyJson,
                   errorType: ErrorTypes.KairosCreteScheduleToDelayInvalidation,
                   jobId: createScheduleJobId,
                 },
@@ -372,16 +364,13 @@ export class TimerRuleEngine {
             );
             return Promise.resolve();
           },
-          (err) => {
+          (err: AnyJson) => {
             Utils.log(
               payload,
               integrations,
               ErrorCodes.KairosError,
               {
-                error: {
-                  data: err?.response?.data,
-                  responseHeaders: err?.response?.headers,
-                },
+                error: err as AnyJson,
                 errorType: ErrorTypes.KairosDeleteInvalidatedSchedules,
                 jobIds: jobsToDelete,
               },

packages/rule-engine/src/Utils.ts

@@ -135,6 +135,24 @@ export class Utils {
     return messageContent;
   }
 
+  /**
+   * Gets a concatenated string of messageParts with type 'text'.
+   */
+  public static getMessagePartsEmailContent(messageParts: MessagePart[]): string {
+    let messageContent = '';
+
+    if (messageParts && messageParts.length) {
+      messageContent = messageParts
+        .filter((messagePart) => messagePart.email)
+        .map((messagePart) => {
+          return messagePart.email && messagePart.email.content;
+        })
+        .join(' ');
+    }
+
+    return messageContent;
+  }
+
   public static processHanldebars(value: string, placeholders: PlaceholdersMap): string {
     let processedString = '';
     let isError = false;

packages/rule-engine/src/index.ts

@@ -6,13 +6,16 @@ import {
   KairosCredentials,
 } from './models/rule-engine';
 
-import { Api, CustomPlaceholdersMap, Rule } from './models/rule';
+import { AnyJson, Api, CustomPlaceholdersMap, Rule } from './models/rule';
 import { RulePlugin } from './models/plugin';
 import { RuleProcessor } from './RuleProcessor';
 import { ActionExecutor } from './ActionExecutor';
 import { TimerRuleEngine } from './TimerRuleEngine';
 import ruleConfig from './RuleConfig';
 import recommendedPlugins from './recommended/index';
+import { Utils } from './Utils';
+import { ErrorCodes } from './models/error-codes';
+import { LogSeverity } from './services/GoogleCloudLogging';
 
 export * from './models/rule';
 export * from './models/rule-engine';
@@ -82,6 +85,15 @@ export class RuleEngine {
         );
       }
     } catch (err) {
+      Utils.log(
+        payload,
+        integrations,
+        ErrorCodes.FreshchatAction,
+        {
+          error: err as AnyJson,
+        },
+        LogSeverity.ALERT,
+      );
       return Promise.reject(err);
     }
 

packages/rule-engine/src/models/error-codes.ts

@@ -40,8 +40,10 @@ export enum ErrorTypes {
 }
 
 export enum APITraceCodes {
+  ACTION_HANDLER_ERROR = 'ACTION_HANDLER_ERROR',
   CREATE_SCHEDULE_SUCCESS = 'CREATE_SCHEDULE_SUCCESS',
   DELAY_SCHEDULE_CREATION = 'DELAY_SCHEDULE_CREATION',
   EXECUTE_SCHEDULE_SUCCESS = 'EXECUTE_SCHEDULE_SUCCESS',
+  FIRST_MATCHING_RULE = 'FIRST_MATCHING_RULE',
   INVALIDATE_SCHEDULE_SUCCESS = 'INVALIDATE_SCHEDULE_SUCCESS',
 }

packages/rule-engine/src/models/rule-engine.ts

@@ -3,6 +3,7 @@ import { RequestProxy } from '@freshworks-jaya/marketplace-models/lib/services/r
 import { GoogleCloudLoggingConfig } from '../services/GoogleCloudLogging';
 
 export interface RuleEngineOptions {
+  enableLogger?: boolean; // this is to be enabled only for debugging, should be disabled afterwards
   isSchedulerEnabled: boolean;
   isUseStaticIP: boolean;
   maxProductEventDelay: number;

packages/rule-engine/src/models/rule.ts

@@ -66,6 +66,7 @@ export enum ConditionKey {
   CallType = 'CALL_TYPE',
   Channel = 'CHANNEL',
   ConversationProperty = 'CONVERSATION_PROPERTY',
+  EmailBody = 'EMAIL_BODY',
   LabelCategoryName = 'LABEL_CATEGORY_NAME',
   LabelSubcategoryName = 'LABEL_SUBCATEGORY_NAME',
   MessageText = 'MESSAGE_TEXT',
@@ -176,6 +177,12 @@ export interface TriggerWebhookValue {
     password: string;
     username: string;
   };
+  castArray?: [
+    {
+      key: string;
+      type: string;
+    },
+  ];
   content?: string;
   contentType?: WebhookContentType;
   customHeaders?: string;

packages/rule-engine/src/recommended/actions/assign-to-agent.ts

@@ -3,7 +3,7 @@ import Freshchat from '@freshworks-jaya/freshchat-api';
 import { Integrations, RuleEngineOptions } from '../../models/rule-engine';
 import { PlaceholdersMap } from '@freshworks-jaya/utilities';
 import { Utils } from '../../Utils';
-import { Api } from '../../models/rule';
+import { AnyJson, Api } from '../../models/rule';
 import { ErrorCodes, ErrorTypes } from '../../models/error-codes';
 import { LogSeverity } from '../../services/GoogleCloudLogging';
 
@@ -63,10 +63,7 @@ export default async (
       integrations,
       ErrorCodes.FreshchatAction,
       {
-        error: {
-          data: err?.response?.data,
-          headers: err?.response?.headers,
-        },
+        error: err as AnyJson,
         errorType: ErrorTypes.FreshchatAssignAgent,
       },
       LogSeverity.ERROR,

packages/rule-engine/src/recommended/actions/assign-to-group.ts

@@ -3,7 +3,7 @@ import Freshchat from '@freshworks-jaya/freshchat-api';
 import { Integrations, RuleEngineOptions } from '../../models/rule-engine';
 import { PlaceholdersMap } from '@freshworks-jaya/utilities';
 import { Utils } from '../../Utils';
-import { Api } from '../../models/rule';
+import { AnyJson, Api } from '../../models/rule';
 import { ErrorCodes, ErrorTypes } from '../../models/error-codes';
 import { LogSeverity } from '../../services/GoogleCloudLogging';
 
@@ -56,10 +56,7 @@ export default async (
       integrations,
       ErrorCodes.FreshchatAction,
       {
-        error: {
-          data: err?.response?.data,
-          headers: err?.response?.headers,
-        },
+        error: err as AnyJson,
         errorType: ErrorTypes.FreshchatAssignGroup,
       },
       LogSeverity.ERROR,

packages/rule-engine/src/recommended/actions/create-freshdesk-ticket.ts

@@ -6,7 +6,7 @@ import Freshchat, { User as FreshchatUser } from '@freshworks-jaya/freshchat-api
 import { Utils as FreshchatUtils } from '@freshworks-jaya/freshchat-api/lib/Utils';
 import { isUsernameGenerated } from '@freshworks-jaya/utilities';
 import { Utils } from '../../Utils';
-import { Api, WebhookRequestType } from '../../models/rule';
+import { AnyJson, Api, WebhookRequestType } from '../../models/rule';
 import { ErrorCodes } from '../../models/error-codes';
 import Constants from '../Constants';
 
@@ -193,10 +193,7 @@ export default async (
     );
   } catch (err) {
     Utils.log(productEventPayload, integrations, ErrorCodes.FreshdeskTicket, {
-      error: {
-        data: err?.response?.data,
-        headers: err?.response?.headers,
-      },
+      error: err as AnyJson,
     });
     return Promise.reject('Error creating freshdesk ticket');
   }

packages/rule-engine/src/recommended/actions/reopen.ts

@@ -2,7 +2,7 @@ import { ConversationStatus, ProductEventPayload } from '@freshworks-jaya/market
 import Freshchat from '@freshworks-jaya/freshchat-api';
 import { Integrations, RuleEngineOptions } from '../../models/rule-engine';
 import { PlaceholdersMap } from '@freshworks-jaya/utilities';
-import { Api } from '../../models/rule';
+import { AnyJson, Api } from '../../models/rule';
 import { Utils } from '../../Utils';
 import { ErrorCodes, ErrorTypes } from '../../models/error-codes';
 import { LogSeverity } from '../../services/GoogleCloudLogging';
@@ -30,10 +30,7 @@ export default async (
       integrations,
       ErrorCodes.FreshchatAction,
       {
-        error: {
-          data: err?.response?.data,
-          headers: err?.response?.headers,
-        },
+        error: err as AnyJson,
         errorType: ErrorTypes.FreshchatReopenConversation,
       },
       LogSeverity.ERROR,