feat: add documentation for the Logger option inside the options array (

#731)
googleapis · Dec 5, 2024 · 4a2bdb1 · 4a2bdb1
1 parent 0d7b5eb
commit 4a2bdb1
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 0 deletions.
diff --git a/src/Generation/GapicClientV2Generator.php b/src/Generation/GapicClientV2Generator.php
@@ -46,6 +46,7 @@
 use Google\Generator\Utils\Type;
 use Google\LongRunning\Client\OperationsClient;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 
 class GapicClientV2Generator
 {
@@ -723,6 +724,17 @@ private function construct(): PhpClassMember
                             'A callable which returns the client cert as a string. This can be used to provide',
                             'a certificate and private key to the transport layer for mTLS.'
                         )
+                    ),
+                    PhpDoc::type(
+                        Vector::new([
+                            $ctx->type(Type::false()),
+                            $ctx->type(Type::fromName(LoggerInterface::class))
+                        ]),
+                        'logger',
+                        PhpDoc::text(
+                            'A PSR-3 compliant logger. If set to false, logging is disabled,',
+                            'ignoring the \'GOOGLE_SDK_PHP_LOGGING\' environment flag'
+                        )
                     )
                 )),
                 PhpDoc::throws($this->ctx->type(Type::fromName(ValidationException::class))),

diff --git a/src/Utils/Type.php b/src/Utils/Type.php
@@ -58,6 +58,12 @@ public static function bool(): Type
         return new Type(null, 'bool');
     }
 
+    /** The build int 'false' value */
+    public static function false(): Type
+    {
+        return new Type(null, 'false');
+    }
+
     /** The built-in 'callable' type. */
     public static function callable(): Type
     {

diff --git a/tests/Integration/goldens/functions/src/V1/Client/CloudFunctionsServiceClient.php b/tests/Integration/goldens/functions/src/V1/Client/CloudFunctionsServiceClient.php
@@ -54,6 +54,7 @@
 use Google\LongRunning\Client\OperationsClient;
 use Google\LongRunning\Operation;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Service Description: A service that application uses to manipulate triggers and functions.
@@ -329,6 +330,9 @@ public static function parseName(string $formattedName, ?string $template = null
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Integration/goldens/redis/src/V1/Client/CloudRedisClient.php b/tests/Integration/goldens/redis/src/V1/Client/CloudRedisClient.php
@@ -53,6 +53,7 @@
 use Google\LongRunning\Client\OperationsClient;
 use Google\LongRunning\Operation;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Service Description: Configures and manages Cloud Memorystore for Redis instances
@@ -303,6 +304,9 @@ public static function parseName(string $formattedName, ?string $template = null
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Integration/goldens/securitycenter/src/V1/Client/SecurityCenterClient.php b/tests/Integration/goldens/securitycenter/src/V1/Client/SecurityCenterClient.php
@@ -95,6 +95,7 @@
 use Google\Cloud\SecurityCenter\V1\UpdateSourceRequest;
 use Google\LongRunning\Operation;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Service Description: V1 APIs for Security Center service.
@@ -1295,6 +1296,9 @@ public static function parseName(string $formattedName, ?string $template = null
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Integration/goldens/spanner/src/V1/Client/DatabaseAdminClient.php b/tests/Integration/goldens/spanner/src/V1/Client/DatabaseAdminClient.php
@@ -70,6 +70,7 @@
 use Google\LongRunning\Operation;
 use Grpc\ChannelCredentials;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Service Description: Cloud Spanner Database Admin API
@@ -370,6 +371,9 @@ public static function parseName(string $formattedName, ?string $template = null
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/Basic/out/src/Client/BasicClient.php b/tests/Unit/ProtoTests/Basic/out/src/Client/BasicClient.php
@@ -34,6 +34,7 @@
 use Google\Auth\FetchAuthTokenInterface;
 use Grpc\ChannelCredentials;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\Basic\Request;
 use Testing\Basic\RequestWithArgs;
 use Testing\Basic\Response;
@@ -145,6 +146,9 @@ private static function getClientDefaults()
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/BasicGrpcOnly/out/src/Client/BasicGrpcOnlyClient.php b/tests/Unit/ProtoTests/BasicGrpcOnly/out/src/Client/BasicGrpcOnlyClient.php
@@ -29,6 +29,7 @@
 use Google\ApiCore\Transport\TransportInterface;
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Service Description: This is a basicGrpcOnly service.
@@ -125,6 +126,9 @@ private static function supportedTransports()
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/BasicOneofNew/out/src/Client/BasicOneofNewClient.php b/tests/Unit/ProtoTests/BasicOneofNew/out/src/Client/BasicOneofNewClient.php
@@ -32,6 +32,7 @@
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\BasicOneofNew\Request;
 use Testing\BasicOneofNew\Response;
 
@@ -134,6 +135,9 @@ private static function getClientDefaults()
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/CustomLroNew/out/src/Client/CustomLroClient.php b/tests/Unit/ProtoTests/CustomLroNew/out/src/Client/CustomLroClient.php
@@ -33,6 +33,7 @@
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\CustomLroNew\CreateFooRequest;
 
 /**
@@ -218,6 +219,9 @@ private function createOperationsClient(array $options)
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/CustomLroNew/out/src/Client/CustomLroOperationsClient.php b/tests/Unit/ProtoTests/CustomLroNew/out/src/Client/CustomLroOperationsClient.php
@@ -32,6 +32,7 @@
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\CustomLroNew\CancelOperationRequest;
 use Testing\CustomLroNew\CustomOperationResponse;
 use Testing\CustomLroNew\DeleteOperationRequest;
@@ -149,6 +150,9 @@ private static function supportedTransports()
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/ResourceNames/out/src/Client/ResourceNamesClient.php b/tests/Unit/ProtoTests/ResourceNames/out/src/Client/ResourceNamesClient.php
@@ -33,6 +33,7 @@
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\ResourceNames\FileLevelChildTypeRefRequest;
 use Testing\ResourceNames\FileLevelTypeRefRequest;
 use Testing\ResourceNames\MultiPatternRequest;
@@ -483,6 +484,9 @@ public static function parseName(string $formattedName, ?string $template = null
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException

diff --git a/tests/Unit/ProtoTests/RoutingHeaders/out/src/Client/RoutingHeadersClient.php b/tests/Unit/ProtoTests/RoutingHeaders/out/src/Client/RoutingHeadersClient.php
@@ -32,6 +32,7 @@
 use Google\ApiCore\ValidationException;
 use Google\Auth\FetchAuthTokenInterface;
 use GuzzleHttp\Promise\PromiseInterface;
+use Psr\Log\LoggerInterface;
 use Testing\RoutingHeaders\NestedRequest;
 use Testing\RoutingHeaders\OrderRequest;
 use Testing\RoutingHeaders\Response;
@@ -144,6 +145,9 @@ private static function getClientDefaults()
      *     @type callable $clientCertSource
      *           A callable which returns the client cert as a string. This can be used to
      *           provide a certificate and private key to the transport layer for mTLS.
+     *     @type false|LoggerInterface $logger
+     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
+     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
      * }
      *
      * @throws ValidationException