reactphp / async

Async utilities and fibers for ReactPHP.
https://reactphp.org/async/
MIT License
204 stars 19 forks source link

[3.x] Support iterable type for `parallel()` + `series()` + `waterfall()` #45

Closed clue closed 2 years ago

clue commented 2 years ago

This changeset adds support for the iterable type for parallel() + series() + waterfall(). Instead of only accepting an array, each function now also accepts instances implementing Traversable such as Iterator and Generator instances.

This is a pure feature addition that does not break BC. With these changes applied, our API is now in line with the other promise APIs (see https://github.com/reactphp/promise/pull/225).

This PR targets Async v3 as the minimum API version. If this gets merged, I'll file a follow-up PR to apply the same changes also for Async v4.

The first commit highlights how this is essentially only a new type definition and a call to iterator_to_array(). The second commit then takes advantage of a more iterative approach that uses less memory and also supports consuming infinite iterators if the resulting promise settles. The test suite confirms this has 100% code coverage.

Refs #41 Builds on top of #11 Refs https://twitter.com/another_clue/status/1535652835521613824 (UML of iterators in PHP)