@stream-io/video-client 0.0.46 → 0.0.48

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+### [0.0.48](https://github.com/GetStream/stream-video-js/compare/client0.0.47...client0.0.48) (2023-07-14)
+
+
+### Bug Fixes
+
+* force iceRestart offer, delay ICE restart ([#801](https://github.com/GetStream/stream-video-js/issues/801)) ([0da298f](https://github.com/GetStream/stream-video-js/commit/0da298faff30ddc42277444aad0d40a635fafb0b)), closes [#787](https://github.com/GetStream/stream-video-js/issues/787)
+
+### [0.0.47](https://github.com/GetStream/stream-video-js/compare/client0.0.46...client0.0.47) (2023-07-14)
+
+
+### Features
+
+* take the location-hint on SDK init ([#799](https://github.com/GetStream/stream-video-js/issues/799)) ([ee5b170](https://github.com/GetStream/stream-video-js/commit/ee5b170337278a7063a368790f46b270647abf71))
+
 ### [0.0.46](https://github.com/GetStream/stream-video-js/compare/client0.0.45...client0.0.46) (2023-07-14)
 
 

package/dist/index.browser.es.js

@@ -5665,7 +5665,7 @@ const logLevels = Object.freeze({
     warn: 3,
     error: 4,
 });
-let logger$2;
+let logger$3;
 let level = 'info';
 const logToConsole = (logLevel, message, ...args) => {
     let logMethod;
@@ -5689,7 +5689,7 @@ const logToConsole = (logLevel, message, ...args) => {
     logMethod(message, ...args);
 };
 const setLogger = (l, lvl) => {
-    logger$2 = l;
+    logger$3 = l;
     if (lvl) {
         setLogLevel(lvl);
     }
@@ -5698,7 +5698,7 @@ const setLogLevel = (l) => {
     level = l;
 };
 const getLogger = (withTags) => {
-    const loggerMethod = logger$2 || logToConsole;
+    const loggerMethod = logger$3 || logToConsole;
     const tags = (withTags || []).join(':');
     const result = (logLevel, message, ...args) => {
         if (logLevels[logLevel] >= logLevels[level]) {
@@ -6318,10 +6318,10 @@ class Publisher {
         /**
          * Restarts the ICE connection and renegotiates with the SFU.
          */
-        this.restartIce = () => {
+        this.restartIce = () => __awaiter(this, void 0, void 0, function* () {
             this.logger('debug', 'Restarting ICE connection');
-            this.pc.restartIce();
-        };
+            yield this.negotiate({ iceRestart: true });
+        });
         this.onNegotiationNeeded = () => __awaiter(this, void 0, void 0, function* () {
             yield this.negotiate();
         });
@@ -6463,10 +6463,27 @@ class Publisher {
         };
         this.onIceConnectionStateChange = () => {
             const state = this.pc.iceConnectionState;
-            this.logger('debug', `ICE Connection state changed`, state);
-            if (state === 'failed' || state === 'disconnected') {
-                this.logger('warn', `ICE Connection state changed to ${state}. Attempting to restart ICE`);
-                this.restartIce();
+            this.logger('debug', `ICE Connection state changed to`, state);
+            if (state === 'failed') {
+                this.logger('warn', `Attempting to restart ICE`);
+                this.restartIce().catch((e) => {
+                    this.logger('error', `ICE restart error`, e);
+                });
+            }
+            else if (state === 'disconnected') {
+                // when in `disconnected` state, the browser may recover automatically,
+                // hence, we delay the ICE restart
+                this.logger('warn', `Scheduling ICE restart in 5 seconds`);
+                setTimeout(() => {
+                    // check if the state is still `disconnected` or `failed`
+                    // as the connection may have recovered (or failed) in the meantime
+                    if (this.pc.iceConnectionState === 'disconnected' ||
+                        this.pc.iceConnectionState === 'failed') {
+                        this.restartIce().catch((e) => {
+                            this.logger('error', `ICE restart error`, e);
+                        });
+                    }
+                }, 5000);
             }
         };
         this.onIceGatheringStateChange = () => {
@@ -6491,7 +6508,7 @@ class Publisher {
     }
 }
 
-const logger$1 = getLogger(['Subscriber']);
+const logger$2 = getLogger(['Subscriber']);
 /**
  * A wrapper around the `RTCPeerConnection` that handles the incoming
  * media streams from the SFU.
@@ -6567,10 +6584,10 @@ class Subscriber {
             // that are migrating to the new subscriber.
             // Once all of them are available, we can close the previous subscriber.
             const handleTrackMigration = (e) => {
-                logger$1('debug', `[Migration]: Migrated track: ${e.track.id}, ${e.track.kind}`);
+                logger$2('debug', `[Migration]: Migrated track: ${e.track.id}, ${e.track.kind}`);
                 trackIdsToMigrate.delete(e.track.id);
                 if (trackIdsToMigrate.size === 0) {
-                    logger$1('debug', `[Migration]: Migration complete`);
+                    logger$2('debug', `[Migration]: Migration complete`);
                     pc.removeEventListener('track', handleTrackMigration);
                     cleanupMigration();
                 }
@@ -6598,7 +6615,7 @@ class Subscriber {
          * Restarts the ICE connection and renegotiates with the SFU.
          */
         this.restartIce = () => {
-            logger$1('debug', 'Restarting ICE connection');
+            logger$2('debug', 'Restarting ICE connection');
             this.pc.restartIce();
         };
         this.handleOnTrack = (e) => {
@@ -6606,19 +6623,19 @@ class Subscriber {
             // example: `e3f6aaf8-b03d-4911-be36-83f47d37a76a:TRACK_TYPE_VIDEO`
             const [trackId, trackType] = primaryStream.id.split(':');
             const participantToUpdate = this.state.participants.find((p) => p.trackLookupPrefix === trackId);
-            logger$1('debug', `[onTrack]: Got remote ${trackType} track for userId: ${participantToUpdate === null || participantToUpdate === void 0 ? void 0 : participantToUpdate.userId}`, e.track.id, e.track);
+            logger$2('debug', `[onTrack]: Got remote ${trackType} track for userId: ${participantToUpdate === null || participantToUpdate === void 0 ? void 0 : participantToUpdate.userId}`, e.track.id, e.track);
             if (!participantToUpdate) {
-                logger$1('error', `[onTrack]: Received track for unknown participant: ${trackId}`, e);
+                logger$2('error', `[onTrack]: Received track for unknown participant: ${trackId}`, e);
                 return;
             }
             e.track.addEventListener('mute', () => {
-                logger$1('info', `[onTrack]: Track muted: ${participantToUpdate.userId} ${trackType}:${trackId}`);
+                logger$2('info', `[onTrack]: Track muted: ${participantToUpdate.userId} ${trackType}:${trackId}`);
             });
             e.track.addEventListener('unmute', () => {
-                logger$1('info', `[onTrack]: Track unmuted: ${participantToUpdate.userId} ${trackType}:${trackId}`);
+                logger$2('info', `[onTrack]: Track unmuted: ${participantToUpdate.userId} ${trackType}:${trackId}`);
             });
             e.track.addEventListener('ended', () => {
-                logger$1('info', `[onTrack]: Track ended: ${participantToUpdate.userId} ${trackType}:${trackId}`);
+                logger$2('info', `[onTrack]: Track ended: ${participantToUpdate.userId} ${trackType}:${trackId}`);
             });
             const streamKindProp = {
                 TRACK_TYPE_AUDIO: 'audioStream',
@@ -6626,12 +6643,12 @@ class Subscriber {
                 TRACK_TYPE_SCREEN_SHARE: 'screenShareStream',
             }[trackType];
             if (!streamKindProp) {
-                logger$1('error', `Unknown track type: ${trackType}`);
+                logger$2('error', `Unknown track type: ${trackType}`);
                 return;
             }
             const previousStream = participantToUpdate[streamKindProp];
             if (previousStream) {
-                logger$1('info', `[onTrack]: Cleaning up previous remote ${e.track.kind} tracks for userId: ${participantToUpdate.userId}`);
+                logger$2('info', `[onTrack]: Cleaning up previous remote ${e.track.kind} tracks for userId: ${participantToUpdate.userId}`);
                 previousStream.getTracks().forEach((t) => {
                     t.stop();
                     previousStream.removeTrack(t);
@@ -6644,7 +6661,7 @@ class Subscriber {
         this.onIceCandidate = (e) => __awaiter(this, void 0, void 0, function* () {
             const { candidate } = e;
             if (!candidate) {
-                logger$1('debug', 'null ice candidate');
+                logger$2('debug', 'null ice candidate');
                 return;
             }
             yield this.sfuClient.iceTrickle({
@@ -6653,7 +6670,7 @@ class Subscriber {
             });
         });
         this.negotiate = (subscriberOffer) => __awaiter(this, void 0, void 0, function* () {
-            logger$1('info', `Received subscriberOffer`, subscriberOffer);
+            logger$2('info', `Received subscriberOffer`, subscriberOffer);
             yield this.pc.setRemoteDescription({
                 type: 'offer',
                 sdp: subscriberOffer.sdp,
@@ -6664,7 +6681,7 @@ class Subscriber {
                     yield this.pc.addIceCandidate(iceCandidate);
                 }
                 catch (e) {
-                    logger$1('error', `ICE candidate error`, [e, candidate]);
+                    logger$2('error', `ICE candidate error`, [e, candidate]);
                 }
             }));
             // apply ice candidates
@@ -6676,15 +6693,15 @@ class Subscriber {
             });
         });
         this.onIceConnectionStateChange = () => {
-            logger$1('info', `ICE connection state changed`, this.pc.iceConnectionState);
+            logger$2('info', `ICE connection state changed`, this.pc.iceConnectionState);
         };
         this.onIceGatheringStateChange = () => {
-            logger$1('info', `ICE gathering state changed`, this.pc.iceGatheringState);
+            logger$2('info', `ICE gathering state changed`, this.pc.iceGatheringState);
         };
         this.onIceCandidateError = (e) => {
             const errorMessage = e instanceof RTCPeerConnectionIceErrorEvent &&
                 `${e.errorCode}: ${e.errorText}`;
-            logger$1('error', `ICE Candidate error`, errorMessage);
+            logger$2('error', `ICE Candidate error`, errorMessage);
         };
         this.sfuClient = sfuClient;
         this.dispatcher = dispatcher;
@@ -8013,7 +8030,7 @@ const watchCallGrantsUpdated = (state) => {
     };
 };
 
-const logger = getLogger(['events']);
+const logger$1 = getLogger(['events']);
 /**
  * An event responder which handles the `changePublishQuality` event.
  */
@@ -8078,7 +8095,7 @@ const watchSfuErrorReports = (dispatcher) => {
         if (e.eventPayload.oneofKind !== 'error' || !e.eventPayload.error.error)
             return;
         const error = e.eventPayload.error.error;
-        logger('error', 'SFU reported error', {
+        logger$1('error', 'SFU reported error', {
             code: ErrorCode[error.code],
             message: error.message,
             shouldRetry: error.shouldRetry,
@@ -8525,7 +8542,7 @@ const join = (httpClient, type, id, data) => __awaiter(void 0, void 0, void 0, f
     };
 });
 const doJoin = (httpClient, type, id, data) => __awaiter(void 0, void 0, void 0, function* () {
-    const location = yield getLocationHint();
+    const location = yield httpClient.getLocationHint();
     const request = Object.assign(Object.assign({}, data), { location });
     // FIXME OL: remove this once cascading is enabled by default
     const cascadingModeParams = getCascadingModeParams();
@@ -8540,28 +8557,6 @@ const doJoin = (httpClient, type, id, data) => __awaiter(void 0, void 0, void 0,
     }
     return httpClient.post(`/call/${type}/${id}/join`, request);
 });
-const getLocationHint = () => __awaiter(void 0, void 0, void 0, function* () {
-    const hintURL = `https://hint.stream-io-video.com/`;
-    const abortController = new AbortController();
-    const timeoutId = setTimeout(() => abortController.abort(), 1000);
-    const logger = getLogger(['call']);
-    try {
-        const response = yield fetch(hintURL, {
-            method: 'HEAD',
-            signal: abortController.signal,
-        });
-        const awsPop = response.headers.get('x-amz-cf-pop') || 'ERR';
-        logger === null || logger === void 0 ? void 0 : logger('info', `Location header: ${awsPop}`);
-        return awsPop.substring(0, 3); // AMS1-P2 -> AMS
-    }
-    catch (e) {
-        logger === null || logger === void 0 ? void 0 : logger('error', `Failed to get location hint from ${hintURL}`, e);
-        return 'ERR';
-    }
-    finally {
-        clearTimeout(timeoutId);
-    }
-});
 const toRtcConfiguration = (config) => {
     if (!config || config.length === 0)
         return undefined;
@@ -11330,7 +11325,30 @@ class WSConnectionFallback {
     }
 }
 
-const version = '0.0.46';
+const version = '0.0.48';
+
+const logger = getLogger(['location']);
+const HINT_URL = `https://hint.stream-io-video.com/`;
+const getLocationHint = (hintUrl = HINT_URL, timeout = 1500) => __awaiter(void 0, void 0, void 0, function* () {
+    const abortController = new AbortController();
+    const timeoutId = setTimeout(() => abortController.abort(), timeout);
+    try {
+        const response = yield fetch(HINT_URL, {
+            method: 'HEAD',
+            signal: abortController.signal,
+        });
+        const awsPop = response.headers.get('x-amz-cf-pop') || 'ERR';
+        logger('debug', `Location header: ${awsPop}`);
+        return awsPop.substring(0, 3); // AMS1-P2 -> AMS
+    }
+    catch (e) {
+        logger('error', `Failed to get location hint from ${HINT_URL}`, e);
+        return 'ERR';
+    }
+    finally {
+        clearTimeout(timeoutId);
+    }
+});
 
 class StreamClient {
     /**
@@ -11360,6 +11378,14 @@ class StreamClient {
                 .replace('http', 'ws')
                 .replace(':3030', ':8800');
         };
+        this.getLocationHint = (hintUrl, timeout) => __awaiter(this, void 0, void 0, function* () {
+            const hint = yield this.locationHint;
+            if (!hint || hint === 'ERR') {
+                this.locationHint = getLocationHint(hintUrl !== null && hintUrl !== void 0 ? hintUrl : this.options.locationHintUrl, timeout !== null && timeout !== void 0 ? timeout : this.options.locationHintTimeout);
+                return this.locationHint;
+            }
+            return hint;
+        });
         this._getConnectionID = () => { var _a, _b; return ((_a = this.wsConnection) === null || _a === void 0 ? void 0 : _a.connectionID) || ((_b = this.wsFallback) === null || _b === void 0 ? void 0 : _b.connectionID); };
         this._hasConnectionID = () => Boolean(this._getConnectionID());
         /**
@@ -11880,6 +11906,9 @@ class StreamClient {
             };
         this.browser = inputOptions.browser || typeof window !== 'undefined';
         this.node = !this.browser;
+        if (this.browser) {
+            this.locationHint = getLocationHint(options === null || options === void 0 ? void 0 : options.locationHintUrl, options === null || options === void 0 ? void 0 : options.locationHintTimeout);
+        }
         this.options = Object.assign({ timeout: 5000, withCredentials: false, warmUp: false }, inputOptions);
         if (this.node && !this.options.httpsAgent) {
             this.options.httpsAgent = new https.Agent({