diff --git a/modules/salesforce_mapping/salesforce_mapping.module b/modules/salesforce_mapping/salesforce_mapping.module
index 329498ed2ebd52f9662972695c86d25053916c2a..c72a21e47a95ff0d53e8bc03393253c8ded64464 100644
--- a/modules/salesforce_mapping/salesforce_mapping.module
+++ b/modules/salesforce_mapping/salesforce_mapping.module
@@ -24,6 +24,8 @@ const SALESFORCE_MAPPING_SYNC_SF_CREATE = 'pull_create';
const SALESFORCE_MAPPING_SYNC_SF_UPDATE = 'pull_update';
const SALESFORCE_MAPPING_SYNC_SF_DELETE = 'pull_delete';
+const SALESFORCE_MAPPING_TRIGGER_MAX_LENGTH = 16;
+
/**
* Field mapping direction constants.
*/
@@ -46,6 +48,11 @@ const SALESFORCE_MAPPING_ARRAY_DELIMITER =';';
*/
const SALESFORCE_MAPPING_NAME_LENGTH = 128;
+
+const SALESFORCE_MAPPING_STATUS_SUCCESS = 1;
+const SALESFORCE_MAPPING_STATUS_ERROR = 0;
+
+
/**
* Implements hook_entity_type_alter().
*/
diff --git a/modules/salesforce_mapping/src/Entity/MappedObject.php b/modules/salesforce_mapping/src/Entity/MappedObject.php
index 8e8cc119279cb1442943ecc234dcacb5f4a7c37c..3ced30b3961a15c7cde36ebb8a2f6af9cde83ba9 100644
--- a/modules/salesforce_mapping/src/Entity/MappedObject.php
+++ b/modules/salesforce_mapping/src/Entity/MappedObject.php
@@ -180,6 +180,18 @@ class MappedObject extends RevisionableContentEntityBase implements MappedObject
'weight' => $i++,
]);
+ $fields['last_sync_status'] = BaseFieldDefinition::create('boolean')
+ ->setLabel(t('Status of most recent sync'))
+ ->setDescription(t('Indicates whether most recent sync was successful or not.'))
+ ->setRevisionable(TRUE);
+
+ $fields['last_sync_action'] = BaseFieldDefinition::create('string')
+ ->setLabel(t('Action of most recent sync'))
+ ->setDescription(t('Indicates acion which triggered most recent sync for this mapped object'))
+ ->setSetting('is_ascii', TRUE)
+ ->setSetting('max_length', SALESFORCE_MAPPING_TRIGGER_MAX_LENGTH)
+ ->setRevisionable(TRUE);
+
// @see ContentEntityBase::baseFieldDefinitions
// and RevisionLogEntityTrait::revisionLogBaseFieldDefinitions
$fields += parent::baseFieldDefinitions($entity_type);
@@ -214,7 +226,7 @@ class MappedObject extends RevisionableContentEntityBase implements MappedObject
}
public function push() {
- // @TODO need error handling, logging, and hook invocations within this function, where we can provide full context. At the very least, we need to make sure to include $params in some kind of exception if we're not going to handle it inside this function.
+ // @TODO need error handling, logging, and hook invocations within this function, where we can provide full context, or short of that clear documentation on how callers should handle errors and exceptions. At the very least, we need to make sure to include $params in some kind of exception if we're not going to handle it inside this function.
// @TODO better way to handle push/pull:
$client = \Drupal::service('salesforce.client');
@@ -265,13 +277,14 @@ class MappedObject extends RevisionableContentEntityBase implements MappedObject
// @TODO: where to get entity updated timestamp?
$this->set('entity_updated', $drupal_entity->getChangedTime());
}
+ // dpm($result);
// @TODO restore last_sync_action, last_sync_status, last_sync_message
// @TODO: catch EntityStorageException ? Others ?
$this
->set('salesforce_id', $result['id'])
- // ->set('last_sync_action', $action)
- // ->set('last_sync_status', 'success')
+ ->set('last_sync_action', 'push_' . $action)
+ ->set('last_sync_status', TRUE)
// ->set('last_sync_message', '')
->save();
@@ -281,12 +294,13 @@ class MappedObject extends RevisionableContentEntityBase implements MappedObject
public function pushDelete() {
$client = \Drupal::service('salesforce.client');
$mapping = $this->salesforce_mapping->entity;
- $client->objectDelete($mapping->getSalesforceObjectType(), $this->sfid());
+ $result = $client->objectDelete($mapping->getSalesforceObjectType(), $this->sfid());
$this
- // ->set('last_sync_action', 'delete')
- // ->set('last_sync_status', 'success')
- // ->set('last_sync_message', '')
+ ->set('last_sync_action', 'push_delete')
+ ->set('last_sync_status', TRUE)
->save();
+
+ return $result;
}
public function pull(array $sf_object = NULL, EntityInterface $drupal_entity = NULL) {
diff --git a/modules/salesforce_mapping/src/Entity/SalesforceMapping.php b/modules/salesforce_mapping/src/Entity/SalesforceMapping.php
index 70b8c389fccbcb986a693a31461e9752cacfa5c8..503ce28dadee22d1472cc4fa29900f3855419d1e 100644
--- a/modules/salesforce_mapping/src/Entity/SalesforceMapping.php
+++ b/modules/salesforce_mapping/src/Entity/SalesforceMapping.php
@@ -329,8 +329,6 @@ class SalesforceMapping extends ConfigEntityBase implements SalesforceMappingInt
SALESFORCE_MAPPING_SYNC_SF_DELETE
];
}
- dpm($ops);
- dpm($this->sync_triggers);
return !empty(array_intersect($ops, array_keys(array_filter($this->sync_triggers))));
}
diff --git a/modules/salesforce_push/salesforce_push.module b/modules/salesforce_push/salesforce_push.module
index 1f2c91f588c81526c7aa05277fba7bdd4368a170..80f63bde5189e2b15af5798a8bfa9231ad717023 100644
--- a/modules/salesforce_push/salesforce_push.module
+++ b/modules/salesforce_push/salesforce_push.module
@@ -8,6 +8,7 @@
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\salesforce_mapping\Entity;
+use GuzzleHttp\Exception\RequestException;
/**
* Implements hook_entity_insert().
@@ -42,25 +43,18 @@ function salesforce_push_salesforce_push_entity_allowed(EntityInterface $entity,
/**
* Push entities to Salesforce.
*
- * @param object $entity
+ * @param EntityInterface $entity
* The entity object.
- * @param int $op
+ * @param string $op
* The trigger being responded to.
* One of push_create, push_update, push_delete.
* @TODO
* at some point all these hook_entity_* implementations will go away. We'll
* create an event subscriber class to respond to entity events and delegate
- * actions to the appropriate Push procedures.
+ * actions to the appropriate Push procedures. Unfortunately this point seems
+ * to be a very long ways away. https://www.drupal.org/node/2551893
*/
function salesforce_push_entity_crud(EntityInterface $entity, $op) {
-
- // @TODO decide whether this hook is worth moving to Events framework, and how. Should subscribers throw an exception to prevent entity sync? Return false, like so? Something else entirely?
- foreach (\Drupal::moduleHandler()->invokeAll('salesforce_push_entity_allowed', array($entity, $op)) as $value) {
- if ($value === FALSE) {
- return;
- }
- }
-
try {
$mappings = salesforce_mapping_load_by_drupal($entity->getEntityTypeId());
}
@@ -75,60 +69,83 @@ function salesforce_push_entity_crud(EntityInterface $entity, $op) {
if (!$mapping->doesCrud([$op])) {
continue;
}
-
- try {
- $props = [
- 'entity_id' => $entity->id(),
- 'entity_type_id' => $entity->getEntityTypeId(),
- 'salesforce_mapping' => $mapping->id(),
- ];
- $mapped_objects = salesforce_mapped_object_load_multiple($props);
- // There should really only be one, but the return value is always an array
- $mapped_object = current($mapped_objects);
-
- if ($op == SALESFORCE_MAPPING_SYNC_DRUPAL_DELETE) {
- // If this is a delete, destroy the mapped object and we're done.
- $mapped_object->pushDelete();
- continue;
+ // @TODO decide whether this hook is worth moving to Events framework, and how. Should subscribers throw an exception to prevent entity sync? Return false, like so? Something else entirely?
+ foreach (\Drupal::moduleHandler()->invokeAll('salesforce_push_entity_allowed', array($entity, $op, $mapping)) as $value) {
+ if ($value === FALSE) {
+ continue 2;
}
}
- catch (Exception $e) {
- // No mappings found, need to create a new one and push...
- if ($op == SALESFORCE_MAPPING_SYNC_DRUPAL_DELETE) {
- // Unless it's a delete. Then we're done.
- continue;
- }
- $mapped_object = new MappedObject([
- 'entity_id' => [LanguageInterface::LANGCODE_DEFAULT => $entity->id()],
- 'entity_type_id' => [LanguageInterface::LANGCODE_DEFAULT => $entity->getEntityTypeId()],
- 'salesforce_mapping' => [LanguageInterface::LANGCODE_DEFAULT => $mapping->id()],
- ]);
- }
+ // @TODO batch vs. real-time logic goes here.
try {
- // Push to SF. This also saves the mapped object.
- $result = $mapped_object->push();
- // Do something with the result?
+ $mapped_object = salesforce_push_sync_rest($entity, $mapping, $op);
}
catch (Exception $e) {
- // @TODO As long as push is handled in MappedObject, this hook invocation should go there. We're only handling this exception so that we don't block the entity CRUD operation.
- continue;
+ // what do do here?
+ }
+ }
+}
- // $vars = [
- // 'entity' => $entity,
- // 'mapping' => $mapping,
- // 'params' => $params,
- // 'exception' => $e,
- // 'op' => $op,
- // ];
- //
- // // @TODO This should definitely be an event. See SalesforceEvents::PUSH_FAIL
- // \Drupal::moduleHandler()->invokeAll('salesforce_push_failure', array($e->getMessage(), $vars));
+/**
+ * Worker function to do actual push to Salesforce.
+ *
+ * @param EntityInterface $entity
+ * @param SalesforceMappingInterface $mapping
+ * @param string $op
+ * one of push_create, push_update, push_delete
+ * @return SF result
+ *
+ * @throws Exception if mapping object cannot be loaded or created
+ * @throws RequestException if push operations fail
+ */
+function salesforce_push_sync_rest(EntityInterface $entity, SalesforceMappingInterface $mapping, $op) {
+
+ // First, look for existing mapped object.
+ $props = [
+ 'entity_id' => $entity->id(),
+ 'entity_type_id' => $entity->getEntityTypeId(),
+ 'salesforce_mapping' => $mapping->id(),
+ ];
+ try {
+ $mapped_objects = salesforce_mapped_object_load_multiple($props);
+ // There should really only be one, but the return value is always an array
+ $mapped_object = current($mapped_objects);
+ }
+ catch (Exception $e) {
+ // No mappings found, need to create a new one and push...
+ if ($op == SALESFORCE_MAPPING_SYNC_DRUPAL_DELETE) {
+ // Unless it's a delete. Then we're done.
+ throw $e;
}
+ $mapped_object = new MappedObject([
+ 'entity_id' => [LanguageInterface::LANGCODE_DEFAULT => $entity->id()],
+ 'entity_type_id' => [LanguageInterface::LANGCODE_DEFAULT => $entity->getEntityTypeId()],
+ 'salesforce_mapping' => [LanguageInterface::LANGCODE_DEFAULT => $mapping->id()],
+ ]);
}
+ try {
+ // If this is a delete, destroy the SF object and we're done.
+ if ($op == SALESFORCE_MAPPING_SYNC_DRUPAL_DELETE) {
+ return $mapped_object->pushDelete();
+ }
+ else {
+ // Push to SF. This also saves the mapped object.
+ return $mapped_object->push();
+ }
+ }
+ catch (RequestException $e) {
+ $mapped_object
+ ->set('last_sync_action', $op)
+ ->set('last_sync_status', FALSE)
+ ->set('last_sync_message', $e->getMessage())
+ ->save();
+ throw $e;
+ // @TODO Can we pawn this off to an entity_save hook? implementations can look at last_sync_status to determine success vs failure.
+ // \Drupal::moduleHandler()->invokeAll('salesforce_push_failure', array($e->getMessage(), $vars));
+ }
}
/**
diff --git a/src/RestClient.php b/src/RestClient.php
index 518b17f449ccdd5be30113eb0c1c88a9ccf3e03d..695a0886b56d8c88c4b98eaee4d4701badf0b9b2 100644
--- a/src/RestClient.php
+++ b/src/RestClient.php
@@ -71,9 +71,8 @@ class RestClient {
* Method to initiate the call, such as GET or POST. Defaults to GET.
*
* @return mixed
- * The requested response.
*
- * @throws Exception
+ * @throws GuzzleHttp\Exception\RequestException
*/
public function apiCall($path, array $params = [], $method = 'GET') {
if (!$this->getAccessToken()) {
@@ -81,13 +80,12 @@ class RestClient {
}
try {
- $this->response = $this->apiHttpRequest($path, $params, $method);
+ $this->response = new RestResponse($this->apiHttpRequest($path, $params, $method));
}
catch (RequestException $e) {
- // A RequestException gets thrown if the response has any error status.
- $this->response = $e->getResponse();
+ // RequestException gets thrown for any response status but 2XX
+ $this->response = new RestResponse($e->getResponse());
}
-
if (!is_object($this->response)) {
throw new Exception('Unknown error occurred during API call');
}
@@ -102,8 +100,8 @@ class RestClient {
$this->response = $this->apiHttpRequest($path, $params, $method);
}
catch (RequestException $e) {
- $this->response = $e->getResponse();
- throw new Exception($this->response->getReasonPhrase(), $this->response->getStatusCode());
+ $this->response = new RestResponse($e->getResponse());
+ throw $e;
}
break;
case 200:
@@ -118,15 +116,7 @@ class RestClient {
throw new Exception('Unknown error occurred during API call');
}
}
-
- // Parse a json response, if body is not empty. Sometimes an empty body is valid, e.g. for upsert.
- $data = '';
- $response_body = $this->response->getBody()->getContents();
- if (!empty($response_body)) {
- $this->response->getBody()->rewind();
- $data = $this->handleJsonResponse($this->response);
- }
- return $data;
+ return $this->response->data();
}
/**
@@ -139,8 +129,7 @@ class RestClient {
* @param string $method
* Method to initiate the call, such as GET or POST. Defaults to GET.
*
- * @return object
- * The requested data.
+ * @return GuzzleHttp\Psr7\Response
*/
protected function apiHttpRequest($path, array $params, $method) {
if (!$this->getAccessToken()) {
@@ -174,13 +163,12 @@ class RestClient {
*
* @throws RequestException
*
- * @return object
- * Salesforce response object.
+ * @return GuzzleHttp\Psr7\Response
*/
protected function httpRequest($url, $data = NULL, array $headers = [], $method = 'GET') {
// Build the request, including path and headers. Internal use.
- $request = $this->httpClient->$method($url, ['headers' => $headers, 'body' => $data]);
- return $request;
+ $response = $this->httpClient->$method($url, ['headers' => $headers, 'body' => $data]);
+ return $response;
}
/**
@@ -330,7 +318,7 @@ class RestClient {
throw new Exception($response->getReasonPhrase(), $response->getStatusCode());
}
- $data = $this->handleJsonResponse($response);
+ $data = (new RestResponse($response))->data();
$this
->setAccessToken($data['access_token'])
@@ -344,39 +332,6 @@ class RestClient {
return $this;
}
- /**
- * Helper function to eliminate repetitive json parsing.
- *
- * @param Response $response
- * @return array
- * @throws Drupal\salesforce\Exception
- */
- private function handleJsonResponse($response) {
- // Allow any exceptions here to bubble up:
- $data = Json::decode($response->getBody()->getContents());
- if (empty($data)) {
- throw new Exception('Invalid response ' . print_r($response->getBody()->getContents(), 1));
- }
-
- if (isset($data['error'])) {
- throw new Exception($data['error_description'], $data['error']);
- }
-
- if (!empty($data[0]) && count($data) == 1) {
- $data = $data[0];
- }
-
- if (isset($data['error'])) {
- throw new Exception($data['error_description'], $data['error']);
- }
-
- if (!empty($data['errorCode'])) {
- throw new Exception($data['message'], $this->response->getStatusCode());
- }
-
- return $data;
- }
-
/**
* Retrieve and store the Salesforce identity given an ID url.
*
@@ -395,8 +350,8 @@ class RestClient {
if ($response->getStatusCode() != 200) {
throw new Exception(t('Unable to access identity service.'), $response->getStatusCode());
}
+ $data = (new RestResponse($response))->data();
- $data = $this->handleJsonResponse($response);
$this->setIdentity($data);
return $this;
}
@@ -477,7 +432,7 @@ class RestClient {
$result = $cache->data;
}
else {
- $result = $this->apiCall('sobjects');
+ $response = $this->apiCall('sobjects');
\Drupal::cache()->set('salesforce:objects', $result, 0, ['salesforce']);
}
diff --git a/src/RestException.php b/src/RestException.php
new file mode 100644
index 0000000000000000000000000000000000000000..7d3c073f6e32ac114724537d298ee411b8e01f02
--- /dev/null
+++ b/src/RestException.php
@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\salesforce\Exception.
+ */
+
+namespace Drupal\salesforce;
+
+use Symfony\Component\Serializer\Exception\Exception as SymfonyException;
+
+class RestException extends \RuntimeException implements SymfonyException {
+
+ protected $response;
+
+ function __construct(RestResponse $response, $message = "", $code = 0, Throwable $previous = NULL) {
+ parent::__construct($message, $code, $previous);
+ $this->response = $response;
+ }
+}
diff --git a/src/RestResponse.php b/src/RestResponse.php
new file mode 100644
index 0000000000000000000000000000000000000000..f55ee226fc97a0e7c0b1273e2a1e686eb4c7a869
--- /dev/null
+++ b/src/RestResponse.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace Drupal\salesforce;
+
+use GuzzleHttp\Psr7\Response;
+use Drupal\Component\Serialization\Json;
+
+class RestResponse extends Response {
+
+ protected $response;
+ protected $data;
+
+ /**
+ * {@inheritdoc}
+ * @throws RestException if body cannot be json-decoded
+ */
+ function __construct(Response $response) {
+ $this->response = $response;
+ parent::__construct($response->getStatusCode(), $response->getHeaders(), $response->getBody(), $response->getProtocolVersion(), $response->getReasonPhrase());
+ $this->handleJsonResponse();
+ }
+
+ /**
+ * Get the orignal response
+ *
+ * @return GuzzleHttp\Psr7\Response;
+ */
+ public function response() {
+ return $this->response;
+ }
+
+ /**
+ * Get the json-decoded data object from the response body
+ *
+ * @return stdObject
+ */
+ public function data() {
+ return $this->data;
+ }
+
+ /**
+ * Helper function to eliminate repetitive json parsing.
+ *
+ * @return $this
+ * @throws Drupal\salesforce\RestException
+ */
+ private function handleJsonResponse() {
+ $this->data = '';
+ $response_body = $this->getBody()->getContents();
+ if (empty($response_body)) {
+ return;
+ }
+
+ // Allow any exceptions here to bubble up:
+ try {
+ $data = Json::decode($response_body);
+ }
+ catch (UnexpectedValueException $e) {
+ throw new RestException($this, $e->getMessage(), $e->getCode(), $e);
+ }
+
+ if (empty($data)) {
+ throw new RestException($this, t('Invalid response'));
+ }
+
+ if (!empty($data['error'])) {
+ throw new RestException($this, $data['error']);
+ }
+
+ if (!empty($data[0]) && count($data) == 1) {
+ $data = $data[0];
+ }
+
+ if (!empty($data['error'])) {
+ throw new RestException($this, $data['error']);
+ }
+
+ if (!empty($data['errorCode'])) {
+ throw new RestException($this, $data['errorCode']);
+ }
+ $this->data = $data;
+ return $this;
+ }
+
+}
\ No newline at end of file