Async ORM mutations and queries (#134)

- Disable `thread_sensitive` where it's not needed
- Perform queries and mutations using async
   -   `use_query` now supports async functions.
   -   `use_mutation` now supports async functions.
   -   `django_idom.types.QueryOptions.thread_sensitive` option to customize how sync queries are executed.
   -   `django_idom.hooks.use_mutation` now accepts `django_idom.types.MutationOptions` option to customize how mutations are executed.
- Use Python's arg/kwarg handlers to properly interpret and differentiate between `kwarg` and `args`. This allow things such as `query=my_function` to be properly handled.
-  The `mutate` argument on `django_idom.hooks.use_mutation` has been renamed to `mutation`.
- Add tests for our database routing feature
- Reduce runtime for tests from ~181 seconds to ~11 seconds by only starting the Django server once
- Fix bug where ReactPy utilizes Django's default cache timeout, which can prematurely expire our cache entries.

Author: Archmonger

.gitignore

@@ -8,7 +8,8 @@ logs
 *.pyc
 .dccachea
 __pycache__
-db.sqlite3
+*.sqlite3
+*.sqlite3-journal
 media
 cache
 static-deploy

CHANGELOG.md

@@ -34,9 +34,22 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
--   Nothing (yet)!
+### Added
+
+-   `use_query` now supports async functions.
+-   `use_mutation` now supports async functions.
+-   `reactpy_django.types.QueryOptions.thread_sensitive` option to customize how sync queries are executed.
+-   `reactpy_django.hooks.use_mutation` now accepts `reactpy_django.types.MutationOptions` option to customize how mutations are executed.
+
+### Changed
+
+-   The `mutate` argument on `reactpy_django.hooks.use_mutation` has been renamed to `mutation`.
+
+### Fixed
+
+-   Fix bug where ReactPy utilizes Django's default cache timeout, which can prematurely expire the component cache.
 
-## [3.0.1] - 2023-03-31
+## [3.0.1] - 2023-04-06
 
 ### Changed
 

README.md

@@ -27,7 +27,7 @@
         </td>
         <td>
             <a href="https://github.com/reactive-python/reactpy-django">Django</a>,
-            <a href="https://github.com/idom-team/idom-jupyter">Jupyter</a>,
+            <a href="https://github.com/reactive-python/reactpy-jupyter">Jupyter</a>,
             <a href="https://github.com/idom-team/idom-dash">Plotly-Dash</a>
         </td>
         </tr>

docs/python/use-query-async.py

@@ -0,0 +1,23 @@
+from channels.db import database_sync_to_async
+from example.models import TodoItem
+from reactpy import component, html
+
+from reactpy_django.hooks import use_query
+
+
+async def get_items():
+    return await database_sync_to_async(TodoItem.objects.all)()
+
+
+@component
+def todo_list():
+    item_query = use_query(get_items)
+
+    if item_query.loading:
+        rendered_items = html.h2("Loading...")
+    elif item_query.error or not item_query.data:
+        rendered_items = html.h2("Error when loading!")
+    else:
+        rendered_items = html.ul([html.li(item, key=item) for item in item_query.data])
+
+    return html.div("Rendered items: ", rendered_items)

docs/python/use-query-postprocessor-change.py

@@ -17,7 +17,7 @@ def execute_io_intensive_operation():
 
 
 @component
-def todo_list():
+def my_component():
     query = use_query(
         QueryOptions(
             postprocessor=my_postprocessor,

docs/python/use-query-postprocessor-disable.py

@@ -10,7 +10,7 @@ def execute_io_intensive_operation():
 
 
 @component
-def todo_list():
+def my_component():
     query = use_query(
         QueryOptions(postprocessor=None),
         execute_io_intensive_operation,

docs/python/use-query-postprocessor-kwargs.py

@@ -16,7 +16,7 @@ def get_model_with_relationships():
 
 
 @component
-def todo_list():
+def my_component():
     query = use_query(
         QueryOptions(
             postprocessor_kwargs={"many_to_many": False, "many_to_one": False}

docs/python/use-query-thread-sensitive.py

@@ -0,0 +1,22 @@
+from reactpy import component
+
+from reactpy_django.hooks import use_query
+from reactpy_django.types import QueryOptions
+
+
+def execute_thread_safe_operation():
+    """This is an example query function that does some thread-safe operation."""
+    pass
+
+
+@component
+def my_component():
+    query = use_query(
+        QueryOptions(thread_sensitive=False),
+        execute_thread_safe_operation,
+    )
+
+    if query.loading or query.error:
+        return None
+
+    return str(query.data)

docs/python/use-query.py

@@ -17,6 +17,6 @@ def todo_list():
     elif item_query.error or not item_query.data:
         rendered_items = html.h2("Error when loading!")
     else:
-        rendered_items = html.ul(html.li(item, key=item) for item in item_query.data)
+        rendered_items = html.ul([html.li(item, key=item) for item in item_query.data])
 
     return html.div("Rendered items: ", rendered_items)

docs/src/dictionary.txt

@@ -30,6 +30,7 @@ postprocessing
 serializable
 postprocessor
 preprocessor
+middleware
 backends
 backend
 frontend