@3dsource/angular-unreal-module 0.0.143-dev.2 → 0.0.143-dev.8

package/js/region-ping-prefetch.js

@@ -0,0 +1 @@
+"use strict";(()=>{"use strict";const o="3dsource:region-ping",u="https://datacenter.3dsource.com/regions/";class a{constructor(e){this.max=Math.max(1,e),this.count=0,this.queue=[]}acquire(){return this.count<this.max?(this.count++,Promise.resolve()):new Promise(e=>this.queue.push(e))}release(){this.count--;const e=this.queue.shift();e&&(this.count++,e())}}class l{constructor(){const e=document.currentScript||(()=>{const n=document.getElementsByTagName("script");return n[n.length-1]})(),t=e&&e.dataset||{},r=window.REGION_PING_CONFIG||{};this.regionsPingUrl=r.regionsPingUrl||t.regionsUrl||u,this.config={accurate_samples:this.numberOr(r.accurateSamples,t.accurateSamples,3),ping_timeout:this.numberOr(r.pingTimeout,t.pingTimeout,2e3),warmup_deadline:this.numberOr(r.warmupDeadline,t.warmupDeadline,1500),max_parallel_requests:this.numberOr(r.maxParallel,t.maxParallel,10),bust_cache:this.boolOr(r.bustCache,t.bustCache,!0)}}run(){this.regionsPingUrl&&(this.readFreshCache()||this.prefetch().catch(()=>{}))}prefetch(){return fetch(this.regionsPingUrl,{credentials:"omit"}).then(e=>e.json()).then(e=>{const t=e&&e.regions||[],r=e&&e.timeout||this.config.ping_timeout;return this.warmUpAll(t,r).then(()=>this.measureAll(t,r))}).then(e=>{e&&this.writeCache(e.region_code,e.result)})}warmUpAll(e,t){const r=new a(this.config.max_parallel_requests),n=e.map(s=>r.acquire().then(()=>this.singlePing(s.url,s.timeout||t).catch(()=>{}).finally(()=>r.release())));return Promise.race([Promise.all(n),this.delay(this.config.warmup_deadline)])}measureAll(e,t){const r=new a(this.config.max_parallel_requests),n=e.map(s=>r.acquire().then(()=>this.checkLatency(s.url,s.timeout||t)).then(i=>(r.release(),i.length>=2?{region_code:s.region_code,result:i}:null)).catch(()=>(r.release(),null)));return Promise.all(n).then(s=>this.pickByMedian(s.filter(Boolean)))}checkLatency(e,t){const r=[];let n=0;const s=()=>{if(n>=this.config.accurate_samples)return Promise.resolve(r);n++;const i=performance.now();return this.singlePing(e,t).catch(()=>{}).then(()=>(r.push(Math.round(performance.now()-i)),s()))};return s()}singlePing(e,t){const r=e.indexOf("?")!==-1?"&":"?",n=this.config.bust_cache?`${e}${r}cache_buster=${performance.now()}`:e;return this.fetchWithTimeout(n,{method:"GET",mode:"no-cors",headers:{"Cache-Control":"no-cache, no-store, must-revalidate",Pragma:"no-cache",Expires:"0"},credentials:"omit"},t)}fetchWithTimeout(e,t,r){const n=new AbortController;t.signal=n.signal;const s=setTimeout(()=>n.abort(),r);return fetch(e,t).finally(()=>clearTimeout(s))}pickByMedian(e){let t=null,r=1/0,n=1/0;for(const s of e){const i=this.median(s.result),c=Math.min(...s.result);(i<r||i===r&&c<n)&&(r=i,n=c,t=s)}return t}median(e){const t=e.slice().sort((n,s)=>n-s),r=Math.floor(t.length/2);return t.length%2?t[r]:(t[r-1]+t[r])/2}delay(e){return new Promise(t=>setTimeout(t,e))}readFreshCache(){try{const e=localStorage.getItem(o);if(!e)return null;const t=JSON.parse(e);return!t||typeof t.region_code!="string"||typeof t.ts!="number"||Date.now()-t.ts>=2592e6?null:t}catch{return null}}writeCache(e,t){try{localStorage.setItem(o,JSON.stringify({region_code:e,result:t,ts:Date.now()}))}catch{}}numberOr(e,t,r){for(const n of[e,t]){const s=Number(n);if(n!=null&&n!==""&&!Number.isNaN(s))return s}return r}boolOr(e,t,r){for(const n of[e,t]){if(typeof n=="boolean")return n;if(n==="true")return!0;if(n==="false")return!1}return r}}new l().run()})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3dsource/angular-unreal-module",
-  "version": "0.0.143-dev.2",
+  "version": "0.0.143-dev.8",
   "description": "Unreal module for connect with unreal engine stream",
   "keywords": [
     "3dsource",

package/types/3dsource-angular-unreal-module.d.ts

@@ -245,14 +245,13 @@ interface ReconnectConfig {
     onDataChannelClose?: boolean;
 }
 interface UnrealInitialConfig {
+    playwright?: boolean;
     customErrorsEndpoint?: string;
     commandTelemetryReceiver?: string;
     regionsPingUrl?: string;
     screenLockerContainerId?: string;
     dataChannelConnectionTimeout?: number;
     fpsMonitor?: boolean;
-    playwright?: boolean;
-    streamTelemetryV2?: boolean;
     streamTelemetryV2Url?: string;
     autoHighResolution?: boolean;
     /** Configuration for auto-reconnection behavior */
@@ -364,6 +363,11 @@ declare const DEFAULT_AFK_TIMEOUT = 300;
 declare const DATA_CHANNEL_CONNECTION_TIMEOUT = 8000;
 declare const SIGNALLING_PERCENT_VALUE = 56;
 declare const SCREEN_LOCKER_CONTAINER_ID = "3dsource_start_screen";
+declare const REGION_PING_CACHE_KEY = "3dsource:region-ping";
+declare const REGION_PING_CACHE_TTL_MS: number;
+declare const REGION_PING_ACCURATE_SAMPLES = 3;
+declare const REGION_PING_WARMUP_DEADLINE_MS = 1500;
+declare const REGION_PING_BACKGROUND_REFRESH_DELAY_MS = 5000;
 declare const DEFAULT_RECONNECT_ENABLED = true;
 declare const DEFAULT_RECONNECT_MAX_ATTEMPTS = 3;
 declare const DEFAULT_RECONNECT_DELAY_MS = 1000;
@@ -894,6 +898,40 @@ declare class RegionsPingService {
     };
     constructor();
     getFastest(regionListUrl?: string): node_modules_rxjs_dist_types.Observable<string | undefined>;
+    /**
+     * Read the prefetched winner from `localStorage`, returning it only if the
+     * entry is well-formed and still within {@link REGION_PING_CACHE_TTL_MS}.
+     * All access is guarded — `localStorage` can throw (private mode, disabled
+     * storage) or be absent (non-browser).
+     */
+    private readCachedWinner;
+    private writeCachedWinner;
+    /**
+     * Accurate, OFF-critical-path refresh of the region cache. Mirrors the
+     * prefetch script: warm up every region in parallel (barrier), then measure
+     * {@link REGION_PING_ACCURATE_SAMPLES} probes each and pick the lowest
+     * MEDIAN RTT (tie-break: min). Writes the winner to `localStorage` ONLY — it
+     * does NOT dispatch `regionResolved` or touch current-session state, since
+     * the connection is already established on a region; this just improves the
+     * pick for the NEXT connection.
+     *
+     * Invoked from an effect a few seconds after the data channel is ready (see
+     * `REGION_PING_BACKGROUND_REFRESH_DELAY_MS`), so it never competes with the
+     * connection handshake. Aborts with the injector via `destroyController`.
+     */
+    refreshCacheInBackground(regionListUrl?: string): node_modules_rxjs_dist_types.Observable<{
+        region_code: string;
+        result: number[];
+    } | null>;
+    private measureAccurate;
+    /**
+     * Phase 1 of the accurate measure: one throwaway probe to every region in
+     * parallel to pay the DNS/TCP/TLS cold-start. Resolves once all settle OR
+     * the warm-up deadline elapses, whichever is first.
+     */
+    private warmUpAll;
+    private pickByMedian;
+    private median;
     getPingResult(providers: ProvidersData): node_modules_rxjs_dist_types.Observable<{
         region_code: string;
         result: number[];
@@ -2528,6 +2566,7 @@ declare class UnrealEffects {
     private readonly webRtcPlayerService;
     private readonly commandsSender;
     private readonly commandTelemetryService;
+    private readonly regionsPingService;
     private readonly signallingService;
     private readonly videoService;
     private readonly unrealCallbackService;
@@ -2537,6 +2576,10 @@ declare class UnrealEffects {
     destroyConnections$: node_modules_rxjs_dist_types.Observable<{
         reason: _3dsource_angular_unreal_module.DisconnectReasonType;
     } & node_modules__ngrx_store_types_ngrx_store.Action<string>> & node_modules__ngrx_effects_types_ngrx_effects.CreateEffectMetadata;
+    refreshRegionCache$: node_modules_rxjs_dist_types.Observable<{
+        region_code: string;
+        result: number[];
+    } | null> & node_modules__ngrx_effects_types_ngrx_effects.CreateEffectMetadata;
     abortEstablishingConnection$: node_modules_rxjs_dist_types.Observable<node_modules__ngrx_store_types_ngrx_store.Action<string>> & node_modules__ngrx_effects_types_ngrx_effects.CreateEffectMetadata;
     resetAfk$: node_modules_rxjs_dist_types.Observable<node_modules__ngrx_store_types_ngrx_store.Action<string>> & node_modules__ngrx_effects_types_ngrx_effects.CreateEffectMetadata;
     iframeMessaging$: node_modules_rxjs_dist_types.Observable<string | null> & node_modules__ngrx_effects_types_ngrx_effects.CreateEffectMetadata;
@@ -2801,5 +2844,5 @@ declare const selectUserInactivityDetected: node_modules__ngrx_store_types_ngrx_
 /** Used by external consumers (e.g., metabox). Do not remove. */
 declare const selectIsVideoPlayingAndDataChannelConnected: node_modules__ngrx_store_types_ngrx_store.MemoizedSelector<Record<string, any>, boolean, (s1: boolean, s2: boolean) => boolean>;
 
-export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CONSOLE_COMMAND_DISABLE_MESSAGES, CONSOLE_COMMAND_ENABLE_MESSAGES, CONSOLE_COMMAND_PIXEL_QUALITY, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DEFAULT_RECONNECT_DELAY_MS, DEFAULT_RECONNECT_ENABLED, DEFAULT_RECONNECT_MAX_ATTEMPTS, DEFAULT_RECONNECT_ON_DATACHANNEL_CLOSE, DEFAULT_RECONNECT_ON_ICE_FAILURE, DESTROY_DISCONNECT_REASONS, DataFlowMonitor, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FilterSettingsComponent, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, INNER_RETRY_LIMIT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, KalmanFilter1D, LatencyTimings, LoadingProgressService, LowBandwidthDetectorComponent, LowBandwidthModalComponent, MINIMAL_FPS, MIN_CONTAINER_SIZE, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PingHandler, PlayerCountHandler, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UNREAL_CONFIG, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealSceneComponent, UnrealStatusMessage, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, smoothTransition, startStream, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
+export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CONSOLE_COMMAND_DISABLE_MESSAGES, CONSOLE_COMMAND_ENABLE_MESSAGES, CONSOLE_COMMAND_PIXEL_QUALITY, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DEFAULT_RECONNECT_DELAY_MS, DEFAULT_RECONNECT_ENABLED, DEFAULT_RECONNECT_MAX_ATTEMPTS, DEFAULT_RECONNECT_ON_DATACHANNEL_CLOSE, DEFAULT_RECONNECT_ON_ICE_FAILURE, DESTROY_DISCONNECT_REASONS, DataFlowMonitor, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FilterSettingsComponent, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, INNER_RETRY_LIMIT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, KalmanFilter1D, LatencyTimings, LoadingProgressService, LowBandwidthDetectorComponent, LowBandwidthModalComponent, MINIMAL_FPS, MIN_CONTAINER_SIZE, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PingHandler, PlayerCountHandler, REGION_PING_ACCURATE_SAMPLES, REGION_PING_BACKGROUND_REFRESH_DELAY_MS, REGION_PING_CACHE_KEY, REGION_PING_CACHE_TTL_MS, REGION_PING_WARMUP_DEADLINE_MS, RegionsPingService, SAME_SIZE_THRESHOLD, SCREEN_LOCKER_CONTAINER_ID, SIGNALLING_PERCENT_VALUE, SSInfoHandler, STREAMING_AUDIO_ID, STREAMING_VIDEO_ID, SafePipe, SignallingService, SpecialKeyCodes, StatGraphComponent, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UNREAL_CONFIG, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealSceneComponent, UnrealStatusMessage, VideoService, VideoStatsComponent, WSCloseCode_CIRRUS_ABNORMAL_CLOSURE, WSCloseCode_CIRRUS_MAX_PLAYERS_ERROR, WSCloseCode_CIRRUS_PLAYER_DISCONNECTED, WSCloseCode_CIRRUS_STREAMER_KIKED_PLAYER, WSCloseCode_FORCE_CIRRUS_CLOSE, WSCloseCode_NORMAL_AFK_TIMEOUT, WSCloseCode_NORMAL_CLOSURE, WSCloseCode_NORMAL_MANUAL_DISCONNECT, WSCloseCode_UNKNOWN, WSCloseCodes, WS_OPEN_STATE, WS_RETRY_PER_INSTANCE, WS_TIMEOUT, WebRtcPlayerService, WebrtcErrorModalComponent, abortEstablishingConnection, answerSent, changeStatusMainVideoOnScene, changeStreamResolutionAction, commandCompleted, commandStarted, dataChannelConnected, dataChannelReady, decodeData, destroyRemoteConnections, destroyUnrealScene, disconnectStream, dispatchResize, dropConnection, dropDC, dropPC, floatToPercents, floatToSmoothPercents, forceResizeViewport, fromResizeObserver, getActiveUrl, getImageFromVideoStream, getResizeStudioValues, getResizeValuesUniversal, getRtcErrorMessage, iceConnectionFailed, initSignalling, instanceReady, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, saveAnalyticsEvent, selectCirrusConnectionId, selectClientAndViewIds, selectCommandProgress, selectFreezeFrameCombinedDataUrl, selectFreezeFrameDataUrl, selectFreezeFrameDataUrlFromVideo, selectFreezeFrameProgressMessageFromVideo, selectIsAutostart, selectIsExistMatchUrls, selectIsFreezeFrameLoading, selectIsFullyConnected, selectIsLoaderScreenVisible, selectIsVideoPlayingAndDataChannelConnected, selectShowLoader, selectShowReconnectPopup, selectSignalingParameters, selectStreamConfig, selectTotalProgress, selectUserInactivityDetected, selectWarnTimeout, setAfkTimerCountdown, setAfkTimerHide, setAfkTimerVisible, setAwsInstance, setCirrusConnected, setCirrusDisconnected, setConfig, setEstablishingConnection, setFreezeFrame, setFreezeFrameFromVideo, setIntroImageSrc, setIntroVideoSrc, setLoadingImageSrc, setLoopBackCommandIsCompleted, setMaxFps, setOrchestrationContext, setOrchestrationMessage, setOrchestrationParameters, setOrchestrationProgress, setSignalingName, setStatusMessage, setStatusPercentSignallingServer, setStreamClientCompanyId, setStreamViewId, setUnrealPlaywrightConfig, setUserInactivityTimeout, setViewportNotReady, setViewportReady, showLoadingProgress, showResumeStreamPopup, showUnrealErrorMessage, showUserInactivityTimeoutPopup, signalingRetryAttempted, smoothTransition, startStream, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
 export type { AggregatedStat, AnySignalingMessage, AwsInstance, CandidateMessage, CloseReason, CommandInProgress, ConfigMessage, ConnectionError, ControlSchemeValues, DataFlowCheckResult, DisconnectReasonType, EmittedMilestone, EventId, ForceClientDisconnect, FreezeFrameMessage, InboundVideoStats, InputProps, InstanceReady, InstanceReserved, InterruptClientStream, ListStreamersMessage, MessageBase, MessageTypeValues, NormalizeAndQuantizeSignedValue, NormalizeAndQuantizeUnsignedValue, OrchestrationErrorMessage, OrchestrationMessageType, P2PEstablishedMessage, PhaseOverlay, PhaseParam, PingMessage, PlayerCountMessage, PollingOrchestrationMessage, Quality, ReceivedFile, ReconnectConfig, RequestStream, SSInfo, SelectedIceCandidatePair, SignalingData, SignalingMessageHandler, SignalingMessageMap, StreamConfig, StreamRequestContext, StreamResolutionProps, StreamerListMessage, TelemetryType, UnknownFields, UnquantizeAndDenormalizeUnsignedValue, UnrealCallbackDescriptor, UnrealCallbackEventMap, UnrealCallbackJson, UnrealCallbackJsonWrapped, UnrealInitialConfig, UnrealState, WSCloseCodesValues, streamPreparedForUserInteractionMessage };