[GraphQl][GiftMessage] Add functionality for getting message for order item #29417

Usik2203 · 2020-08-06T09:04:13Z

Description (*)

Now we use customerOrders query for getting GiftMessage of order

But this query is DEPRECATED @deprecated(reason: "Use orders from customer instead")

1.

Using correct query we are getting issue

2.

*Using this query we can't get GiftMessage of order items

{
  customer {
   orders(filter:{number:{eq:"000000234"}}){
    total_count
    items
    {
      id
      number
      status
      order_date
      items {
        product_sku
        gift_message {
          from
          to 
          message
        }
      }
      gift_message {
        from
        to
        message
      }
    }
   }
 }
}

Actual result

This PR fixes first issue and add functionality to get GiftMessage for Order Items

Fixed Issues (if relevant)

Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

...
...

Questions or comments

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] [GraphQl][GiftMessage] Add functionality for getting message for order item #29418: [GraphQl][GiftMessage] Add functionality for getting message for order item

m2-assistant · 2020-08-06T09:04:15Z

Hi @Usik2203. 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

Usik2203 · 2020-08-06T09:04:32Z

@magento create issue

Usik2203 · 2020-08-06T13:58:39Z

@magento run all tests

Usik2203 · 2020-08-06T17:26:13Z

@magento run all tests

rvitaliy · 2020-08-07T12:36:54Z

app/code/Magento/GiftMessageGraphQl/Model/Resolver/Order/GiftMessage.php

@@ -58,9 +58,11 @@ public function resolve(
        if (!isset($value['id'])) {
            throw new GraphQlInputException(__('"id" value should be specified'));
        }
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
+        $orderId = (int)base64_decode($value['id']) ?: (int)$value['id'];


i think that we must be more careful with values provided from FE.

<?php declare(strict_types=1); echo "\nit's wrong (string)`1 hi all!` !== (int)`1`\n"; $a = base64_encode('1 hi all!'); var_dump((int)base64_decode($a)); echo "\nit's wrong (string)`1 hi all!` !== (int)`1`\n"; var_dump((int) '1 hi all!');

https://3v4l.org/dAvUu

Hi @rvitaliy
I am sorry but I am not sure that i understand your remark.
Yes, I understood problem which you provided in example but i can't get how it is related with this case in the code.
Perhaps you could explain your point ?
Thanks

he means if we trust that $value['id'] is a trusted value
and he explained a way to exploit such a value and how it can be misleading using base64_decode

if you wouldn't add this empty line we would of not seen this :)
we actually have a safer way to do this \Magento\Framework\GraphQl\Query\Uid::decode
you can use it if you want, but it's not really the purpose of this PR

rogyar · 2020-08-07T13:29:11Z

app/code/Magento/GiftMessageGraphQl/Model/Resolver/Order/Item/GiftMessage.php

+            return null;
+        }
+
+        if (!$this->giftMessageHelper->isMessagesAllowed('item', $orderItem)) {


I just want to double-check we really need this part. If we calling isMessageAllowed with type = "items", the second invocation (with type = "item") will be performed eventually. See the following implementation

magento2/app/code/Magento/GiftMessage/Helper/Message.php

Line 162 in 30b1cc5

if ($this->isMessagesAllowed($_type, $item, $store)) {

Please, correct me if I'm wrong

Hi @rogyar
isMessageAllowed with type = "item" need for checking isMessageAllowed on product level because we can have situation where GiftMessages are enable in configs but disable for some products
Thanks

magento-engcom-team · 2020-08-21T18:59:47Z

Hi @sidolov, thank you for the review.
ENGCOM-8059 has been created to process this Pull Request

ishakhsuvarov · 2022-08-17T13:48:26Z

Hi @Usik2203

Is there any chance you could take a look and resolve the merge conflict with the leatest 2.4-develop branch? I have tried getting this processedc and delivered but now I'm getting red builds all over the place.

Thank you

… into gift-message-fix

engcom-Charlie · 2022-09-12T09:24:58Z

@magento run all tests

magento-automated-testing · 2022-09-12T09:25:07Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2022-09-12T11:52:32Z

@magento run Functional Tests B2B, Functional Tests EE, Integration Tests, Static Tests, Unit Tests , WebAPI Tests

magento-automated-testing · 2022-09-12T11:52:41Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2022-09-12T18:16:04Z

@magento run all tests

magento-automated-testing · 2022-09-12T18:16:12Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2022-09-13T04:41:00Z

@magento run Functional Tests B2B, Functional Tests EE, Integration Tests, Static Tests

magento-automated-testing · 2022-09-13T04:41:06Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2022-09-13T06:36:51Z

@magento run all tests

magento-automated-testing · 2022-09-13T06:37:01Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2022-09-13T10:28:56Z

Hi @ishakhsuvarov,

I have resolved the merge conflicts. Also fixed all the build failures.

The functional b2b failures are not part of this PR, or not even failing because of this PR's changes. Hence moving this PR to Merge in Progress now.

Thank you!

engcom-Charlie · 2022-09-13T11:37:24Z

@magento run Functional Tests B2B, Unit Tests

magento-automated-testing · 2022-09-13T11:37:35Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[GraphQl][GiftMessage] Add functionality for getting message for order item #29417

Gift message GraphQl module fix

4cbb43c

ghost added the Progress: pending review label Aug 6, 2020

magento-engcom-team added Component: GiftMessageGraphQl Release Line: 2.4 Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner labels Aug 6, 2020

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

[Issue] [GraphQl][GiftMessage] Add functionality for getting message for order item #29418

Closed

4 tasks

rogyar self-assigned this Aug 6, 2020

add test coverage

d373aeb

Usik2203 force-pushed the gift-message-fix branch from b9fdd29 to d373aeb Compare August 6, 2020 13:57

Merge branch '2.4-develop' into gift-message-fix

1f27fa7

minor fix

c2cbea8

rvitaliy reviewed Aug 7, 2020

View reviewed changes

rogyar added Award: category of expertise Award: test coverage Auto-Tests: Covered All changes in Pull Request is covered by auto-tests labels Aug 7, 2020

rogyar reviewed Aug 7, 2020

View reviewed changes

ghost added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Aug 17, 2020

VladimirZaets added the Project: GraphQL label Aug 18, 2020

Fixed indentation

21debc0

sidolov approved these changes Aug 21, 2020

View reviewed changes

ghost assigned sidolov Aug 21, 2020

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

m2-community-project bot added the Progress: accept label Nov 12, 2021

m2-community-project bot added Progress: needs update and removed Progress: accept labels Aug 17, 2022

Indraniks added 2 commits September 12, 2022 12:59

Merge branch 'gift-message-fix' of https://github.com/Usik2203/magento2…

221df48

… into gift-message-fix

Merged 2.4 develop and resolved conflicts

2dde101

engcom-Charlie self-assigned this Sep 12, 2022

m2-community-project bot added Progress: ready for testing Progress: needs update and removed Progress: needs update Progress: ready for testing labels Sep 12, 2022

AC-1726 Solved Order gift message issue and conflicts

ccf2225

AC-1726 Solved static test failures

08ae0ba

m2-community-project bot added Progress: accept and removed Progress: needs update labels Sep 13, 2022

magento-devops-reposync-svc pushed a commit that referenced this pull request Sep 20, 2022

Merge pull request #7883 from magento-gl/comm_78764_29417

254c17b

[GraphQl][GiftMessage] Add functionality for getting message for order item #29417

magento-devops-reposync-svc merged commit 2e19e09 into magento:2.4-develop Sep 20, 2022

[GraphQl][GiftMessage] Add functionality for getting message for order item #29417

[GraphQl][GiftMessage] Add functionality for getting message for order item #29417

Uh oh!

Conversation

Usik2203 commented Aug 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

1.

2.

Actual result

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Aug 6, 2020

Uh oh!

Usik2203 commented Aug 6, 2020

Uh oh!

Usik2203 commented Aug 6, 2020

Uh oh!

Usik2203 commented Aug 6, 2020

Uh oh!

rvitaliy Aug 7, 2020

Choose a reason for hiding this comment

Uh oh!

Usik2203 Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

cpartica Nov 25, 2020

Choose a reason for hiding this comment

Uh oh!

rogyar Aug 7, 2020

Choose a reason for hiding this comment

Uh oh!

Usik2203 Aug 11, 2020

Choose a reason for hiding this comment

Uh oh!

magento-engcom-team commented Aug 21, 2020

Uh oh!

ishakhsuvarov commented Aug 17, 2022

Uh oh!

engcom-Charlie commented Sep 12, 2022

Uh oh!

magento-automated-testing bot commented Sep 12, 2022

Uh oh!

engcom-Charlie commented Sep 12, 2022

Uh oh!

magento-automated-testing bot commented Sep 12, 2022

Uh oh!

engcom-Charlie commented Sep 12, 2022

Uh oh!

magento-automated-testing bot commented Sep 12, 2022

Uh oh!

engcom-Charlie commented Sep 13, 2022

Uh oh!

magento-automated-testing bot commented Sep 13, 2022

Uh oh!

engcom-Charlie commented Sep 13, 2022

Uh oh!

magento-automated-testing bot commented Sep 13, 2022

Uh oh!

engcom-Charlie commented Sep 13, 2022

Uh oh!

engcom-Charlie commented Sep 13, 2022

Uh oh!

magento-automated-testing bot commented Sep 13, 2022

Uh oh!

Uh oh!

Usik2203 commented Aug 6, 2020 •

edited

Loading