Log in subscribers when broadcasting a subscription update

tests/Unit/Subscriptions/BroadcastManagerTest.php

@@ -9,24 +9,14 @@
 use Nuwave\Lighthouse\Subscriptions\BroadcastManager;
 use Nuwave\Lighthouse\Subscriptions\Contracts\Broadcaster;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
-use Nuwave\Lighthouse\Subscriptions\SubscriptionServiceProvider;
-use Tests\TestCase;
 
-class BroadcastManagerTest extends TestCase
+class BroadcastManagerTest extends SubscriptionTestCase
 {
     /**
      * @var \Nuwave\Lighthouse\Subscriptions\BroadcastManager
      */
     protected $broadcastManager;
 
-    protected function getPackageProviders($app)
-    {
-        return array_merge(
-            parent::getPackageProviders($app),
-            [SubscriptionServiceProvider::class]
-        );
-    }
-
     /**
      * Set up test environment.
      */

tests/Unit/Subscriptions/Iterators/GuardContextSyncIteratorTest.php

@@ -0,0 +1,173 @@
+<?php
+
+namespace Tests\Unit\Subscriptions\Iterators;
+
+use Exception;
+use GraphQL\Type\Definition\ResolveInfo;
+use Illuminate\Auth\AuthManager;
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
+use Mockery\MockInterface;
+use Nuwave\Lighthouse\Schema\Context;
+use Nuwave\Lighthouse\Subscriptions\Iterators\GuardContextSyncIterator;
+use Nuwave\Lighthouse\Subscriptions\Subscriber;
+use Nuwave\Lighthouse\Subscriptions\SubscriptionGuard;
+use Tests\Unit\Subscriptions\SubscriptionTestCase;
+
+class GuardContextSyncIteratorTest extends SubscriptionTestCase
+{
+    /**
+     * @var string
+     */
+    public const EXCEPTION_MESSAGE = 'test_exception';
+
+    /**
+     * @var \Nuwave\Lighthouse\Subscriptions\Iterators\GuardContextSyncIterator
+     */
+    protected $iterator;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->iterator = $this->app->make(GuardContextSyncIterator::class);
+    }
+
+    public function testCanIterateOverItemsWithCallback(): void
+    {
+        $items = [];
+
+        $this->iterator->process(
+            $this->subscribers(),
+            static function ($item) use (&$items): void {
+                $items[] = $item;
+            }
+        );
+
+        $this->assertCount(3, $items);
+    }
+
+    public function testCanPassExceptionToHandler(): void
+    {
+        /** @var \Exception|null $exception */
+        $exception = null;
+
+        $this->iterator->process(
+            $this->subscribers(),
+            static function (): void {
+                throw new Exception(self::EXCEPTION_MESSAGE);
+            },
+            static function (Exception $e) use (&$exception): void {
+                $exception = $e;
+            }
+        );
+
+        $this->assertSame(self::EXCEPTION_MESSAGE, $exception->getMessage());
+    }
+
+    public function testSetsAndResetsGuardContextAfterEachIteration(): void
+    {
+        // Give each subscriber a user stub and an ID based on the index of the subscriber in the collection
+        $subscribers = $this->subscribers()->map(static function (Subscriber $subscriber, int $index) {
+            $subscriber->context->user = new GuardContextSyncIteratorAuthenticatableStub($index + 1);
+
+            return $subscriber;
+        });
+
+        $guard = $this->mock(SubscriptionGuard::class, static function (MockInterface $mock) use ($subscribers) {
+            $subscribers->each(static function (Subscriber $subscriber) use ($mock) {
+                $mock->shouldReceive('setUser')->with($subscriber->context->user())->once();
+                $mock->shouldReceive('user')->andReturn($subscriber->context->user())->once();
+                $mock->shouldReceive('reset')->once();
+            });
+        });
+
+        $authManager = $this->app->make(AuthManager::class);
+
+        $authManager->extend(SubscriptionGuard::GUARD_NAME, static function () use ($guard) {
+            return $guard;
+        });
+
+        $processedItems = [];
+        $authenticatedUser = [];
+        $guardBeforeIteration = $authManager->guard();
+
+        $this->iterator->process(
+            $subscribers,
+            static function (Subscriber $subscriber) use (&$processedItems, &$authenticatedUser, $authManager): void {
+                $processedItems[] = $subscriber;
+                $authenticatedUser[] = $authManager->user();
+            }
+        );
+
+        $this->assertCount(3, $processedItems);
+        $this->assertSame($subscribers->pluck('context.user')->all(), $authenticatedUser);
+        $this->assertSame($guardBeforeIteration, $authManager->guard());
+    }
+
+    /**
+     * @return \Illuminate\Support\Collection<\Nuwave\Lighthouse\Subscriptions\Subscriber>
+     */
+    protected function subscribers(): Collection
+    {
+        return new Collection([
+            $this->generateSubscriber(),
+            $this->generateSubscriber(),
+            $this->generateSubscriber(),
+        ]);
+    }
+
+    private function generateSubscriber(): Subscriber
+    {
+        $resolveInfo = $this->getMockBuilder(ResolveInfo::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $resolveInfo->operation = (object)[
+            'name' => (object)[
+                'value' => 'lighthouse',
+            ],
+        ];
+
+        return new Subscriber([], new Context(new Request), $resolveInfo);
+    }
+}
+
+class GuardContextSyncIteratorAuthenticatableStub implements Authenticatable
+{
+    /**
+     * @var int
+     */
+    private $id;
+
+    public function __construct(int $id)
+    {
+        $this->id = $id;
+    }
+
+    public function getAuthIdentifierName()
+    {
+    }
+
+    public function getAuthIdentifier()
+    {
+        return $this->id;
+    }
+
+    public function getAuthPassword()
+    {
+    }
+
+    public function getRememberToken()
+    {
+    }
+
+    public function setRememberToken($value)
+    {
+    }
+
+    public function getRememberTokenName()
+    {
+    }
+}

tests/Unit/Subscriptions/Iterators/SyncIteratorTest.php

@@ -32,7 +32,7 @@ public function testCanIterateOverItemsWithCallback(): void
 
         $this->iterator->process(
             $this->items(),
-            function ($item) use (&$items): void {
+            static function ($item) use (&$items): void {
                 $items[] = $item;
             }
         );
@@ -47,10 +47,10 @@ public function testCanPassExceptionToHandler(): void
 
         $this->iterator->process(
             $this->items(),
-            function (): void {
+            static function (): void {
                 throw new Exception(self::EXCEPTION_MESSAGE);
             },
-            function (Exception $e) use (&$exception): void {
+            static function (Exception $e) use (&$exception): void {
                 $exception = $e;
             }
         );

tests/Unit/Subscriptions/StorageManagerTest.php

@@ -6,24 +6,14 @@
 use GraphQL\Utils\AST;
 use Nuwave\Lighthouse\Subscriptions\StorageManager;
 use Nuwave\Lighthouse\Subscriptions\Subscriber;
-use Nuwave\Lighthouse\Subscriptions\SubscriptionServiceProvider;
-use Tests\TestCase;
 
-class StorageManagerTest extends TestCase
+class StorageManagerTest extends SubscriptionTestCase
 {
     /**
      * @var \Nuwave\Lighthouse\Subscriptions\StorageManager
      */
     protected $storage;
 
-    protected function getPackageProviders($app)
-    {
-        return array_merge(
-            parent::getPackageProviders($app),
-            [SubscriptionServiceProvider::class]
-        );
-    }
-
     protected function setUp(): void
     {
         parent::setUp();

tests/Unit/Subscriptions/SubscriptionTestCase.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tests\Unit\Subscriptions;
+
+use Nuwave\Lighthouse\Subscriptions\SubscriptionServiceProvider;
+use Tests\TestCase;
+
+class SubscriptionTestCase extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return array_merge(
+            parent::getPackageProviders($app),
+            [SubscriptionServiceProvider::class]
+        );
+    }
+}