Merge pull request #333 from plotly/store-nested-data

Fix nested data for the Store component.

Author: T4rk1n

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log for dash-core-components
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.33.1] -- 2018-10-17
+### Fixed
+- Fix Store component nested data [#333](https://github.com/plotly/dash-core-components/pull/333)
+
 ## [0.33.0] -- 2018-10-04
 ### Added
 

dash_core_components/dash_core_components.dev.js

@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "0.33.0",
+  "version": "0.33.1",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",
@@ -19,7 +19,7 @@
     "uninstall-local": "pip uninstall dash-core-components -y",
     "build:js": "webpack --mode production",
     "build:js-dev": "webpack --mode development",
-    "build:py": "node ./extract-meta src/components > dash_core_components/metadata.json && cp package.json dash_core_components && npm run generate-python-classes",
+    "build:py": "node ./extract-meta src/components > dash_core_components/metadata.json && copyfiles package.json dash_core_components && npm run generate-python-classes",
     "build:all": "npm run build:js && npm run build:py",
     "build:all-dev": "npm run build:js-dev && npm run build:py",
     "build:watch": "watch 'npm run build:all' src"

dash_core_components/dash_core_components.min.js

@@ -1 +1 @@
-__version__ = '0.33.0'
+__version__ = '0.33.1'

dash_core_components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "0.33.0",
+  "version": "0.33.1",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",

dash_core_components/version.py

@@ -8,6 +8,7 @@ tox
 tox-pyenv
 six
 plotly>=2.0.8
+urllib3<=1.22
 requests[security]
 ipdb
 dash-table-experiments

package.json

@@ -13,14 +13,14 @@ function dataCheck(data, old) {
             return true;
         }
         for (let i = 0; i < data.length; i++) {
-            if (data[i] !== old[i]) {
+            if (dataCheck(data[i], old[i])) {
                 return true;
             }
         }
     } else if (R.contains(type, ['String', 'Number'])) {
         return old !== data;
     } else if (type === 'Object') {
-        return R.any(([k, v]) => old[k] !== v)(Object.entries(data));
+        return R.any(([k, v]) => dataCheck(v, old[k]))(Object.entries(data));
     }
     return false;
 }

requirements-dev.txt

@@ -1173,19 +1173,19 @@ def test_storage_component(self):
 
         app.layout = html.Div([
             dcc.Store(id='storage',
-                        storage_type='local'),
+                      storage_type='local'),
             html.Button('click me', id='btn'),
             html.Button('clear', id='clear-btn'),
             html.Button('set-init-storage',
                         id='set-init-storage'),
             dcc.Store(id='dummy',
-                        storage_type='session',
-                        data=dummy_data),
+                      storage_type='session',
+                      data=dummy_data),
             dcc.Store(id='memory',
-                        storage_type='memory'),
+                      storage_type='memory'),
             html.Div(id='memory-output'),
             dcc.Store(id='initial-storage',
-                        storage_type='session'),
+                      storage_type='session'),
             html.Div(id='init-output')
         ])
 
@@ -1269,3 +1269,50 @@ def init_output(ts, data):
         self.assertAlmostEqual(ts, init.get('ts'), delta=1000)
         self.assertEqual('initialized', init.get('data'))
 
+    def test_store_nested_data(self):
+        app = dash.Dash(__name__)
+
+        nested = {'nested': {'nest': 'much'}}
+        nested_list = dict(my_list=[1, 2, 3])
+
+        app.layout = html.Div([
+            dcc.Store(id='store', storage_type='local'),
+            html.Button('set object as key', id='obj-btn'),
+            html.Button('set list as key', id='list-btn'),
+            html.Output(id='output')
+        ])
+
+        @app.callback(Output('store', 'data'),
+                      [Input('obj-btn', 'n_clicks_timestamp'),
+                       Input('list-btn', 'n_clicks_timestamp')])
+        def on_obj_click(obj_ts, list_ts):
+            if obj_ts is None and list_ts is None:
+                raise PreventUpdate
+
+            # python 3 got the default props bug. plotly/dash#396
+            if (obj_ts and not list_ts) or obj_ts > list_ts:
+                return nested
+            else:
+                return nested_list
+
+        @app.callback(Output('output', 'children'),
+                      [Input('store', 'modified_timestamp')],
+                      [State('store', 'data')])
+        def on_ts(ts, data):
+            if ts is None:
+                raise PreventUpdate
+            return json.dumps(data)
+
+        self.startServer(app)
+
+        obj_btn = self.wait_for_element_by_css_selector('#obj-btn')
+        list_btn = self.wait_for_element_by_css_selector('#list-btn')
+
+        obj_btn.click()
+        time.sleep(3)
+        self.wait_for_text_to_equal('#output', json.dumps(nested))
+        # it would of crashed the app before adding the recursive check.
+
+        list_btn.click()
+        time.sleep(3)
+        self.wait_for_text_to_equal('#output', json.dumps(nested_list))