Merge pull request #906 from ranfisfrancisco/master

Add openPopupWithLock and use to open login popup
amazon-connect · Aug 5, 2024 · 05a8b1e · 05a8b1e
2 parents e1689ac + 32a4376
commit 05a8b1e
Show file tree

Hide file tree

Showing 8 changed files with 95 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG.md
 
+## [2.14.5] - 2024-08-02
+Added:
+- Made change to prevent more than one login popup from appearing when an embedded CCP is opened in two or more tabs.
+
 ## [2.14.1] - 2024-03-29
 Added:
 - `initCCP` param to set custom ringtone for chat.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amazon-connect-streams",
-  "version": "2.14.4",
+  "version": "2.14.5",
   "description": "Amazon Connect Streams Library",
   "engines": {
     "node": ">=12.0.0"

diff --git a/release/connect-streams-dr-min.js b/release/connect-streams-dr-min.js
diff --git a/release/connect-streams-dr.js b/release/connect-streams-dr.js
diff --git a/release/connect-streams-min.js b/release/connect-streams-min.js
diff --git a/release/connect-streams.js b/release/connect-streams.js
@@ -26896,7 +26896,7 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
 
   connect.core = {};
   connect.core.initialized = false;
-  connect.version = "2.14.4";
+  connect.version = "2.14.5";
   connect.outerContextStreamsVersion = null;
   connect.DEFAULT_BATCH_SIZE = 500;
 
@@ -26940,6 +26940,8 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
   const SNAPSHOT_TOTAL_PROCESSING_TIME = 'SnapshotTotalProcessingTime';
   const SNAPSHOT_COMPARISON_STEP_TIME = 'SnapshotComparisonStepTime';
 
+  var CHECK_LOGIN_POPUP_INTERVAL_MS = 1000;
+
   const APP = {
     GUIDES: 'customviews',
   };
@@ -28334,7 +28336,7 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
           try {
             var loginUrl = getLoginUrl(params);
             connect.getLog().warn("ACK_TIMEOUT occurred, attempting to pop the login page if not already open.").sendInternalLogToServer();
-            connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, params.loginOptions);
+            connect.core._openPopupWithLock(loginUrl, params.loginOptions)
           } catch (e) {
             connect.getLog().error("ACK_TIMEOUT occurred but we are unable to open the login popup.").withException(e).sendInternalLogToServer();
           }
@@ -28405,6 +28407,45 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
     };
   };
 
+  connect.core._openPopupWithLock = function (loginUrl, loginOptions) {
+    const lockName = "connect-login-popup-lock" + loginUrl;
+
+    try {
+      navigator.locks.request(lockName, {mode: 'exclusive', ifAvailable: true }, async lock => {
+        if (!lock) {
+          connect.getLog().info("Popup already opened by another tab.").sendInternalLogToServer();
+          return;
+        }
+        connect.getLog().info("Opening popup window with weblock.").sendInternalLogToServer();
+
+        connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, loginOptions);
+
+        connect.core._shouldHoldPopupLock = true;
+
+        const checkPopupInterval = setInterval(function() {
+          if (!connect.core.loginWindow || connect.core.loginWindow?.closed) {
+              clearInterval(checkPopupInterval);
+              connect.core._shouldHoldPopupLock = false;
+              connect.getLog().info("Cleared check popup interval.").sendInternalLogToServer();
+          }
+        }, CHECK_LOGIN_POPUP_INTERVAL_MS);
+
+        // hold the lock until the popup is closed
+        while (connect.core._shouldHoldPopupLock) {
+            await new Promise(resolve => setTimeout(resolve, 1000));
+        }
+
+        connect.getLog().info("Releasing weblock for opening login popup.").sendInternalLogToServer();
+      })
+    } catch (e) {
+      connect.getLog().error("Failed to use weblock to open popup. Your browser may be out of date.").withException(e).sendInternalLogToServer();
+
+      if (!connect.core.loginWindow){
+        connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, loginOptions);
+      }
+    }
+  };
+
   connect.core.onIframeRetriesExhausted = function(f) {
     connect.core.getEventBus().subscribe(connect.EventType.IFRAME_RETRIES_EXHAUSTED, f);
   }

diff --git a/src/core.js b/src/core.js
@@ -55,6 +55,8 @@
   const SNAPSHOT_TOTAL_PROCESSING_TIME = 'SnapshotTotalProcessingTime';
   const SNAPSHOT_COMPARISON_STEP_TIME = 'SnapshotComparisonStepTime';
 
+  var CHECK_LOGIN_POPUP_INTERVAL_MS = 1000;
+
   const APP = {
     GUIDES: 'customviews',
   };
@@ -1449,7 +1451,7 @@
           try {
             var loginUrl = getLoginUrl(params);
             connect.getLog().warn("ACK_TIMEOUT occurred, attempting to pop the login page if not already open.").sendInternalLogToServer();
-            connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, params.loginOptions);
+            connect.core._openPopupWithLock(loginUrl, params.loginOptions)
           } catch (e) {
             connect.getLog().error("ACK_TIMEOUT occurred but we are unable to open the login popup.").withException(e).sendInternalLogToServer();
           }
@@ -1520,6 +1522,45 @@
     };
   };
 
+  connect.core._openPopupWithLock = function (loginUrl, loginOptions) {
+    const lockName = "connect-login-popup-lock" + loginUrl;
+
+    try {
+      navigator.locks.request(lockName, {mode: 'exclusive', ifAvailable: true }, async lock => {
+        if (!lock) {
+          connect.getLog().info("Popup already opened by another tab.").sendInternalLogToServer();
+          return;
+        }
+        connect.getLog().info("Opening popup window with weblock.").sendInternalLogToServer();
+
+        connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, loginOptions);
+
+        connect.core._shouldHoldPopupLock = true;
+
+        const checkPopupInterval = setInterval(function() {
+          if (!connect.core.loginWindow || connect.core.loginWindow?.closed) {
+              clearInterval(checkPopupInterval);
+              connect.core._shouldHoldPopupLock = false;
+              connect.getLog().info("Cleared check popup interval.").sendInternalLogToServer();
+          }
+        }, CHECK_LOGIN_POPUP_INTERVAL_MS);
+
+        // hold the lock until the popup is closed
+        while (connect.core._shouldHoldPopupLock) {
+            await new Promise(resolve => setTimeout(resolve, 1000));
+        }
+
+        connect.getLog().info("Releasing weblock for opening login popup.").sendInternalLogToServer();
+      })
+    } catch (e) {
+      connect.getLog().error("Failed to use weblock to open popup. Your browser may be out of date.").withException(e).sendInternalLogToServer();
+
+      if (!connect.core.loginWindow){
+        connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, loginOptions);
+      }
+    }
+  };
+
   connect.core.onIframeRetriesExhausted = function(f) {
     connect.core.getEventBus().subscribe(connect.EventType.IFRAME_RETRIES_EXHAUSTED, f);
   }