Merge pull request #1915 from danog/fix-group-call-ended-event

Group calls: report a call that ended (GROUPCALL_INVALID) as discarded

Author: danog

src/GroupCall/GroupCallController.php

@@ -775,11 +775,34 @@ private function checkJoined(): void
     /**
      * The call ended, or we may not be in it anymore (GROUPCALL_FORBIDDEN or GROUPCALL_INVALID): leave it, as
      * TDLib does.
+     *
+     * A call that ended (GROUPCALL_INVALID) is reported to the event handler as discarded, as if we got its
+     * groupCallDiscarded: we may never get one (a live story ends with an updateStory deleting it).
      */
     private function onEnded(string $rpc): void
     {
         $this->log("$this ended, or we may not be in it anymore ($rpc): leaving it.", Logger::NOTICE);
+        $discarded = $this->public->discarded;
         $this->cleanup();
+        if ($rpc !== 'GROUPCALL_INVALID' || $discarded) {
+            return;
+        }
+        $update = [
+            '_' => 'updateGroupCall',
+            'call' => ['_' => 'groupCallDiscarded', 'id' => $this->public->id, 'access_hash' => $this->public->accessHash, 'duration' => 0],
+        ];
+        if ($this->public instanceof LiveStory) {
+            $update['live_story'] = true;
+        }
+        $peerId = $this->public->peerId;
+        if ($peerId !== null) {
+            $update['peer'] = match (true) {
+                DialogId::isUser($peerId) => ['_' => 'peerUser', 'user_id' => $peerId],
+                DialogId::isChat($peerId) => ['_' => 'peerChat', 'chat_id' => DialogId::toChatId($peerId)],
+                default => ['_' => 'peerChannel', 'channel_id' => DialogId::toSupergroupOrChannelId($peerId)],
+            };
+        }
+        $this->API->saveUpdate($update);
     }
 
     /**

tests/danog/MadelineProto/GroupCallMembershipTest.php

@@ -33,7 +33,6 @@
 use DG\BypassFinals;
 use Exception;
 use PHPUnit\Framework\TestCase;
-use ReflectionClass;
 use ReflectionProperty;
 
 use function Amp\delay;
@@ -64,12 +63,18 @@ protected function setUp(): void
         BypassFinals::enable();
     }
 
+    /** @var list<array> The updates saved. */
+    private array $updates = [];
+
     private function client(): MTProto
     {
-        $API = (new ReflectionClass(MTProto::class))->newInstanceWithoutConstructor();
+        $API = $this->getMockBuilder(MTProto::class)->disableOriginalConstructor()->onlyMethods(['saveUpdate'])->getMock();
+        $API->method('saveUpdate')->willReturnCallback(function (array $update): void {
+            $this->updates[] = $update;
+        });
         $API->logger = new Logger((new LoggerSettings)->setType(Logger::ECHO_LOGGER)->setLevel(Logger::FATAL_ERROR));
         $API->wrapper = new APIWrapper(new SessionPaths(sys_get_temp_dir().'/madeline-group-call-membership'));
-        (new ReflectionProperty($API, 'settings'))->setValue($API, new Settings);
+        (new ReflectionProperty(MTProto::class, 'settings'))->setValue($API, new Settings);
         $connection = $this->createMock(Connection::class);
         $connection->method('methodCallAsyncRead')->willReturnCallback(function (string $method, array $args): mixed {
             $this->calls[] = $method;
@@ -82,7 +87,7 @@ private function client(): MTProto
         return $API;
     }
 
-    private function joinedCall(MTProto $API): GroupCallController
+    private function joinedCall(MTProto $API, ?int $peerId = null, bool $liveStory = false): GroupCallController
     {
         $controller = new GroupCallController($API, [
             '_' => 'groupCall',
@@ -103,10 +108,10 @@ private function joinedCall(MTProto $API): GroupCallController
             'record_video_active' => false,
             'conference' => false,
             'version' => 1,
-        ]);
+        ], $peerId, $liveStory);
         (new ReflectionProperty($controller, 'callState'))->setValue($controller, GroupCallState::JOINED);
         (new ReflectionProperty($controller, 'source'))->setValue($controller, self::SOURCE);
-        (new ReflectionProperty($API, 'groupCalls'))->setValue($API, [1 => $controller]);
+        (new ReflectionProperty(MTProto::class, 'groupCalls'))->setValue($API, [1 => $controller]);
         return $controller;
     }
 
@@ -143,6 +148,40 @@ public function testAnEndedCallIsLeft(string $rpc): void
         $this->assertSame([], $API->getAllGroupCalls());
     }
 
+    /**
+     * A call that ended is reported to the event handler as discarded: a live story ends with an updateStory, without
+     * the groupCallDiscarded the event handler waits for (magnaluna didn't start its live story again).
+     */
+    public function testAnEndedCallIsReportedAsDiscarded(): void
+    {
+        $API = $this->client();
+        $controller = $this->joinedCall($API, 783732906, liveStory: true);
+        $this->answer = static fn () => throw RPCErrorException::make('GROUPCALL_INVALID', 400, '');
+
+        self::check($controller);
+
+        $this->assertSame([[
+            '_' => 'updateGroupCall',
+            'call' => ['_' => 'groupCallDiscarded', 'id' => 1, 'access_hash' => 1234, 'duration' => 0],
+            'live_story' => true,
+            'peer' => ['_' => 'peerUser', 'user_id' => 783732906],
+        ]], $this->updates);
+    }
+
+    /**
+     * A call we may just not be in anymore didn't end: it isn't reported as discarded.
+     */
+    public function testAForbiddenCallIsNotReportedAsDiscarded(): void
+    {
+        $controller = $this->joinedCall($this->client(), -1001412768105);
+        $this->answer = static fn () => throw RPCErrorException::make('GROUPCALL_FORBIDDEN', 403, '');
+
+        self::check($controller);
+
+        $this->assertSame(GroupCallState::LEFT, $controller->getCallState());
+        $this->assertSame([], $this->updates);
+    }
+
     /**
      * A failed WebRTC connection is rejoined right away, even if the server still lists our source: it never
      * recovers by itself (after a network outage, every call of a bot stayed failed for hours, sending nothing).