[change:radius] Replace third-party JSONField with Django built-in JSONField #619
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eeshu-Yadav
force-pushed
the
issues/600-replace-jsonfield-clean
branch
2 times, most recently
from
a9ad394 to
998b688
Compare
Eeshu-Yadav
force-pushed
the
issues/600-replace-jsonfield-clean
branch
2 times, most recently
from
a0d7e52 to
21b4925
Compare
Eeshu-Yadav
force-pushed
the
issues/600-replace-jsonfield-clean
branch
4 times, most recently
from
665a8b5 to
fa44638
Compare
Contributor
Author
|
@nemesifier kindly review |
nemesifier
requested changes
Oct 23, 2025
Member
nemesifier
left a comment
nemesifier
left a comment
There was a problem hiding this comment.
Thanks @Eeshu-Yadav, see my comments below.
| name="user_credentials", | ||
| field=models.JSONField(blank=True, null=True, verbose_name="PDF"), | ||
| ), | ||
| migrations.RunPython( |
Member
There was a problem hiding this comment.
Data migrations need to be executed in a dedicated migration file, please refer to https://stackoverflow.com/a/66799446 for more information.
| batch.user_credentials = json.loads(batch.user_credentials) | ||
| batch.save(update_fields=["user_credentials"]) | ||
| except (json.JSONDecodeError, TypeError): | ||
| # If it's already decoded or invalid JSON, skip it |
Member
There was a problem hiding this comment.
It shouldn't fail. If it fails we must let it fail loudly, unless there can be failure which would be common and in that case we should catch the exception and resolve this automatically.
Why do you think it would fail here?
| to proper JSON objects for Django's built-in JSONField. | ||
| """ | ||
| RadiusBatch = apps.get_model("openwisp_radius", "RadiusBatch") | ||
| for batch in RadiusBatch.objects.exclude(user_credentials__isnull=True): |
Member
There was a problem hiding this comment.
Suggested change
| for batch in RadiusBatch.objects.exclude(user_credentials__isnull=True): | |
| for batch in RadiusBatch.objects.exclude(user_credentials__isnull=True).iterator(): |
Not using iterator() may crash instances with large amount of rows and must be avoided.
Eeshu-Yadav
force-pushed
the
issues/600-replace-jsonfield-clean
branch
from
fa44638 to
a763c2b
Compare
- Replaced third-party jsonfield.JSONField with Django's built-in models.JSONField in all model definitions - Updated RadiusBatch.prefix_add method to directly assign user_credentials list instead of using json.dumps() - Added migration 0043 to replace JSONField in model definitions - Added migration 0044 to convert existing double-encoded JSON data in user_credentials field (data migration in separate file) - Used .iterator() in data migration for memory efficiency - Removed jsonfield dependency from setup.py - Updated test migrations to use Django's JSONField - Removed unused json import Closes openwisp#600
Eeshu-Yadav
force-pushed
the
issues/600-replace-jsonfield-clean
branch
from
a763c2b to
ba82cd9
Compare
Contributor
Author
|
@nemesifier kindly review |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Reference to Existing Issue
Closes #600.
Description of Changes
This PR replaces the third-party
jsonfieldlibrary with Django's built-in JSONField. The third-party JSONField library hasn't received updates in 5 years, while Django's built-in JSONField is now mature and actively maintained.Changes Made:
from jsonfield import JSONFieldwithfrom django.db.models import JSONFieldin modelsRadiusBatch.user_credentialsandOrganizationRadiusSettings.sms_meta_datafields"jsonfield~=3.1.0"dependency from setup.py0041_replace_jsonfield_with_django_builtin.pyto handle field type transitionTesting: