API Strongly type everything

silverstripe · May 3, 2022 · a99055b · a99055b
1 parent cc1d219
commit a99055b
Show file tree

Hide file tree

Showing 110 changed files with 289 additions and 1,831 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -17,9 +17,11 @@ matrix:
     - php: 7.4
       env: DB=PGSQL PHPUNIT_TEST=1 PHPCS_TEST=1
     - php: 8.0
-      env: DB=MYSQL PDO=1 PHPUNIT_TEST=1
+      env: DB=MYSQL PDO=1 PHPUNIT_TEST=1 #PHPUNIT_COVERAGE_TEST=1
     - php: 7.4
       env: DB=MYSQL BEHAT_TEST=1 BEHAT_SUITE="asset-admin --config vendor/silverstripe/asset-admin/behat.yml"
+    - php: 8.0
+      env: DB=PGSQL PHPUNIT_TEST=1
     - php: 8.0
       env: DB=MYSQL BEHAT_TEST=1 BEHAT_SUITE="silverstripe-elemental --config vendor/dnadesign/silverstripe-elemental/behat.yml"
     - php: 8.1.0

diff --git a/_config.php b/_config.php
@@ -3,4 +3,4 @@
 // Set to 3.0.0 to show APIs marked for removal at that version
 use SilverStripe\Dev\Deprecation;
 
-Deprecation::notification_version('2.0.0', 'silverstripe/graphql');
+Deprecation::notification_version('4.0.0', 'silverstripe/graphql');
diff --git a/composer.json b/composer.json
@@ -5,15 +5,18 @@
     "license": "BSD-3-Clause",
     "require": {
         "php": "^7.4 || ^8.0",
-        "silverstripe/framework": "^4.10",
+        "silverstripe/framework": "^4.11",
         "silverstripe/vendor-plugin": "^1.0",
         "webonyx/graphql-php": "^14.0",
-        "silverstripe/event-dispatcher": "^0.1.2"
+        "silverstripe/event-dispatcher": "^0.1.2",
+        "guzzlehttp/guzzle": "^7.3",
+        "guzzlehttp/psr7": "^2",
+        "m1/env": "^2.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
         "squizlabs/php_codesniffer": "^3.0",
-		"silverstripe/versioned": "^1.0@dev"
+        "silverstripe/versioned": "^1.0@dev"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Auth/AuthenticatorInterface.php b/src/Auth/AuthenticatorInterface.php
@@ -37,13 +37,13 @@ interface AuthenticatorInterface
      * @return Member               If authentication is successful
      * @throws ValidationException  If authentication fails
      */
-    public function authenticate(HTTPRequest $request);
+    public function authenticate(HTTPRequest $request): ?Member;
 
     /**
      * Determine if this authenticator is applicable to the current request
      *
      * @param HTTPRequest $request
      * @return bool
      */
-    public function isApplicable(HTTPRequest $request);
+    public function isApplicable(HTTPRequest $request): bool;
 }
diff --git a/src/Auth/BasicAuthAuthenticator.php b/src/Auth/BasicAuthAuthenticator.php
@@ -6,24 +6,25 @@
 use SilverStripe\Control\HTTPResponse_Exception;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Security\BasicAuth;
+use SilverStripe\Security\Member;
 
 /**
  * An authenticator using SilverStripe's BasicAuth
  */
 class BasicAuthAuthenticator implements AuthenticatorInterface
 {
-    public function authenticate(HTTPRequest $request)
+    public function authenticate(HTTPRequest $request): ?Member
     {
         try {
-            return BasicAuth::requireLogin($request, 'Restricted resource');
+            return BasicAuth::requireLogin($request, 'Restricted resource') ?: null;
         } catch (HTTPResponse_Exception $ex) {
             // BasicAuth::requireLogin may throw its own exception with an HTTPResponse in it
             $failureMessage = (string) $ex->getResponse()->getBody();
             throw new ValidationException($failureMessage, 401);
         }
     }
 
-    public function isApplicable(HTTPRequest $request)
+    public function isApplicable(HTTPRequest $request): bool
     {
         if ($this->hasAuthHandler('HTTP_AUTHORIZATION')
             || $this->hasAuthHandler('REDIRECT_HTTP_AUTHORIZATION')
@@ -42,7 +43,7 @@ public function isApplicable(HTTPRequest $request)
      * @param  string $servervar
      * @return bool
      */
-    protected function hasAuthHandler($servervar)
+    protected function hasAuthHandler(string $servervar): bool
     {
         return isset($_SERVER[$servervar]) && preg_match('/Basic\s+(.*)$/i', $_SERVER[$servervar] ?? '');
     }

diff --git a/src/Auth/Handler.php b/src/Auth/Handler.php
@@ -65,7 +65,7 @@ public function requireAuthentication(HTTPRequest $request)
      * @param HTTPRequest $request
      * @return null|AuthenticatorInterface
      */
-    public function getAuthenticator(HTTPRequest $request)
+    public function getAuthenticator(HTTPRequest $request): ?AuthenticatorInterface
     {
         // Get list of default authenticators
         $authenticators = $this->config()->get('authenticators');
@@ -89,7 +89,7 @@ public function getAuthenticator(HTTPRequest $request)
      * @return AuthenticatorInterface
      * @throws ValidationException
      */
-    protected function buildAuthenticator($authenticator)
+    protected function buildAuthenticator(string $authenticator): AuthenticatorInterface
     {
         if (!ClassInfo::classImplements($authenticator, AuthenticatorInterface::class)) {
             throw new ValidationException(
@@ -106,7 +106,7 @@ protected function buildAuthenticator($authenticator)
      *
      * @param array $authenticators
      */
-    public function prioritiseAuthenticators(&$authenticators)
+    public function prioritiseAuthenticators(array &$authenticators): void
     {
         usort($authenticators, function ($a, $b) {
             // Set some default values

diff --git a/src/Auth/MemberAuthenticator.php b/src/Auth/MemberAuthenticator.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\GraphQL\Auth;
 
 use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Security\Member;
 use SilverStripe\Security\Security;
 
 /**
@@ -19,18 +20,12 @@
  */
 class MemberAuthenticator implements AuthenticatorInterface
 {
-    public function authenticate(HTTPRequest $request)
+    public function authenticate(HTTPRequest $request): ?Member
     {
         return Security::getCurrentUser();
     }
 
-    /**
-     * Determine if this authenticator is applicable to the current request
-     *
-     * @param HTTPRequest $request
-     * @return bool
-     */
-    public function isApplicable(HTTPRequest $request)
+    public function isApplicable(HTTPRequest $request): bool
     {
         $user = Security::getCurrentUser();
         return !empty($user);

diff --git a/src/Config/Configuration.php b/src/Config/Configuration.php
@@ -52,12 +52,9 @@ public function get($path, $default = null)
     }
 
     /**
-     * @param $path
-     * @param callable $callback
-     * @return $this
      * @throws SchemaBuilderException
      */
-    private function path($path, $callback): void
+    private function path($path, callable $callback): void
     {
         if (is_string($path)) {
             $path = explode('.', $path ?? '');

diff --git a/src/Config/ModelConfiguration.php b/src/Config/ModelConfiguration.php
@@ -46,12 +46,9 @@ public function getOperationConfig(string $operation): array
     }
 
     /**
-     * @param string $class
-     * @param array $mapping
-     * @return string
      * @throws SchemaBuilderException
      */
-    public function getTypeName(string $class, $mapping = []): string
+    public function getTypeName(string $class, array $mapping = []): string
     {
         $typeName = $this->formatClass($class);
         $prefix = $this->getPrefix($class);