Merge pull request #28892 from bdach/better-client-identifier

Send client-generated session GUID for identification purposes
ppy · Jul 17, 2024 · 99c5025 · 99c5025
2 parents d32fef8 + 2a601ce
commit 99c5025
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/osu.Game/Online/API/APIAccess.cs b/osu.Game/Online/API/APIAccess.cs
@@ -164,6 +164,8 @@ private WebSocketNotificationsClientConnector setUpNotificationsClient()
 
  public string AccessToken => authentication.RequestAccessToken();
 
+ public Guid SessionIdentifier { get; } = Guid.NewGuid();
+
  /// <summary>
  /// Number of consecutive requests which failed due to network issues.
  /// </summary>

diff --git a/osu.Game/Online/API/DummyAPIAccess.cs b/osu.Game/Online/API/DummyAPIAccess.cs
@@ -39,6 +39,8 @@ public partial class DummyAPIAccess : Component, IAPIProvider
 
  public string AccessToken => "token";
 
+ public Guid SessionIdentifier { get; } = Guid.NewGuid();
+
  /// <seealso cref="APIAccess.IsLoggedIn"/>
  public bool IsLoggedIn => State.Value > APIState.Offline;
 

diff --git a/osu.Game/Online/API/IAPIProvider.cs b/osu.Game/Online/API/IAPIProvider.cs
@@ -44,6 +44,12 @@ public interface IAPIProvider
  /// </summary>
  string AccessToken { get; }
 
+ /// <summary>
+ /// Used as an identifier of a single local lazer session.
+ /// Sent across the wire for the purposes of concurrency control to spectator server.
+ /// </summary>
+ Guid SessionIdentifier { get; }
+
  /// <summary>
  /// Returns whether the local user is logged in.
  /// </summary>

diff --git a/osu.Game/Online/HubClientConnector.cs b/osu.Game/Online/HubClientConnector.cs
@@ -19,6 +19,9 @@ public class HubClientConnector : PersistentEndpointClientConnector, IHubClientC
  {
  public const string SERVER_SHUTDOWN_MESSAGE = "Server is shutting down.";
 
+ public const string VERSION_HASH_HEADER = @"X-Osu-Version-Hash";
+ public const string CLIENT_SESSION_ID_HEADER = @"X-Client-Session-ID";
+
  /// <summary>
  /// Invoked whenever a new hub connection is built, to configure it before it's started.
  /// </summary>
@@ -68,8 +71,11 @@ protected override Task<PersistentEndpointClient> BuildConnectionAsync(Cancellat
  options.Proxy.Credentials = CredentialCache.DefaultCredentials;
  }
 
- options.Headers.Add("Authorization", $"Bearer {API.AccessToken}");
- options.Headers.Add("OsuVersionHash", versionHash);
+ options.Headers.Add(@"Authorization", @$"Bearer {API.AccessToken}");
+ // non-standard header name kept for backwards compatibility, can be removed after server side has migrated to `VERSION_HASH_HEADER`
+ options.Headers.Add(@"OsuVersionHash", versionHash);
+ options.Headers.Add(VERSION_HASH_HEADER, versionHash);
+ options.Headers.Add(CLIENT_SESSION_ID_HEADER, API.SessionIdentifier.ToString());
  });
 
  if (RuntimeFeature.IsDynamicCodeCompiled && preferMessagePack)