Merge pull request #21588 from smoogipoo/beginplaying-score-token

Add score token to `BeginPlaySession()`

Author: bdach

osu.Game.Tests/Visual/Gameplay/TestSceneSpectator.cs

@@ -261,7 +261,7 @@ public void TestWatchingBeatmapThatDoesntExistLocally()
         [Test]
         public void TestFinalFramesPurgedBeforeEndingPlay()
         {
-            AddStep("begin playing", () => spectatorClient.BeginPlaying(TestGameplayState.Create(new OsuRuleset()), new Score()));
+            AddStep("begin playing", () => spectatorClient.BeginPlaying(0, TestGameplayState.Create(new OsuRuleset()), new Score()));
 
             AddStep("send frames and finish play", () =>
             {

osu.Game.Tests/Visual/Gameplay/TestSceneSpectatorPlayback.cs

@@ -147,7 +147,7 @@ public void SetUpSteps()
                     }
                 };
 
-                spectatorClient.BeginPlaying(TestGameplayState.Create(new OsuRuleset()), recordingScore);
+                spectatorClient.BeginPlaying(0, TestGameplayState.Create(new OsuRuleset()), recordingScore);
                 spectatorClient.OnNewFrames += onNewFrames;
             });
         }

osu.Game/Online/Spectator/ISpectatorServer.cs

@@ -15,8 +15,9 @@ public interface ISpectatorServer
         /// <summary>
         /// Signal the start of a new play session.
         /// </summary>
+        /// <param name="scoreToken">The score submission token.</param>
         /// <param name="state">The state of gameplay.</param>
-        Task BeginPlaySession(SpectatorState state);
+        Task BeginPlaySession(long? scoreToken, SpectatorState state);
 
         /// <summary>
         /// Send a bundle of frame data for the current play session.

osu.Game/Online/Spectator/OnlineSpectatorClient.cs

@@ -47,7 +47,7 @@ private void load(IAPIProvider api)
             }
         }
 
-        protected override async Task BeginPlayingInternal(SpectatorState state)
+        protected override async Task BeginPlayingInternal(long? scoreToken, SpectatorState state)
         {
             if (!IsConnected.Value)
                 return;
@@ -56,7 +56,7 @@ protected override async Task BeginPlayingInternal(SpectatorState state)
 
             try
             {
-                await connection.InvokeAsync(nameof(ISpectatorServer.BeginPlaySession), state);
+                await connection.InvokeAsync(nameof(ISpectatorServer.BeginPlaySession), scoreToken, state);
             }
             catch (Exception exception)
             {
@@ -65,7 +65,7 @@ protected override async Task BeginPlayingInternal(SpectatorState state)
                     Debug.Assert(connector != null);
 
                     await connector.Reconnect();
-                    await BeginPlayingInternal(state);
+                    await BeginPlayingInternal(scoreToken, state);
                 }
 
                 // Exceptions can occur if, for instance, the locally played beatmap doesn't have a server-side counterpart.

osu.Game/Online/Spectator/SpectatorClient.cs

@@ -76,6 +76,7 @@ public abstract partial class SpectatorClient : Component, ISpectatorClient
 
         private IBeatmap? currentBeatmap;
         private Score? currentScore;
+        private long? currentScoreToken;
 
         private readonly Queue<FrameDataBundle> pendingFrameBundles = new Queue<FrameDataBundle>();
 
@@ -108,7 +109,7 @@ private void load()
                     // re-send state in case it wasn't received
                     if (IsPlaying)
                         // TODO: this is likely sent out of order after a reconnect scenario. needs further consideration.
-                        BeginPlayingInternal(currentState);
+                        BeginPlayingInternal(currentScoreToken, currentState);
                 }
                 else
                 {
@@ -159,7 +160,7 @@ Task ISpectatorClient.UserSentFrames(int userId, FrameDataBundle data)
             return Task.CompletedTask;
         }
 
-        public void BeginPlaying(GameplayState state, Score score)
+        public void BeginPlaying(long? scoreToken, GameplayState state, Score score)
         {
             // This schedule is only here to match the one below in `EndPlaying`.
             Schedule(() =>
@@ -178,8 +179,9 @@ public void BeginPlaying(GameplayState state, Score score)
 
                 currentBeatmap = state.Beatmap;
                 currentScore = score;
+                currentScoreToken = scoreToken;
 
-                BeginPlayingInternal(currentState);
+                BeginPlayingInternal(currentScoreToken, currentState);
             });
         }
 
@@ -264,7 +266,7 @@ public void StopWatchingUser(int userId)
             });
         }
 
-        protected abstract Task BeginPlayingInternal(SpectatorState state);
+        protected abstract Task BeginPlayingInternal(long? scoreToken, SpectatorState state);
 
         protected abstract Task SendFramesInternal(FrameDataBundle bundle);
 

osu.Game/Screens/Play/SubmittingPlayer.cs

@@ -148,7 +148,7 @@ protected override void StartGameplay()
                     realmBeatmap.LastPlayed = DateTimeOffset.Now;
             });
 
-            spectatorClient.BeginPlaying(GameplayState, Score);
+            spectatorClient.BeginPlaying(token, GameplayState, Score);
         }
 
         public override bool OnExiting(ScreenExitEvent e)

osu.Game/Tests/Visual/Spectator/TestSpectatorClient.cs

@@ -126,7 +126,7 @@ void flush()
             }
         }
 
-        protected override Task BeginPlayingInternal(SpectatorState state)
+        protected override Task BeginPlayingInternal(long? scoreToken, SpectatorState state)
         {
             // Track the local user's playing beatmap ID.
             Debug.Assert(state.BeatmapID != null);