Merge pull request #673 from openedx/django42

[Django 4.2]: Upgrade Django to 4.2

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         python-version: [py38]
-        django-version: [django32, django42]
+        django-version: [django42]
 
     steps:
     - uses: actions/checkout@v2
@@ -27,5 +27,5 @@ jobs:
       run: |
         docker exec -e TOXENV=${{ matrix.python-version }}-${{ matrix.django-version }} -u root enterprise.catalog.app /edx/app/enterprise_catalog/enterprise_catalog/validate.sh
     - name: Code Coverage
-      if: matrix.python-version == 'py38' && matrix.django-version=='django32'
+      if: matrix.python-version == 'py38' && matrix.django-version=='django42'
       uses: codecov/codecov-action@v1

Makefile

@@ -11,6 +11,10 @@ TOX = ''
         dev.up.build dev.down dev.destroy dev.stop docker_build \
         shellcheck check_keywords install_transifex_client
 
+COMMON_CONSTRAINTS_TXT=requirements/common_constraints.txt
+.PHONY: $(COMMON_CONSTRAINTS_TXT)
+$(COMMON_CONSTRAINTS_TXT):
+	wget -O "$(@)" https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt || touch "$(@)"
 
 define BROWSER_PYSCRIPT
 import os, webbrowser, sys
@@ -93,8 +97,10 @@ html_coverage: ## generate and view HTML coverage report
 	coverage html && open htmlcov/index.html
 
 upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: piptools ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
+upgrade: $(COMMON_CONSTRAINTS_TXT) piptools ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
 	# Make sure to compile files after any other files they include!
+	sed 's/Django<4.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
+	mv requirements/common_constraints.tmp requirements/common_constraints.txt
 	pip-compile --allow-unsafe --rebuild --upgrade -o requirements/pip.txt requirements/pip.in
 	pip-compile --upgrade -o requirements/pip-tools.txt requirements/pip-tools.in
 	pip install -qr requirements/pip.txt

enterprise_catalog/apps/core/models.py

@@ -16,6 +16,10 @@ class User(AbstractUser):
     """
     full_name = models.CharField(_('Full Name'), max_length=255, blank=True, null=True)
 
+    # this avoids a  migration which otherwise would come with Django 3.2 upgrade
+    # See, https://docs.djangoproject.com/en/3.2/releases/3.1/#abstractuser-first-name-max-length-increased-to-150
+    first_name = models.CharField(_('first name'), max_length=30, blank=True)
+
     @property
     def access_token(self):
         """

enterprise_catalog/settings/base.py

@@ -24,8 +24,6 @@
 # SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = os.environ.get('ENTERPRISE_CATALOG_SECRET_KEY', 'insecure-secret-key')
 
-DEFAULT_HASHING_ALGORITHM = "sha1"
-
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
 
 # SECURITY WARNING: don't run with debug turned on in production!
@@ -158,6 +156,11 @@
 
 USE_TZ = True
 
+# Django 4.0+ uses zoneinfo if this is not set. We can remove this and
+# migrate to zoneinfo after Django 4.2 upgrade. See more on following url
+# https://docs.djangoproject.com/en/4.2/releases/4.0/#zoneinfo-default-timezone-implementation
+USE_DEPRECATED_PYTZ = True
+
 LOCALE_PATHS = (
     root('conf', 'locale'),
 )
@@ -223,6 +226,7 @@
 
 CSRF_COOKIE_SECURE = False
 CSRF_TRUSTED_ORIGINS = []
+CSRF_TRUSTED_ORIGINS_WITH_SCHEME = [] # just for Django 4.2 upgrade
 
 # AUTHENTICATION CONFIGURATION
 LOGIN_URL = '/login/'
@@ -436,3 +440,4 @@
 #
 # Enable this on stage first.
 ENABLE_ENT_7729_ONLY_SHOW_COMPLETE_PROGRAMS = False
+

enterprise_catalog/settings/production.py

@@ -1,4 +1,5 @@
 from os import environ
+import django
 import yaml
 
 from enterprise_catalog.settings.base import *
@@ -63,3 +64,6 @@
 
 for override, value in DB_OVERRIDES.items():
     DATABASES['default'][override] = value
+
+if django.VERSION[0] >= 4:  # for greater than django 3.2 use schemes.
+    CSRF_TRUSTED_ORIGINS = CSRF_TRUSTED_ORIGINS_WITH_SCHEME

requirements/base.txt

@@ -21,6 +21,7 @@ backoff==1.10.0
 backports-zoneinfo[tzdata]==0.2.1
     # via
     #   celery
+    #   django
     #   kombu
 billiard==4.1.0
     # via celery
@@ -63,10 +64,8 @@ defusedxml==0.7.1
     #   djangorestframework-xml
     #   python3-openid
     #   social-auth-core
-django==3.2.21
+django==4.2.5
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -c requirements/constraints.txt
     #   -r requirements/base.in
     #   django-celery-results
     #   django-clearcache
@@ -113,10 +112,8 @@ django-model-utils==4.3.1
     #   -r requirements/base.in
     #   edx-celeryutils
     #   edx-rbac
-django-simple-history==3.0.0
-    # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -r requirements/base.in
+django-simple-history==3.4.0
+    # via -r requirements/base.in
 django-waffle==4.0.0
     # via
     #   edx-django-utils
@@ -135,7 +132,7 @@ djangorestframework-xml==2.0.0
     # via -r requirements/base.in
 drf-jwt==1.19.2
     # via edx-drf-extensions
-drf-spectacular==0.26.4
+drf-spectacular==0.26.5
     # via -r requirements/base.in
 edx-auth-backends==4.2.0
     # via -r requirements/base.in
@@ -187,7 +184,7 @@ monotonic==1.6
     # via analytics-python
 mysqlclient==2.2.0
     # via -r requirements/base.in
-newrelic==9.0.0
+newrelic==9.1.0
     # via edx-django-utils
 oauthlib==3.2.2
     # via
@@ -229,7 +226,6 @@ python3-openid==3.2.0
 pytz==2023.3.post1
     # via
     #   -r requirements/base.in
-    #   django
     #   djangorestframework
 pyyaml==6.0.1
     # via
@@ -311,7 +307,7 @@ vine==5.0.0
     #   kombu
 wcwidth==0.2.6
     # via prompt-toolkit
-xlsxwriter==3.1.4
+xlsxwriter==3.1.5
     # via -r requirements/base.in
 zipp==3.17.0
     # via

requirements/common_constraints.txt

@@ -1,8 +1,3 @@
-# This is a temporary solution to override the real common_constraints.txt
-# In edx-lint, until the pyjwt constraint in edx-lint has been removed.
-# See BOM-2721 for more details.
-# Below is the copied and edited version of common_constraints
-
 # A central location for most common version constraints
 # (across edx repos) for pip-installation.
 #
@@ -18,10 +13,15 @@
 
 
 # using LTS django version
-Django<4.0
+
 
 # elasticsearch>=7.14.0 includes breaking changes in it which caused issues in discovery upgrade process.
 # elastic search changelog: https://www.elastic.co/guide/en/enterprise-search/master/release-notes-7.14.0.html
 elasticsearch<7.14.0
 
-setuptools<60
+# django-simple-history>3.0.0 adds indexing and causes a lot of migrations to be affected
+django-simple-history==3.0.0
+
+# tox>4.0.0 isn't yet compatible with many tox plugins, causing CI failures in almost all repos.
+# Details can be found in this discussion: https://github.com/tox-dev/tox/discussions/1810
+tox<4.0.0

requirements/constraints.txt

@@ -8,8 +8,6 @@
 # pin when possible.  Writing an issue against the offending project and
 # linking to it here is good.
 
-Django>=3.2,<4.0
-
 # Common constraints for edx repos
 -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
 
@@ -33,3 +31,4 @@ redis<4
 edx-lint<5.3
 pylint<2.15
 astroid<2.12
+

requirements/dev.txt

@@ -45,6 +45,7 @@ backports-zoneinfo[tzdata]==0.2.1
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
     #   celery
+    #   django
     #   kombu
 billiard==4.1.0
     # via
@@ -152,10 +153,8 @@ distlib==0.3.7
     # via
     #   -r requirements/test.txt
     #   virtualenv
-django==3.2.21
+django==4.2.5
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -c requirements/constraints.txt
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
     #   django-celery-results
@@ -223,9 +222,8 @@ django-model-utils==4.3.1
     #   -r requirements/test.txt
     #   edx-celeryutils
     #   edx-rbac
-django-simple-history==3.0.0
+django-simple-history==3.4.0
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
 django-waffle==4.0.0
@@ -256,7 +254,7 @@ drf-jwt==1.19.2
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
     #   edx-drf-extensions
-drf-spectacular==0.26.4
+drf-spectacular==0.26.5
     # via
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
@@ -418,7 +416,7 @@ mysqlclient==2.2.0
     # via
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
-newrelic==9.0.0
+newrelic==9.1.0
     # via
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
@@ -579,7 +577,6 @@ pytz==2023.3.post1
     # via
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
-    #   django
     #   djangorestframework
 pyyaml==6.0.1
     # via
@@ -710,12 +707,11 @@ tomlkit==0.12.1
     #   pylint
 tox==3.28.0
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/test.txt
     #   tox-battery
 tox-battery==0.6.2
     # via -r requirements/test.txt
-types-pyyaml==6.0.12.11
+types-pyyaml==6.0.12.12
     # via
     #   -r requirements/test.txt
     #   responses
@@ -771,7 +767,7 @@ wrapt==1.15.0
     #   -r requirements/quality.txt
     #   -r requirements/test.txt
     #   astroid
-xlsxwriter==3.1.4
+xlsxwriter==3.1.5
     # via
     #   -r requirements/quality.txt
     #   -r requirements/test.txt

requirements/django.txt

@@ -1 +1 @@
-django==3.2.21
+django==4.2.5

requirements/doc.txt

@@ -43,6 +43,7 @@ backports-zoneinfo[tzdata]==0.2.1
     # via
     #   -r requirements/test.txt
     #   celery
+    #   django
     #   kombu
 beautifulsoup4==4.12.2
     # via pydata-sphinx-theme
@@ -126,10 +127,8 @@ distlib==0.3.7
     # via
     #   -r requirements/test.txt
     #   virtualenv
-django==3.2.21
+django==4.2.5
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -c requirements/constraints.txt
     #   -r requirements/test.txt
     #   django-celery-results
     #   django-clearcache
@@ -178,10 +177,8 @@ django-model-utils==4.3.1
     #   -r requirements/test.txt
     #   edx-celeryutils
     #   edx-rbac
-django-simple-history==3.0.0
-    # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -r requirements/test.txt
+django-simple-history==3.4.0
+    # via -r requirements/test.txt
 django-waffle==4.0.0
     # via
     #   -r requirements/test.txt
@@ -212,7 +209,7 @@ drf-jwt==1.19.2
     # via
     #   -r requirements/test.txt
     #   edx-drf-extensions
-drf-spectacular==0.26.4
+drf-spectacular==0.26.5
     # via -r requirements/test.txt
 edx-auth-backends==4.2.0
     # via -r requirements/test.txt
@@ -326,7 +323,7 @@ monotonic==1.6
     #   analytics-python
 mysqlclient==2.2.0
     # via -r requirements/test.txt
-newrelic==9.0.0
+newrelic==9.1.0
     # via
     #   -r requirements/test.txt
     #   edx-django-utils
@@ -457,7 +454,6 @@ pytz==2023.3.post1
     # via
     #   -r requirements/test.txt
     #   babel
-    #   django
     #   djangorestframework
 pyyaml==6.0.1
     # via
@@ -585,12 +581,11 @@ tomlkit==0.12.1
     #   pylint
 tox==3.28.0
     # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/test.txt
     #   tox-battery
 tox-battery==0.6.2
     # via -r requirements/test.txt
-types-pyyaml==6.0.12.11
+types-pyyaml==6.0.12.12
     # via
     #   -r requirements/test.txt
     #   responses
@@ -636,7 +631,7 @@ wrapt==1.15.0
     # via
     #   -r requirements/test.txt
     #   astroid
-xlsxwriter==3.1.4
+xlsxwriter==3.1.5
     # via -r requirements/test.txt
 zipp==3.17.0
     # via