Skip to content

Reinstate the ability to override the signalling server URL using the .env file for local testing #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
david-macpherson merged 3 commits into from
Jan 24, 2024
Merged

Reinstate the ability to override the signalling server URL using the .env file for local testing #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc1ce0b
re-instate the ability to override the signalling server URL using th…
dan-tw Jan 24, 2024
d33162a
remove space
dan-tw Jan 24, 2024
5e98cc7
Improve commenting
dan-tw Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions examples/typescript/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ import { Config, PixelStreaming, SPSApplication, TextParameters, PixelStreamingA
export const PixelStreamingApplicationStyles = new PixelStreamingApplicationStyle();
PixelStreamingApplicationStyles.applyStyleSheet();

// websocket url env
declare var WEBSOCKET_URL: string;

// Extend the MessageRecv to allow the engine version to exist as part of our config message from the signalling server
class MessageExtendedConfig extends MessageRecv {
peerConnectionOptions: RTCConfiguration;
Expand All @@ -28,12 +25,6 @@ document.body.onload = function () {
// Create a config object. We default to sending the WebRTC offer from the browser as true, TimeoutIfIdle to true, AutoConnect to false and MaxReconnectAttempts to 0
const config = new Config({ useUrlParams: true, initialSettings: { OfferToReceive: true, TimeoutIfIdle: true, AutoConnect: false, MaxReconnectAttempts: 0 } });

// make usage of WEBSOCKET_URL if it is not empty
let webSocketAddress = WEBSOCKET_URL;
if (webSocketAddress != "") {
config.setTextSetting(TextParameters.SignallingServerUrl, webSocketAddress);
}

// Create stream and spsApplication instances that implement the Epic Games Pixel Streaming Frontend PixelStreaming and Application types
const stream = new ScalablePixelStreaming(config);

Expand Down
15 changes: 12 additions & 3 deletions library/src/SPSApplication.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ import { LoadingOverlay } from './LoadingOverlay';
import { SPSSignalling } from './SignallingExtension';
import { MessageStats } from './Messages';

// For local testing. Declare a websocket URL that can be imported via a .env file that will override
// the signalling server URL builder.
declare var WEBSOCKET_URL: string;


export class SPSApplication extends Application {
private loadingOverlay: LoadingOverlay;
Expand Down Expand Up @@ -53,13 +57,18 @@ export class SPSApplication extends Application {
}

enforceSpecialSignallingServerUrl() {
// SPS needs a special /ws added to the signalling server url so K8s can distinguish it
// SPS needs to build a specific signalling server url based on the application name so K8s can distinguish it
this.stream.setSignallingUrlBuilder(() => {

// if we have overriden the signalling server URL with a .env file use it here
if (WEBSOCKET_URL) {
return WEBSOCKET_URL as string;
}

// get the current signalling url
let signallingUrl = this.stream.config.getTextSettingValue(TextParameters.SignallingServerUrl);

// add our 'ws' token to the end dependant on whether the URL ends with a '/' or not
// build the signalling URL based on the existing window location, the result should be 'domain.com/signalling/app-name'
signallingUrl = signallingUrl.endsWith("/") ? signallingUrl + "signalling" + window.location.pathname : signallingUrl + "/signalling" + window.location.pathname;

return signallingUrl
Expand All @@ -85,4 +94,4 @@ export class SPSApplication extends Application {
const data = new MessageStats(stats);
this.stream.webSocketController.webSocket.send(data.payload());
}
}
}