[2.0] feat: Add global SDK

Makefile

@@ -21,7 +21,7 @@ phpstan:
 	vendor/bin/phpstan analyse
 
 test: cs-fix phpstan
-	vendor/bin/phpunit
+	vendor/bin/phpunit --verbose
 
 setup-git:
 	git config branch.autosetuprebase always

composer.json

@@ -47,6 +47,7 @@
         "bin/sentry"
     ],
     "autoload": {
+        "files": ["src/Sdk.php"],
         "psr-4" : {
             "Sentry\\" : "src/"
         }

src/ClientBuilder.php

@@ -131,7 +131,7 @@ public function __construct(array $options = [])
     /**
      * {@inheritdoc}
      */
-    public static function create(array $options = [])
+    public static function create(array $options = []): self
     {
         return new static($options);
     }
@@ -239,7 +239,7 @@ public function getMiddlewares()
     /**
      * {@inheritdoc}
      */
-    public function getClient()
+    public function getClient(): ClientInterface
     {
         $this->messageFactory = $this->messageFactory ?? MessageFactoryDiscovery::find();
         $this->uriFactory = $this->uriFactory ?? UriFactoryDiscovery::find();

src/ClientBuilderInterface.php

@@ -121,5 +121,5 @@ public function getMiddlewares();
      *
      * @return ClientInterface
      */
-    public function getClient();
+    public function getClient(): ClientInterface;
 }

src/Sdk.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Sentry;
+
+use Sentry\Breadcrumbs\Breadcrumb;
+use Sentry\State\Hub;
+
+/**
+ * Creates a new Client and Hub which will be set as current.
+ *
+ * @param array $options
+ */
+function init(array $options = []): void
+{
+    Hub::setCurrent(new Hub(ClientBuilder::create($options)->getClient()));
+}
+
+/**
+ * Captures a message event and sends it to Sentry.
+ *
+ * @param string   $message The message
+ * @param Severity $level   The severity level of the message
+ *
+ * @return null|string
+ */
+function captureMessage(string $message, ?Severity $level = null): ?string
+{
+    return Hub::getCurrent()->captureMessage($message, $level);
+}
+
+/**
+ * Captures an exception event and sends it to Sentry.
+ *
+ * @param \Throwable $exception The exception
+ *
+ * @return null|string
+ */
+function captureException(\Throwable $exception): ?string
+{
+    return Hub::getCurrent()->captureException($exception);
+}
+
+/**
+ * Captures a new event using the provided data.
+ *
+ * @param array $payload The data of the event being captured
+ *
+ * @return null|string
+ */
+function captureEvent(array $payload): ?string
+{
+    return Hub::getCurrent()->captureEvent($payload);
+}
+
+/**
+ * Records a new breadcrumb which will be attached to future events. They
+ * will be added to subsequent events to provide more context on user's
+ * actions prior to an error or crash.
+ *
+ * @param Breadcrumb $breadcrumb The breadcrumb to record
+ */
+function addBreadcrumb(Breadcrumb $breadcrumb): void
+{
+    Hub::getCurrent()->addBreadcrumb($breadcrumb);
+}
+
+/**
+ * Calls the given callback passing to it the current scope so that any
+ * operation can be run within its context.
+ *
+ * @param callable $callback The callback to be executed
+ */
+function configureScope(callable $callback): void
+{
+    Hub::getCurrent()->configureScope($callback);
+}
+
+/**
+ * Creates a new scope with and executes the given operation within. The scope
+ * is automatically removed once the operation finishes or throws.
+ *
+ * @param callable $callback The callback to be executed
+ */
+function withScope(callable $callback): void
+{
+    Hub::getCurrent()->withScope($callback);
+}

src/State/Hub.php

@@ -34,6 +34,13 @@ final class Hub
     /**
      * Constructor.
      *
+     * @var Hub
+     */
+    private static $currentHub;
+
+    /**
+     * Hub constructor.
+     *
      * @param ClientInterface|null $client The client bound to the hub
      * @param Scope|null           $scope  The scope bound to the hub
      */
@@ -206,6 +213,24 @@ public function captureException(\Throwable $exception): ?string
         return null;
     }
 
+    /**
+     * Captures a new event using the provided data.
+     *
+     * @param array $payload The data of the event being captured
+     *
+     * @return null|string
+     */
+    public function captureEvent(array $payload): ?string
+    {
+        $client = $this->getClient();
+
+        if (null !== $client) {
+            return $this->lastEventId = $client->capture($payload);
+        }
+
+        return null;
+    }
+
     /**
      * Records a new breadcrumb which will be attached to future events. They
      * will be added to subsequent events to provide more context on user's
@@ -221,4 +246,32 @@ public function addBreadcrumb(Breadcrumb $breadcrumb): void
             $client->addBreadcrumb($breadcrumb, $this->getScope());
         }
     }
+
+    /**
+     * Returns the current global Hub.
+     *
+     * @return Hub
+     */
+    public static function getCurrent(): self
+    {
+        if (null === self::$currentHub) {
+            self::$currentHub = new self();
+        }
+
+        return self::$currentHub;
+    }
+
+    /**
+     * Sets the Hub as the current.
+     *
+     * @param self $hub
+     *
+     * @return Hub
+     */
+    public static function setCurrent(self $hub): self
+    {
+        self::$currentHub = $hub;
+
+        return $hub;
+    }
 }

tests/SdkTest.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Sentry\Breadcrumbs\Breadcrumb;
+use Sentry\ClientInterface;
+use Sentry\State\Hub;
+use function Sentry\addBreadcrumb;
+use function Sentry\captureEvent;
+use function Sentry\captureException;
+use function Sentry\captureMessage;
+use function Sentry\configureScope;
+use function Sentry\init;
+use function Sentry\withScope;
+
+class SdkTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        init();
+    }
+
+    public function testInit(): void
+    {
+        $this->assertNotNull(Hub::getCurrent()->getClient());
+    }
+
+    public function testCaptureMessage(): void
+    {
+        /** @var ClientInterface|MockObject $client */
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects($this->once())
+            ->method('captureMessage')
+            ->with('foo', [], ['level' => null])
+            ->willReturn('92db40a886c0458288c7c83935a350ef');
+
+        Hub::getCurrent()->bindClient($client);
+        $this->assertEquals($client, Hub::getCurrent()->getClient());
+        $this->assertEquals('92db40a886c0458288c7c83935a350ef', captureMessage('foo'));
+    }
+
+    public function testCaptureException(): void
+    {
+        $exception = new \RuntimeException('foo');
+
+        /** @var ClientInterface|MockObject $client */
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects($this->once())
+            ->method('captureException')
+            ->with($exception)
+            ->willReturn('2b867534eead412cbdb882fd5d441690');
+
+        Hub::getCurrent()->bindClient($client);
+
+        $this->assertEquals('2b867534eead412cbdb882fd5d441690', captureException($exception));
+    }
+
+    public function testCaptureEvent(): void
+    {
+        /** @var ClientInterface|MockObject $client */
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects($this->once())
+            ->method('capture')
+            ->with(['message' => 'test'])
+            ->willReturn('2b867534eead412cbdb882fd5d441690');
+
+        Hub::getCurrent()->bindClient($client);
+
+        $this->assertEquals('2b867534eead412cbdb882fd5d441690', captureEvent(['message' => 'test']));
+    }
+
+    public function testAddBreadcrumb(): void
+    {
+        $breadcrumb = new Breadcrumb(Breadcrumb::LEVEL_ERROR, Breadcrumb::TYPE_ERROR, 'error_reporting');
+
+        /** @var ClientInterface|MockObject $client */
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects($this->once())
+            ->method('addBreadcrumb')
+            ->with($breadcrumb, Hub::getCurrent()->getScope());
+
+        Hub::getCurrent()->bindClient($client);
+        addBreadcrumb($breadcrumb);
+    }
+
+    public function testWithScope(): void
+    {
+        $callbackInvoked = false;
+
+        withScope(function () use (&$callbackInvoked): void {
+            $callbackInvoked = true;
+        });
+
+        $this->assertTrue($callbackInvoked);
+    }
+
+    public function configureScope(): void
+    {
+        $callbackInvoked = false;
+
+        configureScope(function () use (&$callbackInvoked): void {
+            $callbackInvoked = true;
+        });
+
+        $this->assertTrue($callbackInvoked);
+    }
+}

tests/State/HubTest.php

@@ -262,4 +262,18 @@ public function testAddBreadcrumb(): void
         $hub = new Hub($client, $scope);
         $hub->addBreadcrumb($breadcrumb);
     }
+
+    public function testCaptureEvent(): void
+    {
+        /** @var ClientInterface|MockObject $client */
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects($this->once())
+            ->method('capture')
+            ->with(['message' => 'test'])
+            ->willReturn('2b867534eead412cbdb882fd5d441690');
+
+        $hub = new Hub($client);
+
+        $this->assertEquals('2b867534eead412cbdb882fd5d441690', $hub->captureEvent(['message' => 'test']));
+    }
 }