deps: update to django5 #6452

matthewelwell · 2025-12-31T15:15:52Z

Changes

Note: depends on Flagsmith/flagsmith-common#149

Upgrade to django 5.

There were seemingly very few changes that were needed, and most of the updates in this PR relate to typing updates which I've tried to fix where possible but erred on the side of type: ignore comments where needed.

The main breaking changes that required handling on our end were:

Model.Meta.index_together was removed. I've replaced usages of this with models.Index(fields=[...]). This change does result in a migration applied to the database in the form of a RenameIndex but from what I can tell, this is a very minor operation and doesn't require any locks on the data in the table, or the index, only on the metadata for the table.
django.utils.timezone.utc was removed. I've replaced this with datetime.timezone.utc, but since we still want to use django.utils.timezone for other logic, (e.g. timezone.now()), I've imported datetime.timezone as dttz where needed.

I also had to update a few dependencies to support the django upgrade:

django-debug-toolbar
django-softdelete
djoser

Note that the upgrade of django-debug-toolbar meant that I needed to remove DEBUG = True from the test settings (conversation on the actual LoC for clarification).

How did you test this code?

Unit tests, and running locally.

vercel · 2025-12-31T15:15:57Z

The latest updates on your projects. Learn more about Vercel for GitHub.

3 Skipped Deployments

Project	Deployment	Review	Updated (UTC)
docs	Ignored	Preview	Jan 2, 2026 11:35am
flagsmith-frontend-preview	Ignored	Preview	Jan 2, 2026 11:35am
flagsmith-frontend-staging	Ignored	Preview	Jan 2, 2026 11:35am

…cification

codecov · 2025-12-31T17:53:25Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.08%. Comparing base (ed2f460) to head (2f5b58e).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6452      +/-   ##
==========================================
+ Coverage   98.06%   98.08%   +0.01%     
==========================================
  Files        1292     1295       +3     
  Lines       46509    46515       +6     
==========================================
+ Hits        45611    45622      +11     
+ Misses        898      893       -5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

matthewelwell

Minor comments for context where needed.

matthewelwell · 2026-01-02T11:35:55Z

api/app/settings/test.py


 ENABLE_POSTPONE_DECORATOR = False
-
-DEBUG = True


After the upgrade of django-debug-toolbar, this was causing issues because we only include the debug toolbar if DEBUG is True (see here). As I understand it, it's because we don't also add it to installed_apps here which is now required (but seemingly wasn't in older versions of the package).

I decided the better solution here was simply to remove the DEBUG = True as I'm not sure why it existed here for tests in the first place.

matthewelwell · 2026-01-02T11:44:33Z

api/app_analytics/migrations/0007_rename_environment_id_created_at_index.py

+        migrations.RenameIndex(
+            model_name="apiusageraw",
+            new_name="app_analyti_environ_b61cad_idx",
+            old_fields=("environment_id", "created_at"),
+        ),


Caused by deprecation of Model.Meta.index_together. I've researched and, as I understand it, it requires a lock on the metadata, but no the table or index itself.

Since we don't reference the name of the index directly (although we might in specific oracle migrations 🤔) we shouldn't have any schema mismatch issues.

matthewelwell · 2026-01-02T11:45:38Z

api/custom_auth/mfa/trench/command/remove_backup_code.py

+    if serialized_codes is None:  # pragma: no cover
+        return


Added for typing reasons.

matthewelwell · 2026-01-02T11:48:20Z

api/features/feature_health/services.py

        feature=feature_health_event.feature,
        environment=feature_health_event.environment,
-        type=FeatureHealthEventType.HEALTHY,
+        type=FeatureHealthEventType.HEALTHY.value,


This one was somewhat odd. I can't see any indication of any changes to this behaviour in the notes here, but looking at this test I do think it was wrong previously anyway.

The error that I was seeing was that it couldn't create the event with the type as the literal string "FeatureHealthEventType.HEALTHY" which makes sense - perhaps Django 5 is more strict on enforcing the choices behaviour. Either way, I think this change is a good step.

matthewelwell · 2026-01-02T11:48:44Z

api/users/migrations/0045_add_through_fields_metadata_for_django_5_upgrade.py

+# Note: This migration is a no-op, and just adds the `through_fields` attribute
+# seemingly needed by the state in django5


This migration is a no-op as per this comment.

matthewelwell · 2026-01-02T11:50:26Z

api/users/models.py

+        length: int = 10,
+        allowed_chars: str = string.ascii_letters + string.digits,
+    ) -> str:
+        return "".join(secrets.choice(allowed_chars) for _ in range(length))


make_random_password was removed. I simply re-added it, using the guidance provided here.

matthewelwell · 2026-01-02T11:50:40Z

api/pyproject.toml

 djangorestframework-dataclasses = "^1.3.1"
 pyotp = "^2.9.0"
-flagsmith-common = "^2.2.7"
+flagsmith-common = { git = "https://github.com/flagsmith/flagsmith-common", branch = "deps/django-5-upgrade" }


TODO: replace this with the new version once released.

github-actions · 2026-01-02T11:52:28Z

Docker builds report

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-api-test:pr-6452`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-e2e:pr-6452`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-api:pr-6452`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith:pr-6452`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-6452`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-frontend:pr-6452`	Finished ✅	Results ✅

update to django5

1710693

github-actions bot added the api Issue related to the REST API label Dec 31, 2025

matthewelwell added 5 commits December 31, 2025 15:16

Merge branch 'main' into deps/django-5-upgrade

2a56e15

Update django-debug-toolbar

700f99a

Update django-softdelete

841d47e

remove uses of index_together

f61f979

move django-debug-toolbar to dev dependency and loosen dependency spe…

d00ebfd

…cification

github-actions bot added the dependencies Pull requests that update a dependency file label Dec 31, 2025

add rename index migrations

398f753

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Dec 31, 2025

Add no-op migration needed for through model

f466b13

matthewelwell force-pushed the deps/django-5-upgrade branch from 074f8f9 to f466b13 Compare December 31, 2025 15:45

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Dec 31, 2025

Typing fixes / ignore additions following django 5 upgrade

6c3896a

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Dec 31, 2025

matthewelwell added 6 commits December 31, 2025 17:11

Replace uses of timezone.utc

73a2273

Update djoser to 2.3.3

3414080

Use .value for enum following django upgrade

64fddd7

Remove DEBUG from tests

a5cdc7a

Replace other uses of timezone.utc

640f356

Replace assertQuerysetEqual with assertQuerySetEqual

8c4670a

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Dec 31, 2025

Add pragma no cover

bafcaff

matthewelwell force-pushed the deps/django-5-upgrade branch from 4daf736 to bafcaff Compare December 31, 2025 18:10

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Dec 31, 2025

Remove unnecessary DEBUG value from test settings.

2f5b58e

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Jan 2, 2026

matthewelwell commented Jan 2, 2026

View reviewed changes

matthewelwell marked this pull request as ready for review January 2, 2026 11:51

matthewelwell requested a review from a team as a code owner January 2, 2026 11:51

matthewelwell requested review from gagantrivedi and removed request for a team January 2, 2026 11:51

github-actions bot added dependencies Pull requests that update a dependency file and removed dependencies Pull requests that update a dependency file labels Jan 2, 2026

matthewelwell mentioned this pull request Jan 2, 2026

deps: upgrade django Flagsmith/flagsmith-common#149

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

deps: update to django5 #6452

deps: update to django5 #6452

Uh oh!

matthewelwell commented Dec 31, 2025 •

edited

Loading

Uh oh!

vercel bot commented Dec 31, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 31, 2025 •

edited

Loading

Uh oh!

matthewelwell left a comment

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

matthewelwell Jan 2, 2026 •

edited

Loading

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

matthewelwell Jan 2, 2026

Uh oh!

github-actions bot commented Jan 2, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		# Note: This migration is a no-op, and just adds the `through_fields` attribute
		# seemingly needed by the state in django5

deps: update to django5 #6452

Are you sure you want to change the base?

deps: update to django5 #6452

Uh oh!

Conversation

matthewelwell commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

How did you test this code?

Uh oh!

vercel bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

matthewelwell left a comment

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

matthewelwell Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docker builds report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matthewelwell commented Dec 31, 2025 •

edited

Loading

vercel bot commented Dec 31, 2025 •

edited

Loading

codecov bot commented Dec 31, 2025 •

edited

Loading

matthewelwell Jan 2, 2026 •

edited

Loading

github-actions bot commented Jan 2, 2026 •

edited

Loading