Fix static files for container images/Debian packages when DEBUG is o…

…n (1.15) (#2788)

Co-authored-by: Jan Klopper <[email protected]>

.env-defaults

@@ -30,3 +30,7 @@ DJANGO_CSRF_TRUSTED_ORIGINS=http://localhost,http://127.0.0.1
 
 # This allows running pytest inside the container
 ROCKY_DB_USER_CREATEDB=CREATEDB
+
+# This is normally False when DEBUG is true, but we override that in settings.py
+# so it possible to set DEBUG to True in production like environments.
+COMPRESS_ENABLED=False

rocky/.ci/.env.test

@@ -1,6 +1,7 @@
 # Rocky
 SECRET_KEY=change-this
 DEBUG=True
+COMPRESS_ENABLED=False
 TWOFACTOR_ENABLED=False
 
 # Postgresql setup for rocky-db and rocky

rocky/rocky/settings.py

@@ -307,12 +307,13 @@
     "django.contrib.staticfiles.finders.AppDirectoriesFinder",
     "compressor.finders.CompressorFinder",
 ]
+COMPRESS_ENABLED = env.bool("COMPRESS_ENABLED", True)
 COMPRESS_OFFLINE = True
 COMPRESS_STORAGE = "compressor.storage.BrotliCompressorFileStorage"
 
 STORAGES = {
     "staticfiles": {
-        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+        "BACKEND": "rocky.storage.RockyStaticFilesStorage",
     },
 }
 
@@ -321,7 +322,7 @@
 
 def immutable_file_test(path, url):
     # Match filename with 12 hex digits before the extension e.g.
-    # app.db8f2edc0c8a.js. Confifguraring this is necessary because whitenoise
+    # app.db8f2edc0c8a.js. Configuring this is necessary because whitenoise
     # doesn't automatically detect the django-compressor files as immutable.
     return _IMMUTABLE_FILE_TEST_PATTERN.match(url)
 

rocky/rocky/storage.py

@@ -0,0 +1,16 @@
+from django.conf import settings
+from whitenoise.storage import CompressedManifestStaticFilesStorage
+
+
+class RockyStaticFilesStorage(CompressedManifestStaticFilesStorage):
+    def url(self, name, force=False):
+        if settings.DEBUG and settings.COMPRESS_ENABLED:
+            # If django-compressor is enabled when DEBUG is also enabled, we
+            # need to force Django to use the hashed urls so that
+            # django-compressor can find the static assets in the offline
+            # manifest. This is needed to make it possible to use DEBUG with
+            # container images or Debian packages where we only ship the hashed
+            # files.
+            force = True
+
+        return super().url(name, force)