📝 Benchmark immutadot and display results on front page (#196)

* ✨ Add the simple benchmark made for immer in a sperate package

* 📝 Add benchmark results in README.md

* ✏️ Add link to benchmark author github profile

* 🚧 Add lodash/fp in benchmark

* 🔥 Remove test of immer with autofreeze

* 🐛 Reorder args for lodash/fp test

* 🔥 Remove lodash/fp test

* 📝 Update benchmark results

* ♻️ Adjustments in benchmarks

* 👌 Take care of @nlepage review

* ✏️ Update benchmark results

* 📝 Update benchmark presentation

* ✏️ fix typo

Author: frinyvonnick

README.md

@@ -186,7 +186,21 @@ toLowerCase({ nested: { prop: { 1: { msg: 'Hello' }, 2: { msg: 'Hi' }, 3: { msg
 // { nested: { prop: { 1: { msg: 'Hello' }, 2: { msg: 'hi' }, 3: { msg: 'good morning' } } } }
 ```
 
-### Performances
+## Performances
+
+We reused a [simple benchmark](https://github.com/Zenika/immutadot/tree/master/packages/immutadot-benchmark/src/benchmark.spec.js) originally made by [mweststrate](https://github.com/mweststrate) for [immer](https://github.com/mweststrate/immer).
+It updates 10.000 items out of list of 100.000 todos items, these tests were executed on Node 8.4.0 with a MacBook Pro 2015:
+
+```shell
+Update todos list
+    ✓ with mutation (2ms)
+    ✓ with deep cloning, then mutation (628ms)
+    ✓ with ES2015 destructuring (46ms)
+    ✓ with immutable (w/o conversion to plain JS objects) (99ms)
+    ✓ with immutable (w/ conversion to plain JS objects) (858ms)
+    ✓ with immer (353ms)
+    ✓ with immutad●t (137ms)
+```
 
 When applying operations on a path immutad●t tries to create the minimum of objects or arrays needed to guarantee your data structure to be immutable.
 

packages/immutadot-benchmark/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "immutadot-benchmark",
+  "version": "1.0.0-rc.4",
+  "license": "MIT",
+  "devDependencies": {
+    "immer": "~0.2.0",
+    "immutable": "~3.8.2",
+    "immutadot": "~1.0.0-rc.4",
+    "jest": "~21.2.1"
+  },
+  "scripts": {
+    "benchmark": "jest -v -i"
+  }
+}

packages/immutadot-benchmark/src/benchmark.spec.js

@@ -0,0 +1,117 @@
+/* eslint-env jest */
+'use strict'
+
+// Initial source: https://github.com/mweststrate/immer/blob/2a1da31f8d0408857697c04f6a683fd955ab7a06/__tests__/performance.js
+
+import { List, Record } from 'immutable'
+
+import immer, { setAutoFreeze } from 'immer'
+
+import cloneDeep from 'lodash/cloneDeep'
+
+import { set } from 'immutadot/core'
+
+describe('Benchmarks', () => {
+
+  describe('Update todos list', () => {
+    const MAX = 100000
+    const MODIFY_FACTOR = 0.1
+
+    // Prepare base state
+    const baseState = []
+    for (let i = 0; i < MAX; i++) {
+      baseState.push({
+        todo: `todo_${i}`,
+        done: false,
+        someThingCompletelyIrrelevant: [1, 2, 3, 4, 5, 6, 7, 8, 9, 0],
+      })
+    }
+
+    // Prepare frozen state
+    const frozenState = Object.freeze(baseState.map(todo => Object.freeze({
+      ...todo,
+      someThingCompletelyIrrelevant: Object.freeze([...todo.someThingCompletelyIrrelevant]),
+    })))
+
+    // Prepare immutalbe state
+    const todoRecord = Record({
+      todo: '',
+      done: false,
+      someThingCompletelyIrrelevant: [],
+    })
+    const immutableState = List(frozenState.map(todo => todoRecord(todo)))
+
+    // Disable immer auto freeze
+    setAutoFreeze(false)
+
+    // Prepare expectd state
+    const expectedState = []
+    for (let i = 0; i < MAX; i++) {
+      expectedState.push({
+        todo: `todo_${i}`,
+        done: i < MAX * MODIFY_FACTOR,
+        someThingCompletelyIrrelevant: [1, 2, 3, 4, 5, 6, 7, 8, 9, 0],
+      })
+    }
+
+    it('with mutation', () => {
+      for (let i = 0; i < MAX * MODIFY_FACTOR; i++)
+        baseState[i].done = true
+    })
+
+    let deepCloneActual
+    it('with deep cloning, then mutation', () => {
+      deepCloneActual = cloneDeep(frozenState)
+      for (let i = 0; i < MAX * MODIFY_FACTOR; i++)
+        deepCloneActual[i].done = true
+    })
+
+    let es2015Actual
+    it('with ES2015 destructuring', () => {
+      es2015Actual = frozenState
+        .slice(0, MAX * MODIFY_FACTOR)
+        .map(todo => ({
+          ...todo,
+          done: true,
+        }))
+        .concat(frozenState.slice(MAX * MODIFY_FACTOR))
+    })
+
+    it('with immutable (w/o conversion to plain JS objects)', () => {
+      immutableState.withMutations(state => {
+        for (let i = 0; i < MAX * MODIFY_FACTOR; i++)
+          state.setIn([i, 'done'], true)
+      })
+    })
+
+    let immutableActual
+    it('with immutable (w/ conversion to plain JS objects)', () => {
+      immutableActual = immutableState.withMutations(state => {
+        for (let i = 0; i < MAX * MODIFY_FACTOR; i++)
+          state.setIn([i, 'done'], true)
+      }).toJS()
+    })
+
+    let immerActual
+    it('with immer', () => {
+      immerActual = immer(frozenState, draft => {
+        for (let i = 0; i < MAX * MODIFY_FACTOR; i++)
+          draft[i].done = true
+      })
+    })
+
+    let immutadotActual
+    it('with immutad●t', () => {
+      immutadotActual = set(frozenState, `[:${MAX * MODIFY_FACTOR}].done`, true)
+    })
+
+    it('check produced todos lists', () => {
+      expect(baseState).toEqual(expectedState)
+      expect(deepCloneActual).toEqual(expectedState)
+      expect(es2015Actual).toEqual(expectedState)
+      expect(immutableActual).toEqual(expectedState)
+      expect(immerActual).toEqual(expectedState)
+      expect(immutadotActual).toEqual(expectedState)
+    })
+  })
+})

yarn.lock

@@ -2601,6 +2601,14 @@ ignore@^3.3.3:
   version "3.3.7"
   resolved "https://registry.yarnpkg.com/ignore/-/ignore-3.3.7.tgz#612289bfb3c220e186a58118618d5be8c1bab021"
 
+immer@~0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/immer/-/immer-0.2.0.tgz#a871923e7bfdfaff0796ba3f9a98c3aec665f389"
+
+immutable@~3.8.2:
+  version "3.8.2"
+  resolved "https://registry.yarnpkg.com/immutable/-/immutable-3.8.2.tgz#c2439951455bb39913daf281376f1530e104adf3"
+
 imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"