scottrigby / aws_sqs_entity

Amazon SQS Entity (Drupal module)

Amazon SQS Entity

Dependencies

• AWS Simple Queue Service
• Composer Manager
• composer (drush extension)

Installation & Setup

1. Follow setup instructions for AWS Simple Queue Service module.
2. Set the AWS SQS Entity queue name. This can be done either:
   • With drush: drush vset aws_sqs_entity_queue_name YOUR_QUEUE_NAME
   • In your settings file: $conf['aws_sqs_entity_queue_name'] = 'YOUR_QUEUE_NAME';
   • Using the settings form at admin/config/system/aws-sqs-entity.
3. Set rules for your allowed list of Entity types, bundles, and CRUD operations.
   • Similar options as above. See \Drupal\aws_sqs_entity\Entity\CrudQueue::setRules() for documentation.

Required Patches

Please apply below patches if you encounter to any error or warning.

• Entity API
  • EntityMetadataWrapperException: Parent Data Structure Not Set https://www.drupal.org/files/issues/entity-on-exception-return-null-1596594-62.patch

aws_sqs_entity's Issues

hook_aws_sqs_entity_send_item() could pass more context

After we send an item to SQS, on this line we invoke the hook hook_aws_sqs_entity_send_item (bottom line of code snippet).

public function sendItem() {
    // Always a required step before attempting to create a queue item.
    $this->createQueue();
    $data = $this->getMessageBody();
    if ($result = $this->createItem($data)) {
      // Pass original keys to notification hook. This hook could allow, for
      // example, various kinds of reporting.
      module_invoke_all('aws_sqs_entity_send_item', $this->type, $this->entity, $this->op);

For the sake of using this hook to trigger reporting, it would be nice if the hook had more context, specifically:
A. The return status of the publish action (success or failure)
B. The message body that was sent

We could

1. add these two parameters to the hook
2. pass the CrudQueue object $this, from which many other things can be found
3. Other?