Add custom signal limits link and fix Javadoc List Formatting #6722

tusharkhandelwal8 · 2025-02-25T19:02:10Z

Add link to documentation about custom signal limits (b/385028620) and Update setCustomSignals Javadoc List Formatting (b/390054823)

github-actions · 2025-02-25T19:02:24Z

Javadoc Changes:

--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html	2025-02-26 05:31:13.600445054 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html	2025-02-26 05:28:09.964231032 +0000
@@ -987,7 +987,7 @@
         <h3 class="api-name" id="setCustomSignals(com.google.firebase.remoteconfig.CustomSignals)">setCustomSignals</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>&gt;&nbsp;<a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#setCustomSignals(com.google.firebase.remoteconfig.CustomSignals)">setCustomSignals</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/CustomSignals.html">CustomSignals</a>&nbsp;customSignals)</pre>
         <p>Asynchronously changes the custom signals for this <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html">FirebaseRemoteConfig</a></code> instance. </p>
-        <p>Custom signals are subject to limits on the size of key/value pairs and the total number of signals. Any calls that exceed these limits will be discarded.</p>
+        <p>Custom signals are subject to limits on the size of key/value pairs and the total number of signals. Any calls that exceed these limits will be discarded. See <a href="https://firebase.google.com/docs/remote-config/parameters?template_type=client#custom-signal-limits">Custom Signal Limits</a>.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -1004,11 +1004,11 @@
                 <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/CustomSignals.html">CustomSignals</a>&nbsp;customSignals</code></td>
                 <td>
                   <p>The custom signals to set for this instance. </p>
-                  <ol>
+                  <ul>
                     <li>New keys will add new key-value pairs in the custom signals. </li>
                     <li>Existing keys with new values will update the corresponding signals. </li>
                     <li>Setting a key's value to <code>null</code> will remove the associated signal. </li>
-                  </ol>
+                  </ul>
                 </td>
               </tr>
             </tbody>

--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html	2025-02-26 05:31:13.595445048 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html	2025-02-26 05:28:09.947231008 +0000
@@ -1004,7 +1004,7 @@
         <h3 class="api-name" id="setCustomSignals(com.google.firebase.remoteconfig.CustomSignals)">setCustomSignals</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#setCustomSignals(com.google.firebase.remoteconfig.CustomSignals)">setCustomSignals</a>(customSignals:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/CustomSignals.html">CustomSignals</a>):&nbsp;<a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>!&gt;</pre>
         <p>Asynchronously changes the custom signals for this <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html">FirebaseRemoteConfig</a></code> instance. </p>
-        <p>Custom signals are subject to limits on the size of key/value pairs and the total number of signals. Any calls that exceed these limits will be discarded.</p>
+        <p>Custom signals are subject to limits on the size of key/value pairs and the total number of signals. Any calls that exceed these limits will be discarded. See <a href="https://firebase.google.com/docs/remote-config/parameters?template_type=client#custom-signal-limits">Custom Signal Limits</a>.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -1021,11 +1021,11 @@
                 <td><code>customSignals:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/CustomSignals.html">CustomSignals</a></code></td>
                 <td>
                   <p>The custom signals to set for this instance. </p>
-                  <ol>
+                  <ul>
                     <li>New keys will add new key-value pairs in the custom signals. </li>
                     <li>Existing keys with new values will update the corresponding signals. </li>
                     <li>Setting a key's value to <code>null</code> will remove the associated signal. </li>
-                  </ol>
+                  </ul>
                 </td>
               </tr>
             </tbody>

google-oss-bot · 2025-02-25T19:02:54Z

	1 Warning
⚠️	Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

google-oss-bot · 2025-02-25T19:06:49Z

Coverage Report ¹

Affected Products

No changes between base commit (1e8c218) and merge commit (f26d378).

Test Logs

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

github-actions · 2025-02-25T19:08:09Z

Test Results

42 files + 8 42 suites +8 1m 19s ⏱️ +20s
322 tests +134 322 ✅ +134 0 💤 ±0 0 ❌ ±0
656 runs +280 656 ✅ +280 0 💤 ±0 0 ❌ ±0

Results for commit 3f0ddc2. ± Comparison against base commit 1e8c218.

This pull request removes 188 and adds 322 tests. Note that renamed tests count towards both.

com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_emptyLocationHeader_setsDownloadFailure
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_isNotRedirectResponse_setsDownloadFailure
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_missingLocationHeader_setsDownloadFailure
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_onAppResume_setsUpdateCancelled
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_whenAabReleaseAvailable_redirectsToPlay
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateAppTask_whenOpenConnectionFails_setsNetworkFailure
com.google.firebase.appdistribution.impl.AabUpdaterTest ‑ updateApp_whenCalledMultipleTimesWithAAB_onlyMakesOneRequest
com.google.firebase.appdistribution.impl.ApkInstallerTests ‑ installActivityDestroyed_setsInstallError
com.google.firebase.appdistribution.impl.ApkInstallerTests ‑ installApk_currentActivityNotNull_InstallIntentOnCurrentActivity
com.google.firebase.appdistribution.impl.ApkInstallerTests ‑ whenCalledMultipleTimes_onlyEmitsOneIntent
…

com.google.firebase.remoteconfig.ConfigTests ‑ Custom Signals builder support multiple types
com.google.firebase.remoteconfig.ConfigTests ‑ Firebase#remoteConfig should delegate to FirebaseRemoteConfig#getInstance()
com.google.firebase.remoteconfig.ConfigTests ‑ Firebase#remoteConfig should delegate to FirebaseRemoteConfig#getInstance(FirebaseApp, region)
com.google.firebase.remoteconfig.ConfigTests ‑ FirebaseRemoteConfigSettings builder works
com.google.firebase.remoteconfig.ConfigTests ‑ Overloaded get() operator returns default value when key doesn't exist
com.google.firebase.remoteconfig.ConfigTests ‑ Overloaded get() operator returns value when key exists
com.google.firebase.remoteconfig.CustomSignalsTest ‑ testCustomSignals_builderPutDouble
com.google.firebase.remoteconfig.CustomSignalsTest ‑ testCustomSignals_builderPutDuplicateKeys
com.google.firebase.remoteconfig.CustomSignalsTest ‑ testCustomSignals_builderPutLong
com.google.firebase.remoteconfig.CustomSignalsTest ‑ testCustomSignals_builderPutMixedTypes
…

♻️ This comment has been updated with latest results.

google-oss-bot · 2025-02-25T19:12:01Z

Size Report ¹

Affected Products

firebase-config
Type Base (1e8c218) Merge (f26d378) Diff
aar 112 kB 112 kB -5 B (-0.0%)
apk (release) 4.59 MB 4.59 MB -4 B (-0.0%)

Test Logs

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

ashish-kothari

LGTM

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

Add custom signal limits link and fix Javadoc List Formatting

8e8790b

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

google-oss-bot added the size/XS label Feb 25, 2025

tusharkhandelwal8 and others added 2 commits February 26, 2025 01:14

Merge branch 'main' into updateFormatting

6d87ea6

Remove TODO to add documentation link.

eb44b5c

tusharkhandelwal8 marked this pull request as ready for review February 26, 2025 05:14

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

tusharkhandelwal8 requested a review from ashish-kothari February 26, 2025 05:14

ashish-kothari approved these changes Feb 26, 2025

View reviewed changes

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

Update statement for custom signal limits.

3f0ddc2

tusharkhandelwal8 requested a review from rlazo February 26, 2025 06:21

rlazo approved these changes Feb 26, 2025

View reviewed changes

rlazo merged commit c3308a3 into main Feb 26, 2025
39 checks passed

rlazo deleted the updateFormatting branch February 26, 2025 14:51

firebase locked and limited conversation to collaborators Mar 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add custom signal limits link and fix Javadoc List Formatting #6722

Add custom signal limits link and fix Javadoc List Formatting #6722

Uh oh!

tusharkhandelwal8 commented Feb 25, 2025

Uh oh!

github-actions bot commented Feb 25, 2025 •

edited

Loading

Uh oh!

google-oss-bot commented Feb 25, 2025

Uh oh!

google-oss-bot commented Feb 25, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Feb 25, 2025 •

edited

Loading

Uh oh!

google-oss-bot commented Feb 25, 2025 •

edited

Loading

`firebase-config`

Uh oh!

ashish-kothari left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add custom signal limits link and fix Javadoc List Formatting #6722

Add custom signal limits link and fix Javadoc List Formatting #6722

Uh oh!

Conversation

tusharkhandelwal8 commented Feb 25, 2025

Uh oh!

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

Uh oh!

Uh oh!

google-oss-bot commented Feb 25, 2025

Uh oh!

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

Uh oh!

Coverage Report 1

Affected Products

Test Logs

Uh oh!

github-actions bot commented Feb 25, 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 Feb 25, 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!

ashish-kothari left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 25, 2025 •

edited

Loading

google-oss-bot commented Feb 25, 2025 •

edited

Loading

Coverage Report ¹

github-actions bot commented Feb 25, 2025 •

edited

Loading

google-oss-bot commented Feb 25, 2025 •

edited

Loading

Size Report ¹

`firebase-config`