Allow user to set the project dir #30651

tdutrion · 2019-03-22T18:19:19Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

Currently, the project directory is defined by the location of the composer.json file.

That file is not required in production, which therefore breaks the method getProjectDir (who sends back null).
The offered solution, while working, requires the developer to implement it, and uses inheritance override, while a more aesthetic solution could be used.

This does not fix the behaviour, but allows the developer to pass the project dir as a parameter.

While this solution does not include BC break or anything, it is important to notice that it includes
an optional parameter.

Object instantiation in the framework bundle recipe could be updated as follow (in another PR):

$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);

$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG'], dirname(__DIR__));

src/Symfony/Component/HttpKernel/Kernel.php

Currently, the project directory is defined by the location of the composer.json file. That file is not required in production, which therefore breaks the method getProjectDir (who sends back null). This does not fix the behaviour, but allows the developer to pass the project dir as a parameter.

fabpot · 2019-03-23T15:01:49Z

Thank you @tdutrion.

fabpot · 2019-03-23T15:02:09Z

@tdutrion Can you submit a PR for the recipe?

This PR was merged into the 4.3-dev branch. Discussion ---------- Allow user to set the project dir | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes  | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR |  Currently, the project directory is defined by the location of the composer.json file. That file is not required in production, which therefore [breaks the method getProjectDir](#23950) (who sends back null). The offered solution, while working, requires the developer to implement it, and uses inheritance override, while a more aesthetic solution could be used. This does not fix the behaviour, but allows the developer to pass the project dir as a parameter. While this solution does not include BC break or anything, it is important to notice that it includes **an optional parameter**. [Object instantiation in the framework bundle recipe](https://github.com/symfony/recipes/blob/master/symfony/framework-bundle/4.2/public/index.php#L23) could be updated as follow (in another PR): ```php $kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']); ``` ```php $kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG'], dirname(__DIR__)); ``` Commits ------- c40017d Allow user to set the project dir

tdutrion · 2019-03-23T15:31:08Z

@tdutrion Can you submit a PR for the recipe?

Done in symfony/recipes#555

javiereguiluz · 2019-03-27T14:37:45Z

I'm working on the changes needed for this in the docs ... and I wondered why do we need all this logic to calculate the project dir:

symfony/src/Symfony/Component/HttpKernel/Kernel.php

Lines 343 to 358 in 71c33c1

    
           public function getProjectDir() 
        
           { 
        
               if (null === $this->projectDir) { 
        
                   $r = new \ReflectionObject($this); 
        
                   $dir = $rootDir = \dirname($r->getFileName()); 
        
                   while (!file_exists($dir.'/composer.json')) { 
        
                       if ($dir === \dirname($dir)) { 
        
                           return $this->projectDir = $rootDir; 
        
                       } 
        
                       $dir = \dirname($dir); 
        
                   } 
        
                   $this->projectDir = $dir; 
        
               } 
        
               return $this->projectDir; 
        
           }

Do you consider making the string $projectDir argument mandatory in the constructor so we can remove this? Or is this logic still needed for some reason? Thanks.

tdutrion · 2019-03-27T14:44:05Z

While I'd love to have it mandatory, it seems to me that it would be a breaking change, so that would need to wait for a major version (let me know if I'm wrong there).

stof · 2019-03-27T14:51:35Z

Well, the drawback of relying on a constructor argument is that it means that each place instantiating the kernel has to know which value to pass it.
Updating your front controller and your console already means updating 2 places (for which not passing the same absolute path would cause really weird things to happen). But there are other places instantiating it:

tests extending KernelTestCase or one of its child classes
Behat's Symfony extension also instantiate the kernel
maybe other places in other ecosystems

Requiring all these places to provide a configuration setting for which you need to pass the same project root looks like a bad experience to me.
That's precisely the reason why we introduced getProjectDir with a sensible implementation for most projects (the only projects breaking it are the one where you delete the composer.json before deployment), documenting that the supported extension point for people needing a different logic there is to define the method in their Kernel.

To me, a constructor argument here is actually a much worse DX than overriding the method.

stof · 2019-03-27T14:53:21Z

What we could do though is to throw an exception when the composer.json could not be found (asking to override the method or to keep the file) instead of returning a broken root dir, to improve DX.

javiereguiluz · 2019-03-27T14:55:51Z

throw an exception when the composer.json could not be found (asking to override the method or to keep the file)

This is nice ... because it solves the problem without forcing the user to look for or read any docs. Just read the great exception message, make the changes, and you're done!

fabpot · 2019-03-29T16:13:18Z

Reading the discussion here, I'm wondering if you should revert this change.

nicolas-grekas · 2019-03-29T16:26:18Z

Makes sense. Let's revert.

tdutrion · 2019-03-29T16:28:36Z

Don't forget symfony/recipes#555 if you revert

jvasseur · 2019-03-29T16:33:31Z

One solution (the one I use in my projects) is instead to override the getProjectDir method in src/Kernel.php to return dirname(__DIR__). Maybe this could be added to the recipe ?

tdutrion · 2019-03-29T16:38:59Z

While this solution work, it's not as decent from a software engineering point of view, as it's again hiding the setting somewhere rather than forcing the developer who calls it to think where it's root his.

Works for most symfony standard setup though, could be tricky if people do change the setup without understanding fully how things work.

jvasseur · 2019-03-29T16:42:35Z

While this solution work, it's not as decent from a software engineering point of view, as it's again hiding the setting somewhere rather than forcing the developer who calls it to think where it's root his.

Well it feels more logical to me to put it in the Kernel.php file since it's the file responsible for managing your project structure (cache, logs, config).

Works for most symfony standard setup though, could be tricky if people do change the setup without understanding fully how things work.

It's true if you define it in the index.php or console file to.

fabpot · 2019-03-29T17:00:18Z

reverted

This reverts commit aa12dd0, reversing changes made to 7d01aae.

…rion)"

carsonbot added Status: Needs Review Feature labels Mar 22, 2019

nicolas-grekas reviewed Mar 22, 2019

View reviewed changes

src/Symfony/Component/HttpKernel/Kernel.php Outdated Show resolved Hide resolved

carsonbot removed the Status: Needs Review label Mar 22, 2019

nicolas-grekas approved these changes Mar 22, 2019

View reviewed changes

carsonbot added the Status: Reviewed label Mar 22, 2019

chalasr added the HttpKernel label Mar 23, 2019

chalasr added this to the next milestone Mar 23, 2019

chalasr approved these changes Mar 23, 2019

View reviewed changes

fabpot approved these changes Mar 23, 2019

View reviewed changes

fabpot merged commit c40017d into symfony:master Mar 23, 2019

tdutrion mentioned this pull request Mar 23, 2019

Add project path to app Kernel instanciation symfony/recipes#555

Merged

javiereguiluz mentioned this pull request Mar 27, 2019

Documented the new Kernel project_dir argument symfony/symfony-docs#11228

Closed

fabpot added a commit that referenced this pull request Mar 29, 2019

Revert "feature #30651 Allow user to set the project dir (tdutrion)"

2389d7c

This reverts commit aa12dd0, reversing changes made to 7d01aae.

alquerci added a commit to alquerci/symfony that referenced this pull request Mar 31, 2019

Revert "feature symfony#30651 Allow user to set the project dir (tdut…

8b39416

…rion)"

tdutrion mentioned this pull request Apr 3, 2019

Add project dir to framework bundle symfony/recipes#564

Merged

alquerci added a commit to alquerci/symfony that referenced this pull request Apr 10, 2019

Revert "feature symfony#30651 Allow user to set the project dir (tdut…

419688a

…rion)"

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow user to set the project dir #30651

Allow user to set the project dir #30651

tdutrion commented Mar 22, 2019

fabpot commented Mar 23, 2019

fabpot commented Mar 23, 2019

tdutrion commented Mar 23, 2019

javiereguiluz commented Mar 27, 2019

tdutrion commented Mar 27, 2019

stof commented Mar 27, 2019

stof commented Mar 27, 2019

javiereguiluz commented Mar 27, 2019

fabpot commented Mar 29, 2019

nicolas-grekas commented Mar 29, 2019

tdutrion commented Mar 29, 2019

jvasseur commented Mar 29, 2019

tdutrion commented Mar 29, 2019

jvasseur commented Mar 29, 2019

fabpot commented Mar 29, 2019

Allow user to set the project dir #30651

Allow user to set the project dir #30651

Conversation

tdutrion commented Mar 22, 2019

fabpot commented Mar 23, 2019

fabpot commented Mar 23, 2019

tdutrion commented Mar 23, 2019

javiereguiluz commented Mar 27, 2019

tdutrion commented Mar 27, 2019

stof commented Mar 27, 2019

stof commented Mar 27, 2019

javiereguiluz commented Mar 27, 2019

fabpot commented Mar 29, 2019

nicolas-grekas commented Mar 29, 2019

tdutrion commented Mar 29, 2019

jvasseur commented Mar 29, 2019

tdutrion commented Mar 29, 2019

jvasseur commented Mar 29, 2019

fabpot commented Mar 29, 2019