remove shouldFinalFlush

Author: billyvg

packages/replay/src/replay.ts

@@ -19,6 +19,7 @@ import type {
   PopEventContext,
   RecordingOptions,
   ReplayContainer as ReplayContainerInterface,
+  ReplayFlushOptions,
   ReplayPluginOptions,
   Session,
   Timeouts,
@@ -86,11 +87,6 @@ export class ReplayContainer implements ReplayContainerInterface {
    */
   private _isEnabled: boolean = false;
 
-  /**
-   * If true, will flush regardless of `_isEnabled` property
-   */
-  private _shouldFinalFlush: boolean = false;
-
   /**
    * Paused is a state where:
    * - DOM Recording is not listening at all
@@ -259,16 +255,16 @@ export class ReplayContainer implements ReplayContainerInterface {
         log(msg);
       }
 
-      // Set this property so that it ignores `_isEnabled` = false
       // We can't move `_isEnabled` after awaiting a flush, otherwise we can
       // enter into an infinite loop when `stop()` is called while flushing.
-      this._shouldFinalFlush = true;
       this._isEnabled = false;
       this._removeListeners();
       this.stopRecording();
 
-      // Flush event buffer before stopping
-      await this.flushImmediate();
+      this._debouncedFlush.cancel();
+      // See comment above re: `_isEnabled`, we "force" a flush, ignoring the
+      // `_isEnabled` state of the plugin since it was disabled above.
+      await this._flush({force: true})
 
       // After flush, destroy event buffer
       this.eventBuffer && this.eventBuffer.destroy();
@@ -279,8 +275,6 @@ export class ReplayContainer implements ReplayContainerInterface {
       clearSession(this);
     } catch (err) {
       this._handleException(err);
-    } finally {
-      this._shouldFinalFlush = false;
     }
   }
 
@@ -794,8 +788,8 @@ export class ReplayContainer implements ReplayContainerInterface {
    * Flush recording data to Sentry. Creates a lock so that only a single flush
    * can be active at a time. Do not call this directly.
    */
-  private _flush: () => Promise<void> = async () => {
-    if (!this._isEnabled && !this._shouldFinalFlush) {
+  private _flush = async ({force = false}: ReplayFlushOptions = {}): Promise<void> => {
+    if (!this._isEnabled && !force) {
       // This can happen if e.g. the replay was stopped because of exceeding the retry limit
       return;
     }

packages/replay/src/types.ts

@@ -451,6 +451,15 @@ export interface ReplayContainer {
   setInitialState(): void;
 }
 
+export interface ReplayFlushOptions {
+  /**
+   * If true, flush while ignoring the `_isEnabled` state of
+* Replay integration. (By default, flush is noop if integration
+* is stopped).
+   */
+  force?: boolean;
+}
+
 export interface ReplayPerformanceEntry<T> {
   /**
    * One of these types https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType