Merge pull request #8677 from magento-lynx/storefront-extra-graphql-delivery

internal-magento-queue-manager[bot] · web-flow · commit 59b29218f2c1 · 2023-12-15T03:17:48.000Z
[LYNX] Storefront extra graphql delivery
diff --git a/app/code/Magento/CustomerGraphQl/Model/Customer/GetAttributesForm.php b/app/code/Magento/CustomerGraphQl/Model/Customer/GetAttributesForm.php
@@ -42,12 +42,6 @@ public function execute(string $formCode): ?array
     {
         $attributes = [];
         foreach ($this->entity->getAttributes($formCode) as $attribute) {
-            // region_id and country_id returns large datasets that is also not related between each other and
-            // not filterable. DirectoryGraphQl contains queries that allow to retrieve this information in a
-            // meaningful way
-            if ($attribute->getAttributeCode() === 'region_id' || $attribute->getAttributeCode() === 'country_id') {
-                continue;
-            }
             $attributes[] = ['entity_type' => $this->type, 'attribute_code' => $attribute->getAttributeCode()];
         }
         return $attributes;
diff --git a/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php b/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php
@@ -1,10 +1,8 @@
 <?php
-
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\EavGraphQl\Model\Output;
@@ -24,12 +22,19 @@ class GetAttributeData implements GetAttributeDataInterface
      */
     private EnumLookup $enumLookup;
 
+    /**
+     * @var array
+     */
+    private array $skipOptionsForAttributeCodes;
+
     /**
      * @param EnumLookup $enumLookup
+     * @param array $skipOptionsForAttributeCodes
      */
-    public function __construct(EnumLookup $enumLookup)
+    public function __construct(EnumLookup $enumLookup, array $skipOptionsForAttributeCodes = [])
     {
         $this->enumLookup = $enumLookup;
+        $this->skipOptionsForAttributeCodes = $skipOptionsForAttributeCodes;
     }
 
     /**
@@ -91,7 +96,7 @@ private function getFrontendInput(AttributeInterface $attribute): string
      */
     private function getOptions(AttributeInterface $attribute): array
     {
-        if (!$attribute->getOptions()) {
+        if (!$attribute->getOptions() || $this->skipOptions($attribute)) {
             return [];
         }
         return array_filter(
@@ -133,4 +138,18 @@ private function isDefault(mixed $value, mixed $defaultValue): bool
 
         return in_array($value, explode(',', $defaultValue));
     }
+
+    /**
+     * Skip attributes options for region_id and country_id
+     *
+     * Attributes region_id and country_id returns large datasets that is also not related between each other and
+     * not filterable. DirectoryGraphQl contains queries that allow to retrieve this information in a meaningful way
+     *
+     * @param AttributeInterface $attribute
+     * @return bool
+     */
+    private function skipOptions(AttributeInterface $attribute): bool
+    {
+        return in_array($attribute->getAttributeCode(), $this->skipOptionsForAttributeCodes);
+    }
 }
diff --git a/app/code/Magento/EavGraphQl/etc/di.xml b/app/code/Magento/EavGraphQl/etc/di.xml
@@ -9,4 +9,12 @@
     <type name="Magento\Eav\Model\Entity\Attribute">
         <plugin name="entityAttributeChangePlugin" type="Magento\EavGraphQl\Plugin\Eav\AttributePlugin" />
     </type>
+    <type name="Magento\EavGraphQl\Model\Output\GetAttributeData">
+        <arguments>
+            <argument name="skipOptionsForAttributeCodes" xsi:type="array">
+                <item name="region_id" xsi:type="string">region_id</item>
+                <item name="country_id" xsi:type="string">country_id</item>
+            </argument>
+        </arguments>
+    </type>
 </config>
diff --git a/app/code/Magento/EavGraphQl/etc/schema.graphqls b/app/code/Magento/EavGraphQl/etc/schema.graphqls
@@ -11,7 +11,7 @@ type Query {
     customAttributeMetadataV2(attributes: [AttributeInput!]): AttributesMetadataOutput! @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributesMetadata") @doc(description: "Retrieve EAV attributes metadata.") @cache(cacheIdentity: "Magento\\EavGraphQl\\Model\\Resolver\\Cache\\CustomAttributeMetadataV2Identity")
     attributesForm(formCode: String! @doc(description: "Form code.")): AttributesFormOutput!
     @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributesForm")
-    @doc(description: "Retrieve EAV attributes associated to a frontend form. For region_id and country_id attributes information use DirectoryGraphQl module.")
+    @doc(description: "Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.")
     @cache(cacheIdentity: "Magento\\Eav\\Model\\Cache\\AttributesFormIdentity")
     attributesList(
         entityType: AttributeEntityTypeEnum! @doc(description: "Entity type.")
diff --git a/app/code/Magento/QuoteGraphQl/etc/graphql/di.xml b/app/code/Magento/QuoteGraphQl/etc/graphql/di.xml
@@ -60,4 +60,13 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\StoreGraphQl\Model\Resolver\Store\StoreConfigDataProvider">
+        <arguments>
+            <argument name="extendedConfigData" xsi:type="array">
+                <item name="is_guest_checkout_enabled" xsi:type="string">checkout/options/guest_checkout</item>
+                <item name="is_one_page_checkout_enabled" xsi:type="string">checkout/options/onepage_checkout_enabled</item>
+                <item name="max_items_in_order_summary" xsi:type="string">checkout/options/max_items_display_count</item>
+            </argument>
+        </arguments>
+    </type>
 </config>
diff --git a/app/code/Magento/QuoteGraphQl/etc/schema.graphqls b/app/code/Magento/QuoteGraphQl/etc/schema.graphqls
@@ -442,3 +442,8 @@ enum CartUserInputErrorType {
     UNDEFINED
 }
 
+type StoreConfig {
+    is_guest_checkout_enabled: Boolean @doc(description: "Extended Config Data - checkout/options/guest_checkout")
+    is_one_page_checkout_enabled: Boolean @doc(description: "Extended Config Data - checkout/options/onepage_checkout_enabled")
+    max_items_in_order_summary: Int @doc(description: "Extended Config Data - checkout/options/max_items_display_count")
+}
diff --git a/app/code/Magento/StoreGraphQl/etc/graphql/di.xml b/app/code/Magento/StoreGraphQl/etc/graphql/di.xml
@@ -27,6 +27,10 @@
         <arguments>
             <argument name="extendedConfigData" xsi:type="array">
                 <item name="use_store_in_url" xsi:type="string">web/url/use_store</item>
+                <item name="default_country" xsi:type="string">general/country/default</item>
+                <item name="countries_with_required_region" xsi:type="string">general/region/state_required</item>
+                <item name="display_state_if_optional" xsi:type="string">general/region/display_all</item>
+                <item name="optional_zip_countries" xsi:type="string">general/country/optional_zip_countries</item>
             </argument>
         </arguments>
     </type>
diff --git a/app/code/Magento/StoreGraphQl/etc/schema.graphqls b/app/code/Magento/StoreGraphQl/etc/schema.graphqls
@@ -43,4 +43,8 @@ type StoreConfig @doc(description: "Contains information about a store's configu
     secure_base_static_url : String @doc(description: "The secure fully-qualified URL that specifies the location of static view files.")
     secure_base_media_url : String @doc(description: "The secure fully-qualified URL that specifies the location of media files.")
     use_store_in_url: Boolean @doc(description: "Indicates whether the store code should be used in the URL.")
+    default_country: String @doc(description: "Extended Config Data - general/country/default")
+    countries_with_required_region: String @doc(description: "Extended Config Data - general/region/state_required")
+    optional_zip_countries: String @doc(description: "Extended Config Data - general/country/optional_zip_countries")
+    display_state_if_optional: Boolean @doc(description: "Extended Config Data - general/region/display_all")
 }
diff --git a/app/code/Magento/TaxGraphQl/etc/graphql/di.xml b/app/code/Magento/TaxGraphQl/etc/graphql/di.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<!--
+/************************************************************************
+ *
+ * Copyright 2023 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ * ************************************************************************
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Magento\StoreGraphQl\Model\Resolver\Store\StoreConfigDataProvider">
+        <arguments>
+            <argument name="extendedConfigData" xsi:type="array">
+                <item name="shopping_cart_display_price" xsi:type="string">tax/cart_display/price</item>
+                <item name="shopping_cart_display_shipping" xsi:type="string">tax/cart_display/shipping</item>
+                <item name="shopping_cart_display_subtotal" xsi:type="string">tax/cart_display/subtotal</item>
+                <item name="shopping_cart_display_grand_total" xsi:type="string">tax/cart_display/grandtotal</item>
+                <item name="shopping_cart_display_full_summary" xsi:type="string">tax/cart_display/full_summary</item>
+                <item name="shopping_cart_display_zero_tax" xsi:type="string">tax/cart_display/zero_tax</item>
+            </argument>
+        </arguments>
+    </type>
+</config>
diff --git a/app/code/Magento/TaxGraphQl/etc/schema.graphqls b/app/code/Magento/TaxGraphQl/etc/schema.graphqls
@@ -4,3 +4,12 @@
 enum PriceAdjustmentCodesEnum {
     TAX @deprecated(reason: "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.")
 }
+
+type StoreConfig {
+    shopping_cart_display_price: Int @doc(description: "Extended Config Data - tax/cart_display/price")
+    shopping_cart_display_shipping: Int @doc(description: "Extended Config Data - tax/cart_display/shipping")
+    shopping_cart_display_subtotal: Int @doc(description: "Extended Config Data - tax/cart_display/subtotal")
+    shopping_cart_display_grand_total: Boolean @doc(description: "Extended Config Data - tax/cart_display/grandtotal")
+    shopping_cart_display_full_summary: Boolean @doc(description: "Extended Config Data - tax/cart_display/full_summary")
+    shopping_cart_display_zero_tax: Boolean @doc(description: "Extended Config Data - tax/cart_display/zero_tax")
+}
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/Attribute/AttributesFormTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Customer/Attribute/AttributesFormTest.php
@@ -59,14 +59,6 @@ class AttributesFormTest extends GraphQlAbstract
                 'used_in_forms' => ['customer_address_edit']
             ],
             'attribute_2'
-        ),
-        DataFixture(
-            CustomerAttribute::class,
-            [
-                'entity_type_id' => AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
-                'used_in_forms' => ['customer_register_address']
-            ],
-            'attribute_3'
         )
     ]
     public function testAttributesForm(): void
@@ -75,22 +67,16 @@ public function testAttributesForm(): void
         $attribute1 = DataFixtureStorageManager::getStorage()->get('attribute_1');
         /** @var AttributeInterface $attribute2 */
         $attribute2 = DataFixtureStorageManager::getStorage()->get('attribute_2');
-        /** @var AttributeInterface $attribute3 */
-        $attribute3 = DataFixtureStorageManager::getStorage()->get('attribute_3');
-        $attribute3->setIsVisible(false)->save();
 
         $result = $this->graphQlQuery(sprintf(self::QUERY, 'customer_register_address'));
 
-        foreach ($result['attributesForm']['items'] as $item) {
-            if (array_contains($item, $attribute1->getAttributeCode())) {
-                return;
-            }
-            $this->assertNotContains($attribute2->getAttributeCode(), $item);
-            $this->assertNotContains($attribute3->getAttributeCode(), $item);
-            $this->assertNotContains('region_id', $item);
-            $this->assertNotContains('country_id', $item);
-        }
-        $this->fail(sprintf("Attribute '%s' not found in query response", $attribute1->getAttributeCode()));
+        $this->assertNotEmpty($result['attributesForm']['items']);
+        $codes = $this->getAttributeCodes($result['attributesForm']['items']);
+
+        $this->assertContains($attribute1->getAttributeCode(), $codes);
+        $this->assertContains('country_id', $codes);
+        $this->assertContains('region_id', $codes);
+        $this->assertNotContains($attribute2->getAttributeCode(), $codes);
     }
 
     public function testAttributesFormAdminHtmlForm(): void
@@ -152,13 +138,10 @@ public function testAttributesFormScope(): void
 
         $result = $this->graphQlQuery(sprintf(self::QUERY, 'customer_register_address'));
 
-        foreach ($result['attributesForm']['items'] as $item) {
-            if (array_contains($item, $attribute1->getAttributeCode())) {
-                $this->fail(
-                    sprintf("Attribute '%s' found in query response in global scope", $attribute1->getAttributeCode())
-                );
-            }
-        }
+        $this->assertNotEmpty($result['attributesForm']['items']);
+        $codes = $this->getAttributeCodes($result['attributesForm']['items']);
+
+        $this->assertNotContains($attribute1->getAttributeCode(), $codes);
 
         /** @var StoreInterface $store */
         $store = DataFixtureStorageManager::getStorage()->get('store2');
@@ -170,16 +153,31 @@ public function testAttributesFormScope(): void
             ['Store' => $store->getCode()]
         );
 
-        foreach ($result['attributesForm']['items'] as $item) {
-            if (array_contains($item, $attribute1->getAttributeCode())) {
-                return;
-            }
-        }
-        $this->fail(
+        $this->assertNotEmpty($result['attributesForm']['items']);
+        $codes = $this->getAttributeCodes($result['attributesForm']['items']);
+        $this->assertContains(
+            $attribute1->getAttributeCode(),
+            $codes,
             sprintf(
                 "Attribute '%s' not found in query response in website scope",
                 $attribute1->getAttributeCode()
             )
         );
     }
+
+    /**
+     * Retrieve an array of attribute codes based on an array of attributes data
+     *
+     * @param array $attributes
+     * @return array
+     */
+    private function getAttributeCodes(array $attributes): array
+    {
+        return array_map(
+            function (array $attribute) {
+                return $attribute['code'];
+            },
+            $attributes
+        );
+    }
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/StoreConfigResolverTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Quote/StoreConfigResolverTest.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\Quote;
+
+use Magento\Checkout\Helper\Data;
+use Magento\Store\Model\ScopeInterface;
+use Magento\TestFramework\Fixture\Config as ConfigFixture;
+use Magento\TestFramework\TestCase\GraphQlAbstract;
+
+/**
+ * Test the GraphQL endpoint's StoreConfigs query
+ */
+class StoreConfigResolverTest extends GraphQlAbstract
+{
+    private const MAX_ITEMS_TO_DISPLAY = 5;
+
+    #[
+        ConfigFixture(Data::XML_PATH_GUEST_CHECKOUT, true, ScopeInterface::SCOPE_STORE, 'default'),
+        ConfigFixture('checkout/options/onepage_checkout_enabled', true, ScopeInterface::SCOPE_STORE, 'default'),
+        ConfigFixture('checkout/options/max_items_display_count', self::MAX_ITEMS_TO_DISPLAY)
+    ]
+    public function testGetStoreConfig(): void
+    {
+        $query
+            = <<<QUERY
+{
+  storeConfig {
+    is_guest_checkout_enabled,
+    is_one_page_checkout_enabled,
+    max_items_in_order_summary
+  }
+}
+QUERY;
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayHasKey('storeConfig', $response);
+        $this->validateStoreConfig($response['storeConfig']);
+    }
+
+    /**
+     * Validate Store Config Data
+     *
+     * @param array $responseConfig
+     */
+    private function validateStoreConfig(
+        array $responseConfig,
+    ): void {
+        $this->assertTrue($responseConfig['is_guest_checkout_enabled']);
+        $this->assertTrue($responseConfig['is_one_page_checkout_enabled']);
+        $this->assertEquals(self::MAX_ITEMS_TO_DISPLAY, $responseConfig['max_items_in_order_summary']);
+    }
+}
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Store/StoreConfigResolverTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Store/StoreConfigResolverTest.php
@@ -7,12 +7,15 @@
 
 namespace Magento\GraphQl\Store;
 
+use Magento\Directory\Helper\Data;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Api\Data\StoreConfigInterface;
 use Magento\Store\Api\StoreConfigManagerInterface;
 use Magento\Store\Api\StoreRepositoryInterface;
 use Magento\Store\Api\StoreResolverInterface;
+use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\Store;
+use Magento\TestFramework\Fixture\Config;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\ObjectManager;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
@@ -39,6 +42,12 @@ protected function setUp(): void
      * @magentoApiDataFixture Magento/Store/_files/store.php
      * @throws NoSuchEntityException
      */
+    #[
+        Config(Data::XML_PATH_DEFAULT_COUNTRY, 'es', ScopeInterface::SCOPE_STORE, 'default'),
+        Config(Data::XML_PATH_STATES_REQUIRED, 'us', ScopeInterface::SCOPE_STORE, 'default'),
+        Config(Data::OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH, 'fr', ScopeInterface::SCOPE_STORE, 'default'),
+        Config(Data::XML_PATH_DISPLAY_ALL_STATES, true, ScopeInterface::SCOPE_STORE, 'default'),
+    ]
     public function testGetStoreConfig(): void
     {
         /** @var  StoreConfigManagerInterface $storeConfigManager */
@@ -80,7 +89,10 @@ public function testGetStoreConfig(): void
     secure_base_link_url,
     secure_base_static_url,
     secure_base_media_url,
-    store_name
+    default_country,
+    countries_with_required_region,
+    optional_zip_countries,
+    display_state_if_optional
   }
 }
 QUERY;
@@ -136,6 +148,9 @@ private function validateStoreConfig(
         $this->assertEquals($storeConfig->getSecureBaseLinkUrl(), $responseConfig['secure_base_link_url']);
         $this->assertEquals($storeConfig->getSecureBaseStaticUrl(), $responseConfig['secure_base_static_url']);
         $this->assertEquals($storeConfig->getSecureBaseMediaUrl(), $responseConfig['secure_base_media_url']);
-        $this->assertEquals($store->getName(), $responseConfig['store_name']);
+        $this->assertEquals('es', $responseConfig['default_country']);
+        $this->assertEquals('us', $responseConfig['countries_with_required_region']);
+        $this->assertEquals('fr', $responseConfig['optional_zip_countries']);
+        $this->assertEquals('true', $responseConfig['display_state_if_optional']);
     }
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Tax/StoreConfigResolverTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Tax/StoreConfigResolverTest.php

Original file line number	Diff line number	Diff line change
`@@ -42,12 +42,6 @@ public function execute(string $formCode): ?array`
`42`	`42`	`{`
`43`	`43`	`$attributes = [];`
`44`	`44`	`foreach ($this->entity->getAttributes($formCode) as $attribute) {`
`45`		`- // region_id and country_id returns large datasets that is also not related between each other and`
`46`		`- // not filterable. DirectoryGraphQl contains queries that allow to retrieve this information in a`
`47`		`- // meaningful way`
`48`		`- if ($attribute->getAttributeCode() === 'region_id' \|\| $attribute->getAttributeCode() === 'country_id') {`
`49`		`- continue;`
`50`		`- }`
`51`	`45`	`$attributes[] = ['entity_type' => $this->type, 'attribute_code' => $attribute->getAttributeCode()];`
`52`	`46`	`}`
`53`	`47`	`return $attributes;`
Original file line number	Diff line number	Diff line change
`@@ -442,3 +442,8 @@ enum CartUserInputErrorType {`
`442`	`442`	`UNDEFINED`
`443`	`443`	`}`
`444`	`444`
	`445`	`+type StoreConfig {`
	`446`	`+ is_guest_checkout_enabled: Boolean @doc(description: "Extended Config Data - checkout/options/guest_checkout")`
	`447`	`+ is_one_page_checkout_enabled: Boolean @doc(description: "Extended Config Data - checkout/options/onepage_checkout_enabled")`
	`448`	`+ max_items_in_order_summary: Int @doc(description: "Extended Config Data - checkout/options/max_items_display_count")`
	`449`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,8 @@ type StoreConfig @doc(description: "Contains information about a store's configu`
`43`	`43`	`secure_base_static_url : String @doc(description: "The secure fully-qualified URL that specifies the location of static view files.")`
`44`	`44`	`secure_base_media_url : String @doc(description: "The secure fully-qualified URL that specifies the location of media files.")`
`45`	`45`	`use_store_in_url: Boolean @doc(description: "Indicates whether the store code should be used in the URL.")`
	`46`	`+ default_country: String @doc(description: "Extended Config Data - general/country/default")`
	`47`	`+ countries_with_required_region: String @doc(description: "Extended Config Data - general/region/state_required")`
	`48`	`+ optional_zip_countries: String @doc(description: "Extended Config Data - general/country/optional_zip_countries")`
	`49`	`+ display_state_if_optional: Boolean @doc(description: "Extended Config Data - general/region/display_all")`
`46`	`50`	`}`