Skip to content
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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Allow referencing a TimeoutCancellation #421

Open
wants to merge 3 commits into
base: 3.x
Choose a base branch
from
Open

Allow referencing a TimeoutCancellation #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6bf4c5
Allow referencing a TimeoutCancellation
danog Jul 25, 2023
ee6e57f
Fix
danog Aug 7, 2023
f9d9f70
fix
danog Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/TimeoutCancellation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@
private readonly Cancellation $cancellation;

/**
* @param float $timeout Seconds until cancellation is requested.
* @param string $message Message for TimeoutException. Default is "Operation timed out".
* @param float $timeout Seconds until cancellation is requested.
* @param string $message Message for TimeoutException. Default is "Operation timed out".
* @param bool $reference Whether to reference the timer.
*/
public function __construct(float $timeout, string $message = "Operation timed out")
public function __construct(float $timeout, string $message = "Operation timed out", bool $reference = false)
{
$this->cancellation = $source = new Internal\Cancellable;

Expand All @@ -29,7 +30,7 @@

$this->watcher = EventLoop::delay($timeout, static function () use ($source, $message, $trace): void {
if ($trace) {
$message .= \sprintf("\r\n%s was created here: %s", self::class, Internal\formatStacktrace($trace));

Check failure on line 33 in src/TimeoutCancellation.php

View workflow job for this annotation

GitHub Actions / PHP 8.2

InvalidArgument 

src/TimeoutCancellation.php:33:108: InvalidArgument: Argument 1 of Amp\Internal\formatStacktrace expects list<array{args?: list<mixed>, class?: class-string, file: string, function: string, line: int, object?: object, type?: string}>, but non-empty-list<array{args?: list<mixed>, class?: class-string, file?: string, function: string, line?: int, object?: object, type?: string}> with additional array shape fields (file, line) was provided (see https://psalm.dev/004)
} else {
$message .= \sprintf(" (Enable assertions for a backtrace of the %s creation)", self::class);
}
Expand All @@ -37,7 +38,9 @@
$source->cancel(new TimeoutException($message));
});

EventLoop::unreference($this->watcher);
if (!$reference) {
EventLoop::unreference($this->watcher);
}
}

/**
Expand Down
17 changes: 17 additions & 0 deletions test/Cancellation/TimeoutCancellationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Amp\Cancellation;

use Amp\CancelledException;
use Amp\DeferredFuture;
use Amp\TestCase;
use Amp\TimeoutCancellation;
use Amp\TimeoutException;
Expand Down Expand Up @@ -42,4 +43,20 @@ public function testWatcherCancellation(): void
unset($cancellation);
self::assertSame($identifiers, EventLoop::getIdentifiers());
}

public function testWatcherUnreference(): void
{
$this->expectExceptionMessageMatches("/Event loop terminated without resuming the current suspension/");
$deferred = new DeferredFuture;
$cancellation = new TimeoutCancellation(0.001);
$deferred->getFuture()->await($cancellation);
}

public function testWatcherNoUnreference(): void
{
$this->expectException(CancelledException::class);
$cancellation = new TimeoutCancellation(0.001, reference: true);
$deferred = new DeferredFuture;
$deferred->getFuture()->await($cancellation);
}
}