Skip to content

[0.1.x] spin: Ensure process termination on $callback() failure #71

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 19, 2023
Merged

[0.1.x] spin: Ensure process termination on $callback() failure #71

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
961ae03
Kill process if callback fails
manelgavalda Sep 15, 2023
68880b8
initialize pid outside try catch
manelgavalda Sep 15, 2023
9f7cb8c
Add reset terminal function to reset lines when callback is finished …
manelgavalda Sep 16, 2023
3e9142b
pid should not be undefined
manelgavalda Sep 16, 2023
c5a0bee
Update docblock to follow contribution guidelines
manelgavalda Sep 16, 2023
20306a8
Remove redundant comments
manelgavalda Sep 16, 2023
660b70d
Passing pid only if we have one
manelgavalda Sep 18, 2023
a1b2815
Restore terminal on static spin failure
jessarcher Sep 19, 2023
7f36b51
Make dynamic and static spin logic consistent
jessarcher Sep 19, 2023
612b9a7
Formatting
jessarcher Sep 19, 2023
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
44 changes: 27 additions & 17 deletions src/Spinner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ public function spin(Closure $callback): mixed
return $this->renderStatically($callback);
}

$this->hideCursor();

$originalAsync = pcntl_async_signals(true);

pcntl_signal(SIGINT, function () {
Expand All @@ -56,6 +54,7 @@ public function spin(Closure $callback): mixed
});

try {
$this->hideCursor();
$this->render();

$pid = pcntl_fork();
Expand All @@ -71,24 +70,33 @@ public function spin(Closure $callback): mixed
} else {
$result = $callback();

posix_kill($pid, SIGHUP);
pcntl_async_signals($originalAsync);
pcntl_signal(SIGINT, SIG_DFL);

$this->eraseRenderedLines();
$this->showCursor();
$this->resetTerminal($originalAsync, $pid);

return $result;
}
} catch (\Throwable $e) {
$this->showCursor();
pcntl_async_signals($originalAsync);
pcntl_signal(SIGINT, SIG_DFL);
$this->resetTerminal($originalAsync, $pid ?? null);

throw $e;
}
}

/**
* Reset the terminal.
*/
protected function resetTerminal(bool $originalAsync, ?int $pid): void
{
if ($pid) {
posix_kill($pid, SIGHUP);
}

pcntl_async_signals($originalAsync);
pcntl_signal(SIGINT, SIG_DFL);

$this->eraseRenderedLines();
$this->showCursor();
}

/**
* Render a static version of the spinner.
*
Expand All @@ -101,13 +109,15 @@ protected function renderStatically(Closure $callback): mixed
{
$this->static = true;

$this->hideCursor();
$this->render();

$result = $callback();
try {
$this->hideCursor();
$this->render();

$this->eraseRenderedLines();
$this->showCursor();
$result = $callback();
} finally {
$this->eraseRenderedLines();
$this->showCursor();
}

return $result;
}
Expand Down