search

openfl / lime

A foundational Haxe framework for cross-platform development
https://lime.openfl.org/
MIT License
754 stars 370 forks source link

Expose more `ThreadPool` functionality through `Future.withEventualValue()`. #1828

Closed player-03 closed 1 month ago

player-03 commented 1 month ago

Previously, Future.withEventualValue() tried to match the Future constructor, with one subtle difference in behavior. It interpreted null to mean "run the function again," which causes an infinite loop if the programmer returns null without realizing. Joshua found a regression of this sort in Lime itself, one I should have caught but overlooked.

This PR changes the function signature to avoid any possibility of this error. There is no return value anymore, so you can't accidentally return the wrong value. Instead, as with ThreadPool, you are given a WorkOutput object and must call sendComplete() at some point. The work function has the same signature as in ThreadPool, so if users understand the one, they'll understand the other.

I have a couple other branches that are closer to how withEventualValue() used to work, and I can bring them back if requested. But withEventualValue() is new in 8.2.0, so it shouldn't hurt to change its signature.

player-03 commented 1 month ago

Perhaps we should do this through Promise instead.