Add support for IPv6 Addresses in ServiceAddressTrait

[jdpedrie]

Currently, GAX does not support IPv6 addresses. Providing an IPv6 hostname will raise Google\ApiCore\ValidationException.

Example:

<?php

use Google\ApiCore\ServiceAddressTrait;
use Google\ApiCore\ValidationException;

include __DIR__ .'/../gax-php/vendor/autoload.php';

class TestClient
{
    use ServiceAddressTrait;

    public $hostname;

    public $port;

    public function __construct($address)
    {
        list (
            $this->hostname,
            $this->port
        ) = $this->normalizeServiceAddress($address);
    }
}

$addresses = [
    '[::1]:8080',
    '::1',
    '[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:8080',
    '2001:0db8:85a3:0000:0000:8a2e:0370:7334'
];

foreach ($addresses as $address) {
    try {
        $client = new TestClient($address);
        var_dump('Success: '. $address);
    } catch (ValidationException $e) {
        var_dump('Fail: '. $e->getMessage());
    }
}

Output:

string(40) "Fail: Invalid serviceAddress: [::1]:8080"
string(33) "Fail: Invalid serviceAddress: ::1"
string(76) "Fail: Invalid serviceAddress: [2001:0db8:85a3:0000:0000:8a2e:0370:7334]:8080"
string(69) "Fail: Invalid serviceAddress: 2001:0db8:85a3:0000:0000:8a2e:0370:7334"

[michaelbausor]

Thanks @jdpedrie, sorry I didn't respond until now. I marked this P1 , but wanted to check if there is a current user impact from this in google-cloud-php?

[jdpedrie]

No worries! Not much impact. The Firestore emulator supports both IPv6 and IPv4. We discovered the missing support when we were adding support for the emulator to Google Cloud PHP. The solution is to simply use the IPv4 address, and we informed users of that, but if someone were to use the IPv6 service address, they would encounter an error.