Merge pull request #307 from PrefectHQ/subscription-refresh-dispose

Enhancement: Create a new scope for each execution when refreshing subscriptions

Author: pleek91

src/useSubscription/models/channel.ts

@@ -44,7 +44,7 @@ export default class Channel<T extends Action = Action> {
   private readonly action: T
   private readonly args: ActionArguments<T>
   private readonly subscriptions: Map<number, Subscription<T>> = new Map()
-  private readonly scope = effectScope()
+  private scope = effectScope()
   private timer: ReturnType<typeof setInterval> | null = null
   private lastExecution: number = 0
   private _loading: boolean = false
@@ -193,6 +193,14 @@ export default class Channel<T extends Action = Action> {
     }
   }
 
+  public refresh(): Promise<void> {
+    this.scope.stop()
+    this.scope = effectScope()
+    const response = this.execute()
+
+    return response
+  }
+
   public isSubscribed(id: number): boolean {
     return this.subscriptions.has(id)
   }
@@ -217,6 +225,6 @@ export default class Channel<T extends Action = Action> {
     const sinceLastRun = Date.now() - this.lastExecution
     const timeTillNextExecution = this.interval - sinceLastRun
 
-    this.timer = setTimeout(() => this.execute(), timeTillNextExecution)
+    this.timer = setTimeout(() => this.refresh(), timeTillNextExecution)
   }
 }

src/useSubscription/models/subscription.ts

@@ -36,7 +36,7 @@ export default class Subscription<T extends Action> {
   }
 
   public async refresh(): Promise<void> {
-    await this.channel.execute()
+    await this.channel.refresh()
   }
 
   public unsubscribe(): void {

src/useSubscription/useSubscription.spec.ts

@@ -571,14 +571,14 @@ describe('subscribe', () => {
     expect(spy).toBeCalledTimes(1)
   })
 
-  it('changing args unsubscribes nested subscriptions automatically', async () => {
+  it('unsubscribes nested subscriptions when changing args', async () => {
     const number = ref(0)
     const manager = new Manager()
     const action = vi.fn()
     let childSubscription: UseSubscription<typeof action>
 
     useSubscription((number: number): number => {
-      childSubscription = useSubscription(action)
+      childSubscription = useSubscription(action, [], { manager })
       return number
     }, [number], { manager })
 
@@ -591,4 +591,20 @@ describe('subscribe', () => {
     expect(spy).toBeCalledTimes(1)
   })
 
+  it('it refreshes nested subscriptions when calling refresh', async () => {
+    const action = vi.fn()
+    const manager = new Manager()
+    const subscription = useSubscription((): void => {
+      useSubscription(action, [], { manager })
+    }, [], { manager })
+
+    await timeout()
+
+    subscription.refresh()
+
+    await timeout()
+
+    expect(action).toBeCalledTimes(2)
+  })
+
 })