[Proposal] A recipe for Symfony Flex

[covex-nn]

The main blocker for recipe is a db_driver parameter - it is required and it's possible values cannot be used without installing additional packages.

We could make that parameter optional with no_driver default value, like i suggested in FriendsOfSymfony/FOSUserBundle#2708. The main goal of a default value is to pass cache:clear stage without errors and to make a recipe valid.

With a new driver some services like sonata.media.manager.media must be created, because other services depend on them. I suggest to create a new classes for that services, that will throw exceptions on usage in runtime with instructions for a developer what to do next.

With a default db_driver we will have a recipe with default configuration for MediaBundle. This configuration will be extended by recipes for specific meta package, i.e. sonata-project/media-orm-pack or sonata-project/media-phpcr-pack. All such packages will require sonata-project/media-bundle and conflict with each other. Each pack recipe will contain only Entity, Document or PHPCR classes with annotations, that will be copied into src directory during installation. So, no new maker or easy-extends bundle will be required.

[kunicmarko20]

Can't we add configuration with db_driver: orm to the pack and then copy it from the pack?

[covex-nn]

MediaBundle does not require doctrine/doctrine-bundle, so db_driver: doctrine_orm will cause an error:

The service "sonata.media.serializer.handler.gallery" has a dependency on a non-existent service "doctrine"

[kunicmarko20]

Well, that part we could leave to dev? and we just give them a choice of 3 packs? cc @sonata-project/contributors does that sound valid?

[covex-nn]

A recipe for sonata-project/media-orm-pack will contain db_driver: doctrine_orm! Also sonata-project/media-orm-pack will require sonata-project/media-bundle, doctrine/doctrine-bundle and doctrine/orm. So, after sonata-project/media-orm-pack installation, MediaBundle will be fully functional

[kunicmarko20]

So a pack can require additional libs? Then that is it, we just create packs and we are done?

[jordisala1991]

IMO it is a great idea to just use packs

[covex-nn]

MediaBundle recipe could have it's default configuration:

sonata_media:
    default_context: default
    contexts:
        default:
            providers:
                - sonata.media.provider.youtube
                - sonata.media.provider.image
                - sonata.media.provider.file
                - sonata.media.provider.vimeo
            formats:
                small: { width: 100 , quality: 70}
                big:   { width: 500 , quality: 70}

    cdn:
        server:
            path: /upload/media

    filesystem:
        local:
            directory: "%kernel.project_dir%/public/upload/media"
            create: false

And then pack recipe will have only storage configuration (and Entity/Document/PHPCR classes):

sonata_media:
    class:
        media: App\Entity\SonataMediaMedia
        gallery: App\Entity\SonataMediaGallery
        gallery_has_media: App\Entity\SonataMediaGalleryHasMedia
    db_driver: doctrine_orm

[kunicmarko20]

That sounds good, but then if someone installs media without a pack, he would still get an error?

[covex-nn]

Right now, if someone installs MediaBundle 3.x-dev with Flex, there will be a error in console after composer require sonata-project/media-bundle 3.x-dev:

Executing script cache:clear [KO]
[KO]
Script cache:clear returned with error code 1
!!
!! In ArrayNode.php line 230:
!!
!! The child node "db_driver" at path "sonata_media" must be configured.
!!
!!
!!

If my proposal will be accepted, developer will see similar error in dev environment on a web-page. Exception will be decorated by symfony/debug-bundle and will contain instructions for developer. So, error will be anyway, because MediaBundle must be configured properly.

[kunicmarko20]

basically, if they install it in any way (without a pack) they would get an error? Ok, your proposal is great, I think we can move forward like this for all bundles and deprecate easy-extends

[covex-nn]

Without a pack error will be in runtime, and there won't be errors after installation during cache:clear, so a recipe will be valid and will be accepted

[jordisala1991]

We can't deprecate easy-extends for now, because it contains a class used in this (and other bundles), but we can get close to it.

[kunicmarko20]

You mean we can't remove it? We can deprecate it?

[jordisala1991]

SonataMediaBundle/src/DependencyInjection/SonataMediaExtension.php

Line 15 in 73e80e1

use Sonata\EasyExtendsBundle\Mapper\DoctrineCollector;

[kunicmarko20]

But when we add recipe:

SonataMediaBundle/src/DependencyInjection/SonataMediaExtension.php

Line 273 in 73e80e1

public function registerDoctrineMapping(array $config)

That won't be called anymore, so we can deprecate easy extends and on Media 4.x remove that part?