@stream-io/video-client 1.0.3 → 1.0.4

package/dist/src/stats/SfuStatsReporter.d.ts

@@ -6,14 +6,14 @@ export type SfuStatsReporterOptions = {
     options: StatsOptions;
     clientDetails: LocalClientDetailsType;
     subscriber: Subscriber;
-    publisher: Publisher;
+    publisher?: Publisher;
 };
 export declare class SfuStatsReporter {
     private readonly logger;
     readonly options: StatsOptions;
     private readonly sfuClient;
     private readonly subscriber;
-    private readonly publisher;
+    private readonly publisher?;
     private intervalId;
     private readonly sdkName;
     private readonly sdkVersion;

package/dist/src/stats/stateStoreStatsReporter.d.ts

@@ -3,8 +3,9 @@ import { CallState } from '../store';
 import { Publisher, Subscriber } from '../rtc';
 export type StatsReporterOpts = {
     subscriber: Subscriber;
-    publisher: Publisher;
+    publisher?: Publisher;
     state: CallState;
+    datacenter: string;
     pollingIntervalInMs?: number;
 };
 export type StatsReporter = {
@@ -43,7 +44,7 @@ export type StatsReporter = {
 /**
  * Creates a new StatsReporter instance that collects metrics about the ongoing call and reports them to the state store
  */
-export declare const createStatsReporter: ({ subscriber, publisher, state, pollingIntervalInMs, }: StatsReporterOpts) => StatsReporter;
+export declare const createStatsReporter: ({ subscriber, publisher, state, datacenter, pollingIntervalInMs, }: StatsReporterOpts) => StatsReporter;
 export type StatsTransformOpts = {
     /**
      * The kind of track we are transforming stats for.

package/dist/src/stats/utils.d.ts

@@ -1,4 +1,5 @@
 import { LocalClientDetailsType } from '../client-details';
+import { Sdk } from '../gen/video/sfu/models/models';
 /**
  * Flatten the stats report into an array of stats objects.
  *
@@ -15,3 +16,5 @@ export declare const getSdkSignature: (clientDetails: LocalClientDetailsType) =>
     sdkName: string;
     sdkVersion: string;
 };
+export declare const getSdkName: (sdk: Sdk | undefined) => "stream-react" | "stream-react-native" | "stream-js";
+export declare const getSdkVersion: (sdk: Sdk | undefined) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/Call.ts

@@ -1001,7 +1001,10 @@ export class Call {
       });
     }
 
-    if (!this.publisher) {
+    // anonymous users can't publish anything hence, there is no need
+    // to create Publisher Peer Connection for them
+    const isAnonymous = this.streamClient.user?.type === 'anonymous';
+    if (!this.publisher && !isAnonymous) {
       const audioSettings = this.state.settings?.audio;
       const isDtxEnabled = !!audioSettings?.opus_dtx_enabled;
       const isRedEnabled = !!audioSettings?.redundant_coding_enabled;
@@ -1020,6 +1023,7 @@ export class Call {
         subscriber: this.subscriber,
         publisher: this.publisher,
         state: this.state,
+        datacenter: this.sfuClient.edgeName,
       });
     }
 
@@ -1069,14 +1073,17 @@ export class Call {
       }
       if (isMigrating) {
         await this.subscriber.migrateTo(sfuClient, connectionConfig);
-        await this.publisher.migrateTo(sfuClient, connectionConfig);
+        await this.publisher?.migrateTo(sfuClient, connectionConfig);
       } else if (isReconnecting) {
         if (reconnected) {
           // update the SFU client instance on the subscriber and publisher
           this.subscriber.setSfuClient(sfuClient);
-          this.publisher.setSfuClient(sfuClient);
-          // and perform a full ICE restart on the publisher
-          await this.publisher.restartIce();
+          // publisher might not be there (anonymous users)
+          if (this.publisher) {
+            this.publisher.setSfuClient(sfuClient);
+            // and perform a full ICE restart on the publisher
+            await this.publisher.restartIce();
+          }
         } else if (previousSfuClient?.isFastReconnecting) {
           // reconnection wasn't possible, so we need to do a full rejoin
           return await reconnect('full', 're-attempting').catch((err) => {

package/src/stats/SfuStatsReporter.ts

@@ -2,15 +2,14 @@ import { StreamSfuClient } from '../StreamSfuClient';
 import { StatsOptions } from '../gen/coordinator';
 import { getLogger } from '../logger';
 import { Publisher, Subscriber } from '../rtc';
-import { SdkType } from '../gen/video/sfu/models/models';
-import { flatten } from './utils';
+import { flatten, getSdkName, getSdkVersion } from './utils';
 import { getWebRTCInfo, LocalClientDetailsType } from '../client-details';
 
 export type SfuStatsReporterOptions = {
   options: StatsOptions;
   clientDetails: LocalClientDetailsType;
   subscriber: Subscriber;
-  publisher: Publisher;
+  publisher?: Publisher;
 };
 
 export class SfuStatsReporter {
@@ -20,7 +19,7 @@ export class SfuStatsReporter {
 
   private readonly sfuClient: StreamSfuClient;
   private readonly subscriber: Subscriber;
-  private readonly publisher: Publisher;
+  private readonly publisher?: Publisher;
 
   private intervalId: NodeJS.Timeout | undefined;
   private readonly sdkName: string;
@@ -39,16 +38,8 @@ export class SfuStatsReporter {
 
     const { sdk, browser } = clientDetails;
 
-    this.sdkName =
-      sdk && sdk.type === SdkType.REACT
-        ? 'stream-react'
-        : sdk && sdk.type === SdkType.REACT_NATIVE
-        ? 'stream-react-native'
-        : 'stream-js';
-
-    this.sdkVersion = sdk
-      ? `${sdk.major}.${sdk.minor}.${sdk.patch}`
-      : '0.0.0-development';
+    this.sdkName = getSdkName(sdk);
+    this.sdkVersion = getSdkVersion(sdk);
 
     // The WebRTC version if passed from the SDK, it is taken else the browser info is sent.
     this.webRTCVersion =
@@ -60,7 +51,7 @@ export class SfuStatsReporter {
   private run = async () => {
     const [subscriberStats, publisherStats] = await Promise.all([
       this.subscriber.getStats().then(flatten).then(JSON.stringify),
-      this.publisher.getStats().then(flatten).then(JSON.stringify),
+      this.publisher?.getStats().then(flatten).then(JSON.stringify) ?? '[]',
     ]);
 
     await this.sfuClient.sendStats({

package/src/stats/stateStoreStatsReporter.ts

@@ -11,8 +11,9 @@ import { flatten } from './utils';
 
 export type StatsReporterOpts = {
   subscriber: Subscriber;
-  publisher: Publisher;
+  publisher?: Publisher;
   state: CallState;
+  datacenter: string;
   pollingIntervalInMs?: number;
 };
 
@@ -67,6 +68,7 @@ export const createStatsReporter = ({
   subscriber,
   publisher,
   state,
+  datacenter,
   pollingIntervalInMs = 2000,
 }: StatsReporterOpts): StatsReporter => {
   const logger = getLogger(['stats']);
@@ -79,7 +81,6 @@ export const createStatsReporter = ({
     } else if (kind === 'publisher' && publisher) {
       return publisher.getStats(selector);
     } else {
-      logger('warn', `Can't retrieve RTC stats for ${kind}`);
       return undefined;
     }
   };
@@ -89,6 +90,7 @@ export const createStatsReporter = ({
     mediaStream: MediaStream,
   ) => {
     const pc = kind === 'subscriber' ? subscriber : publisher;
+    if (!pc) return [];
     const statsForStream: StatsReport[] = [];
     for (let track of mediaStream.getTracks()) {
       const report = await pc.getStats(track);
@@ -141,7 +143,7 @@ export const createStatsReporter = ({
         } catch (e) {
           logger(
             'error',
-            `Failed to collect stats for ${kind} if ${participant.userId}`,
+            `Failed to collect stats for ${kind} of ${participant.userId}`,
             e,
           );
         }
@@ -159,23 +161,25 @@ export const createStatsReporter = ({
         )
         .then(aggregate),
       publisher
-        .getStats()
-        .then((report) =>
-          transform(report, {
-            kind: 'publisher',
-            trackKind: 'video',
-          }),
-        )
-        .then(aggregate),
+        ? publisher
+            .getStats()
+            .then((report) =>
+              transform(report, {
+                kind: 'publisher',
+                trackKind: 'video',
+              }),
+            )
+            .then(aggregate)
+        : getEmptyStats(),
     ]);
 
     const [subscriberRawStats, publisherRawStats] = await Promise.all([
       getRawStatsForTrack('subscriber'),
-      getRawStatsForTrack('publisher'),
+      publisher ? getRawStatsForTrack('publisher') : undefined,
     ]);
 
     state.setCallStatsReport({
-      datacenter: publisher.sfuClient.edgeName,
+      datacenter,
       publisherStats,
       subscriberStats,
       subscriberRawStats,
@@ -288,14 +292,9 @@ const transform = (
   };
 };
 
-/**
- * Aggregates generic stats.
- *
- * @param stats the stats to aggregate.
- */
-const aggregate = (stats: StatsReport): AggregatedStatsReport => {
-  const aggregatedStats: AggregatedStatsReport = {
-    rawReport: stats,
+const getEmptyStats = (stats?: StatsReport): AggregatedStatsReport => {
+  return {
+    rawReport: stats ?? { streams: [], timestamp: Date.now() },
     totalBytesSent: 0,
     totalBytesReceived: 0,
     averageJitterInMs: 0,
@@ -306,6 +305,15 @@ const aggregate = (stats: StatsReport): AggregatedStatsReport => {
     highestFramesPerSecond: 0,
     timestamp: Date.now(),
   };
+};
+
+/**
+ * Aggregates generic stats.
+ *
+ * @param stats the stats to aggregate.
+ */
+const aggregate = (stats: StatsReport): AggregatedStatsReport => {
+  const aggregatedStats = getEmptyStats(stats);
 
   let maxArea = -1;
   const area = (w: number, h: number) => w * h;

package/src/stats/utils.ts

@@ -1,5 +1,5 @@
 import { LocalClientDetailsType } from '../client-details';
-import { SdkType } from '../gen/video/sfu/models/models';
+import { Sdk, SdkType } from '../gen/video/sfu/models/models';
 
 /**
  * Flatten the stats report into an array of stats objects.
@@ -16,16 +16,8 @@ export const flatten = (report: RTCStatsReport) => {
 
 export const getSdkSignature = (clientDetails: LocalClientDetailsType) => {
   const { sdk, ...platform } = clientDetails;
-  const sdkName =
-    sdk && sdk.type === SdkType.REACT
-      ? 'stream-react'
-      : sdk && sdk.type === SdkType.REACT_NATIVE
-      ? 'stream-react-native'
-      : 'stream-js';
-
-  const sdkVersion = sdk
-    ? `${sdk.major}.${sdk.minor}.${sdk.patch}`
-    : '0.0.0-development';
+  const sdkName = getSdkName(sdk);
+  const sdkVersion = getSdkVersion(sdk);
 
   return {
     sdkName,
@@ -33,3 +25,15 @@ export const getSdkSignature = (clientDetails: LocalClientDetailsType) => {
     ...platform,
   };
 };
+
+export const getSdkName = (sdk: Sdk | undefined) => {
+  return sdk && sdk.type === SdkType.REACT
+    ? 'stream-react'
+    : sdk && sdk.type === SdkType.REACT_NATIVE
+    ? 'stream-react-native'
+    : 'stream-js';
+};
+
+export const getSdkVersion = (sdk: Sdk | undefined) => {
+  return sdk ? `${sdk.major}.${sdk.minor}.${sdk.patch}` : '0.0.0-development';
+};