fix: protobuf 4.31 deprecations (#616)

Author: hotrush

.github/workflows/lint.yml

@@ -16,3 +16,5 @@ jobs:
     static-analysis:
         name: PHPStan Static Analysis
         uses: GoogleCloudPlatform/php-tools/.github/workflows/static-analysis.yml@main
+        with:
+          autoload-file: tests/bootstrap_phpstan.php

src/Serializer.php

@@ -344,7 +344,7 @@ private function encodeMessageImpl(Message $message, Descriptor $messageType)
                     $arr[$this->encodeElement($keyField, $k)] = $this->encodeElement($valueField, $vv);
                 }
                 $v = $arr;
-            } elseif ($field->getLabel() === GPBLabel::REPEATED) {
+            } elseif ($this->checkFieldRepeated($field)) {
                 $arr = [];
                 foreach ($v as $k => $vv) {
                     $arr[$k] = $this->encodeElement($field, $vv);
@@ -427,7 +427,7 @@ private function decodeMessageImpl(Message $message, Descriptor $messageType, ar
                     $arr[$this->decodeElement($keyField, $k)] = $this->decodeElement($valueField, $vv);
                 }
                 $value = $arr;
-            } elseif ($field->getLabel() === GPBLabel::REPEATED) {
+            } elseif ($this->checkFieldRepeated($field)) {
                 $arr = [];
                 foreach ($v as $k => $vv) {
                     $arr[$k] = $this->decodeElement($field, $vv);
@@ -447,6 +447,17 @@ private function decodeMessageImpl(Message $message, Descriptor $messageType, ar
         return $message;
     }
 
+    /**
+     * @param FieldDescriptor $field
+     * @return bool
+     */
+    private function checkFieldRepeated(FieldDescriptor $field): bool
+    {
+        return method_exists($field, 'isRepeated')
+            ? $field->isRepeated()
+            : $field->getLabel() === GPBLabel::REPEATED;
+    }
+
     /**
      * @param string $name
      * @return string Getter function

tests/Unit/CredentialsWrapperTest.php

@@ -61,12 +61,12 @@ class CredentialsWrapperTest extends TestCase
     public function testBuildWithoutExplicitKeyFile($args, $expectedCredentialsWrapper)
     {
         $appDefaultCreds = getenv('GOOGLE_APPLICATION_CREDENTIALS');
-        putenv('GOOGLE_APPLICATION_CREDENTIALS=' . __DIR__ . '/testdata/json-key-file.json');
+        $this->setEnv('GOOGLE_APPLICATION_CREDENTIALS', __DIR__ . '/testdata/json-key-file.json');
 
         $actualCredentialsWrapper = CredentialsWrapper::build($args);
         $this->assertEquals($expectedCredentialsWrapper, $actualCredentialsWrapper);
 
-        putenv('GOOGLE_APPLICATION_CREDENTIALS=' . $appDefaultCreds);
+        $this->setEnv('GOOGLE_APPLICATION_CREDENTIALS', $appDefaultCreds);
     }
 
     /**
@@ -81,7 +81,7 @@ public function testBuildWithKeyFile($args, $expectedCredentialsWrapper)
     public function buildDataWithoutExplicitKeyFile()
     {
         $appDefaultCreds = getenv('GOOGLE_APPLICATION_CREDENTIALS');
-        putenv('GOOGLE_APPLICATION_CREDENTIALS=' . __DIR__ . '/testdata/json-key-file.json');
+        $this->setEnv('GOOGLE_APPLICATION_CREDENTIALS', __DIR__ . '/testdata/json-key-file.json');
         $scopes = ['myscope'];
         $authHttpHandler = HttpHandlerFactory::build();
         $asyncAuthHttpHandler = function ($request, $options) use ($authHttpHandler) {
@@ -123,7 +123,7 @@ public function buildDataWithoutExplicitKeyFile()
             ],
         ];
 
-        putenv('GOOGLE_APPLICATION_CREDENTIALS=' . $appDefaultCreds);
+        $this->setEnv('GOOGLE_APPLICATION_CREDENTIALS', $appDefaultCreds);
 
         return $testData;
     }
@@ -454,8 +454,8 @@ public function getAuthorizationHeaderCallbackData()
      */
     public function testApplicationDefaultCredentialsWithOnGCECacheTrue()
     {
-        putenv('HOME=' . __DIR__ . '/not_exist_fixtures');
-        putenv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
+        $this->setEnv('HOME', __DIR__ . '/not_exist_fixtures');
+        $this->setEnv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
 
         $mockCacheItem = $this->prophesize('Psr\Cache\CacheItemInterface');
         $mockCacheItem->isHit()
@@ -484,8 +484,8 @@ public function testApplicationDefaultCredentialsWithOnGCECacheTrue()
      */
     public function testApplicationDefaultCredentialsWithOnGCECacheFalse()
     {
-        putenv('HOME=' . __DIR__ . '/not_exist_fixtures');
-        putenv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
+        $this->setEnv('HOME', __DIR__ . '/not_exist_fixtures');
+        $this->setEnv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
 
         $this->expectException(ValidationException::class);
         $this->expectExceptionMessage('Could not construct ApplicationDefaultCredentials');
@@ -513,8 +513,8 @@ public function testApplicationDefaultCredentialsWithOnGCECacheFalse()
      */
     public function testApplicationDefaultCredentialsWithOnGCECacheOptions()
     {
-        putenv('HOME=' . __DIR__ . '/not_exist_fixtures');
-        putenv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
+        $this->setEnv('HOME', __DIR__ . '/not_exist_fixtures');
+        $this->setEnv(ServiceAccountCredentials::ENV_VAR);  // removes it from the environment
 
         $mockCacheItem = $this->prophesize('Psr\Cache\CacheItemInterface');
         $mockCacheItem->isHit()
@@ -579,4 +579,15 @@ public function testSerializeCredentialsWrapper()
         $serialized = serialize($credentialsWrapper);
         $this->assertIsString($serialized);
     }
+
+    private function setEnv(string $env, ?string $value = null)
+    {
+        if ($value === null) {
+            putenv($env);
+            unset($_ENV[$env]);
+        } else {
+            putenv($env . '=' . $value);
+            $_ENV[$env] = $value;
+        }
+    }
 }

tests/bootstrap_phpstan.php

@@ -0,0 +1,11 @@
+<?php
+
+use Google\Protobuf\RepeatedField;
+use Google\Protobuf\Internal;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+// Fix issue where PHPStan does not respect aliases
+if (!class_exists(Internal\RepeatedField::class)) {
+    class_alias(RepeatedField::class, Internal\RepeatedField::class);
+}