GraphQl-93: Implement support for variables in query #259

Aquarvin · 2018-11-20T17:54:03Z

-- Variables may be Input type
-- Query now accepts variables
-- added type property for Output/Input Type element
-- functional test was added

Description (*)

Currently running the following Graph Ql query

query GetProductsQuery($page: Int, $filterInput: ProductFilterInput){
  products(
    pageSize: 10
    currentPage: $page
    filter: $filterInput
    sort: {}
  ) {
    items {
    	name
    }
  }
}

with variables:

{
  "page": 1,
  "filterInput": {
    "price": {
    	"gt": "10"
    }
  }
}

Will return filtered products list, since ProductFilterInput is an input type, according to scheme

Fixed Issues (if relevant)

Implement support for variables in query #93: Implement support for variables in query

Manual testing scenarios (*)

...
...

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 on Travis CI are green)

-- Variables may be Input type -- Query now accepts variables -- added type property for Output/Input Type element -- functional test was added

Aquarvin · 2018-11-20T18:02:53Z

Request Sample:

query GetProductsQuery($page: Int, $filterInput: ProductFilterInput){
  products(
    pageSize: 10
    currentPage: $page
    filter: $filterInput
    sort: {}
  ) {
    items {
    	name
    }
  }
}

With variables:

{
  "page": 1,
  "filterInput": {
    "price": {
    	"gt": "10"
    }
  }
}

paliarush · 2019-01-17T23:35:13Z

dev/tests/api-functional/testsuite/Magento/GraphQl/VariablesSupportQueryTest.php

+
+        $query
+            = <<<'QUERY'
+query GetProductsQuery($page: Int, $filterInput: ProductFilterInput){


Do we have enum used here?

paliarush · 2019-01-17T23:37:20Z

lib/internal/Magento/Framework/GraphQl/Config.php

     *
-     * @return string[]
+     * @return array $types
+     *  name string


Is this common style for documenting array structure? Usually I see
['name' => 'example value', 'type' = 'example value']

paliarush · 2019-01-17T23:39:26Z

lib/internal/Magento/Framework/GraphQl/Config.php

-     * @return string[]
+     * @return array $types
+     *  name string
+     *  type string
     */
    public function getDeclaredTypeNames() : array


Can we rename this method, to getDeclaredTypes, for example

paliarush · 2019-01-17T23:42:29Z

lib/internal/Magento/Framework/GraphQl/Config/Element/InputFactory.php

+    }
+
+    /**
+     * Create type object based off array of configured GraphQL InputType data.


Suggested change

* Create type object based off array of configured GraphQL InputType data.

* Create input type object based off array of configured GraphQL InputType data.

paliarush · 2019-01-17T23:43:51Z

lib/internal/Magento/Framework/GraphQl/Config/Element/Type.php

@@ -8,7 +8,7 @@
 namespace Magento\Framework\GraphQl\Config\Element;

 /**
- * Describes all the configured data of an Output or Input type in GraphQL.
+ * Class representing 'type' GraphQL config element.


Suggested change

* Class representing 'type' GraphQL config element.

* Class representing 'type' GraphQL config elements.

paliarush · 2019-01-17T23:48:01Z

lib/internal/Magento/Framework/GraphQl/Query/Fields.php

+     *
+     * @return string[]
+     */
+    private function getVariables(array $variables): array


Suggested change

private function getVariables(array $variables): array

private function formatVariables(array $variables): array

or maybe extractVariables

paliarush · 2019-01-17T23:52:26Z

lib/internal/Magento/Framework/GraphQl/Schema/SchemaGenerator.php

                    $typesImplementors = [];
-                    foreach ($this->config->getDeclaredTypeNames() as $name) {
-                        $typesImplementors [] = $this->outputMapper->getOutputType($name);
+                    foreach ($this->config->getDeclaredTypeNames() as $type) {


Please create a ticket not to load all types, but just the ones which do not have references from Query/Mutation types

paliarush · 2019-01-17T23:54:59Z

lib/internal/Magento/Framework/GraphQl/Schema/Type/TypeRegistry.php

+            $configElementClass = get_class($configElement);
+            if (!isset($this->configToTypeMap[$configElementClass])) {
+                throw new GraphQlInputException(
+                    new Phrase("Type for '{$configElementClass}' has not declared.")


Suggested change

new Phrase("Type for '{$configElementClass}' has not declared.")

new Phrase("No mapping to Webonyx type is declared for '{$configElementClass}' config element type.")

-- Fixes after CR

magento-engcom-team · 2019-01-22T21:30:04Z

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

-- Builds fixes

ghost · 2019-01-23T23:45:50Z

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

GraphQl-93: Implement support for variables in query

958a0ac

-- Variables may be Input type -- Query now accepts variables -- added type property for Output/Input Type element -- functional test was added

paliarush approved these changes Dec 12, 2018

View reviewed changes

Merge remote-tracking branch 'origin/2.3-develop' into graphql-93

a3544dc

naydav force-pushed the graphql-93 branch from cf4e067 to a3544dc Compare December 21, 2018 14:32

JStein92 mentioned this pull request Dec 27, 2018

[feature]: Category Sorting with Venia (PWA) magento/pwa-studio#360

Closed

4 tasks

GraphQl-93: Implement support for variables in query

6f585f4

paliarush suggested changes Jan 17, 2019

View reviewed changes

naydav added 2 commits January 18, 2019 14:46

GraphQl-93: Implement support for variables in query

0985244

-- Fixes after CR

GraphQl-93: Implement support for variables in query

b3c194f

-- Fixes after CR

magento-engcom-team assigned naydav Jan 22, 2019

magento-engcom-team added this to the Release: 2.3.1 milestone Jan 22, 2019

magento-engcom-team added the Release Line: 2.3 label Jan 22, 2019

GraphQl-93: Implement support for variables in query

2e74cc1

-- Builds fixes

cherdman mentioned this pull request Jan 23, 2019

Implement filtering for Category with Venia (PWA) magento/pwa-studio#361

Closed

3 tasks

magento-engcom-team merged commit 2e74cc1 into 2.3-develop Jan 23, 2019

magento-engcom-team pushed a commit that referenced this pull request Jan 23, 2019

ENGCOM-3931: GraphQl-93: Implement support for variables in query #259

95150ba

magento-engcom-team added the Award: complex label Jan 23, 2019

naydav mentioned this pull request Jan 25, 2019

Unable to pass enum value as argument in GraphQL query #325

Closed

keharper mentioned this pull request Feb 8, 2019

GraphQL: Describe variable use in queries magento/devdocs#3716

Closed

12 tasks

This was referenced Feb 28, 2019

Document query variables magento/devdocs#3839

Closed

Updating search and pagination topic magento/devdocs#3840

Merged

keharper added the documentation-completed label Mar 5, 2019

codeAdrian mentioned this pull request Mar 21, 2019

feature: Layered Navigation (Filters) magento/pwa-studio#797

Merged

8 tasks

naydav deleted the graphql-93 branch April 12, 2019 19:35

awilcoxa mentioned this pull request Jul 11, 2019

[Category Filtering]:Complete Category Filtering Feature w/ GQL magento/pwa-studio#1432

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GraphQl-93: Implement support for variables in query #259

GraphQl-93: Implement support for variables in query #259

Aquarvin commented Nov 20, 2018 •

edited

Loading

Aquarvin commented Nov 20, 2018 •

edited

Loading

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

paliarush Jan 17, 2019

magento-engcom-team commented Jan 22, 2019

ghost commented Jan 23, 2019

	* Create type object based off array of configured GraphQL InputType data.
	* Create input type object based off array of configured GraphQL InputType data.

	* Class representing 'type' GraphQL config element.
	* Class representing 'type' GraphQL config elements.

	private function getVariables(array $variables): array
	private function formatVariables(array $variables): array

	new Phrase("Type for '{$configElementClass}' has not declared.")
	new Phrase("No mapping to Webonyx type is declared for '{$configElementClass}' config element type.")

GraphQl-93: Implement support for variables in query #259

GraphQl-93: Implement support for variables in query #259

Conversation

Aquarvin commented Nov 20, 2018 • edited Loading

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Aquarvin commented Nov 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magento-engcom-team commented Jan 22, 2019

ghost commented Jan 23, 2019

Aquarvin commented Nov 20, 2018 •

edited

Loading

Aquarvin commented Nov 20, 2018 •

edited

Loading