Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EZP-30636: Provided forward compatibility for eZ Platform Extension #11

Merged
merged 6 commits into from
Sep 30, 2019

Conversation

alongosz
Copy link
Member

@alongosz alongosz commented Sep 25, 2019

Question Answer
JIRA issue EZP-30636
Bug/Improvement no
New feature yes
Target version 1.0 for eZ Platform v2.5.x LTS and 3.0@beta2
BC breaks yes
Tests pass yes
Doc needed yes

This PR provides forward compatibility with eZ Platform 3.0 by means of eZ Platform Core Bundle and its Extension, so the Developers and Maintainers are able to prefix their eZ Platform configuration with

ezplatform:

instead of

ezpublish:

Current implementation simply prepends ezplatform configuration to ezpublish extension. This by no means is a complete solution. It's rather a workaround to simplify migration.

For eZ Platform 3.0 we plan to provide fully functional EzPlatformCoreBundle which registers ezplatform extension and replaces EzPublishCoreBundle and ezpublish extension.

I still believe this is a good way to go, even if it is a workaround. I took into the account suggestions from the internal Sprint Demo and targeted it for eZ Platform 2.5.x LTS so that PR provides more significant value.

Open question

  • Should we drop "Core" from the Bundle and Extension name? So it's just EzPlatformBundle and EzPlatformExtension? // Internal Sync: No.

Doc

To use ezplatform instead of ezpublish in their 2.5.x ezplatform.yml configuration files, the Developers must enable the EzSystems\EzPlatformCoreBundle\EzPlatformCoreBundle in their Kernel.

v2.5

app/AppKernel.php:

        $bundles = [
            // ...
            new EzSystems\EzPlatformCoreBundle\EzPlatformCoreBundle(),
            // ...
        ];

v3.0

config/bundles.php:

return [
    // ...
    EzSystems\EzPlatformCoreBundle\EzPlatformCoreBundle::class => ['all' => true],
    // ...
];

QA

  • Test configuration of ezplatform extension (replacing ezpublish with ezplatform in ezplatform.yml (you could use the alongosz:ezp-30636-ezplatform-extension branch),
  • Perform sanity checks for the current ezpublish configuration.

TODO

  • Rebase after merging [Travis] Added code style checking job #10
  • Create Bundle.
  • Create Extension.
  • Prepend ezpublish extension with config from ezplatform extension.
  • Double check if everything is working as expected.

@alongosz alongosz force-pushed the ezp-30636-ezplatform-extension branch 3 times, most recently from 12f98eb to 4293586 Compare September 27, 2019 13:38
@alongosz alongosz marked this pull request as ready for review September 27, 2019 13:38
@alongosz alongosz changed the title [WiP] EZP-30636: Created eZ Platform Core Bundle and Config Extension EZP-30636: Created eZ Platform Core Bundle and Config Extension Sep 27, 2019
@alongosz alongosz force-pushed the ezp-30636-ezplatform-extension branch from 4293586 to 81895a5 Compare September 27, 2019 15:13
@alongosz alongosz force-pushed the ezp-30636-ezplatform-extension branch from 81895a5 to 3544de2 Compare September 29, 2019 16:47
@alongosz alongosz changed the base branch from master to 1.0 September 29, 2019 16:48
@alongosz alongosz changed the title EZP-30636: Created eZ Platform Core Bundle and Config Extension EZP-30636: Provided forward compatibility for eZ Platform Extension Sep 29, 2019
@alongosz alongosz force-pushed the ezp-30636-ezplatform-extension branch from 3544de2 to 7508f87 Compare September 30, 2019 09:01
src/EzPlatformCoreBundle/bundle/EzPlatformCoreBundle.php Outdated Show resolved Hide resolved
composer.json Outdated Show resolved Hide resolved
.travis.yml Outdated Show resolved Hide resolved
@alongosz alongosz force-pushed the ezp-30636-ezplatform-extension branch from 1254825 to 9c97d3f Compare September 30, 2019 13:06
alongosz added a commit that referenced this pull request Sep 30, 2019
Squashed commit of the following:

commit 9c97d3f
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Fri Sep 27 15:28:18 2019 +0200

    [Symfony] Prepended ezplatform configuration to ezpublish extension

    This is a workaround to avoid copying all the code from
    EzPublishCoreBundle at once. It allows using "ezplatform"
    as a root node for the configuration w/o defining that configuration.

    Validation is still done by ezpublish extension.

commit f55ad2b
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Wed Sep 25 23:28:37 2019 +0200

    [Symfony] Created eZ Platform Core Bundle, Extension, and Configuration

commit a932385
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Wed Sep 25 23:25:46 2019 +0200

    [Tests] Created EzPlatformCoreBundle test suite

commit cc5d00c
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Wed Sep 25 22:54:17 2019 +0200

    [Composer] Added EzPlatformCoreBundle namespace to autoloader

commit 1d4e610
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Wed Sep 25 21:29:30 2019 +0200

    [Travis] Added PHPUnit unit tests job

commit ed7dcff
Author: Andrew Longosz <alongosz@users.noreply.github.com>
Date:   Wed Sep 25 21:14:36 2019 +0200

    [Tests] Created initial PHPUnit tests setup
Copy link
Member

@mnocon mnocon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok to me, on v2 with ezplatform and ezpublish config prefixes and on v3 with ezplatform one.

@alongosz alongosz merged commit 02ee7ae into ezsystems:1.0 Sep 30, 2019
@alongosz alongosz deleted the ezp-30636-ezplatform-extension branch September 30, 2019 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request QA approved
Development

Successfully merging this pull request may close these issues.

5 participants