add ignore parameter to serialize

packages/effector/fork.d.ts

@@ -18,7 +18,10 @@ export function hydrate(domain: Domain, config: {values: ValueMap}): void
 /**
 serialize state on server
 */
-export function serialize(scope: Scope): {[sid: string]: any}
+export function serialize(
+  scope: Scope,
+  {ignore = []}: {ignore?: Array<Store<any>>} = {},
+): {[sid: string]: any}
 
 /** bind event to scope from .watch call */
 export function scopeBind<T>(unit: Unit<T>): (payload: T) => void

src/effector/__tests__/fork.test.js

@@ -0,0 +1,63 @@
+//@noflow
+
+import {createDomain} from 'effector'
+import {fork, serialize} from 'effector/fork'
+
+it('serialize stores to object of sid as keys', () => {
+  const app = createDomain()
+  const $a = app.createStore('value', {sid: 'a'})
+  const $b = app.createStore([], {sid: 'b'})
+  const $c = app.createStore(null, {sid: 'c'})
+  const $d = app.createStore(false, {sid: 'd'})
+
+  const scope = fork(app)
+  const values = serialize(scope)
+
+  expect(values).toMatchInlineSnapshot(`
+    Object {
+      "a": "value",
+      "b": Array [],
+      "c": null,
+      "d": false,
+    }
+  `)
+})
+
+it('serialize stores with ignore parameter', () => {
+  const app = createDomain()
+  const $a = app.createStore('value', {sid: 'a'})
+  const $b = app.createStore([], {sid: 'b'})
+  const $c = app.createStore(null, {sid: 'c'})
+  const $d = app.createStore(false, {sid: 'd'})
+
+  const scope = fork(app)
+  const values = serialize(scope, {ignore: [$b, $d]})
+
+  expect(values).toMatchInlineSnapshot(`
+    Object {
+      "a": "value",
+      "c": null,
+    }
+  `)
+})
+
+it('serialize stores in nested domain', () => {
+  const app = createDomain()
+  const first = app.createDomain()
+  const second = app.createDomain()
+  const third = second.createDomain()
+  const $a = first.createStore('value', {sid: 'a'})
+  const $b = second.createStore([], {sid: 'b'})
+  const $c = third.createStore(null, {sid: 'c'})
+  const $d = app.createStore(false, {sid: 'd'})
+
+  const scope = fork(app)
+  const values = serialize(scope, {ignore: [$d, $a]})
+
+  expect(values).toMatchInlineSnapshot(`
+    Object {
+      "b": Array [],
+      "c": null,
+    }
+`)
+})

src/effector/fork.js

@@ -45,13 +45,19 @@ export function hydrate(domain, {values}) {
 /**
 serialize state on server
 */
-export function serialize({clones}) {
+export function serialize(
+  {clones},
+  {ignore = []}: {ignore?: Array<Store<any>>} = {},
+) {
   const result = {}
   for (const {meta, scope, reg} of clones) {
     if (meta.unit !== 'store') continue
     if (!meta.sid) continue
     result[meta.sid] = reg[scope.state.id].current
   }
+  for (const {sid} of ignore) {
+    if (sid) delete result[sid]
+  }
   return result
 }
 

src/types/__tests__/effector/fork.test.js

@@ -0,0 +1,65 @@
+// @flow
+/* eslint-disable no-unused-vars */
+import {createDomain, Store} from 'effector'
+import {fork, serialize} from 'effector/fork'
+
+const typecheck = '{global}'
+
+describe('serialize cases (should pass)', () => {
+  test('serialize(Scope): {[sid: string]: any}', () => {
+    const app = createDomain()
+    const $a = app.createStore('demo')
+
+    const scope = fork(app)
+    const values: {[sid: string]: string} = serialize(scope)
+
+    expect(typecheck).toMatchInlineSnapshot(`
+      "
+      --typescript--
+      no errors
+
+      --flow--
+      no errors
+      "
+    `)
+  })
+
+  test('serialize(Scope, {ignore:[Store<any>]}): {[sid: string]: any}', () => {
+    const app = createDomain()
+    const $a = app.createStore('demo')
+    const $b = app.createStore(5)
+
+    const scope = fork(app)
+    const values: {[sid: string]: number} = serialize(scope, {ignore: [$b]})
+
+    expect(typecheck).toMatchInlineSnapshot(`
+      "
+      --typescript--
+      no errors
+
+      --flow--
+      no errors
+      "
+    `)
+  })
+})
+
+describe('serialize cases (should fail)', () => {
+  test('serialize(Scope, {ignore:[Event<any>]}): {[sid: string]: any}', () => {
+    const app = createDomain()
+    const event = app.createEvent()
+
+    const scope = fork(app)
+    const values: {[sid: string]: any} = serialize(scope, {ignore: [event]})
+
+    expect(typecheck).toMatchInlineSnapshot(`
+      "
+      --typescript--
+      no errors
+
+      --flow--
+      no errors
+      "
+    `)
+  })
+})