Skip to content

feat: remove serveDirectory() — use serveFromDisk() for production #20

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
developersharif merged 1 commit into from
Apr 4, 2026
Merged

feat: remove serveDirectory() — use serveFromDisk() for production #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 0 additions & 100 deletions src/Widget/WebView.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ class WebView
private string $id;
private bool $debug;

/** @var resource|null PHP built-in server process for serveDirectory() */
private $serverProcess = null;
private ?int $serverPort = null;

/** @var array<string, callable> JS→PHP command handlers: name => callback(string $id, string $args) */
private array $commandHandlers = [];

Expand Down Expand Up @@ -86,74 +82,6 @@ public function setHtml(string $html): void
$this->process->sendCommand(['cmd' => 'set_html', 'html' => $html]);
}

/**
* Serve a directory via PHP's built-in web server and navigate to it.
*
* Ideal for loading production frontend builds (e.g., Vite's dist/ folder).
*
* @param string $path Path to the directory containing index.html
* @param int $port Port to use (0 = auto-pick a free port)
*/
public function serveDirectory(string $path, int $port = 0): void
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Removing the public method serveDirectory() and its associated getter getServerPort() is a breaking change for the public API. More importantly, this removal will cause fatal errors in the test suite, as tests/webview/FrontendServingTest.php (specifically the suite starting at line 469) still references both methods. Please ensure the tests are updated or removed to reflect the new API before merging.

{
$path = realpath($path);
if (!$path || !is_dir($path)) {
throw new \RuntimeException("Directory not found: {$path}");
}
if (!file_exists($path . '/index.html')) {
throw new \RuntimeException("No index.html found in: {$path}");
}

// Auto-pick a free port
if ($port === 0) {
$sock = @stream_socket_server('tcp://127.0.0.1:0', $errno, $errstr);
if (!$sock) {
throw new \RuntimeException("Could not find a free port: {$errstr}");
}
$addr = stream_socket_get_name($sock, false);
$port = (int) substr($addr, strrpos($addr, ':') + 1);
fclose($sock);
}

// Start PHP built-in server
$cmd = sprintf(
'%s -S 127.0.0.1:%d -t %s',
PHP_BINARY,
$port,
escapeshellarg($path)
);

$descriptors = [
0 => ['pipe', 'r'],
1 => ['pipe', 'w'],
2 => ['pipe', 'w'],
];

$this->serverProcess = proc_open($cmd, $descriptors, $pipes);
if (!is_resource($this->serverProcess)) {
throw new \RuntimeException("Failed to start local server on port {$port}");
}
$this->serverPort = $port;

// Close stdin, we don't need it
fclose($pipes[0]);
fclose($pipes[1]);
fclose($pipes[2]);

// Wait for server to be ready (up to 3 seconds)
$deadline = microtime(true) + 3.0;
while (microtime(true) < $deadline) {
$fp = @fsockopen('127.0.0.1', $port, $errno, $errstr, 0.1);
if ($fp) {
fclose($fp);
break;
}
usleep(50000); // 50ms
}

$this->navigate("http://127.0.0.1:{$port}");
}

/**
* Serve a directory directly via the native webview engine (no HTTP server).
*
Expand Down Expand Up @@ -310,14 +238,6 @@ public function enableFetchProxy(): void
JS);
}

/**
* Get the port of the local server started by serveDirectory().
*/
public function getServerPort(): ?int
{
return $this->serverPort;
}

/* ── Window ──────────────────────────────────────────────────────────── */

/**
Expand Down Expand Up @@ -425,7 +345,6 @@ public function emit(string $event, mixed $payload = null): void
*/
public function destroy(): void
{
$this->stopServer();
$this->process->close();
}

Expand Down Expand Up @@ -564,7 +483,6 @@ private function handleCommand(array $event): void

public function __destruct()
{
$this->stopServer();
if (!$this->isClosed()) {
$this->destroy();
}
Expand Down Expand Up @@ -653,22 +571,4 @@ private function streamRequest(string $url, string $method, array $headers, ?str
return [$status, $resHeaders, $resBody];
}

private function stopServer(): void
{
if ($this->serverProcess && is_resource($this->serverProcess)) {
$status = proc_get_status($this->serverProcess);
if ($status['running']) {
// Kill the server process tree
$pid = $status['pid'];
if (PHP_OS_FAMILY === 'Windows') {
exec("taskkill /F /T /PID {$pid} 2>NUL");
} else {
exec("kill {$pid} 2>/dev/null");
}
}
proc_close($this->serverProcess);
$this->serverProcess = null;
$this->serverPort = null;
}
}
}
Loading