Skip to content

Resolve StrictMode violation in App Check. #4085

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.

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
merged 6 commits into from
Sep 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import androidx.annotation.VisibleForTesting;
import com.google.android.gms.tasks.Continuation;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.android.gms.tasks.Tasks;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseException;
Expand All @@ -35,6 +36,8 @@
import com.google.firebase.inject.Provider;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class DefaultFirebaseAppCheck extends FirebaseAppCheck {

Expand All @@ -46,6 +49,8 @@ public class DefaultFirebaseAppCheck extends FirebaseAppCheck {
private final List<AppCheckListener> appCheckListenerList;
private final StorageHelper storageHelper;
private final TokenRefreshManager tokenRefreshManager;
private final ExecutorService backgroundExecutor;
private final Task<Void> retrieveStoredTokenTask;
private final Clock clock;

private AppCheckProviderFactory appCheckProviderFactory;
Expand All @@ -55,6 +60,17 @@ public class DefaultFirebaseAppCheck extends FirebaseAppCheck {
public DefaultFirebaseAppCheck(
@NonNull FirebaseApp firebaseApp,
@NonNull Provider<HeartBeatController> heartBeatController) {
this(
checkNotNull(firebaseApp),
checkNotNull(heartBeatController),
Executors.newCachedThreadPool());
}

@VisibleForTesting
DefaultFirebaseAppCheck(
@NonNull FirebaseApp firebaseApp,
@NonNull Provider<HeartBeatController> heartBeatController,
@NonNull ExecutorService backgroundExecutor) {
checkNotNull(firebaseApp);
checkNotNull(heartBeatController);
this.firebaseApp = firebaseApp;
Expand All @@ -65,8 +81,22 @@ public DefaultFirebaseAppCheck(
new StorageHelper(firebaseApp.getApplicationContext(), firebaseApp.getPersistenceKey());
this.tokenRefreshManager =
new TokenRefreshManager(firebaseApp.getApplicationContext(), /* firebaseAppCheck= */ this);
this.backgroundExecutor = backgroundExecutor;
this.retrieveStoredTokenTask = retrieveStoredAppCheckTokenInBackground(backgroundExecutor);
this.clock = new Clock.DefaultClock();
setCachedToken(storageHelper.retrieveAppCheckToken());
}

private Task<Void> retrieveStoredAppCheckTokenInBackground(@NonNull ExecutorService executor) {
TaskCompletionSource<Void> taskCompletionSource = new TaskCompletionSource<>();
executor.execute(
() -> {
AppCheckToken token = storageHelper.retrieveAppCheckToken();
if (token != null) {
setCachedToken(token);
}
taskCompletionSource.setResult(null);
});
return taskCompletionSource.getTask();
}

@Override
Expand Down Expand Up @@ -146,44 +176,50 @@ public void removeAppCheckListener(@NonNull AppCheckListener listener) {
@NonNull
@Override
public Task<AppCheckTokenResult> getToken(boolean forceRefresh) {
if (!forceRefresh && hasValidToken()) {
return Tasks.forResult(DefaultAppCheckTokenResult.constructFromAppCheckToken(cachedToken));
}
if (appCheckProvider == null) {
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromError(
new FirebaseException("No AppCheckProvider installed.")));
}
// TODO: Cache the in-flight task.
return fetchTokenFromProvider()
.continueWithTask(
new Continuation<AppCheckToken, Task<AppCheckTokenResult>>() {
@Override
public Task<AppCheckTokenResult> then(@NonNull Task<AppCheckToken> task) {
if (task.isSuccessful()) {
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromAppCheckToken(task.getResult()));
}
// If the token exchange failed, return a dummy token for integrators to attach in
// their headers.
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromError(
new FirebaseException(
task.getException().getMessage(), task.getException())));
}
});
return retrieveStoredTokenTask.continueWithTask(
unused -> {
if (!forceRefresh && hasValidToken()) {
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromAppCheckToken(cachedToken));
}
if (appCheckProvider == null) {
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromError(
new FirebaseException("No AppCheckProvider installed.")));
}
// TODO: Cache the in-flight task.
return fetchTokenFromProvider()
.continueWithTask(
appCheckTokenTask -> {
if (appCheckTokenTask.isSuccessful()) {
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromAppCheckToken(
appCheckTokenTask.getResult()));
}
// If the token exchange failed, return a dummy token for integrators to attach
// in their headers.
return Tasks.forResult(
DefaultAppCheckTokenResult.constructFromError(
new FirebaseException(
appCheckTokenTask.getException().getMessage(),
appCheckTokenTask.getException())));
});
});
}

@NonNull
@Override
public Task<AppCheckToken> getAppCheckToken(boolean forceRefresh) {
if (!forceRefresh && hasValidToken()) {
return Tasks.forResult(cachedToken);
}
if (appCheckProvider == null) {
return Tasks.forException(new FirebaseException("No AppCheckProvider installed."));
}
return fetchTokenFromProvider();
return retrieveStoredTokenTask.continueWithTask(
unused -> {
if (!forceRefresh && hasValidToken()) {
return Tasks.forResult(cachedToken);
}
if (appCheckProvider == null) {
return Tasks.forException(new FirebaseException("No AppCheckProvider installed."));
}
return fetchTokenFromProvider();
});
}

/** Fetches an {@link AppCheckToken} via the installed {@link AppCheckProvider}. */
Expand Down Expand Up @@ -227,7 +263,7 @@ void setCachedToken(@NonNull AppCheckToken token) {
* well as the in-memory cached {@link AppCheckToken}.
*/
private void updateStoredToken(@NonNull AppCheckToken token) {
storageHelper.saveAppCheckToken(token);
backgroundExecutor.execute(() -> storageHelper.saveAppCheckToken(token));
setCachedToken(token);

tokenRefreshManager.maybeScheduleTokenRefresh(token);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import androidx.test.core.app.ApplicationProvider;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.Tasks;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.firebase.FirebaseApp;
import com.google.firebase.appcheck.AppCheckProvider;
import com.google.firebase.appcheck.AppCheckProviderFactory;
Expand Down Expand Up @@ -74,7 +75,10 @@ public void setup() {
when(mockAppCheckProvider.getToken()).thenReturn(Tasks.forResult(validDefaultAppCheckToken));

defaultFirebaseAppCheck =
new DefaultFirebaseAppCheck(mockFirebaseApp, () -> mockHeartBeatController);
new DefaultFirebaseAppCheck(
mockFirebaseApp,
() -> mockHeartBeatController,
MoreExecutors.newDirectExecutorService());
}

@Test
Expand Down