Use use WSGI to serve static files (#49)

Author: codingjoe

.github/workflows/ci.yml

@@ -64,7 +64,6 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - run: python -m pip install .[test]
       - run: python -m pip install django~=${{ matrix.django-version }}.0
-      - run: python -m playwright install
       - run: python -m pytest
       - uses: codecov/codecov-action@v5
         with:
@@ -91,12 +90,32 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - run: python -m pip install .[test]
       - run: python -m pip install django~=${{ matrix.django-version }}.0
-      - run: python -m playwright install
       - run: python -m pytest
       - uses: codecov/codecov-action@v5
         with:
           flags: dj${{ matrix.django-version }}
 
+  pytest-extras:
+    name: PyTest
+    needs:
+      - lint
+    strategy:
+      matrix:
+        extras:
+          - "whitenoise"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: python -m pip install .[test,${{ matrix.extras }}]
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v5
+        with:
+          flags: dj${{ matrix.extras }}
+
   codeql:
     name: CodeQL
     needs: [ dist, pytest-python, pytest-django ]

README.md

@@ -19,9 +19,11 @@ NextGen JavaScript ESM module support for Django.
 Install the package and add it to your `INSTALLED_APPS` setting:
 
 ```bash
-pip install django-esm
+pip install django-esm[whitenoise]
 ```
 
+First, add `django_esm` to your `INSTALLED_APPS` settings:
+
 ```python
 # settings.py
 INSTALLED_APPS = [
@@ -31,25 +33,26 @@ INSTALLED_APPS = [
 ]
 ```
 
-Next, lets configure Django-ESM:
+Optionally: If you are using whitenoise you will need to modify your WSGI application.
 
 ```python
-# settings.py
-from pathlib import Path
+import os
+import pathlib
 
-# add BASE_DIR setting (if not already present)
-BASE_DIR = Path(__file__).resolve().parent.parent
+from django.core.wsgi import get_wsgi_application
 
-ESM = {
-    "PACKAGE_DIR": BASE_DIR,  # path to a directory containing a package.json file
-    "STATIC_DIR": BASE_DIR / "esm", # target directory to collect ES modules into
-    "STATIC_PREFIX": "esm", # prefix for the ES module URLs
-}
+from django_esm.wsgi import ESM
 
-STATICFILES_DIRS = [
-    # …
-    (ESM["STATIC_PREFIX"], ESM["STATIC_DIR"]),
-]
+BASE_DIR = pathlib.Path(__file__).parent.parent
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myproject.settings")
+
+application = get_wsgi_application()
+application = ESM(
+    application,
+    root=BASE_DIR / "staticfiles" / "esm",
+    prefix="esm",
+)
 ```
 
 Finally, add the import map to your base template:
@@ -108,23 +111,6 @@ You need to define your private modules in your `package.json` file:
 }
 ```
 
-### Testing (with Jest)
-
-You can use the `django_esm` package to test your JavaScript modules with Jest.
-Jest v27.4 and upwards will honor `imports` in your `package.json` file.
-
-Before v27.4 that, you can try to use a custom `moduleNameMapper`, like so:
-
-```js
-// jest.config.js
-module.exports = {
-  // …
-  moduleNameMapper: {
-    '^#(.*)$': '<rootDir>/staticfiles/js/$1' // @todo: remove this with Jest >=29.4
-  },
-}
-```
-
 ## How it works
 
 Django ESM works via native JavaScript module support in modern browsers.

django_esm/checks.py

@@ -1,6 +1,5 @@
 import pathlib
 
-from django.conf import settings
 from django.core.checks import Error, Tags, Warning, register
 
 from . import conf
@@ -66,23 +65,12 @@ def check_esm_settings(app_configs, **kwargs):
             )
         )
 
-    if (
-        conf.get_settings().STATIC_PREFIX,
-        conf.get_settings().STATIC_DIR,
-    ) not in settings.STATICFILES_DIRS:
-        errors.append(
-            Error(
-                '\'(ESM["STATIC_PREFIX"], ESM["STATIC_DIR"]),\' must be in STATICFILES_DIRS.',
-                id="esm.E006",
-            )
-        )
-
     if not (pathlib.Path(conf.get_settings().PACKAGE_DIR) / "package.json").exists():
         errors.append(
             Error(
                 f"package.json file not found in: {conf.get_settings().PACKAGE_DIR}",
                 hint='Make sure check your ESM["PACKAGE_DIR"] setting.',
-                id="esm.E007",
+                id="esm.E006",
             )
         )
 
@@ -111,7 +99,7 @@ def check_deployment(app_configs, **kwargs):
                 hint=(
                     'Make sure check your ESM["STATIC_DIR"] setting and to run the "esm" management command to generate the importmap.json file.'
                 ),
-                id="esm.E008",
+                id="esm.E007",
             )
         )
 

django_esm/conf.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 from django.conf import settings
 
 __all__ = ["get_settings"]
@@ -8,9 +10,9 @@ def get_settings():
         "Settings",
         (),
         {
-            "PACKAGE_DIR": "",
-            "STATIC_DIR": "",
-            "STATIC_PREFIX": "",
+            "PACKAGE_DIR": Path(getattr(settings, "BASE_DIR", "")),
+            "STATIC_DIR": Path(getattr(settings, "STATIC_ROOT")) / "esm",
+            "STATIC_PREFIX": "esm",
             **getattr(settings, "ESM", {}),
         },
     )

django_esm/management/commands/collectstatic.py

@@ -29,4 +29,19 @@ def handle(self, **options):
                 stdout=sys.stdout,
                 stderr=sys.stderr,
             )
+            try:
+                import whitenoise  # noqa
+            except ImportError:
+                pass
+            else:
+                subprocess.check_call(  # nosec
+                    [
+                        "python3",
+                        "-m",
+                        "whitenoise.compress",
+                        get_settings().STATIC_DIR,
+                    ],
+                    stdout=sys.stdout,
+                    stderr=sys.stderr,
+                )
         super().handle(**options)

django_esm/management/commands/esm.py

@@ -18,6 +18,12 @@ def add_arguments(self, parser):
             action="store_true",
             help="Watch for changes in the package directory and re-run collect files.",
         )
+        parser.add_argument(
+            "-s",
+            "--serve",
+            action="store_true",
+            help="Serve the files using esimport.",
+        )
 
     def handle(self, *args, **options):
         subprocess.check_call(  # nosec
@@ -30,6 +36,7 @@ def handle(self, *args, **options):
                     get_settings().STATIC_DIR,
                 ]
                 + (["--watch"] if options["watch"] else [])
+                + (["--serve"] if options["serve"] else [])
             ),
             stdout=sys.stdout,
             stderr=sys.stderr,

django_esm/templatetags/esm.py

@@ -1,9 +1,9 @@
 import json
 import pathlib
+import re
 
 from django import template
 from django.conf import settings
-from django.contrib.staticfiles.storage import staticfiles_storage
 from django.utils.safestring import mark_safe
 
 from .. import conf
@@ -19,9 +19,12 @@ def _resolve_importmap_urls(raw_importmap):
         "integrity": {},
     }
     for entry_pointy, filename in raw_importmap["imports"].items():
-        static_url = staticfiles_storage.url(
-            str(pathlib.Path(conf.get_settings().STATIC_PREFIX) / filename)
-        )
+        if re.match("^https?://", filename):
+            static_url = filename
+        else:
+            static_url = str(
+                pathlib.Path("/") / conf.get_settings().STATIC_PREFIX / filename
+            )
         full_importmap["imports"][entry_pointy] = static_url
         full_importmap["integrity"][static_url] = raw_importmap["integrity"][filename]
     return json.dumps(

django_esm/wsgi.py

@@ -0,0 +1,6 @@
+from whitenoise import WhiteNoise
+
+
+class ESM(WhiteNoise):
+    def immutable_file_test(self, path, url):
+        return True

pyproject.toml

@@ -33,14 +33,18 @@ classifiers = [
   "Framework :: Django :: 5.2",
 ]
 requires-python = ">=3.9"
-dependencies = ["django>=4.2.0"]
+dependencies = [
+  "django>=4.2.0",
+]
 
 [project.optional-dependencies]
+whitenoise = [
+  "whitenoise>=6.0",
+]
 test = [
   "pytest",
   "pytest-cov",
   "pytest-django",
-  "pytest-playwright",
 ]
 lint = [
   "bandit==1.8.3",