From ff63e07b05e5973af0a0c646f8ca4da2a4809f71 Mon Sep 17 00:00:00 2001
From: Daniel Tschinder <daniel.tschinder@researchgate.net>
Date: Sun, 11 Feb 2018 18:19:52 +0100
Subject: [PATCH] Improve introspection types + new getIntrospectionQuery()

This adds a new function `getIntrospectionQuery()` which allows for some minor configuration over the resulting query text: to exclude descriptions if your use case does not require them.

ref: graphql/graphql-js#1113
---
 src/Type/Introspection.php                    | 117 ++++--------------
 tests/Type/EnumTypeTest.php                   |   1 -
 tests/Type/IntrospectionTest.php              |   2 +-
 tests/Validator/AbstractQuerySecurityTest.php |   2 +-
 4 files changed, 23 insertions(+), 99 deletions(-)

diff --git a/src/Type/Introspection.php b/src/Type/Introspection.php
index 7326ea4..57be002 100644
--- a/src/Type/Introspection.php
+++ b/src/Type/Introspection.php
@@ -37,11 +37,25 @@ class Introspection
     private static $map = [];
 
     /**
+     * Options:
+     *   - descriptions
+     *     Whether to include descriptions in the introspection result.
+     *     Default: true
+     *
+     * @param array $options
      * @return string
      */
-    public static function getIntrospectionQuery($includeDescription = true)
+    public static function getIntrospectionQuery($options = [])
     {
-        $withDescription = <<<'EOD'
+        if (is_bool($options)) {
+            trigger_error('Calling Introspection::getIntrospectionQuery(boolean) is deprecated. Please use Introspection::getIntrospectionQuery(["descriptions" => boolean]).', E_USER_DEPRECATED);
+            $descriptions = $options;
+        } else {
+            $descriptions = !array_key_exists('descriptions', $options) || $options['descriptions'] === true;
+        }
+        $descriptionField = $descriptions ? 'description' : '';
+
+        return <<<EOD
   query IntrospectionQuery {
     __schema {
       queryType { name }
@@ -52,7 +66,7 @@ class Introspection
       }
       directives {
         name
-        description
+        {$descriptionField}
         locations
         args {
           ...InputValue
@@ -64,10 +78,10 @@ class Introspection
   fragment FullType on __Type {
     kind
     name
-    description
+    {$descriptionField}
     fields(includeDeprecated: true) {
       name
-      description
+      {$descriptionField}
       args {
         ...InputValue
       }
@@ -85,7 +99,7 @@ class Introspection
     }
     enumValues(includeDeprecated: true) {
       name
-      description
+      {$descriptionField}
       isDeprecated
       deprecationReason
     }
@@ -96,7 +110,7 @@ class Introspection
 
   fragment InputValue on __InputValue {
     name
-    description
+    {$descriptionField}
     type { ...TypeRef }
     defaultValue
   }
@@ -134,95 +148,6 @@ class Introspection
     }
   }
 EOD;
-        $withoutDescription = <<<'EOD'
-  query IntrospectionQuery {
-    __schema {
-      queryType { name }
-      mutationType { name }
-      subscriptionType { name }
-      types {
-        ...FullType
-      }
-      directives {
-        name
-        locations
-        args {
-          ...InputValue
-        }
-      }
-    }
-  }
-
-  fragment FullType on __Type {
-    kind
-    name
-    fields(includeDeprecated: true) {
-      name
-      args {
-        ...InputValue
-      }
-      type {
-        ...TypeRef
-      }
-      isDeprecated
-      deprecationReason
-    }
-    inputFields {
-      ...InputValue
-    }
-    interfaces {
-      ...TypeRef
-    }
-    enumValues(includeDeprecated: true) {
-      name
-      isDeprecated
-      deprecationReason
-    }
-    possibleTypes {
-      ...TypeRef
-    }
-  }
-
-  fragment InputValue on __InputValue {
-    name
-    type { ...TypeRef }
-    defaultValue
-  }
-
-  fragment TypeRef on __Type {
-    kind
-    name
-    ofType {
-      kind
-      name
-      ofType {
-        kind
-        name
-        ofType {
-          kind
-          name
-          ofType {
-            kind
-            name
-            ofType {
-              kind
-              name
-              ofType {
-                kind
-                name
-                ofType {
-                  kind
-                  name
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-EOD;
-        return $includeDescription ? $withDescription : $withoutDescription;
     }
 
     public static function getTypes()
diff --git a/tests/Type/EnumTypeTest.php b/tests/Type/EnumTypeTest.php
index ecce357..d278d7b 100644
--- a/tests/Type/EnumTypeTest.php
+++ b/tests/Type/EnumTypeTest.php
@@ -1,7 +1,6 @@
 <?php
 namespace GraphQL\Tests\Type;
 
-use GraphQL\Error\Error;
 use GraphQL\GraphQL;
 use GraphQL\Language\SourceLocation;
 use GraphQL\Schema;
diff --git a/tests/Type/IntrospectionTest.php b/tests/Type/IntrospectionTest.php
index 532028b..e1d92de 100644
--- a/tests/Type/IntrospectionTest.php
+++ b/tests/Type/IntrospectionTest.php
@@ -28,7 +28,7 @@ class IntrospectionTest extends \PHPUnit_Framework_TestCase
             ])
         ]);
 
-        $request = Introspection::getIntrospectionQuery(false);
+        $request = Introspection::getIntrospectionQuery(['descriptions' => false]);
         $expected = array (
             'data' =>
                 array (
diff --git a/tests/Validator/AbstractQuerySecurityTest.php b/tests/Validator/AbstractQuerySecurityTest.php
index 885fc99..7e5e36b 100644
--- a/tests/Validator/AbstractQuerySecurityTest.php
+++ b/tests/Validator/AbstractQuerySecurityTest.php
@@ -53,7 +53,7 @@ abstract class AbstractQuerySecurityTest extends \PHPUnit_Framework_TestCase
 
     protected function assertIntrospectionQuery($maxExpected)
     {
-        $query = Introspection::getIntrospectionQuery(true);
+        $query = Introspection::getIntrospectionQuery();
 
         $this->assertMaxValue($query, $maxExpected);
     }