Skip to content

Additional logging for failed HQ token auth in ConnectID-managed apps. #2984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OrangeAndGreen merged 4 commits into from
Mar 14, 2025
Merged

Additional logging for failed HQ token auth in ConnectID-managed apps. #2984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5589445
Additional logging for failed HQ token auth in ConnectID-managed apps.
OrangeAndGreen Mar 12, 2025
3078ade
Retrieving seatedAppId retrieval inside function that checks for toke…
OrangeAndGreen Mar 13, 2025
e546eb5
Merge branch 'connect_qa' into dv/log_hq_token_auth_failure
OrangeAndGreen Mar 13, 2025
283500b
Merge branch 'connect_qa' into dv/log_hq_token_auth_failure
OrangeAndGreen Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/src/org/commcare/activities/LoginActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,6 +878,10 @@ public void handlePullTaskResult(ResultAndError<DataPullTask.PullTaskResult> res
raiseLoginMessage(StockMessages.Empty_Url, true);
break;
case AUTH_FAILED:
if(ConnectManager.checkForFailedConnectIdAuth(uiController.getEnteredUsername())) {
Logger.exception("Token auth error for connect managed app",
new Throwable("Token Auth failed during login for a ConnectID managed app"));
}
raiseLoginMessage(StockMessages.Auth_BadCredentials, false);
break;
case BAD_DATA_REQUIRES_INTERVENTION:
Expand Down
9 changes: 7 additions & 2 deletions app/src/org/commcare/activities/SyncCapableCommCareActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.commcare.views.dialogs.StandardAlertDialog;
import org.commcare.views.notifications.NotificationActionButtonInfo;
import org.commcare.views.notifications.NotificationMessageFactory;
import org.javarosa.core.services.Logger;
import org.javarosa.core.services.locale.Localization;

public abstract class SyncCapableCommCareActivity<T> extends SessionAwareCommCareActivity<T>
Expand Down Expand Up @@ -103,9 +104,13 @@ public void handlePullTaskResult(ResultAndError<DataPullTask.PullTaskResult> res
updateUiAfterDataPullOrSend(Localization.get("sync.fail.empty.url"), FAIL);
break;
case AUTH_FAILED:
String seatedAppId = CommCareApplication.instance().getCurrentApp().getUniqueId();
String username = CommCareApplication.instance().getRecordForCurrentUser().getUsername();
ConnectManager.forgetAppCredentials(seatedAppId, username);
Copy link
Contributor

@shubham1g5 shubham1g5 Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is intentional ?

Copy link
Contributor Author

@OrangeAndGreen OrangeAndGreen Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, getting rid of that on purpose. It was added with ConnectID-managed traditional apps in mind. But now that we know the token auth could fail for other reasons, we don't want to take the unnecessary step of forcing the app credentials to be setup again. The improved messaging is a better reaction to this error.


if(ConnectManager.checkForFailedConnectIdAuth(username)) {
Logger.exception("Token auth error for connect managed app",
new Throwable("Token Auth failed during sync for a ConnectID managed app"));
}

updateUiAfterDataPullOrSend(Localization.get("sync.fail.auth.loggedin"), FAIL);
break;
case BAD_DATA:
Expand Down
15 changes: 15 additions & 0 deletions app/src/org/commcare/connect/ConnectManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,21 @@ public static void checkConnectIdLink(CommCareActivity<?> activity, boolean auto
callback.connectActivityComplete(false);
}

public static boolean checkForFailedConnectIdAuth(String username) {
try {
if (isConnectIdConfigured()) {
String seatedAppId = CommCareApplication.instance().getCurrentApp().getUniqueId();
ConnectLinkedAppRecord appRecord = ConnectDatabaseHelper.getAppData(
CommCareApplication.instance(), seatedAppId, username);
return appRecord != null && appRecord.getWorkerLinked();
}
} catch (Exception e){
Logger.exception("Error while checking ConnectId status after failed token auth", e);
}

return false;
}

public static ConnectAppMangement getAppManagement(Context context, String appId, String userId) {
ConnectAppRecord record = getAppRecord(context, appId);
if(record != null) {
Expand Down
16 changes: 3 additions & 13 deletions app/src/org/commcare/network/CommcareRequestGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,19 +183,9 @@ private AuthInfo buildAuth() {
Logger.log(LogTypes.TYPE_MAINTENANCE, "Applying token auth");
return tokenAuth;
} else {
try {
if (ConnectManager.isConnectIdConfigured()) {
String seatedAppId = CommCareApplication.instance().getCurrentApp().getUniqueId();
ConnectLinkedAppRecord appRecord = ConnectDatabaseHelper.getAppData(
CommCareApplication.instance(), seatedAppId, username);
if (appRecord != null && appRecord.getWorkerLinked()) {
Logger.exception("Critical auth error for connect managed app",
new Throwable("No token Auth available for a connect managed app"));
}
}
Logger.log(LogTypes.TYPE_MAINTENANCE, "Applying current auth");
} catch (Exception e){
Logger.exception("error while checking connect status when trying to build auth", e);
if(ConnectManager.checkForFailedConnectIdAuth(username)) {
Logger.exception("Token auth error for connect managed app",
new Throwable("No token Auth available for a connect managed app"));
}

CommCareApplication.instance().getSession().getLoggedInUser();
Expand Down