Add configurable parameter to control delay between transcript message send on startup to Connect. Workaround Connect problem with respect to out of order delivery of sent messages.

Author: bobpskier

build/update-lex-web-ui-config.js

@@ -146,7 +146,8 @@ const lexV2BotLocaleVoices = {
  'CONNECT_START_LIVE_CHAT_LABEL',
  'CONNECT_START_LIVE_CHAT_ICON',
  'CONNECT_END_LIVE_CHAT_LABEL',
- 'CONNECT_END_LIVE_CHAT_ICON' ,
+ 'CONNECT_END_LIVE_CHAT_ICON',
+ 'CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC',
  'APP_DOMAIN_NAME',
  'UI_TOOLBAR_TITLE',
  'UI_TOOLBAR_LOGO',

config/base.env.js

@@ -23,6 +23,7 @@ module.exports = {
  chatEndedMessage: process.env.CONNECT_CHAT_ENDED_MESSAGE,
  attachChatTranscript: process.env.CONNECT_ATTACH_CHAT_TRANSCRIPT,
  liveChatTerms: process.env.CONNECT_LIVE_CHAT_TERMS,
+ transcriptMessageDelayInMsec: process.env.CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC,
  },
  lex: {
  v2BotId: process.env.V2_BOT_ID,

config/env.mk

@@ -36,6 +36,7 @@ export CONNECT_START_LIVE_CHAT_LABEL ?= $()
 export CONNECT_START_LIVE_CHAT_ICON ?= $()
 export CONNECT_END_LIVE_CHAT_LABEL ?= $()
 export CONNECT_END_LIVE_CHAT_ICON ?= $()
+export CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC ?= $()
 export BOT_INITIAL_TEXT ?= $()
 export BOT_INITIAL_SPEECH ?= $()
 export BOT_INITIAL_UTTERANCE ?= $()

lex-web-ui/package-lock.json

@@ -74,6 +74,8 @@ const configDefault = {
  waitingForAgentMessageIntervalSeconds: 60,
  // Terms to start live chat
  liveChatTerms: 'live chat',
+ // The delay to use between sending transcript blocks to connect
+ transcriptMessageDelayInMsec: 150,
  },
  lex: {
  // Lex V2 fields

lex-web-ui/src/config/index.js

@@ -66,7 +66,7 @@ export const initLiveChatHandlers = (context, session) => {
  const transcriptArray = context.getters.liveChatTextTranscriptArray();
  transcriptArray.forEach((text, index) => {
  var formattedText = "Bot Transcript: (" + (index + 1).toString() + "\\" + transcriptArray.length + ")\n" + text;
- sendChatMessageWithDelay(session, formattedText, index * 150);
+ sendChatMessageWithDelay(session, formattedText, index * context.state.config.connect.transcriptMessageDelayInMsec);
  console.info((index + 1).toString() + "-" + formattedText);
  });
 

lex-web-ui/src/store/live-chat-handlers.js

@@ -9,6 +9,7 @@
  "agentJoinedMessage": "",
  "agentLeftMessage": "",
  "chatEndedMessage": "",
- "attachChatTranscript": ""
+ "attachChatTranscript": "",
+ "transcriptMessageDelayInMsec": ""
  }
 }

package-lock.json

@@ -217,6 +217,12 @@ Parameters:
  Icon to use in menu and toolbar to end connect live chat
  Default: "call_end"
 
+ ConnectTranscriptMessageDelayInMsec:
+ Type: Number
+ Description: >
+ Delay to insert between each transcript message send to Connect in msec.
+ Default: 150
+
  LexV2BotId:
  Description: >
  Bot ID (not bot name) of an existing Lex V2 Bot to be used by the web ui. NOTE: You must
@@ -711,6 +717,8 @@ Resources:
  Value: !Ref ConnectEndLiveChatLabel
  - Name: CONNECT_END_LIVE_CHAT_ICON
  Value: !Ref ConnectEndLiveChatIcon
+ - Name: CONNECT_TRANSCRIPT_MESSAGE_DELAY_IN_MSEC
+ Value: !Ref ConnectTranscriptMessageDelayInMsec
  - Name: APP_USER_POOL_CLIENT_ID
  Value: !Ref CognitoAppUserPoolClientId
  - Name: APP_USER_POOL_NAME
@@ -827,6 +835,7 @@ Resources:
  ConnectStartLiveChatIcon: !Ref ConnectStartLiveChatIcon
  ConnectEndLiveChatLabel: !Ref ConnectEndLiveChatLabel
  ConnectEndLiveChatIcon: !Ref ConnectEndLiveChatIcon
+ ConnectTranscriptMessageDelayInMsec: !Ref ConnectTranscriptMessageDelayInMsec
  WebAppBucket: !Ref WebAppBucket
  LexV2BotId: !Ref LexV2BotId
  LexV2BotAliasId: !Ref LexV2BotAliasId

src/config/lex-web-ui-loader-config.json

@@ -1,6 +1,6 @@
 AWSTemplateFormatVersion: 2010-09-09
 Description: |
- Master Pipeline Lex Web UI CloudFormation template (v0.19.7)
+ Master Pipeline Lex Web UI CloudFormation template (v0.19.8)
  The Lex Web Ui can be deployed to operate against either a Lex V2 Bot OR a Lex V1 Bot BUT NOT BOTH.
  Please configure either the Lex V2 bot information OR the Lex V1 bot information and leave the other
  version input parameters as defaulted.
@@ -368,6 +368,12 @@ Parameters:
  Icon to use in menu and toolbar to end connect live chat
  Default: "call_end"
 
+ ConnectTranscriptMessageDelayInMsec:
+ Type: Number
+ Description: >
+ Delay to insert between each transcript message send to Connect in msec.
+ Default: 150
+
 Rules:
  ValidateEitherV1orV2:
  RuleCondition: !Not 
@@ -459,7 +465,7 @@ Resources:
  NamePrefix: !Ref BotNamePrefix
  ShouldDeleteBot: !Ref ShouldDeleteBot
  CustomResourceCodeBucket: !Ref BootstrapBucket
- CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.7.zip"
+ CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.8.zip"
 
  CognitoIdentityPool:
  Type: AWS::CloudFormation::Stack
@@ -503,8 +509,8 @@ Resources:
  - !GetAtt CognitoIdentityPool.Outputs.CognitoIdentityPoolId
  - !Ref CognitoIdentityPoolId
  SourceBucket: !Ref BootstrapBucket
- SourceObject: !Sub "${BootstrapPrefix}/src-v0.19.7.zip"
- CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.7.zip"
+ SourceObject: !Sub "${BootstrapPrefix}/src-v0.19.8.zip"
+ CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.8.zip"
 
  Pipeline:
  Type: AWS::CloudFormation::Stack
@@ -535,8 +541,8 @@ Resources:
  ParentOrigin: !Ref WebAppParentOrigin
  CustomResourceCodeBucket: !Ref BootstrapBucket
  CustomResourceCodePrefix: !Ref BootstrapPrefix
- CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.7.zip"
- InitiateChatLambdaCodeObject: !Sub "${BootstrapPrefix}/initiate-chat-lambda-v0.19.7.zip"
+ CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.19.8.zip"
+ InitiateChatLambdaCodeObject: !Sub "${BootstrapPrefix}/initiate-chat-lambda-v0.19.8.zip"
  CleanupBuckets: !Ref CleanupBuckets
  CognitoAppUserPoolClientId:
  !If
@@ -570,6 +576,7 @@ Resources:
  ConnectStartLiveChatIcon: !Ref ConnectStartLiveChatIcon
  ConnectEndLiveChatLabel: !Ref ConnectEndLiveChatLabel
  ConnectEndLiveChatIcon: !Ref ConnectEndLiveChatIcon
+ ConnectTranscriptMessageDelayInMsec: !Ref ConnectTranscriptMessageDelayInMsec
 
  CognitoIdentityPoolConfig:
  Type: AWS::CloudFormation::Stack
@@ -583,7 +590,7 @@ Resources:
  CodeBuildProjectName: !Ref CodeBuildName
  CognitoUserPool: !GetAtt CognitoIdentityPool.Outputs.CognitoUserPoolId
  CognitoUserPoolClient: !GetAtt CognitoIdentityPool.Outputs.CognitoUserPoolClientId
- Timestamp: 1678465363
+ Timestamp: 1683124094
 
 Outputs:
  BotName: