Merge pull request #16 from symfony/finish-pr-15

Finish pr 15

Author: dunglas

.travis.yml

@@ -3,7 +3,7 @@ language: php
 jobs:
   include:
     - php: '7.1'
-    - php: 7.2
+    - php: '7.2'
     - php: '7.3'
       env: lint=1
     - php: '7.3'
@@ -24,7 +24,7 @@ install:
   - if [[ $deps = 'low' ]]; then
       composer update --prefer-dist --no-progress --no-suggest --prefer-stable --prefer-lowest --ansi;
     else
-      composer update --prefer-dist --no-progress --no-suggest --ansi;
+      composer update --prefer-dist --no-progress --no-suggest --prefer-stable --ansi;
     fi
 
 script:

CHANGELOG.md

@@ -1,10 +1,13 @@
 CHANGELOG
 =========
 
-0.2.1
+0.3.0
 -----
 
 * Compatibility with Symfony 5
+* Add `TraceablePublisher` to collect debug information
+* Add `PublisherInterface`
+* Fix an error when using the `retry` parameter
 
 0.2.0
 -----

composer.json

@@ -27,7 +27,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.x-dev"
+            "dev-master": "0.3.x-dev"
         },
         "thanks": {
             "name": "dunglas/mercure",
@@ -37,7 +37,12 @@
     "config": {
         "sort-packages": true
     },
+    "suggest": {
+        "symfony/stopwatch": "Integration with the profiler performances"
+    },
     "require-dev": {
-        "symfony/phpunit-bridge": "^4.2.4|^5.0"
-    }
+        "symfony/phpunit-bridge": "^4.2.4|^5.0",
+        "symfony/stopwatch": "^4.3|^5.0"
+    },
+    "minimum-stability": "dev"
 }

src/Debug/TraceablePublisher.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Mercure Component project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Mercure\Debug;
+
+use Symfony\Component\Mercure\PublisherInterface;
+use Symfony\Component\Mercure\Update;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Contracts\Service\ResetInterface;
+
+/**
+ * Traces updates for profiler.
+ *
+ * @author Vincent Chalamon <[email protected]>
+ *
+ * @experimental
+ */
+final class TraceablePublisher implements PublisherInterface, ResetInterface
+{
+    private $publisher;
+    private $stopwatch;
+    private $messages = [];
+
+    public function __construct(PublisherInterface $publisher, Stopwatch $stopwatch)
+    {
+        $this->publisher = $publisher;
+        $this->stopwatch = $stopwatch;
+    }
+
+    public function __invoke(Update $update): string
+    {
+        $this->stopwatch->start(__CLASS__);
+
+        $content = ($this->publisher)($update);
+
+        $e = $this->stopwatch->stop(__CLASS__);
+        $this->messages[] = [
+            'object' => $update,
+            'duration' => $e->getDuration(),
+            'memory' => $e->getMemory(),
+        ];
+
+        return $content;
+    }
+
+    public function reset()
+    {
+        $this->messages = [];
+    }
+
+    public function count(): int
+    {
+        return \count($this->messages);
+    }
+
+    public function getMessages(): array
+    {
+        return $this->messages;
+    }
+
+    public function getDuration(): float
+    {
+        return array_sum(array_map(function ($a) {
+            return $a['duration'];
+        }, $this->messages));
+    }
+
+    public function getMemory(): int
+    {
+        return (int) array_sum(array_map(function ($a) {
+            return $a['memory'];
+        }, $this->messages));
+    }
+}

src/Publisher.php

@@ -25,15 +25,14 @@
  *
  * @experimental
  */
-final class Publisher
+final class Publisher implements PublisherInterface
 {
     private $hubUrl;
     private $jwtProvider;
     private $httpClient;
 
     /**
-     * @param callable(): string       $jwtProvider
-     * @param HttpClientInterface|null $httpClient
+     * @param callable(): string $jwtProvider
      */
     public function __construct(string $hubUrl, callable $jwtProvider, HttpClientInterface $httpClient = null)
     {

src/PublisherInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Mercure Component project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Mercure;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ *
+ * @experimental
+ */
+interface PublisherInterface
+{
+    public function __invoke(Update $update): string;
+}

tests/Debug/TraceablePublisherTest.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Mercure Component project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Mercure\Tests\Debug;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mercure\Debug\TraceablePublisher;
+use Symfony\Component\Mercure\Publisher;
+use Symfony\Component\Mercure\Update;
+use Symfony\Component\Stopwatch\Stopwatch;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+final class TraceablePublisherTest extends TestCase
+{
+    const URL = 'https://demo.mercure.rocks/hub';
+    const JWT = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6WyJmb28iLCJiYXIiXSwicHVibGlzaCI6WyJmb28iXX19.LRLvirgONK13JgacQ_VbcjySbVhkSmHy3IznH3tA9PM';
+
+    public function testPublish(): void
+    {
+        $publisher = new Publisher(self::URL, function (): string {
+            return self::JWT;
+        });
+        $traceablePublisher = new TraceablePublisher($publisher, new Stopwatch());
+        $update = new Update(
+            'https://demo.mercure.rocks/demo/books/1.jsonld',
+            'Hi from Symfony!',
+            [],
+            'id',
+            null,
+            3
+        );
+        $traceablePublisher($update);
+
+        $this->assertEquals(1, $traceablePublisher->count());
+        $this->assertSame($update, $traceablePublisher->getMessages()[0]['object']);
+    }
+}