Make FirebaseApp.delete() Public #5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,19 +2,19 @@ | |
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
| import static com.google.common.base.Preconditions.checkState; | ||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.MoreObjects; | ||
| import com.google.common.base.Strings; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.common.io.BaseEncoding; | ||
| import com.google.firebase.internal.AuthStateListener; | ||
| import com.google.firebase.internal.FirebaseAppStore; | ||
| import com.google.firebase.internal.FirebaseExecutors; | ||
| import com.google.firebase.internal.FirebaseService; | ||
| import com.google.firebase.internal.GetTokenResult; | ||
| import com.google.firebase.internal.Joiner; | ||
| import com.google.firebase.internal.NonNull; | ||
| import com.google.firebase.internal.Nullable; | ||
|
|
@@ -29,46 +29,50 @@ | |
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.concurrent.Callable; | ||
| import java.util.concurrent.ScheduledFuture; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| /** | ||
| * The entry point of Firebase SDKs. It holds common configuration and state for Firebase APIs. Most | ||
| * applications don't need to directly interact with FirebaseApp. | ||
| * | ||
| * <p>Firebase APIs use the default FirebaseApp by default, unless a different one is explicitly | ||
| * passed to the API via FirebaseFoo.getInstance(firebaseApp). | ||
| * | ||
| * <p>{@link FirebaseApp#initializeApp(FirebaseOptions)} initializes the default app instance. This | ||
| * method should be invoked at startup. | ||
| */ | ||
| public class FirebaseApp { | ||
|
|
||
| /** A map of (name, FirebaseApp) instances. */ | ||
| private static final Map<String, FirebaseApp> instances = new HashMap<>(); | ||
|
|
||
| public static final String DEFAULT_APP_NAME = "[DEFAULT]"; | ||
| private static final long TOKEN_REFRESH_INTERVAL_MILLIS = TimeUnit.MINUTES.toMillis(55); | ||
| private static final TokenRefresher.Factory DEFAULT_TOKEN_REFRESHER_FACTORY = | ||
| new TokenRefresher.Factory(); | ||
|
|
||
| /** | ||
| * Global lock for synchronizing all SDK-wide application state changes. Specifically, any | ||
| * accesses to instances map should be protected by this lock. | ||
| */ | ||
| private static final Object appsLock = new Object(); | ||
|
|
||
| private final String name; | ||
| private final FirebaseOptions options; | ||
| private final TokenRefresher tokenRefresher; | ||
|
|
||
| private final AtomicBoolean deleted = new AtomicBoolean(); | ||
| private final List<AuthStateListener> authStateListeners = new ArrayList<>(); | ||
| private final AtomicReference<GetTokenResult> currentToken = new AtomicReference<>(); | ||
| private final Map<String, FirebaseService> services = new HashMap<>(); | ||
|
There was a problem hiding this comment. I'm having some trouble reasoning about the threading of this class. I think it might help if you:
Contributor
Author
There was a problem hiding this comment. I prefer the idea of having two locks here:
I basically don't want action from app-A to block an action from App-B. I've added some comments explaining the purpose of two locks. Removed GuardedBy annotation. Also we need to selectively lock some parts of the code. In particular, we don't want to hold a lock while executing an event handler (e.g. AuthStateListener) |
||
|
|
||
| /** | ||
| * Per application lock for synchronizing all internal FirebaseApp state changes. | ||
| */ | ||
| private final Object lock = new Object(); | ||
|
|
||
| /** Default constructor. */ | ||
| private FirebaseApp(String name, FirebaseOptions options, TokenRefresher.Factory factory) { | ||
|
|
@@ -81,7 +85,9 @@ private FirebaseApp(String name, FirebaseOptions options, TokenRefresher.Factory | |
| /** Returns a mutable list of all FirebaseApps. */ | ||
| public static List<FirebaseApp> getApps() { | ||
| // TODO(arondeak): reenable persistence. See b/28158809. | ||
| synchronized (appsLock) { | ||
| return ImmutableList.copyOf(instances.values()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -103,7 +109,7 @@ public static FirebaseApp getInstance() { | |
| * #initializeApp(FirebaseOptions, String)} or {@link #getApps()}. | ||
| */ | ||
| public static FirebaseApp getInstance(@NonNull String name) { | ||
| synchronized (appsLock) { | ||
| FirebaseApp firebaseApp = instances.get(normalize(name)); | ||
| if (firebaseApp != null) { | ||
| return firebaseApp; | ||
|
|
@@ -154,8 +160,8 @@ static FirebaseApp initializeApp( | |
| FirebaseAppStore appStore = FirebaseAppStore.initialize(); | ||
| String normalizedName = normalize(name); | ||
| final FirebaseApp firebaseApp; | ||
| synchronized (appsLock) { | ||
| checkState( | ||
| !instances.containsKey(normalizedName), | ||
| "FirebaseApp name " + normalizedName + " already exists!"); | ||
|
|
||
|
|
@@ -170,8 +176,12 @@ static FirebaseApp initializeApp( | |
|
|
||
| @VisibleForTesting | ||
| static void clearInstancesForTest() { | ||
| synchronized (appsLock) { | ||
| // Copy the instances list before iterating, as delete() would attempt to remove from the | ||
| // original list. | ||
| for (FirebaseApp app : ImmutableList.copyOf(instances.values())) { | ||
| app.delete(); | ||
| } | ||
| instances.clear(); | ||
| } | ||
| } | ||
|
|
@@ -191,7 +201,7 @@ String getPersistenceKey() { | |
|
|
||
| private static List<String> getAllAppNames() { | ||
| Set<String> allAppNames = new HashSet<>(); | ||
| synchronized (appsLock) { | ||
| for (FirebaseApp app : instances.values()) { | ||
| allAppNames.add(app.getName()); | ||
| } | ||
|
|
@@ -250,27 +260,33 @@ public String toString() { | |
| * | ||
| * <p>A no-op if delete was called before. | ||
| */ | ||
| public void delete() { | ||
| synchronized (lock) { | ||
| boolean valueChanged = deleted.compareAndSet(false /* expected */, true); | ||
| if (!valueChanged) { | ||
| return; | ||
| } | ||
|
|
||
| for (FirebaseService service : services.values()) { | ||
| service.destroy(); | ||
| } | ||
| services.clear(); | ||
| authStateListeners.clear(); | ||
| tokenRefresher.cleanup(); | ||
| } | ||
|
|
||
| synchronized (appsLock) { | ||
| instances.remove(name); | ||
| } | ||
|
|
||
| FirebaseAppStore appStore = FirebaseAppStore.getInstance(); | ||
| if (appStore != null) { | ||
| appStore.removeApp(name); | ||
| } | ||
| } | ||
|
|
||
| private void checkNotDeleted() { | ||
| checkState(!deleted.get(), "FirebaseApp was deleted %s", this); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -293,10 +309,14 @@ public GetTokenResult then(@NonNull Task<String> task) throws Exception { | |
| GetTokenResult oldToken = currentToken.get(); | ||
| List<AuthStateListener> listenersCopy = null; | ||
| if (!newToken.equals(oldToken)) { | ||
| synchronized (lock) { | ||
| if (deleted.get()) { | ||
| return newToken; | ||
| } | ||
|
|
||
| // Grab the lock before compareAndSet to avoid a potential race | ||
| // condition with addAuthStateListener. The same lock also ensures serial | ||
| // access to the token refresher. | ||
| if (currentToken.compareAndSet(oldToken, newToken)) { | ||
| listenersCopy = ImmutableList.copyOf(authStateListeners); | ||
| tokenRefresher.scheduleRefresh(TOKEN_REFRESH_INTERVAL_MILLIS); | ||
|
|
@@ -318,55 +338,48 @@ boolean isDefaultApp() { | |
| return DEFAULT_APP_NAME.equals(getName()); | ||
| } | ||
|
|
||
| void addAuthStateListener(@NonNull final AuthStateListener listener) { | ||
| GetTokenResult currentToken; | ||
| synchronized (lock) { | ||
| checkNotDeleted(); | ||
| authStateListeners.add(checkNotNull(listener)); | ||
| currentToken = this.currentToken.get(); | ||
| } | ||
|
|
||
| if (currentToken != null) { | ||
| // Task has copied the authStateListeners before the listener was added. | ||
| // Notify this listener explicitly. | ||
| listener.onAuthStateChanged(currentToken); | ||
| } | ||
| } | ||
|
|
||
| void removeAuthStateListener(@NonNull AuthStateListener listener) { | ||
| synchronized (lock) { | ||
| checkNotDeleted(); | ||
| authStateListeners.remove(checkNotNull(listener)); | ||
| } | ||
| } | ||
|
|
||
| void addService(FirebaseService service) { | ||
| synchronized (lock) { | ||
| checkNotDeleted(); | ||
| checkArgument(!services.containsKey(checkNotNull(service).getId())); | ||
| services.put(service.getId(), service); | ||
| } | ||
| } | ||
|
|
||
| FirebaseService getService(String id) { | ||
| synchronized (lock) { | ||
| checkArgument(!Strings.isNullOrEmpty(id)); | ||
| return services.get(id); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Utility class for scheduling proactive token refresh events. Each FirebaseApp should have | ||
| * its own instance of this class. This class is not thread safe. The caller (FirebaseApp) must | ||
| * ensure that methods are called serially. | ||
| */ | ||
| static class TokenRefresher { | ||
|
|
||
| private final FirebaseApp firebaseApp; | ||
|
|
@@ -382,7 +395,7 @@ static class TokenRefresher { | |
| * @param delayMillis Duration in milliseconds, after which the token should be forcibly | ||
| * refreshed. | ||
| */ | ||
| final void scheduleRefresh(long delayMillis) { | ||
| cancelPrevious(); | ||
| scheduleNext( | ||
| new Callable<Task<GetTokenResult>>() { | ||
|
|
@@ -410,14 +423,13 @@ protected void scheduleNext(Callable<Task<GetTokenResult>> task, long delayMilli | |
| } | ||
| } | ||
|
|
||
| protected void cleanup() { | ||
| if (future != null) { | ||
| future.cancel(true); | ||
| } | ||
| } | ||
|
|
||
| static class Factory { | ||
| TokenRefresher create(FirebaseApp app) { | ||
| return new TokenRefresher(app); | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI- There are stray asterisks at the end of line 40 and 43 for some reason. They may show up in generated reference docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed