Propagate client-safety of endpoint errors (#48)

spawnia · Jan 4, 2022 · e567c4c · e567c4c
1 parent 7a1d2eb
commit e567c4c
Show file tree

Hide file tree

Showing 48 changed files with 454 additions and 123 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v0.16.0
+
+### Added
+
+- Add configuration `EndpointConfig::errorsAreClientSafe()` to propagate client-safety of endpoint errors
+
+### Changed
+
+- Move `Spawnia\Sailor\ResultErrorsException` to `Spawnia\Sailor\Error\ResultErrorsException`
+- Move `Spawnia\Sailor\InvalidDataException` to `Spawnia\Sailor\Error\InvalidDataException`
+- Include only messages in `ResultErrorsException::$message`, expose full `Error` objects as `ResultErrorsException::$errors`
+
+### Removed
+
+- Remove `Spawnia\Sailor\Response::assertErrorFree()`
+
 ## v0.15.0
 
 ### Added

diff --git a/examples/custom-types/expected/Operations/MyBenSampoEnumQuery/MyBenSampoEnumQuery.php b/examples/custom-types/expected/Operations/MyBenSampoEnumQuery/MyBenSampoEnumQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'withBenSampoEnum' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\CustomTypes\TypeConverters\BenSampoEnumConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/custom-types/expected/Operations/MyCustomEnumQuery/MyCustomEnumQuery.php b/examples/custom-types/expected/Operations/MyCustomEnumQuery/MyCustomEnumQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'withCustomEnum' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\CustomTypes\TypeConverters\CustomEnumConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/custom-types/expected/Operations/MyDefaultEnumQuery/MyDefaultEnumQuery.php b/examples/custom-types/expected/Operations/MyDefaultEnumQuery/MyDefaultEnumQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/custom-types/expected/Operations/MyEnumInputQuery/MyEnumInputQuery.php b/examples/custom-types/expected/Operations/MyEnumInputQuery/MyEnumInputQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'withEnumInput' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\CustomTypes\Operations\MyEnumInputQuery\WithEnumInput\EnumObject),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/custom-types/expected/Operations/MyEnumInputQuery/WithEnumInput/EnumObject.php b/examples/custom-types/expected/Operations/MyEnumInputQuery/WithEnumInput/EnumObject.php
@@ -40,4 +40,9 @@ protected function converters(): array
             'default' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\EnumConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/custom-types/expected/Types/EnumInput.php b/examples/custom-types/expected/Types/EnumInput.php
@@ -37,4 +37,9 @@ protected function converters(): array
             'custom' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\CustomTypes\TypeConverters\CustomEnumConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'custom-types';
+    }
 }
diff --git a/examples/input/expected/Operations/TakeSomeInput/TakeSomeInput.php b/examples/input/expected/Operations/TakeSomeInput/TakeSomeInput.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'takeSomeInput' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IntConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
 }
diff --git a/examples/input/expected/Types/SomeInput.php b/examples/input/expected/Types/SomeInput.php
@@ -53,4 +53,9 @@ protected function converters(): array
             'nested' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Input\Types\SomeInput),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'input';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/AllMembers/AllMembers.php b/examples/polymorphic/expected/Operations/AllMembers/AllMembers.php
@@ -37,4 +37,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/AllMembers/Members/Organization.php b/examples/polymorphic/expected/Operations/AllMembers/Members/Organization.php
@@ -34,4 +34,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/AllMembers/Members/User.php b/examples/polymorphic/expected/Operations/AllMembers/Members/User.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'name' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/NodeMembers/Members/Organization.php b/examples/polymorphic/expected/Operations/NodeMembers/Members/Organization.php
@@ -26,4 +26,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/NodeMembers/Members/User.php b/examples/polymorphic/expected/Operations/NodeMembers/Members/User.php
@@ -34,4 +34,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/NodeMembers/NodeMembers.php b/examples/polymorphic/expected/Operations/NodeMembers/NodeMembers.php
@@ -37,4 +37,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/UserOrPost/Node/Post.php b/examples/polymorphic/expected/Operations/UserOrPost/Node/Post.php
@@ -40,4 +40,9 @@ protected function converters(): array
             'title' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/UserOrPost/Node/Task.php b/examples/polymorphic/expected/Operations/UserOrPost/Node/Task.php
@@ -34,4 +34,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/UserOrPost/Node/User.php b/examples/polymorphic/expected/Operations/UserOrPost/Node/User.php
@@ -40,4 +40,9 @@ protected function converters(): array
             'name' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/polymorphic/expected/Operations/UserOrPost/UserOrPost.php b/examples/polymorphic/expected/Operations/UserOrPost/UserOrPost.php
@@ -38,4 +38,9 @@ protected function converters(): array
             '__typename' => new \Spawnia\Sailor\Convert\NonNullConverter(new \Spawnia\Sailor\Convert\StringConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'polymorphic';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyObjectNestedQuery/MyObjectNestedQuery.php b/examples/simple/expected/Operations/MyObjectNestedQuery/MyObjectNestedQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'singleObject' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Simple\Operations\MyObjectNestedQuery\SingleObject\SomeObject),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyObjectNestedQuery/SingleObject/Nested/SomeObject.php b/examples/simple/expected/Operations/MyObjectNestedQuery/SingleObject/Nested/SomeObject.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'value' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IntConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyObjectNestedQuery/SingleObject/SomeObject.php b/examples/simple/expected/Operations/MyObjectNestedQuery/SingleObject/SomeObject.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'nested' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Simple\Operations\MyObjectNestedQuery\SingleObject\Nested\SomeObject),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyObjectQuery/MyObjectQuery.php b/examples/simple/expected/Operations/MyObjectQuery/MyObjectQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'singleObject' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Simple\Operations\MyObjectQuery\SingleObject\SomeObject),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyObjectQuery/SingleObject/SomeObject.php b/examples/simple/expected/Operations/MyObjectQuery/SingleObject/SomeObject.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'value' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IntConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/MyScalarQuery/MyScalarQuery.php b/examples/simple/expected/Operations/MyScalarQuery/MyScalarQuery.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'scalarWithArg' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IDConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/examples/simple/expected/Operations/TwoArgs/TwoArgs.php b/examples/simple/expected/Operations/TwoArgs/TwoArgs.php
@@ -34,4 +34,9 @@ protected function converters(): array
             'twoArgs' => new \Spawnia\Sailor\Convert\NullConverter(new \Spawnia\Sailor\Convert\IDConverter),
         ];
     }
+
+    public static function endpoint(): string
+    {
+        return 'simple';
+    }
 }
diff --git a/src/BelongsToEndpoint.php b/src/BelongsToEndpoint.php
@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor;
+
+interface BelongsToEndpoint
+{
+    /**
+     * The configured endpoint this class belongs to.
+     */
+    public static function endpoint(): string;
+}
diff --git a/src/Codegen/ObjectLikeBuilder.php b/src/Codegen/ObjectLikeBuilder.php
@@ -31,7 +31,7 @@ class ObjectLikeBuilder
      */
     private array $optionalProperties = [];
 
-    public function __construct(string $name, string $namespace)
+    public function __construct(string $name, string $namespace, string $endpointName)
     {
         $class = new ClassType($name, new PhpNamespace($namespace));
 
@@ -55,6 +55,8 @@ public function __construct(string $name, string $namespace)
         );
         $this->converters = $converters;
 
+        ClassHelper::setEndpoint($class, $endpointName);
+
         $this->class = $class;
     }
 

diff --git a/src/Codegen/OperationGenerator.php b/src/Codegen/OperationGenerator.php
@@ -352,7 +352,8 @@ protected function makeObjectLikeBuilder(string $name): ObjectLikeBuilder
     {
         return new ObjectLikeBuilder(
             $name,
-            $this->currentNamespace()
+            $this->currentNamespace(),
+            $this->endpointName
         );
     }
 

diff --git a/src/Console/IntrospectCommand.php b/src/Console/IntrospectCommand.php
@@ -35,10 +35,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         /** @var string $endpointName */
         foreach ($endpointNames as $endpointName) {
             echo "Running introspection on endpoint {$endpointName}...\n";
-            $generator = new Introspector(
-                Configuration::endpoint($endpointName)
-            );
-            $generator->introspect();
+            (new Introspector(
+                Configuration::endpoint($endpointName),
+                $endpointName
+            ))->introspect();
         }
 
         echo "Successfully introspected. You might want to rerun codegen: vendor/bin/sailor\n";

diff --git a/src/EndpointConfig.php b/src/EndpointConfig.php
@@ -55,6 +55,14 @@ public function parseError(stdClass $error): Error
         return Error::fromStdClass($error);
     }
 
+    /**
+     * Is it safe to display the errors from the endpoint to clients?
+     */
+    public function errorsAreClientSafe(): bool
+    {
+        return false;
+    }
+
     /**
      * Return a map from type names to a TypeConfig describing how to deal with them.
      *

diff --git a/src/Error/Error.php b/src/Error/Error.php
@@ -3,13 +3,16 @@
 namespace Spawnia\Sailor\Error;
 
 use Exception;
+use GraphQL\Error\ClientAware;
 use stdClass;
 
 /**
  * Representation of an error according to https://spec.graphql.org/October2021/#sec-Errors.
  */
-class Error extends Exception
+class Error extends Exception implements ClientAware
 {
+    use OriginatesFromEndpoint;
+
     /**
      * Description of the error intended for the developer as a guide to understand and correct the error.
      *

diff --git a/src/InvalidDataException.php → src/Error/InvalidDataException.php b/src/InvalidDataException.php → src/Error/InvalidDataException.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Spawnia\Sailor;
+namespace Spawnia\Sailor\Error;
 
 class InvalidDataException extends \Exception
 {