[Feat]: Upgrade django from 2.2 to 3.2

The django library 2.2 LTS is going end of life next year. Move the library to django 3.2
Also, with this upgrade, moved to use edx-api-doc-tools to generate the swagger doc UI at /docs

Author: schenedx

.travis.yml

@@ -20,7 +20,7 @@ matrix:
     - python: '3.8'
       env: TESTNAME=test-python-3.8 TARGETS="PYTHON_ENV=py38 main.test"
     - python: '3.8'
-      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django30 main.test"
+      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django32 main.test"
       after_success:
         - docker exec analytics_api_testing /edx/app/analytics_api/analytics_api/.travis/run_coverage.sh
         - codecov --disable pycov

Makefile

@@ -3,7 +3,7 @@ COVERAGE_DIR = $(ROOT)/build/coverage
 PACKAGES = analyticsdataserver analytics_data_api
 DATABASES = default analytics
 PYTHON_ENV=py38
-DJANGO_VERSION=django22
+DJANGO_VERSION=django32
 .DEFAULT_GOAL := help
 
 help: ## display this help message
@@ -33,18 +33,7 @@ tox.requirements:  ## install tox requirements
 develop: test.requirements  ## install test and dev requirements
 	pip3 install -q -r requirements/dev.txt
 
-
-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 "$(@)"
-
-upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: $(COMMON_CONSTRAINTS_TXT)   ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
-	sed 's/pyjwt\[crypto\]<2.0.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
-	mv requirements/common_constraints.tmp requirements/common_constraints.txt
-	sed 's/edx-drf-extensions<7.0.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
-	mv requirements/common_constraints.tmp requirements/common_constraints.txt
+upgrade: 
 	pip3 install -q -r requirements/pip_tools.txt
 	pip-compile --upgrade -o requirements/pip_tools.txt requirements/pip_tools.in
 	pip-compile --upgrade -o requirements/base.txt requirements/base.in

analyticsdataserver/settings/base.py

@@ -245,7 +245,8 @@
     'rest_framework.authtoken',
     'rest_framework_jwt',
     'django_countries',
-    'rest_framework_swagger',
+    'drf_yasg',
+    'edx_api_doc_tools',
     'storages',
     'enterprise_data',
     'rules.apps.AutodiscoverRulesConfig',
@@ -477,3 +478,7 @@
 ########## ENTERPRISE LEARNER ENGAGEMENT REPORTING
 EXCLUDED_ENGAGEMENT_ENTITY_TYPES = [DISCUSSION]
 ENGAGEMENT_CACHE_TIMEOUT = 1 * 60 * 60  # 1 hour
+
+########## Django 3.2 upgrade settings
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+DEFAULT_HASHING_ALGORITHM = "sha1"

analyticsdataserver/urls.py

@@ -1,6 +1,7 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 from django.views.generic import RedirectView
+from edx_api_doc_tools import make_api_info, make_docs_ui_view
 from rest_framework.authtoken.views import obtain_auth_token
 
 from analyticsdataserver import views
@@ -9,19 +10,30 @@
 admin.site.site_title = admin.site.site_header
 
 urlpatterns = [
-    url(r'^$', RedirectView.as_view(url='/docs')),  # pylint: disable=no-value-for-parameter
-
     url(r'^api-auth/', include('rest_framework.urls', 'rest_framework')),
     url(r'^api-token-auth/', obtain_auth_token),
 
     url(r'^api/', include('analytics_data_api.urls')),
-    url(r'^docs/', views.SwaggerSchemaView.as_view()),
     url(r'^status/$', views.StatusView.as_view(), name='status'),
     url(r'^authenticated/$', views.AuthenticationTestView.as_view(), name='authenticated'),
     url(r'^health/$', views.HealthView.as_view(), name='health'),
 ]
 
 urlpatterns.append(url(r'', include('enterprise_data.urls')))
 
+api_ui_view = make_docs_ui_view(
+    api_info=make_api_info(
+        title="edX Analytics Data API",
+        version="v0",
+        email="program-cosmonauts@edx.org"
+    ),
+    api_url_patterns=urlpatterns
+)
+
+urlpatterns += [
+    url(r'^docs/$', api_ui_view, name='api-docs'),
+    url(r'^$', RedirectView.as_view(url='/docs')),  # pylint: disable=no-value-for-parameter
+]
+
 handler500 = 'analyticsdataserver.views.handle_internal_server_error'  # pylint: disable=invalid-name
 handler404 = 'analyticsdataserver.views.handle_missing_resource_error'  # pylint: disable=invalid-name

analyticsdataserver/views.py

@@ -3,12 +3,10 @@
 from django.conf import settings
 from django.db import connections
 from django.http import HttpResponse
-from rest_framework import permissions, schemas
-from rest_framework.permissions import AllowAny
+from rest_framework import permissions
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
 from rest_framework.views import APIView
-from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
 
 logger = logging.getLogger(__name__)
 
@@ -33,21 +31,6 @@ def _handle_error(status_code):
     return HttpResponse(renderer.render(info), content_type=content_type, status=status_code)
 
 
-class SwaggerSchemaView(APIView):
-    """
-    Renders the swagger schema for the documentation regardless of permissions.
-    """
-    permission_classes = [AllowAny]
-    renderer_classes = [
-        OpenAPIRenderer,
-        SwaggerUIRenderer
-    ]
-
-    def get(self, _request):
-        generator = schemas.SchemaGenerator(title='Analytics API')
-        return Response(generator.get_schema())
-
-
 class StatusView(APIView):
     """
     Simple check to determine if the server is alive

requirements/base.in

@@ -2,20 +2,21 @@
 
 -c constraints.txt
 
+edx-api-doc-tools
 boto==2.42.0                        # MIT
 boto3
+coreapi
 Django                              # BSD License
 django-countries                    # MIT
 python-memcached                    # Python Software Foundation License v2
 djangorestframework                 # BSD
-django-rest-swagger		    # BSD
 djangorestframework-csv             # BSD
 django-storages                     # BSD
 elasticsearch-dsl                   # Apache 2.0
 ordered-set                         # MIT
 tqdm                                # MIT
 urllib3                             # MIT
-Markdown==2.6.6		            # BSD:markdown is used by swagger for rendering the api docs
+Markdown                            # BSD:markdown is used by swagger for rendering the api docs
 edx-ccx-keys
 edx-django-release-util
 edx-opaque-keys

requirements/base.txt

@@ -4,6 +4,8 @@
 #
 #    make upgrade
 #
+asgiref==3.4.1
+    # via django
 boto==2.42.0
     # via -r requirements/base.in
 boto3==1.18.21
@@ -22,17 +24,18 @@ charset-normalizer==2.0.4
     # via requests
 coreapi==2.3.3
     # via
-    #   django-rest-swagger
-    #   openapi-codec
+    #   -r requirements/base.in
+    #   drf-yasg
 coreschema==0.0.4
-    # via coreapi
+    # via
+    #   coreapi
+    #   drf-yasg
 cryptography==3.4.7
     # via
     #   django-fernet-fields
     #   pyjwt
-django==2.2.24
+django==3.2.6
     # via
-    #   -c requirements/common_constraints.txt
     #   -r requirements/base.in
     #   django-cors-headers
     #   django-crum
@@ -41,6 +44,8 @@ django==2.2.24
     #   django-storages
     #   djangorestframework
     #   drf-jwt
+    #   drf-yasg
+    #   edx-api-doc-tools
     #   edx-django-release-util
     #   edx-django-utils
     #   edx-drf-extensions
@@ -61,8 +66,6 @@ django-model-utils==4.1.1
     # via
     #   edx-enterprise-data
     #   edx-rbac
-django-rest-swagger==2.2.0
-    # via -r requirements/base.in
 django-storages==1.8
     # via
     #   -c requirements/constraints.txt
@@ -74,17 +77,20 @@ django-waffle==2.2.1
 djangorestframework==3.12.4
     # via
     #   -r requirements/base.in
-    #   django-rest-swagger
     #   djangorestframework-csv
     #   drf-jwt
+    #   drf-yasg
+    #   edx-api-doc-tools
     #   edx-drf-extensions
     #   rest-condition
 djangorestframework-csv==2.1.1
     # via -r requirements/base.in
-drf-jwt==1.19.0
-    # via
-    #   -c requirements/common_constraints.txt
-    #   edx-drf-extensions
+drf-jwt==1.19.1
+    # via edx-drf-extensions
+drf-yasg==1.20.0
+    # via edx-api-doc-tools
+edx-api-doc-tools==1.4.3
+    # via -r requirements/base.in
 edx-ccx-keys==1.2.1
     # via -r requirements/base.in
 edx-django-release-util==1.1.0
@@ -126,6 +132,8 @@ future==0.18.2
     # via pyjwkest
 idna==3.2
     # via requests
+inflection==0.5.1
+    # via drf-yasg
 itypes==1.2.0
     # via coreapi
 jinja2==3.0.1
@@ -134,18 +142,18 @@ jmespath==0.10.0
     # via
     #   boto3
     #   botocore
-markdown==2.6.6
+markdown==3.3.4
     # via -r requirements/base.in
 markupsafe==2.0.1
     # via jinja2
 newrelic==6.8.0.163
     # via edx-django-utils
-openapi-codec==1.3.2
-    # via django-rest-swagger
 ordered-set==3.1.1
     # via
     #   -c requirements/constraints.txt
     #   -r requirements/base.in
+packaging==21.0
+    # via drf-yasg
 pbr==5.6.0
     # via stevedore
 psutil==5.8.0
@@ -163,6 +171,8 @@ pyjwt[crypto]==2.1.0
     #   edx-rest-api-client
 pymongo==3.12.0
     # via edx-opaque-keys
+pyparsing==2.4.7
+    # via packaging
 python-dateutil==2.8.2
     # via
     #   botocore
@@ -184,14 +194,16 @@ requests==2.26.0
     #   slumber
 rest-condition==1.0.3
     # via edx-drf-extensions
+ruamel.yaml==0.17.10
+    # via drf-yasg
+ruamel.yaml.clib==0.2.6
+    # via ruamel.yaml
 rules==3.0
     # via edx-enterprise-data
 s3transfer==0.5.0
     # via boto3
 semantic-version==2.8.5
     # via edx-drf-extensions
-simplejson==3.17.3
-    # via django-rest-swagger
 six==1.16.0
     # via
     #   djangorestframework-csv
@@ -216,7 +228,9 @@ tqdm==4.62.0
 unicodecsv==0.14.1
     # via djangorestframework-csv
 uritemplate==3.0.1
-    # via coreapi
+    # via
+    #   coreapi
+    #   drf-yasg
 urllib3==1.26.6
     # via
     #   -r requirements/base.in

requirements/common_constraints.txt

@@ -7,11 +7,7 @@
 # link to other information that will help people in the future to remove the
 # pin when possible.  Writing an issue against the offending project and
 # linking to it here is good.
-
-# copy/paste all pins from upstream link. It gives us option to override any pin.
-# otherwise pip-tools gives conflicting errors.
--c common_constraints.txt
-
+ 
 # TODO: Many pinned dependencies should be unpinned and/or moved to this constraints file.
 
 # django-storages version 1.9 drops support for boto storage backend.