4 Ways to Speedup Your Symfony Development with PackageBuilder

Symplify 4 was released and with it also one package, that contains all the Symfony tweaks that Symplify packages use.

Throwable render? Test services without public violation? Load parameters with glob? We got you covered!

Here are 4 news that were added in Symplify 4 and that you can use in your application right away.

Just install it...

composer require symplify/package-builder

...and enjoy more than one of these 4 new features:

1. Console-Like -vvv-Aware Renders for Exceptions and Errors

  Check the PR #732

  Check the PR #720

If you use Symfony Console you are probably familiar with these errors and with -vvv to get full exception trace:

Also works with Error like ParseError. That is super handy, useful and universal.

But what if you need to use it standalone error reporting. e.g before console build?

$containerFactory = new ContainerFactory();
$container = $containerFactory->createFromConfig('config-not-found.yml');

$application = $container->get(Application::class);
$application->run();

Well, you could use SymfonyStyle:

use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Output\ConsoleOutput;

try {
    $containerFactory = new ContainerFactory();
    $containerFactory->createFromConfig('config-with-parse-error.yml');

    $application = $container->get(Application::class);
    $application->run();
} catch (Throwable $throwable) {
    (new SymfonyStyle(new ArgvInput(), new ConsoleOutput()))->error($throwable);
}

And that will get you rather chaotic report:

 [ERROR] Symfony\Component\Yaml\Exception\ParseException: Unable to parse at line 9 (near "@# global templates
         variables"). in /var/www/tomasvotruba.cz/vendor/symfony/yaml/Parser.php:415
         Stack trace:
         #0 /var/www/tomasvotruba.cz/vendor/symfony/yaml/Parser.php(454): Symfony\Component\Yaml\Parser->doParse(' @#
         global temp...', 768)
         #1 /var/www/tomasvotruba.cz/vendor/symfony/yaml/Parser.php(315): Symfony\Component\Yaml\Parser->parseBlock(8,
         '@# global templ...', 768)
         #2 /var/www/tomasvotruba.cz/vendor/symfony/yaml/Parser.php(95): Symfony\Component\Yaml\Parser->doParse(Array,
         768)
         #3 /var/www/tomasvotruba.cz/vendor/symfony/yaml/Parser.php(62):
         Symfony\Component\Yaml\Parser->parse('imports:\n    - ...', 768)
         #4 /var/www/tomasvotruba.cz/vendor/symfony/dependency-injection/Loader/YamlFileLoader.php(621):
         Symfony\Component\Yaml\Parser->parseFile('/var/www/tomasv...', 768)
         #5
         /var/www/tomasvotruba.cz/vendor/symplify/package-builder/src/Yaml/AbstractParameterMergingYamlFileLoader.php(52
         ): Symfony\Component\DependencyInjection\Loader\YamlFileLoader->loadFile('/var/www/tomasv...')
         #6 /var/www/tomasvotruba.cz/vendor/symfony/config/Loader/DelegatingLoader.php(40):
         Symplify\PackageBuilder\Yaml\AbstractParameterMergingYamlFileLoader->load('/var/www/tomasv...', NULL)
         #7 /var/www/tomasvotruba.cz/vendor/symplify/statie/src/DependencyInjection/StatieKernel.php(43):
         Symfony\Component\Config\Loader\DelegatingLoader->load('/var/www/tomasv...')
         #8 /var/www/tomasvotruba.cz/vendor/symfony/http-kernel/Kernel.php(614):
        ...

How to Get Nice Error Reports Even out of Console Application Scope?

Do you need this to work on your CLI app? Thanks to Ondra Machulda's motivation issues I came with decoupled Symfony\Console Application logic.

It's named Symplify\PackageBuilder\Console\ThrowableRenderer and use it like this:

use Symplify\PackageBuilder\Console\ThrowableRenderer;

try {
    $containerFactory = new ContainerFactory();
    $containerFactory->createFromConfig('config-not-found.yml');

    $application = $container->get(Application::class);
    $application->run();
} catch (Throwable $throwable) {
    (new ThrowableRenderer())->render($throwable);
}

And you'll get always nice errors for any Throwable :). Work anywhere right away and also respects -vvv option.


2. Drop Manual public: true for Every Service You Test

  Check the PR #680

If you need to test a service, this is the most common way to test it using DI:

final class ChangelogLinkerTest extends AbstractContainerAwareTestCase
{
    protected function setUp(): void
    {
        $this->changelogLinker = $this->container->get(ChangelogLinker::class);
    }

    // ...
}

But if you call it like this, you're informed that it must be public.

To make that happen, developers will take one of 2 paths. Both with high maintainability:

1. Public for Every Tested Class

services:
    SomeNamespace\:
        resource: '..'

    SomeNamespace\SomeClass:
        public: true

2. Custom Tests-only Configs

# services-tests.yml
services:
    SomeNamespace\SomeClass:
        public: true

Both these configs rely on your manual updates. That!s not a way to go - programming should be easy, fun and without any triggers in our heads.

How to Overcome This?

Just add Symplify\PackageBuilder\DependencyInjection\CompilerPass\PublicForTestsCompilerPass:

final class AppKernel extends Kernel
{
    // ...

    protected function build(ContainerBuilder $containerBuilder): void
    {
        $containerBuilder->addCompilerPass(new PublicForTestsCompilerPass());
    }
}

It detects PHPUnit run and adds public to each service, so you don't have to add it for every new service your set.

Setup & forget.


3. Autowire Singly-Implemented Interfaces

  Check the PR #645

Autowiring works great in combination with PSR-4 autoloading since Symfony 3.4. But what about 3-rd party services that have interfaces?

# app/config/services.yml
services:
    _defaults:
        autowire: true

    Symfony\Component\Console\Input\ArgvInput: ~
    Symfony\Component\Console\Output\ConsoleOutput: ~

If you use Symfony\Component\Console\Input\InputInterace, you'll get error of missing implementation.

To solve it you need to use an alias for every class that implements an interface:

# app/config/services.yml
services:
    _defaults:
        autowire: true

    Symfony\Component\Console\Input\ArgvInput: ~
    Symfony\Component\Console\Input\InputInterace:
        alias: Symfony\Component\Console\Input\ArgvInput

    Symfony\Component\Console\Output\ConsoleOutput: ~
    Symfony\Component\Console\Output\OutputInterace:
        alias: Symfony\Component\Console\Output\ConsoleOutput

This way, you're actually being punished for using clean code and separation of interfaces in your code, because using Symfony\Component\Console\Input\ArgvInput would be easier. But is it really necessary to break SOLID principles just to comply with Symfony behaviors? I don't think that framework should enforce bad design to your application.

How to fix this?

I got inspired by Register singly-implemented interfaces when doing PSR-4 discovery pull-request in Symfony and by Nette default behavior.

namespace App;

use Symfony\Component\HttpKernel\Kernel;
use Symplify\PackageBuilder\DependencyInjection\CompilerPass\AutowireSinglyImplementedCompilerPass;

final class AppKernel extends Kernel
{
    // ...
    protected function build(ContainerBuilder $containerBuilder): void
    {
        $containerBuilder->addCompilerPass(new AutowireSinglyImplementedCompilerPass());
    }
}

And then clean your configs the same way PSR-4 autodiscovery works:

 # app/config/services.yml
 services:
     _defaults:
         autowire: true

     Symfony\Component\Console\Input\ArgvInput: ~
-    Symfony\Component\Console\Input\InputInterace:
-        alias: Symfony\Component\Console\Input\ArgvInput

     Symfony\Component\Console\Output\ConsoleOutput: ~
-    Symfony\Component\Console\Output\OutputInterace:
-        alias: Symfony\Component\Console\Output\ConsoleOutput


4. How to Decouple Parameters to multiple files in Safe Way?

  Check the PR #745

Do you prefer to decouple long parameter list to multiple files and them with Glob?

# app/config/config.yml
imports:
    - { resource: 'framework/*.yml' }

In /framework directory there 2 files:

# app/config/framework/symfony.yml
parameters:
    framework:
        symfony:
            controller: '<?php "some Symfony code"'

and

# app/config/framework/laravel.yml
parameters:
    framework:
        laravel:
            controller: '<?php "some Laravel code"'

How many items will framework parameter have? 2? 1? 0?

One is correct. And which one? laravel or symfony? Well, according the YamlFileLoader, that last wins approach is used. So probably symfony... but it doesn't matter, because you need them all.

How to Prefer Merging of Parameters?

The official statement is to create Extension, Configuration, Bundle and merge class, which and then add a custom implementation of parameter binding and other Symfony parameters related features like composing of parameters, env variables and etc. I asked for this option to be allowed with no BC break in the issue, but it seems it's not needed enough.

Symplify actually followed the suggested approach and it was a lot of duplicated code from Symfony\DependencyInjection that barely worked.

To save many duplicated classes and take advantage of all Symfony parameter features you could overload YamlFileLoader, where parameters are merged together:

# app/config/framework/symfony.yml
parameters:
    framework:
        symfony:
            controller: '<?php "some Symfony code"'
        laravel:
            controller: '<?php "some Laravel code"'

Do you need this? Just use Symplify\PackageBuilder\Yaml\AbstractParameterMergingYamlFileLoader in your Kernel class:

use Symfony\Component\Config\Loader\DelegatingLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Kernel;

final class AppKernel extends Kernel
{
    // ...

    /**
     * @param ContainerInterface|ContainerBuilder $container
     */
    protected function getContainerLoader(ContainerInterface $container): DelegatingLoader
    {
        $kernelFileLocator = new FileLocator($this);

        $loaderResolver = new LoaderResolver([
            new GlobFileLoader($container, $kernelFileLocator),
            new class($container, $kernelFileLocator) extends AbstractParameterMergingYamlFileLoader {
            },
        ]);

        return new DelegatingLoader($loaderResolver);
    }
}

The class is abstract, so you can modify it in any way you need.


Happy package building!


  Continue Learning


Typo? Fix it, please  and join 47 people who build this website

GitHub RSS @votrubaT Runs on Statie Hosted on GitHub Build by 48 people

Like what I write about? Hire me & we can work together