Fix wrong format error DHL shipping label

[vpsnak]

Fix "The response is in wrong format." error while generating dhl shipping label. When product name has unicode characters substr() is sending � in causing erros dhl syntax errors.

Description (*)

DHL shipping.log produces error "Error in parsing request XML:The element type "PieceContents" must be terminated by the matching end-tag "</PieceContents>"."

This is caused in our use case by substr() not supporting multibyte characters in product name.

Manual testing scenarios (*)

1. create a product with product name "Φυστίκι Ψημένο με Αλάτι Συσκευασία"
2. place an order with dhl shipping method (having debug mode will help trace dhl error response)
3. try to ship order with "create shipping label" checkbox checked
4. while requesting label creation you get "The response is in wrong format."

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:

1. resolves [Issue] Fix wrong format error DHL shipping label #31032: Fix wrong format error DHL shipping label

Related Pull Requests

[m2-assistant]

Hi @vpsnak. 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:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. 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

[m2-assistant]

Hi @vpsnak, 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.

[m2-assistant]

Hi @vpsnak. 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:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. 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.

[rogyar]

Hi @vpsnak. Thank you for your collaboration. According to the definition of done all changes should be covered by auto-tests. Could I ask you to cover this case with an integration test, please? Feel free to extend the existing test for that.

Thank you!

[gabrieldagama]

@magento create issue

[engcom-Hotel]

Hello @vpsnak.
I will check failing tests, could you please cover your changes according to recommendations from
#31021 (review)

[vpsnak]

@engcom-Hotel @rogyar i have never made an Automated test, i am searching on how to cover this issue with a test case because its a tricky situation. I have to test _shipmentDetails in order to test the difference between substr(implode(',', $content), 0, 34) and $this->string->substr(implode(',', $content), 0, 34) on line 1751? Or can i make a test just passing the same string to both and test the result?

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

@magento run all tests

[engcom-Hotel]

@magento run Functional Tests B2B

[engcom-Hotel]

@magento run Functional Tests EE

[engcom-Hotel]

@magento run all tests

[magento-engcom-team]

Hi @rogyar, thank you for the review.
ENGCOM-8537 has been created to process this Pull Request
✳️ @rogyar, 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]

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

[engcom-Alfa]

✔️ QA Passed

Case 1.

With product name "Φυστίκι Ψημένο με Αλάτι Συσκευασία"

1. Create a product with product name "Φυστίκι Ψημένο με Αλάτι Συσκευασία";
2. Place an order with dhl shipping method;
3. Try to ship order with "create shipping label" checkbox checked

Before: ❌ while requesting label creation we get "The response is in wrong format."

✖️ With Documents type

✖️ With Non Documents type

After: ✔️ The shipment has been created

✔️ With Documents and Non Documents types

Case 2.

With product name "Simple 1"

1. Create a product with product name "Simple 1";
2. Place an order with dhl shipping method;
3. Try to ship order with "create shipping label" checkbox checked

Before: ❌ while requesting label creation we get "The response is in wrong format."

✖️ With Documents type

✔️ With Non Documents type

After: ✔️ The shipment has been created

✔️ With Documents and Non Documents types

[m2-assistant]

Hi @vpsnak, 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.