graycore/magento2-graphql-introspection-cache

v0.1.2 2022-08-25 20:19 UTC

Requires

• php: >=7.4
• magento/framework: ^102.0 || ^103.0
• magento/module-catalog: ^103.0 || ^104.0
• magento/module-eav: ^102.0
• magento/module-graph-ql: ^100.0.0
• magento/module-graph-ql-cache: ^100.0.0

Requires (Dev)

• magento/magento-coding-standard: >=6.0
• phpunit/phpunit: ^8.0 || ^9.0
• squizlabs/php_codesniffer: ^3.0

MIT

README

This module allows you to use the same mechanism that is used for caching regular GraphQL resolvers, for introspection queries.

This helps minimize the number of times Magento is bootstrapped.

The following introspection types are supported out of the box:

• ProductAttributeFilterInput

This module is experimental, it contains BC-fixes for older Magento versions (<2.4.2). Class internals will likely change when support for those versions end.

Getting Started

This module is intended to be installed with composer. From the root of your Magento 2 project:

1. Download the package

composer require graycore/magento2-graphql-introspection-cache

1. Enable the package

./bin/magento module:enable Graycore_GraphQlIntrospectionCache

Usage

You can add your own introspection cache identity by adding a bit of di.xml:

<type name="Graycore\GraphQlIntrospectionCache\Plugin\CachePlugin">
    <arguments>
        <argument xsi:type="array" name="introspectionHandlers">
            <item xsi:type="object" name="NameOfInspectedType">Namespace\Module\Model\Cache\Identity\Introspection\NameOfInspectedType</item>
        </argument>
    </arguments>
</type>

Your class must implement Magento\Framework\GraphQl\Query\Resolver\IdentityInterface.

For more information on GraphQL Cache Identities, please visit the official documentation.

Internals

• A before plugin is created on QueryProcessor::process to set a custom ReferenceExecutor. This ReferenceExecutor is instantiated using the Object Manager, so that we can use plugins on it in a later stage.
• An after plugin is created on ReferenceExecutor::doExecute. This plugin determines if we are dealing with an introspection request and if there is a cache identity registered for it. If there is, it will attempt to generate cache tags and add it to the request.

Check out the unit/integration tests to get a better picture.