@3dsource/angular-unreal-module 0.0.174 → 0.0.175

package/README.md

@@ -377,12 +377,26 @@ The package publishes two dependency-free scripts for use in the document
 ></script>
 ```
 
-`stream-prefetch.js` runs by default only on
-`metabox-configurator/{modular|basic}/...` routes. It reads the same-origin
-`assets/config.json`; override that path with `data-config-url` when needed.
-It also forwards the orchestration-issued `streamRequestId` from the polling
-response to Cirrus on the WebSocket URL (the session `connectionId`) and parks it
-for the Angular side to adopt.
+`stream-prefetch.js` runs only on `metabox-configurator/modular/{configuratorId}`
+routes — the configurator id comes from the route and there is no attribute to
+supply one, so the script cannot be enabled for an arbitrary page.
+
+It reads the same-origin `assets/config.json` and `assets/features.json`, then
+the configurator's cached record from `{cdn}/cache/configurator/{id}.json` — the
+same document the host app reads — so it polls under the identity the app will
+use rather than inventing one. The `newOrchestration` feature flag picks the
+transport: `signalling` (HTTP polling) or `newSignalling` (control socket +
+`requestStream`). The orchestration-issued `streamRequestId` is forwarded to
+Cirrus on the WebSocket URL (the session `connectionId`) and parked for adoption.
+
+`window.__stream` is both the parked stream and the lock: whichever of the script
+and the Angular module writes it first owns the connection, so a page never
+builds two. Load the script and the package from the same version — an older
+script does not know about the lock.
+
+Optional `data-*`: `data-config-url`, `data-features-url`, `data-ws-timeout`,
+`data-poll-timeout`.
+
 Pin an exact package version in production when deterministic CDN assets are
 required.
 

package/fesm2022/3dsource-angular-unreal-module.mjs

@@ -252,6 +252,11 @@ const DisconnectReason = {
     AbortEstablishingConnection: 'AbortEstablishingConnection',
 };
 
+/** True when the slot is the app's own marker rather than a prefetched stream. */
+function isAppOwned(slot) {
+    return slot.owner === 'app';
+}
+
 /*
 export interface RequestReservation extends InstanceMessageBase {
   type: 'requestReservation';
@@ -701,7 +706,7 @@ const unrealReducer = createReducer(initialState, on(changeStatusMainVideoOnScen
     return { ...state, analyticsEvent: event };
 }), on(setCirrusConnected, (state) => {
     return { ...state, cirrusConnected: true };
-}), on(streamAdopted, (state, { machineId, pollingUrl, ssData, streamRequestId }) => {
+}), on(streamAdopted, (state, { machineId, pollingUrl, ssData, streamRequestId, kind, instanceName, eta, }) => {
     return {
         ...state,
         cirrusConnected: true,
@@ -714,7 +719,11 @@ const unrealReducer = createReducer(initialState, on(changeStatusMainVideoOnScen
             // adopted stream came from — `connectToSignaling` never ran, so no
             // `setAwsInstance` will fill this in later.
             pollingUrl: pollingUrl ?? state.awsInstance.pollingUrl,
-            instanceName: 'Adopted Connection',
+            // The machine's real id when the prefetch reported one; the
+            // placeholder only for scripts that predate the field.
+            instanceName: instanceName ?? 'Adopted Connection',
+            kind: kind ?? state.awsInstance.kind,
+            eta: eta ?? state.awsInstance.eta,
             streamRequestId: streamRequestId ?? state.awsInstance.streamRequestId,
             progressComplete: 0,
         },
@@ -2148,12 +2157,18 @@ class SignallingService extends SubService {
      * {@link OnOpenHandler} (which would re-`setCirrusConnected`). Reuses the
      * head-script's `correlationId` so correlated messages line up.
      */
-    adoptSocket(ws, correlationId) {
+    adoptSocket(ws, correlationId, controlWs) {
         this.correlationId = correlationId;
         ws.onmessage = OnMessageHandler.bind(this);
         ws.onclose = OnCloseHandler.bind(this);
         ws.onerror = OnErrorHandler.bind(this);
         this.ws = ws;
+        // On the new-orchestration flow the prefetch also holds the control socket,
+        // already handed over (open, handlers stripped). Take the reference so
+        // `teardownControlWs` can close it — nothing else on this side can reach it.
+        if (controlWs) {
+            this.handedOverControlWs = controlWs;
+        }
         Logger.log('WS ADOPTED (handshake already done, requestStream already sent)');
     }
     showStatusMessage(statusMessage) {
@@ -3446,54 +3461,44 @@ class StreamAdoptionService {
         this.webRtc = inject(WebRtcPlayerService);
     }
     /**
-     * Decide adoption, WAITING for an in-flight prefetch instead of racing it.
-     *
-     * - nothing parked → emit `false` at once (caller connects normally).
-     * - already settled (`ready`/`failed`/`adopted`) → adopt-if-ready at once.
-     * - still `connecting` → wait for the script's `onSettled` callback and
-     *   adopt-if-ready the instant it fires (event-driven, zero polling latency).
+     * Decide adoption, WAITING for an in-flight prefetch instead of racing it:
+     * nothing parked → `false`; settled → adopt-if-ready; still `connecting` →
+     * wait for `onSettled`. Emits exactly once.
      *
-     * Deliberately NO time budget: for DIRECT orchestration the prefetch holds
-     * the socket open while the orchestrator provisions a machine, which can take
-     * minutes (150–200s+). A fixed deadline would make Angular give up and open a
-     * second connection mid-provisioning — exactly the race/orphan this avoids.
-     * The wait is bounded by liveness instead: the script flips the parked state
-     * to `failed` on a dead socket (`ws.onclose`/`onerror`), and the caller wraps
-     * this in `takeUntil(abortEstablishingConnection)`, so a route change / teardown
-     * cancels it. Emits exactly once. Cancelling runs no adoption — which is what
-     * stops a fast route-switch from starting overlapping connections.
+     * NO time budget: provisioning can take minutes, and a deadline would open a
+     * second connection mid-flight. Bounded by liveness instead — the script
+     * flips to `failed` on a dead socket — and by the caller's
+     * `takeUntil(abortEstablishingConnection)`.
      *
-     * Wrapped in `defer` so the `tryAdopt()` side effect (which dispatches
-     * `streamAdopted`) runs at SUBSCRIPTION time, not when the observable is
-     * built. The effect prepends `startWith(setEstablishingConnection(true))` —
-     * the single dispatch site for that boundary — which starts the telemetry
-     * session and subscribes its phase catalog; that must happen BEFORE
-     * `streamAdopted`, or `emitAdoptedConnection` fires into a session that does
-     * not exist yet and the whole connection waterfall is lost. `defer`
-     * guarantees that ordering.
+     * `defer` so the `streamAdopted` dispatch happens at SUBSCRIPTION time: the
+     * effect's `startWith(setEstablishingConnection(true))` must land first, or
+     * the telemetry session does not exist yet and the waterfall is lost.
      */
     awaitAndAdopt$() {
         return defer(() => {
-            const parked = window.__stream;
-            if (!parked) {
+            const slot = window.__stream;
+            if (!slot) {
+                // The slot is free, so we connect — and take it in the same synchronous
+                // breath, before any `await`. A head-script that evaluates later finds it
+                // occupied and stands down instead of building a second connection.
+                this.takeSlot();
                 return of(false);
             }
-            if (parked.state !== 'connecting') {
-                return of(this.tryAdopt());
+            if (isAppOwned(slot)) {
+                // Our own marker from an earlier pass — nothing to adopt.
+                return of(false);
+            }
+            if (slot.state !== 'connecting') {
+                return of(this.tryAdoptOrTakeSlot());
             }
             Logger.info('[Adoption] Prefetch in progress — waiting before connecting');
-            return this.awaitSettled$(parked);
+            return this.awaitSettled$(slot);
         });
     }
     /**
-     * Event-driven wait: the script fires `onSettled` the instant it parks
-     * `ready`/`failed`, so we adopt with zero polling lag. Emits exactly once.
-     *
-     * No timer/budget by design: an indefinitely `connecting` stream is valid
-     * (DIRECT orchestration holds the socket open for minutes while it
-     * provisions), and every terminal state — including a dead socket — flips to
-     * `ready`/`failed` and fires the hook. Teardown (route change → unsubscribe)
-     * sets `done`, so a late callback after cancel can't trigger a stray adoption.
+     * Event-driven wait on the script's `onSettled`; emits exactly once. No timer
+     * — see `awaitAndAdopt$`. Teardown sets `done`, so a late callback after
+     * cancel can't trigger a stray adoption.
      */
     awaitSettled$(parked) {
         return new Observable((subscriber) => {
@@ -3502,7 +3507,18 @@ class StreamAdoptionService {
                 if (done)
                     return;
                 done = true;
-                subscriber.next(this.tryAdopt());
+                let adopted = false;
+                try {
+                    adopted = this.tryAdoptOrTakeSlot();
+                }
+                catch (e) {
+                    // The script swallows a throwing callback, so an error escaping here
+                    // would emit nothing at all — leaving `exhaustMap` stuck forever with
+                    // `streamAdopted` already dispatched. Fall back to connecting.
+                    Logger.error('[Adoption] Adoption threw — falling back', e);
+                    this.takeSlot();
+                }
+                subscriber.next(adopted);
                 subscriber.complete();
             });
             return () => {
@@ -3510,13 +3526,57 @@ class StreamAdoptionService {
             };
         });
     }
+    /** Every `false` here means we are about to connect ourselves — take the slot. */
+    tryAdoptOrTakeSlot() {
+        const adopted = this.tryAdopt();
+        if (!adopted) {
+            this.takeSlot();
+        }
+        return adopted;
+    }
+    /** Mark the slot as the app's, replacing a spent prefetch object. */
+    takeSlot() {
+        // A `ready` stream whose socket died is never torn down by the script
+        // (`onclose` skips `fail` once ready), so dropping the reference here would
+        // orphan a live PeerConnection — a second connection for one page.
+        const evicted = window.__stream;
+        window.__stream = { owner: 'app' };
+        if (evicted && !isAppOwned(evicted)) {
+            this.closeParked(evicted);
+        }
+    }
+    /** Best-effort teardown of a parked stream we are about to abandon. */
+    closeParked(parked) {
+        if (parked.state === 'adopted') {
+            // Already handed to the module — that connection is live and its teardown
+            // belongs to the session, not to whoever is taking the slot.
+            return;
+        }
+        for (const closeable of [
+            parked.dc,
+            parked.pc,
+            parked.ws,
+            parked.controlWs,
+        ]) {
+            try {
+                closeable?.close();
+            }
+            catch {
+                /* already closed / not closeable — nothing to salvage */
+            }
+        }
+    }
     /**
      * @returns `true` if a ready parked stream was adopted (caller must NOT
      *          start a fresh connection), `false` otherwise.
      */
     tryAdopt() {
-        const parked = window.__stream;
-        if (!parked || parked.state !== 'ready') {
+        const slot = window.__stream;
+        if (!slot || isAppOwned(slot)) {
+            return false;
+        }
+        const parked = slot;
+        if (parked.state !== 'ready') {
             return false;
         }
         // A ready stream whose transport died before adoption is useless — fall back.
@@ -3531,22 +3591,21 @@ class StreamAdoptionService {
         Logger.info('[Adoption] Adopting prefetched stream', parked.timings);
         // Clear the script's timers and mark the handoff complete.
         parked.adopt();
-        // Flag cirrus connected (so a later `initSignalling` won't open a 2nd
-        // connection), record the adopted machine, and hydrate the streamer info
-        // (`ssData`) the prefetch captured from the `ssInfo` message. NOTE:
-        // clientId/viewId are left untouched — the host app (metabox) already set
-        // them authoritatively from its own data before `initSignalling`; the
-        // script's ids are only used internally to establish the connection.
+        // Flags cirrus connected, records the machine and hydrates `ssData`.
+        // clientId/viewId are left alone — the host app already set them.
         this.store.dispatch(streamAdopted({
             machineId: parked.machineId ?? null,
             pollingUrl: parked.pollingUrl ?? null,
             ssData: parked.ssData ?? null,
             streamRequestId: parked.ids?.streamRequestId || null,
+            kind: parked.kind ?? null,
+            instanceName: parked.instanceName ?? null,
+            eta: parked.eta ?? null,
             timings: parked.timings ?? null,
         }));
         // Hand the live socket over without re-sending `requestStream`, reusing the
         // script's correlationId (the one `requestStream` was already sent with).
-        this.signalling.adoptSocket(parked.ws, parked.ids.correlationId);
+        this.signalling.adoptSocket(parked.ws, parked.ids.correlationId, parked.controlWs);
         // Take ownership of pc/dc/media + replay buffered DC traffic. This drives
         // `dataChannelConnected`, which the `unrealReceiverReady$` effect turns into
         // `dataChannelReady` → app init (console commands, loopback, viewport).
@@ -8427,5 +8486,5 @@ function provideUnrealModule() {
  * Generated bundle index. Do not edit.
  */
 
-export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, 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, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UNREAL_CONFIG, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, 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, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, 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, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
+export { AFKService, AUTO_HIGH_RESOLUTION_IDLE_MS, AfkTimeoutModalComponent, AggregatorService, AnalyticsService, AnswerHandler, CommandTelemetryService, ConfigHandler, ConsoleExtensionsService, ControlScheme, DATA_CHANNEL_CONNECTION_TIMEOUT, DEBOUNCE_TO_MANY_RESIZE_CALLS, DEFAULT_AFK_TIMEOUT, DEFAULT_AFK_TIMEOUT_PERIOD, DESTROY_DISCONNECT_REASONS, DevModeService, DisconnectReason, FULL_HD_HEIGHT, FULL_HD_WIDTH, FileHandlerService, FileReceiverService, FpsMonitorService, FreezeFrameComponent, FreezeFrameService, INNER_RETRY_LIMIT, INSTANCE_READY_TIMEOUT, IceCandidateHandler, ImageLoadingSrcComponent, InputOptions, InputService, InstanceReadyHandler, InstanceReservedHandler, IntroSrcComponent, LatencyTimings, LoadingProgressService, MINIMAL_FPS, MIN_CONTAINER_SIZE, MessageType, MouseButton, MouseButtonsMask, OUTER_RETRY_DELAY, OnCloseHandler, OnErrorHandler, OnMessageHandler, OnOpenHandler, OrchestrationMessageTypes, POLLING_TIME, PlayerCountHandler, RECONNECT_CONFIG, 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, StreamAdoptionService, StreamStatusTelemetryService, StreamStatusTelemetryService2, SubService, ToClientMessage, UNREAL_CONFIG, UnrealAfkSlotDirective, UnrealCallbackService, UnrealCommunicatorService, UnrealEffects, UnrealResumeSlotDirective, UnrealSceneComponent, UnrealStatusMessage, UnrealStatusSlotDirective, 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, isAppOwned, isMetaboxMode, keepMaxUntilReset, makeEven, pollingEnded, pollingStarted, provideUnrealModule, provideUnrealState, qpToQuality, reconnectPeer, reconnectPeerFailed, reconnectPeerSuccess, regionPingFetchEnd, regionPingFetchStart, regionResolved, resetAfk, resetConfig, resetDataChannelForReconnect, resetIntroSrc, resetUserInactivityTimeout, resetWarnTimeout, resolveSkin, 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, startStream, streamAdopted, trackMixpanelEvent, trackTelemetryData, uint8ToBase64, unrealCommandCallback, unrealFeature, unrealReducer, updateCirrusInfo, videoAdaptedToContainer, videoStreamInitialized };
 //# sourceMappingURL=3dsource-angular-unreal-module.mjs.map