Add return types to the ClientBuilder methods and make the Options class final (#728)

Author: Jean85

phpstan.neon

@@ -4,7 +4,7 @@ parameters:
         - src
         - tests
     ignoreErrors:
-        - '/Call to an undefined method Sentry\\ClientBuilder::methodThatDoesNotExists\(\)/'
+        - '/Method Sentry\\ClientBuilder::\w+\(\) should return \$this\(Sentry\\ClientBuilderInterface\) but returns \$this\(Sentry\\ClientBuilder\)/'
         - '/Argument of an invalid type object supplied for foreach, only iterables are supported/'
         - '/Binary operation "\*" between array and 2 results in an error\./'
         - '/Method Sentry\\Serializer\\RepresentationSerializer::(representationSerialize|serializeValue)\(\) should return [\w|]+ but returns [\w|]+/'

src/ClientBuilder.php

@@ -34,40 +34,6 @@
  * The default implementation of {@link ClientBuilderInterface}.
  *
  * @author Stefano Arlandini <[email protected]>
- *
- * @method int getSendAttempts()
- * @method setSendAttempts(int $attemptsCount)
- * @method string[] getPrefixes()
- * @method setPrefixes(array $prefixes)
- * @method float getSampleRate()
- * @method setSampleRate(float $sampleRate)
- * @method bool shouldAttachStacktrace()
- * @method setAttachStacktrace(bool $enable)
- * @method int getContextLines()
- * @method setContextLines(int $contextLines)
- * @method null|string getEnvironment()
- * @method setEnvironment(null|string $environment)
- * @method string[] getExcludedProjectPaths()
- * @method setExcludedProjectPaths(string[] $paths)
- * @method setExcludedLoggers(string[] $loggers)
- * @method string[] getExcludedExceptions()
- * @method string getProjectRoot()
- * @method setProjectRoot(string $path)
- * @method string getLogger()
- * @method setLogger(string $logger)
- * @method string getRelease()
- * @method setRelease(string $release)
- * @method string getDsn()
- * @method string getServerName()
- * @method setServerName(string $serverName)
- * @method string[] getTags()
- * @method setTags(string[] $tags)
- * @method bool shouldSendDefaultPii()
- * @method setSendDefaultPii(bool $enable)
- * @method bool hasDefaultIntegrations()
- * @method setDefaultIntegrations(bool $enable)
- * @method callable getBeforeSendCallback()
- * @method setBeforeSendCallback(callable $beforeSend)
  */
 final class ClientBuilder implements ClientBuilderInterface
 {
@@ -124,11 +90,11 @@ final class ClientBuilder implements ClientBuilderInterface
     /**
      * Class constructor.
      *
-     * @param array $options The client options
+     * @param Options|null $options The client options
      */
-    public function __construct(array $options = [])
+    public function __construct(Options $options = null)
     {
-        $this->options = new Options($options);
+        $this->options = $options ?? new Options();
 
         if ($this->options->hasDefaultIntegrations()) {
             $this->options->setIntegrations(\array_merge([
@@ -141,15 +107,23 @@ public function __construct(array $options = [])
     /**
      * {@inheritdoc}
      */
-    public static function create(array $options = []): self
+    public static function create(array $options = []): ClientBuilderInterface
     {
-        return new static($options);
+        return new static(new Options($options));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function setUriFactory(UriFactory $uriFactory): self
+    public function getOptions(): Options
+    {
+        return $this->options;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setUriFactory(UriFactory $uriFactory): ClientBuilderInterface
     {
         $this->uriFactory = $uriFactory;
 
@@ -159,7 +133,7 @@ public function setUriFactory(UriFactory $uriFactory): self
     /**
      * {@inheritdoc}
      */
-    public function setMessageFactory(MessageFactory $messageFactory): self
+    public function setMessageFactory(MessageFactory $messageFactory): ClientBuilderInterface
     {
         $this->messageFactory = $messageFactory;
 
@@ -169,7 +143,7 @@ public function setMessageFactory(MessageFactory $messageFactory): self
     /**
      * {@inheritdoc}
      */
-    public function setTransport(TransportInterface $transport): self
+    public function setTransport(TransportInterface $transport): ClientBuilderInterface
     {
         $this->transport = $transport;
 
@@ -179,7 +153,7 @@ public function setTransport(TransportInterface $transport): self
     /**
      * {@inheritdoc}
      */
-    public function setHttpClient(HttpAsyncClient $httpClient): self
+    public function setHttpClient(HttpAsyncClient $httpClient): ClientBuilderInterface
     {
         $this->httpClient = $httpClient;
 
@@ -189,7 +163,7 @@ public function setHttpClient(HttpAsyncClient $httpClient): self
     /**
      * {@inheritdoc}
      */
-    public function addHttpClientPlugin(Plugin $plugin): self
+    public function addHttpClientPlugin(Plugin $plugin): ClientBuilderInterface
     {
         $this->httpClientPlugins[] = $plugin;
 
@@ -199,7 +173,7 @@ public function addHttpClientPlugin(Plugin $plugin): self
     /**
      * {@inheritdoc}
      */
-    public function removeHttpClientPlugin(string $className): self
+    public function removeHttpClientPlugin(string $className): ClientBuilderInterface
     {
         foreach ($this->httpClientPlugins as $index => $httpClientPlugin) {
             if (!$httpClientPlugin instanceof $className) {
@@ -215,7 +189,7 @@ public function removeHttpClientPlugin(string $className): self
     /**
      * {@inheritdoc}
      */
-    public function setSerializer(SerializerInterface $serializer): self
+    public function setSerializer(SerializerInterface $serializer): ClientBuilderInterface
     {
         $this->serializer = $serializer;
 
@@ -225,7 +199,7 @@ public function setSerializer(SerializerInterface $serializer): self
     /**
      * {@inheritdoc}
      */
-    public function setRepresentationSerializer(RepresentationSerializerInterface $representationSerializer): self
+    public function setRepresentationSerializer(RepresentationSerializerInterface $representationSerializer): ClientBuilderInterface
     {
         $this->representationSerializer = $representationSerializer;
 
@@ -235,7 +209,7 @@ public function setRepresentationSerializer(RepresentationSerializerInterface $r
     /**
      * {@inheritdoc}
      */
-    public function setSdkIdentifier(string $sdkIdentifier): self
+    public function setSdkIdentifier(string $sdkIdentifier): ClientBuilderInterface
     {
         $this->sdkIdentifier = $sdkIdentifier;
 
@@ -259,7 +233,7 @@ private function getSdkVersion(): string
     /**
      * {@inheritdoc}
      */
-    public function setSdkVersion(string $sdkVersion): self
+    public function setSdkVersion(string $sdkVersion): ClientBuilderInterface
     {
         $this->sdkVersion = $sdkVersion;
 
@@ -273,7 +247,7 @@ public function setSdkVersion(string $sdkVersion): self
      *
      * @return $this
      */
-    public function setSdkVersionByPackageName(string $packageName): self
+    public function setSdkVersionByPackageName(string $packageName): ClientBuilderInterface
     {
         $this->sdkVersion = PrettyVersions::getVersion($packageName)->getPrettyVersion();
 
@@ -293,25 +267,6 @@ public function getClient(): ClientInterface
         return new Client($this->options, $this->transport, $this->createEventFactory());
     }
 
-    /**
-     * This method forwards all methods calls to the options object.
-     *
-     * @param string $name      The name of the method being called
-     * @param array  $arguments Parameters passed to the $name'ed method
-     *
-     * @return $this
-     *
-     * @throws \BadMethodCallException If the called method does not exists
-     */
-    public function __call($name, $arguments)
-    {
-        if (!method_exists($this->options, $name)) {
-            throw new \BadMethodCallException(sprintf('The method named "%s" does not exists.', $name));
-        }
-
-        return $this->options->$name(...$arguments);
-    }
-
     /**
      * Creates a new instance of the HTTP client.
      *

src/ClientBuilderInterface.php

@@ -22,11 +22,18 @@ interface ClientBuilderInterface
     /**
      * Creates a new instance of this builder.
      *
-     * @param array $options The client options
+     * @param array $options The client options, in naked array form
      *
      * @return static
      */
-    public static function create(array $options = []);
+    public static function create(array $options = []): self;
+
+    /**
+     * The options that will be used to create the {@see Client}.
+     *
+     * @return Options
+     */
+    public function getOptions(): Options;
 
     /**
      * Sets the factory to use to create URIs.
@@ -35,7 +42,7 @@ public static function create(array $options = []);
      *
      * @return $this
      */
-    public function setUriFactory(UriFactory $uriFactory);
+    public function setUriFactory(UriFactory $uriFactory): self;
 
     /**
      * Sets the factory to use to create PSR-7 messages.
@@ -44,7 +51,7 @@ public function setUriFactory(UriFactory $uriFactory);
      *
      * @return $this
      */
-    public function setMessageFactory(MessageFactory $messageFactory);
+    public function setMessageFactory(MessageFactory $messageFactory): self;
 
     /**
      * Sets the transport that will be used to send events.
@@ -53,7 +60,7 @@ public function setMessageFactory(MessageFactory $messageFactory);
      *
      * @return $this
      */
-    public function setTransport(TransportInterface $transport);
+    public function setTransport(TransportInterface $transport): self;
 
     /**
      * Sets the HTTP client.
@@ -62,7 +69,7 @@ public function setTransport(TransportInterface $transport);
      *
      * @return $this
      */
-    public function setHttpClient(HttpAsyncClient $httpClient);
+    public function setHttpClient(HttpAsyncClient $httpClient): self;
 
     /**
      * Adds a new HTTP client plugin to the end of the plugins chain.
@@ -71,7 +78,7 @@ public function setHttpClient(HttpAsyncClient $httpClient);
      *
      * @return $this
      */
-    public function addHttpClientPlugin(Plugin $plugin);
+    public function addHttpClientPlugin(Plugin $plugin): self;
 
     /**
      * Removes a HTTP client plugin by its fully qualified class name (FQCN).
@@ -80,7 +87,7 @@ public function addHttpClientPlugin(Plugin $plugin);
      *
      * @return $this
      */
-    public function removeHttpClientPlugin(string $className);
+    public function removeHttpClientPlugin(string $className): self;
 
     /**
      * Gets the instance of the client built using the configured options.
@@ -96,7 +103,7 @@ public function getClient(): ClientInterface;
      *
      * @return $this
      */
-    public function setSerializer(SerializerInterface $serializer);
+    public function setSerializer(SerializerInterface $serializer): self;
 
     /**
      * Sets a representation serializer instance to be injected as a dependency of the client.
@@ -107,7 +114,7 @@ public function setSerializer(SerializerInterface $serializer);
      *
      * @return $this
      */
-    public function setRepresentationSerializer(RepresentationSerializerInterface $representationSerializer);
+    public function setRepresentationSerializer(RepresentationSerializerInterface $representationSerializer): self;
 
     /**
      * Sets the SDK identifier to be passed onto {@see Event} and HTTP User-Agent header.
@@ -118,7 +125,7 @@ public function setRepresentationSerializer(RepresentationSerializerInterface $r
      *
      * @internal
      */
-    public function setSdkIdentifier(string $sdkIdentifier);
+    public function setSdkIdentifier(string $sdkIdentifier): self;
 
     /**
      * Sets the SDK version to be passed onto {@see Event} and HTTP User-Agent header.
@@ -129,5 +136,5 @@ public function setSdkIdentifier(string $sdkIdentifier);
      *
      * @internal
      */
-    public function setSdkVersion(string $sdkVersion);
+    public function setSdkVersion(string $sdkVersion): self;
 }

src/Options.php

@@ -13,7 +13,7 @@
  *
  * @author Stefano Arlandini <[email protected]>
  */
-class Options
+final class Options
 {
     /**
      * The default maximum number of breadcrumbs that will be sent with an event.

src/Sdk.php

@@ -13,7 +13,8 @@
  */
 function init(array $options = []): void
 {
-    Hub::setCurrent(new Hub(ClientBuilder::create($options)->getClient()));
+    $client = ClientBuilder::create($options)->getClient();
+    Hub::setCurrent(new Hub($client));
 }
 
 /**