Anushree Ganjam
26a5f65afd
See https://docs.google.com/drawings/d/1JHFi_nhmQt2xPT1N3FB_1mnaRK5TVqKZ9-fSl3EA7sU/edit?usp=sharing and https://docs.google.com/drawings/d/1bx4WURP4uHZGzZ1bWQgpw701jkTkVqlNfA02Yt-ZtSI/edit?usp=sharing&resourcekey=0-oySjsnaCsOSrNIPqqEa0gw for design details. We need to make SandboxContext extend LauncherApplication because we want create MainThreadInitializedObjects in SandboxContext's AppComponent scope. Since MainThreadInitiliazedObjects are closed in SandboxContext's OnDestroy() , we need to replicate same thing using dagger as well. - DaggerSingletonObject is same as MainThreadInitializedObject but is used for fetching the dagger created singletons so that we can avoid major refactors for accessing singletons. This will be deleted soon. - DaggerSingletonTracker to track dagger created singletons and call close() on those singleton objects created in SandboxContext scope. - Annotate the singleton object SettingsChangeLogger constructor with @Inject and execute the statements in Main thread. - Added createSandboxContextForTest(only for Test) to avoid creation of dagger component in test. As follow up, I will delete this method and introduce fakeDaggerComponents in test. Bug: 361850561 Test: Manual Flag: NONE Dagger Integration Change-Id: I2d3762ea64e53baa4de190790568aec750b54201
58 lines
1.9 KiB
Java
58 lines
1.9 KiB
Java
/*
|
|
* Copyright (C) 2024 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package com.android.launcher3.util;
|
|
|
|
import com.android.launcher3.dagger.LauncherAppSingleton;
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import javax.inject.Inject;
|
|
|
|
/**
|
|
* A tracker class for keeping track of Dagger created singletons.
|
|
* Dagger will take care of creating singletons. But we should take care of unregistering callbacks
|
|
* if at all registered during singleton construction.
|
|
* All singletons should be declared as SafeCloseable so that we can call close() method.
|
|
*/
|
|
@LauncherAppSingleton
|
|
public class DaggerSingletonTracker implements SafeCloseable {
|
|
|
|
private final ArrayList<SafeCloseable> mLauncherAppSingletons = new ArrayList<>();
|
|
|
|
@Inject
|
|
DaggerSingletonTracker() {
|
|
}
|
|
|
|
/**
|
|
* Adds the SafeCloseable Singletons to the mLauncherAppSingletons list.
|
|
* This helps to track the singletons and close them appropriately.
|
|
* See {@link DaggerSingletonTracker#close()} and
|
|
* {@link MainThreadInitializedObject.SandboxContext#onDestroy()}
|
|
*/
|
|
public void addCloseable(SafeCloseable closeable) {
|
|
mLauncherAppSingletons.add(closeable);
|
|
}
|
|
|
|
@Override
|
|
public void close() {
|
|
// Destroy in reverse order
|
|
for (int i = mLauncherAppSingletons.size() - 1; i >= 0; i--) {
|
|
mLauncherAppSingletons.get(i).close();
|
|
}
|
|
}
|
|
}
|