[UE5.7] Exposed playerid (#728) (#729)

* Exposed playerid (#728)

(cherry picked from commit 6733632)

* Expose player id and improve signalling library

Add ability to access player id on the frontend and remove player id stripping from the signalling library. This change backports the 'Exposed playerid' feature.

---------

Co-authored-by: Luke Bermingham <1215582+lukehb@users.noreply.github.com>

Author: github-actions[bot]

.changeset/bright-shoes-repair.md

@@ -0,0 +1,11 @@
+---
+"@epicgames-ps/lib-pixelstreamingfrontend-ue5.7": minor
+"@epicgames-ps/lib-pixelstreamingsignalling-ue5.7": minor
+---
+
+Add: Ability to access player id on the frontend.
+QoL: Remove player id stripping from the signalling library.
+
+It is useful to be able to use the player id as a unique identifier that is common between UE side stats and frontend side stats; however, the player id is not actually exposed to TS/JS because the SS strips it out of signalling messages.
+
+This change is a backport of "Exposed playerid" (#728)

Frontend/library/src/WebRtcPlayer/WebRtcPlayerController.ts

@@ -109,6 +109,7 @@ export class WebRtcPlayerController {
     signallingUrlBuilder: () => string;
     autoJoinTimer: ReturnType<typeof setTimeout> = undefined;
     keepalive: KeepaliveMonitor;
+    playerId: string | null = null;
 
     /**
      *
@@ -1358,6 +1359,11 @@ export class WebRtcPlayerController {
     handleWebRtcAnswer(Answer: Messages.answer) {
         Logger.Info(`Got answer sdp ${Answer.sdp}`);
 
+        // Extract the player id if it is present
+        if (Answer.playerId) {
+            this.playerId = Answer.playerId;
+        }
+
         const sdpAnswer: RTCSessionDescriptionInit = {
             sdp: Answer.sdp,
             type: 'answer'
@@ -1374,6 +1380,11 @@ export class WebRtcPlayerController {
     handleWebRtcOffer(Offer: Messages.offer) {
         Logger.Info(`Got offer sdp ${Offer.sdp}`);
 
+        // Extract the player id if it is present
+        if (Offer.playerId) {
+            this.playerId = Offer.playerId;
+        }
+
         this.isUsingSFU = Offer.sfu ? Offer.sfu : false;
         this.isUsingSVC = Offer.scalabilityMode ? Offer.scalabilityMode != 'L1T1' : false;
         if (this.isUsingSFU || this.isUsingSVC) {

Signalling/src/StreamerConnection.ts

@@ -136,7 +136,6 @@ export class StreamerConnection extends EventEmitter implements IStreamer, LogUt
         } else {
             const player = this.server.playerRegistry.get(message.playerId);
             if (player) {
-                delete message.playerId;
                 LogUtils.logForward(this, player, message);
                 player.protocol.sendMessage(message);
             }