Repository navigation
lib-pixelstreamingsignalling-ue5.8-0.2.1
·
76 commits
to master
since this release
@epicgames-ps/lib-pixelstreamingsignalling-ue5.6
0.2.1
Patch Changes
- 9a43ab9: Leave the previous streamer when an SFU subscribes to another.
SFUConnection.subscribeoverwrotesubscribedStreamerwithout unsubscribing from the old streamer, so the old streamer kept forwarding to the SFU and kept the SFU's listeners. When that old streamer later disconnected, it detached the SFU from the streamer it was actually on and dropped the SFU's players.PlayerConnectionalready unsubscribes first; the SFU now does the same. - c37638b: Bound what the signalling server writes to its log. Every message a player sent was written to the log file whole, and the daily file had no size limit, so a client could make the log grow as fast as it could send. Log text and protocol messages longer than 16 KiB are now cut to that length, with their full length noted, and the log files are limited in size and number: by default 14 files of 100 MB, set with
logMaxSizeandlogMaxFilesinInitLogging, or--log_max_sizeand--log_max_filesin wilbur. Files are now kept by count rather than for 14 days. - e373094: Stop malformed messages from crashing the signalling server. A message whose JSON is
nullthrew from the protocol's message handler, and since that handler runs inside the websocket's message event, any client could take the process down with one frame. Such a message is now rejected and logged, like unparseable JSON. A streamer'sdisconnectPlayerwith a reason over 123 bytes, or one that is not a string, madewsthrow in the same way; the reason is now dropped and the player is still disconnected. A non-string endpoint id from a streamer was stored as its id and broke the next streamer registration; it is now treated as no id. - b52cb35: Limit websocket messages on the streamer, player and SFU ports to 1 MiB. ws accepts up to 100 MiB in one message by default, and signalling messages are a few kilobytes. A connection that sends more is closed with code 1009. Setting
maxPayloadinstreamerWsOptions,playerWsOptionsorsfuWsOptionsoverrides the limit for that port. - Updated dependencies [e373094]
- @epicgames-ps/lib-pixelstreamingcommon-ue5.8@0.1.1
0.2.0
Minor Changes
- c8cd21a: Allow TURN credentials to be issued per connection rather than shared by every session.
peerOptionsis static, so a credential written there is sent to every peer that ever connects and cannot be changed without a redeploy — the weakness noted in tip 3 of the security guidelines.IServerConfig.peerOptionsProvideris consulted once per connecting peer and returns the peer options for that peer, falling back topeerOptionsif it throws. On top of it the signalling server adds--turn_secret(or--turn_secret_file) and--turn_ttl, which give everyturn:/turns:entry a time limited username and credential in the form coturn'suse-auth-secretmode expects. Default behaviour is unchanged when no secret is supplied. SeeDocs/Security-Guidelines.md.
Patch Changes
- e9cd872: Stop an unsubscribed player from crashing the signalling server. When a player sends a message without being subscribed,
sendToStreamerforce-subscribes it to the first available streamer and then forwards throughthis.subscribedStreamer!.subscribe()can decline — most commonly becausemaxSubscribersis already reached — and reports that only by leavingsubscribedStreamerunset, so the non-null assertions throw a TypeError out of a websocket message handler and take the process down, disconnecting every other player. It now checks the subscription took, and disconnects just that player if it did not.
0.2.1
Patch Changes
- 812a419: - Addressing security issues raised by dependabot. (glob, js-yaml, playwright)
- Added lint npm script to the root project. Running
npm run lintwill now run linting over all packages.
- Added lint npm script to the root project. Running
- Updated dependencies [812a419]
- @epicgames-ps/lib-pixelstreamingcommon-ue5.7@0.1.4
0.2.0
Minor Changes
-
05bebea: 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)