Merge pull request #124 from mcg-web/use-dedicated-exception-for-type-parsing-error

Throw UserError vs InvariantViolationError for errors caused by client

Author: vladar

src/Error/UserError.php

@@ -0,0 +1,14 @@
+<?php
+namespace GraphQL\Error;
+
+/**
+ * Class UserError
+ *
+ * Note:
+ * Error that can be display safely to client...
+ *
+ * @package GraphQL\Error
+ */
+class UserError extends InvariantViolation
+{
+}

src/Type/Definition/FloatType.php

@@ -1,7 +1,7 @@
 <?php
 namespace GraphQL\Type\Definition;
 
-use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\UserError;
 use GraphQL\Language\AST\FloatValueNode;
 use GraphQL\Language\AST\IntValueNode;
 use GraphQL\Utils;
@@ -50,14 +50,14 @@ public function parseValue($value)
     private function coerceFloat($value)
     {
         if ($value === '') {
-            throw new InvariantViolation(
+            throw new UserError(
                 'Float cannot represent non numeric value: (empty string)'
             );
         }
         if (is_numeric($value) || $value === true || $value === false) {
             return (float)$value;
         }
-        throw new InvariantViolation('Float cannot represent non numeric value: ' . Utils::printSafe($value));
+        throw new UserError(sprintf('Float cannot represent non numeric value: %s', Utils::printSafe($value)));
     }
 
     /**

src/Type/Definition/IntType.php

@@ -1,7 +1,7 @@
 <?php
 namespace GraphQL\Type\Definition;
 
-use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\UserError;
 use GraphQL\Language\AST\IntValueNode;
 use GraphQL\Language\AST\ValueNode;
 use GraphQL\Utils;
@@ -57,7 +57,7 @@ public function parseValue($value)
     private function coerceInt($value)
     {
         if ($value === '') {
-            throw new InvariantViolation(
+            throw new UserError(
                 'Int cannot represent non 32-bit signed integer value: (empty string)'
             );
         }
@@ -67,8 +67,8 @@ private function coerceInt($value)
         if (is_numeric($value) && $value <= self::MAX_INT && $value >= self::MIN_INT) {
             return (int) $value;
         }
-        throw new InvariantViolation(
-            'Int cannot represent non 32-bit signed integer value: ' . Utils::printSafe($value)
+        throw new UserError(
+            sprintf('Int cannot represent non 32-bit signed integer value: %s', Utils::printSafe($value))
         );
     }
 

src/Type/Definition/ObjectType.php

@@ -1,6 +1,7 @@
 <?php
 namespace GraphQL\Type\Definition;
 use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\UserError;
 use GraphQL\Utils;
 
 
@@ -127,7 +128,7 @@ public function getField($name)
             $this->getFields();
         }
         if (!isset($this->fields[$name])) {
-            throw new InvariantViolation(sprintf("Field '%s' is not defined for type '%s'", $name, $this->name));
+            throw new UserError(sprintf("Field '%s' is not defined for type '%s'", $name, $this->name));
         }
         return $this->fields[$name];
     }
@@ -145,7 +146,7 @@ public function getInterfaces()
             foreach ($interfaces as $iface) {
                 $iface = Type::resolve($iface);
                 if (!$iface instanceof InterfaceType) {
-                    throw new InvariantViolation("Expecting interface type, got " . Utils::printSafe($iface));
+                    throw new InvariantViolation(sprintf('Expecting interface type, got %s', Utils::printSafe($iface)));
                 }
                 $this->interfaces[] = $iface;
             }

tests/Type/ScalarSerializationTest.php

@@ -1,7 +1,7 @@
 <?php
 namespace GraphQL\Tests\Type;
 
-use GraphQL\Error\InvariantViolation;
+use GraphQL\Error\UserError;
 use GraphQL\Type\Definition\Type;
 
 class ScalarSerializationTest extends \PHPUnit_Framework_TestCase
@@ -28,28 +28,28 @@ public function testSerializesOutputInt()
         try {
             $intType->serialize(9876504321);
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: 9876504321', $e->getMessage());
         }
 
         try {
             $intType->serialize(-9876504321);
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: -9876504321', $e->getMessage());
         }
 
         try {
             $intType->serialize(1e100);
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: 1.0E+100', $e->getMessage());
         }
 
         try {
             $intType->serialize(-1e100);
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: -1.0E+100', $e->getMessage());
         }
 
@@ -58,14 +58,14 @@ public function testSerializesOutputInt()
         try {
             $intType->serialize('one');
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: one', $e->getMessage());
         }
 
         try {
             $intType->serialize('');
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Int cannot represent non 32-bit signed integer value: (empty string)', $e->getMessage());
         }
 
@@ -92,14 +92,14 @@ public function testSerializesOutputFloat()
         try {
             $floatType->serialize('one');
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Float cannot represent non numeric value: one', $e->getMessage());
         }
 
         try {
             $floatType->serialize('');
             $this->fail('Expected exception was not thrown');
-        } catch (InvariantViolation $e) {
+        } catch (UserError $e) {
             $this->assertEquals('Float cannot represent non numeric value: (empty string)', $e->getMessage());
         }