https://github.com/graphpql/graphpinator-persisted-queries

:zap::globe_with_meridians::zap: Module to persist validated query in cache and improve performace of repeating queries.
https://github.com/graphpql/graphpinator-persisted-queries

graphql graphql-php php

Last synced: about 2 months ago
JSON representation

:zap::globe_with_meridians::zap: Module to persist validated query in cache and improve performace of repeating queries.

• Host: GitHub
• URL: https://github.com/graphpql/graphpinator-persisted-queries
• Owner: graphpql
• License: mit
• Created: 2021-05-29T13:00:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T12:12:12.000Z (3 months ago)
• Last Synced: 2024-10-19T16:23:27.239Z (3 months ago)
• Topics: graphql, graphql-php, php
• Language: PHP
• Homepage: https://github.com/graphpql
• Size: 460 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# GraPHPinator Persisted Queries [![PHP](https://github.com/infinityloop-dev/graphpinator-persisted-queries/workflows/PHP/badge.svg?branch=master)](https://github.com/infinityloop-dev/graphpinator-persisted-queries/actions?query=workflow%3APHP) [![codecov](https://codecov.io/gh/infinityloop-dev/graphpinator-persisted-queries/branch/master/graph/badge.svg)](https://codecov.io/gh/infinityloop-dev/graphpinator-persisted-queries)

:zap::globe_with_meridians::zap: Module to persist validated query in cache and improve performace of repeating queries.

## Introduction

This Module allows GraPHPinator to cache queries on the server to reduce server load. This module aims to reduce GraphQL overhead in parsing and validation by caching and reusing known requests.

> Please note that this module does not affect the speed of your resolver functions.

## Installation

Install package using composer

```composer require infinityloop-dev/graphpinator-persisted-queries```

## How to use

1. Implement `\Psr\SimpleCache\CacheInterface`

You need implementation of `\Psr\SimpleCache\CacheInterface` where the serialized version of request is stored for later reuse.

2. Register `PersistedQueriesModule` as GraPHPinator module:

```php

$persistModule = new \Graphpinator\PersistedQueriesModule\PersistedQueriesModule($schema, $cacheImpl);

$graphpinator = new \Graphpinator\Graphpinator(

    $schema,

    $catchExceptions,

    new \Graphpinator\Module\ModuleSet([$persistModule, /* possibly other modules */]),

    $logger,

);

```

3. You are all set, queries are automatically cached in specified storage.

## Performance improvements

Simple benchmark (code in `bench` directory) shows approximatelly 80% reduction of GraphQL overhead.

Benchmark runs the same query 10k times, with 5 warmup queries before. Cache in use is a simple implementation using Redis on localhost, connection is done using php-redis extension. Opcache was disabled.

| CPU model | Time WITHOUT module | Time WITH module |

| --------- | ------------------- | ---------------- |

| Ryzen 5900X | ~12.44 s | ~2.16 s |

| Ryzen 5600X (using VMware) | ~24.83 s | ~4.69 s |

| Ryzen 5 3600 | ~14.97 s | ~2.77 s |