fix: cluster size of 0 leads to infinite loop #397
Conversation
fResult
force-pushed
the
fix/cluster-size-errors
branch
from
260b096 to
42ca8be
Compare
There was a problem hiding this comment.
Hey @fResult, good to see more contributions from you 👍
I'll get this merged after my review is addressed
src/array/cluster.ts
Outdated
| @@ -13,6 +15,14 @@ export function cluster<T, Size extends number = 2>( | |||
| array: readonly T[], | |||
| size: Size = 2 as Size, | |||
| ): Cluster<T, Size>[] { | |||
| if (size <= 0 || Number.isNaN(size)) { | |||
There was a problem hiding this comment.
The NaN check is unnecessary, since the loop will exit when size is NaN.
src/array/cluster.ts
Outdated
| throw new IllegalSizeError(`Size must be 1 or more, the size is ${size}`) | ||
| } | ||
|
|
||
| if (size === Number.POSITIVE_INFINITY) { |
There was a problem hiding this comment.
Same here. The loop will exit just fine when size is infinite.
src/array/cluster.ts
Outdated
| @@ -13,6 +15,14 @@ export function cluster<T, Size extends number = 2>( | |||
| array: readonly T[], | |||
| size: Size = 2 as Size, | |||
| ): Cluster<T, Size>[] { | |||
| if (size <= 0 || Number.isNaN(size)) { | |||
| throw new IllegalSizeError(`Size must be 1 or more, the size is ${size}`) | |||
There was a problem hiding this comment.
I think returning [] when size <= 0 would be better. It's more concise, makes logical sense, and works fine with the Cluster<T, Size>[] return type.
fResult
force-pushed
the
fix/cluster-size-errors
branch
from
42ca8be to
39ad3a1
Compare
|
Hi @aleclarson, I have already updated the code following your review. |
Benchmark Results
Performance regressions of 30% or more should be investigated, unless they were anticipated. Smaller regressions may be due to normal variability, as we don't use dedicated CI infrastructure. |
|
Appreciate the extra tests! Thanks @fResult |
|
A stable release To install: pnpm add [email protected]
|
Summary
Fixes infinite loop bug when cluster() size is 0.
I chose error throwing over returning an input array due to
Cluster<T, Size>type constraints.Additional test cases were added to verify handling of various edge cases, including negative and non-integer sizes.
Related issue, if any:
#392
For any code change,
Does this PR introduce a breaking change?
No
Bundle impact
src/array/cluster.tsFootnotes
Function size includes the
importdependencies of the function. ↩