feat(proxy-state-tree): add flush ID to track flushes

Author: christianalfoni

packages/node_modules/proxy-state-tree/src/index.test.ts

@@ -392,6 +392,7 @@ describe('FUNCTIONS', () => {
 
 describe('REACTIONS', () => {
   test('should be able to register a listener using paths', () => {
+    expect.assertions(2)
     let reactionCount = 0
     const tree = new ProxyStateTree({
       foo: 'bar',
@@ -400,8 +401,9 @@ describe('REACTIONS', () => {
     const trackId = tree.startPathsTracking()
     state.foo // eslint-disable-line
     const paths = tree.clearPathsTracking(trackId)
-    tree.addMutationListener(paths, () => {
+    tree.addMutationListener(paths, (flushId) => {
       reactionCount++
+      expect(flushId).toBe(0)
     })
     tree.startMutationTracking()
     state.foo = 'bar2'
@@ -410,19 +412,20 @@ describe('REACTIONS', () => {
     expect(reactionCount).toBe(1)
   })
   test('should be able to register a global listener', () => {
-    expect.assertions(1)
+    expect.assertions(2)
     const tree = new ProxyStateTree({
       foo: 'bar',
     })
     const state = tree.get()
-    tree.addMutationListener((mutations) => {
+    tree.addMutationListener((mutations, flushId) => {
       expect(mutations).toEqual([
         {
           method: 'set',
           path: 'foo',
           args: ['bar2'],
         },
       ])
+      expect(flushId).toBe(0)
     })
     tree.startMutationTracking()
     state.foo = 'bar2'
@@ -529,19 +532,22 @@ describe('REACTIONS', () => {
     tree.startMutationTracking()
     state.foo = 'bar3'
     tree.clearMutationTracking()
-    const mutations = tree.flush()
-    expect(mutations).toEqual([
-      {
-        path: 'foo',
-        method: 'set',
-        args: ['bar2'],
-      },
-      {
-        path: 'foo',
-        method: 'set',
-        args: ['bar3'],
-      },
-    ])
+    const flushResult = tree.flush()
+    expect(flushResult).toEqual({
+      flushId: 0,
+      mutations: [
+        {
+          path: 'foo',
+          method: 'set',
+          args: ['bar2'],
+        },
+        {
+          path: 'foo',
+          method: 'set',
+          args: ['bar3'],
+        },
+      ],
+    })
   })
 })
 

packages/node_modules/proxy-state-tree/src/index.ts

@@ -23,6 +23,7 @@ class ProxyStateTree {
   paths: Set<string>[]
   status: STATUS
   proxy: any
+  currentFlushId: number
   constructor(state: object, options: Options = {}) {
     if (!isPlainObject(state)) {
       throw new Error('You have to pass a plain object to the Proxy State Tree')
@@ -42,6 +43,7 @@ class ProxyStateTree {
     this.objectChanges = new Set()
     this.status = STATUS.IDLE
     this.proxy = proxify(this, state)
+    this.currentFlushId = 0
   }
   get() {
     return this.proxy
@@ -54,6 +56,7 @@ class ProxyStateTree {
   flush() {
     const pathCallbacksToCall = new Set()
     const mutations = this.mutations.slice()
+    const flushId = this.currentFlushId++
 
     for (let objectChange of this.objectChanges) {
       if (this.pathDependencies[objectChange]) {
@@ -74,18 +77,21 @@ class ProxyStateTree {
     }
 
     for (let callback of pathCallbacksToCall) {
-      callback()
+      callback(flushId)
     }
 
     pathCallbacksToCall.clear()
     this.mutations.length = 0
     this.objectChanges.clear()
 
     for (let globalDependency of this.globalDependencies) {
-      globalDependency(mutations)
+      globalDependency(mutations, flushId)
     }
 
-    return mutations
+    return {
+      mutations,
+      flushId,
+    }
   }
   startMutationTracking() {
     if (this.status !== STATUS.IDLE) {
@@ -131,8 +137,8 @@ class ProxyStateTree {
 
     return pathSet
   }
-  addMutationListener(cb: (mutations: Mutation[]) => void)
-  addMutationListener(initialPaths: Set<string>, cb: () => void)
+  addMutationListener(cb: (mutations: Mutation[], flushId: number) => void)
+  addMutationListener(initialPaths: Set<string>, cb: (flushId: number) => void)
   addMutationListener() {
     if (arguments.length === 1) {
       const cb = arguments[0]