Disconnect from Remote Config real-time server when app is backgrounded. #6816

tusharkhandelwal8 · 2025-03-28T07:54:04Z

This PR focuses on enhancing the reliability and efficiency of the Remote Config real-time stream, particularly concerning background app states. We've refined the ConfigRealtimeHttpClient to retrieve and manage the underlying input and error streams more effectively, ensuring proper closure even in error scenarios. Additionally, the closeRealtimeHttpStream method now explicitly closes these streams using the acquired references.

A key improvement is the robust handling of the app's background state. The setRealtimeBackgroundState method is now synchronized to guarantee thread-safe updates and will immediately close the real-time HTTP connection when the app transitions to the background. This background state is also reflected in ConfigAutoFetch, allowing for conditional exception logging during real-time stream listening, ensuring logs are only generated when the app is actively in the foreground. Furthermore, ConfigAutoFetch now maintains a dedicated InputStream reference to ensure proper stream closure, and a separate reference is kept in beginRealtimeHttpStream to handle potential early closure scenarios before ConfigAutoFetch is reached.

github-actions · 2025-03-28T07:54:19Z

📝 PRs merging into main branch

Our main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released.

google-oss-bot · 2025-03-28T07:58:25Z

Coverage Report ¹

Affected Products

`firebase-config`

Overall coverage changed from ? (58b9da4) to 84.30% (2b6cb5b) by ?.

34 individual files with coverage change

Filename	Base (`58b9da4`)	Merge (`2b6cb5b`)	Diff
AutoValue_ConfigUpdate.java	?	29.41%	?
Code.java	?	0.00%	?
ConfigAutoFetch.java	?	86.73%	?
ConfigCacheClient.java	?	93.33%	?
ConfigContainer.java	?	94.29%	?
ConfigFetchHandler.java	?	92.94%	?
ConfigFetchHttpClient.java	?	86.27%	?
ConfigGetParameterHandler.java	?	96.45%	?
ConfigRealtimeHandler.java	?	41.38%	?
ConfigRealtimeHttpClient.java	?	73.45%	?
ConfigSharedPrefsClient.java	?	87.50%	?
ConfigStorageClient.java	?	100.00%	?
ConfigUpdate.java	?	100.00%	?
ConfigUpdateListener.java	?	0.00%	?
ConfigUpdateListenerRegistration.java	?	0.00%	?
CustomSignals.java	?	100.00%	?
DefaultsXmlParser.java	?	0.00%	?
FirebaseRemoteConfig.java	?	89.76%	?
FirebaseRemoteConfigClientException.java	?	75.00%	?
FirebaseRemoteConfigException.java	?	95.65%	?
FirebaseRemoteConfigFetchThrottledException.java	?	100.00%	?
FirebaseRemoteConfigInfo.java	?	0.00%	?
FirebaseRemoteConfigInfoImpl.java	?	100.00%	?
FirebaseRemoteConfigServerException.java	?	68.42%	?
FirebaseRemoteConfigSettings.java	?	61.54%	?
FirebaseRemoteConfigValue.java	?	0.00%	?
FirebaseRemoteConfigValueImpl.java	?	84.62%	?
Personalization.java	?	91.43%	?
RemoteConfig.kt	?	31.58%	?
RemoteConfigComponent.java	?	90.70%	?
RemoteConfigConstants.java	?	0.00%	?
RemoteConfigRegistrar.java	?	100.00%	?
RolloutsStateFactory.java	?	95.24%	?
RolloutsStateSubscriptionsHandler.java	?	100.00%	?

Test Logs

Merge (2b6cb5b): https://github.com/firebase/firebase-android-sdk/actions/runs/14361466226

https://storage.googleapis.com/firebase-sdk-metric-reports/RUyYk4Mt6i.html

github-actions · 2025-03-28T08:00:19Z

Test Results

42 files - 992 42 suites - 992 1m 23s ⏱️ - 32m 55s
324 tests - 5 548 324 ✅ - 5 526 0 💤 - 22 0 ❌ ±0
660 runs - 11 147 660 ✅ - 11 103 0 💤 - 44 0 ❌ ±0

Results for commit 3c879c7. ± Comparison against base commit 58b9da4.

This pull request removes 5550 and adds 2 tests. Note that renamed tests count towards both.

com.google.android.datatransport.cct.CctBackendFactoryTest ‑ create_returnCCTBackend_WhenBackendNameIsCCT
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldOnlySupportProtoAndJson
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldSupportProtoAndJson
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOffline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOnline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldAddCookieOnPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldDropCookieOnMixedPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_CompressedResponseIsUncompressed
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirectsMoreThan5Times_shouldOnlyRedirect4Times
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirects_shouldCorrectlyFollowTheRedirectViaPost
…

com.google.firebase.remoteconfig.FirebaseRemoteConfigTest ‑ realtime_stream_listen_backgrounded_disconnects
com.google.firebase.remoteconfig.FirebaseRemoteConfigTest ‑ realtime_stream_listen_get_inputstream_exception_handling

♻️ This comment has been updated with latest results.

google-oss-bot · 2025-03-28T08:09:07Z

Size Report ¹

Affected Products

firebase-config
Type Base (58b9da4) Merge (2b6cb5b) Diff
aar 112 kB 113 kB +639 B (+0.6%)
apk (aggressive) 211 kB 212 kB +492 B (+0.2%)
apk (release) 4.59 MB 4.59 MB +740 B (+0.0%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/Qmc3Og9WC7.html

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java

...config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHttpClient.java

google-oss-bot · 2025-04-08T06:58:23Z

Startup Time Report ¹

Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS.

Notes

This report is for comparing the base commit (58b9da4) and the CI merge commit (2b6cb5b)
Please check below reports for each individual commit to find more details (Perfetto traces, histograms, detailed measurements)
- 58b9da4: https://storage.googleapis.com/firebase-sdk-metric-reports/H4CE5P9vXH/index.html
- 2b6cb5b: https://storage.googleapis.com/firebase-sdk-metric-reports/YEnH45UV8m/index.html

Startup Times

`fire-rc`

Device Statistics Distributions

oriole-32

Percentile	`58b9da4`	`2b6cb5b`	Diff	Significant (?)
p10	69.2 ±9 μs	350 ±368 μs	+281 μs (+406.0%)	MAYBE
p25	80.2 ±21 μs	364 ±376 μs	+284 μs (+353.4%)	MAYBE
p50	97.9 ±24 μs	394 ±391 μs	+296 μs (+302.3%)	MAYBE
p75	125 ±32 μs	459 ±422 μs	+333 μs (+266.2%)	NO
p90	188 ±43 μs	593 ±530 μs	+405 μs (+215.0%)	NO

20 test runs in comparison

Commit	Test Runs
`58b9da4`	2025-04-09_15:36:07.306830_Qqzs 2025-04-09_15:36:07.306869_CaiJ 2025-04-09_15:36:07.306879_KHBY 2025-04-09_15:36:07.306888_uxgf 2025-04-09_15:36:07.306895_vlYG 2025-04-09_15:36:07.306901_lrMv 2025-04-09_15:36:07.306908_Jrnt 2025-04-09_15:36:07.306914_OqXO 2025-04-09_15:36:07.306920_mPdN 2025-04-09_15:36:07.306927_Lsdh
`2b6cb5b`	2025-04-09_16:06:07.568298_eqBw 2025-04-09_16:06:07.568336_Xjll 2025-04-09_16:06:07.568346_eNrM 2025-04-09_16:06:07.568354_xyUn 2025-04-09_16:06:07.568362_rlSf 2025-04-09_16:06:07.568369_AWdl 2025-04-09_16:06:07.568375_xIvI 2025-04-09_16:06:07.568382_lqiN 2025-04-09_16:06:07.568388_LSFO 2025-04-09_16:06:07.568395_eNel

redfin-30

Percentile	`58b9da4`	`2b6cb5b`	Diff	Significant (?)
p10	402 ±455 μs	253 ±220 μs	-149 μs (-37.1%)	NO
p25	468 ±523 μs	286 ±262 μs	-182 μs (-38.9%)	NO
p50	592 ±685 μs	371 ±393 μs	-221 μs (-37.3%)	NO
p75	800 ±859 μs	506 ±558 μs	-294 μs (-36.7%)	NO
p90	1.18 ±1 ms	803 ±866 μs	-382 μs (-32.2%)	NO

20 test runs in comparison

Commit	Test Runs
`58b9da4`	2025-04-09_15:36:07.306830_Qqzs 2025-04-09_15:36:07.306869_CaiJ 2025-04-09_15:36:07.306879_KHBY 2025-04-09_15:36:07.306888_uxgf 2025-04-09_15:36:07.306895_vlYG 2025-04-09_15:36:07.306901_lrMv 2025-04-09_15:36:07.306908_Jrnt 2025-04-09_15:36:07.306914_OqXO 2025-04-09_15:36:07.306920_mPdN 2025-04-09_15:36:07.306927_Lsdh
`2b6cb5b`	2025-04-09_16:06:07.568298_eqBw 2025-04-09_16:06:07.568336_Xjll 2025-04-09_16:06:07.568346_eNrM 2025-04-09_16:06:07.568354_xyUn 2025-04-09_16:06:07.568362_rlSf 2025-04-09_16:06:07.568369_AWdl 2025-04-09_16:06:07.568375_xIvI 2025-04-09_16:06:07.568382_lqiN 2025-04-09_16:06:07.568388_LSFO 2025-04-09_16:06:07.568395_eNel

`timeToInitialDisplay`

Device Statistics Distributions

oriole-32

Percentile	`58b9da4`	`2b6cb5b`	Diff	Significant (?)
p10	199 ±5 ms	200 ±3 ms	+634 μs (+0.3%)	NO
p25	204 ±4 ms	206 ±3 ms	+1.46 ms (+0.7%)	NO
p50	211 ±5 ms	213 ±3 ms	+2.04 ms (+1.0%)	NO
p75	219 ±6 ms	221 ±4 ms	+2.13 ms (+1.0%)	NO
p90	227 ±7 ms	231 ±7 ms	+3.61 ms (+1.6%)	NO

20 test runs in comparison

Commit	Test Runs
`58b9da4`	2025-04-09_15:36:07.306830_Qqzs 2025-04-09_15:36:07.306869_CaiJ 2025-04-09_15:36:07.306879_KHBY 2025-04-09_15:36:07.306888_uxgf 2025-04-09_15:36:07.306895_vlYG 2025-04-09_15:36:07.306901_lrMv 2025-04-09_15:36:07.306908_Jrnt 2025-04-09_15:36:07.306914_OqXO 2025-04-09_15:36:07.306920_mPdN 2025-04-09_15:36:07.306927_Lsdh
`2b6cb5b`	2025-04-09_16:06:07.568298_eqBw 2025-04-09_16:06:07.568336_Xjll 2025-04-09_16:06:07.568346_eNrM 2025-04-09_16:06:07.568354_xyUn 2025-04-09_16:06:07.568362_rlSf 2025-04-09_16:06:07.568369_AWdl 2025-04-09_16:06:07.568375_xIvI 2025-04-09_16:06:07.568382_lqiN 2025-04-09_16:06:07.568388_LSFO 2025-04-09_16:06:07.568395_eNel

redfin-30

Percentile	`58b9da4`	`2b6cb5b`	Diff	Significant (?)
p10	226 ±6 ms	245 ±4 ms	+19.4 ms (+8.6%)	MAYBE
p25	233 ±5 ms	252 ±4 ms	+19.4 ms (+8.4%)	MAYBE
p50	240 ±6 ms	260 ±4 ms	+19.5 ms (+8.1%)	MAYBE
p75	250 ±6 ms	270 ±6 ms	+20.5 ms (+8.2%)	MAYBE
p90	260 ±7 ms	287 ±14 ms	+26.4 ms (+10.1%)	NO

20 test runs in comparison

Commit	Test Runs
`58b9da4`	2025-04-09_15:36:07.306830_Qqzs 2025-04-09_15:36:07.306869_CaiJ 2025-04-09_15:36:07.306879_KHBY 2025-04-09_15:36:07.306888_uxgf 2025-04-09_15:36:07.306895_vlYG 2025-04-09_15:36:07.306901_lrMv 2025-04-09_15:36:07.306908_Jrnt 2025-04-09_15:36:07.306914_OqXO 2025-04-09_15:36:07.306920_mPdN 2025-04-09_15:36:07.306927_Lsdh
`2b6cb5b`	2025-04-09_16:06:07.568298_eqBw 2025-04-09_16:06:07.568336_Xjll 2025-04-09_16:06:07.568346_eNrM 2025-04-09_16:06:07.568354_xyUn 2025-04-09_16:06:07.568362_rlSf 2025-04-09_16:06:07.568369_AWdl 2025-04-09_16:06:07.568375_xIvI 2025-04-09_16:06:07.568382_lqiN 2025-04-09_16:06:07.568388_LSFO 2025-04-09_16:06:07.568395_eNel

https://storage.googleapis.com/firebase-sdk-metric-reports/x0QowTQdpE/index.html

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

ashish-kothari

LGTM, minor feedback on a code comment.

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java

...config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHttpClient.java

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java

tusharkhandelwal8 added 2 commits March 28, 2025 13:05

Disconnect from Remote Config real-time server when app is backgrounded.

ad97ea0

Add changelog entry for closing real-time background connections.

7329989

google-oss-bot added the do-not-merge/work-in-progress label Mar 28, 2025

google-oss-bot added the size/L label Mar 28, 2025

Merge branch 'refs/heads/main' into realtime-background-connections-fix

65c3492

tusharkhandelwal8 requested a review from dsjadaun-google April 1, 2025 11:44

dsjadaun-google reviewed Apr 7, 2025

View reviewed changes

tusharkhandelwal8 added 2 commits April 8, 2025 11:42

Minor refactoring and renaming changes.

d30f896

Merge branch 'refs/heads/main' into realtime-background-connections-fix

2776833

ashish-kothari reviewed Apr 8, 2025

View reviewed changes

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java Outdated Show resolved Hide resolved

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java Show resolved Hide resolved

tusharkhandelwal8 added 3 commits April 9, 2025 13:47

Add more tests and update comment.

2e5fd40

Update test to remove spy.

d5c95bb

Merge branch 'refs/heads/main' into realtime-background-connections-fix

6966468

tusharkhandelwal8 marked this pull request as ready for review April 9, 2025 08:29

google-oss-bot removed the do-not-merge/work-in-progress label Apr 9, 2025

ashish-kothari approved these changes Apr 9, 2025

View reviewed changes

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java Show resolved Hide resolved

dsjadaun-google approved these changes Apr 9, 2025

View reviewed changes

tusharkhandelwal8 requested a review from VinayGuthal April 9, 2025 14:45

VinayGuthal reviewed Apr 9, 2025

View reviewed changes

...config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHttpClient.java Outdated Show resolved Hide resolved

VinayGuthal reviewed Apr 9, 2025

View reviewed changes

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java Outdated Show resolved Hide resolved

VinayGuthal reviewed Apr 9, 2025

View reviewed changes

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigAutoFetch.java Show resolved Hide resolved

tusharkhandelwal8 added 2 commits April 9, 2025 21:15

Close BufferedReader and use primitive boolean for isInBackground.

6dff041

Merge branch 'refs/heads/main' into realtime-background-connections-fix

3c879c7

VinayGuthal self-requested a review April 9, 2025 15:55

VinayGuthal approved these changes Apr 9, 2025

View reviewed changes

VinayGuthal merged commit 5081e7c into main Apr 9, 2025
37 of 38 checks passed

VinayGuthal deleted the realtime-background-connections-fix branch April 9, 2025 16:22

firebase locked and limited conversation to collaborators May 10, 2025

Disconnect from Remote Config real-time server when app is backgrounded. #6816

Disconnect from Remote Config real-time server when app is backgrounded. #6816

Uh oh!

Conversation

tusharkhandelwal8 commented Mar 28, 2025

Uh oh!

github-actions bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 PRs merging into main branch

Uh oh!

google-oss-bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report 1

Affected Products

firebase-config

Test Logs

Uh oh!

github-actions bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

google-oss-bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

firebase-config

Test Logs

Uh oh!

Uh oh!

Uh oh!

Uh oh!

google-oss-bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Startup Time Report 1

Notes

Startup Times

fire-rc

timeToInitialDisplay

Uh oh!

Uh oh!

Uh oh!

ashish-kothari left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions bot commented Mar 28, 2025 •

edited

Loading

google-oss-bot commented Mar 28, 2025 •

edited

Loading

Coverage Report ¹

`firebase-config`

github-actions bot commented Mar 28, 2025 •

edited

Loading

google-oss-bot commented Mar 28, 2025 •

edited

Loading

Size Report ¹

`firebase-config`

google-oss-bot commented Apr 8, 2025 •

edited

Loading

Startup Time Report ¹

`fire-rc`

`timeToInitialDisplay`