fix(xhrUtil): Added better logging and retries in XHRUtil

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.64.3] - 2024-01-02
+
+### Added
+
+- Added better logging and retries in XHRUtil
+
 ## [1.64.2] - 2023-12-19
 
 ### Fixed

lib/utils/EventDispatcherUtil.js

@@ -140,7 +140,8 @@ let EventDispatcher = {
             method: 'POST',
             url: `${properties.url}${queryParams}`,
             payload,
-            customHeaders
+            customHeaders,
+            logger
           })
           .then(() => {
             this.handlePostResponse(properties, payload);

lib/utils/XhrUtil.js

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+const logging = require('../services/logging');
+const { LogLevelEnum } = logging;
 const { getCurrentTime } = require('./FunctionUtil');
 const { isObject, isFunction } = require('./DataTypeUtil');
 
@@ -55,7 +57,7 @@ const XhrUtil = {
       parsedSettings
     };
   },
-  send: function({ method, url, payload, userStorageService, customHeaders } = {}) {
+  send: function({ method, url, payload, userStorageService, customHeaders, logger } = {}) {
     if (!url || !method) {
       return;
     }
@@ -67,12 +69,68 @@ const XhrUtil = {
         resolve(parsedSettings);
       } else {
         let xhr = new XMLHttpRequest();
-        this.xhrHandler(xhr, method, url, payload, userStorageService, customHeaders, resolve, reject);
+        this.xhrHandler(xhr, method, url, payload, userStorageService, customHeaders, logger, resolve, reject);
       }
     });
   },
 
-  xhrHandler: function(xhr, method, url, payload, userStorageService, customHeaders = {}, resolve, reject) {
+  // send request function definition (to allow for retries)
+  sendRequest: function(xhr, retries, maxRetries, delay, logger, customHeaders, payload, method, url, resolve, reject) {
+    // onload event
+    xhr.onload = () => {
+      // retry if error and less than max retries
+      if (xhr.status < 200 || xhr.status >= 300) {
+        if (retries < maxRetries) {
+          retries++;
+
+          // log retried times
+          logger.log(LogLevelEnum.ERROR, 'Retrying with Status Code :' + xhr.status);
+          logger.log(LogLevelEnum.ERROR, 'Retrying with Response :' + xhr.responseText);
+
+          // call send request again, after delay
+          setTimeout(() => {
+            this.sendRequest(
+              xhr,
+              retries,
+              maxRetries,
+              delay,
+              logger,
+              customHeaders,
+              payload,
+              method,
+              url,
+              resolve,
+              reject
+            );
+          }, delay);
+        } else {
+          // log errors with status (clean up later)
+          logger.log(LogLevelEnum.ERROR, 'Request failed with Status Code :' + xhr.status);
+          logger.log(LogLevelEnum.ERROR, 'Request failed with Response :' + xhr.responseText);
+          reject(`Got Error: ${xhr.statusText} and Status Code: ${xhr.status}`);
+        }
+      } else {
+        // resolve the promise if all well
+        resolve();
+      }
+    };
+
+    // onerror event
+    xhr.onerror = () => {
+      reject(`Error: ${xhr.statusText}, Status Code: ${xhr.status}`);
+    };
+
+    // open connection and add headers if any, and then send
+    xhr.open(method, url, true);
+    for (var newHeaderName in customHeaders) {
+      if (customHeaders.hasOwnProperty(newHeaderName)) {
+        xhr.setRequestHeader(newHeaderName, customHeaders[newHeaderName]);
+      }
+    }
+    xhr.send(JSON.stringify(payload));
+  },
+
+  xhrHandler: function(xhr, method, url, payload, userStorageService, customHeaders = {}, logger, resolve, reject) {
     if (method === 'GET') {
       try {
         xhr.onload = () => {
@@ -93,20 +151,13 @@ const XhrUtil = {
         console.log(e.message);
       }
     } else if (method === 'POST') {
-      xhr.onload = () => {
-        resolve();
-      };
-      xhr.onerror = () => {
-        reject(`Error: ${xhr.statusText}, Status Code: ${xhr.status}`);
-      };
-
-      xhr.open(method, url, true);
-      for (var newHeaderName in customHeaders) {
-        if (customHeaders.hasOwnProperty(newHeaderName)) {
-          xhr.setRequestHeader(newHeaderName, customHeaders[newHeaderName]);
-        }
-      }
-      xhr.send(JSON.stringify(payload));
+      // retry params
+      let retries = 0;
+      let maxRetries = 5;
+      let delay = 1000;
+
+      // send request
+      this.sendRequest(xhr, retries, maxRetries, delay, logger, customHeaders, payload, method, url, resolve, reject);
     }
   },