feat(multiset): handle r=ping correctly

app/Connect/Actions/BuildClientPatchDataAction.php

@@ -43,54 +43,42 @@ public function execute(
             throw new InvalidArgumentException('Either gameHash or game must be provided to build patch data.');
         }
 
-        // For legacy clients, just use the game directly.
+        // For legacy clients that don't provide a hash, just use the game directly.
         if (!$gameHash) {
             return $this->buildPatchData($game, null, $user, $flag);
         }
 
-        $hashGame = $gameHash->game;
+        $rootGameId = (new ResolveRootGameIdAction())->execute($gameHash, $game, $user);
+        $rootGame = Game::find($rootGameId);
 
-        // If there's no user or the current user has multiset globally disabled, use the hash game.
+        // If multiset is disabled or there's no user, just use the game directly.
         if (!$user || $user->is_globally_opted_out_of_subsets) {
-            return $this->buildPatchData($hashGame, null, $user, $flag);
+            return $this->buildPatchData($rootGame, null, $user, $flag);
         }
 
         // Resolve sets once - we'll use this for building the full patch data.
         $resolvedSets = (new ResolveAchievementSetsAction())->execute($gameHash, $user);
         if ($resolvedSets->isEmpty()) {
-            return $this->buildPatchData($hashGame, null, $user, $flag);
+            return $this->buildPatchData($rootGame, null, $user, $flag);
         }
 
         // Get the core game from the first resolved set.
         $coreSet = $resolvedSets->first();
-        $coreGame = Game::find($coreSet->game_id) ?? $hashGame;
+        $coreGame = Game::find($coreSet->game_id) ?? $rootGame;
 
         $richPresencePatch = $coreGame->RichPresencePatch;
 
-        // Look up if this hash game's achievement set is attached as a subset to the core game
-        $hashGameSubsetAttachment = GameAchievementSet::where('game_id', $coreGame->id)
-            ->where('achievement_set_id', $hashGame->gameAchievementSets()->core()->first()?->achievement_set_id)
-            ->first();
+        // For specialty/exclusive sets, we use:
+        // - The root game's ID and achievements (already determined by ResolveRootGameIdAction).
+        // - The core game's title and image.
+        // - The root game's RP if present, otherwise fall back to core game's RP.
+        if ($rootGameId === $gameHash->game->id) {
+            $richPresencePatch = $gameHash->game->RichPresencePatch ?: $richPresencePatch;
 
-        if ($hashGameSubsetAttachment && in_array($hashGameSubsetAttachment->type, [AchievementSetType::Specialty, AchievementSetType::Exclusive])) {
-            /**
-             * At the root level:
-             * - Use the subset game's ID and achievements.
-             * - Use the core game's title and image.
-             * - Use the subset game's RP, if present.
-             */
-            $richPresencePatch = $hashGame->RichPresencePatch ?: $richPresencePatch;
-
-            return $this->buildPatchData(
-                $hashGame, // ... use the subset game for ID and achievements ...
-                $resolvedSets,
-                $user,
-                $flag,
-                $richPresencePatch,
-                $coreGame // ... use the core game for title and image ...
-            );
+            return $this->buildPatchData($rootGame, $resolvedSets, $user, $flag, $richPresencePatch, $coreGame);
         }
 
+        // For all other cases (including bonus sets), we use the core game's data.
         return $this->buildPatchData($coreGame, $resolvedSets, $user, $flag, $richPresencePatch);
     }
 

app/Connect/Actions/ResolveRootGameIdAction.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Connect\Actions;
+
+use App\Models\Game;
+use App\Models\GameAchievementSet;
+use App\Models\GameHash;
+use App\Models\User;
+use App\Platform\Enums\AchievementSetType;
+use InvalidArgumentException;
+
+class ResolveRootGameIdAction
+{
+    /**
+     * Resolves the root game ID for a given game hash and user combination.
+     * - For legacy clients or when multiset is globally disabled, uses the hash's game ID directly.
+     * - For bonus sets, uses the core game ID.
+     * - For specialty/exclusive sets, uses the set's game ID.
+     *
+     * @param GameHash|null $gameHash the game hash to resolve the root game ID for
+     * @param Game|null $game the game to resolve the root game ID for (for legacy clients)
+     * @param User|null $user the current user (for multiset resolution)
+     * @throws InvalidArgumentException when neither $gameHash nor $game is provided
+     */
+    public function execute(
+        ?GameHash $gameHash = null,
+        ?Game $game = null,
+        ?User $user = null,
+    ): int {
+        if (!$gameHash && !$game) {
+            throw new InvalidArgumentException('Either gameHash or game must be provided to resolve the root game ID.');
+        }
+
+        // For legacy clients or multi-disc games (where the hash isn't provided), just use the game ID directly.
+        if (!$gameHash) {
+            return $game->id;
+        }
+
+        $hashGame = $gameHash->game;
+
+        // If there's no user or the current user has multiset globally disabled, use the hash game.
+        if (!$user || $user->is_globally_opted_out_of_subsets) {
+            return $hashGame->id;
+        }
+
+        // Resolve sets once - we'll use this to determine the core game.
+        $resolvedSets = (new ResolveAchievementSetsAction())->execute($gameHash, $user);
+        if ($resolvedSets->isEmpty()) {
+            return $hashGame->id;
+        }
+
+        // Get the core game from the first resolved set.
+        $coreSet = $resolvedSets->first();
+        $coreGame = Game::find($coreSet->game_id) ?? $hashGame;
+
+        // Look up if this hash game's achievement set is attached as a subset to the core game.
+        $hashGameSubsetAttachment = GameAchievementSet::whereGameId($coreGame->id)
+            ->whereAchievementSetId($hashGame->gameAchievementSets()->core()->first()?->achievement_set_id)
+            ->first();
+
+        $isSpecialtyOrExclusive = in_array($hashGameSubsetAttachment->type, [AchievementSetType::Specialty, AchievementSetType::Exclusive]);
+        if ($hashGameSubsetAttachment && $isSpecialtyOrExclusive) {
+            // For specialty/exclusive sets, use the subset game ID.
+            return $hashGame->id;
+        }
+
+        // For all other cases (including bonus sets), use the core game ID.
+        return $coreGame->id;
+    }
+}

config/feature.php

@@ -5,4 +5,5 @@
      * 'example' => env('FEATURE_EXAMPLE', false),
      */
     'enable_modern_hubs' => env('FEATURE_ENABLE_MODERN_HUBS', false),
+    'enable_multiset' => env('VITE_FEATURE_MULTISET', false),
 ];

public/dorequest.php

@@ -4,6 +4,7 @@
 use App\Connect\Actions\BuildClientPatchDataAction;
 use App\Connect\Actions\GetClientSupportLevelAction;
 use App\Connect\Actions\InjectPatchClientSupportLevelDataAction;
+use App\Connect\Actions\ResolveRootGameIdAction;
 use App\Enums\ClientSupportLevel;
 use App\Enums\Permissions;
 use App\Models\Achievement;
@@ -332,6 +333,12 @@ function DoRequestError(string $error, ?int $status = 200, ?string $code = null)
                 }
             }
 
+            // If multiset is enabled, resolve the root game ID.
+            if (config('feature.enable_multiset')) {
+                $rootGameId = (new ResolveRootGameIdAction())->execute($gameHash, $game, $user);
+                $game = Game::find($rootGameId);
+            }
+
             PlayerSessionHeartbeat::dispatch($user, $game, $activityMessage, $gameHash);
 
             $response['Success'] = true;

tests/Feature/Connect/PingMultisetTest.php

@@ -0,0 +1,185 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Feature\Connect;
+
+use App\Models\Achievement;
+use App\Models\Game;
+use App\Models\GameHash;
+use App\Models\PlayerSession;
+use App\Models\System;
+use App\Models\User;
+use App\Platform\Actions\AssociateAchievementSetToGameAction;
+use App\Platform\Actions\UpsertGameCoreAchievementSetFromLegacyFlagsAction;
+use App\Platform\Enums\AchievementSetType;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Str;
+use Tests\Feature\Platform\Concerns\TestsPlayerAchievements;
+use Tests\TestCase;
+
+/**
+ * TODO migrate these test cases into PingTest after multiset is generally available.
+ * These have to be separated because environment variables can only be changed at the
+ * test suite level, not the test case level.
+ */
+class PingMultisetTest extends TestCase
+{
+    use BootstrapsConnect;
+    use RefreshDatabase;
+    use TestsPlayerAchievements;
+
+    protected User $user;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Config::set('feature.enable_multiset', true);
+
+        /** @var User $user */
+        $user = User::factory()->create(['appToken' => Str::random(16)]);
+        $this->user = $user;
+    }
+
+    public function testPingWithBonusSetResolvesToCoreGame(): void
+    {
+        // Arrange
+        Carbon::setTestNow(Carbon::now());
+
+        $system = System::factory()->create();
+        $baseGame = Game::factory()->create(['ConsoleID' => $system->id]);
+        $bonusGame = Game::factory()->create(['ConsoleID' => $system->id]);
+
+        Achievement::factory()->published()->count(2)->create(['GameID' => $baseGame->id]);
+        Achievement::factory()->published()->count(2)->create(['GameID' => $bonusGame->id]);
+
+        $upsertGameCoreSetAction = new UpsertGameCoreAchievementSetFromLegacyFlagsAction();
+        $associateAchievementSetToGameAction = new AssociateAchievementSetToGameAction();
+
+        $upsertGameCoreSetAction->execute($baseGame);
+        $upsertGameCoreSetAction->execute($bonusGame);
+        $associateAchievementSetToGameAction->execute($baseGame, $bonusGame, AchievementSetType::Bonus, 'Bonus');
+
+        $bonusGameHash = GameHash::factory()->create(['game_id' => $bonusGame->id]);
+
+        $this->user->LastGameID = $bonusGame->id;
+        $this->user->save();
+
+        // Act
+        $response = $this->post('dorequest.php', $this->apiParams('ping', [
+            'g' => $bonusGame->id, // !!
+            'm' => 'Playing bonus content',
+            'x' => $bonusGameHash->md5,
+        ]))
+            ->assertStatus(200)
+            ->assertExactJson(['Success' => true]);
+
+        // Assert
+        $response
+            ->assertStatus(200)
+            ->assertExactJson(['Success' => true]);
+
+        $playerSession = PlayerSession::latest()->first();
+
+        $this->assertNotNull($playerSession);
+        $this->assertEquals($this->user->id, $playerSession->user_id);
+        $this->assertEquals($baseGame->id, $playerSession->game_id);
+        $this->assertEquals($bonusGameHash->id, $playerSession->game_hash_id);
+        $this->assertEquals('Playing bonus content', $playerSession->rich_presence);
+        $this->assertEquals(1, $playerSession->duration);
+
+        $this->assertEquals($baseGame->id, $this->user->fresh()->LastGameID);
+        $this->assertEquals('Playing bonus content', $this->user->fresh()->RichPresenceMsg);
+    }
+
+    public function testPingWithSpecialtySetMaintainsSubsetGame(): void
+    {
+        // Arrange
+        Carbon::setTestNow(Carbon::now());
+
+        $system = System::factory()->create();
+        $baseGame = Game::factory()->create(['ConsoleID' => $system->id]);
+        $specialtyGame = Game::factory()->create(['ConsoleID' => $system->id]);
+
+        Achievement::factory()->published()->count(2)->create(['GameID' => $baseGame->id]);
+        Achievement::factory()->published()->count(2)->create(['GameID' => $specialtyGame->id]);
+
+        $upsertGameCoreSetAction = new UpsertGameCoreAchievementSetFromLegacyFlagsAction();
+        $associateAchievementSetToGameAction = new AssociateAchievementSetToGameAction();
+
+        $upsertGameCoreSetAction->execute($baseGame);
+        $upsertGameCoreSetAction->execute($specialtyGame);
+        $associateAchievementSetToGameAction->execute($baseGame, $specialtyGame, AchievementSetType::Specialty, 'Specialty');
+
+        $specialtyGameHash = GameHash::factory()->create(['game_id' => $specialtyGame->id]);
+
+        $this->user->LastGameID = $specialtyGame->id;
+        $this->user->save();
+
+        // Act
+        $response = $this->post('dorequest.php', $this->apiParams('ping', [
+            'g' => $specialtyGame->id,
+            'm' => 'Playing specialty content',
+            'x' => $specialtyGameHash->md5,
+        ]));
+
+        // Assert
+        $response
+            ->assertStatus(200)
+            ->assertExactJson(['Success' => true]);
+
+        $playerSession = PlayerSession::latest()->first();
+
+        $this->assertNotNull($playerSession);
+        $this->assertEquals($this->user->id, $playerSession->user_id);
+        $this->assertEquals($specialtyGame->id, $playerSession->game_id); // !! should stay on specialty game
+        $this->assertEquals($specialtyGameHash->id, $playerSession->game_hash_id);
+        $this->assertEquals('Playing specialty content', $playerSession->rich_presence);
+        $this->assertEquals(1, $playerSession->duration);
+
+        $this->assertEquals($specialtyGame->id, $this->user->fresh()->LastGameID);
+        $this->assertEquals('Playing specialty content', $this->user->fresh()->RichPresenceMsg);
+    }
+
+    public function testPingWithMultiDiscGameUsesGameIdDirectly(): void
+    {
+        // Arrange
+        Carbon::setTestNow(Carbon::now());
+
+        $system = System::factory()->create();
+        $game = Game::factory()->create(['ConsoleID' => $system->id]);
+        $gameHash = GameHash::factory()->create([
+            'game_id' => $game->id,
+            'name' => 'Game Title (Disc 2)', // !! will be detected as multi-disc
+        ]);
+
+        $this->user->LastGameID = $game->id;
+        $this->user->save();
+
+        // Act
+        $response = $this->post('dorequest.php', $this->apiParams('ping', [
+            'g' => $game->id,
+            'm' => 'Playing disc 2',
+            'x' => $gameHash->md5,
+        ]));
+
+        // Assert
+        $response
+            ->assertStatus(200)
+            ->assertExactJson(['Success' => true]);
+
+        $playerSession = PlayerSession::latest()->first();
+
+        $this->assertNotNull($playerSession);
+        $this->assertEquals($this->user->id, $playerSession->user_id);
+        $this->assertEquals($game->id, $playerSession->game_id);
+        $this->assertNull($playerSession->game_hash_id);
+        $this->assertEquals('Playing disc 2', $playerSession->rich_presence);
+
+        $this->assertEquals($game->id, $this->user->fresh()->LastGameID);
+        $this->assertEquals('Playing disc 2', $this->user->fresh()->RichPresenceMsg);
+    }
+}