Auto on session tracking

src/Client.php

@@ -17,8 +17,7 @@
 use Bugsnag\Middleware\SessionData;
 use Bugsnag\Request\BasicResolver;
 use Bugsnag\Request\ResolverInterface;
-use Composer\CaBundle\CaBundle;
-use GuzzleHttp\Client as Guzzle;
+use Bugsnag\Utils;
 use GuzzleHttp\ClientInterface;
 use ReflectionClass;
 use ReflectionException;
@@ -30,7 +29,7 @@ class Client
      *
      * @var string
      */
-    const ENDPOINT = 'https://notify.bugsnag.com';
+    const ENDPOINT = Configuration::DEFAULT_NOTIFY_ENDPOINT;
 
     /**
      * The config instance.
@@ -88,10 +87,13 @@ class Client
     public static function make($apiKey = null, $endpoint = null, $defaults = true)
     {
         $config = new Configuration($apiKey ?: getenv('BUGSNAG_API_KEY'));
-        $guzzle = static::makeGuzzle($endpoint ?: getenv('BUGSNAG_ENDPOINT'));
 
-        $client = new static($config, null, $guzzle);
+        if ($endpoint = $endpoint ?: getenv('BUGSNAG_ENDPOINT')) {
+            $sessionEndpoint = getenv('BUGSNAG_SESSION_ENDPOINT');
+            $config->setEndpoints($endpoint, $sessionEndpoint);
+        }
 
+        $client = new static($config, null, null);
         if ($defaults) {
             $client->registerDefaultCallbacks();
         }
@@ -111,10 +113,20 @@ public static function make($apiKey = null, $endpoint = null, $defaults = true)
     public function __construct(Configuration $config, ResolverInterface $resolver = null, ClientInterface $guzzle = null)
     {
         $this->config = $config;
+        if ($guzzle) {
+            $this->config->setGuzzleClient($guzzle);
+            if (version_compare(ClientInterface::VERSION, '6') === 1) {
+                $endpoint = $guzzle->getConfig('base_uri');
+            } else {
+                $endpoint = $guzzle->getBaseUrl();
+            }
+            $this->config->setEndpoints((string) $endpoint, null);
+        }
+
         $this->resolver = $resolver ?: new BasicResolver();
         $this->recorder = new Recorder();
         $this->pipeline = new Pipeline();
-        $this->http = new HttpClient($config, $guzzle ?: static::makeGuzzle());
+        $this->http = new HttpClient($config);
         $this->sessionTracker = new SessionTracker($config);
 
         $this->registerMiddleware(new NotificationSkipper($config));
@@ -135,28 +147,8 @@ public function __construct(Configuration $config, ResolverInterface $resolver =
     public static function makeGuzzle($base = null, array $options = [])
     {
         $key = version_compare(ClientInterface::VERSION, '6') === 1 ? 'base_uri' : 'base_url';
-
         $options[$key] = $base ?: static::ENDPOINT;
-
-        if ($path = static::getCaBundlePath()) {
-            $options['verify'] = $path;
-        }
-
-        return new Guzzle($options);
-    }
-
-    /**
-     * Get the ca bundle path if one exists.
-     *
-     * @return string|false
-     */
-    protected static function getCaBundlePath()
-    {
-        if (!class_exists(CaBundle::class)) {
-            return false;
-        }
-
-        return realpath(CaBundle::getSystemCaRootBundlePath());
+        return Utils::makeGuzzle($options);
     }
 
     /**
@@ -784,6 +776,41 @@ public function setAutoCaptureSessions($track)
         return $this;
     }
 
+    /**
+     * Sets the notify and session endpoints
+     *
+     * @param string $notifyEndpoint the notify endpoint
+     * @param string $sessionEndpoint the session endpoint
+     *
+     * @return $this
+     */
+    public function setEndpoints($notifyEndpoint, $sessionEndpoint)
+    {
+        $this->config->setEndpoints($notifyEndpoint, $sessionEndpoint);
+
+        return $this;
+    }
+
+    /**
+     * Gets the notify endpoint
+     *
+     * @return string
+     */
+    public function getNotifyEndpoint()
+    {
+        return $this->config->getNotifyEndpoint();
+    }
+
+    /**
+     * Gets the session endpoint
+     *
+     * @return string
+     */
+    public function getSessionEndpoint()
+    {
+        return $this->config->getSessionEndpoint();
+    }
+
     /**
      * Set session delivery endpoint.
      *
@@ -808,6 +835,41 @@ public function getSessionClient()
         return $this->config->getSessionClient();
     }
 
+    /**
+     * Gets the current guzzle client.
+     *
+     * @return GuzzleHttp\ClientInterface
+     */
+    public function getGuzzleClient()
+    {
+        return $this->config->getGuzzleClient();
+    }
+
+    /**
+     * Sets the guzzle client
+     *
+     * Delivery URLs should be set using the "setEndpoints" method
+     *
+     * @param GuzzleHttp\ClientInterface $guzzleClient the new guzzle client
+     *
+     * @return $this
+     */
+    public function setGuzzleClient($guzzleClient)
+    {
+        $this->config->setGuzzleClient($guzzleClient);
+        return $this;
+    }
+
+    /**
+     * Whether any sessions are enabled.
+     *
+     * @return bool
+     */
+    public function sessionsEnabled()
+    {
+        return $this->config->sessionsEnabled();
+    }
+
     /**
      * Whether should be auto-capturing sessions.
      *

src/Configuration.php

@@ -3,22 +3,30 @@
 namespace Bugsnag;
 
 use InvalidArgumentException;
+use Bugsnag\Utils;
 
 class Configuration
 {
     /**
-     * The default endpoint.
+     * The default notification endpoint.
      *
      * @var string
      */
-    const SESSION_ENDPOINT = 'https://sessions.bugsnag.com';
+    const DEFAULT_NOTIFY_ENDPOINT = 'https://notify.bugsnag.com';
+
+    /**
+     * The default session endpoint.
+     *
+     * @var string
+     */
+    const DEFAULT_SESSION_ENDPOINT = 'https://sessions.bugsnag.com';
 
     /**
      * The default build endpoint.
      *
      * @var string
      */
-    const BUILD_ENDPOINT = 'https://build.bugsnag.com';
+    const DEFAULT_BUILD_ENDPOINT = 'https://build.bugsnag.com';
 
     /**
      * The Bugsnag API Key.
@@ -116,25 +124,39 @@ class Configuration
     protected $errorReportingLevel;
 
     /**
-     * Whether to track sessions.
+     * Whether to track sessions automatically.
+     *
+     * @var bool
+     */
+    protected $autoCaptureSessions = true;
+
+    /**
+     * Whether to allow any sessions to be tracked.
      *
      * @var bool
      */
-    protected $autoCaptureSessions = false;
+    protected $enableSessions = true;
 
     /**
-     * A client to use to send sessions.
+     * The client for making http requests
      *
-     * @var \Guzzle\ClientInterface
+     * @var GuzzleHttp\ClientInterface|null
      */
-    protected $sessionClient;
+    protected $guzzleClient = null;
+
+    /**
+     * The endpoint to deliver notifications to.
+     *
+     * @var string
+     */
+    protected $notifyEndpoint = self::DEFAULT_NOTIFY_ENDPOINT;
 
     /**
      * The endpoint to deliver sessions to.
      *
      * @var string
      */
-    protected $sessionEndpoint = self::SESSION_ENDPOINT;
+    protected $sessionEndpoint = self::DEFAULT_SESSION_ENDPOINT;
 
     /**
      * The endpoint to deliver build notifications to.
@@ -578,6 +600,75 @@ public function setAutoCaptureSessions($track)
         return $this;
     }
 
+    /**
+     * Whether any sessions are enabled.
+     *
+     * @return bool
+     */
+    public function sessionsEnabled()
+    {
+        if ($this->enableSessions) {
+            $notifyEndpointSet = $this->notifyEndpoint !== static::DEFAULT_NOTIFY_ENDPOINT;
+            $sessionEndpointSet = $this->sessionEndpoint !== static::DEFAULT_SESSION_ENDPOINT;
+            if ($notifyEndpointSet && !$sessionEndpointSet) {
+                syslog(LOG_WARNING, 'The session endpoint has not been set, all further session capturing will be disabled');
+                $this->enableSessions = false;
+            } elseif (!$notifyEndpointSet && $sessionEndpointSet) {
+                throw new InvalidArgumentException('The session endpoint cannot be modified without the notify endpoint');
+            }
+        }
+        return $this->enableSessions;
+    }
+
+    /**
+     * Whether should be auto-capturing sessions.
+     *
+     * @return bool
+     */
+    public function shouldCaptureSessions()
+    {
+        return $this->autoCaptureSessions && $this->sessionsEnabled();
+    }
+
+    /**
+     * Sets the notify and session endpoints
+     *
+     * @param string $notifyEndpoint the notify endpoint
+     * @param string $sessionEndpoint the session endpoint
+     *
+     * @return $this
+     */
+    public function setEndpoints($notifyEndpoint, $sessionEndpoint)
+    {
+        if ($notifyEndpoint) {
+            $this->notifyEndpoint = $notifyEndpoint;
+        }
+        if ($sessionEndpoint) {
+            $this->sessionEndpoint = $sessionEndpoint;
+        }
+        return $this;
+    }
+
+    /**
+     * Gets the notify endpoint
+     *
+     * @return string
+     */
+    public function getNotifyEndpoint()
+    {
+        return $this->notifyEndpoint;
+    }
+
+    /**
+     * Gets the session endpoint
+     *
+     * @return string
+     */
+    public function getSessionEndpoint()
+    {
+        return $this->sessionEndpoint;
+    }
+
     /**
      * Set session delivery endpoint.
      *
@@ -587,9 +678,7 @@ public function setAutoCaptureSessions($track)
      */
     public function setSessionEndpoint($endpoint)
     {
-        $this->sessionEndpoint = $endpoint;
-
-        $this->sessionClient = Client::makeGuzzle($this->sessionEndpoint);
+        $this->setEndpoints(null, $endpoint);
 
         return $this;
     }
@@ -601,21 +690,35 @@ public function setSessionEndpoint($endpoint)
      */
     public function getSessionClient()
     {
-        if (is_null($this->sessionClient)) {
-            $this->sessionClient = Client::makeGuzzle($this->sessionEndpoint);
-        }
+        return $this->getGuzzleClient();
+    }
 
-        return $this->sessionClient;
+    /**
+     * Sets the guzzle client
+     *
+     * Delivery URLs should be set using the "setEndpoints" method
+     *
+     * @param GuzzleHttp\ClientInterface $guzzleClient the new guzzle client
+     *
+     * @return $this
+     */
+    public function setGuzzleClient($guzzleClient)
+    {
+        $this->guzzleClient = $guzzleClient;
+        return $this;
     }
 
     /**
-     * Whether should be auto-capturing sessions.
+     * Gets the current guzzle client, making one if necessary
      *
-     * @return bool
+     * @return GuzzleHttp\ClientInterface
      */
-    public function shouldCaptureSessions()
+    public function getGuzzleClient()
     {
-        return $this->autoCaptureSessions;
+        if (!$this->guzzleClient) {
+            $this->guzzleClient = Utils::makeGuzzle();
+        }
+        return $this->guzzleClient;
     }
 
     /**
@@ -643,6 +746,6 @@ public function getBuildEndpoint()
             return $this->buildEndpoint;
         }
 
-        return self::BUILD_ENDPOINT;
+        return self::DEFAULT_BUILD_ENDPOINT;
     }
 }