https://github.com/graphpql/graphpinator-query-cost

:zap::globe_with_meridians::zap: Modules to limit query cost by restricting maximum depth or number of nodes.
https://github.com/graphpql/graphpinator-query-cost

graphql graphql-php php

Last synced: about 2 months ago
JSON representation

:zap::globe_with_meridians::zap: Modules to limit query cost by restricting maximum depth or number of nodes.

• Host: GitHub
• URL: https://github.com/graphpql/graphpinator-query-cost
• Owner: graphpql
• License: mit
• Created: 2021-05-26T20:43:06.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-10T15:33:06.000Z (about 1 year ago)
• Last Synced: 2024-04-24T03:18:05.945Z (9 months ago)
• Topics: graphql, graphql-php, php
• Language: PHP
• Homepage: https://github.com/graphpql
• Size: 119 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

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

:zap::globe_with_meridians::zap: Modules to limit query cost by restricting maximum depth or number of nodes.

## Introduction

## Installation

Install package using composer

```composer require infinityloop-dev/graphpinator-query-cost```

## How to use

This package includes two modules. They can be used together or each on their own.

- `MaxDepthModule` validates maximum depth of a query.

- `MaxNodesModule` validates that size of a query does not exceed maximum number of nodes. 

    - One node is essentially a single value which is to be resolved. 

    - This module automatically recognises "multiplier" arguments, such as `limit`, which multiply inner number of nodes for that field.

        - Default multiplier arguments are `['limit', 'first', 'last']`, but can be changed using second constructor argument.

        - If you wish to disable this feature, set the constructor argument to empty array.

1. Register selected modules to GraPHPinator:

```php

$depthModule = new \Graphpinator\QueryCost\MaxDepthModule(

    10, // selected maximum depth

);

$nodesModule = new \Graphpinator\QueryCost\MaxNodesModule(

    10000, // selected number of nodes

    ['limit'], // optional: multiplier argument names

);

$graphpinator = new \Graphpinator\Graphpinator(

    $schema,

    $catchExceptions,

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

    $logger,

);

```

2. You are all set, queries are validated for maximum depth/maximum number of nodes.