Recipes for Symfony Flex

[covex-nn]

This article contains a plan for creating recipes for sonata-project bundles. Each bundle must be prepared according to my proposal:

1. It should be possible to create a default configuration, that allows to run cache:clear without errors
2. It should be possible to create an additional configuration for each supported persistence mechanism, that will make a bundle fully functional after installing some required additional packages

A default configuration will be a bundle's recipe. Additional configuration will be a recipe for a new package. This new package, a pack, will contain composer.json with all requirements for particular persistence mechanism.

A bundle, that will be installed without a pack (and without additional configuration) can throw exceptions with instructions for developer how to set it up with installing a pack.

MediaBundle

• Update dependencies, Update dependencies SonataMediaBundle#1417
• Make a db_driver configuration parameter optional with no_driver default value, Make a db_driver configuration parameter optional with no_driver default value SonataMediaBundle#1420
• Create default configuration and a recipe, Add sonata-project/media-bundle recipe symfony/recipes-contrib#375
• Create new repository for sonata-project/media-orm-pack
• Create additional configuration for ORM, create a recipe, Add sonata-project/media-orm-pack recipe symfony/recipes-contrib#385
• Create new repository for sonata-project/media-odm-pack
• Create additional configuration for MongoDB ODM, create a recipe, Add sonata-project/media-odm-pack recipe symfony/recipes-contrib#410
• Create new repository for sonata-project/media-phpcr-pack
• Create additional configuration for PHPCR, create a recipe

SeoBundle and CacheBundle

Maybe a default configuration could be created? Or bundle configuration is enough?

NotificationBundle

• Refactor bundle configuration, Refactor bundle configuration to create recipe for Flex SonataNotificationBundle#314
• Update dependencies, Move enqueue/amqp-lib to require-dev section SonataNotificationBundle#327
• Create default configuration and a recipe, Add sonata-project/notification-bundle recipe symfony/recipes-contrib#302
• Create new repository for sonata-project/notification-orm-pack
• Create additional configuration for ORM, create a recipe, Add sonata-project/notification-orm-pack recipe symfony/recipes-contrib#384

PageBundle

• Auto-register sonata.page.router, Auto-register sonata.page.router SonataPageBundle#960
• Update bundle dependencies in composer.json, Require sonata-project/doctrine-orm-admin-bundle SonataPageBundle#980
• Wait until symfony-cmf/routing-bundle will be released with Symfony ^4.0 dependencies
• Create default configuration and a recipe, Add recipe for sonata-project/page-bundle symfony/recipes-contrib#397

ClassificationBundle

• Prepare bundle for recipe, Force use translation strings for classification entities SonataClassificationBundle#403
• Create default configuration and a recipe, Add recipe for sonata-project/classification-bundle symfony/recipes-contrib#389

TranslationBundle

• Prepare bundle for recipe, Check if 'sonata_translation.checker.translatable' service exists SonataTranslationBundle#233
• Create default configuration and a recipe, Add recipe for sonata-project/translation-bundle symfony/recipes-contrib#400

ArticleBundle

• Create default configuration and a recipe

TimelineBundle

• Create default configuration and a recipe

CommentBundle

• Create a recipes for FOSCommentBundle first ??

DashboardBundle

• Create default configuration and a recipe

UserBundle and NewsBundle

It is not possible to create a recipe for these bundles, because they depends on FOSUserBundle, that does have and cannot have a recipe.

FormatterBundle

egeloen/ckeditor-bundle should be replaced with friendsofsymfony/ckeditor-bundle, but it is a BC break

ClassificationMedia

No plans, a recipe will be possible after next major release of MediaBundle and ClassificationBundle

[kunicmarko20]

Make a db_driver configuration parameter optional with no_driver default value

I think this will be a bc break 😞

Set admin.enabled configuration parameter == defaultFalse

same

SeoBundle and CacheBundle

Maybe a default configuration could be created? Or bundle configuration is enough?

If there is any configuration that has to be set in docs, then we add it to recipe.

So basically, we can only do: SeoBundle, CacheBundle, PageBundle, ClassificationBundle, ArticleBundle, TimelineBundle , DashboardBundle?

[covex-nn]

I believe, that changes for MediaBundle is not a BC break, i will create a PR soon, so we can discuss it there. I hope MediaBundle will have a recipe soon. And ArticleBundle depends on MediaBundle =)

PageBundle and DashboardBundle depends on NotificationBundle. And we can create a recipe for NotificationBundle, actualy. Changing admin.enabled is optional, and it is BC break, yes. With that change i want to enable admin only when backend is sonata.notification.backend.doctrine and Entity is available. Otherwise it will be disabled by default configuration in current release.

If there is any configuration that has to be set in docs, then we add it to recipe.

👍

[kunicmarko20]

oh, if by default it is empty, then no, I thought it is orm by default. That won't be a bc break for media then.

[covex-nn]

Btw, what package name is more correct: sonata-project/media-odm-pack or sonata-project/media-mongodb-pack?

[covex-nn]

Updated PR for sonata-project/notification-bundle, see symfony/recipes-contrib#302. Recipe contains only config/packages/sonata_notification.yaml file

There is a problem with PageBundle: symfony-cmf/routing-bundle has no stable release with Symfony4 support =(

[kunicmarko20]

Media pack name depends on:

that depends whether you target ODM or plain MongoDB

Copied from Slack conversation I never used it so I am not sure, I guess ODM?

[kunicmarko20]

So, for now, we need:

sonata-project/media-orm-pack
sonata-project/media-odm-pack
sonata-project/media-phpcr-pack
sonata-project/notification-orm-pack
sonata-project/classification-orm-pack
sonata-project/classification-odm-pack

this repositories created?

[covex-nn]

Yes, that's right. It will be possible to create a recipes for sonata-project/classification-bundle, i just checked (i guess, that before creating recipes, composer.json must be updated. i will create a PR)

[kunicmarko20]

ok, will contact @rande about creating repositories

[kunicmarko20]

cc @greg0ire, @jordisala1991, @core23, @OskarStark, @soullivaneuh before I contact @rande, do you agree we continue this way and use packs?

[core23]

do you agree we continue this way and use packs?

Never used symfony flex /w packs. Do we need this many packs or can we create a general sonata/doctrine-pack?

[covex-nn]

@core23 sonata/doctrine-pack is too generic, it cannot bring anything for sonata-project/media-bundle except doctrine/doctrine-bundle and doctrine/doctrine-orm - and symfony/orm-pack already contains such dependencies.

With my proposal, see sonata-project/SonataMediaBundle#1419, after composer require sonata-project/media-orm-pack developer will receive:

1. sonata-project/media-bundle and sonata-project/doctrine-orm-admin-bundle from pack's dependencies; also doctrine/doctrine-bundle with doctrine/orm will be installed
2. A default configuration from MediaBundle recipe, see comment
3. A storage configuration from MediaOrmPack recipe, see the same comment
4. Three Entity classes, see gist

And after bin/console doctrine:schema:update --force developer will have fully functional MediaBundle

[rande]

Do you want 1 repositories with all packs and split it like symfony ? or do you want many repositories ?

The pack solution looks great!

[covex-nn]

Each repository must contain composer.json file, unique for each pack. So, it cannot be splited, i guess.

Please create many repositories =)