Repository navigation
fix(observable): validate every chunk length eagerly - #32
Open
xperiandri wants to merge 1 commit into
Open
xperiandri wants to merge 1 commit into
xperiandri wants to merge 1 commit into
Conversation
R3 validates the window length of `Chunk(count)` when it is called, but not of the time-and-count overloads: a length of 0 made every element fail with `IndexOutOfRangeException` through `OnErrorResume`, and a negative one failed only at subscription with `OverflowException`. Where R3 does validate, it reports its message as the parameter name and leaves out the rejected value. `chunkBySize` and `chunkBy` now reject a non-positive length of `ChunkCount`, `ChunkTimeSpanCount` and `ChunkMillisecondsCount` when they are called, with an `ArgumentOutOfRangeException` that names the parameter and carries the rejected length. Both functions are no longer inline, because the shared check is private. Their XML docs are rewritten along with them: they document the `ArgumentOutOfRangeException` and the last chunk emitted on completion, and drop the `ArgumentNullException` tag. 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
The validation covers every count-bearing chunk configuration and reports the correct parameter and rejected value.
Review effort: Balanced
Findings: None
What changed in this PR
Adds eager validation for non-positive observable chunk lengths, preventing delayed R3 failures.
Changes:
- Adds shared validation for all count-based chunk configurations.
- Updates XML documentation and changelog entries.
| File | Description |
|---|---|
src/FSharp.Control.R3/Observable.fs |
Validates chunk lengths eagerly and documents behavior. |
CHANGELOG.md |
Records the validation fix. |
💡 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 #31 (
feat/chunk-by-boundaries), so it shows only its own change; merge #31 first.R3 validates the window length of
Chunk(count)when it is called, but not of the time-and-count overloads: a length of 0 made every element fail withIndexOutOfRangeExceptionthroughOnErrorResume, and a negative one failed only at subscription withOverflowException. Where R3 does validate, it reports its message as the parameter name and leaves out the rejected value.chunkBySizeandchunkBynow reject a non-positive length ofChunkCount,ChunkTimeSpanCountandChunkMillisecondsCountwhen they are called, with anArgumentOutOfRangeExceptionthat names the parameter and carries the rejected length. Both functions are no longer inline, because the shared check is private.Their XML docs are rewritten along with them: they document the
ArgumentOutOfRangeExceptionand the last chunk emitted on completion, and drop theArgumentNullExceptiontag.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
Tests (in #22): the rejects a non-positive ... when called, before subscribing tests of
ChunkTests.fs.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)!: defaultofTaskconfigureAwaittotruetoArrayandtoListinto theTask.Observablemodule #40 feat(task)!: movetoArrayandtoListinto theTask.Observablemodulebind,catchandmapAsync#42 docs: document the R3 1.3.1 limitations ofbind,catchandmapAsync🤖 Generated with Claude Code