Upgrading to v1.11.2 breaks the unit test of our (lonely) streaming method about gax-php HOT 7 CLOSED

Ok we've got a fix planned. It will come early next week. Sorry about the breakage, please continue to use 1.10 for now.

from gax-php.

FYI @fiboknacky @aohren

from gax-php.

Not sure if that helps but debugging the unit test that fail, I found that the ApiException instance is not created in the same way depending on the version of gax-php being used.

1.10.0: It uses the method createFromStdClass and the metadata is NULL.

1.11.2: It uses the method createFromRpcStatus and the metadata is a RepeatedField got from status.

from gax-php.

That definitely helps! That looks like the root cause.

from gax-php.

Actually, in looking at the create documentation, the $metadata may either be a PHP array OR a RepeatedField. So the fact that this is a RepeatedField is allowed.

from gax-php.

However, the documentation for ApiException constructor indicates $metadata should be an array.

hmm.

from gax-php.

Ok so we are thinking that the this is a bug in gax-php that has kind of been lurking.

ApiException::create is documented as accepting []mixed|RepeatedField for $metadata. That $metadata value is passed to ApiException::_construct untouched. ApiException::_construct documents that it expects $metadata to be an array, and ApiException::getMetadata documents the return type i.e. $metadata is []mixed.

So the bug is that ApiException::create needs to convert $metadata that's instanceof RepeatedField into an array prior to constructing the ApiException.

The problem was introduced because ServerStream::readAll was changed to construct an exception via ApiException::createFromRpcStatus whereas it was ApiException::createFromStdClass (a gRPC specific type) before. The former (the code recently released) supplies the Google/Rpc/Status::getDetails() directly to ApiException::create. Since it isn't "massaged" to the array type as I mentioned earlier, this whole issue popped up.

@bshaffer

from gax-php.