feat: State change notification for flags client #3025
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,25 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2016-Present Datadog, Inc. | ||
| */ | ||
|
|
||
| package com.datadog.android.flags | ||
|
|
||
| import com.datadog.android.flags.model.FlagsClientState | ||
|
|
||
| /** | ||
| * Listener interface for receiving state change notifications from a [FlagsClient]. | ||
| * | ||
| * Implementations of this interface can be registered with a [FlagsClient] to receive | ||
| * callbacks whenever the client's state changes. | ||
| */ | ||
| interface FlagsStateListener { | ||
| /** | ||
| * Called when the state of the [FlagsClient] changes. | ||
| * | ||
| * @param newState The new state of the client. If the state is [FlagsClientState.Error], | ||
| * the error details are contained within the state object itself. | ||
| */ | ||
| fun onStateChanged(newState: FlagsClientState) | ||
| } |
This file contains hidden or 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,61 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2016-Present Datadog, Inc. | ||
| */ | ||
|
|
||
| package com.datadog.android.flags | ||
|
|
||
| import com.datadog.android.flags.model.FlagsClientState | ||
|
|
||
| /** | ||
| * Observable interface for tracking [FlagsClient] state changes. | ||
| * | ||
| * This interface provides two ways to observe state: | ||
| * 1. **Synchronous getter**: [getCurrentState] for immediate state queries | ||
| * 2. **Callback pattern**: [addListener]/[removeListener] for reactive observers | ||
| * | ||
| * ## Usage Examples | ||
| * | ||
| * ```kotlin | ||
| * // Synchronous getter | ||
| * val current = client.state.getCurrentState() | ||
| * if (current is FlagsClientState.Ready) { | ||
| * // Proceed | ||
| * } | ||
| * | ||
| * // Callback pattern | ||
| * client.state.addListener(object : FlagsStateListener { | ||
| * override fun onStateChanged(newState: FlagsClientState) { | ||
| * // Handle state change | ||
| * } | ||
| * }) | ||
| * ``` | ||
| */ | ||
| interface StateObservable { | ||
| /** | ||
| * Returns the current state synchronously. | ||
| * | ||
| * This method is safe to call from any thread. | ||
| * | ||
| * @return The current [FlagsClientState]. | ||
| */ | ||
| fun getCurrentState(): FlagsClientState | ||
typotter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Registers a listener to receive state change notifications. | ||
| * | ||
| * The listener will immediately receive the current state upon registration, | ||
| * then be notified of all future state changes. | ||
| * | ||
| * @param listener The [FlagsStateListener] to register. | ||
| */ | ||
| fun addListener(listener: FlagsStateListener) | ||
typotter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Unregisters a previously registered state listener. | ||
| * | ||
| * @param listener The [FlagsStateListener] to unregister. | ||
| */ | ||
| fun removeListener(listener: FlagsStateListener) | ||
| } | ||
This file contains hidden or 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 coroutines are now removed from this module, this is not relevant
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.
fixed