Skip to content

Improve memory consumption by using static progress callback without binding to promise #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 25 additions & 14 deletions src/Promise.php
Original file line number Diff line number Diff line change
Expand Up @@ -164,17 +164,6 @@ private function reject($reason = null)
$this->settle(reject($reason));
}

private function notify($update = null)
{
if (null !== $this->result) {
return;
}

foreach ($this->progressHandlers as $handler) {
$handler($update);
}
}

private function settle(ExtendedPromiseInterface $promise)
{
$promise = $this->unwrap($promise);
Expand Down Expand Up @@ -246,9 +235,7 @@ function ($value = null) {
function ($reason = null) {
$this->reject($reason);
},
function ($update = null) {
$this->notify($update);
}
self::notifier($this->progressHandlers)
);
}
} catch (\Throwable $e) {
Expand All @@ -257,4 +244,28 @@ function ($update = null) {
$this->reject($e);
}
}

/**
* Creates a static progress callback that is not bound to a promise instance.
*
* Moving the closure creation to a static method allows us to create a
* callback that is not bound to a promise instance. By passing its progress
* handlers by reference, we can still execute them when requested and still
* clear this reference when settling the promise. This helps avoiding
* garbage cycles if any callback creates an Exception.
*
* These assumptions are covered by the test suite, so if you ever feel like
* refactoring this, go ahead, any alternative suggestions are welcome!
*
* @param array $progressHandlers
* @return callable
*/
private static function notifier(&$progressHandlers)
{
return function ($update = null) use (&$progressHandlers) {
foreach ($progressHandlers as $handler) {
$handler($update);
}
};
}
}
33 changes: 33 additions & 0 deletions tests/PromiseTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,39 @@ public function shouldRejectWithoutCreatingGarbageCyclesIfResolverThrowsExceptio
$this->assertSame(0, gc_collect_cycles());
}

/**
* test that checks number of garbage cycles after throwing from a resolver
* that has its arguments explicitly set to null (reassigned arguments only
* show up in the stack trace in PHP 7, so we can't test this on legacy PHP)
*
* @test
* @requires PHP 7
* @link https://3v4l.org/OiDr4
*/
public function shouldRejectWithoutCreatingGarbageCyclesIfResolverThrowsExceptionWithResolveAndRejectUnset()
{
gc_collect_cycles();
$promise = new Promise(function ($resolve, $reject) {
$resolve = $reject = null;
throw new \Exception('foo');
});
unset($promise);

$this->assertSame(0, gc_collect_cycles());
}

/** @test */
public function shouldIgnoreNotifyAfterReject()
{
$promise = new Promise(function () { }, function ($resolve, $reject, $notify) {
$reject(new \Exception('foo'));
$notify(42);
});

$promise->then(null, null, $this->expectCallableNever());
$promise->cancel();
}

/** @test */
public function shouldFulfillIfFullfilledWithSimplePromise()
{
Expand Down