feat: relace tokens with contextVars

api/src/chat/services/block.service.spec.ts

@@ -65,6 +65,7 @@ import { LabelModel } from '../schemas/label.schema';
 import { FileType } from '../schemas/types/attachment';
 import { Context } from '../schemas/types/context';
 import { PayloadType, StdOutgoingListMessage } from '../schemas/types/message';
+import { SubscriberContext } from '../schemas/types/subscriberContext';
 
 describe('BlockService', () => {
   let blockRepository: BlockRepository;
@@ -421,6 +422,7 @@ describe('BlockService', () => {
           ...contextBlankInstance,
           skip: { [blockProductListMock.id]: 0 },
         },
+        { vars: {} }, //TODO: to correct
         false,
         'conv_id',
       );
@@ -454,6 +456,7 @@ describe('BlockService', () => {
           ...contextBlankInstance,
           skip: { [blockProductListMock.id]: 2 },
         },
+        { vars: {} }, //TODO: to correct
         false,
         'conv_id',
       );
@@ -498,9 +501,19 @@ describe('BlockService', () => {
       skip: { '1': 0 },
       attempt: 0,
     };
+    const subscriberContext: SubscriberContext = {
+      vars: {
+        phone: '123456789',
+      },
+    };
 
     it('should process empty text', () => {
-      const result = blockService.processText('', context, settings);
+      const result = blockService.processText(
+        '',
+        context,
+        subscriberContext,
+        settings,
+      );
       expect(result).toEqual('');
     });
 
@@ -509,6 +522,7 @@ describe('BlockService', () => {
       const result = blockService.processText(
         translation.en,
         context,
+        subscriberContext,
         settings,
       );
       expect(result).toEqual(translation.fr);
@@ -518,6 +532,7 @@ describe('BlockService', () => {
       const result = blockService.processText(
         '{context.user.first_name} {context.user.last_name}, email : {context.vars.email}',
         contextEmailVarInstance,
+        subscriberContext,
         settings,
       );
       expect(result).toEqual('John Doe, email : email@example.com');
@@ -525,17 +540,19 @@ describe('BlockService', () => {
 
     it('should process text replacements with context vars', () => {
       const result = blockService.processText(
-        '{context.user.first_name} {context.user.last_name}, email : {context.vars.email}',
+        '{context.user.first_name} {context.user.last_name}, phone : {context.vars.phone}',
         contextEmailVarInstance,
+        subscriberContext,
         settings,
       );
-      expect(result).toEqual('John Doe, email : email@example.com');
+      expect(result).toEqual('John Doe, phone : 123456789');
     });
 
     it('should process text replacements with settings contact infos', () => {
       const result = blockService.processText(
         'Trying the settings : the name of company is <<{contact.company_name}>>',
         contextBlankInstance,
+        subscriberContext,
         settings,
       );
       expect(result).toEqual(

api/src/chat/services/block.service.ts

@@ -33,6 +33,7 @@ import {
 } from '../schemas/types/message';
 import { NlpPattern, Pattern, PayloadPattern } from '../schemas/types/pattern';
 import { Payload, StdQuickReply } from '../schemas/types/quick-reply';
+import { SubscriberContext } from '../schemas/types/subscriberContext';
 
 @Injectable()
 export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
@@ -301,22 +302,19 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
   processTokenReplacements(
     text: string,
     context: Context,
+    subscriberContext: SubscriberContext,
     settings: Settings,
   ): string {
+    const vars = { ...subscriberContext.vars, ...context.vars };
     // Replace context tokens with their values
-    Object.keys(context.vars || {}).forEach((key) => {
-      if (
-        typeof context.vars[key] === 'string' &&
-        context.vars[key].indexOf(':') !== -1
-      ) {
-        const tmp = context.vars[key].split(':');
-        context.vars[key] = tmp[1];
+    Object.keys(vars).forEach((key) => {
+      if (typeof vars[key] === 'string' && vars[key].indexOf(':') !== -1) {
+        const tmp = vars[key].split(':');
+        vars[key] = tmp[1];
       }
       text = text.replace(
         '{context.vars.' + key + '}',
-        typeof context.vars[key] === 'string'
-          ? context.vars[key]
-          : JSON.stringify(context.vars[key]),
+        typeof vars[key] === 'string' ? vars[key] : JSON.stringify(vars[key]),
       );
     });
 
@@ -368,7 +366,12 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
    *
    * @returns The text message translated and tokens being replaces with values
    */
-  processText(text: string, context: Context, settings: Settings): string {
+  processText(
+    text: string,
+    context: Context,
+    subscriberContext: SubscriberContext,
+    settings: Settings,
+  ): string {
     const lang =
       context && context.user && context.user.language
         ? context.user.language
@@ -376,7 +379,12 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
     // Translate
     text = this.i18n.t(text, { lang, defaultValue: text });
     // Replace context tokens
-    text = this.processTokenReplacements(text, context, settings);
+    text = this.processTokenReplacements(
+      text,
+      context,
+      subscriberContext,
+      settings,
+    );
     return text;
   }
 
@@ -423,6 +431,7 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
   async processMessage(
     block: Block | BlockFull,
     context: Context,
+    subscriberContext: SubscriberContext,
     fallback = false,
     conversationId?: string,
   ): Promise<StdOutgoingEnvelope> {
@@ -440,6 +449,7 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
       const text = this.processText(
         this.getRandom(blockMessage),
         context,
+        subscriberContext,
         settings,
       );
       const envelope: StdOutgoingEnvelope = {
@@ -456,12 +466,22 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
         const envelope: StdOutgoingEnvelope = {
           format: OutgoingMessageFormat.quickReplies,
           message: {
-            text: this.processText(blockMessage.text, context, settings),
+            text: this.processText(
+              blockMessage.text,
+              context,
+              subscriberContext,
+              settings,
+            ),
             quickReplies: blockMessage.quickReplies.map((qr: StdQuickReply) => {
               return qr.title
                 ? {
                     ...qr,
-                    title: this.processText(qr.title, context, settings),
+                    title: this.processText(
+                      qr.title,
+                      context,
+                      subscriberContext,
+                      settings,
+                    ),
                   }
                 : qr;
             }),
@@ -476,12 +496,22 @@ export class BlockService extends BaseService<Block, BlockPopulate, BlockFull> {
         const envelope: StdOutgoingEnvelope = {
           format: OutgoingMessageFormat.buttons,
           message: {
-            text: this.processText(blockMessage.text, context, settings),
+            text: this.processText(
+              blockMessage.text,
+              context,
+              subscriberContext,
+              settings,
+            ),
             buttons: blockMessage.buttons.map((btn) => {
               return btn.title
                 ? {
                     ...btn,
-                    title: this.processText(btn.title, context, settings),
+                    title: this.processText(
+                      btn.title,
+                      context,
+                      subscriberContext,
+                      settings,
+                    ),
                   }
                 : btn;
             }),

api/src/chat/services/bot.service.ts

@@ -74,6 +74,7 @@ export class BotService {
       await this.blockService.processMessage(
         block,
         context,
+        event.getSender().context,
         fallback,
         conservationId,
       );