vendor/sentry/sentry/src/ClientBuilder.php line 277

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry;
  7. use Http\Client\Common\Plugin as PluginInterface;
  8. use Http\Client\HttpAsyncClient;
  9. use Http\Discovery\MessageFactoryDiscovery;
  10. use Http\Discovery\StreamFactoryDiscovery;
  11. use Http\Discovery\UriFactoryDiscovery;
  12. use Http\Message\MessageFactory as MessageFactoryInterface;
  13. use Http\Message\StreamFactory as StreamFactoryInterface;
  14. use Http\Message\UriFactory as UriFactoryInterface;
  15. use Jean85\PrettyVersions;
  16. use Psr\Log\LoggerInterface;
  17. use Sentry\HttpClient\HttpClientFactory;
  18. use Sentry\HttpClient\PluggableHttpClientFactory;
  19. use Sentry\Serializer\RepresentationSerializer;
  20. use Sentry\Serializer\RepresentationSerializerInterface;
  21. use Sentry\Serializer\Serializer;
  22. use Sentry\Serializer\SerializerInterface;
  23. use Sentry\Transport\DefaultTransportFactory;
  24. use Sentry\Transport\TransportFactoryInterface;
  25. use Sentry\Transport\TransportInterface;
  27. /**
  28.  * The default implementation of {@link ClientBuilderInterface}.
  29.  *
  30.  * @author Stefano Arlandini <sarlandini@alice.it>
  31.  */
  32. final class ClientBuilder implements ClientBuilderInterface
  33. {
  34.     /**
  35.      * @var Options The client options
  36.      */
  37.     private $options;
  39.     /**
  40.      * @var UriFactoryInterface|null The PSR-7 URI factory
  41.      */
  42.     private $uriFactory;
  44.     /**
  45.      * @var StreamFactoryInterface|null The PSR-17 stream factory
  46.      */
  47.     private $streamFactory;
  49.     /**
  50.      * @var MessageFactoryInterface|null The PSR-7 message factory
  51.      */
  52.     private $messageFactory;
  54.     /**
  55.      * @var TransportFactoryInterface|null The transport factory
  56.      */
  57.     private $transportFactory;
  59.     /**
  60.      * @var TransportInterface|null The transport
  61.      */
  62.     private $transport;
  64.     /**
  65.      * @var HttpAsyncClient|null The HTTP client
  66.      */
  67.     private $httpClient;
  69.     /**
  70.      * @var PluginInterface[] The list of Httplug plugins
  71.      */
  72.     private $httpClientPlugins = [];
  74.     /**
  75.      * @var SerializerInterface|null The serializer to be injected in the client
  76.      */
  77.     private $serializer;
  79.     /**
  80.      * @var RepresentationSerializerInterface|null The representation serializer to be injected in the client
  81.      */
  82.     private $representationSerializer;
  84.     /**
  85.      * @var LoggerInterface|null A PSR-3 logger to log internal errors and debug messages
  86.      */
  87.     private $logger;
  89.     /**
  90.      * @var string The SDK identifier, to be used in {@see Event} and {@see SentryAuth}
  91.      */
  92.     private $sdkIdentifier = Client::SDK_IDENTIFIER;
  94.     /**
  95.      * @var string The SDK version of the Client
  96.      */
  97.     private $sdkVersion;
  99.     /**
  100.      * Class constructor.
  101.      *
  102.      * @param Options|null $options The client options
  103.      */
  104.     public function __construct(Options $options = null)
  105.     {
  106.         $this->options = $options ?? new Options();
  107.         $this->sdkVersion = PrettyVersions::getVersion('sentry/sentry')->getPrettyVersion();
  108.     }
  110.     /**
  111.      * {@inheritdoc}
  112.      */
  113.     public static function create(array $options = []): ClientBuilderInterface
  114.     {
  115.         return new static(new Options($options));
  116.     }
  118.     /**
  119.      * {@inheritdoc}
  120.      */
  121.     public function getOptions(): Options
  122.     {
  123.         return $this->options;
  124.     }
  126.     /**
  127.      * {@inheritdoc}
  128.      */
  129.     public function setUriFactory(UriFactoryInterface $uriFactory): ClientBuilderInterface
  130.     {
  131.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  133.         $this->uriFactory = $uriFactory;
  135.         return $this;
  136.     }
  138.     /**
  139.      * {@inheritdoc}
  140.      */
  141.     public function setMessageFactory(MessageFactoryInterface $messageFactory): ClientBuilderInterface
  142.     {
  143.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  145.         $this->messageFactory = $messageFactory;
  147.         return $this;
  148.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function setTransport(TransportInterface $transport): ClientBuilderInterface
  154.     {
  155.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0. Use the setTransportFactory() method instead.', __METHOD__), \E_USER_DEPRECATED);
  157.         $this->transport = $transport;
  159.         return $this;
  160.     }
  162.     /**
  163.      * {@inheritdoc}
  164.      */
  165.     public function setHttpClient(HttpAsyncClient $httpClient): ClientBuilderInterface
  166.     {
  167.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  169.         $this->httpClient = $httpClient;
  171.         return $this;
  172.     }
  174.     /**
  175.      * {@inheritdoc}
  176.      */
  177.     public function addHttpClientPlugin(PluginInterface $plugin): ClientBuilderInterface
  178.     {
  179.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  181.         $this->httpClientPlugins[] = $plugin;
  183.         return $this;
  184.     }
  186.     /**
  187.      * {@inheritdoc}
  188.      */
  189.     public function removeHttpClientPlugin(string $className): ClientBuilderInterface
  190.     {
  191.         @trigger_error(sprintf('Method %s() is deprecated since version 2.3 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  193.         foreach ($this->httpClientPlugins as $index => $httpClientPlugin) {
  194.             if (!$httpClientPlugin instanceof $className) {
  195.                 continue;
  196.             }
  198.             unset($this->httpClientPlugins[$index]);
  199.         }
  201.         return $this;
  202.     }
  204.     /**
  205.      * {@inheritdoc}
  206.      */
  207.     public function setSerializer(SerializerInterface $serializer): ClientBuilderInterface
  208.     {
  209.         $this->serializer = $serializer;
  211.         return $this;
  212.     }
  214.     /**
  215.      * {@inheritdoc}
  216.      */
  217.     public function setRepresentationSerializer(RepresentationSerializerInterface $representationSerializer): ClientBuilderInterface
  218.     {
  219.         $this->representationSerializer = $representationSerializer;
  221.         return $this;
  222.     }
  224.     /**
  225.      * {@inheritdoc}
  226.      */
  227.     public function setLogger(LoggerInterface $logger): ClientBuilderInterface
  228.     {
  229.         $this->logger = $logger;
  231.         return $this;
  232.     }
  234.     /**
  235.      * {@inheritdoc}
  236.      */
  237.     public function setSdkIdentifier(string $sdkIdentifier): ClientBuilderInterface
  238.     {
  239.         $this->sdkIdentifier = $sdkIdentifier;
  241.         return $this;
  242.     }
  244.     /**
  245.      * {@inheritdoc}
  246.      */
  247.     public function setSdkVersion(string $sdkVersion): ClientBuilderInterface
  248.     {
  249.         $this->sdkVersion = $sdkVersion;
  251.         return $this;
  252.     }
  254.     /**
  255.      * Sets the version of the SDK package that generated this Event using the Packagist name.
  256.      *
  257.      * @param string $packageName The package name that will be used to get the version from (i.e. "sentry/sentry")
  258.      *
  259.      * @return $this
  260.      *
  261.      * @deprecated since version 2.2, to be removed in 3.0
  262.      */
  263.     public function setSdkVersionByPackageName(string $packageName): ClientBuilderInterface
  264.     {
  265.         @trigger_error(sprintf('Method %s() is deprecated since version 2.2 and will be removed in 3.0.', __METHOD__), \E_USER_DEPRECATED);
  267.         $this->sdkVersion = PrettyVersions::getVersion($packageName)->getPrettyVersion();
  269.         return $this;
  270.     }
  272.     /**
  273.      * {@inheritdoc}
  274.      */
  275.     public function getClient(): ClientInterface
  276.     {
  277.         $this->transport = $this->transport ?? $this->createTransportInstance();
  279.         return new Client($this->options, $this->transport, $this->createEventFactory(), $this->logger);
  280.     }
  282.     /**
  283.      * Sets the transport factory.
  284.      *
  285.      * @param TransportFactoryInterface $transportFactory The transport factory
  286.      *
  287.      * @return $this
  288.      */
  289.     public function setTransportFactory(TransportFactoryInterface $transportFactory): ClientBuilderInterface
  290.     {
  291.         $this->transportFactory = $transportFactory;
  293.         return $this;
  294.     }
  296.     /**
  297.      * Creates a new instance of the transport mechanism.
  298.      */
  299.     private function createTransportInstance(): TransportInterface
  300.     {
  301.         if (null !== $this->transport) {
  302.             return $this->transport;
  303.         }
  305.         $transportFactory = $this->transportFactory ?? $this->createDefaultTransportFactory();
  307.         return $transportFactory->create($this->options);
  308.     }
  310.     /**
  311.      * Instantiate the {@see EventFactory} with the configured serializers.
  312.      */
  313.     private function createEventFactory(): EventFactoryInterface
  314.     {
  315.         $this->serializer = $this->serializer ?? new Serializer($this->options);
  316.         $this->representationSerializer = $this->representationSerializer ?? new RepresentationSerializer($this->options);
  318.         return new EventFactory($this->serializer, $this->representationSerializer, $this->options, $this->sdkIdentifier, $this->sdkVersion);
  319.     }
  321.     /**
  322.      * Creates a new instance of the {@see DefaultTransportFactory} factory.
  323.      */
  324.     private function createDefaultTransportFactory(): DefaultTransportFactory
  325.     {
  326.         $this->messageFactory = $this->messageFactory ?? MessageFactoryDiscovery::find();
  327.         $this->uriFactory = $this->uriFactory ?? UriFactoryDiscovery::find();
  328.         $this->streamFactory = $this->streamFactory ?? StreamFactoryDiscovery::find();
  330.         $httpClientFactory = new HttpClientFactory(
  331.             $this->uriFactory,
  332.             $this->messageFactory,
  333.             $this->streamFactory,
  334.             $this->httpClient,
  335.             $this->sdkIdentifier,
  336.             $this->sdkVersion
  337.         );
  339.         if (!empty($this->httpClientPlugins)) {
  340.             $httpClientFactory = new PluggableHttpClientFactory($httpClientFactory, $this->httpClientPlugins);
  341.         }
  343.         return new DefaultTransportFactory($this->messageFactory, $httpClientFactory, $this->logger);
  344.     }
  345. }