Merge pull request #64 from HackSoftware/settings-structure

RadoRado · web-flow · commit 0b874bda84e5 · 2021-11-22T14:37:06.000+02:00
Improve settings structure
diff --git a/.env.example b/.env.example
@@ -1 +1,2 @@
 PYTHONBREAKPOINT=ipdb.set_trace
+SENTRY_DSN=""
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ For `production.py`, we have the following:
 
 ```python
 CORS_ALLOW_ALL_ORIGINS = False
-CORS_ORIGIN_WHITELIST = env.list('DJANGO_CORS_ORIGIN_WHITELIST', default=[])
+CORS_ORIGIN_WHITELIST = env.list('CORS_ORIGIN_WHITELIST', default=[])
 ```
 
 ### DRF
diff --git a/config/asgi.py b/config/asgi.py
@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.base')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.django.base')
 
 application = get_asgi_application()
diff --git a/config/django/__init__.py b/config/django/__init__.py
diff --git a/config/django/base.py b/config/django/base.py
@@ -12,7 +12,7 @@
 
 import os
 
-from .env_reader import env, environ
+from config.env import env, environ
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = environ.Path(__file__) - 3
@@ -166,6 +166,7 @@
     'DEFAULT_AUTHENTICATION_CLASSES': []
 }
 
-from .cors import *  # noqa
-from .sessions import *  # noqa
-from .celery import *  # noqa
+from config.settings.cors import *  # noqa
+from config.settings.sessions import *  # noqa
+from config.settings.celery import *  # noqa
+from config.settings.sentry import *  # noqa
diff --git a/config/django/local.py b/config/django/local.py
@@ -0,0 +1,5 @@
+from .base import *  # noqa
+
+CELERY_BROKER_BACKEND = "memory"
+CELERY_TASK_ALWAYS_EAGER = True
+CELERY_TASK_EAGER_PROPAGATES = True
diff --git a/config/django/production.py b/config/django/production.py
@@ -0,0 +1,23 @@
+from .base import *  # noqa
+
+from config.env import env
+
+DEBUG = env.bool('DJANGO_DEBUG', default=False)
+
+SECRET_KEY = env('SECRET_KEY')
+
+ALLOWED_HOSTS = env.list('ALLOWED_HOSTS', default=[])
+
+CORS_ALLOW_ALL_ORIGINS = False
+CORS_ORIGIN_WHITELIST = env.list('CORS_ORIGIN_WHITELIST', default=[])
+
+SESSION_COOKIE_SECURE = env.bool('SESSION_COOKIE_SECURE', default=True)
+
+# https://docs.djangoproject.com/en/dev/ref/settings/#secure-proxy-ssl-header
+SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
+# https://docs.djangoproject.com/en/dev/ref/settings/#secure-ssl-redirect
+SECURE_SSL_REDIRECT = env.bool("SECURE_SSL_REDIRECT", default=True)
+# https://docs.djangoproject.com/en/dev/ref/middleware/#x-content-type-options-nosniff
+SECURE_CONTENT_TYPE_NOSNIFF = env.bool(
+    "SECURE_CONTENT_TYPE_NOSNIFF", default=True
+)
diff --git a/config/django/test.py b/config/django/test.py
@@ -0,0 +1,16 @@
+from .base import *  # noqa
+
+# Based on https://www.hacksoft.io/blog/optimize-django-build-to-run-faster-on-github-actions
+
+DEBUG = False
+PASSWORD_HASHERS = ['django.contrib.auth.hashers.MD5PasswordHasher']
+
+CELERY_BROKER_BACKEND = "memory"
+CELERY_TASK_ALWAYS_EAGER = True
+CELERY_TASK_EAGER_PROPAGATES = True
+
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+    }
+}
diff --git a/config/env.py b/config/env.py
diff --git a/config/settings/celery.py b/config/settings/celery.py
@@ -1,8 +1,8 @@
-from .env_reader import env
+from config.env import env
 
 # https://docs.celeryproject.org/en/stable/userguide/configuration.html
 
-CELERY_BROKER_URL = env('DJANGO_CELERY_BROKER_URL', default='amqp://guest:guest@localhost//')
+CELERY_BROKER_URL = env('CELERY_BROKER_URL', default='amqp://guest:guest@localhost//')
 CELERY_RESULT_BACKEND = 'django-db'
 
 CELERY_TIMEZONE = 'UTC'
diff --git a/config/settings/production.py b/config/settings/production.py
diff --git a/config/settings/sentry.py b/config/settings/sentry.py
@@ -0,0 +1,77 @@
+from config.env import env
+
+SENTRY_DSN = env('SENTRY_DSN', default='')
+
+if SENTRY_DSN:
+    environment = env("SENTRY_ENVIRONMENT", default="local")
+    # This is related to Sentry's performance monitoring
+    # https://docs.sentry.io/product/performance/
+    # If you don't need it, just remove everything related to `track_performance`
+    track_performance = environment == "production"
+
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+    from sentry_sdk.integrations.celery import CeleryIntegration
+
+    # We are implementing this following the official documentation:
+    # https://docs.sentry.io/platforms/python/performance/
+    # This specific implementation ignores the execute times of all Celery tasks.
+    # But if you want to also traces them, just change the return value for the Celery tasks.
+    def traces_sampler(sampling_context):
+        """
+        We want to track only web transactions, and ignore all Celery transactions.
+        Here's an example context from Celery:
+        {
+            "transaction_context": {
+                "trace_id": "08c7c8b4d8744977a24d40457fc36d0b",
+                "span_id": "9a78f06a999ae7a2",
+                "parent_span_id": "808dca474783eb78",
+                "same_process_as_parent": false,
+                "op": "celery.task",
+                "description": null,
+                "start_timestamp": "datetime here",
+                "timestamp": null,
+                "tags": {
+                    "status": "ok"
+                },
+                "name": "project.app.tasks.task_name",
+                "sampled": null
+            },
+            "parent_sampled": true,
+            "celery_job": {
+                "task": "project.app.tasks.task_name",
+                "args": [],
+                "kwargs": {}
+            }
+        }
+        """
+        if not track_performance:
+            return 0
+
+        transaction_context = sampling_context.get("transaction_context")
+
+        if transaction_context is None:
+            return 0
+
+        op = transaction_context.get("op")
+
+        if op is None:
+            return 0
+
+        if op == "celery.task":
+            return 0
+
+        return 0.5
+
+    sentry_sdk.init(
+        dsn=SENTRY_DSN,
+        environment=environment,
+        traces_sampler=traces_sampler,
+        integrations=[
+            DjangoIntegration(),
+            CeleryIntegration(),
+        ],
+        # If you wish to associate users to errors (assuming you are using
+        # django.contrib.auth) you may enable sending PII data.
+        send_default_pii=False
+    )
diff --git a/config/settings/sessions.py b/config/settings/sessions.py
@@ -1,4 +1,4 @@
-from .env_reader import env
+from config.env import env
 
 
 """
@@ -7,10 +7,10 @@
     1. https://docs.djangoproject.com/en/3.1/ref/settings/#sessions
     2. https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies
 """
-SESSION_COOKIE_AGE = env.int('DJANGO_SESSION_COOKIE_AGE', default=1209600)  # Default - 2 weeks in seconds
-SESSION_COOKIE_HTTPONLY = env.bool('DJANGO_SESSION_COOKIE_HTTPONLY', default=True)
-SESSION_COOKIE_NAME = env('DJANGO_SESSION_COOKIE_NAME', default='sessionid')
-SESSION_COOKIE_SAMESITE = env('DJANGO_SESSION_COOKIE_SAMESITE', default='Lax')
-SESSION_COOKIE_SECURE = env.bool('DJANGO_SESSION_COOKIE_SECURE', default=False)
+SESSION_COOKIE_AGE = env.int('SESSION_COOKIE_AGE', default=1209600)  # Default - 2 weeks in seconds
+SESSION_COOKIE_HTTPONLY = env.bool('SESSION_COOKIE_HTTPONLY', default=True)
+SESSION_COOKIE_NAME = env('SESSION_COOKIE_NAME', default='sessionid')
+SESSION_COOKIE_SAMESITE = env('SESSION_COOKIE_SAMESITE', default='Lax')
+SESSION_COOKIE_SECURE = env.bool('SESSION_COOKIE_SECURE', default=False)
 
-CSRF_USE_SESSIONS = env.bool('DJANGO_CSRF_USE_SESSIONS', default=True)
+CSRF_USE_SESSIONS = env.bool('CSRF_USE_SESSIONS', default=True)
diff --git a/config/wsgi.py b/config/wsgi.py
@@ -11,6 +11,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.base')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.django.base')
 
 application = get_wsgi_application()
diff --git a/manage.py b/manage.py
@@ -5,7 +5,7 @@
 
 
 def main():
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.base')
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.django.base')
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
diff --git a/pytest.ini b/pytest.ini
@@ -1,5 +1,5 @@
 # -- FILE: pytest.ini (or tox.ini)
 [pytest]
-DJANGO_SETTINGS_MODULE = config.settings.base
+DJANGO_SETTINGS_MODULE = config.django.test
 # -- recommended but optional:
 python_files = tests.py test_*.py *_tests.py
diff --git a/styleguide_example/api/urls.py b/styleguide_example/api/urls.py
@@ -4,7 +4,6 @@
     path(
         'auth/', include(('styleguide_example.authentication.urls', 'authentication'))
     ),
-    path('common/', include(('styleguide_example.common.urls', 'common'))),
     path('users/', include(('styleguide_example.users.urls', 'users'))),
     path('errors/', include(('styleguide_example.errors.urls', 'errors'))),
 ]
diff --git a/styleguide_example/common/apis.py b/styleguide_example/common/apis.py
diff --git a/styleguide_example/common/urls.py b/styleguide_example/common/urls.py
diff --git a/styleguide_example/errors/apis.py b/styleguide_example/errors/apis.py
@@ -28,3 +28,10 @@ def get(self, request):
         user_create(email="unique@hacksoft.io", password="user")
 
         return Response()
+
+
+class TriggerUnhandledExceptionApi(APIView):
+    def get(self, request):
+        raise Exception("Oops")
+
+        return Response()
diff --git a/styleguide_example/errors/urls.py b/styleguide_example/errors/urls.py
@@ -1,6 +1,10 @@
 from django.urls import path
 
-from .apis import TriggerErrorApi, TriggerValidateUniqueErrorApi
+from .apis import (
+    TriggerErrorApi,
+    TriggerValidateUniqueErrorApi,
+    TriggerUnhandledExceptionApi
+)
 
 
 urlpatterns = [
@@ -9,7 +13,11 @@
         TriggerErrorApi.as_view()
     ),
     path(
-        "trigger/unique",
+        "trigger/unique/",
         TriggerValidateUniqueErrorApi.as_view()
-    )
+    ),
+    path(
+        "trigger/exception/",
+        TriggerUnhandledExceptionApi.as_view()
+    ),
 ]
diff --git a/styleguide_example/tasks/celery.py b/styleguide_example/tasks/celery.py
@@ -5,7 +5,7 @@
 from celery import Celery
 
 # set the default Django settings module for the 'celery' program.
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.base')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.django.base')
 
 app = Celery('styleguide_example')
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`PYTHONBREAKPOINT=ipdb.set_trace`
	`2`	`+SENTRY_DSN=""`