Resolve `django_form` limitations
A pull request for this has already been merged.
- #298 by @Archmonger — merged
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python, react
- Domain
- full-stack
Research direction
Start by reading the client code under src/js/src and the server websocket entry point in src/reactpy_django/websocket/consumer.py, then review the related draft PR #859 and the merged work in #298. Done means the unresolved FileField and ImageField limitations and form restoration on page reload have defined, working behavior.
Written by the indexing model from the issue text.
Description
Current Situation and Proposed Actions
Serializable data fields do not work (Unresolved)
The following fields are currently incompatible with django_form due to ReactPy's client and server not supporting file serialization:
-
FileField -
ImageField
My two initial ideas on how to solve this:
- Extend the current implementation but use a custom messaging schema
- Specifically, adding some sort of messaging websocket schema that can differentiate between layout messages and file transfers.
- On the server-side, we could consider re-using Django's UploadHandler.
- The UploadHandler will probably need to be subclassed to get things working with ReactPy.
- Determine how to pipe the HTTP client/server stack through a websocket
- This would be convenient - specifically would enable us to retain the exact same upload behavior that users would expect on any specific Django version
It might be difficult to figure out what to do on early websocket termination. It might also make sense to create a throttling system where the server can control the incoming upload speed.
There was a related draft PR for file uploads that could be leveraged for inspiration.
Multiple choice fields do not work (Fixed in #298)
There is an additional set of fields that are currently incompatible with django_form, and this seems to be caused by weirdness with how Django re-hydrates/re-renders the form submission data:
-
SplitDateTimeField -
MultiValueField
When the form data is submitted, those fields don't properly rehydrate themselves when given form submission data. This causes incorrect re-renders.
This might just be a limitation of our current rendering methodology. If that is true, then fixing this will require digging into Django's form rendering stack and figuring out why they don't rehydrate properly when given the expected values.
Form restoration on page load (Unresolved)
The following limitation will also need to be resolved:
- Implement form restoration on page reload.
- Perhaps pre-rendering plus the browser's default behavior may already handle form restoration well enough? Probably not, but this should be investigated.
- Maybe this involves creating a new setting called
form_restoration_methodthat can be set to"URL","CLIENT_LOCAL_STORAGE","SERVER_SESSION", orNone. Note that "URL" mode would likely limit the user to one form per page. - Maybe we need to mandate the user provides a
keyfor the form if using form restoration in order to properly re-hydrate the form? Or perhaps we can use the form's CSRF token as the key? Or perhaps it can be linked directly to the browser'sscope["session"]? This needs some additional thought.
- Dominant language
- Python
- Stars
- 357
- Forks
- 22
- Avg merge
- 10h 31m
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from reactive-python/reactpy-django
-
Add coverage tests Opencomplexity: 3 (low) priority: 3 (low) type: ci
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
complexity: 2 (medium) priority: 3 (low)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 2 (medium) priority: 3 (low)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 1 (high) priority: 2 (moderate)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 2 (medium) priority: 2 (moderate) type: investigation
Difficulty 5/5 Over a week Newbie friendliness 20/100
All issues in reactive-python/reactpy-django
Similar issues
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100