Store Tracking URL in DB as well as Tracking Code #10799

RhodriOwainDavies · 2017-09-06T23:46:20Z

Please beware this is critical for Magento Shipping (to be released in v2.2.2 - discuss with @joni-jones @orlangur & Nadia Kalinovich

Linked to #10977

Forked from 2.2-develop branch, merge target branch 2.2-develop as per @joni-jones 's request.

Description

Add a new field sales_shipment_track.track_url.
Expose this field via API.
Including this URL as a hyperlink in the Shipment Sent Email template.

Feature

To support impending Magento Shipping feature request of inserting Carrier Specific URL in email template to Customer

Manual testing scenarios

API Test
POST /V1/order/{orderId}/ship
Pass in tracking_url as an extension attribute (in same manner as tracking_number)
UI Test
In the admin section, view a Shipment which already has a trackinging URL set (via API in Test Can you commit to repository a folder dev/tests/static ? #1). Click Send Tracking Email. Check email, Tracking Number should be a hyperlink to tracking_url

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 on Travis CI are green)

magento-cicd2 · 2017-09-06T23:46:24Z

Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 3 committers have signed the CLA.

✅ RhodriOwainDavies
❌ paliarush
❌ viktym

orlangur · 2017-09-07T08:36:17Z

app/code/Magento/Sales/Api/Data/TrackInterface.php

+     * @param string $trackUrl
+     * @return $this
+     */
+    public function setTrackUrl($trackUrl);


New methods cannot be added into existing @api interfaces as it will break every existing interface implementation. Please check http://devdocs.magento.com/guides/v2.0/contributor-guide/backward-compatible-development/#introduction-of-a-method-to-a-class-or-interface

YevSent · 2017-09-07T13:27:30Z

app/code/Magento/Sales/Test/Unit/Model/Order/Shipment/TrackTest.php

@@ -55,6 +55,15 @@ public function testSetGetNumber()
        $this->assertEquals('test', $this->_model->getTrackNumber());
    }

+    public function testSetGetUrl()


This test method is useless.

YevSent · 2017-09-07T14:01:01Z

dev/tests/integration/testsuite/Magento/Sales/Api/ShipmentTrackRepositoryInterfaceTest.php

@@ -41,14 +41,17 @@ public function testGetList()
        $filter3 = $filterBuilder->setField(ShipmentTrackInterface::TRACK_NUMBER)
            ->setValue('track number 4')
            ->create();
-        $filter4 = $filterBuilder->setField(ShipmentTrackInterface::CARRIER_CODE)
-            ->setValue('carrier code 5')
+        $filter4 = $filterBuilder->setField(ShipmentTrackInterface::TRACK_URL)


You added new search criteria but didn't change the test's fixture. Seems these changes cause travis failures. Does this test work as expected in your environment?

Hi, I've updated the tests again, including the fixtures, please check again

YevSent · 2017-09-08T09:32:20Z

app/code/Magento/Sales/Api/Data/TrackUrlInterface.php

+/**
+ * Shipment Track Creation interface.
+ */
+interface TrackUrlInterface


Introduction of the new interface should bump the minor version of a package.

I've bumped the version number

Do not see any changes in composer.json file.

Am I supposed to update this composer.json?

https://github.com/RhodriOwainDavies/magento2/blob/0e13ba15b73fc701029ccbd7b3f30863c4e640fd/app/code/Magento/Sales/composer.json

Can you confirm what you mean exactly?

You need to bump the version of composer.json in Sales module and specify the updated version in the replace section of "root" composer.json file. Also TrackUrlInterface should be marked as API.

need to bump the version of composer.json in Sales module and specify the updated version in the replace section of "root" composer.json file

Would be nice if such info added to http://devdocs.magento.com/guides/v2.0/contributor-guide/backward-compatible-development/ or http://devdocs.magento.com/guides/v2.2/extension-dev-guide/versioning/

RhodriOwainDavies · 2017-09-12T21:22:11Z

composer.json

@@ -86,122 +86,121 @@
        "sebastian/phpcpd": "2.0.4"
    },
    "replace": {


Hi @orlangur

Can you help me by providing me with a correct version of composer.json ?

I'm not sure what version each of the modules are supposed to be in the replace section. All I do know is that "magento/module-sales": "100.3.0-dev",

And can you confirm my target branch? My PR is currently targeting develop branch, whereas maybe it should be 2.2.0-preview

It should definitely be develop, please change back.

develop branch reflects what will be later released as 2.3, most of the modules are 100.3.0-dev so I assume your change makes module Sales 100.4.0-dev (@joni-jones, please check).

[mpi] MAGETWO-72551: Update version in composer to 2.2.1-dev for 2.2-develop branch

… include in Sales Shipment Email

orlangur · 2017-09-20T07:36:48Z

@RhodriOwainDavies changed the base branch from 2.2.0-preview to 2.2-develop

develop branch shall be used here, not 2.2-develop. After PR is merged into develop, backport to 2.2-develop could be created.

RhodriOwainDavies · 2017-09-20T10:51:02Z

Hi @orlangur

Please refer to message from @joni-jones

Please use 2.2-develop to deliver code for upcoming 2.2.x releases.

orlangur · 2017-09-20T11:01:03Z

It is misleading, see https://community.magento.com/t5/Magento-DevBlog/Pull-Requests-for-2-1-x-Patch-Releases/ba-p/65630 for details. The same rules apply for 2.2-develop: changes must be applied to develop first.

@joni-jones please confirm.

RhodriOwainDavies · 2017-09-20T12:20:29Z

I used 2.2-develop as a base, so a PR into develop will result in many changed files (237 files changed).

Please confirm which branch I should start with

I'll go ahead and make my changes on top of that branch

Please confirm which branch(es) I should target in my Pull Request(s)

Please bear in mind this is a feature requirement for the upcoming Magento Shipping module (currently scheduled for v2.2.2).

orlangur · 2017-09-20T12:23:18Z

this is a feature requirement for the upcoming Magento Shipping module (currently scheduled for v2.2.2)

Where do you get such information by the way? I didn't contact Nadia but by myself didn't hear it yet.

I used 2.2-develop as a base, so a PR into develop will result in many changed files (237 files changed).

You need to apply your commits on top of develop or wait while 2.2-develop will be merged again into develop and then merge develop into your branch.

RhodriOwainDavies · 2017-09-25T02:20:26Z

Hi @orlangur

I've been working closely with Nadia and the Magento Shipping team on the solution and we have targeted v2.2.2 for release. Please discuss directly with Nadia for further info.

I've updated this PR and created a new PR here:
10977

Hope they're ok, please let me know.

vrann · 2017-10-04T12:32:10Z

Please see comments here #10977

vrann · 2017-10-11T16:15:31Z

@RhodriOwainDavies discussed with @antonkril today, this change cannot be released in 2.2 as backward incompatible. Please re-create the PR for develop branch

RhodriOwainDavies changed the title ~~Store Tracking URL in DB as well as Tracking Code~~ WIP : Store Tracking URL in DB as well as Tracking Code Sep 7, 2017

orlangur reviewed Sep 7, 2017

View reviewed changes

YevSent reviewed Sep 7, 2017

View reviewed changes

YevSent reviewed Sep 8, 2017

View reviewed changes

RhodriOwainDavies changed the title ~~WIP : Store Tracking URL in DB as well as Tracking Code~~ Store Tracking URL in DB as well as Tracking Code Sep 8, 2017

RhodriOwainDavies changed the title ~~Store Tracking URL in DB as well as Tracking Code~~ WIP : Store Tracking URL in DB as well as Tracking Code Sep 12, 2017

orlangur mentioned this pull request Sep 12, 2017

Store Tracking URL in DB as well as Tracking Code #10854

Closed

4 tasks

RhodriOwainDavies commented Sep 12, 2017

View reviewed changes

RhodriOwainDavies changed the title ~~WIP : Store Tracking URL in DB as well as Tracking Code~~ Deprecated : Store Tracking URL in DB as well as Tracking Code Sep 13, 2017

MAGETWO-70580: Merged fixes

c3ea1f5

RhodriOwainDavies changed the title ~~Deprecated : Store Tracking URL in DB as well as Tracking Code~~ Store Tracking URL in DB as well as Tracking Code Sep 13, 2017

RhodriOwainDavies changed the base branch from develop to 2.2.0-preview September 13, 2017 06:30

Merge pull request #1483 from magento-mpi/MAGETWO-72551

0c0393d

[mpi] MAGETWO-72551: Update version in composer to 2.2.1-dev for 2.2-develop branch

RhodriOwainDavies closed this Sep 13, 2017

orlangur added this to the September 2017 milestone Sep 13, 2017

orlangur assigned orlangur and YevSent Sep 13, 2017

orlangur mentioned this pull request Sep 19, 2017

MAGESHIP-21 Add Shipping Tracking URL to DB, API and email template #10956

Closed

3 tasks

orlangur reopened this Sep 19, 2017

MAGESHIP-21 Add track_url to sales_shipment_track, expose via API and…

93fe1f3

… include in Sales Shipment Email

RhodriOwainDavies changed the base branch from 2.2.0-preview to 2.2-develop September 20, 2017 00:44

RhodriOwainDavies changed the base branch from 2.2-develop to develop September 20, 2017 12:11

RhodriOwainDavies changed the base branch from develop to 2.2-develop September 20, 2017 12:13

RhodriOwainDavies mentioned this pull request Sep 21, 2017

MAGESHIP-21-develop Add track_url to DB & API and send via Customer S… #10977

Closed

4 tasks

orlangur unassigned orlangur and YevSent Sep 21, 2017

vrann added 2.2.x improvement Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development Award: complex labels Sep 26, 2017

magento-team force-pushed the 2.2-develop branch from 0c0393d to e442de5 Compare September 26, 2017 19:52

vrann self-assigned this Sep 28, 2017

magento-team closed this Sep 29, 2017

vrann reopened this Sep 29, 2017

okorshenko modified the milestones: September 2017, October 2017 Oct 5, 2017

vrann closed this Oct 11, 2017

Store Tracking URL in DB as well as Tracking Code #10799

Store Tracking URL in DB as well as Tracking Code #10799

Uh oh!

Conversation

RhodriOwainDavies commented Sep 6, 2017 • edited by vrann Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Feature

Manual testing scenarios

Contribution checklist

Uh oh!

magento-cicd2 commented Sep 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YevSent Sep 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

orlangur Sep 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

orlangur commented Sep 20, 2017

Uh oh!

RhodriOwainDavies commented Sep 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

orlangur commented Sep 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RhodriOwainDavies commented Sep 20, 2017

Uh oh!

orlangur commented Sep 20, 2017

Uh oh!

RhodriOwainDavies commented Sep 25, 2017

Uh oh!

vrann commented Oct 4, 2017

Uh oh!

vrann commented Oct 11, 2017

Uh oh!

Uh oh!

RhodriOwainDavies commented Sep 6, 2017 •

edited by vrann

Loading

magento-cicd2 commented Sep 6, 2017 •

edited

Loading

YevSent Sep 7, 2017 •

edited

Loading

orlangur Sep 11, 2017 •

edited

Loading

RhodriOwainDavies commented Sep 20, 2017 •

edited

Loading

orlangur commented Sep 20, 2017 •

edited

Loading