feat: add end method to flush policies for cleanup (#753)

Author: oscb

packages/core/src/flushPolicies/__tests__/count-flush-policy.test.ts

@@ -5,9 +5,7 @@ describe('CountFlushPolicy', () => {
   it('triggers a flush when reaching limit', () => {
     const policy = new CountFlushPolicy(3);
 
-    const observer = jest.fn().mockImplementation((value) => {
-      console.log(`new value: ${value}`);
-    });
+    const observer = jest.fn();
 
     policy.shouldFlush.onChange(observer);
 

packages/core/src/flushPolicies/__tests__/timer-flush-policy.test.ts

@@ -10,9 +10,7 @@ describe('TimerFlushPolicy', () => {
     const policy = new TimerFlushPolicy(time);
     policy.start();
 
-    const observer = jest.fn().mockImplementation((value) => {
-      console.log(`new value: ${value}`);
-    });
+    const observer = jest.fn();
 
     policy.shouldFlush.onChange(observer);
 

packages/core/src/flushPolicies/flush-policy-executer.ts

@@ -23,6 +23,7 @@ export class FlushPolicyExecuter {
   }
 
   remove(policy: FlushPolicy) {
+    policy.end();
     let i = this.policies.findIndex((p) => p === policy);
     return this.removeIndex(i);
   }
@@ -80,6 +81,9 @@ export class FlushPolicyExecuter {
         unsubscribe();
       }
     }
+    for (const policy of this.policies) {
+      policy.end();
+    }
   }
 
   private startPolicy(policy: FlushPolicy) {

packages/core/src/flushPolicies/timer-flush-policy.ts

@@ -29,6 +29,10 @@ export class TimerFlushPolicy extends FlushPolicyBase {
     this.startTimer();
   }
 
+  end(): void {
+    clearTimeout(this.flushTimeout);
+  }
+
   onEvent(_event: SegmentEvent): void {
     // Reset interval
     this.startTimer();

packages/core/src/flushPolicies/types.ts

@@ -63,6 +63,12 @@ export interface FlushPolicy {
    * Called when the flush has been completed.
    */
   reset(): void;
+
+  /**
+   * Ends the execution of the flush policy.
+   * All cleanup methods should be contained here
+   */
+  end(): void;
 }
 
 /**
@@ -77,6 +83,10 @@ export abstract class FlushPolicyBase implements FlushPolicy {
     this.shouldFlush.value = false;
   }
 
+  end(): void {
+    // Nothing to cleanup
+  }
+
   abstract start(): void;
 
   abstract onEvent(event: SegmentEvent): void;