Ensure that invoice comments are returned when requested by GraphQL queries #31606

aligent-lturner · 2021-01-11T00:56:03Z

Description (*)

As part of the GraphQL schema for customer orders, invoices can be requested, along with their comments. However, the current implementation does not return any comments for invoices, resulting in a null value always.
This pull request ensures that invoice comments (that are visible in the front-end) are returned when requested in the query.

Fixed Issues (if relevant)

Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

Create a customer order and an associated invoice.
Add a number of comments to an order invoice, including both visible and not visible in the front-end.
Call the customer GraphQL query, requesting orders, invoices and their associated comments - e.g:

query {
    customer {
        orders(filter: { number: { eq: "000000154" } }) {
            items {
                invoices {
                    comments {
                        message
                        timestamp
                    }
                    items {
                        product_name
                    }
                }
            }
        }
    }
}

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] Ensure that invoice comments are returned when requested by GraphQL queries #31643: Ensure that invoice comments are returned when requested by GraphQL queries

Resolved issues:

resolves [Issue] Ensure that invoice comments are returned when requested by GraphQL queries #31866: Ensure that invoice comments are returned when requested by GraphQL queries

m2-assistant · 2021-01-11T00:56:06Z

Hi @aligent-lturner. 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
Semantic Version Checker

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

eduard13

Hi @aligent-lturner thank you for the fix. Could you please cover your changes by an appropriate API Functional test? You can use the following fixture that already provides invoices with comments.
https://github.com/magento/magento2/blob/2.4-develop/dev/tests/integration/testsuite/Magento/Sales/_files/invoice_comments_for_search.php

Please let me know whether you have any questions.
Thank you.

eduard13 · 2021-01-13T09:20:25Z

@magento run WebAPI Tests, Static Tests

aligent-lturner · 2021-01-13T23:14:49Z

@eduard13 the fixture mentioned adds comments to a guest order, which isn't suitable for this, as the graphql query is for a logged-in customer. I've added a new fixture to add comments to a customer order instead, and have added a functional test that uses the fixture.

eduard13 · 2021-01-14T06:47:21Z

@magento run all tests

eduard13 · 2021-01-14T06:47:54Z

@magento create issue

eduard13 · 2021-01-14T10:03:10Z

@aligent-lturner could you please review and fix the WebAPI Tests?
Thank you.

aligent-lturner · 2021-01-14T21:31:30Z

@magento run all tests

aligent-lturner · 2021-01-14T23:31:50Z

@magento run all tests

aligent-lturner · 2021-01-15T03:07:31Z

@magento run all tests

aligent-lturner · 2021-01-15T05:30:52Z

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

engcom-Lima · 2022-11-03T06:18:05Z

Looking like bot moved it from Extended to Ready for testing. Hence, moving back again to Extended testing.

engcom-Echo · 2022-11-07T12:50:06Z

@magento run all tests

magento-automated-testing · 2022-11-07T12:50:12Z