Restore reference resolving in contenttype settings; restore referenc…

…e resolving in scalar attributes; do not swallow any more errors from non-existing user groups

API/ComplexFieldInterface.php

@@ -8,11 +8,11 @@
 interface ComplexFieldInterface
 {
     /**
-     * Return a non primitive field value - or a primitive field value after further transformation
+     * Return a non primitive field value - or a primitive field value with custom transformation
      *
      * @param $fieldValueArray The definition of the field value, as used in the yml file
      * @param array $context The context for execution of the current migrations. Contains f.e. the path to the migration
-     * @return mixed
+     * @return mixed the object / array / scalar which will be passed to the setField() call of a content update or creation structure
      */
     public function createValue($fieldValueArray, array $context = array());
 }

Core/Executor/ContentManager.php

@@ -313,7 +313,7 @@ protected function setObjectStates(Content $content, array $stateKeys)
     }
 
     /**
-     * Create the field value for either a primitive or complex field
+     * Create the field value for either a primitive (ie. scalar) or complex field
      *
      * @param mixed $value
      * @param FieldDefinition $fieldDefinition
@@ -354,8 +354,9 @@ protected function getSingleFieldValue($value, FieldDefinition $fieldDefinition,
                 // do nothing
         }
 
-        // We do not really want this to happen by default on all scalar field values. If you want this to happen, register a complex field for it
-        //$value = $this->referenceResolver->resolveReference($value);
+        // q: do we really want this to happen by default on all scalar field values?
+        // Note: if you want this *not* to happen, register a complex field for your scalar field...
+        $value = $this->referenceResolver->resolveReference($value);
 
         return $value;
     }

Core/Executor/ContentTypeManager.php

@@ -6,6 +6,7 @@
 use eZ\Publish\Core\Repository\Values\ContentType\FieldDefinition;
 use eZ\Publish\API\Repository\Values\ContentType\ContentType;
 use Kaliop\eZMigrationBundle\API\Collection\ContentTypeCollection;
+use Kaliop\eZMigrationBundle\API\ReferenceResolverInterface;
 use Kaliop\eZMigrationBundle\Core\Matcher\ContentTypeMatcher;
 use Kaliop\eZMigrationBundle\Core\Matcher\ContentTypeGroupMatcher;
 
@@ -18,11 +19,15 @@ class ContentTypeManager extends RepositoryExecutor
 
     protected $contentTypeMatcher;
     protected $contentTypeGroupMatcher;
+    // This resolver is used to resolve references in content-type settings definitions
+    protected $extendedReferenceResolver;
 
-    public function __construct(ContentTypeMatcher $matcher, ContentTypeGroupMatcher $contentTypeGroupMatcher)
+    public function __construct(ContentTypeMatcher $matcher, ContentTypeGroupMatcher $contentTypeGroupMatcher,
+        ReferenceResolverInterface $extendedReferenceResolver)
     {
         $this->contentTypeMatcher = $matcher;
         $this->contentTypeGroupMatcher = $contentTypeGroupMatcher;
+        $this->extendedReferenceResolver = $extendedReferenceResolver;
     }
 
     /**
@@ -139,7 +144,6 @@ protected function update()
                     if ($existingFieldDefinition) {
                         // Edit existing attribute
                         $fieldDefinitionUpdateStruct = $this->updateFieldDefinition($contentTypeService, $attribute);
-                        //$fieldDefinitionUpdateStruct = $this->updateFieldSettingsFromExisting($fieldDefinitionUpdateStruct, $existingFieldDefinition);
                         $contentTypeService->updateFieldDefinition(
                             $contentTypeDraft,
                             $existingFieldDefinition,
@@ -319,7 +323,7 @@ private function createFieldDefinition(ContentTypeService $contentTypeService, a
                     $fieldDefinition->defaultValue = $value;
                     break;
                 case 'field-settings':
-                    $fieldDefinition->fieldSettings = $this->setFieldSettings($value);
+                    $fieldDefinition->fieldSettings = $this->getFieldSettings($value);
                     break;
                 case 'validator-configuration':
                     $fieldDefinition->validatorConfiguration = $value;
@@ -377,7 +381,7 @@ private function updateFieldDefinition(ContentTypeService $contentTypeService, a
                     $fieldDefinitionUpdateStruct->defaultValue = $value;
                     break;
                 case 'field-settings':
-                    $fieldDefinitionUpdateStruct->fieldSettings = $this->setFieldSettings($value);
+                    $fieldDefinitionUpdateStruct->fieldSettings = $this->getFieldSettings($value);
                     break;
                 case 'position':
                     $fieldDefinitionUpdateStruct->position = $value;
@@ -391,7 +395,7 @@ private function updateFieldDefinition(ContentTypeService $contentTypeService, a
         return $fieldDefinitionUpdateStruct;
     }
 
-    private function setFieldSettings($value)
+    private function getFieldSettings($value)
     {
         // Updating any references in the value array
 
@@ -403,11 +407,11 @@ private function setFieldSettings($value)
 
                 // we do NOT check for refs in field settings which are arrays, even though we could, maybe *should*...
                 if (!is_array($val)) {
-                    $ret[$key] = $this->referenceResolver->resolveReference($val);
+                    $ret[$key] = $this->extendedReferenceResolver->resolveReference($val);
                 }
             }
         } else {
-            $ret = $this->referenceResolver->resolveReference($value);
+            $ret = $this->extendedReferenceResolver->resolveReference($value);
         }
 
         return $ret;

Core/Executor/RoleManager.php

@@ -274,17 +274,17 @@ private function assignRole(Role $role, RoleService $roleService, UserService $u
                         $group = $userService->loadUserGroup($groupId);
 
                         if (!isset($assign['limitations'])) {
-                            try {
+                            // q: why are we swallowing exceptions here ?
+                            //try {
                                 $roleService->assignRoleToUserGroup($role, $group);
-                                // q: why are we swallowing exceptions here ?
-                            } catch (InvalidArgumentException $e) {}
+                            //} catch (InvalidArgumentException $e) {}
                         } else {
                             foreach ($assign['limitations'] as $limitation) {
                                 $limitationObject = $this->createLimitation($roleService, $limitation);
-                                try {
-                                    $roleService->assignRoleToUserGroup($role, $group, $limitationObject);
                                 // q: why are we swallowing exceptions here ?
-                                } catch (InvalidArgumentException $e) {}
+                                //try {
+                                    $roleService->assignRoleToUserGroup($role, $group, $limitationObject);
+                                //} catch (InvalidArgumentException $e) {}
                             }
                         }
                     }

Core/Executor/UserManager.php

@@ -43,9 +43,9 @@ protected function create()
             $userGroup = $userService->loadUserGroup($groupId);
 
             // q: in which case can we have no group? And should we throw an exception?
-            if ($userGroup) {
+            //if ($userGroup) {
                 $userGroups[] = $userGroup;
-            }
+            //}
         }
 
         // FIXME: Hard coding content type to user for now

Resources/config/services.yml

@@ -175,6 +175,7 @@ services:
         arguments:
             - '@ez_migration_bundle.content_type_matcher'
             - '@ez_migration_bundle.content_type_group_matcher'
+            - '@ez_migration_bundle.reference_resolver'
         tags:
             - { name: ez_migration_bundle.executor }
 
@@ -343,6 +344,8 @@ services:
     ### reference resolvers
 
     # A service that will resolve *any* possible reference. To be used with care
+    # At the moment is is only used to resolve references in definitions of FieldType settings, and even then, only
+    # for backwards compatibility
     ez_migration_bundle.reference_resolver:
         alias: ez_migration_bundle.reference_resolver.chain
 
@@ -352,7 +355,7 @@ services:
             -
                 - '@ez_migration_bundle.reference_resolver.customreference'
                 - '@ez_migration_bundle.reference_resolver.location'
-               # not enabled by default for v2, as it might break v1 migrations that don't expect it to be present
+               # not enabled by default for v3, as it might break v1 migrations that don't expect it to be present
                #- '@ez_migration_bundle.reference_resolver.content'
                 - '@ez_migration_bundle.reference_resolver.tag'
 

Resources/doc/DSL/ManageContentType.yml

@@ -22,6 +22,9 @@
             category: default|meta # Optional
             default-value: # Optional
             field-settings: array # Optional, can be used for various field type specific settings
+                                  # Within the settings values, the following tag are *currently* resolved:
+                                  # reference:<ref>, tag:<tag name>, location:<location remote id>
+                                  # *Note* that this is for bacwards compatibility and may change in the future
     # The list in references tells the manager to store specific values for later use by other steps in the current
     # migration.
     references: # Optional

WHATSNEW.md

@@ -29,6 +29,9 @@ Version 3.0.0
 
     * ez_migration.step_executed => listeners receive a StepExecutedEvent event instance
 
+* Fixed: migrations will not silently swallow any more errors when creating users or assigning roles and an inexisting
+    group is specified
+
 * New: it is now possible to add resolvers for custom references using tagged services. The tag to use is: 
     `ez_migration_bundle.reference_resolver.customreference`. 
     For an example, see the test UnitTestOK010_customrefs.yml and class 
@@ -74,12 +77,6 @@ Version 3.0.0
     * references to 'tag:' and 'location:' will not be resolved any more in fields of type Object Relation and 
         Object Relation List. On the other hand non-integer strings will be resolved as remote-content-ids
 
-    * custom references are not resolved any more in the values for scalar fields when creating/updating content.
-        The old behaviour was inconsistent, as references were resolved by default for scalar values but not for
-        array values.
-        If you need to have reference resolution in your content field values, you will have to register a custom field
-        type handler using a tagged service (see services.yml for how the current handlers do it) and do it yourself 
-
     * changes for developers who extended the bundle: the MatcherInterface and ReferenceResolverInterface have a new
         method each; many Executor services now have a different constructor signature; one Trait has been removed from
         the public API; the service ez_migration_bundle.helper.role_handler has been renamed