Merge pull request #346 from PrefectHQ/fix-use-subscription-with-depe…

…ndency-reactivity

Fix subscription actions being called even when the args have not changed

src/useSubscription/useSubscriptionWithDependencies.spec.ts

@@ -0,0 +1,29 @@
+import { expect, test, vi } from 'vitest'
+import { computed, ref } from 'vue'
+import { useSubscriptionWithDependencies } from '@/useSubscription/useSubscriptionWithDependencies'
+import { timeout } from '@/utilities/tests'
+
+test('it does not execute the action when args have not changed', async () => {
+  const object = ref({ value: 0 })
+  const action = vi.fn()
+
+  const parameters = computed(() => [object.value])
+
+  useSubscriptionWithDependencies(action, parameters)
+
+  await timeout()
+
+  expect(action).toBeCalledTimes(1)
+
+  object.value = { value: 1 }
+
+  await timeout()
+
+  expect(action).toBeCalledTimes(2)
+
+  object.value = { value: 1 }
+
+  await timeout()
+
+  expect(action).toBeCalledTimes(2)
+})

src/useSubscription/useSubscriptionWithDependencies.ts

@@ -1,3 +1,4 @@
+import isEqual from 'lodash.isequal'
 import { reactive, ref, Ref, toRaw, watch } from 'vue'
 import { MaybeRef } from '@/types/maybe'
 import { Action, SubscriptionOptions, UseSubscription, ActionArguments, MappedSubscription } from '@/useSubscription/types'
@@ -33,6 +34,10 @@ export function useSubscriptionWithDependencies<T extends Action>(...[action, ar
       return
     }
 
+    if (isEqual(value, previousValue)) {
+      return
+    }
+
     if (subscription.isSubscribed()) {
       subscription.unsubscribe()
     }