feat: improve JWT error handling and enhance IterableConfig with additional flags

Author: lposen

src/core/classes/Iterable.ts

@@ -1017,7 +1017,7 @@ export class Iterable {
       let authResponseCallback: IterableAuthResponseResult;
       RNEventEmitter.addListener(IterableEventName.handleAuthCalled, () => {
         // MOB-10423: Check if we can use chain operator (?.) here instead
-
+        // Asks frontend of the client/app to pass authToken
         Iterable.savedConfig.authHandler!()
           .then((promiseResult) => {
             // Promise result can be either just String OR of type AuthResponse.
@@ -1038,6 +1038,8 @@ export class Iterable {
                 } else if (
                   authResponseCallback === IterableAuthResponseResult.FAILURE
                 ) {
+                  // We are currently only reporting JWT related errors.  In
+                  // the future, we should handle other types of errors as well.
                   if ((promiseResult as IterableAuthResponse).failureCallback) {
                     (promiseResult as IterableAuthResponse).failureCallback?.();
                   }
@@ -1067,8 +1069,14 @@ export class Iterable {
       );
       RNEventEmitter.addListener(
         IterableEventName.handleAuthFailureCalled,
-        () => {
+        (authFailureResponse: IterableAuthFailure) => {
+          // Mark the flag for above listener to indicate something failed.
+          // `catch(err)` will only indicate failure on high level. No actions
+          // should be taken inside `catch(err)`.
           authResponseCallback = IterableAuthResponseResult.FAILURE;
+
+          // Call the actual JWT error with `authFailure` object.
+          Iterable.savedConfig?.onJWTError?.(authFailureResponse);
         }
       );
     }

src/core/classes/IterableConfig.ts

@@ -209,7 +209,8 @@ export class IterableConfig {
   >;
 
   /**
-   * A callback function which is called when an error occurs while validating a JWT.
+   * A callback function that is called when the SDK encounters an error while
+   * validing the JWT.
    *
    * The retry for JWT should be automatically handled by the native SDK, so
    * this is just for logging/transparency purposes.
@@ -234,7 +235,8 @@ export class IterableConfig {
   logLevel: IterableLogLevel = IterableLogLevel.info;
 
   /**
-   * The retry policy to use when retrying a request.
+   * Configuration for JWT refresh retry behavior.
+   * If not specified, the SDK will use default retry behavior.
    */
   retryPolicy?: IterableRetryPolicy;
 
@@ -357,6 +359,13 @@ export class IterableConfig {
        */
       // eslint-disable-next-line eqeqeq
       authHandlerPresent: this.authHandler != undefined,
+      /**
+       * A boolean indicating if an onJWTError handler is present.
+       *
+       * TODO: Figure out if this is purposeful
+       */
+      // eslint-disable-next-line eqeqeq
+      onJWTErrorPresent: this.onJWTError != undefined,
       /** The log level for the SDK. */
       logLevel: this.logLevel,
       expiringAuthTokenRefreshPeriod: this.expiringAuthTokenRefreshPeriod,
@@ -367,6 +376,7 @@ export class IterableConfig {
       dataRegion: this.dataRegion,
       pushPlatform: this.pushPlatform,
       encryptionEnforced: this.encryptionEnforced,
+      retryPolicy: this.retryPolicy,
     };
   }
 }