[MOB-11813] - JWT in background - Rework #931

Ayyanchira · 2025-07-30T19:23:35Z

🔹 Jira Ticket(s) if any

MOB-11813

✏️ Description

Please provide a brief description of what this pull request does.

Ayyanchira · 2025-08-01T18:38:31Z

At current state, I could still see refresh not happening when app is active & jwt in memory is within its refresh period.

Ayyanchira · 2025-08-05T05:29:58Z

Background/Foreground Auth Token Management

Background Prevention: JWT requests are now prevented when the app goes to background to avoid unnecessary network calls and improve performance.

Foreground Token Refresh Logic:

When the app comes to foreground, the SDK checks if the current auth token is within its refresh period
If the token is approaching expiration (within the configured expiringAuthTokenRefreshPeriod), a new token request is scheduled immediately
Otherwise, the token refresh is scheduled around the calculated expiration time (offset by the refresh period)

Retry Policy Integration: The existing retry policy logic remains unchanged:

When the app comes to foreground and the SDK detects an invalid or expired auth token in memory, it immediately schedules a new auth token request from the app (following the configured retry policy)
If no auth token is present in memory (null), the SDK waits for the first SDK request before attempting to schedule an auth token request to the app
This approach ensures efficient token management while maintaining backward compatibility with existing retry mechanisms.

Ayyanchira · 2025-08-05T05:32:12Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

+                                if (!isInForeground) {
+                                    IterableLogger.w(TAG, "Auth token request skipped - app is in background");
+                                    pendingAuth = false;
+                                    return;


This will now prevent the Auth token form getting requested to the app. This also does not increase the retryCount

Do we need to call the handleAuthTokenSuccess in this scenario?
Is it possible that the client's app is waiting for the sdk to return something?

Because no token will be requested until this point, we wont have to call any success or failure callback.
The function is void method which only SDK internally calls for scheduling a request. Once we make a request to app, we call either a success or failure callback

Ayyanchira · 2025-08-05T05:37:13Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

@@ -151,7 +165,7 @@ public void queueExpirationRefresh(String encodedJWT) {
            if (triggerExpirationRefreshTime > 0) {
                scheduleAuthTokenRefresh(triggerExpirationRefreshTime, true, null);
            } else {
-                IterableLogger.w(TAG, "The expiringAuthTokenRefreshPeriod has already passed for the current JWT");
+                scheduleAuthTokenRefresh(getNextRetryInterval(), true, null);


The SDK was missing the opportunity to refresh the token when the trigger time had already passed the configured refresh window

Ayyanchira · 2025-08-05T05:37:43Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

+        String currentAuthToken = api.getAuthToken();
+        if (currentAuthToken != null) {
+            // Reuse existing queueExpirationRefresh logic to check and schedule refresh if needed
+            queueExpirationRefresh(currentAuthToken);


When App comes back to foreground, it continues with its usual scheduling

Ayyanchira · 2025-08-05T05:41:48Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

+            // Reuse existing queueExpirationRefresh logic to check and schedule refresh if needed
+            queueExpirationRefresh(currentAuthToken);
+        } else {
+            IterableLogger.d(TAG, "No auth token available for expiration check");


For cases when auth token will be null in memory,
Like for Instances:

App's server is overloaded and not responding

App has not configured/ using JWT based API key
The app will not immediately follow scheduling auth Token request. When SDK makes a request and realizes missing of an auth token from backend is when it will continue to ask for new Auth token and following retry policy

1. ActivityMonitor removing callback doesnt need to be done. 2. encodedJWT can be null sometimes. SDK should still attempt to request jwt as per RetryPolicy (only when in foreground) 3. SDK to check email OR userID existence before proceeding to auth token check and retries

sumchattering · 2025-08-08T13:05:23Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

+    public void onSwitchToBackground() {
+        IterableLogger.d(TAG, "App switched to background - disabling auth token requests");
+        isInForeground = false;
+        clearRefreshTimer();


can we wrap in try catch blocks

sumchattering · 2025-08-08T13:05:37Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

+        IterableLogger.d(TAG, "App switched to foreground - enabling auth token requests");
+        isInForeground = true;
+
+        checkAndHandleAuthRefresh();


can we wrap in try catch blocks

Ayyanchira · 2025-08-12T06:27:22Z

Current state, the Test fails are not flaky. local running the tests are making it run properly but not when running the entire suite

Ayyanchira · 2025-08-12T22:48:14Z

@sumeruchat @davidtruong updated with try catch and review and comments on discussions initiated

sumeruchat · 2025-08-14T08:22:01Z

iterableapi/src/main/java/com/iterable/iterableapi/IterableAuthManager.java

        } catch (Exception e) {
-            IterableLogger.e(TAG, "Error in onSwitchToBackground", e);
+            throw new RuntimeException(e);


why are we throwing the exception

Good find! Thanks. No runtime exception needed. Replacing with Error log.

Im also seeing that isTimerScheduled is also checked within `scheduleAuthTokenRefresh` method. But somehow, without checking calling makes the test cases fail. So adding it as added checks are not harmful. Apart from that, surrounded background and foreground tasks in try catch as suggested in PR Reviews

[MOB-11813] - Null case and background handling

f3b1b26

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from 2667920 to f3b1b26 Compare July 30, 2025 19:33

Merge branch 'master' into MOB-11813-JWTrework-for-null-in-bg

d4a68d7

Merge branch 'master' into MOB-11813-JWTrework-for-null-in-bg

1a962a3

Ayyanchira requested a review from sumeruchat August 5, 2025 05:00

Ayyanchira marked this pull request as ready for review August 5, 2025 05:00

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from 87e7f7b to 6c0df8a Compare August 5, 2025 05:02

Handle token refresh when in refresh period

2ce0ee8

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from 6c0df8a to 2ce0ee8 Compare August 5, 2025 05:06

Ayyanchira changed the title ~~[MOB-11813] - Null case and background handling~~ [MOB-11813] - JWT in background - Rework Aug 5, 2025

Ayyanchira requested a review from davidtruong August 5, 2025 05:31

Ayyanchira commented Aug 5, 2025

View reviewed changes

“Akshay added 2 commits August 7, 2025 08:11

Added PR review comments

7404e94

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from 558eb97 to f4aedbf Compare August 8, 2025 07:02

sumchattering reviewed Aug 8, 2025

View reviewed changes

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from e550af7 to b445b0c Compare August 12, 2025 22:31

Ayyanchira requested a review from sumchattering August 12, 2025 22:47

sumeruchat reviewed Aug 14, 2025

View reviewed changes

Ayyanchira force-pushed the MOB-11813-JWTrework-for-null-in-bg branch from b445b0c to 50e002a Compare August 14, 2025 16:37

Ayyanchira requested a review from sumeruchat August 14, 2025 16:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[MOB-11813] - JWT in background - Rework #931

[MOB-11813] - JWT in background - Rework #931

Ayyanchira commented Jul 30, 2025 •

edited by jira bot

Loading

Uh oh!

Ayyanchira commented Aug 1, 2025

Uh oh!

Ayyanchira commented Aug 5, 2025

Uh oh!

Ayyanchira Aug 5, 2025

Uh oh!

davidtruong Aug 7, 2025

Uh oh!

Ayyanchira Aug 12, 2025

Uh oh!

Ayyanchira Aug 5, 2025

Uh oh!

Ayyanchira Aug 5, 2025

Uh oh!

Ayyanchira Aug 5, 2025

Uh oh!

sumchattering Aug 8, 2025

Uh oh!

sumchattering Aug 8, 2025

Uh oh!

Ayyanchira commented Aug 12, 2025

Uh oh!

Ayyanchira commented Aug 12, 2025

Uh oh!

sumeruchat Aug 14, 2025

Uh oh!

Ayyanchira Aug 14, 2025

Uh oh!

Uh oh!

[MOB-11813] - JWT in background - Rework #931

Are you sure you want to change the base?

[MOB-11813] - JWT in background - Rework #931

Conversation

Ayyanchira commented Jul 30, 2025 • edited by jira bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔹 Jira Ticket(s) if any

✏️ Description

Uh oh!

Ayyanchira commented Aug 1, 2025

Uh oh!

Ayyanchira commented Aug 5, 2025

Background/Foreground Auth Token Management

Background Prevention: JWT requests are now prevented when the app goes to background to avoid unnecessary network calls and improve performance.

Foreground Token Refresh Logic:

Retry Policy Integration: The existing retry policy logic remains unchanged:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ayyanchira commented Aug 12, 2025

Uh oh!

Ayyanchira commented Aug 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Ayyanchira commented Jul 30, 2025 •

edited by jira bot

Loading