- Converts form-based validation to entity constraints for mapped objects

modules/salesforce_example/salesforce_example.module

@@ -101,12 +101,14 @@ function _salesforce_example_entity_manage(\Drupal\Core\Entity\EntityInterface &
 
     /** @var \Drupal\salesforce_mapping\Entity\MappedObject $entity */
     $mapped_entity = $entity->getMappedEntity();
-
+    if (!$mapped_entity) {
+      return;
+    }
     /**
      * Here we check to see if the entity that the SFDC Mapping Object dealt with was a Commerce Product
      * Variation.
      */
-    if($mapped_entity->getEntityTypeId() == 'commerce_product_variation') {
+    if ($mapped_entity->getEntityTypeId() == 'commerce_product_variation') {
       /** @var \Drupal\salesforce\SObject $sf */
       $sf = $entity->getSalesforceRecord();
 

modules/salesforce_mapping/src/Entity/MappedObject.php

@@ -59,7 +59,13 @@ use Drupal\salesforce_mapping\Plugin\Field\ComputedItemList;
  *      "id" = "id",
  *      "entity_id" = "drupal_entity__target_id",
  *      "salesforce_id" = "salesforce_id",
- *      "revision" = "revision_id"
+ *      "revision" = "revision_id",
+ *      "label" = "salesforce_id"
+ *   },
+ *   constraints = {
+ *     "MappingSfid" = {},
+ *     "MappingEntity" = {},
+ *     "MappingEntityType" = {}
  *   }
  * )
  */
@@ -475,7 +481,7 @@ class MappedObject extends RevisionableContentEntityBase implements MappedObject
 
     // @TODO better way to handle push/pull:
     $fields = $mapping->getPullFields();
-    $drupal_entity = $this->drupal_entity->entity ?: $this->getDrupalEntityStub();
+    $drupal_entity = $this->getMappedEntity() ?: $this->getDrupalEntityStub();
     foreach ($fields as $field) {
       try {
         $value = $field->pullValue($this->sf_object, $drupal_entity, $mapping);

modules/salesforce_mapping/src/Form/MappedObjectDeleteForm.php

@@ -45,7 +45,7 @@ class MappedObjectDeleteForm extends ContentEntityConfirmFormBase {
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {
     $mapped_object = $this->getEntity();
-    $form_state->setRedirect($mapped_object->getMappedEntity()->toUrl('salesforce')->toString());
+    $form_state->setRedirect($mapped_object->getMappedEntity()->toUrl()->toString());
     $message = 'MappedObject @sfid deleted.';
     $args = ['@sfid' => $mapped_object->salesforce_id->value];
     \Drupal::service('event_dispatcher')->dispatch(SalesforceEvents::NOTICE, new SalesforceNoticeEvent(NULL, $message, $args));

modules/salesforce_mapping/src/Form/MappedObjectForm.php

@@ -100,9 +100,10 @@ class MappedObjectForm extends ContentEntityForm {
     $drupal_entity = $entity_id = $entity_type_id = FALSE;
     dpm($form);
     if ($this->entity->isNew()) {
-      $drupal_entity = $this->getDrupalEntityFromUrl();
-      $form['drupal_entity']['widget'][0]['target_type']['#default_value'] = $drupal_entity->getEntityTypeId();
-      $form['drupal_entity']['widget'][0]['target_id']['#default_value'] = $drupal_entity;
+      if ($drupal_entity = $this->getDrupalEntityFromUrl()) {
+        $form['drupal_entity']['widget'][0]['target_type']['#default_value'] = $drupal_entity->getEntityTypeId();
+        $form['drupal_entity']['widget'][0]['target_id']['#default_value'] = $drupal_entity;
+      }
     }
 
     // Allow exception to bubble up here, because we shouldn't have got here if
@@ -150,23 +151,11 @@ class MappedObjectForm extends ContentEntityForm {
     $drupal_entity_array = $form_state->getValue(['drupal_entity', 0]);
     $entity = FALSE;
 
-    // Verify entity was specified
+    // Verify entity was given - required for push.
     if (empty($drupal_entity_array['target_id'])) {
       $form_state->setErrorByName('drupal_entity][0][target_id', t('Please specify an entity to push.'));
       return;
     }
-
-    // Get the mapping.
-    $mapping = $this->mappingStorage
-      ->load($form_state->getValue(['salesforce_mapping', 0, 'target_id']));
-
-    $this->validateUniqueEntityAndMapping($drupal_entity_array, $mapping, $form_state);
-
-    // If an SFID was given, verify that it's not already assigned to this mapping.
-    $sfid = $form_state->getValue(['salesforce_id', 0, 'value'], FALSE);
-    if ($sfid) {
-      $this->validateUniqueSfidAndMapping($sfid, $mapping, $form_state);
-    }
   }
 
   /**
@@ -182,71 +171,6 @@ class MappedObjectForm extends ContentEntityForm {
       $form_state->setErrorByName('salesforce_id', t('Please specify a Salesforce ID to pull.'));
       return;
     }
-
-    // Fetch mapping and verify that this SFID is not already mapped.
-    $mapping = $this->mappingStorage
-      ->load($form_state->getValue(['salesforce_mapping', 0, 'target_id']));
-    $this->validateUniqueSfidAndMapping($sfid, $mapping, $form_state);
-
-    // If entity was given, verify that it's not already mapped with this mapping.
-    $drupal_entity_array = $form_state->getValue(['drupal_entity', 0]);
-    if (!empty($drupal_entity_array['target_id'])) {
-      dpm($drupal_entity_array);
-      $this->validateUniqueEntityAndMapping($drupal_entity_array, $mapping, $form_state);
-    }
-  }
-
-
-  /**
-   * Helper method to verify a given entity-mapping combo is unique.
-   * Uses $form_state to set an error if not.
-   * @return NULL
-   */
-  protected function validateUniqueEntityAndMapping(array $entity_array, SalesforceMappingInterface $mapping, FormStateInterface $form_state) {
-    $entity = $this->entityTypeManager
-      ->getStorage($entity_array['target_type'])
-      ->load($entity_array['target_id']);
-    if ($existing_mapped_object = $this->mappedObjectStorage->loadByEntityAndMapping($entity, $mapping)) {
-      $url = Url::fromRoute('entity.salesforce_mapped_object.canonical', ['salesforce_mapped_object' => $existing_mapped_object->id()]);
-      $form_state->setErrorByName('drupal_entity][0][target_id', t('Mapped object already exists for this entity: <a href=":url">:sfid</a>', [':url' => $url->toString(), ':sfid' => $existing_mapped_object->sfid()]));
-    }    
-  }
-
-  /**
-   * Helper method to verify a given sfid-mapping combo is unique.
-   * uses $form_state to set an error if not.
-   * @return NULL
-   */
-  protected function validateUniqueSfidAndMapping($sfid, SalesforceMappingInterface $mapping, FormStateInterface $form_state) {
-    try {
-      $sfid = new SFID($sfid);
-    }
-    catch (\Exception $e) {
-      $form_state->setErrorByName('salesforce_id', t('The given value is not a valid Salesforce ID.'));
-      return;
-    }
-
-    if ($existing_mapped_object = $this->mappedObjectStorage->loadBySfidAndMapping(new SFID($sfid), $mapping)) {
-      $url = Url::fromRoute('entity.salesforce_mapped_object.canonical', ['salesforce_mapped_object' => $existing_mapped_object->id()]);
-      $form_state->setErrorByName('drupal_entity][0][target_id', t('Mapped object already exists for this SFID: <a href=":url">:sfid</a>', [':url' => $url->toString(), ':sfid' => $existing_mapped_object->sfid()]));
-    }
-  }
-
-  /**
-   * Verify that mapping was selected, and can be loaded successfully.
-   *
-   * @param array $form 
-   * @param FormStateInterface $form_state 
-   */
-  public function validateForm(array &$form, FormStateInterface $form_state) {
-    parent::validateForm($form, $form_state);
-
-    // Verify mapping and entity type match.
-    $mapping = $this->mappingStorage
-      ->load($form_state->getValue(['salesforce_mapping', 0, 'target_id']));
-    if ($mapping->getDrupalEntityType() != $form_state->getValue(['drupal_entity', 0, 'target_type'])) {
-      $form_state->setErrorByName('salesforce_mapping', t('Mapping %mapping can only be used with entity type %entity_type_id', ['%mapping' => $mapping->label(), '%entity_type_id' => $mapping->getDrupalEntityType()]));
-    }
   }
 
   /**
@@ -265,19 +189,6 @@ class MappedObjectForm extends ContentEntityForm {
     else {
       $mapped_object->set('salesforce_id', '');
     }
-    
-
-    // Validate mapped object. Upon failure, rebuild form.
-    // Do not pass go, do not collect $200.
-    $errors = $mapped_object->validate();
-
-    if ($errors->count() > 0) {
-      foreach ($errors as $error) {
-        drupal_set_message($error->getMessage(), 'error');
-      }
-      $form_state->setRebuild();
-      return;
-    }
 
     // Push to SF.
     try {
@@ -285,7 +196,6 @@ class MappedObjectForm extends ContentEntityForm {
       $mapped_object->push();
     }
     catch (\Exception $e) {
-      dpm($e);
       $mapped_object->delete();
       $this->eventDispatcher->dispatch(SalesforceEvents::ERROR, new SalesforceErrorEvent($e));
       drupal_set_message(t('Push failed with an exception: %exception', array('%exception' => $e->getMessage())), 'error');
@@ -305,8 +215,6 @@ class MappedObjectForm extends ContentEntityForm {
     $mapped_object = $this->entity
       ->set('salesforce_id', (string)new SFID($form_state->getValue(['salesforce_id', 0, 'value'])))
       ->set('salesforce_mapping', $form_state->getValue(['salesforce_mapping', 0, 'target_id']));
-    $errors = $mapped_object->validate();
-
     // Create stub entity.
     $drupal_entity_array = $form_state->getValue(['drupal_entity', 0]);
     if ($drupal_entity_array['target_id']) {
@@ -323,14 +231,6 @@ class MappedObjectForm extends ContentEntityForm {
       $mapped_object->setDrupalEntityStub($drupal_entity);
     }
 
-    if ($errors->count() > 0) {
-      foreach ($errors as $error) {
-        drupal_set_message($error->getMessage(), 'error');
-      }
-      $form_state->setRebuild();
-      return;
-    }
-
     try {
       // Pull from SF. Save first to pass local validation.
       $mapped_object->save();

modules/salesforce_mapping/src/Plugin/Validation/Constraint/MappingEntityConstraint.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+/**
+ * Checks if a set of entity fields has a unique value.
+ *
+ * @Constraint(
+ *   id = "MappingEntity",
+ *   label = @Translation("Mapping-SFID unique fields constraint", context = "Validation"),
+ *   type = {"entity"}
+ * )
+ */
+class MappingEntityConstraint extends UniqueFieldsConstraint {
+
+  public function __construct($options = NULL) {
+    $options = ['fields' => ["drupal_entity.target_type", "drupal_entity.target_id", "salesforce_mapping"]];
+    parent::__construct($options);
+  }
+
+}
\ No newline at end of file

modules/salesforce_mapping/src/Plugin/Validation/Constraint/MappingEntityTypeConstraint.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Checks if a set of entity fields has a unique value.
+ *
+ * @Constraint(
+ *   id = "MappingEntityType",
+ *   label = @Translation("Mapping-EntityType match constraint", context = "Validation"),
+ *   type = {"entity"}
+ * )
+ */
+class MappingEntityTypeConstraint extends Constraint {
+
+  public $message = 'Mapping %mapping cannot be used with entity type %entity_type.';
+
+}
\ No newline at end of file

modules/salesforce_mapping/src/Plugin/Validation/Constraint/MappingEntityTypeConstraintValidator.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+
+/**
+ * Validates that a salesforce mapping matches entity type of the given entity.
+ */
+class MappingEntityTypeConstraintValidator extends ConstraintValidator {
+
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validate($entity, Constraint $constraint) {
+    $drupal_entity = $entity->getMappedEntity() ?: $entity->getDrupalEntityStub();
+    if ($drupal_entity->getEntityTypeId() != $entity->getMapping()->getDrupalEntityType()) {
+      $this->context->addViolation($constraint->message, [
+        '%mapping' => $entity->getMapping()->label(),
+        '%entity_type' => $drupal_entity->getEntityType()->getLabel()
+      ]);
+    }
+  }
+
+}
\ No newline at end of file

modules/salesforce_mapping/src/Plugin/Validation/Constraint/MappingSfidConstraint.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+/**
+ * Checks if a set of entity fields has a unique value.
+ *
+ * @Constraint(
+ *   id = "MappingSfid",
+ *   label = @Translation("Mapping-SFID unique fields constraint", context = "Validation"),
+ *   type = {"entity"}
+ * )
+ */
+class MappingSfidConstraint extends UniqueFieldsConstraint {
+
+  public function __construct($options = null) {
+    $options = ['fields' => ['salesforce_id', 'salesforce_mapping']];
+    parent::__construct($options);
+  }
+
+}
\ No newline at end of file

modules/salesforce_mapping/src/Plugin/Validation/Constraint/UniqueFieldsConstraint.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Checks if a set of entity fields has a unique value.
+ *
+ * @Constraint(
+ *   id = "UniqueFields",
+ *   label = @Translation("Unique fields constraint", context = "Validation"),
+ *   type = {"entity"}
+ * )
+ */
+class UniqueFieldsConstraint extends Constraint {
+
+  public $message = 'A @entity_type already exists: <a href=":url">@label</a>';
+
+  public $fields;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getRequiredOptions() {
+    return ['fields'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getDefaultOption() {
+    return 'fields';
+  }
+
+  public function validatedBy() {
+    return '\Drupal\salesforce_mapping\Plugin\Validation\Constraint\UniqueFieldsConstraintValidator';
+  }
+
+}
\ No newline at end of file

modules/salesforce_mapping/src/Plugin/Validation/Constraint/UniqueFieldsConstraintValidator.php

+<?php
+
+namespace Drupal\salesforce_mapping\Plugin\Validation\Constraint;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+
+/**
+ * Validates that a set of fields are unique for the given entity type.
+ */
+class UniqueFieldsConstraintValidator extends ConstraintValidator {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validate($entity, Constraint $constraint) {
+    $entity_type = $entity->getEntityType();
+    $id_key = $entity_type->getKey('id');
+
+    $query = \Drupal::entityQuery($entity_type->id())
+      // The id could be NULL, so we cast it to 0 in that case.
+      ->condition($id_key, (int) $entity->id(), '<>')
+      ->range(0, 1);
+
+    foreach ($constraint->fields as $field) {
+      $field_name = $field;
+      $property = '';
+      if (strpos($field_name, '.')) {
+        list($field_name, $property) = explode('.', $field_name, 2);
+      }
+      else {
+        $property = $entity->{$field}->getFieldDefinition()->getMainPropertyName();
+      }
+      $value = $entity->{$field_name}->{$property};
+      $query->condition($field, $value);
+    }
+
+    if ($id = $query->execute()) {
+      $id = reset($id);
+      $entity = \Drupal::entityTypeManager()
+        ->getStorage($entity_type->id())
+        ->load($id);
+      $url = $entity->toUrl();
+      $message_replacements = [
+        '@entity_type' => $entity_type->getLowercaseLabel(),
+        ':url' => $url->toString(),
+        '@label' => $entity->label()
+      ];
+      $this->context->addViolation($constraint->message, $message_replacements);
+    }
+  }
+
+}