Enable rector/type-perfect for stricter type checking

But ignore unavoidable interface returns on public APIs

Author: jeromegamez

UPGRADE-8.0.md

@@ -50,6 +50,8 @@ The following list has been generated with [roave/backward-compatibility-check](
 [BC] CHANGED: The parameter $clearTextPassword of Kreait\Firebase\Request\EditUserTrait#withClearTextPassword() changed from Stringable|string to string
 [BC] CHANGED: The parameter $code of Kreait\Firebase\Exception\Database\TransactionFailed#__construct() changed from int to a non-contravariant Throwable|null
 [BC] CHANGED: The parameter $code of Kreait\Firebase\Exception\Database\UnsupportedQuery#__construct() changed from int to a non-contravariant Throwable|null
+[BC] CHANGED: The parameter $config of Kreait\Firebase\Messaging\CloudMessage#withAndroidConfig() changed from no type to a non-contravariant Kreait\Firebase\Messaging\AndroidConfig|array
+[BC] CHANGED: The parameter $config of Kreait\Firebase\Messaging\CloudMessage#withApnsConfig() changed from no type to a non-contravariant Kreait\Firebase\Messaging\ApnsConfig|array
 [BC] CHANGED: The parameter $email of Kreait\Firebase\Contract\Auth#createUserWithEmailAndPassword() changed from Stringable|string to a non-contravariant string
 [BC] CHANGED: The parameter $email of Kreait\Firebase\Contract\Auth#createUserWithEmailAndPassword() changed from Stringable|string to string
 [BC] CHANGED: The parameter $email of Kreait\Firebase\Contract\Auth#getEmailActionLink() changed from Stringable|string to a non-contravariant string
@@ -147,6 +149,9 @@ The following list has been generated with [roave/backward-compatibility-check](
 [BC] CHANGED: The parameter $url of Kreait\Firebase\Request\EditUserTrait#withPhotoUrl() changed from Stringable|string to string
 [BC] CHANGED: The parameter $user of Kreait\Firebase\Contract\Auth#signInAsUser() changed from Kreait\Firebase\Auth\UserRecord|Stringable|string to Kreait\Firebase\Auth\UserRecord|string
 [BC] CHANGED: The parameter $user of Kreait\Firebase\Contract\Auth#signInAsUser() changed from Kreait\Firebase\Auth\UserRecord|Stringable|string to a non-contravariant Kreait\Firebase\Auth\UserRecord|string
+[BC] CHANGED: The parameter $value of Kreait\Firebase\Messaging\ApnsConfig#withDataField() changed from mixed to a non-contravariant string
+[BC] CHANGED: The parameter $value of Kreait\Firebase\RemoteConfig\ConditionalValue#withValue() changed from no type to Kreait\Firebase\RemoteConfig\ParameterValue|array|string
+[BC] CHANGED: The parameter $value of Kreait\Firebase\RemoteConfig\ConditionalValue#withValue() changed from no type to a non-contravariant Kreait\Firebase\RemoteConfig\ParameterValue|array|string
 [BC] CHANGED: The return type of Kreait\Firebase\RemoteConfig\ConditionalValue#value() changed from no type to string|array
 [BC] CHANGED: The return type of Kreait\Firebase\RemoteConfig\TagColor#__toString() changed from no type to string
 [BC] REMOVED: Class Kreait\Firebase\Contract\DynamicLinks has been deleted

phpstan.neon.dist

@@ -38,6 +38,13 @@ parameters:
 	reportPossiblyNonexistentConstantArrayOffset: true
 	# reportPossiblyNonexistentGeneralArrayOffset: true
 	reportAnyTypeWideningInVarTag: true
+
+	type_perfect:
+		no_mixed_property: true
+		no_mixed_caller: true
+		null_over_false: true
+		narrow_param: false
+		narrow_return: true
 includes:
 	- vendor/cuyz/valinor/qa/PHPStan/valinor-phpstan-configuration.php
 	- vendor/phpstan/phpstan/conf/bleedingEdge.neon

src/Firebase/Auth/CreateActionLink/GuzzleApiClientHandler.php

@@ -13,7 +13,6 @@
 use Kreait\Firebase\Auth\ProjectAwareAuthResourceUrlBuilder;
 use Kreait\Firebase\Auth\TenantAwareAuthResourceUrlBuilder;
 use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Message\RequestInterface;
 
 use function array_filter;
 
@@ -68,7 +67,7 @@ public function handle(CreateActionLink $action): string
         return (string) $actionCode;
     }
 
-    private function createRequest(CreateActionLink $action): RequestInterface
+    private function createRequest(CreateActionLink $action): Request
     {
         $data = [
             'requestType' => $action->type(),

src/Firebase/Auth/CreateSessionCookie/GuzzleApiClientHandler.php

@@ -13,7 +13,6 @@
 use Kreait\Firebase\Auth\ProjectAwareAuthResourceUrlBuilder;
 use Kreait\Firebase\Auth\TenantAwareAuthResourceUrlBuilder;
 use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Message\RequestInterface;
 
 use function array_filter;
 
@@ -63,7 +62,7 @@ public function handle(CreateSessionCookie $action): string
         throw new FailedToCreateSessionCookie($action, $response, 'The response did not contain a session cookie');
     }
 
-    private function createRequest(CreateSessionCookie $action): RequestInterface
+    private function createRequest(CreateSessionCookie $action): Request
     {
         $data = [
             'idToken' => $action->idToken(),

src/Firebase/Auth/SendActionLink/GuzzleApiClientHandler.php

@@ -12,7 +12,6 @@
 use Kreait\Firebase\Auth\SendActionLink;
 use Kreait\Firebase\Auth\TenantAwareAuthResourceUrlBuilder;
 use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Message\RequestInterface;
 
 use function array_filter;
 
@@ -50,7 +49,7 @@ public function handle(SendActionLink $action): void
         }
     }
 
-    private function createRequest(SendActionLink $action): RequestInterface
+    private function createRequest(SendActionLink $action): Request
     {
         $data = [
             'requestType' => $action->type(),

src/Firebase/Auth/SignIn/GuzzleHandler.php

@@ -21,7 +21,6 @@
 use Kreait\Firebase\Auth\SignInWithRefreshToken;
 use Kreait\Firebase\Util;
 use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Message\RequestInterface;
 use UnexpectedValueException;
 
 use function http_build_query;
@@ -77,7 +76,7 @@ public function handle(SignIn $action): SignInResult
         return SignInResult::fromData($data);
     }
 
-    private function createApiRequest(SignIn $action): RequestInterface
+    private function createApiRequest(SignIn $action): Request
     {
         return match (true) {
             $action instanceof SignInAnonymously => $this->anonymous($action),

src/Firebase/Factory.php

@@ -303,6 +303,9 @@ public function withClock(object $clock): self
         return $factory;
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createAppCheck(): Contract\AppCheck
     {
         $projectId = $this->getProjectId();
@@ -336,6 +339,9 @@ public function createAppCheck(): Contract\AppCheck
         );
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createAuth(): Contract\Auth
     {
         $projectId = $this->getProjectId();
@@ -358,6 +364,9 @@ public function createAuth(): Contract\Auth
         return new Auth($authApiClient, $customTokenGenerator, $idTokenVerifier, $sessionCookieVerifier, $this->clock);
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createDatabase(): Contract\Database
     {
         $middlewares = array_filter([
@@ -379,6 +388,9 @@ public function createDatabase(): Contract\Database
         );
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createRemoteConfig(): Contract\RemoteConfig
     {
         $http = $this->createApiClient([
@@ -394,6 +406,9 @@ public function createRemoteConfig(): Contract\RemoteConfig
         );
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createMessaging(): Contract\Messaging
     {
         $projectId = $this->getProjectId();
@@ -437,6 +452,9 @@ public function createFirestore(?string $databaseName = null): Contract\Firestor
         return Firestore::fromConfig($config);
     }
 
+    /**
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
+     */
     public function createStorage(): Contract\Storage
     {
         try {

src/Firebase/Firestore.php

@@ -19,6 +19,8 @@ private function __construct(private FirestoreClient $client)
 
     /**
      * @param array<non-empty-string, mixed> $config
+     *
+     * @phpstan-ignore typePerfect.narrowReturnObjectType
      */
     public static function fromConfig(array $config): Contract\Firestore
     {

src/Firebase/Messaging.php

@@ -271,7 +271,7 @@ private function messageHasTarget(Message $message): bool
             || array_key_exists(MessageTarget::TOPIC, $check);
     }
 
-    private function withChangedTarget(Message $message, string $target, string $value): Message
+    private function withChangedTarget(Message $message, string $target, string $value): RawMessageFromArray
     {
         $message = Json::decode(Json::encode($message), true);
 

src/Firebase/Messaging/ApnsConfig.php

@@ -105,7 +105,7 @@ public function withApsField(string $key, mixed $value): self
     /**
      * @param non-empty-string $name
      */
-    public function withDataField(string $name, mixed $value): self
+    public function withDataField(string $name, string $value): self
     {
         if ($name === 'aps') {
             throw new InvalidArgument('"aps" is a reserved field name');