feat(SnapshotPlugin): Add keptDuration option.

source/detector-spec.ts

@@ -15,6 +15,12 @@ import { find, spy } from "./spy";
 
 import "rxjs/add/operator/mergeMap";
 
+const options = {
+    keptDuration: -1,
+    keptValues: 4,
+    warning: false
+};
+
 describe("detector", () => {
 
     let detector: Detector;
@@ -29,7 +35,7 @@ describe("detector", () => {
 
     beforeEach(() => {
 
-        teardown = spy({ warning: false });
+        teardown = spy({ ...options });
         detector = new Detector(find(SnapshotPlugin));
     });
 

source/plugin/snapshot-plugin-spec.ts

@@ -23,6 +23,7 @@ import "../add/operator/tag";
 
 describe("SnapshotPlugin", () => {
 
+    const keptDuration = 10;
     const keptValues = 2;
     let plugin: SnapshotPlugin;
     let teardown: () => void;
@@ -36,7 +37,7 @@ describe("SnapshotPlugin", () => {
 
     beforeEach(() => {
 
-        plugin = new SnapshotPlugin({ keptValues });
+        plugin = new SnapshotPlugin({ keptDuration, keptValues });
         teardown = spy({ plugins: [new GraphPlugin(), plugin], warning: false });
     });
 
@@ -139,6 +140,27 @@ describe("SnapshotPlugin", () => {
             expect(subscriberSnapshot.values).to.have.length(2);
             expect(subscriberSnapshot.valuesFlushed).to.equal(2);
         });
+
+        it("should automatically flush old, unsubscribed snapshots", (callback) => {
+
+            const subject = new Subject<number>();
+            const subscription = subject.subscribe((value) => {}, (error) => {});
+
+            subject.next(1);
+
+            let snapshot = plugin.snapshotAll();
+            expect(snapshot.observables).to.have.property("size", 1);
+
+            subject.complete();
+
+            setTimeout(() => {
+
+                snapshot = plugin.snapshotAll();
+                expect(snapshot.observables).to.have.property("size", 0);
+                callback();
+
+            }, keptDuration + 10);
+        });
     });
 
     describe("snapshotAll", () => {

source/plugin/snapshot-plugin.ts

@@ -78,26 +78,37 @@ export interface SubscriptionSnapshot {
 
 export class SnapshotPlugin extends BasePlugin {
 
-    private rootSubscriptionRefs_: Map<SubscriptionRef, boolean>;
+    private keptDuration_: number;
     private keptValues_: number;
+    private lastFlush_: number;
+    private rootSubscriptionRefs_: Map<SubscriptionRef, boolean>;
 
     constructor({
+        keptDuration = 30000,
         keptValues = 4
     }: {
+        keptDuration?: number,
         keptValues?: number
     } = {}) {
 
         super();
 
-        this.rootSubscriptionRefs_ = new Map<SubscriptionRef, boolean>();
+        this.keptDuration_ = keptDuration;
         this.keptValues_ = keptValues;
+        this.lastFlush_ = Date.now();
+        this.rootSubscriptionRefs_ = new Map<SubscriptionRef, boolean>();
     }
 
     afterUnsubscribe(ref: SubscriptionRef): void {
 
         const snapshotRef = getSnapshotRef(ref);
         snapshotRef.tick = tick();
         snapshotRef.unsubscribed = true;
+
+        const { keptDuration_, rootSubscriptionRefs_ } = this;
+        if ((keptDuration_ >= 0) && rootSubscriptionRefs_.has(ref)) {
+            setTimeout(() => rootSubscriptionRefs_.delete(ref), keptDuration_);
+        }
     }
 
     beforeComplete(ref: SubscriptionRef): void {
@@ -175,6 +186,7 @@ export class SnapshotPlugin extends BasePlugin {
                 rootSubscriptionRefs_.delete(ref);
             }
         });
+        this.lastFlush_ = Date.now();
     }
 
     snapshotAll({

source/spy-spec.ts

@@ -15,6 +15,12 @@ import { tick } from "./tick";
 
 import "rxjs/add/operator/mapTo";
 
+const options = {
+    keptDuration: -1,
+    keptValues: 4,
+    warning: false
+};
+
 describe("spy", () => {
 
     let teardown: () => void;
@@ -33,7 +39,7 @@ describe("spy", () => {
         beforeEach(() => {
 
             plugin = stubPlugin();
-            teardown = spy({ plugins: [plugin], warning: false });
+            teardown = spy({ plugins: [plugin], ...options });
         });
 
         it("should call the plugin's flush method", () => {
@@ -47,7 +53,7 @@ describe("spy", () => {
 
         it("should apply the selector to the tagged observable", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
             _let("people", (source) => source.mapTo("bob"));
 
             const values: any[] = [];
@@ -63,7 +69,7 @@ describe("spy", () => {
 
         it("should log the tagged observable", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
 
             const subject = new Subject<string>();
             let calls: any[][] = [];
@@ -92,7 +98,7 @@ describe("spy", () => {
 
         it("should log all/any tagged observables", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
 
             const subject = new Subject<string>();
             const calls: any[][] = [];
@@ -111,7 +117,7 @@ describe("spy", () => {
 
         it("should pause the tagged observable's subscriptions", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
             const deck = pause("people");
 
             const values: any[] = [];
@@ -127,7 +133,7 @@ describe("spy", () => {
 
         it("should resume upon teardown", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
             const deck = pause("people");
 
             const values: any[] = [];
@@ -149,7 +155,7 @@ describe("spy", () => {
         beforeEach(() => {
 
             plugin = stubPlugin();
-            teardown = spy({ plugins: [plugin], warning: false });
+            teardown = spy({ plugins: [plugin], ...options });
         });
 
         it("should call the plugin subscribe/next/unsubscribe methods", () => {
@@ -308,7 +314,7 @@ describe("spy", () => {
 
         it("should show snapshotted information for the tagged observable", () => {
 
-            teardown = spy({ warning: false });
+            teardown = spy({ ...options });
 
             const calls: any[][] = [];
             const subject = new Subject<number>();
@@ -325,7 +331,7 @@ describe("spy", () => {
 
         it("should show snapshotted information all/any tagged observables", () => {
 
-            teardown = spy({ warning: false });
+            teardown = spy({ ...options });
 
             const calls: any[][] = [];
             const subject = new Subject<number>();
@@ -345,7 +351,7 @@ describe("spy", () => {
 
         it("should increment with each subscription and value, etc.", () => {
 
-            teardown = spy({ plugins: [], warning: false });
+            teardown = spy({ plugins: [], ...options });
 
             const subject = new Subject<string>();
 

source/spy.ts

@@ -274,14 +274,14 @@ export function show(match: any, partialLogger: PartialLogger = defaultLogger):
     logger.groupEnd();
 }
 
-export function spy({
-    plugins,
-    warning = true
-}: {
+export function spy(options: {
+    [key: string]: any,
     plugins?: Plugin[]
     warning?: boolean
 } = {}): () => void {
 
+    const { plugins, warning } = options;
+
     if (Observable.prototype.subscribe !== subscribeBase) {
         throw new Error("Already spying on Observable.prototype.subscribe.");
     }
@@ -298,7 +298,7 @@ export function spy({
         plugins_ = [
             new StackTracePlugin(),
             new GraphPlugin(),
-            new SnapshotPlugin(),
+            new SnapshotPlugin(options as { [key: string]: any }),
             new DevToolsPlugin()
         ];
     }