hide behind feature toggle

packages/client/src/StreamVideoClient.ts

@@ -31,6 +31,7 @@ import { getLogger, logToConsole, setLogger } from './logger';
 import { getSdkInfo } from './client-details';
 import { SdkType } from './gen/video/sfu/models/models';
 import { withoutConcurrency } from './helpers/concurrency';
+import { enableTimerWorker } from './timers';
 
 /**
  * A `StreamVideoClient` instance lets you communicate with our API, and authenticate users.
@@ -86,9 +87,12 @@ export class StreamVideoClient {
     if (typeof apiKeyOrArgs === 'string') {
       logLevel = opts?.logLevel || logLevel;
       logger = opts?.logger || logger;
+      if (opts?.expertimental_enableTimerWorker) enableTimerWorker();
     } else {
       logLevel = apiKeyOrArgs.options?.logLevel || logLevel;
       logger = apiKeyOrArgs.options?.logger || logger;
+      if (apiKeyOrArgs.options?.expertimental_enableTimerWorker)
+        enableTimerWorker();
     }
 
     setLogger(logger, logLevel);

packages/client/src/coordinator/connection/types.ts

@@ -146,6 +146,12 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
    * In Node.js environment, you can use the `ws` package.
    */
   WebSocketImpl?: typeof WebSocket;
+
+  /**
+   * Create Web Worker to initiate timer events like health checks. Can possibly prevent
+   * timer throttling issues in inactive browser tabs.
+   */
+  expertimental_enableTimerWorker?: boolean;
 };
 
 export type TokenProvider = () => Promise<string>;

packages/client/src/timers/index.ts

@@ -9,7 +9,12 @@ class TimerWorker {
   private worker: Worker | undefined;
   private fallback = false;
 
-  setup(): void {
+  setup({ useTimerWorker = true }: { useTimerWorker?: boolean } = {}): void {
+    if (!useTimerWorker) {
+      this.fallback = true;
+      return;
+    }
+
     try {
       const source = timerWorker.src;
       const blob = new Blob([source], {
@@ -119,8 +124,14 @@ class TimerWorker {
   }
 }
 
+let timerWorkerEnabled = false;
+
+export const enableTimerWorker = () => {
+  timerWorkerEnabled = true;
+};
+
 export const getTimers = lazy(() => {
   const instance = new TimerWorker();
-  instance.setup();
+  instance.setup({ useTimerWorker: timerWorkerEnabled });
   return instance;
 });