Skip to content

Commit

Permalink
Better already migrated detection
Browse files Browse the repository at this point in the history
  • Loading branch information
Mogost committed Sep 17, 2024
1 parent a68bf90 commit dd24cce
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ test.db
coverage.xml
docs/_build
.idea
constance/_version.py
27 changes: 16 additions & 11 deletions constance/migrations/0003_drop_pickle.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import json
import logging
import pickle
from base64 import b64decode
Expand All @@ -11,6 +12,16 @@
logger = logging.getLogger(__name__)


def is_already_migrated(value):
try:
data = json.loads(value)

Check warning on line 17 in constance/migrations/0003_drop_pickle.py

View check run for this annotation

Codecov / codecov/patch

constance/migrations/0003_drop_pickle.py#L16-L17

Added lines #L16 - L17 were not covered by tests
if isinstance(data, dict) and set(data.keys()) == {'__type__', '__value__'}:
return True
except (json.JSONDecodeError, TypeError):
return False
return False

Check warning on line 22 in constance/migrations/0003_drop_pickle.py

View check run for this annotation

Codecov / codecov/patch

constance/migrations/0003_drop_pickle.py#L19-L22

Added lines #L19 - L22 were not covered by tests


def import_module_attr(path):
package, module = path.rsplit('.', 1)
return getattr(import_module(package), module)
Expand All @@ -20,8 +31,9 @@ def migrate_pickled_data(apps, schema_editor) -> None: # pragma: no cover
Constance = apps.get_model('constance', 'Constance')

for constance in Constance.objects.exclude(value=None):
constance.value = dumps(pickle.loads(b64decode(constance.value.encode()))) # noqa: S301
constance.save(update_fields=['value'])
if not is_already_migrated(constance.value):
constance.value = dumps(pickle.loads(b64decode(constance.value.encode()))) # noqa: S301
constance.save(update_fields=['value'])

if settings.BACKEND in ('constance.backends.redisd.RedisBackend', 'constance.backends.redisd.CachingRedisBackend'):
import redis
Expand All @@ -39,15 +51,8 @@ def migrate_pickled_data(apps, schema_editor) -> None: # pragma: no cover
for key in settings.CONFIG:
prefixed_key = f'{_prefix}{key}'
value = _rd.get(prefixed_key)
if value is not None:
try:
redis_migrated_data[prefixed_key] = dumps(pickle.loads(value)) # noqa: S301
except pickle.UnpicklingError as e:
if value.startswith(b'{"__'):
# Seems like we're facing already migrated data
# Might be related to defaults and when config was accessed while django inits for migration
continue
raise e
if value is not None and not is_already_migrated(value):
redis_migrated_data[prefixed_key] = dumps(pickle.loads(value)) # noqa: S301
for prefixed_key, value in redis_migrated_data.items():
_rd.set(prefixed_key, value)

Expand Down

0 comments on commit dd24cce

Please sign in to comment.