EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI #1985

alongosz · 2017-05-12T15:03:45Z

Part 1 of EZP-26885 implementation.

We want to be able to use \Doctrine\DBAL\Connection for FieldTypes external storage directly.
To achieve this, FieldType external storage needs to be injected with DoctrineStorage gateway which uses Doctrine instead of Legacy Connection Handler.

This PR is the first step towards solving EZP-26885. To be able easily inject Doctrine instead of Legacy DatabaseHandler we need to make the latter fully injectable. Up to now, external storage gateway was chosen by context passed by \eZ\Publish\Core\Persistence\Legacy\Content\StorageHandler.

This PR refactors Field Type-specific external storages so they get injected with proper, FT-specific gateways.
Each gateway gets injected with \eZ\Publish\Core\Persistence\Doctrine\ConnectionHandler.
In the future Legacy gateway injected into FT-specific external storage can be replaced with Doctrine gateway which would use \Doctrine\DBAL\Connection.

TODO:

alongosz · 2017-05-22T09:10:09Z

Example of actual implementation of DoctrineStorage gateway is available in the PR #1993.
For Keyword FT: 46d5589.

alongosz · 2017-05-22T09:11:15Z

review ping @andrerom @kore @Nattfarinn

kore · 2017-06-19T10:38:54Z

+1

andrerom

+1, but some inline nitpicks to fix

andrerom · 2017-06-19T11:25:19Z

doc/upgrade/6.10.md

@@ -0,0 +1,166 @@
+# Upgrade steps from 6.9 to 6.10


6.10 to 6.11 by now

andrerom · 2017-06-19T11:28:58Z

doc/upgrade/6.10.md

+Abstract base class `eZ\Publish\Core\FieldType\StorageGateway` for the gateway of a Field Type external storage and the
+`eZ\Publish\Core\FieldType\StorageGateway::setConnection` method are deprecated.
+
+Extend the `eZ\Publish\SPI\FieldType\StorageGateway` class and inject Database Handler directly


to better signal that the change is not something field types have to do immediately, start the sentence by saying something like:

To prepare your FieldType for future storage engines and avoid using the deprecated abstract, extend the ..

andrerom · 2017-06-19T11:29:29Z

doc/upgrade/6.10.md

+Abstract base class `eZ\Publish\Core\FieldType\GatewayBasedStorage` for Field Type external storage
+which uses gateway is deprecated.
+
+Use `eZ\Publish\SPI\FieldType\GatewayBasedStorage` instead and inject external


similar comment here

andrerom · 2017-06-19T11:31:02Z

eZ/Publish/Core/FieldType/GatewayBasedStorage.php

+                '%s extends deprecated %s. Extend %s instead',
+                static::class,
+                self::class,
+                \eZ\Publish\SPI\FieldType\GatewayBasedStorage::class


place in use section to not use FQCN inline

andrerom · 2017-06-19T11:31:09Z

eZ/Publish/Core/FieldType/GatewayBasedStorage.php

@@ -15,6 +15,8 @@
 /**
 * Storage gateway base class to be used by FieldType storages.
 *
+ * @deprecated Since 6.10. Use {@link \eZ\Publish\SPI\FieldType\GatewayBasedStorage}


6.11, same everywhere else in this PR

andrerom · 2017-06-19T11:36:42Z

Another thing, this deprecation should also be mentioned with a point in doc/bc/6.11 with reference to the upgrade doc for further info.

…ion via DI

…a DI

andrerom · 2017-06-20T13:46:16Z

doc/bc/changes-6.11.md

+## Changes
+
+- EZP-26885: Field Type external storage
+  - Field Type external storage gets directly injected with a proper external storage gateway.


This is misleading isn't it, people will need to migrate as stated in upgrade doc in order for this change to affect them. As in if they stay on old abstract nothing will change or?

Ok, I wasn't sure how to indicate this. Maybe I just should keep ## Changes section empty and keep ## Deprecations only?

yes I think so

we almost always first deprecate, and in a later release change or remove ;)

Done, all docs in 13a9dc2

andrerom · 2017-06-20T15:13:04Z

doc/bc/changes-6.11.md

+## Deprecations
+
+- EZP-26885: Field Type external storage
+  - Abstract base class `eZ\Publish\Core\FieldType\StorageGateway` for the gateway of a Field Type


Should you also list up eZ\Publish\Core\FieldType\GatewayBasedStorage here?

Yeah, sorry :( Somehow I thought we have only two deprecations in Core. I looked over entire diff and in fact we have 4 in total. Added as a fixup in 23722a4 for easier review.

Amended in a6d83a7

andrerom · 2017-06-21T11:44:01Z

Great work @alongosz, merging :)

You can now rebase the other one when you have the time ;)

alongosz mentioned this pull request May 12, 2017

EZP-26885: As a Developer I want to future proof my Field Types by using Doctrine [in external storage] #1911

Closed

6 tasks

alongosz changed the title ~~EZP-26885: As a Developer I want to future proof my Field Types by using Doctrine [in external storage]~~ [WIP] EZP-26885: As a Developer I want to future proof my Field Types by using Doctrine [in external storage] May 12, 2017

alongosz force-pushed the ezp-26885-ft-ext-storage-gw-changes branch 3 times, most recently from 95cb22c to 424b4a2 Compare May 16, 2017 13:47

alongosz changed the title ~~[WIP] EZP-26885: As a Developer I want to future proof my Field Types by using Doctrine [in external storage]~~ EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI May 16, 2017

alongosz force-pushed the ezp-26885-ft-ext-storage-gw-changes branch 3 times, most recently from ca2da9e to a674bff Compare May 19, 2017 14:49

alongosz mentioned this pull request May 22, 2017

EZP-26885: As a Developer I want to future proof my Field Types by using Doctrine [in external storage] #1993

Merged

11 tasks

alongosz requested review from andrerom and Nattfarinn May 22, 2017 09:10

Nattfarinn approved these changes May 25, 2017

View reviewed changes

andrerom approved these changes Jun 19, 2017

View reviewed changes

Andrew Longosz added 10 commits June 20, 2017 14:14

EZP-26885: Added to SPI ext. storage GW base classes

5be99ec

EZP-26885: Deprecated getting GW from StorageHandler context

144822e

EZP-26885: [Keyword FT] Injected ext storage GW and connection via DI

a24d823

EZP-26885: [BinaryFile, Media FT] Injected ext storage GW and connect…

55c490d

…ion via DI

EZP-26885: [Image FT] Injected ext storage GW and connection via DI

412b6f0

EZP-26885: [MapLocation FT] Injected ext storage GW and connection vi…

e6a2ee8

…a DI

EZP-26885: [User FT] Injected ext storage GW and connection via DI

e83cfa6

EZP-26885: [Page FT] Injected ext storage GW connection via DI

117bfb9

EZP-26885: [RichText FT] Injected ext storage GW and connection via DI

24bdac8

EZP-26885: [Url FT] Injected ext storage GW and connection via DI

564c3b1

alongosz force-pushed the ezp-26885-ft-ext-storage-gw-changes branch from a674bff to cec4b56 Compare June 20, 2017 13:11

andrerom reviewed Jun 20, 2017

View reviewed changes

EZP-26885: Added upgrade notes

13a9dc2

alongosz force-pushed the ezp-26885-ft-ext-storage-gw-changes branch from cec4b56 to 13a9dc2 Compare June 20, 2017 15:06

andrerom reviewed Jun 20, 2017

View reviewed changes

fixup! EZP-26885: Added upgrade notes

a6d83a7

alongosz force-pushed the ezp-26885-ft-ext-storage-gw-changes branch from 23722a4 to a6d83a7 Compare June 20, 2017 20:54

andrerom merged commit 9f5f9b2 into ezsystems:master Jun 21, 2017

alongosz mentioned this pull request Jul 14, 2017

[PostgreSQL] Fix sequence naming for External Storage Gateways #2055

Merged

emodric mentioned this pull request Aug 17, 2017

Use new storage gateway API for 6.11 compatibility ezsystems/ezplatform-xmltext-fieldtype#22

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI #1985

EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI #1985

alongosz commented May 12, 2017 •

edited

Loading

alongosz commented May 22, 2017

alongosz commented May 22, 2017

kore commented Jun 19, 2017

andrerom left a comment

andrerom Jun 19, 2017 •

edited

Loading

andrerom Jun 19, 2017

andrerom Jun 19, 2017

andrerom Jun 19, 2017

andrerom Jun 19, 2017

andrerom commented Jun 19, 2017

andrerom Jun 20, 2017

alongosz Jun 20, 2017

andrerom Jun 20, 2017

alongosz Jun 20, 2017

andrerom Jun 20, 2017

alongosz Jun 20, 2017

alongosz Jun 20, 2017

andrerom commented Jun 21, 2017

EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI #1985

EZP-26885: Refactor Field Types external storages to inject gateways and connection handler via DI #1985

Conversation

alongosz commented May 12, 2017 • edited Loading

Part 1 of EZP-26885 implementation.

alongosz commented May 22, 2017

alongosz commented May 22, 2017

kore commented Jun 19, 2017

andrerom left a comment

Choose a reason for hiding this comment

andrerom Jun 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrerom commented Jun 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrerom commented Jun 21, 2017

alongosz commented May 12, 2017 •

edited

Loading

andrerom Jun 19, 2017 •

edited

Loading