-
Notifications
You must be signed in to change notification settings - Fork 584
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add custom signals support in Remote Config. #6539
Open
tusharkhandelwal8
wants to merge
5
commits into
main
Choose a base branch
from
remoteConfigCustomTargeting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5f75cc8
Rename ConfigMetadataClient to ConfigSharedPrefsClient (#6537)
tusharkhandelwal8 17cc491
Add custom signals support in Remote Config. (#6410)
tusharkhandelwal8 9fa2ac9
Update fetch to utilize latest custom signals (#6582)
tusharkhandelwal8 57587fd
Merge branch 'refs/heads/main' into remoteConfigCustomTargeting
tusharkhandelwal8 d13645c
Add documentation, update tests and improve code style.
tusharkhandelwal8 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
86 changes: 86 additions & 0 deletions
86
firebase-config/src/main/java/com/google/firebase/remoteconfig/CustomSignals.java
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // 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.google.firebase.remoteconfig; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * A container type to represent key/value pairs of heterogeneous types to be set as custom signals | ||
| * in {@link FirebaseRemoteConfig#setCustomSignals}. | ||
| */ | ||
| public class CustomSignals { | ||
rlazo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| final Map<String, String> customSignals; | ||
|
|
||
| /** Builder for constructing {@link CustomSignals} instances. */ | ||
| public static class Builder { | ||
tusharkhandelwal8 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private Map<String, String> customSignals = new HashMap<String, String>(); | ||
|
|
||
| /** | ||
| * Adds a custom signal with a value that can be a string or null to the builder. | ||
| * | ||
| * @param key The key for the custom signal. | ||
| * @param value The string value associated with the key. Can be null. | ||
| * @return This Builder instance to allow chaining of method calls. | ||
| */ | ||
| @NonNull | ||
| public Builder put(@NonNull String key, @Nullable String value) { | ||
| customSignals.put(key, value); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a custom signal with a long value to the builder. | ||
| * | ||
| * @param key The key for the custom signal. | ||
| * @param value The long value for the custom signal. | ||
| * @return This Builder instance to allow chaining of method calls. | ||
| */ | ||
| @NonNull | ||
| public Builder put(@NonNull String key, long value) { | ||
| customSignals.put(key, Long.toString(value)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a custom signal with a double value to the builder. | ||
| * | ||
| * @param key The key for the custom signal. | ||
| * @param value The double value for the custom signal. | ||
| * @return This Builder instance to allow chaining of method calls. | ||
| */ | ||
| @NonNull | ||
| public Builder put(@NonNull String key, double value) { | ||
| customSignals.put(key, Double.toString(value)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a {@link CustomSignals} instance with the added custom signals. | ||
| * | ||
| * @return The constructed {@link CustomSignals} instance. | ||
| */ | ||
| @NonNull | ||
| public CustomSignals build() { | ||
| return new CustomSignals(this); | ||
| } | ||
| } | ||
|
|
||
| CustomSignals(@NonNull Builder builder) { | ||
| this.customSignals = builder.customSignals; | ||
| } | ||
| } | ||
This file contains 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
This file contains 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.
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.
since we are already making changes here, it sounds like a good idea to revisit naming, is
frcadding any valuable meaning as part of the name? If not, I'd rather rename it to something more descriptive.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.
Thank you for the suggestion! The prefix frc here specifically refers for storing Remote Config related key-value pairs in shared preferences. It helps differentiate these preferences from other shared preferences. Do you have any other suggestions?