This repository has been archived by the owner on Dec 4, 2024. It is now read-only.
feat: adds init async with timeout and deprecated non-timeout init functions #95
Conversation
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
… timeouts and functions taking in User instances.
tanderson-ld
commented
May 3, 2024
| @@ -349,7 +348,6 @@ public interface ILdClient : IDisposable | |||
| /// about setting the context and optionally requesting a unique key for it</param> | |||
| /// <returns>a task that yields true if new flag values were obtained</returns> | |||
| /// <seealso cref="Identify(Context, TimeSpan)"/> | |||
| /// <seealso cref="ILdClientExtensions.IdentifyAsync(ILdClient, User)"/> | |||
There was a problem hiding this comment.
For reviewers: User is deprecated
tanderson-ld
commented
May 3, 2024
| /// the LaunchDarkly service is returned, or immediately if offline, or when the the specified | ||
| /// wait time elapses. If the max wait time elapses, the returned instance will have | ||
| /// an <see cref="Initialized"/> property of <see langword="false"/>, but the instance will continue | ||
| /// trying to get fresh feature flags. |
There was a problem hiding this comment.
For reviewers: Documentation changes are just tidying up the contents and making each of the init docs more consistent with each other. They diverged in subtle ways over time.
tanderson-ld
commented
May 3, 2024
| /// <returns>a Task that resolves to the singleton LdClient instance</returns> | ||
| [Obsolete("Initializing the LDClient without a timeout is no longer permitted to help prevent" + | ||
| "consumers from blocking their application execution by mistake when connectivity is poor. Please" + | ||
| "use InitAsync(string, ConfigurationBuilder.AutoEnvAttributes, Context, TimeSpan) and specify a max wait time.")] |
There was a problem hiding this comment.
For reviewers: The diff engine makes this look like I added a method and deprecated it immediately. That is not the case, just the diff shifting things around.
cwaldren-ld
reviewed
May 3, 2024
cwaldren-ld
reviewed
May 3, 2024
| } | ||
|
|
||
| var startTask = _connectionManager.Start(); | ||
| var completedTask = await Task.WhenAny(startTask, Task.Delay(maxWaitTime)); |
There was a problem hiding this comment.
How does this != logic work? (just haven't seen it before with tasks)
There was a problem hiding this comment.
The whenAny returns the task that completed and if it isn't the start task then it must be the delay task.
cwaldren-ld
reviewed
May 3, 2024
cwaldren-ld
approved these changes
May 8, 2024
tanderson-ld
pushed a commit
that referenced
this pull request
May 8, 2024
🤖 I have created a release *beep* *boop* --- ## [5.2.0](5.1.0...5.2.0) (2024-05-08) ### Features * adds init async with timeout and deprecated non-timeout init functions ([#95](#95)) ([41e70f2](41e70f2)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Requirements
Related issues
242110