This repository was archived by the owner on Nov 19, 2024. It is now read-only.
[GraphQL] Add information about debugging #4013
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
magento-engcom-team
added
Partner: Atwix
partners-contribution
|
An admin must run tests on this PR before it can be merged. |
lorikrell
changed the title
keharper
added
2.3.x
keharper
suggested changes
Mar 30, 2019
| title: Debugging GraphQL queries | ||
| --- | ||
|
|
||
| In this section you will find recommendations on how to debug GraphQL requests. |
There was a problem hiding this comment.
Suggested change
| In this section you will find recommendations on how to debug GraphQL requests. | |
| This topic provides recommendations on how to debug GraphQL requests. |
|
|
||
| ## Debugging with PHPStorm and Xdebug | ||
|
|
||
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries you might need to debug the request processing. |
There was a problem hiding this comment.
Suggested change
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries you might need to debug the request processing. | |
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries, you might need to debug the request processing. |
| ## Debugging with PHPStorm and Xdebug | ||
|
|
||
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries you might need to debug the request processing. | ||
| It is possible to use Xdebug for debugging the PHP execution of GraphQL query as well as we do for other HTTP requests. |
There was a problem hiding this comment.
Suggested change
| It is possible to use Xdebug for debugging the PHP execution of GraphQL query as well as we do for other HTTP requests. | |
| You can use Xdebug for debugging the PHP execution of a GraphQL query just as you would for other HTTP requests. |
|
|
||
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries you might need to debug the request processing. | ||
| It is possible to use Xdebug for debugging the PHP execution of GraphQL query as well as we do for other HTTP requests. | ||
| In order to start debugging you can simply add the additional `?XDEBUG_SESSION_START=PHPSTORM` parameter to the endpoint url. |
There was a problem hiding this comment.
Suggested change
| In order to start debugging you can simply add the additional `?XDEBUG_SESSION_START=PHPSTORM` parameter to the endpoint url. | |
| To start debugging, add the `?XDEBUG_SESSION_START=PHPSTORM` parameter to the endpoint URL. |
| When [using GraphiQL]({{ page.baseurl }}/graphql/index.html#how-to-access-graphql) or any other client for testing GraphQL queries you might need to debug the request processing. | ||
| It is possible to use Xdebug for debugging the PHP execution of GraphQL query as well as we do for other HTTP requests. | ||
| In order to start debugging you can simply add the additional `?XDEBUG_SESSION_START=PHPSTORM` parameter to the endpoint url. | ||
| The following example shows how to establish connection between Xdebug and PHPStorm IDE. |
There was a problem hiding this comment.
Suggested change
| The following example shows how to establish connection between Xdebug and PHPStorm IDE. | |
| The following example shows how to establish a connection between Xdebug and PHPStorm IDE. |
| http://<magento2-3-server>/graphql?XDEBUG_SESSION_START=PHPSTORM | ||
| ``` | ||
|
|
||
| There is also another possible way to enable Xdebug connection for particular request by setting the corresponding header parameter. |
There was a problem hiding this comment.
Suggested change
| There is also another possible way to enable Xdebug connection for particular request by setting the corresponding header parameter. | |
| You can also enable an Xdebug connection for a particular request by setting the corresponding header parameter. |
| Cookie: XDEBUG_SESSION=PHPSTORM | ||
| ``` | ||
|
|
||
| As result Xdebug within the PHP execution attempts to make a connection to an IDE. If the IDE is listening, it will give the instructions to Xdebug about breakpoints etc. |
There was a problem hiding this comment.
Suggested change
| As result Xdebug within the PHP execution attempts to make a connection to an IDE. If the IDE is listening, it will give the instructions to Xdebug about breakpoints etc. | |
| As a result, Xdebug within the PHP execution attempts to make a connection to an IDE. If the IDE is listening, it will give the instructions to Xdebug about breakpoints and other relevant information. |
|
Hello @keharper, Thank you! |
keharper
approved these changes
Apr 1, 2019
|
running tests |
|
Hi @dmytro-ch, thank you for your contribution! |
|
Thanks for your contribution, @dmytro-ch |
|
@keharper please add |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a:
Summary
This PR adds information about debugging GraphQL queries.
The new page is created and the corresponding link is added into the Development section of navigation menu.
Additional information
List all affected URLs
whatsnew
Added a topic about GraphQL debugging.