Merge pull request #775 from aws-samples/development

Release 0.21.7

Author: atjohns

CHANGELOG.md

@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.21.6] - 2024-09-20
+## [0.21.6] - 2025-01-23
+- Add heartbeat for streaming responses to prevent idle timeout of 10 mins
+
+## [0.21.6] - 2024-12-18
 - Updatae the Web UI to allow VPC integration with all Lambda functions. This requires your VPC to at a minimum be able to access S3, and additional optional functionality will require additional VPC endpoints to services.
 - Package updates to address vulnerabilities. 
 

dist/lex-web-ui-loader.min.css

@@ -1,5 +1,5 @@
 /*!
-* lex-web-ui v0.21.6
+* lex-web-ui v0.21.7
 * (c) 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * Released under the Amazon Software License.
 */  

dist/lex-web-ui-loader.min.js

@@ -1,6 +1,6 @@
 {
   "name": "lex-web-ui",
-  "version": "0.21.6",
+  "version": "0.21.7",
   "description": "Amazon Lex Web Interface",
   "author": "AWS",
   "license": "Amazon Software License",

dist/lex-web-ui.js

@@ -710,11 +710,11 @@ export default {
 
           wsClient.onmessage = (event) => {
             if(event.data!=='/stop/' && context.getters.isStartingTypingWsMessages()){
-              console.info("streaming ", context.getters.isStartingTypingWsMessages());
+              console.info('Streaming: ', context.getters.isStartingTypingWsMessages());
               context.commit('pushWebSocketMessage',event.data);
               context.dispatch('typingWsMessages')
             }else{
-              console.info('stopping streaming');
+              console.info('Currently not streaming');
             }
           }
         }
@@ -1304,6 +1304,41 @@ export default {
 
     const signedUrl = Signer.signUrl(context.state.config.lex.streamingWebSocketEndpoint+'?sessionId='+sessionId, accessInfo, serviceInfo);
     wsClient = new WebSocket(signedUrl);
+
+    // Add heartbeat logic
+    const HEARTBEAT_INTERVAL = 540000; // 9 minutes
+    const MAX_DURATION = 7200000; // 2 hours
+    const startTime = Date.now();
+    let heartbeatTimer = null;
+
+    function startHeartbeat() {
+        if (wsClient.readyState === WebSocket.OPEN) {
+            const elapsedTime = Date.now() - startTime;
+            if (elapsedTime < MAX_DURATION) {
+                const pingMessage = JSON.stringify({ action: 'ping' });
+                wsClient.send(pingMessage);
+                console.log('Sending Ping:', new Date().toISOString());
+                heartbeatTimer = setTimeout(startHeartbeat, HEARTBEAT_INTERVAL);
+            } else {
+                console.log('Stopped sending pings after reaching 2-hour limit.');
+                clearTimeout(heartbeatTimer);
+            }
+        }
+    }
+    wsClient.onopen = () => {
+      console.log('WebSocket Connected');
+      startHeartbeat();
+    };
+
+    wsClient.onclose = () => {
+        console.log('WebSocket Closed');
+        clearTimeout(heartbeatTimer);
+    };
+
+    wsClient.onerror = (error) => {
+        console.log('WebSocket Error', error.message);
+        clearTimeout(heartbeatTimer);
+    };
   },
   typingWsMessages(context){
     if (context.getters.wsMessagesCurrentIndex()<context.getters.wsMessagesLength()-1){

dist/lex-web-ui.js.map

@@ -1,6 +1,6 @@
 {
   "name": "aws-lex-web-ui",
-  "version": "0.21.6",
+  "version": "0.21.7",
   "description": "Sample Amazon Lex Web Interface",
   "main": "dist/lex-web-ui.min.js",
   "repository": {

dist/lex-web-ui.min.css

@@ -1,6 +1,6 @@
 AWSTemplateFormatVersion: 2010-09-09
 Description: |
-    Master Lex Web UI CloudFormation template (v0.21.6)
+    Master Lex Web UI CloudFormation template (v0.21.7)
     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.
@@ -760,7 +760,7 @@ Resources:
                 ShouldDeleteBot: !Ref ShouldDeleteBot
                 ParentStackName: !Ref "AWS::StackName"
                 SourceBucket: !Ref BootstrapBucket
-                QBusinessLambdaCodeObject: !Sub "${BootstrapPrefix}/qbusiness-lambda-v0.21.6.zip"
+                QBusinessLambdaCodeObject: !Sub "${BootstrapPrefix}/qbusiness-lambda-v0.21.7.zip"
                 AmazonQAppId: !Ref AmazonQAppId
                 IDCApplicationARN: !Ref IDCApplicationARN
                 VpcSubnetId: !Ref VpcSubnetId
@@ -804,10 +804,10 @@ Resources:
                 SourceBucket: !Ref BootstrapBucket
                 SourcePrefix: !Ref BootstrapPrefix
                 StreamingWebSocketEndpoint: !Ref StreamingWebSocketEndpoint
-                SourceObject: !Sub "${BootstrapPrefix}/src-v0.21.6.zip"
-                CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.21.6.zip"
-                InitiateChatLambdaCodeObject: !Sub "${BootstrapPrefix}/initiate-chat-lambda-v0.21.6.zip"
-                StreamingLambdaCodeObject: !Sub "${BootstrapPrefix}/streaming-lambda-v0.21.6.zip"
+                SourceObject: !Sub "${BootstrapPrefix}/src-v0.21.7.zip"
+                CustomResourceCodeObject: !Sub "${BootstrapPrefix}/custom-resources-v0.21.7.zip"
+                InitiateChatLambdaCodeObject: !Sub "${BootstrapPrefix}/initiate-chat-lambda-v0.21.7.zip"
+                StreamingLambdaCodeObject: !Sub "${BootstrapPrefix}/streaming-lambda-v0.21.7.zip"
                 CleanupBuckets: !Ref CleanupBuckets
                 BotName:
                     !If
@@ -904,7 +904,7 @@ Resources:
                 UploadBucket: !Ref UploadBucket
                 VpcSubnetId: !Ref VpcSubnetId
                 VpcSecurityGroupId: !Ref VpcSecurityGroupId
-                Timestamp: 1734531050
+                Timestamp: 1737634514
 
     CognitoIdentityPoolConfig:
         Type: AWS::CloudFormation::Stack
@@ -920,7 +920,7 @@ Resources:
                 CognitoUserPoolClient: !GetAtt CognitoIdentityPool.Outputs.CognitoUserPoolClientId
                 VpcSubnetId: !Ref VpcSubnetId
                 VpcSecurityGroupId: !Ref VpcSecurityGroupId
-                Timestamp: 1734531050
+                Timestamp: 1737634514
 
     ##########################################################################
     # Lambda that will validate if user has put in an invalid CSS color/Hex string and fail deployment

dist/lex-web-ui.min.js

@@ -169,11 +169,34 @@ Resources:
       IntegrationUri: 
         Fn::Sub:
             arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${StreamingLambda.Arn}/invocations    
+  
+  PingRoute:
+    Type: AWS::ApiGatewayV2::Route
+    Properties:
+      ApiId: !Ref StreamingWebSocket
+      RouteKey: ping
+      OperationName: PingRoute
+      Target: !Join
+        - '/'
+        - - 'integrations'
+          - !Ref PingIntegration
+
+  PingIntegration:
+    Type: AWS::ApiGatewayV2::Integration
+    Properties:
+      ApiId: !Ref StreamingWebSocket
+      Description: Ping Integration
+      IntegrationType: MOCK
+      PassthroughBehavior: WHEN_NO_MATCH
+      RequestTemplates:
+        application/json: '{"statusCode":200}'
+
 
   Deployment:
     Type: AWS::ApiGatewayV2::Deployment
     DependsOn:
     - ConnectRoute
+    - PingRoute
     Properties:
       ApiId: !Ref StreamingWebSocket