feat(dev): make dev super fast

Reduces average page load time from over 5 sec to 0.5 sec.
Restarts web server on crash (due to python errors while coding).
Disables DEBUG.
Uses WhiteNoise for static files.

Author: alanzhu0

Ion.egg-info/SOURCES.txt

@@ -401,6 +401,8 @@ intranet/apps/dataimport/management/commands/import_students.py
 intranet/apps/dataimport/management/commands/import_users.py
 intranet/apps/dataimport/management/commands/year_cleanup.py
 intranet/apps/dataimport/migrations/__init__.py
+intranet/apps/django/management/commands/__init__.py
+intranet/apps/django/management/commands/run.py
 intranet/apps/eighth/Hybrid-README.rst
 intranet/apps/eighth/__init__.py
 intranet/apps/eighth/admin.py
@@ -3795,6 +3797,7 @@ migrations/__init__.py
 scripts/build_docs.sh
 scripts/build_ensure_no_changes.sh
 scripts/build_sources.sh
+scripts/dev_autoupdate_static.sh
 scripts/export_fixtures.sh
 scripts/format.sh
 scripts/get_ldif.py

config/docker/docker-compose.yml

@@ -1,73 +1,88 @@
 version: '3.9'
 
-
 services:
   redis:
     container_name: server
     image: redis:latest
     networks:
-    - intranet_net
+      - intranet_net
     expose:
-    - "6379"
+      - "6379"
 
   postgres:
     container_name: database
     image: postgres:latest
     networks:
-    - intranet_net
+      - intranet_net
     expose:
-    - "5432"
+      - "5432"
     environment:
-    - POSTGRES_DB=ion
-    - POSTGRES_USER=ion
-    - POSTGRES_PASSWORD=pwd
+      - POSTGRES_DB=ion
+      - POSTGRES_USER=ion
+      - POSTGRES_PASSWORD=pwd
     volumes:
-    - pgdata:/var/lib/postgresql/data
+      - pgdata:/var/lib/postgresql/data
 
   application:
     container_name: intranet
     image: application
     networks:
-    - intranet_net
-    entrypoint: ["/bin/sh", "-c" , "git config --global --add safe.directory /ion && python3 config/docker/entrypoint.py && chmod +x config/docker/entrypoint.sh && config/docker/entrypoint.sh"]
+      - intranet_net
+    entrypoint:
+      [
+        "/bin/sh",
+        "-c",
+        "git config --global --add safe.directory /ion && \
+         /bin/sh config/docker/entrypoint.sh"
+      ]
     ports:
-    - 8080:8080
+      - 8080:8080
     build:
       context: ../../
       dockerfile: ./config/docker/Dockerfile
     volumes:
-    - ../../:/ion:z
+      - ../../:/ion:z
     depends_on:
-    - redis
-    - postgres
+      - redis
+      - postgres
 
   celery:
     container_name: celery
     image: application
     networks:
-    - intranet_net
-    entrypoint: ["/bin/sh", "-c" , "git config --global --add safe.directory /ion && pipenv run celery --app intranet worker -l info --without-gossip --without-mingle --without-heartbeat -Ofair"]
+      - intranet_net
+    entrypoint:
+      [
+        "/bin/sh",
+        "-c",
+        "git config --global --add safe.directory /ion && \
+         pipenv run celery --app intranet worker -l info --without-gossip --without-mingle --without-heartbeat -Ofair"
+      ]
     depends_on:
-    - application
+      - application
     volumes:
-    - ../../:/ion:z
+      - ../../:/ion:z
 
   celerybeat:
     container_name: celerybeat
     image: application
     networks:
-    - intranet_net
-    entrypoint: ["/bin/sh", "-c" , "git config --global --add safe.directory /ion && pipenv run celery --app intranet beat -l info"]
+      - intranet_net
+    entrypoint:
+      [
+        "/bin/sh",
+        "-c",
+        "git config --global --add safe.directory /ion && \
+         pipenv run celery --app intranet beat -l info"
+      ]
     depends_on:
-    - application
+      - application
     volumes:
-    - ../../:/ion:z
-
+      - ../../:/ion:z
 
 networks:
   intranet_net:
-      driver: bridge
-
+    driver: bridge
 
 volumes:
   pgdata:

config/docker/entrypoint.sh

@@ -1,10 +1,14 @@
 #!/bin/sh
 echo "---- Running entrypoint script ----"
 
-echo "Starting web server..."
-echo ""
+echo "Performing pre-startup tasks..."
+export DEBUG=FALSE  # HUGE performance benefits. Manually enable if you need to debug.
+python3 config/docker/entrypoint.py &  # For initial setup
+sass --watch intranet/static/css:intranet/collected_static/css &  # Automatically compile modified scss files
 
+echo "Starting web server..."
 cat << END
+
 ██╗    ██╗███████╗██╗      ██████╗ ██████╗ ███╗   ███╗███████╗
 ██║    ██║██╔════╝██║     ██╔════╝██╔═══██╗████╗ ████║██╔════╝
 ██║ █╗ ██║█████╗  ██║     ██║     ██║   ██║██╔████╔██║█████╗ 
@@ -18,6 +22,12 @@ cat << END
         ██║   ██║   ██║         ██║██║   ██║██║╚██╗██║╚═╝
         ██║   ╚██████╔╝         ██║╚██████╔╝██║ ╚████║██╗
         ╚═╝    ╚═════╝          ╚═╝ ╚═════╝ ╚═╝  ╚═══╝╚═╝
+
 END
 
-python3 manage.py runserver 0.0.0.0:8080
+# Wrap the run command in a loop so that it restarts if it crashes, e.g. due to a syntax error
+while :  # while true
+do 
+    python3 manage.py run 0.0.0.0:8080  # Custom run command that skips system checks for performance
+    sleep 1
+done

intranet/apps/django/management/commands/__init__.py

@@ -0,0 +1,11 @@
+from django.contrib.staticfiles.management.commands.runserver import Command as RunserverCommand
+
+
+class Command(RunserverCommand):
+    """Run the development server but skip checks for performance."""
+
+    def check(self, *args, **kwargs):
+        self.stdout.write("Skipping system checks.")
+
+    def check_migrations(self, *args, **kwargs):
+        self.stdout.write("Skipping migrations checks.\nRun 'python3 manage.py check' to perform checks.\n\n")

intranet/apps/django/management/commands/run.py

@@ -15,7 +15,9 @@ def __init__(self, get_response):
     def __call__(self, request):
         """Process the response and strip extra newlines from HTML."""
         response = self.get_response(request)
-        is_html = response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;")
+        is_html = (
+            response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;") if "Content-Type" in response else False
+        )  # noqa: E501 pylint: disable=line-too-long
         if is_html and settings.DEBUG:
             response.content = re.sub(r"\n(\s*)\n", "\n", response.content.decode())
             response.content = re.sub(r"^(\s*)\n", "", response.content.decode())
@@ -35,7 +37,9 @@ def __init__(self, get_response):
 
     def __call__(self, request):
         response = self.get_response(request)
-        is_html = response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;")
+        is_html = (
+            response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;") if "Content-Type" in response else False
+        )  # noqa: E501 pylint: disable=line-too-long
         if is_html and request.path.startswith("/eighth/admin"):
             replacement = """</select>
                 <div class="selectize-control selectize-loading">
@@ -57,7 +61,9 @@ def __init__(self, get_response):
 
     def __call__(self, request):
         response = self.get_response(request)
-        is_html = response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;")
+        is_html = (
+            response["Content-Type"] == "text/html" or response["Content-Type"].startswith("text/html;") if "Content-Type" in response else False
+        )  # noqa: E501 pylint: disable=line-too-long
         if is_html:
             response.content = re.sub(r'<a(.*href ?= ?[\'"]http.*)>', r'<a rel="noopener noreferrer"\1>', response.content.decode())
         return response

intranet/middleware/templates.py

@@ -243,6 +243,7 @@
 # Example: "/home/media/media.lawrence.com/static/"
 #
 # This is the folder that Nginx serves as /static in production
+# and WhiteNoise serves in development.
 STATIC_ROOT = os.path.join(PROJECT_ROOT, "collected_static")
 
 # URL prefix for static files.
@@ -433,6 +434,14 @@
     "django_referrer_policy.middleware.ReferrerPolicyMiddleware",  # Sets the Referrer-Policy header
 ]
 
+if not PRODUCTION and not DEBUG:
+    # Serve static files using WhiteNoise in development if DEBUG is False
+    # See http://whitenoise.evans.io/en/stable/django.html
+    WHITENOISE_AUTOREFRESH = True
+    WHITENOISE_USE_FINDERS = True
+    WHITENOISE_MAX_AGE = 0
+    MIDDLEWARE += ["whitenoise.middleware.WhiteNoiseMiddleware"]
+
 # URLconf at urls.py
 ROOT_URLCONF = "intranet.urls"
 
@@ -579,6 +588,7 @@ def get_month_seconds():
     "intranet.apps.auth",
     "intranet.apps.bus",
     "intranet.apps.cslapps",
+    "intranet.apps.django",
     "intranet.apps.eighth",
     "intranet.apps.events",
     "intranet.apps.groups",
@@ -733,6 +743,10 @@ def get_log(name):  # pylint: disable=redefined-outer-name; 'name' is used as th
         "SHOW_TOOLBAR_CALLBACK": "intranet.utils.helpers.debug_toolbar_callback",
     }
 
+    # Disable all panels by default in development for performance
+    if not PRODUCTION:
+        DEBUG_TOOLBAR_CONFIG["DISABLE_PANELS"] = [panel for panel, _ in _panels]
+
     DEBUG_TOOLBAR_PANELS = [t[0] for t in _panels]
 
     # Add middleware

intranet/settings/__init__.py

@@ -40,12 +40,19 @@ def parse_db_url(db_url):
 
 
 def debug_toolbar_callback(request):
-    """Show the debug toolbar to those with the Django staff permission, excluding the Eighth Period
-    office."""
+    """
+    In development:
+        Show the debug toolbar to all users.
+    In production:
+        Show the debug toolbar to those with the Django staff permission, excluding the Eighth Period
+        office.
+    """
+
+    if not settings.PRODUCTION:
+        return True
 
     if request.headers.get("x-requested-with") == "XMLHttpRequest":
         return False
-
     if not hasattr(request, "user"):
         return False
     if not request.user.is_authenticated:

intranet/utils/helpers.py

@@ -0,0 +1,23 @@
+#!/bin/bash
+# FOR DEVELOPMENT ONLY
+# Automatically copies modified static files in intranet/static to intranet/collected_static
+# Run from root ion directory, e.g. ./scripts/dev_autoupdate_static.sh
+# Use this when WHITENOISE_USE_FINDERS is set to False in settings
+
+cd intranet/static
+
+# CSS
+sass --watch css:../collected_static/css &
+
+# Everything else
+inotifywait --format '%w%f %e' -rm -e modify -e create -e delete --exclude '\.scss$' . | 
+while read -r file action; do
+    file=${file#./}  # Remove leading ./ from file path
+    if [ "$action" = "CREATE" ] || [ "$action" = "MODIFY" ]; then
+        cp "$file" ../collected_static/"$file"
+        echo "Copied $file to ../collected_static/$file"
+    elif [ "$action" = "DELETE" ]; then
+        rm ../collected_static/"$file"
+        echo "Deleted ../collected_static/$file"
+    fi
+done