Skip to content

Commit 21a39c5

Browse files
tusharkhandelwal8tusharkhandelwal8
authored
Rename ConfigMetadataClient to ConfigSharedPrefsClient (#6440)
Rename ConfigMetadataClient to ConfigSharedPrefsClient Reflects expanded functionality to store both metadata and custom signals in shared preferences.
1 parent 5a15867 commit 21a39c5

File tree

17 files changed

+267
-250
lines changed

17 files changed

+267
-250
lines changed

‎firebase-config/ktx/src/test/kotlin/com/google/firebase/remoteconfig/TestConstructorUtil.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import com.google.firebase.installations.FirebaseInstallationsApi
2323
import com.google.firebase.remoteconfig.internal.ConfigCacheClient
2424
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler
2525
import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler
26-
import com.google.firebase.remoteconfig.internal.ConfigMetadataClient
2726
import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler
27+
import com.google.firebase.remoteconfig.internal.ConfigSharedPrefsClient
2828
import com.google.firebase.remoteconfig.internal.rollouts.RolloutsStateSubscriptionsHandler
2929
import java.util.concurrent.Executor
3030

@@ -41,7 +41,7 @@ fun createRemoteConfig(
4141
defaultConfigsCache: ConfigCacheClient,
4242
fetchHandler: ConfigFetchHandler,
4343
getHandler: ConfigGetParameterHandler,
44-
frcMetadata: ConfigMetadataClient,
44+
frcSharedPrefs: ConfigSharedPrefsClient,
4545
realtimeHandler: ConfigRealtimeHandler,
4646
rolloutsStateSubscriptionsHandler: RolloutsStateSubscriptionsHandler
4747
): FirebaseRemoteConfig {
@@ -56,7 +56,7 @@ fun createRemoteConfig(
5656
defaultConfigsCache,
5757
fetchHandler,
5858
getHandler,
59-
frcMetadata,
59+
frcSharedPrefs,
6060
realtimeHandler,
6161
rolloutsStateSubscriptionsHandler
6262
)

‎firebase-config/ktx/src/test/kotlin/com/google/firebase/remoteconfig/ktx/RemoteConfigTests.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import com.google.firebase.remoteconfig.createRemoteConfig
3232
import com.google.firebase.remoteconfig.internal.ConfigCacheClient
3333
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler
3434
import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler
35-
import com.google.firebase.remoteconfig.internal.ConfigMetadataClient
3635
import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler
36+
import com.google.firebase.remoteconfig.internal.ConfigSharedPrefsClient
3737
import com.google.firebase.remoteconfig.internal.rollouts.RolloutsStateSubscriptionsHandler
3838
import org.junit.After
3939
import org.junit.Before
@@ -142,7 +142,7 @@ class ConfigTests : BaseTestCase() {
142142
defaultConfigsCache = mock(ConfigCacheClient::class.java),
143143
fetchHandler = mock(ConfigFetchHandler::class.java),
144144
getHandler = mockGetHandler,
145-
frcMetadata = mock(ConfigMetadataClient::class.java),
145+
frcSharedPrefs = mock(ConfigSharedPrefsClient::class.java),
146146
realtimeHandler = mock(ConfigRealtimeHandler::class.java),
147147
rolloutsStateSubscriptionsHandler = mock(RolloutsStateSubscriptionsHandler::class.java)
148148
)

‎firebase-config/src/androidTest/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigIntegrationTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
import com.google.firebase.remoteconfig.internal.ConfigContainer;
3636
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler;
3737
import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler;
38-
import com.google.firebase.remoteconfig.internal.ConfigMetadataClient;
3938
import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler;
39+
import com.google.firebase.remoteconfig.internal.ConfigSharedPrefsClient;
4040
import com.google.firebase.remoteconfig.internal.rollouts.RolloutsStateSubscriptionsHandler;
4141
import java.util.Date;
4242
import java.util.HashMap;
@@ -60,7 +60,7 @@ public class FirebaseRemoteConfigIntegrationTest {
6060
@Mock private ConfigCacheClient mockDefaultsCache;
6161
@Mock private ConfigFetchHandler mockFetchHandler;
6262
@Mock private ConfigGetParameterHandler mockGetHandler;
63-
@Mock private ConfigMetadataClient metadataClient;
63+
@Mock private ConfigSharedPrefsClient sharedPrefsClient;
6464
@Mock private ConfigRealtimeHandler mockConfigRealtimeHandler;
6565
@Mock private RolloutsStateSubscriptionsHandler mockRolloutsStateSubscriptionHandler;
6666

@@ -112,7 +112,7 @@ public void setUp() {
112112
mockDefaultsCache,
113113
mockFetchHandler,
114114
mockGetHandler,
115-
metadataClient,
115+
sharedPrefsClient,
116116
mockConfigRealtimeHandler,
117117
mockRolloutsStateSubscriptionHandler);
118118
}

‎firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfig.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler;
3434
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler.FetchResponse;
3535
import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler;
36-
import com.google.firebase.remoteconfig.internal.ConfigMetadataClient;
3736
import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler;
37+
import com.google.firebase.remoteconfig.internal.ConfigSharedPrefsClient;
3838
import com.google.firebase.remoteconfig.internal.DefaultsXmlParser;
3939
import com.google.firebase.remoteconfig.internal.rollouts.RolloutsStateSubscriptionsHandler;
4040
import java.util.ArrayList;
@@ -160,7 +160,7 @@ public static FirebaseRemoteConfig getInstance(@NonNull FirebaseApp app) {
160160
private final ConfigCacheClient defaultConfigsCache;
161161
private final ConfigFetchHandler fetchHandler;
162162
private final ConfigGetParameterHandler getHandler;
163-
private final ConfigMetadataClient frcMetadata;
163+
private final ConfigSharedPrefsClient frcSharedPrefs;
164164
private final FirebaseInstallationsApi firebaseInstallations;
165165
private final ConfigRealtimeHandler configRealtimeHandler;
166166
private final RolloutsStateSubscriptionsHandler rolloutsStateSubscriptionsHandler;
@@ -181,7 +181,7 @@ public static FirebaseRemoteConfig getInstance(@NonNull FirebaseApp app) {
181181
ConfigCacheClient defaultConfigsCache,
182182
ConfigFetchHandler fetchHandler,
183183
ConfigGetParameterHandler getHandler,
184-
ConfigMetadataClient frcMetadata,
184+
ConfigSharedPrefsClient frcSharedPrefs,
185185
ConfigRealtimeHandler configRealtimeHandler,
186186
RolloutsStateSubscriptionsHandler rolloutsStateSubscriptionsHandler) {
187187
this.context = context;
@@ -194,7 +194,7 @@ public static FirebaseRemoteConfig getInstance(@NonNull FirebaseApp app) {
194194
this.defaultConfigsCache = defaultConfigsCache;
195195
this.fetchHandler = fetchHandler;
196196
this.getHandler = getHandler;
197-
this.frcMetadata = frcMetadata;
197+
this.frcSharedPrefs = frcSharedPrefs;
198198
this.configRealtimeHandler = configRealtimeHandler;
199199
this.rolloutsStateSubscriptionsHandler = rolloutsStateSubscriptionsHandler;
200200
}
@@ -208,18 +208,18 @@ public Task<FirebaseRemoteConfigInfo> ensureInitialized() {
208208
Task<ConfigContainer> activatedConfigsTask = activatedConfigsCache.get();
209209
Task<ConfigContainer> defaultsConfigsTask = defaultConfigsCache.get();
210210
Task<ConfigContainer> fetchedConfigsTask = fetchedConfigsCache.get();
211-
Task<FirebaseRemoteConfigInfo> metadataTask = Tasks.call(executor, this::getInfo);
211+
Task<FirebaseRemoteConfigInfo> sharedPrefsTask = Tasks.call(executor, this::getInfo);
212212
Task<String> installationIdTask = firebaseInstallations.getId();
213213
Task<InstallationTokenResult> installationTokenTask = firebaseInstallations.getToken(false);
214214

215215
return Tasks.whenAllComplete(
216216
activatedConfigsTask,
217217
defaultsConfigsTask,
218218
fetchedConfigsTask,
219-
metadataTask,
219+
sharedPrefsTask,
220220
installationIdTask,
221221
installationTokenTask)
222-
.continueWith(executor, (unusedListOfCompletedTasks) -> metadataTask.getResult());
222+
.continueWith(executor, (unusedListOfCompletedTasks) -> sharedPrefsTask.getResult());
223223
}
224224

225225
/**
@@ -475,7 +475,7 @@ public Map<String, FirebaseRemoteConfigValue> getAll() {
475475
*/
476476
@NonNull
477477
public FirebaseRemoteConfigInfo getInfo() {
478-
return frcMetadata.getInfo();
478+
return frcSharedPrefs.getInfo();
479479
}
480480

481481
/**
@@ -488,7 +488,7 @@ public Task<Void> setConfigSettingsAsync(@NonNull FirebaseRemoteConfigSettings s
488488
return Tasks.call(
489489
executor,
490490
() -> {
491-
frcMetadata.setConfigSettings(settings);
491+
frcSharedPrefs.setConfigSettings(settings);
492492

493493
// Return value required; return null for Void.
494494
return null;
@@ -548,14 +548,14 @@ public Task<Void> setDefaultsAsync(@XmlRes int resourceId) {
548548
@NonNull
549549
public Task<Void> reset() {
550550
// Use a Task to avoid throwing potential file I/O errors to the caller and because
551-
// frcMetadata's clear call is blocking.
551+
// frcSharedPrefs's clear call is blocking.
552552
return Tasks.call(
553553
executor,
554554
() -> {
555555
activatedConfigsCache.clear();
556556
fetchedConfigsCache.clear();
557557
defaultConfigsCache.clear();
558-
frcMetadata.clear();
558+
frcSharedPrefs.clear();
559559
return null;
560560
});
561561
}
@@ -666,7 +666,7 @@ public Task<Void> setCustomSignals(@NonNull CustomSignals customSignalsMap) {
666666
return Tasks.call(
667667
executor,
668668
() -> {
669-
frcMetadata.setCustomSignals(customSignalsMap.customSignals);
669+
frcSharedPrefs.setCustomSignals(customSignalsMap.customSignals);
670670
return null;
671671
});
672672
}

‎firebase-config/src/main/java/com/google/firebase/remoteconfig/RemoteConfigComponent.java‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636
import com.google.firebase.remoteconfig.internal.ConfigFetchHandler;
3737
import com.google.firebase.remoteconfig.internal.ConfigFetchHttpClient;
3838
import com.google.firebase.remoteconfig.internal.ConfigGetParameterHandler;
39-
import com.google.firebase.remoteconfig.internal.ConfigMetadataClient;
4039
import com.google.firebase.remoteconfig.internal.ConfigRealtimeHandler;
40+
import com.google.firebase.remoteconfig.internal.ConfigSharedPrefsClient;
4141
import com.google.firebase.remoteconfig.internal.ConfigStorageClient;
4242
import com.google.firebase.remoteconfig.internal.Personalization;
4343
import com.google.firebase.remoteconfig.internal.rollouts.RolloutsStateFactory;
@@ -166,7 +166,7 @@ public synchronized FirebaseRemoteConfig get(String namespace) {
166166
ConfigCacheClient fetchedCacheClient = getCacheClient(namespace, FETCH_FILE_NAME);
167167
ConfigCacheClient activatedCacheClient = getCacheClient(namespace, ACTIVATE_FILE_NAME);
168168
ConfigCacheClient defaultsCacheClient = getCacheClient(namespace, DEFAULTS_FILE_NAME);
169-
ConfigMetadataClient metadataClient = getMetadataClient(context, appId, namespace);
169+
ConfigSharedPrefsClient sharedPrefsClient = getSharedPrefsClient(context, appId, namespace);
170170

171171
ConfigGetParameterHandler getHandler = getGetHandler(activatedCacheClient, defaultsCacheClient);
172172
Personalization personalization =
@@ -187,9 +187,9 @@ public synchronized FirebaseRemoteConfig get(String namespace) {
187187
fetchedCacheClient,
188188
activatedCacheClient,
189189
defaultsCacheClient,
190-
getFetchHandler(namespace, fetchedCacheClient, metadataClient),
190+
getFetchHandler(namespace, fetchedCacheClient, sharedPrefsClient),
191191
getHandler,
192-
metadataClient,
192+
sharedPrefsClient,
193193
rolloutsStateSubscriptionsHandler);
194194
}
195195

@@ -206,7 +206,7 @@ synchronized FirebaseRemoteConfig get(
206206
ConfigCacheClient defaultsClient,
207207
ConfigFetchHandler fetchHandler,
208208
ConfigGetParameterHandler getHandler,
209-
ConfigMetadataClient metadataClient,
209+
ConfigSharedPrefsClient sharedPrefsClient,
210210
RolloutsStateSubscriptionsHandler rolloutsStateSubscriptionsHandler) {
211211
if (!frcNamespaceInstances.containsKey(namespace)) {
212212
FirebaseRemoteConfig in =
@@ -221,15 +221,15 @@ synchronized FirebaseRemoteConfig get(
221221
defaultsClient,
222222
fetchHandler,
223223
getHandler,
224-
metadataClient,
224+
sharedPrefsClient,
225225
getRealtime(
226226
firebaseApp,
227227
firebaseInstallations,
228228
fetchHandler,
229229
activatedClient,
230230
context,
231231
namespace,
232-
metadataClient),
232+
sharedPrefsClient),
233233
rolloutsStateSubscriptionsHandler);
234234
in.startLoadingConfigsFromDisk();
235235
frcNamespaceInstances.put(namespace, in);
@@ -254,30 +254,32 @@ private ConfigCacheClient getCacheClient(String namespace, String configStoreTyp
254254

255255
@VisibleForTesting
256256
ConfigFetchHttpClient getFrcBackendApiClient(
257-
String apiKey, String namespace, ConfigMetadataClient metadataClient) {
257+
String apiKey, String namespace, ConfigSharedPrefsClient sharedPrefsClient) {
258258
String appId = firebaseApp.getOptions().getApplicationId();
259259
return new ConfigFetchHttpClient(
260260
context,
261261
appId,
262262
apiKey,
263263
namespace,
264-
/* connectTimeoutInSeconds= */ metadataClient.getFetchTimeoutInSeconds(),
265-
/* readTimeoutInSeconds= */ metadataClient.getFetchTimeoutInSeconds(),
266-
/* customSignals= */ metadataClient.getCustomSignals());
264+
/* connectTimeoutInSeconds= */ sharedPrefsClient.getFetchTimeoutInSeconds(),
265+
/* readTimeoutInSeconds= */ sharedPrefsClient.getFetchTimeoutInSeconds(),
266+
/* customSignals= */ sharedPrefsClient.getCustomSignals());
267267
}
268268

269269
@VisibleForTesting
270270
synchronized ConfigFetchHandler getFetchHandler(
271-
String namespace, ConfigCacheClient fetchedCacheClient, ConfigMetadataClient metadataClient) {
271+
String namespace,
272+
ConfigCacheClient fetchedCacheClient,
273+
ConfigSharedPrefsClient sharedPrefsClient) {
272274
return new ConfigFetchHandler(
273275
firebaseInstallations,
274276
isPrimaryApp(firebaseApp) ? analyticsConnector : () -> null,
275277
executor,
276278
DEFAULT_CLOCK,
277279
DEFAULT_RANDOM,
278280
fetchedCacheClient,
279-
getFrcBackendApiClient(firebaseApp.getOptions().getApiKey(), namespace, metadataClient),
280-
metadataClient,
281+
getFrcBackendApiClient(firebaseApp.getOptions().getApiKey(), namespace, sharedPrefsClient),
282+
sharedPrefsClient,
281283
this.customHeaders);
282284
}
283285

@@ -288,15 +290,15 @@ synchronized ConfigRealtimeHandler getRealtime(
288290
ConfigCacheClient activatedCacheClient,
289291
Context context,
290292
String namespace,
291-
ConfigMetadataClient metadataClient) {
293+
ConfigSharedPrefsClient sharedPrefsClient) {
292294
return new ConfigRealtimeHandler(
293295
firebaseApp,
294296
firebaseInstallations,
295297
configFetchHandler,
296298
activatedCacheClient,
297299
context,
298300
namespace,
299-
metadataClient,
301+
sharedPrefsClient,
300302
executor);
301303
}
302304

@@ -306,13 +308,14 @@ private ConfigGetParameterHandler getGetHandler(
306308
}
307309

308310
@VisibleForTesting
309-
static ConfigMetadataClient getMetadataClient(Context context, String appId, String namespace) {
311+
static ConfigSharedPrefsClient getSharedPrefsClient(
312+
Context context, String appId, String namespace) {
310313
String fileName =
311314
String.format(
312315
"%s_%s_%s_%s",
313316
FIREBASE_REMOTE_CONFIG_FILE_NAME_PREFIX, appId, namespace, PREFERENCES_FILE_NAME);
314317
SharedPreferences preferences = context.getSharedPreferences(fileName, Context.MODE_PRIVATE);
315-
return new ConfigMetadataClient(preferences);
318+
return new ConfigSharedPrefsClient(preferences);
316319
}
317320

318321
@Nullable

0 commit comments

Comments
 (0)