Initial save to/load from URL

Author: Eric Smyth

src/chime_dash/app/pages/root.py

@@ -7,10 +7,9 @@
 """
 from collections import OrderedDict
 
-from dash_bootstrap_components import Container, Row
 from dash_bootstrap_components.themes import BOOTSTRAP
 from dash_html_components import Div
-from dash_core_components import Store
+from dash_core_components import Location, Store
 
 from chime_dash.app.components.base import Page
 from chime_dash.app.components.navbar import Navbar
@@ -32,13 +31,13 @@ class Root(Page):
     def __init__(self, language, defaults):
         """
         """
-        super().__init__(language, defaults)
         self.components = OrderedDict(
             navbar=Navbar(language, defaults),
             sidebar=Sidebar(language, defaults),
             # todo subscribe to changes to URL and select page appropriately
             index=Index(language, defaults),
         )
+        super().__init__(language, defaults)
 
     def get_html(self):
         """Glues individual setup components together
@@ -51,6 +50,7 @@ def get_html(self):
                     children=self.components["sidebar"].html
                              + self.components["index"].html
                 ),
-                Store(id="root-store")
+                Store(id="root-store"),
+                Location(id='location')
             ]
         )

src/chime_dash/app/pages/sidebar.py

@@ -9,6 +9,7 @@
 
 from dash.development.base_component import ComponentMeta
 from dash_html_components import Nav, Div
+from dash_core_components import Store
 
 from chime_dash.app.components.base import Page
 from chime_dash.app.utils import ReadOnlyDict
@@ -117,7 +118,9 @@ class Sidebar(Page):
     def get_html(self) -> List[ComponentMeta]:
         """Initializes the view
         """
-        elements = []
+        elements = [
+            Store(id="sidebar-store")
+        ]
         for idx, data in _SIDEBAR_ELEMENTS.items():
             if data["type"] == "number":
                 element = create_number_input(idx, data, self.content, self.defaults)

src/chime_dash/app/services/callbacks.py

@@ -1,5 +1,9 @@
 from typing import List
-from datetime import date, datetime
+from datetime import datetime
+from collections import OrderedDict
+from urllib.parse import parse_qsl, urlencode
+from dash.exceptions import PreventUpdate
+from dateutil.parser import parse as parse_date
 
 from chime_dash.app.utils.callbacks import ChimeCallback, register_callbacks
 from chime_dash.app.utils import (
@@ -30,13 +34,13 @@ def toggle_tables(switch_value):
         return get_n_switch_values(switch_value, 3)
 
     @staticmethod
-    def handle_model_change(i, pars_json):
+    def handle_model_change(i, sidebar_data):
         model = {}
         pars = None
         result = []
         viz_kwargs = {}
-        if pars_json:
-            pars = parameters_deserializer(pars_json)
+        if sidebar_data:
+            pars = parameters_deserializer(sidebar_data["parameters"])
             model = SimSirModel(pars)
             viz_kwargs = dict(
                 labels=pars.labels,
@@ -53,9 +57,8 @@ def handle_model_change(i, pars_json):
         return result
 
     def __init__(self, component_instance):
-        def handle_model_change_helper(*args, **kwargs):
-            pars_json = args[1]
-            return IndexCallbacks.handle_model_change(component_instance, pars_json)
+        def handle_model_change_helper(sidebar_mod, sidebar_data):
+            return IndexCallbacks.handle_model_change(component_instance, sidebar_data)
 
         super().__init__(
             component_instance=component_instance,
@@ -75,7 +78,7 @@ def handle_model_change_helper(*args, **kwargs):
                     callback_fn=IndexCallbacks.toggle_tables
                 ),
                 ChimeCallback(  # If the parameters or model change, update the text
-                    changed_elements={"root-store": "modified_timestamp"},
+                    changed_elements={"sidebar-store": "modified_timestamp"},
                     dom_updates={
                         "intro": "children",
                         "more_intro": "children",
@@ -90,7 +93,7 @@ def handle_model_change_helper(*args, **kwargs):
                         "SIR_download": "href",
                     },
                     callback_fn=handle_model_change_helper,
-                    stores=['root-store'],
+                    stores=["sidebar-store"],
                 )
             ]
         )
@@ -107,11 +110,14 @@ def get_formated_values(i, input_values):
                 result[key] = False if result[key] == [True] else True
             elif input_type == "date":
                 value = result[key]
-                result[key] = datetime.strptime(value, "%Y-%m-%d").date() if value else value
+                try:
+                    result[key] = datetime.strptime(value, "%Y-%m-%d").date() if value else value
+                except ValueError:
+                    pass
         return result
 
     @staticmethod
-    def update_parameters(i, *input_values) -> List[str]:
+    def update_parameters(i, *input_values) -> List[dict]:
         """Reads html form outputs and converts them to a parameter instance
 
         Returns Parameters
@@ -137,7 +143,7 @@ def update_parameters(i, *input_values) -> List[str]:
             ),
             max_y_axis=inputs_dict.get("max_y_axis_value", None),
         )
-        return [parameters_serializer(pars)]
+        return [{"inputs_dict": inputs_dict, "parameters": parameters_serializer(pars)}]
 
     def __init__(self, component_instance):
         def update_parameters_helper(*args, **kwargs):
@@ -148,17 +154,93 @@ def update_parameters_helper(*args, **kwargs):
             callbacks=[
                 ChimeCallback(
                     changed_elements=component_instance.input_value_map,
-                    dom_updates={"root-store": "data"},
+                    dom_updates={"sidebar-store": "data"},
                     callback_fn=update_parameters_helper,
-                    stores=['root-store'],
                 )
             ]
         )
 
 
+# todo Add tons of tests and validation because there be dragons
 class RootCallbacks(ComponentCallbacks):
+    @staticmethod
+    def try_parsing_number(v):
+        try:
+            return int(v)
+        except ValueError:
+            try:
+                return float(v)
+            except ValueError:
+                return v
+
+    @staticmethod
+    def get_inputs(val_dict, inputs_keys):
+        # todo handle versioning of inputs
+        return OrderedDict((key, value) for key, value in val_dict.items() if key in inputs_keys)
+
+    @staticmethod
+    def parse_hash(hash_str, sidebar_input_types):
+        hash_dict = dict(parse_qsl(hash_str[1:]))
+        for key, value in hash_dict.items():
+            value_type = sidebar_input_types[key]
+            if value_type == "number":
+                parsed_value = RootCallbacks.try_parsing_number(value)
+            # elif value_type == "date":
+            #     parsed_value = parse_date(value)
+            else:
+                parsed_value = value
+            hash_dict[key] = parsed_value
+        return hash_dict
+
+    @staticmethod
+    def hash_changed(sidebar_input_types, hash_str=None, root_data=None):
+        if hash_str:
+            hash_dict = RootCallbacks.parse_hash(hash_str, sidebar_input_types)
+            result = RootCallbacks.get_inputs(hash_dict, sidebar_input_types.keys())
+            # Don't update the data store if it already contains the same data
+            if result == root_data:
+                raise PreventUpdate
+        else:
+            raise PreventUpdate
+        return [result]
+
+    @staticmethod
+    def stores_changed(inputs_keys, root_mod, sidebar_mod, root_data, sidebar_data):
+        root_modified = root_mod or 0
+        sidebar_modified = sidebar_mod or 0
+        if root_modified < sidebar_modified:
+            inputs_dict = sidebar_data["inputs_dict"]
+            new_val = RootCallbacks.get_inputs(inputs_dict, inputs_keys)
+        elif root_modified > sidebar_modified:
+            new_val = RootCallbacks.get_inputs(root_data, inputs_keys)
+        else:
+            raise PreventUpdate
+        return ["#{}".format(urlencode(new_val))] + list(new_val.values())
+
     def __init__(self, component_instance):
+        sidebar = component_instance.components["sidebar"]
+        sidebar_inputs = sidebar.input_value_map
+        sidebar_input_types = sidebar.input_type_map
+
+        def hash_changed_helper(hash_str=None, root_data=None):
+            return RootCallbacks.hash_changed(sidebar_input_types, hash_str, root_data)
+
+        def stores_changed_helper(root_mod, sidebar_mod, root_data, sidebar_data):
+            return RootCallbacks.stores_changed(sidebar_inputs.keys(), root_mod, sidebar_mod, root_data, sidebar_data)
         super().__init__(
             component_instance=component_instance,
-            callbacks=[]
+            callbacks=[
+                ChimeCallback(
+                    changed_elements={"location": "hash"},
+                    dom_updates={"root-store": "data"},
+                    callback_fn=hash_changed_helper,
+                    stores=["root-store"],
+                ),
+                ChimeCallback(
+                    changed_elements={"root-store": "modified_timestamp", "sidebar-store": "modified_timestamp"},
+                    dom_updates={"location": "hash", **sidebar_inputs},
+                    callback_fn=stores_changed_helper,
+                    stores=["root-store", "sidebar-store"],
+                ),
+            ]
         )

src/chime_dash/app/utils/__init__.py

@@ -40,7 +40,7 @@ def __len__(self):
     def __iter__(self):
         return iter(self._data)
 
-    def __keys__(self):
+    def keys(self):
         return self._data.keys()