UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29080

danbtl · 2020-07-11T17:39:21Z

Description (*)

The UPS Tracking API returns the activity status code "D" for delivered packages. The delivery properties of the tracking object should only be set if we see this status code. Otherwise packages that are still in transit show as delivered, incorrectly.

Consider the following extract of a UPS tracking API response:

...
    <Package>
      <TrackingNumber>*REMOVED*</TrackingNumber>
      <DeliveryIndicator>N</DeliveryIndicator>
      <Activity>
        <ActivityLocation>
          <Address>
            <City>Secaucus</City>
            <StateProvinceCode>NJ</StateProvinceCode>
            <CountryCode>US</CountryCode>
          </Address>
        </ActivityLocation>
        <Status>
          <StatusType>
            <Code>I</Code>
            <Description>Departed from Facility</Description>
          </StatusType>
          <StatusCode>
            <Code>DP</Code>
          </StatusCode>
        </Status>
        <Date>20200711</Date>
        <Time>034100</Time>
        <GMTDate>2020-07-11</GMTDate>
        <GMTTime>07:41:00</GMTTime>
        <GMTOffset>-04:00</GMTOffset>
        <NextScheduleActivity>
          <Date>2020-07-15</Date>
          <Time>235900</Time>
        </NextScheduleActivity>
      </Activity>
      <Activity>
        <ActivityLocation>
          <Address>
            <City>New York</City>
            <StateProvinceCode>NY</StateProvinceCode>
            <CountryCode>US</CountryCode>
          </Address>
        </ActivityLocation>
        <Status>
          <StatusType>
            <Code>I</Code>
            <Description>Origin Scan</Description>
          </StatusType>
          <StatusCode>
            <Code>OR</Code>
          </StatusCode>
        </Status>
        <Date>20200710</Date>
        <Time>202339</Time>
        <GMTDate>2020-07-11</GMTDate>
        <GMTTime>00:23:39</GMTTime>
        <GMTOffset>-04:00</GMTOffset>
      </Activity>
...

In this case, the package is still in transit. However, because the check for the DeliveryStatus is missing, the package would incorrectly show as delivered in Magento, and display the date/time of the first activity as Delivered On.

Related Pull Requests

None

Fixed Issues (if relevant)

Couldn't find any open issues related to this.

Manual testing scenarios (*)

You will need a valid UPS tracking number and UPS API keys to test this.

Questions or comments

Let me know if you need samples of the UPS tracking API response.

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29659: UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered

m2-assistant · 2020-07-11T17:39:24Z

Hi @danbtl. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

danbtl · 2020-07-13T16:53:03Z

@magento run all tests

danbtl · 2020-07-27T17:17:38Z

@magento run all tests

danbtl · 2020-07-27T18:08:49Z

@joni-jones Could you please have a look at this PR? Let me know if you need additional information.

YevSent · 2020-07-29T16:01:33Z

Hi @danbtl, thanks for pointing your attention to this issue. I'm not sure how familiar you are with tracking functionality, so let me provide some context. The idea, that a customer or merchant can see all package transition history for a specific shipment, basically the same what almost all carriers provide - when a package left a shipping facility, current transit destination, delivery status, etc. So not only when a package was delivered.

The current logic is the following, the latest (XML nodes follow from latest to earlier update order) tracking information will be represented as shipment status and previous - as shipment activities. For instance, if a package in transit then the status will be In Transit, and activities like Label Created, Shipped, Out for Delivery, etc - will be represented as activities.

The proposed changes will break this logic because if the latest status is not Delivered then we will just lose the information about the current status.

However, because the check for the DeliveryStatus is missing, the package would incorrectly show as delivered in Magento, and display the date/time of the first activity as Delivered On.

I think the problem, not in the logic for UPS carrier itself but in the label for status https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Shipping/Block/DataProviders/Tracking/DeliveryDateTitle.php#L25. The label says Delivered On but it should be something like Current Status or Status Updated.

danbtl · 2020-08-05T00:00:34Z

Hi @joni-jones, thank you for reviewing this issue. I spent some time to look into this a bit further.

You're right, my proposed patch will hide the "Delivered on" row for packages that are still in transit. Like you mentioned, the real problem is that the label "Delivered On" is incorrect, and it should really say "Status on" or something similar (at least while the package is still in transit).

The FedEx provider contains a plugin that changes this label:

magento2/app/code/Magento/Fedex/Plugin/Block/DataProviders/Tracking/ChangeTitle.php

Lines 27 to 33 in b4770e4

    
           public function afterGetTitle(Subject $subject, $result, Status $trackingStatus) 
        
           { 
        
               if ($trackingStatus->getCarrier() === Carrier::CODE) { 
        
                   $result = __('Expected Delivery:'); 
        
               } 
        
               return $result; 
        
           }

I could add a similar plugin to the UPS module that simply changes the label using the same afterGetTitle mechanism. What do you think?

sidolov · 2020-08-18T17:58:21Z

@magento create issue

danbtl · 2020-08-20T02:09:06Z

@joni-jones I updated the PR. I added a plugin to change the Delivered On title to Status Updated On for the UPS carrier. This is using the same plugin mechanism that is used by the FedEx module.
Let me know your thoughts.

VladimirZaets · 2020-08-20T13:08:22Z

@magento run all tests

magento-engcom-team · 2020-08-20T13:08:38Z

Hi @VladimirZaets, thank you for the review.
ENGCOM-8045 has been created to process this Pull Request
✳️ @VladimirZaets, could you please add one of the following labels to the Pull Request?

Label	Description
`Auto-Tests: Covered`	All changes in Pull Request is covered by auto-tests
`Auto-Tests: Not Covered`	Changes in Pull Request requires coverage by auto-tests
`Auto-Tests: Not Required`	Changes in Pull Request does not require coverage by auto-tests

magento-engcom-team · 2020-08-20T13:08:40Z

@danbtl thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

danbtl · 2020-08-24T18:01:42Z

@VladimirZaets Thank you for reviewing this. This is my first Magento PR. Is there anything else I should do to get this merged?

ghost · 2020-08-24T18:04:51Z

Could you give me a call?

…

Sent from my Apple Watch

engcom-Delta · 2020-09-10T13:31:58Z

@magento give me test instance

magento-deployment-service · 2020-09-10T13:32:01Z

Hi @engcom-Delta. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service · 2020-09-10T13:36:36Z

Hi @engcom-Delta, here is your Magento Instance: https://f368c7157cb61ab4d0287123be51bf97.instances.magento-community.engineering
Admin access: https://f368c7157cb61ab4d0287123be51bf97.instances.magento-community.engineering/admin_f19f
Login: 89cf8566
Password: ba99b15b441a

engcom-Delta · 2020-09-21T13:17:51Z

@magento give me test instance

magento-deployment-service · 2020-09-21T13:17:53Z

Hi @engcom-Delta. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service · 2020-09-21T13:22:15Z

Hi @engcom-Delta, here is your Magento Instance: https://f368c7157cb61ab4d0287123be51bf97.instances.magento-community.engineering
Admin access: https://f368c7157cb61ab4d0287123be51bf97.instances.magento-community.engineering/admin_7e33
Login: c309efeb
Password: ea5329378170

engcom-Delta · 2020-09-21T14:56:32Z

@magento give me 2.4-develop instance

magento-deployment-service · 2020-09-21T14:56:33Z

Hi @engcom-Delta. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service · 2020-09-21T15:01:25Z

Hi @engcom-Delta, here is your Magento Instance: https://f368c7157cb61ab4d0287123be51bf97-2-4-develop.instances.magento-community.engineering
Admin access: https://f368c7157cb61ab4d0287123be51bf97-2-4-develop.instances.magento-community.engineering/admin_fcd3
Login: d8d6477a
Password: d769e40385f8

engcom-Delta · 2020-09-21T15:15:03Z

✔️ QA passed
Result:
❌ Before:

✔️ After:

engcom-Delta · 2020-09-22T09:46:49Z

Note: Automation tests are passed

…kage has actually been delivered #29080

m2-assistant · 2020-09-23T12:33:29Z

Hi @danbtl, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

ghost added the Progress: pending review label Jul 11, 2020

magento-engcom-team added Component: Ups Release Line: 2.4 labels Jul 11, 2020

sidolov added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Aug 18, 2020

m2-assistant bot mentioned this pull request Aug 18, 2020

[Issue] UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29659

Closed

UPS Shipment Tracking: Change "Delivered On" title

5031159

danbtl force-pushed the fix-ups-tracking branch from 09c318e to 5031159 Compare August 20, 2020 02:02

VladimirZaets approved these changes Aug 20, 2020

View reviewed changes

ghost assigned VladimirZaets Aug 20, 2020

ghost added Progress: ready for testing and removed Progress: pending review labels Aug 20, 2020

Merge branch '2.4-develop' into fix-ups-tracking

123a4f0

engcom-Delta self-assigned this Sep 10, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Sep 10, 2020

engcom-Delta added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Sep 22, 2020

ghost added Progress: accept and removed Progress: testing in progress labels Sep 22, 2020

magento-engcom-team pushed a commit that referenced this pull request Sep 23, 2020

ENGCOM-8045: UPS Shipment Tracking: Show "Delivered On" only when pac…

5780d07

…kage has actually been delivered #29080

magento-engcom-team merged commit bfeeb17 into magento:2.4-develop Sep 23, 2020

sidolov added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Sep 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29080

UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29080

danbtl commented Jul 11, 2020 •

edited by m2-assistant bot

Loading

m2-assistant bot commented Jul 11, 2020

danbtl commented Jul 13, 2020

danbtl commented Jul 27, 2020

danbtl commented Jul 27, 2020

YevSent commented Jul 29, 2020

danbtl commented Aug 5, 2020

sidolov commented Aug 18, 2020

danbtl commented Aug 20, 2020

VladimirZaets commented Aug 20, 2020

magento-engcom-team commented Aug 20, 2020

magento-engcom-team commented Aug 20, 2020

danbtl commented Aug 24, 2020

ghost commented Aug 24, 2020 via email

engcom-Delta commented Sep 10, 2020

magento-deployment-service bot commented Sep 10, 2020

magento-deployment-service bot commented Sep 10, 2020

engcom-Delta commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

engcom-Delta commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

engcom-Delta commented Sep 21, 2020

engcom-Delta commented Sep 22, 2020

m2-assistant bot commented Sep 23, 2020

UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29080

UPS Shipment Tracking: Show "Delivered On" only when package has actually been delivered #29080

Conversation

danbtl commented Jul 11, 2020 • edited by m2-assistant bot Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

m2-assistant bot commented Jul 11, 2020

danbtl commented Jul 13, 2020

danbtl commented Jul 27, 2020

danbtl commented Jul 27, 2020

YevSent commented Jul 29, 2020

danbtl commented Aug 5, 2020

sidolov commented Aug 18, 2020

danbtl commented Aug 20, 2020

VladimirZaets commented Aug 20, 2020

magento-engcom-team commented Aug 20, 2020

magento-engcom-team commented Aug 20, 2020

danbtl commented Aug 24, 2020

ghost commented Aug 24, 2020 via email

engcom-Delta commented Sep 10, 2020

magento-deployment-service bot commented Sep 10, 2020

magento-deployment-service bot commented Sep 10, 2020

engcom-Delta commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

engcom-Delta commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

magento-deployment-service bot commented Sep 21, 2020

engcom-Delta commented Sep 21, 2020

engcom-Delta commented Sep 22, 2020

m2-assistant bot commented Sep 23, 2020

danbtl commented Jul 11, 2020 •

edited by m2-assistant bot

Loading