IBX-9947: Rebranded field type identifiers #543

barw4 · 2025-05-23T14:30:49Z

🎫 Issue	IBX-9947

Related PRs:

ibexa/content-forms#89
ibexa/admin-ui#1560

Description:

Publishing content type that previously used legacy field type aliases will rebrand old aliases to new ones.

The same goes for contents, new version will always use new aliases.

List of rebranded identifiers with legacy aliases:

 ---------------------------------------------------------- ----------------------------------------------------------------- ---------------------------------------------------- ---------------------------------------------------------- 
  Service ID                                                 alias                                                             legacy_alias                                         Class name                                                
 ---------------------------------------------------------- ----------------------------------------------------------------- ---------------------------------------------------- ---------------------------------------------------------- 
  Ibexa\Core\FieldType\Author\Type                           ibexa_author                                                      ezauthor                                             Ibexa\Core\FieldType\Author\Type                          
  Ibexa\Core\FieldType\BinaryFile\Type                       ibexa_binaryfile                                                  ezbinaryfile                                         Ibexa\Core\FieldType\BinaryFile\Type                      
  Ibexa\Core\FieldType\Checkbox\Type                         ibexa_boolean                                                     ezboolean                                            Ibexa\Core\FieldType\Checkbox\Type                        
  Ibexa\Core\FieldType\Country\Type                          ibexa_country                                                     ezcountry                                            Ibexa\Core\FieldType\Country\Type                         
  Ibexa\Core\FieldType\Date\Type                             ibexa_date                                                        ezdate                                               Ibexa\Core\FieldType\Date\Type                            
  Ibexa\Core\FieldType\DateAndTime\Type                      ibexa_datetime                                                    ezdatetime                                           Ibexa\Core\FieldType\DateAndTime\Type                     
  Ibexa\Core\FieldType\Time\Type                             ibexa_time                                                        eztime                                               Ibexa\Core\FieldType\Time\Type                            
  Ibexa\Core\FieldType\EmailAddress\Type                     ibexa_email                                                       ezemail                                              Ibexa\Core\FieldType\EmailAddress\Type                    
  Ibexa\Core\FieldType\Float\Type                            ibexa_float                                                       ezfloat                                              Ibexa\Core\FieldType\Float\Type                           
  Ibexa\Core\FieldType\Integer\Type                          ibexa_integer                                                     ezinteger                                            Ibexa\Core\FieldType\Integer\Type                         
  Ibexa\Core\FieldType\Image\Type                            ibexa_image                                                       ezimage                                              Ibexa\Core\FieldType\Image\Type                           
  Ibexa\Core\FieldType\ISBN\Type                             ibexa_isbn                                                        ezisbn                                               Ibexa\Core\FieldType\ISBN\Type                            
  Ibexa\Core\FieldType\Keyword\Type                          ibexa_keyword                                                     ezkeyword                                            Ibexa\Core\FieldType\Keyword\Type                         
  Ibexa\Core\FieldType\Media\Type                            ibexa_media                                                       ezmedia                                              Ibexa\Core\FieldType\Media\Type                           
  Ibexa\Core\FieldType\Relation\Type                         ibexa_object_relation                                             ezobjectrelation                                     Ibexa\Core\FieldType\Relation\Type                        
  Ibexa\Core\FieldType\Selection\Type                        ibexa_selection                                                   ezselection                                          Ibexa\Core\FieldType\Selection\Type                       
  Ibexa\Core\FieldType\TextBlock\Type                        ibexa_text                                                        eztext                                               Ibexa\Core\FieldType\TextBlock\Type                       
  Ibexa\Core\FieldType\TextLine\Type                         ibexa_string                                                      ezstring                                             Ibexa\Core\FieldType\TextLine\Type                        
  Ibexa\Core\FieldType\Url\Type                              ibexa_url                                                         ezurl                                                Ibexa\Core\FieldType\Url\Type                             
  Ibexa\Core\FieldType\MapLocation\Type                      ibexa_gmap_location                                               ezgmaplocation                                       Ibexa\Core\FieldType\MapLocation\Type                     
  Ibexa\Core\FieldType\RelationList\Type                     ibexa_object_relation_list                                        ezobjectrelationlist                                 Ibexa\Core\FieldType\RelationList\Type                    
  Ibexa\Core\FieldType\User\Type                             ibexa_user                                                        ezuser                                               Ibexa\Core\FieldType\User\Type                            
  ibexa.field_type.ibexa_matrix                              ibexa_matrix                                                      ezmatrix                                             Ibexa\Core\FieldType\Null\Type                            
  Ibexa\FieldTypeRichText\FieldType\RichText\Type            ibexa_richtext                                                    ezrichtext                                           Ibexa\FieldTypeRichText\FieldType\RichText\Type           
  Ibexa\FieldTypeMatrix\FieldType\Type                       %ibexa.field_type.matrix.identifier%                              %ibexa.field_type.matrix.legacy_identifier%          Ibexa\FieldTypeMatrix\FieldType\Type                      
  Ibexa\FieldTypeQuery\FieldType\Query\Type                  %ibexa.field_type.query.content.identifier%                       %ibexa.field_type.query.content.legacy_identifier%   Ibexa\FieldTypeQuery\FieldType\Query\Type                 
  Ibexa\Connector\Dam\FieldType\ImageAsset\Type              ibexa_image_asset                                                 ezimageasset                                         Ibexa\Connector\Dam\FieldType\ImageAsset\Type             
  Ibexa\Seo\FieldType\SeoType                                ibexa_seo                                                                                                              Ibexa\Seo\FieldType\SeoType                               
  Ibexa\Measurement\FieldType\MeasurementType                ibexa_measurement                                                                                                      Ibexa\Measurement\FieldType\MeasurementType               
  Ibexa\ProductCatalog\FieldType\CustomerGroup\Type          ibexa_customer_group                                                                                                   Ibexa\ProductCatalog\FieldType\CustomerGroup\Type         
  Ibexa\ProductCatalog\FieldType\ProductSpecification\Type   ibexa_product_specification                                                                                            Ibexa\ProductCatalog\FieldType\ProductSpecification\Type  
  Ibexa\Taxonomy\FieldType\TaxonomyEntry\Type                %ibexa.taxonomy.fieldtype.taxonomy_entry.identifier%                                                                   Ibexa\Taxonomy\FieldType\TaxonomyEntry\Type               
  Ibexa\Taxonomy\FieldType\TaxonomyEntryAssignment\Type      %ibexa.taxonomy.fieldtype.taxonomy_entry_assignment.identifier%                                                        Ibexa\Taxonomy\FieldType\TaxonomyEntryAssignment\Type     
  Ibexa\FieldTypePage\FieldType\LandingPage\Type             ibexa_landing_page                                                ezlandingpage                                        Ibexa\FieldTypePage\FieldType\LandingPage\Type            
  Ibexa\FormBuilder\FieldType\Type                           ibexa_form                                                        ezform                                               Ibexa\FormBuilder\FieldType\Type                          
  Ibexa\FieldTypeAddress\FieldType\Type                      %ibexa.field_type.address.identifier%                                                                                  Ibexa\FieldTypeAddress\FieldType\Type                     
 ---------------------------------------------------------- ----------------------------------------------------------------- ---------------------------------------------------- ----------------------------------------------------------

For QA:

Documentation:

src/lib/Base/Container/Compiler/FieldTypeRegistryPass.php

src/bundle/Core/Resources/views/fielddefinition_settings.html.twig

src/lib/FieldType/FieldTypeAliasResolverInterface.php

src/lib/FieldType/FieldTypeAliasResolver.php

barw4 · 2025-06-03T13:08:58Z

src/lib/Base/Container/Compiler/FieldTypeRegistryPass.php

+                        ],
+                    );
+                }
+


All ez* fieldtypes were additionally tagged with legacy_alias tag, i.e.:

Ibexa\Core\FieldType\Checkbox\Type: class: Ibexa\Core\FieldType\Checkbox\Type parent: Ibexa\Core\FieldType\FieldType tags: - {name: ibexa.field_type, alias: ibexa_boolean, legacy_alias: ezboolean}

And therefore, these aliases were added to a new registry FieldTypeAliasRegistry.

Can we mark this part as deprecated for our own purposes when dropping support in 6.0? (if it is planned of course - @adamwojs )

barw4 · 2025-06-03T13:10:16Z

src/lib/FieldType/FieldTypeAliasRegistry.php

+
+    public function getNewAlias(string $oldAlias): string
+    {
+        return $this->aliasMap[$oldAlias];


The registry allows to get a new alias instead of an old legacy alias.

src/lib/Persistence/Legacy/Content/StorageHandler.php

barw4 · 2025-06-03T13:12:45Z

src/lib/Persistence/Legacy/Content/Type/Mapper.php

+        $dataTypeString = $row['content_type_field_definition_data_type_string'];
+        $dataTypeString = $this->fieldTypeAliasResolver->resolveIdentifier($dataTypeString);


The whole magic happens here. We are changing identifiers during runtime, maybe we won't need to migrate any existing identifiers stored in database 🤔 but I'm not sure if this is what we want to go with

I am all for making db migration and droping this in 6.0. @adamwojs

ViniTou · 2025-06-04T08:00:39Z

src/lib/Base/Container/Compiler/FieldTypeRegistryPass.php

+                        ],
+                    );
+                }
+


Can we mark this part as deprecated for our own purposes when dropping support in 6.0? (if it is planned of course - @adamwojs )

ViniTou · 2025-06-04T08:04:59Z

src/lib/FieldType/FieldTypeRegistry.php

     * @return \Ibexa\Contracts\Core\FieldType\FieldType
     */
-    public function getFieldType($identifier): SPIFieldType
+    public function getFieldType(string $identifier): SPIFieldType


Could this be a good place to check if using old name and if - emit deprecation message?

I also wonder shouldnt we use decorator pattern here.

ViniTou · 2025-06-04T08:07:12Z

src/lib/Persistence/Legacy/Content/FieldValue/Converter/DateAndTimeConverter.php

@@ -32,7 +32,9 @@ public function toStorageValue(FieldValue $value, StorageFieldValue $storageFiel
    {
        // @todo: One should additionally store the timezone here. This could
        // be done in a backwards compatible way, I think…
-        $storageFieldValue->dataInt = ($value->data !== null ? $value->data['timestamp'] : null);
+        $storageFieldValue->dataInt = ($value->data !== null
+            ? ($value->data['timestamp'] ?? $value->data['timestring'])


prolly I am missing something, but from what timestring is coming from?

Discussed on Slack but leaving a note here so that it won't get lost. On 5.0 we are getting:

Warning: Undefined array key "timestamp"

without this change

ViniTou · 2025-06-04T08:11:20Z

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase.php

@@ -1148,15 +1148,15 @@ public function removeReverseFieldRelations(int $contentId): void
        $statement = $query->executeQuery();

        while ($row = $statement->fetch(FetchMode::ASSOCIATIVE)) {
-            if ($row['data_type_string'] === 'ezobjectrelation') {
+            if ($row['data_type_string'] === 'ibexa_object_relation') {


I know this is a strech now - but maybe, we can finally introduce const for every FieldType or make getFieldTypeIdentifier static method? Those strings are really troublesome when spiled accros product.

ViniTou · 2025-06-04T08:12:17Z

src/lib/Persistence/Legacy/Content/Type/Mapper.php

+        $dataTypeString = $row['content_type_field_definition_data_type_string'];
+        $dataTypeString = $this->fieldTypeAliasResolver->resolveIdentifier($dataTypeString);


I am all for making db migration and droping this in 6.0. @adamwojs

ViniTou · 2025-06-04T08:12:56Z

src/lib/Repository/UserService.php

@@ -62,7 +62,7 @@
 */
 class UserService implements UserServiceInterface
 {
-    private const USER_FIELD_TYPE_NAME = 'ezuser';
+                  private const USER_FIELD_TYPE_NAME = 'ibexa_user'; //TODO co z tym? :/

            


as above, in my opinien we should remove this and unify accessing FT types.

src/lib/FieldType/FieldTypeAliasRegistry.php

barw4 · 2025-06-05T08:20:08Z

src/lib/Persistence/Legacy/Content/Mapper.php

+        $fieldTypeString = $row['content_field_data_type_string'];
+        $fieldTypeString = $this->fieldTypeAliasResolver->resolveIdentifier($fieldTypeString);
+
+        $field->type = $fieldTypeString;


sonarqubecloud · 2025-06-05T19:48:50Z

Quality Gate failed

Failed conditions
4.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

adamwojs

Could you please add aliases for all renamed services and parameters ? This will help us to keep BC (in a follow up PR).

github-actions bot assigned mikadamczyk May 23, 2025

This was referenced May 23, 2025

IBX-9947: Rebranded field type identifiers ibexa/admin-ui#1560

Merged

IBX-9947: Rebranded field type identifiers ibexa/content-forms#89

Merged

github-actions bot assigned alongosz and tischsoic May 23, 2025

barw4 added Feature New feature request Work in progress labels May 23, 2025

barw4 force-pushed the ibx-9947-rebrand-ft-identifiers branch from 7196c19 to b75af48 Compare May 23, 2025 14:33

lserwatka reviewed May 23, 2025

View reviewed changes

src/lib/Base/Container/Compiler/FieldTypeRegistryPass.php Outdated Show resolved Hide resolved

adamwojs reviewed May 29, 2025

View reviewed changes

src/bundle/Core/Resources/views/fielddefinition_settings.html.twig Outdated Show resolved Hide resolved

src/lib/FieldType/FieldTypeAliasResolverInterface.php Outdated Show resolved Hide resolved

src/lib/FieldType/FieldTypeAliasResolver.php Outdated Show resolved Hide resolved

barw4 force-pushed the ibx-9947-rebrand-ft-identifiers branch from 8b6b2ea to 91bce77 Compare June 3, 2025 11:35

barw4 commented Jun 3, 2025

View reviewed changes

src/lib/Persistence/Legacy/Content/StorageHandler.php Outdated Show resolved Hide resolved

barw4 commented Jun 3, 2025

View reviewed changes

ViniTou reviewed Jun 4, 2025

View reviewed changes

tbialcz reviewed Jun 4, 2025

View reviewed changes

src/lib/FieldType/FieldTypeAliasRegistry.php Outdated Show resolved Hide resolved

barw4 force-pushed the ibx-9947-rebrand-ft-identifiers branch from 0d68129 to 448692b Compare June 5, 2025 08:19

barw4 commented Jun 5, 2025

View reviewed changes

barw4 marked this pull request as ready for review June 5, 2025 08:20

barw4 added Ready for review and removed Work in progress labels Jun 5, 2025

barw4 added 23 commits June 5, 2025 21:36

IBX-9947: Rebranded remaining field types

6a1840b

IBX-9947: Naming

b8946c9

IBX-9947: Naming in tests

47f4eb0

IBX-9947: Naming

6c7f743

IBX-9947: Naming

ab43baf

IBX-9947: Naming

6efc19d

IBX-9947: Update command

86fbb6f

IBX-9947: Update test

4026b84

IBX-9947: Update cleandata.sql

6ee62c6

IBX-9947: Update fixtures

128276f

IBX-9947: PHPStan

32bd524

IBX-9947: Fixup

b625ee3

IBX-9947: Fixup

e3824ca

IBX-9947: Rollback

02a0669

IBX-9947: Rollback StorageHandler

b266d81

IBX-9947: Rollback registry passes

3bca9f0

IBX-9947: Rollback registry passes

bfa6cfe

IBX-9947: CS

60f7158

IBX-9947: Fixed tests

c49ed09

IBX-9947: Rollbacked legacy field types removal

6f1b6a1

IBX-9947: CS

7f06c2d

IBX-9947: CS

18b694a

IBX-9947: CS

65c37af

adamwojs force-pushed the ibx-9947-rebrand-ft-identifiers branch from 4885801 to 65c37af Compare June 5, 2025 19:47

adamwojs approved these changes Jun 5, 2025

View reviewed changes

adamwojs merged commit 12abb87 into main Jun 5, 2025
12 of 15 checks passed

adamwojs deleted the ibx-9947-rebrand-ft-identifiers branch June 5, 2025 21:16

This was referenced Jun 6, 2025

IBX-9947: Rebranded FT identifiers ibexa/test-core#21

Merged

IBX-9947: Rebranded field type identifiers ibexa/behat#148

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

IBX-9947: Rebranded field type identifiers #543

IBX-9947: Rebranded field type identifiers #543

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		$dataTypeString = $row['content_type_field_definition_data_type_string'];
		$dataTypeString = $this->fieldTypeAliasResolver->resolveIdentifier($dataTypeString);

IBX-9947: Rebranded field type identifiers #543

IBX-9947: Rebranded field type identifiers #543

Uh oh!

Conversation

Uh oh!

Related PRs:

Description:

For QA:

Documentation:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Quality Gate failed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!