fix(task)!: default ofTask configureAwait to true - #39
Open
xperiandri wants to merge 1 commit into
Open
xperiandri wants to merge 1 commit into
xperiandri wants to merge 1 commit into
Conversation
Both `ofTask` overloads declared `[<Optional>] configureAwait` without a default value, so an omitted argument passed `false`, while R3's `FromAsync`, `ofAsync`, `ProcessingOptions.Default` and `ChunkConfiguration.AsyncWindow` all default to `true`. A UI handler subscribed through `ofTask` therefore ran off its synchronization context. The parameter now defaults to `true`, and both overloads are documented. BREAKING CHANGE: callers that omit `configureAwait` now resume on the captured synchronization context; pass `false` to keep the old behaviour. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 5, 2026
This was referenced Oct 5, 2026
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Both overloads consistently implement the intended default, preserve explicit overrides, and have matching documentation.
Review effort: Balanced
Findings: None
What changed in this PR
Aligns ofTask with R3 and ofAsync by enabling synchronization-context capture by default.
Changes:
- Sets
configureAwaittotruefor both overloads; explicitfalsepreserves previous behavior. - Documents factory behavior and records the breaking change.
| File | Description |
|---|---|
| src/FSharp.Control.R3/TaskObservable.fs | Updates both defaults and their XML documentation. |
| CHANGELOG.md | Records the breaking default change. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed Changes
Part of splitting #22 into small pull requests that can be reviewed one at a time. It is stacked on #38 (
fix/iter-async-guard), so it shows only its own change; merge #38 first.Both
ofTaskoverloads declared[<Optional>] configureAwaitwithout a default value, so an omitted argument passedfalse, while R3'sFromAsync,ofAsync,ProcessingOptions.DefaultandChunkConfiguration.AsyncWindowall default totrue. A UI handler subscribed throughofTasktherefore ran off its synchronization context. The parameter now defaults totrue, and both overloads are documented.Types of changes
What types of changes does your code introduce to FSharp.Control.R3?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
Breaking change: callers that omit
configureAwaitnow resume on the captured synchronization context; passfalseto keep the old behaviour.Tests (in #22):
TaskObservableTests.fs– ofTask resumes on the captured synchronization context when configureAwait is omitted, ... when configureAwait is true and ofTask does not resume on the captured synchronization context when configureAwait is false.Stack – every pull request is based on the one before it, so each shows only its own change. Merge them in this order:
AwaitOperationConfigurationcases withAwait#23 refactor!: prefixAwaitOperationConfigurationcases withAwaitmapAsyncoptions eagerly #24 fix: validate the concurrency limit ofmapAsyncoptions eagerlyyield/zerosynchronously to keep element order #25 fix(rxquery): emityield/zerosynchronously to keep element ordersumBywithUnchecked.defaultof#26 fix(rxquery)!: stop seedingsumBywithUnchecked.defaultofrxqueryWithto cancel the terminal query operators #27 feat(rxquery): addrxqueryWithto cancel the terminal query operatorsofSeqreachable asObservable.ofSeq#29 feat(observable)!: makeofSeqreachable asObservable.ofSeqObservable.choosetake avoptionchooser, addObservableOption#30 feat(observable)!: makeObservable.choosetake avoptionchooser, addObservableOptionchunkByBoundariesfor boundaries of any element type #31 feat(observable): addchunkByBoundariesfor boundaries of any element typecancellationTokenfromtoLookup#35 fix(async)!: remove the ignoredcancellationTokenfromtoLookupiterAsyncthroughForEachAsyncinstead ofCountAsync#37 fix: wait foriterAsyncthroughForEachAsyncinstead ofCountAsynciterAsyncreliably and never lose a failure of its action #38 fix: stopiterAsyncreliably and never lose a failure of its actionofTaskconfigureAwaittotrue#39 fix(task)!: defaultofTaskconfigureAwaittotrue← this pull requesttoArrayandtoListinto theTask.Observablemodule #40 feat(task)!: movetoArrayandtoListinto theTask.Observablemodulebind,catchandmapAsync#42 docs: document the R3 1.3.1 limitations ofbind,catchandmapAsync🤖 Generated with Claude Code