Best way to override ServerRunCommand and ServerStartCommand? #20429

pocky · 2016-11-06T22:50:31Z

Hello,

I am using a non-standard folder structure and I just discovered a "problem" with server:run and server:start (for me it's a DX) :

        $documentRoot = $input->getOption('docroot');

        if (null === $documentRoot) {
            $documentRoot = $this->getContainer()->getParameter('kernel.root_dir').'/../web';
        }

For my distribution, the $documentRoot should be : $this->getContainer()->getParameter('kernel.root_dir').'/../../web'

I don't want to tell to each dev wich using my distribution to add the --docroot option (or using an alias via composer scripts/make) so I'm looking to the best way to change this.

Solutions :

1- ServerRunCommand and ServerStartCommand should be used as services to allow overriding
2- Add a getDocumentRoot option in Kernel and use the parameter instead of relative path (simpler)
3- Create a symfony/server-bundle with all related server commands as dependency of framework-bundle

What's your opinion?

The text was updated successfully, but these errors were encountered:

chalasr · 2016-11-07T09:39:40Z

@pocky Hello,

If you don't want to pass this option each time, here is a quick way to do it:

<?php

namespace AppBundle\Command;

use Symfony\Bundle\FrameworkBundle\Command\ServerRunCommand as BaseServerRunCommand;

class ServerRunCommand extends BaseServerRunCommand
{
    protected function configure()
    {
        parent::configure();

        $this->getDefinition()->getOption('docroot')->setDefault('your/custom/docroot');
    }
}

Like this, calling bin/console server:run use your custom docroot by default.

I may miss something but in my opinion having the docroot option should be enough for most use cases, I don't think it is worth making it configurable, AFAIK we never did such for any command in the past.

pocky · 2016-11-07T12:29:01Z

@chalasr Correct! ;)

But if I want to share my AppBundle with you (and your symfony-standard), this change will broke your server:run.

chalasr · 2016-11-16T21:40:09Z

But if I want to share my AppBundle with you (and your symfony-standard), this change will broke your server:run.

Since the need is quite specific to your structure, you could register the command as a service and have the command in a place that cannot be published/reused (e.g. in app/Command if your structure allows it), outside of any bundle.

chalasr · 2017-01-07T11:25:00Z

@pocky See #21190, it should help here

edit: In 3.3, you can e.g. decorate the service:

# app/config/services.yml
services:
    app.command.server_run:
        decorates: web_server.command.server_run
        arguments: ['%your_custom_docroot%', '%kernel.environment%']

…ntainer (chalasr) This PR was merged into the 3.3-dev branch. Discussion ---------- [WebServerBundle] Decouple server commands from the container | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20429 | License | MIT | Doc PR | maybe This removes the need for injecting the container in the new `server:*` commands, registering them as services when used in the framework and thus making them even more discoverable and extensible. It would then be easy to reconsider extracting them in a `WebServer` component instead of having a bundle only. IMHO it would make sense to use these commands outside of the framework. If the idea can be considered I'll add some tests at least ensuring that these commands are bootstrap-able. This must be done before that they are covered by the BC promise (3.3). Commits ------- 2e63025 [WebServerBundle] Decouple server:* commands from the container

javiereguiluz added Enhancement FrameworkBundle labels Nov 7, 2016

chalasr mentioned this issue Jan 7, 2017

[WebServerBundle] Decouple server commands from the container #21190

Merged

fabpot closed this as completed Jan 8, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Best way to override ServerRunCommand and ServerStartCommand? #20429

Best way to override ServerRunCommand and ServerStartCommand? #20429

pocky commented Nov 6, 2016 •

edited

Loading

chalasr commented Nov 7, 2016

pocky commented Nov 7, 2016

chalasr commented Nov 16, 2016

chalasr commented Jan 7, 2017 •

edited

Loading

Best way to override ServerRunCommand and ServerStartCommand? #20429

Best way to override ServerRunCommand and ServerStartCommand? #20429

Comments

pocky commented Nov 6, 2016 • edited Loading

chalasr commented Nov 7, 2016

pocky commented Nov 7, 2016

chalasr commented Nov 16, 2016

chalasr commented Jan 7, 2017 • edited Loading

pocky commented Nov 6, 2016 •

edited

Loading

chalasr commented Jan 7, 2017 •

edited

Loading