feat: add InsecureRequestBuilder for emulator (#582)

Author: pulzarraider

src/GapicClientTrait.php

@@ -313,7 +313,8 @@ private function setClientOptions(array $options)
                 $options['apiEndpoint'],
                 $transport,
                 $options['transportConfig'],
-                $options['clientCertSource']
+                $options['clientCertSource'],
+                $options['hasEmulator'] ?? false
             );
     }
 
@@ -322,14 +323,16 @@ private function setClientOptions(array $options)
      * @param string $transport
      * @param TransportOptions|array $transportConfig
      * @param callable $clientCertSource
+     * @param bool $hasEmulator
      * @return TransportInterface
      * @throws ValidationException
      */
     private function createTransport(
         string $apiEndpoint,
         $transport,
         $transportConfig,
-        callable $clientCertSource = null
+        callable $clientCertSource = null,
+        bool $hasEmulator = false
     ) {
         if (!is_string($transport)) {
             throw new ValidationException(
@@ -372,6 +375,8 @@ private function createTransport(
                     );
                 }
                 $restConfigPath = $configForSpecifiedTransport['restClientConfigPath'];
+                $configForSpecifiedTransport['hasEmulator'] = $hasEmulator;
+
                 return RestTransport::build($apiEndpoint, $restConfigPath, $configForSpecifiedTransport);
             default:
                 throw new ValidationException(

src/InsecureRequestBuilder.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Google\ApiCore;
+
+use GuzzleHttp\Psr7\Utils;
+use Psr\Http\Message\UriInterface;
+
+/**
+ * @internal
+ */
+class InsecureRequestBuilder extends RequestBuilder
+{
+    /**
+     * @param string $path
+     * @param array $queryParams
+     * @return UriInterface
+     */
+    protected function buildUri(string $path, array $queryParams)
+    {
+        $uri = Utils::uriFor(sprintf(
+            'http://%s%s',
+            $this->baseUri,
+            $path
+        ));
+        if ($queryParams) {
+            $uri = $this->buildUriWithQuery(
+                $uri,
+                $queryParams
+            );
+        }
+        return $uri;
+    }
+}

src/RequestBuilder.php

@@ -50,7 +50,7 @@ class RequestBuilder
     use UriTrait;
     use ValidationTrait;
 
-    private $baseUri;
+    protected $baseUri;
     private $restConfig;
 
     /**
@@ -270,7 +270,7 @@ private function tryRenderPathTemplate(string $uriTemplate, array $bindings)
      * @param array $queryParams
      * @return UriInterface
      */
-    private function buildUri(string $path, array $queryParams)
+    protected function buildUri(string $path, array $queryParams)
     {
         $uri = Utils::uriFor(
             sprintf(

src/Transport/RestTransport.php

@@ -33,6 +33,7 @@
 
 use Google\ApiCore\ApiException;
 use Google\ApiCore\Call;
+use Google\ApiCore\InsecureRequestBuilder;
 use Google\ApiCore\RequestBuilder;
 use Google\ApiCore\ServerStream;
 use Google\ApiCore\ServiceAddressTrait;
@@ -83,6 +84,7 @@ public function __construct(
      *
      *    @type callable $httpHandler A handler used to deliver PSR-7 requests.
      *    @type callable $clientCertSource A callable which returns the client cert as a string.
+     *    @type bool $hasEmulator True if the emulator is enabled.
      * }
      * @return RestTransport
      * @throws ValidationException
@@ -92,9 +94,12 @@ public static function build(string $apiEndpoint, string $restConfigPath, array
         $config += [
             'httpHandler'  => null,
             'clientCertSource' => null,
+            'hasEmulator' => false,
         ];
         list($baseUri, $port) = self::normalizeServiceAddress($apiEndpoint);
-        $requestBuilder = new RequestBuilder("$baseUri:$port", $restConfigPath);
+        $requestBuilder = $config['hasEmulator']
+            ? new InsecureRequestBuilder("$baseUri:$port", $restConfigPath)
+            : new RequestBuilder("$baseUri:$port", $restConfigPath);
         $httpHandler = $config['httpHandler'] ?: self::buildHttpHandlerAsync();
         $transport = new RestTransport($requestBuilder, $httpHandler);
         if ($config['clientCertSource']) {

tests/Tests/Unit/InsecureRequestBuilderTest.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright 2024 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+use Google\ApiCore\InsecureRequestBuilder;
+use Google\ApiCore\Testing\MockRequestBody;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @group core
+ */
+class InsecureRequestBuilderTest extends TestCase
+{
+    private $builder;
+
+    const SERVICE_NAME = 'test.interface.v1.api';
+
+    public function setUp(): void
+    {
+        $this->builder = new InsecureRequestBuilder(
+            'www.example.com',
+            __DIR__ . '/testdata/test_service_rest_client_config.php'
+        );
+    }
+
+    public function testMethodWithUrlPlaceholder()
+    {
+        $message = new MockRequestBody();
+        $message->setName('message/foo');
+
+        $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithUrlPlaceholder', $message);
+        $uri = $request->getUri();
+
+        $this->assertSame('http', $uri->getScheme());
+        $this->assertEmpty($uri->getQuery());
+        $this->assertEmpty((string) $request->getBody());
+        $this->assertSame('/v1/message/foo', $uri->getPath());
+    }
+
+    public function testMethodWithBody()
+    {
+        $message = new MockRequestBody();
+        $message->setName('message/foo');
+        $nestedMessage = new MockRequestBody();
+        $nestedMessage->setName('nested/foo');
+        $message->setNestedMessage($nestedMessage);
+
+        $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithBodyAndUrlPlaceholder', $message);
+        $uri = $request->getUri();
+
+        $this->assertSame('http', $uri->getScheme());
+        $this->assertEmpty($uri->getQuery());
+        $this->assertSame('/v1/message/foo', $uri->getPath());
+        $this->assertEquals(
+            ['name' => 'message/foo', 'nestedMessage' => ['name' => 'nested/foo']],
+            json_decode($request->getBody(), true)
+        );
+    }
+}

tests/Tests/Unit/RequestBuilderTest.php

@@ -62,6 +62,7 @@ public function testMethodWithUrlPlaceholder()
         $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithUrlPlaceholder', $message);
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertEmpty((string) $request->getBody());
         $this->assertSame('/v1/message/foo', $uri->getPath());
@@ -78,6 +79,7 @@ public function testMethodWithBody()
         $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithBodyAndUrlPlaceholder', $message);
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertSame('/v1/message/foo', $uri->getPath());
         $this->assertEquals(
@@ -97,6 +99,7 @@ public function testMethodWithNestedMessageAsBody()
         $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithNestedMessageAsBody', $message);
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertSame('/v1/message/foo', $uri->getPath());
         $this->assertEquals(
@@ -161,6 +164,7 @@ public function testMethodWithNestedUrlPlaceholder()
         $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithNestedUrlPlaceholder', $message);
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertSame('/v1/nested/foo', $uri->getPath());
         $this->assertEquals(
@@ -179,6 +183,7 @@ public function testMethodWithUrlRepeatedField()
         $uri = $request->getUri();
 
         $this->assertEmpty((string) $request->getBody());
+        $this->assertSame('https', $uri->getScheme());
         $this->assertSame('/v1/message/foo', $uri->getPath());
         $this->assertSame('repeatedField=bar1&repeatedField=bar2', $uri->getQuery());
     }
@@ -206,6 +211,7 @@ public function testMethodWithColon()
         $request = $this->builder->build(self::SERVICE_NAME . '/MethodWithColonInUrl', $message);
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertSame('/v1/message/foo:action', $uri->getPath());
     }
@@ -222,6 +228,7 @@ public function testMethodWithMultipleWildcardsAndColonInUrl()
         );
         $uri = $request->getUri();
 
+        $this->assertSame('https', $uri->getScheme());
         $this->assertEmpty($uri->getQuery());
         $this->assertSame('/v1/message/foo/number/10:action', $uri->getPath());
     }
@@ -236,7 +243,7 @@ public function testMethodWithSimplePlaceholder()
             $message
         );
         $uri = $request->getUri();
-
+        $this->assertSame('https', $uri->getScheme());
         $this->assertSame('/v1/message-name', $uri->getPath());
     }