Create a shipment notification when shipment is completed

#7 for me is working fine

We can now significantly reduce the size of this patch thanks to #3017080: Create a service for sending emails to customers.

EDIT: Here's the change record https://www.drupal.org/node/3030431

I have changed this patch to now use commerce mail service. It is not quite reliable for me yet.

TODO: Tests need to be written to verify final email output contents.

The interdiff contains only the new test, which will fail because the email functionality has not yet been introduced.

Tests are failing because of a change in commerce. You can see 2 tests fail for the interdiff but only 1 for patch 13.

Patch re-roll...

Is anyone else interested in moving this forward? I could sure use this functionality...

What actually causes the email to be sent? I've patched my installation using the patch from #19 and processed an order. I edited the shipment to include the USPS tracking number, saved it, and hit "Send shipment" when done. I went back to the order and hit "Fulfill order". I didn't see any errors, but I didn't see any email - and I checked my server log, too.

Looking at the patch, it creates a subscriber for the "commerce_shipment.ship.post_transition" event. I can't find any code that dispatches that event, though. Did I miss another patch that adds code to dispatch the event, or is this something that's still needed for this patch?

Minor update to the patch to properly center one of the tables in the twig template...

Can this be moved to "needs review"? I have it installed and it seems to be working fine.

We've tested this patch.

Initially did not seem to work. But after reviewing that there's an option to turn this feature on in shipment type all seems to be working well.

Good job and thanks.

I've deployed this patch on my site and it seems to be working fine.

The patch is working perfectly for us. Thanks!

Quick review. Going to work on a reroll.

It looks like the test from #13 went missing.

1. +++ b/src/EventSubscriber/ShipmentSubscriber.php
   @@ -0,0 +1,140 @@
   +  /**
   +   * The entity type manager.
   +   *
   +   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   +   */
   +  protected $entityTypeManager;
   ...
   +    $this->entityTypeManager = $entity_type_manager;
   

   The entity type manager is not used directly outside of the constructor, we don't need it as a property.

2. +++ b/src/EventSubscriber/ShipmentSubscriber.php
   @@ -0,0 +1,140 @@
   +  /**
   +   * The language manager.
   +   *
   +   * @var \Drupal\Core\Language\LanguageManagerInterface
   +   */
   +  protected $languageManager;
   ...
   +  /**
   +   * The renderer.
   +   *
   +   * @var \Drupal\Core\Render\Renderer
   +   */
   +  protected $renderer;
   ...
   +    $this->languageManager = $language_manager;
   ...
   +    $this->renderer = $renderer;
   

   These services aren't used, it seems.

3. +++ b/src/EventSubscriber/ShipmentSubscriber.php
   @@ -0,0 +1,140 @@
   +    $subject = $this->t('Item(s) for Order #@number shipped!', ['@number' => $order->getOrderNumber()]);
   

   We can use formatPlural for "Item(s)"

4. +++ b/src/EventSubscriber/ShipmentSubscriber.php
   @@ -0,0 +1,140 @@
   +      // TODO This might not be necessary.
   

   Remove the TODO, it's fine to pass as context for anyone altering the mail. We may even want to pass the shipment as a param as well.

5. +++ b/src/Form/ShipmentTypeForm.php
   @@ -82,6 +82,21 @@ class ShipmentTypeForm extends CommerceBundleEntityFormBase {
   +      '#default_value' => ($shipment_type->isNew()) ? TRUE : $shipment_type->shouldSendConfirmation(),
   ...
   +      '#default_value' => ($shipment_type->isNew()) ? '' : $shipment_type->getConfirmationBcc(),
   

   We do not need the extra parentheses around the condition.

6. +++ b/templates/commerce-shipment-notification.html.twig
   @@ -0,0 +1,104 @@
   +<table style="margin: 15px auto 0 auto; max-width: 768px; font-family: arial,sans-serif">
   +    <tbody>
   +    <tr>
   +        <td>
   

   Seems like the indentation is off for the file.

7. +++ b/templates/commerce-shipment-notification.html.twig
   @@ -0,0 +1,104 @@
   +                        {{ 'Item(s) in your order #@number have been shipped!'|t({'@number': order_entity.getOrderNumber}) }}
   ...
   +                                        {{ 'Item(s) in shipment:'|t }}
   

   again, get can use formatPlural utilities

🙌 IntelliJ's patch tool got the last patch to apply. I made my changes per #25: added the test back, using format plural utilities, removed unused services.

Tests need updating since we added reusable profiles. And I made a syntax whoopsies

+++ b/tests/src/FunctionalJavascript/ShipmentAdminTest.php
@@ -307,7 +311,7 @@ class ShipmentAdminTest extends CommerceWebDriverTestBase {
-    list($order_item) = $this->order->getItems();
+    [$order_item] = $this->order->getItems();

Ope.

This should fix the test and syntax.

There are some phpcs items to fix on commit. I think this is ready to commit.

1. +++ b/commerce_shipping.module
   @@ -283,6 +283,14 @@ function commerce_shipping_theme() {
   +    ]
   

   needs comma

2. +++ b/src/EventSubscriber/ShipmentSubscriber.php
   @@ -0,0 +1,119 @@
   +use Drupal\Core\Language\LanguageManagerInterface;
   ...
   +use Drupal\Core\Render\Renderer;
   

   Unused

I've tested the patch from #28 on my site. It works fine.

Looks good so far. A few things about this feature:

• Core commerce has a "resend receipt" action, we should be able to re-send shipping notification
• We should extend the template to have better language when the shipment includes all order items, is the only shipment, or has only one item in it

Here's some twig code I've been playing with. I'm not sure it's the right way to go, but it's how I'm overriding the template in my site.

{% if(shipment_entity.getItems().length > 1) %}
                        {{ 'Items in your order #@number have been shipped!'|t({'@number': order_entity.getOrderNumber}) }}
                        {% else %}
                        {{ 'An item in your order #@number has been shipped!'|t({'@number': order_entity.getOrderNumber}) }}
                        {% endif %}

31.1 good point! We should add this now versus later

32.2 we have format plural logic. That should cover the usage. Is it not for you? We're missing test coverage there as well I think.

On mobile, but worth kicking back to add the action and ensure test coverage

Receiving the following error on the latest patch.

Drupal\Component\Plugin\Exception\PluginNotFoundException: The "commerce_shipment_type" entity type does not exist. in Drupal\Core\Entity\EntityTypeManager->getDefinition() (line 150 of /home/mysite/public_html/core/lib/Drupal/Core/Entity/EntityTypeManager.php).

Did I miss something on the patch?

Tracked the issue down.

We had issues with updating core. We had to perform a manual update which caused commerce to be removed.
We reinstalled commerce 2.16 instead of the dev version.
Patch applied properly but is now receiving the following errors. (understandably it's likely caused by patching 2.16 instead of dev.)

Error: Call to undefined method Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderPercentageOff::isDisplayInclusive() in Drupal\commerce_shipping\EventSubscriber\PromotionSubscriber->Drupal\commerce_shipping\EventSubscriber\{closure}() (line 119 of /home/mysite/public_html/modules/contrib/commerce_shipping/src/EventSubscriber/PromotionSubscriber.php)

Warning: assert(): assert($offer instanceof ShipmentPromotionOfferInterface) failed in Drupal\commerce_shipping\EventSubscriber\PromotionSubscriber->Drupal\commerce_shipping\EventSubscriber\{closure}() (line 117 of /home/mysite/public_html/modules/contrib/commerce_shipping/src/EventSubscriber/PromotionSubscriber.php)

When trying to install the dev version of commerce and commerce shipping we are now receiving dependency issues.

Problem 1
- drupal/commerce_cart 2.16.0 requires drupal/commerce 2.16.0 -> satisfiable by drupal/commerce[2.16.0] but these conflict with your requirements or minimum-stability.
- drupal/commerce_cart 2.16.0 requires drupal/commerce 2.16.0 -> satisfiable by drupal/commerce[2.16.0] but these conflict with your requirements or minimum-stability.
- drupal/commerce_cart 2.16.0 requires drupal/commerce 2.16.0 -> satisfiable by drupal/commerce[2.16.0] but these conflict with your requirements or minimum-stability.
- Installation request for drupal/commerce_cart (locked at 2.16.0) -> satisfiable by drupal/commerce_cart[2.16.0].

Is it possible to directly modify the composer.lock so we can change module and dependencies to the dev version?

Thanks

It seems that the email is always sent to anonymous user in English even when default site language is not English and the guest completed the order in another language. Is it the same issue than with order receipt here: https://www.drupal.org/project/commerce/issues/3031195

There is a bug in the provided template. Shipping item quantity is always returned as integer even when it is a decimal value. Instead of just shipping_item.getQuantity|number_format is should be something like this:

{% if shipping_item.getQuantity|number_format != shipping_item.getQuantity|round(2) %}
{{ shipping_item.getQuantity|number_format(2, '.', ',') }}
{% else %}
{{ shipping_item.getQuantity|number_format }}
{% endif %}

Decimal value quantities are non-standard. We also use number_format in the default order receipt. Any project utilizing decimal quantities will have to override this template, just like the order receipt template and any other customizations that had to be made.

What do you mean decimal value quantities are non-standard? They are standard since Drupal 8. There is no need for additional modules like before.

#28 works as expected! The only problem is when you place an order as anonymous user, in that case the email come in english (instead of user preferred language). To fix this you can edit /src/EventSubscriber/ShipmentSubscriber.php from line 109 like that:

'id' => 'shipment_confirmation',
      'from' => $order->getStore()->getEmail(),
      'bcc' => $shipment_type->getConfirmationBcc(),
      'order' => $order,
      'shipment' => $shipment,
    ];
    $customer = $order->getCustomer();
     if ($customer->isAuthenticated()) {
       $params['langcode'] = $customer->getPreferredLangcode();
     }
     $this->mailHandler->sendMail($to, $subject, $body, $params);
  }

}

To be more clear:

'id' => 'shipment_confirmation',
      'from' => $order->getStore()->getEmail(),
      'bcc' => $shipment_type->getConfirmationBcc(),
-    'langcode' => $order->getCustomer()->getPreferredLangcode(),
      'order' => $order,
      'shipment' => $shipment,
     ];
+    $customer = $order->getCustomer();
+    if ($customer->isAuthenticated()) {
+      $params['langcode'] = $customer->getPreferredLangcode();
+    }
     $this->mailHandler->sendMail($to, $subject, $body, $params);
   }
 

Patch #28 work on last RC1 release and PHP 7.3. Also work my fix for anonymous user (language) in /src/EventSubscriber/ShipmentSubscriber.php from line 109

'id' => 'shipment_confirmation',
      'from' => $order->getStore()->getEmail(),
      'bcc' => $shipment_type->getConfirmationBcc(),
-    'langcode' => $order->getCustomer()->getPreferredLangcode(),
      'order' => $order,
      'shipment' => $shipment,
     ];
+    $customer = $order->getCustomer();
+    if ($customer->isAuthenticated()) {
+      $params['langcode'] = $customer->getPreferredLangcode();
+    }
     $this->mailHandler->sendMail($to, $subject, $body, $params);
}

Patch #28 + language fix for anonymous user, please test it

Does this patch works with latest commerce 2.19?

Does this patch works with latest commerce 2.19?

I'm using the patch from #28 with Drupal Commerce 8.x-2.20 and Commerce Shipping 8.x-2.0-rc1. It works fine.

Thanks to everyone who's contributed to this issue, this is a super useful feature.

I have implemented the "Resend notification" button in the operations dropdown on the shipments page, as this was helpful when creating and testing a custom shipment notification email template.

I have also refactored the notification mail into its own ShipmentNotificationMail service, based on the OrderReceiptMail service.

The patch also includes the language changes from #39-41 but the interdiff is from #28.

The patch in #45 seems to be working for my normal workflow. The only unexpected thing I noticed was that the "Resend notification" button in the operations dropdown (thanks, this is a nice feature!) is available even when I haven't sent the shipment notification for the first time. I haven't tried to resend a notification yet.

@Sah it works perfectly for re-sending the notification.

Patch 45 with Resend notification works perfectly.
However, is it possible to also send a copy to the email addresses that were configured to receive a copy as well?

Thanks

Edit: Looking over the patch, it looks like the BCC email address were included for the new Resend notification feature. However, our tests so far does not receive any email notifications that were resent to customers.

The BCC mail is only sent on the original notification, not the resend. This is the same as the order receipt functionality in Commerce Order, the BCC mail is never resent there either.

Just tested it with current dev and it works great. After patched, I need to go into Shipment Type setting to enable " Send customer an email confirmation when shipped" so that the email will automatically send to customer when we click on send button.

Then, we can resend the same email to customer using "Resend notification" button in the Operations.

I've been reviewing this today in preparation for the next RC release and made minor adjustments:

1. I fixed several phpcs violations and small issues with the comments (Wrong class name in constructor).
2. I renamed "notification" to "confirmation" everywhere for consistency. Shipment notification is too generic, and the shipping module might deliver additional notifications in the future. So now we have "resend confirmation", the template is now commerce-shipment-confirmation instead of commerce-shipment-notification for example.

Thanks everyone!! This is now committed!!

Does this support urls for tracking links to different shipping companies tracking pages like usps, ups, and FedEx?

Does this support urls for tracking links to different shipping companies tracking pages like usps, ups, and FedEx?

No, it doesn't. The tracking code is included in the email, but the code isn't wrapped with an HTML tag to turn it into a hyperlink - and you can't just add the tag to the twig template. To make it work, you need to know which shipping company is being used so that the URL references the right service.

However, if your shipping method plugin implements SupportsTrackingInterface and you write the getTrackingUrl() method then the linked URL should be passed through to the shipping confirmation email.

The USPS plugin appears to do both of those things, but I don't see a hyperlink in my shipment notifications. There's just the tracking code. Here's the code for the getTrackingUrl function:

  public function getTrackingUrl(ShipmentInterface $shipment) {
    $code = $shipment->getTrackingCode();
    if (!empty($code)) {
      // If the tracking code token exists, replace it with the code.
      if (strstr($this->configuration['options']['tracking_url'], '[tracking_code]')) {
        $url = str_replace('[tracking_code]', $code, $this->configuration['options']['tracking_url']);
      }
      else {
        // Otherwise, append the tracking code to the end of the URL.
        $url = $this->configuration['options']['tracking_url'] . $code;
      }

      return Url::fromUri($url);
    }
    return FALSE;
  }

Thanks sah62, I'll check out your solution. I appreciate you letting us know what worked for you!