[Console] Added Application::reset() #32418

lyrixx · 2019-07-07T15:58:07Z

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

Symfony leaks a lot in CLI when using the EventDispatcher. I'm working on it.

But instead of fixing the root cause, it can be legit to go quick and to reset all services.
So IMHO, this services should be exposed, and always available

nicolas-grekas · 2019-07-08T05:56:02Z

I understand, but I'd prefer not if possible, as having a non-leaking core is very important to me. Providing workarounds could lessen the urge to fix and not really help in the long run.

nicolas-grekas · 2019-07-08T05:58:48Z

Would making Kernel implement ResetInterface be a cleaner alternative? (if we really need this hook)

…atcher' service (lyrixx) This PR was submitted for the 4.4 branch but it was merged into the 3.4 branch instead (closes #32421). Discussion ---------- [EventDispatcher] Add tag kernel.rest on 'debug.event_dispatcher' service | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | In CLI, Symfony leaks because it uses the TraceableEventDispatcher. Let's make this service resetable. This PR is related to #32418 --- Side note: Forcing user to use the `ServicesResetter` is IMHO bad for the DX. I prefer to have something that does not leak by default. More over, the TraceableEventDispatcher stores some informations for the profiler. But in CLI it does not make sens, since the tooling does not exist. I have already fixed such issue for monolog in #30339. I think we should do the same for the TraceableEventDispatcher. --- Note: When using #32418 + this PR and with the following code, it does not leak **at all** <details> <summary>code</summary> ```php <?php namespace App\Command; use Psr\Log\LoggerInterface; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; use Symfony\Component\EventDispatcher\Event; use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter; use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; class LeakCommand extends Command { protected static $defaultName = 'leak'; private $dispatcher; private $resetter; private $logger; public function __construct(EventDispatcherInterface $dispatcher, ServicesResetter $resetter, LoggerInterface $logger) { $this->dispatcher = $dispatcher; $this->resetter = $resetter; $this->logger = $logger; parent::__construct(); } protected function execute(InputInterface $input, OutputInterface $output) { $this->dispatcher->addListener(MyEvent::class, function ($e) { }); for ($i=0; $i < INF; $i++) { $output->writeln(memory_get_usage()); $this->dispatcher->dispatch(new MyEvent()); $this->logger->debug('some log'); // if ($i > 2000) { // meminfo_dump(fopen('/tmp/my_dump_file.json', 'w')); // die; // } usleep(100); $this->resetter->reset(); } } } class MyEvent {} ``` </detail> Commits ------- 5249eaf [EventDispatcher] Add tag kernel.rest on 'debug.event_dispatcher' service

lyrixx · 2019-07-08T07:49:06Z

I understand, but I'd prefer not if possible, as having a non-leaking core is very important to me. Providing workarounds could lessen the urge to fix and not really help in the long run.

I totally agree but there is two things here:

having a non leaking core is a must have (BTW, you need to see this comment?)
be able to reset the framework to a clean state. When you are working on a long running process, you need to reset everything at some point. For example when a new AMQP message comes, you want to empty Monolog's Buffer, to clear the doctrine's Unit Of Work, etc... Because yes, there are some services that leak by nature.

Both points are really wanted. We can already wire everything in Messenger to clear everything (If not done, I did not check). I already open an issue in swarrot about that too.

But I'm also writing 100% custom worker that does many things. I need to do that by hand too :)

Would making Kernel implement ResetInterface be a cleaner alternative? (if we really need this hook)

I hesitate between Two approaches. This PR and adding Command::reset(). But it's not possible anymore since commands are not 'container aware' anymore.

Adding Kernel::reset() is a very nice idea too! I will update update the PR.

lyrixx · 2019-07-08T08:23:15Z

Hmm, I updated the PR and I have a strange feeling. This means injecting the kernel. I think I never injected the kernel. It's a bit like injecting the Container to me. I'm not sure it's cleaner.

I hesitate between Two approaches. This PR and adding Command::reset(). But it's not possible anymore since commands are not 'container aware' anymore.

Actually this is possible: Command::getApplication()->getKernel()->reset() :)

So we have Many choices here:

Make ServicesResetter "public": autowire + always preset
Add Kernel::reset() and let people inject the kernel where needed
2 + expose Command::reset() to hide the fact you can inject the Kernel , and to make things smoother

WDYT? I would go for 1 or 3, not 2

nicolas-grekas · 2019-07-08T08:57:46Z

Add reset() on Application? Would make sense to me.

lyrixx · 2019-07-08T09:22:51Z

Here we go :)

src/Symfony/Component/HttpKernel/composer.json

src/Symfony/Component/HttpKernel/Kernel.php

src/Symfony/Bundle/FrameworkBundle/composer.json

src/Symfony/Bundle/FrameworkBundle/Console/Application.php

lyrixx · 2019-07-08T09:59:22Z

@nicolas-grekas Here we go 👍 I addressed your comments

nicolas-grekas

lean, nice :)

fabpot · 2019-07-08T10:09:40Z

Thank you @lyrixx.

This PR was merged into the 4.4 branch. Discussion ---------- [Console] Added Application::reset() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Symfony leaks a lot in CLI when using the EventDispatcher. I'm working on it. But instead of fixing the root cause, it can be legit to go quick and to reset all services. So IMHO, this services should be exposed, and always available Commits ------- 15ba579 [Console] Added Application::reset()

Tobion · 2019-07-11T04:13:36Z

src/Symfony/Component/Console/Application.php

+    /**
+     * {@inheritdoc}
+     */
+    public function reset()


what's the point of an empty reset method? why not implement reset only in the frameworkbundle application?

Command::getApplication() returns this very class according to the phpdoc.
With this, phpstan is happy

Please, please, please, stop with the phpstan mania. We don't care if phpstan is happy or not. This is just a tool.

Actually I did it to make @nicolas-grekas happy (see previouses comment) he is not a tools 😅😁

The reason @Tobion is that this method is now part of the semantics of the API exposed by the base Application class. It's a template method (from the template design pattern).

template pattern does not apply here. template pattern methods must either be abstract (to force subclasses to implement them) or function as helper method hooks (with can have an empty body). neither is the case here. it's just an empty method providing no functionality. but it's not that important to me.

carsonbot added Status: Needs Review FrameworkBundle Feature labels Jul 7, 2019

lyrixx changed the base branch from master to 4.4 July 7, 2019 15:58

lyrixx force-pushed the service-resetter branch from 821bf0b to 4697907 Compare July 7, 2019 15:59

lyrixx mentioned this pull request Jul 7, 2019

[EventDispatcher] Add tag kernel.rest on 'debug.event_dispatcher' service #32421

Merged

nicolas-grekas added this to the next milestone Jul 8, 2019

lyrixx force-pushed the service-resetter branch 2 times, most recently from 3d1a6fa to fa26c2d Compare July 8, 2019 09:22

lyrixx changed the title ~~[FrameworkBundle] Add support for autowiring ServicesResetter and make it always available~~ [HttpKernel+FrameworkBundle] Added Kernel::reset() and Console\Application::reset() Jul 8, 2019

nicolas-grekas reviewed Jul 8, 2019

View reviewed changes

src/Symfony/Component/HttpKernel/composer.json Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jul 8, 2019

View reviewed changes

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

nicolas-grekas reviewed Jul 8, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/composer.json Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jul 8, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Application.php Show resolved Hide resolved

lyrixx force-pushed the service-resetter branch from fa26c2d to e1afb01 Compare July 8, 2019 09:57

lyrixx changed the title ~~[HttpKernel+FrameworkBundle] Added Kernel::reset() and Console\Application::reset()~~ [Console] Added Application::reset() Jul 8, 2019

[Console] Added Application::reset()

15ba579

lyrixx force-pushed the service-resetter branch from e1afb01 to 15ba579 Compare July 8, 2019 09:58

nicolas-grekas approved these changes Jul 8, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jul 8, 2019

fabpot approved these changes Jul 8, 2019

View reviewed changes

fabpot merged commit 15ba579 into symfony:4.4 Jul 8, 2019

lyrixx deleted the service-resetter branch July 8, 2019 10:19

lyrixx mentioned this pull request Jul 8, 2019

Leverage ResetInterface swarrot/swarrot#193

Closed

Tobion reviewed Jul 11, 2019

View reviewed changes

nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019

This was referenced Nov 12, 2019

Release v4.4.0-BETA1 #34338

Merged

Release v5.0.0-BETA1 #34339

Merged

vudaltsov mentioned this pull request Jul 31, 2020

[Mailer] Prevent MessageLoggerListener from leaking in env=prod #37712

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Added Application::reset() #32418

[Console] Added Application::reset() #32418

lyrixx commented Jul 7, 2019

nicolas-grekas commented Jul 8, 2019

nicolas-grekas commented Jul 8, 2019

lyrixx commented Jul 8, 2019 •

edited

lyrixx commented Jul 8, 2019

nicolas-grekas commented Jul 8, 2019

lyrixx commented Jul 8, 2019

lyrixx commented Jul 8, 2019

nicolas-grekas left a comment

fabpot commented Jul 8, 2019

Tobion Jul 11, 2019

lyrixx Jul 11, 2019

fabpot Jul 11, 2019

lyrixx Jul 11, 2019

nicolas-grekas Jul 11, 2019

Tobion Jul 11, 2019 •

edited

[Console] Added Application::reset() #32418

[Console] Added Application::reset() #32418

Conversation

lyrixx commented Jul 7, 2019

nicolas-grekas commented Jul 8, 2019

nicolas-grekas commented Jul 8, 2019

lyrixx commented Jul 8, 2019 • edited

lyrixx commented Jul 8, 2019

nicolas-grekas commented Jul 8, 2019

lyrixx commented Jul 8, 2019

lyrixx commented Jul 8, 2019

nicolas-grekas left a comment

Choose a reason for hiding this comment

fabpot commented Jul 8, 2019

Tobion Jul 11, 2019

Choose a reason for hiding this comment

lyrixx Jul 11, 2019

Choose a reason for hiding this comment

fabpot Jul 11, 2019

Choose a reason for hiding this comment

lyrixx Jul 11, 2019

Choose a reason for hiding this comment

nicolas-grekas Jul 11, 2019

Choose a reason for hiding this comment

Tobion Jul 11, 2019 • edited

Choose a reason for hiding this comment

lyrixx commented Jul 8, 2019 •

edited

Tobion Jul 11, 2019 •

edited