Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[WebServerBundle] Change the default pidfile location to cache directory #31280

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 1 commit into from
Apr 29, 2019
Merged

[WebServerBundle] Change the default pidfile location to cache directory #31280

Show file tree
Hide file tree
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
6 changes: 4 additions & 2 deletions src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ class ServerRunCommand extends Command
{
private $documentRoot;
private $environment;
private $pidFileDirectory;

protected static $defaultName = 'server:run';

public function __construct(string $documentRoot = null, string $environment = null)
public function __construct(string $documentRoot = null, string $environment = null, string $pidFileDirectory = null)
{
$this->documentRoot = $documentRoot;
$this->environment = $environment;
$this->pidFileDirectory = $pidFileDirectory;

parent::__construct();
}
Expand Down Expand Up @@ -129,7 +131,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
}

try {
$server = new WebServer();
$server = new WebServer($this->pidFileDirectory);
$config = new WebServerConfig($documentRoot, $env, $input->getArgument('addressport'), $input->getOption('router'));

$message = sprintf('Server listening on http://%s', $config->getAddress());
Expand Down
6 changes: 4 additions & 2 deletions src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ class ServerStartCommand extends Command
{
private $documentRoot;
private $environment;
private $pidFileDirectory;

protected static $defaultName = 'server:start';

public function __construct(string $documentRoot = null, string $environment = null)
public function __construct(string $documentRoot = null, string $environment = null, string $pidFileDirectory = null)
{
$this->documentRoot = $documentRoot;
$this->environment = $environment;
$this->pidFileDirectory = $pidFileDirectory;

parent::__construct();
}
Expand Down Expand Up @@ -133,7 +135,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
$this->getApplication()->setDispatcher(new EventDispatcher());

try {
$server = new WebServer();
$server = new WebServer($this->pidFileDirectory);
if ($server->isRunning($input->getOption('pidfile'))) {
$io->error(sprintf('The web server has already been started. It is currently listening on http://%s. Please stop the web server before you try to start it again.', $server->getAddress($input->getOption('pidfile'))));

Expand Down
11 changes: 10 additions & 1 deletion src/Symfony/Bundle/WebServerBundle/Command/ServerStatusCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ class ServerStatusCommand extends Command
{
protected static $defaultName = 'server:status';

private $pidFileDirectory;

public function __construct(string $pidFileDirectory = null)
{
$this->pidFileDirectory = $pidFileDirectory;

parent::__construct();
}

/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -64,7 +73,7 @@ protected function configure()
protected function execute(InputInterface $input, OutputInterface $output)
{
$io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);
$server = new WebServer();
$server = new WebServer($this->pidFileDirectory);
if ($filter = $input->getOption('filter')) {
if ($server->isRunning($input->getOption('pidfile'))) {
list($host, $port) = explode(':', $address = $server->getAddress($input->getOption('pidfile')));
Expand Down
11 changes: 10 additions & 1 deletion src/Symfony/Bundle/WebServerBundle/Command/ServerStopCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ class ServerStopCommand extends Command
{
protected static $defaultName = 'server:stop';

private $pidFileDirectory;

public function __construct(string $pidFileDirectory = null)
{
$this->pidFileDirectory = $pidFileDirectory;

parent::__construct();
}

/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -55,7 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
$io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);

try {
$server = new WebServer();
$server = new WebServer($this->pidFileDirectory);
$server->stop($input->getOption('pidfile'));
$io->success('Stopped the web server.');
} catch (\Exception $e) {
Expand Down
18 changes: 18 additions & 0 deletions src/Symfony/Bundle/WebServerBundle/DependencyInjection/WebServerExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ public function load(array $configs, ContainerBuilder $container)
$container->getDefinition('web_server.command.server_run')->replaceArgument(0, $publicDirectory);
$container->getDefinition('web_server.command.server_start')->replaceArgument(0, $publicDirectory);

$pidFileDirectory = $this->getPidFileDirectory($container);
$container->getDefinition('web_server.command.server_run')->replaceArgument(2, $pidFileDirectory);
$container->getDefinition('web_server.command.server_start')->replaceArgument(2, $pidFileDirectory);
$container->getDefinition('web_server.command.server_stop')->replaceArgument(0, $pidFileDirectory);
$container->getDefinition('web_server.command.server_status')->replaceArgument(0, $pidFileDirectory);

if (!class_exists(ConsoleFormatter::class)) {
$container->removeDefinition('web_server.command.server_log');
}
Expand All @@ -54,4 +60,16 @@ private function getPublicDirectory(ContainerBuilder $container)

return $kernelProjectDir.'/'.$publicDir;
}

private function getPidFileDirectory(ContainerBuilder $container): string
{
$kernelCacheDir = $container->getParameter('kernel.cache_dir');
$environment = $container->getParameter('kernel.environment');

if (basename($kernelCacheDir) !== $environment) {
return $container->getParameter('kernel.project_dir');
}

return \dirname($container->getParameter('kernel.cache_dir'));
}
}
4 changes: 4 additions & 0 deletions src/Symfony/Bundle/WebServerBundle/Resources/config/webserver.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,24 @@
<service id="web_server.command.server_run" class="Symfony\Bundle\WebServerBundle\Command\ServerRunCommand">
<argument>%kernel.project_dir%/public</argument>
<argument>%kernel.environment%</argument>
<argument>%kernel.project_dir%/var/cache</argument>
<tag name="console.command" command="server:run" />
</service>

<service id="web_server.command.server_start" class="Symfony\Bundle\WebServerBundle\Command\ServerStartCommand">
<argument>%kernel.project_dir%/public</argument>
<argument>%kernel.environment%</argument>
<argument>%kernel.project_dir%/var/cache</argument>
<tag name="console.command" command="server:start" />
</service>

<service id="web_server.command.server_stop" class="Symfony\Bundle\WebServerBundle\Command\ServerStopCommand">
<argument>%kernel.project_dir%/var/cache</argument>
<tag name="console.command" command="server:stop" />
</service>

<service id="web_server.command.server_status" class="Symfony\Bundle\WebServerBundle\Command\ServerStatusCommand">
<argument>%kernel.project_dir%/var/cache</argument>
<tag name="console.command" command="server:status" />
</service>

Expand Down
20 changes: 20 additions & 0 deletions src/Symfony/Bundle/WebServerBundle/Tests/DependencyInjection/WebServerExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ public function testLoad()
{
$container = new ContainerBuilder();
$container->setParameter('kernel.project_dir', __DIR__);
$container->setParameter('kernel.cache_dir', __DIR__.'/var/cache/test');
$container->setParameter('kernel.environment', 'test');
(new WebServerExtension())->load([], $container);

$this->assertSame(
Expand All @@ -32,6 +34,24 @@ public function testLoad()
__DIR__.'/test',
$container->getDefinition('web_server.command.server_start')->getArgument(0)
);

$this->assertSame(
__DIR__.'/var/cache',
$container->getDefinition('web_server.command.server_run')->getArgument(2)
);
$this->assertSame(
__DIR__.'/var/cache',
$container->getDefinition('web_server.command.server_start')->getArgument(2)
);
$this->assertSame(
__DIR__.'/var/cache',
$container->getDefinition('web_server.command.server_stop')->getArgument(0)
);
$this->assertSame(
__DIR__.'/var/cache',
$container->getDefinition('web_server.command.server_status')->getArgument(0)
);

$this->assertTrue($container->hasDefinition('web_server.command.server_run'));
$this->assertTrue($container->hasDefinition('web_server.command.server_start'));
$this->assertTrue($container->hasDefinition('web_server.command.server_stop'));
Expand Down
9 changes: 8 additions & 1 deletion src/Symfony/Bundle/WebServerBundle/WebServer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ class WebServer
const STARTED = 0;
const STOPPED = 1;

private $pidFileDirectory;

public function __construct(string $pidFileDirectory = null)
{
$this->pidFileDirectory = $pidFileDirectory;
}

public function run(WebServerConfig $config, $disableOutput = true, callable $callback = null)
{
if ($this->isRunning()) {
Expand Down Expand Up @@ -166,6 +173,6 @@ private function createServerProcess(WebServerConfig $config)

private function getDefaultPidFile()
{
return getcwd().'/.web-server-pid';
return ($this->pidFileDirectory ?? getcwd()).'/.web-server-pid';
}
}