When canceling order with OrderService, the cancel method always saves the order and returns true, even if the order can not be canceled.

[ekuusela]

I'm assuming the cancel method in OrderService is supposed to return true only if the cancellation was a success.

magento2/app/code/Magento/Sales/Model/Service/OrderService.php

Line 87 in 5973d67

public function cancel($id)

But, since the cancel method in Order always returns the order itself, the service method ends up always saving and returning true as if the order was cancelled.

magento2/app/code/Magento/Sales/Model/Order.php

Line 1112 in 5973d67

public function cancel()

This is confusing if not broken. The meaning of the boolean return value should be documented and if it is indeed meant as an indicator of successful cancelation, the service method should be fixed.

I'll include the boilerplate below to prevent this issue from getting auto-marked as not helpful.

Preconditions

1. Fresh Magento 2 version (see links to functions in develop branch above)

Steps to reproduce

1. Look at phpdoc in OrderService's cancel method and try to understand it's return value.

Expected result

1. A clear understanding of the return value AND
2. Return value corresponding to reality, for example, true only if order was canceled.

Actual result

1. Confusion. Looks like the return value might indicate cancelation success, but it does not.

[magento-engcom-team]

Hi @ekuusela
Could you please create a Pull Request for this issue?

[freakphp]

@freakphp

[magento-engcom-team]

@ekuusela thank you for your bug report.
We've created internal ticket MAGETWO-75370 to track progress on the issue.

[magento-team]

Internal ticket to track issue progress: MAGETWO-75327

[strell]

I would like to work on this issue

[okorshenko]

@ekuusela thank you for your report. The issue is already fixed in 2.2-develop branch (PR: #11160 by @strell) and will be available in the Magento 2.2.2 release