feat(replay/v9): Deprecate _experiments.autoFlushOnFeedback

This feature works pretty well so we are going to make this the default behavior and deprecate the settings. We should remove this in v10.

Author: billyvg

dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

@@ -5,9 +5,6 @@ window.Replay = Sentry.replayIntegration({
   flushMinDelay: 200,
   flushMaxDelay: 200,
   useCompression: false,
-  _experiments: {
-    autoFlushOnFeedback: true,
-  },
 });
 
 Sentry.init({

packages/replay-internal/src/replay.ts

@@ -939,7 +939,7 @@ export class ReplayContainer implements ReplayContainerInterface {
 
       // There is no way to remove these listeners, so ensure they are only added once
       if (!this._hasInitializedCoreListeners) {
-        addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });
+        addGlobalListeners(this);
 
         this._hasInitializedCoreListeners = true;
       }

packages/replay-internal/src/types/replay.ts

@@ -235,6 +235,9 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
      * https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/cross-origin-iframes.md#considerations
      */
     recordCrossOriginIframes: boolean;
+    /**
+     * @deprecated This option is now the default behavior and the option is no longer needed. It will be removed in the next major version.
+     */
     autoFlushOnFeedback: boolean;
     /**
      * Completetly ignore mutations matching the given selectors.

packages/replay-internal/src/util/addGlobalListeners.ts

@@ -16,10 +16,7 @@ import type { ReplayContainer } from '../types';
 /**
  * Add global listeners that cannot be removed.
  */
-export function addGlobalListeners(
-  replay: ReplayContainer,
-  { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
-): void {
+export function addGlobalListeners(replay: ReplayContainer): void {
   // Listeners from core SDK //
   const client = getClient();
 
@@ -64,17 +61,15 @@ export function addGlobalListeners(
       const replayId = replay.getSessionId();
       if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
         // In case the feedback is sent via API and not through our widget, we want to flush replay
-        if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
+        if (feedbackEvent.contexts.feedback.source === 'api') {
           await replay.flush();
         }
         feedbackEvent.contexts.feedback.replay_id = replayId;
       }
     });
 
-    if (autoFlushOnFeedback) {
-      client.on('openFeedbackWidget', async () => {
-        await replay.flush();
-      });
-    }
+    client.on('openFeedbackWidget', async () => {
+      await replay.flush();
+    });
   }
 }