From 6c4024f264b221e16a620702e1dda20441bef28f Mon Sep 17 00:00:00 2001
From: eliseacornejo <ecornejo@adobe.com>
Date: Tue, 16 May 2023 15:27:04 +0200
Subject: [PATCH] LYNX-149: Cache identity for attributesMetadata query (#114)

* LYNX-149: Cache identity for attributesMetadata query
---
 .../Model/Output/GetAttributeData.php         |   1 +
 .../CustomAttributeMetadataV2Identity.php     |  39 ++
 .../Magento/EavGraphQl/etc/schema.graphqls    |   2 +-
 .../CustomAttributesMetadataV2CacheTest.php   | 382 ++++++++++++++++++
 4 files changed, 423 insertions(+), 1 deletion(-)
 create mode 100644 app/code/Magento/EavGraphQl/Model/Resolver/Cache/CustomAttributeMetadataV2Identity.php
 create mode 100644 dev/tests/api-functional/testsuite/Magento/GraphQl/Eav/CustomAttributesMetadataV2CacheTest.php

diff --git a/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php b/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php
index c40e2503cc0dd..8316036ff8b31 100644
--- a/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php
+++ b/app/code/Magento/EavGraphQl/Model/Output/GetAttributeData.php
@@ -63,6 +63,7 @@ public function execute(
         int $storeId
     ): array {
         return [
+            'id' => $attribute->getAttributeId(),
             'uid' => $this->attributeUid->encode($entityType, $attribute->getAttributeCode()),
             'code' => $attribute->getAttributeCode(),
             'label' => $attribute->getStoreLabel($storeId),
diff --git a/app/code/Magento/EavGraphQl/Model/Resolver/Cache/CustomAttributeMetadataV2Identity.php b/app/code/Magento/EavGraphQl/Model/Resolver/Cache/CustomAttributeMetadataV2Identity.php
new file mode 100644
index 0000000000000..2b67b43d1e9ac
--- /dev/null
+++ b/app/code/Magento/EavGraphQl/Model/Resolver/Cache/CustomAttributeMetadataV2Identity.php
@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\EavGraphQl\Model\Resolver\Cache;
+
+use Magento\Eav\Model\Entity\Attribute as EavAttribute;
+use Magento\Framework\GraphQl\Query\Resolver\IdentityInterface;
+
+/**
+ * Cache identity provider for custom attribute metadata query results.
+ */
+class CustomAttributeMetadataV2Identity implements IdentityInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getIdentities(array $resolvedData): array
+    {
+        $identities = [];
+        if (isset($resolvedData['items']) && !empty($resolvedData['items'])) {
+            foreach ($resolvedData['items'] as $item) {
+                if (is_array($item)) {
+                    $identities[] = sprintf(
+                        "%s_%s",
+                        EavAttribute::CACHE_TAG,
+                        $item['id']
+                    );
+                }
+            }
+        } else {
+            return [];
+        }
+        return $identities;
+    }
+}
diff --git a/app/code/Magento/EavGraphQl/etc/schema.graphqls b/app/code/Magento/EavGraphQl/etc/schema.graphqls
index fb61fa83c8913..ef021207a6528 100644
--- a/app/code/Magento/EavGraphQl/etc/schema.graphqls
+++ b/app/code/Magento/EavGraphQl/etc/schema.graphqls
@@ -8,7 +8,7 @@ type Query {
     @doc(description: "Return the attribute type, given an attribute code and entity type.")
     @cache(cacheIdentity: "Magento\\EavGraphQl\\Model\\Resolver\\Cache\\CustomAttributeMetadataIdentity")
     @deprecated(reason: "Use `customAttributeMetadataV2` query instead.")
-    customAttributeMetadataV2(attributes: [AttributeInput!]): AttributesMetadataOutput! @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributesMetadata") @doc(description: "Retrieve EAV attributes metadata.")
+    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.")
     attributesList(entityType: AttributeEntityTypeEnum! @doc(description: "Entity type.")): AttributesMetadataOutput @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributesList") @doc(description: "Returns a list of attributes metadata for a given entity type.") @cache(cacheable: false)
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Eav/CustomAttributesMetadataV2CacheTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Eav/CustomAttributesMetadataV2CacheTest.php
new file mode 100644
index 0000000000000..29c03febd6557
--- /dev/null
+++ b/dev/tests/api-functional/testsuite/Magento/GraphQl/Eav/CustomAttributesMetadataV2CacheTest.php
@@ -0,0 +1,382 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\Eav;
+
+use Magento\Customer\Api\CustomerMetadataInterface;
+use Magento\Customer\Api\Data\AttributeMetadataInterface;
+use Magento\Eav\Api\Data\AttributeInterface;
+use Magento\Eav\Model\AttributeRepository;
+use Magento\Eav\Test\Fixture\Attribute;
+use Magento\EavGraphQl\Model\Uid;
+use Magento\GraphQl\PageCache\GraphQLPageCacheAbstract;
+use Magento\TestFramework\Fixture\Config as ConfigFixture;
+use Magento\TestFramework\Fixture\DataFixture;
+use Magento\TestFramework\Fixture\DataFixtureStorageManager;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\TestCase\GraphQl\ResponseContainsErrorsException;
+use Magento\PageCache\Model\Config;
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Test\Fixture\Group as StoreGroupFixture;
+use Magento\Store\Test\Fixture\Store as StoreFixture;
+use Magento\Store\Test\Fixture\Website as WebsiteFixture;
+
+/**
+ * Test caching for custom attribute metadata GraphQL query.
+ */
+class CustomAttributesMetadataV2CacheTest extends GraphQLPageCacheAbstract
+{
+    /**
+     * @var AttributeRepository
+     */
+    private $attributeRepository;
+
+    /**
+     * @var UId
+     */
+    private $uid;
+
+    /**
+     * @inheritdoc
+     */
+    public function setUp(): void
+    {
+        $this->attributeRepository = Bootstrap::getObjectManager()->get(AttributeRepository::class);
+        $this->uid = Bootstrap::getObjectManager()->get(Uid::class);
+        parent::setUp();
+    }
+
+    #[
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'text'
+            ],
+            'attribute'
+        ),
+        ConfigFixture(Config::XML_PAGECACHE_TYPE, Config::VARNISH)
+    ]
+    public function testCacheHitMiss(): void
+    {
+        /** @var AttributeInterface $attribute */
+        $attribute = DataFixtureStorageManager::getStorage()->get('attribute');
+
+        $uidCode = $this->uid->encode('customer', $attribute->getAttributeCode());
+
+        $query = $this->getAttributeQuery($attribute->getAttributeCode(), "customer");
+        $response = $this->assertCacheMissAndReturnResponse($query, []);
+        $assertionMap = [
+            ['response_field' => 'uid', 'expected_value' => $uidCode],
+            ['response_field' => 'code', 'expected_value' => $attribute->getAttributeCode()],
+            ['response_field' => 'entity_type', 'expected_value' => 'CUSTOMER'],
+            ['response_field' => 'frontend_input', 'expected_value' => 'TEXT']
+        ];
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+        $response = $this->assertCacheHitAndReturnResponse($query, []);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+    }
+
+    #[
+        ConfigFixture(Config::XML_PAGECACHE_TYPE, Config::VARNISH),
+        DataFixture(WebsiteFixture::class, as: 'website2'),
+        DataFixture(StoreGroupFixture::class, ['website_id' => '$website2.id$'], 'store_group2'),
+        DataFixture(StoreFixture::class, ['store_group_id' => '$store_group2.id$'], 'store2'),
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'text'
+            ],
+            'attribute'
+        ),
+    ]
+    public function testCacheMissAndHitDifferentStores(): void
+    {
+        /** @var StoreInterface $store2 */
+        $store2 = DataFixtureStorageManager::getStorage()->get('store2');
+
+        /** @var AttributeMetadataInterface $attribute */
+        $attribute = DataFixtureStorageManager::getStorage()->get('attribute');
+        $uidCode = $this->uid->encode('customer', $attribute->getAttributeCode());
+
+        $query = $this->getAttributeQuery($attribute->getAttributeCode(), "customer");
+        $response = $this->assertCacheMissAndReturnResponse($query, []);
+        $assertionMap = [
+            ['response_field' => 'uid', 'expected_value' => $uidCode],
+            ['response_field' => 'code', 'expected_value' => $attribute->getAttributeCode()],
+            ['response_field' => 'entity_type', 'expected_value' => 'CUSTOMER'],
+            ['response_field' => 'frontend_input', 'expected_value' => 'TEXT']
+        ];
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+        $response = $this->assertCacheHitAndReturnResponse($query, []);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+
+        // First query execution for a different store should result in a cache miss, while second one should be a hit
+        $response = $this->assertCacheMissAndReturnResponse($query, ['Store' => $store2->getCode()]);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+        $response = $this->assertCacheHitAndReturnResponse($query, ['Store' => $store2->getCode()]);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+    }
+
+    #[
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'text'
+            ],
+            'attribute_1'
+        ),
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'boolean'
+            ],
+            'attribute_2'
+        ),
+        ConfigFixture(Config::XML_PAGECACHE_TYPE, Config::VARNISH)
+    ]
+    public function testCacheInvalidation(): void
+    {
+        /** @var AttributeInterface $attribute */
+        $attribute = DataFixtureStorageManager::getStorage()->get('attribute_1');
+
+        /** @var AttributeInterface $attribute2 */
+        $attribute2 = DataFixtureStorageManager::getStorage()->get('attribute_2');
+
+        $query = $this->getAttributeQuery($attribute->getAttributeCode(), "customer");
+        // check cache missed on first query
+        $this->assertCacheMissAndReturnResponse($query, []);
+        // assert cache hit on second query
+        $this->assertCacheHitAndReturnResponse($query, []);
+
+        $attribute->setIsRequired(true);
+        $this->attributeRepository->save($attribute);
+        // assert cache miss after changes
+        $this->assertCacheMissAndReturnResponse($query, []);
+
+        $attribute2->setIsRequired(true);
+        $this->attributeRepository->save($attribute2);
+
+        // assert cache hits on second query after changes, and cache is not invalidated when another entity changed
+        $this->assertCacheHitAndReturnResponse($query, []);
+    }
+
+    #[
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'text'
+            ],
+            'attribute'
+        ),
+        ConfigFixture(Config::XML_PAGECACHE_TYPE, Config::VARNISH)
+    ]
+    public function testCacheInvalidationOnAttributeDelete()
+    {
+        /** @var AttributeInterface $attribute */
+        $attribute = DataFixtureStorageManager::getStorage()->get('attribute');
+        $uidCode = $this->uid->encode('customer', $attribute->getAttributeCode());
+        $attributeCode = $attribute->getAttributeCode();
+
+        $query = $this->getAttributeQuery($attributeCode, "customer");
+
+        // check cache missed on first query
+        $response = $this->assertCacheMissAndReturnResponse($query, []);
+        $assertionMap = [
+            ['response_field' => 'uid', 'expected_value' => $uidCode],
+            ['response_field' => 'code', 'expected_value' => $attributeCode],
+            ['response_field' => 'entity_type', 'expected_value' => 'CUSTOMER'],
+            ['response_field' => 'frontend_input', 'expected_value' => 'TEXT']
+        ];
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+
+        // assert cache hit on second query
+        $response = $this->assertCacheHitAndReturnResponse($query, []);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['items'][0], $assertionMap);
+
+        $this->attributeRepository->delete($attribute);
+        $assertionMap = [
+            ['response_field' => 'type', 'expected_value' => 'ATTRIBUTE_NOT_FOUND'],
+            ['response_field' => 'message', 'expected_value' => sprintf(
+                'Attribute code "%s" could not be found.',
+                $attributeCode
+            )]
+        ];
+        $response = $this->assertCacheMissAndReturnResponse($query, []);
+        $this->assertResponseFields($response['body']['customAttributeMetadataV2']['errors'][0], $assertionMap);
+    }
+
+    #[
+        DataFixture(
+            Attribute::class,
+            [
+                'entity_type_id' => CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
+                'frontend_input' => 'text'
+            ],
+            'attribute'
+        ),
+        ConfigFixture(Config::XML_PAGECACHE_TYPE, Config::VARNISH)
+    ]
+    public function testCacheMissingAttributeParam(): void
+    {
+        /** @var AttributeInterface $attribute */
+        $attribute = DataFixtureStorageManager::getStorage()->get('attribute');
+
+        $query = $this->getAttributeQueryNoCode("customer");
+        // check cache missed on each query
+        $this->assertQueryResultIsCacheMissWithError(
+            $query,
+            "Missing attribute_code for the input entity_type: customer."
+        );
+        $this->assertQueryResultIsCacheMissWithError(
+            $query,
+            "Missing attribute_code for the input entity_type: customer."
+        );
+
+        $query = $this->getAttributeQueryNoEntityType($attribute->getAttributeCode());
+        // check cache missed on each query
+        $this->assertQueryResultIsCacheMissWithError(
+            $query,
+            sprintf("Missing entity_type for the input attribute_code: %s.", $attribute->getAttributeCode())
+        );
+        $this->assertQueryResultIsCacheMissWithError(
+            $query,
+            sprintf("Missing entity_type for the input attribute_code: %s.", $attribute->getAttributeCode())
+        );
+    }
+
+    /**
+     * Assert that query produces an error and the cache is missed.
+     *
+     * @param string $query
+     * @param string $expectedError
+     * @return void
+     * @throws \Exception
+     */
+    private function assertQueryResultIsCacheMissWithError(string $query, string $expectedError)
+    {
+        $caughtException = null;
+        try {
+            // query for response, expect response to be present in exception
+            $this->graphQlQueryWithResponseHeaders($query, []);
+        } catch (ResponseContainsErrorsException $exception) {
+            $caughtException = $exception;
+        }
+        $this->assertInstanceOf(
+            ResponseContainsErrorsException::class,
+            $caughtException
+        );
+        // cannot use expectException because need to assert the headers
+        $this->assertStringContainsString(
+            $expectedError,
+            $caughtException->getMessage()
+        );
+        // assert that it's a miss
+        $this->assertEquals(
+            'MISS',
+            $caughtException->getResponseHeaders()['X-Magento-Cache-Debug']
+        );
+    }
+
+    /**
+     * Prepare and return GraphQL query for given entity type and code.
+     *
+     * @param string $code
+     * @param string $entityType
+     * @return string
+     */
+    private function getAttributeQuery(string $code, string $entityType) : string
+    {
+        return <<<QUERY
+{
+  customAttributeMetadataV2(attributes: [{attribute_code:"{$code}", entity_type:"{$entityType}"}]) {
+    items {
+      uid
+      code
+      label
+      entity_type
+      frontend_input
+      is_required
+      default_value
+      is_unique
+      options {
+        uid
+        label
+        value
+      }
+    }
+    errors {
+      type
+      message
+    }
+  }
+}
+QUERY;
+    }
+
+    /**
+     * Prepare and return GraphQL query for given entity type with no code.
+     *
+     * @param string $entityType
+     *
+     * @return string
+     */
+    private function getAttributeQueryNoCode(string $entityType) : string
+    {
+        return <<<QUERY
+{
+  customAttributeMetadata(attributes:
+  [
+    {
+      entity_type:"{$entityType}"
+    }
+  ]
+  )
+  {
+    items
+    {
+      attribute_code
+      entity_type
+    }
+  }
+ }
+QUERY;
+    }
+
+    /**
+     * Prepare and return GraphQL query for given code with no entity type.
+     *
+     * @param string $code
+     *
+     * @return string
+     */
+    private function getAttributeQueryNoEntityType(string $code) : string
+    {
+        return <<<QUERY
+{
+  customAttributeMetadata(attributes:
+  [
+    {
+      attribute_code:"{$code}"
+    }
+  ]
+  )
+  {
+    items
+    {
+      attribute_code
+      entity_type
+    }
+  }
+ }
+QUERY;
+    }
+}