Add frontend asset serving based on h-assets package

Enable Via to serve static frontend assets using the same setup as we use in the
h and lms apps.

Author: robertknight

Dockerfile

@@ -1,3 +1,15 @@
+# Stage 1: Build frontend assets
+FROM node:19.8.1-alpine as frontend-build
+
+ENV NODE_ENV production
+COPY .babelrc rollup.config.mjs gulpfile.mjs package.json yarn.lock ./
+COPY via/static ./via/static
+
+RUN yarn install --frozen-lockfile
+RUN yarn build
+
+# Stage 2: Build the rest of the app using build output from Stage 1.
+
 # Unlike most Hypothesis projects this Docker image is based on Debian,
 # so it can use glibc's DNS resolver which supports TCP retries. It can be
 # reverted back to Alpine when Musl v1.2.4 is released.
@@ -24,6 +36,9 @@ COPY requirements/requirements.txt ./
 RUN pip install --no-cache-dir -U pip \
   && pip install --no-cache-dir -r requirements.txt
 
+# Copy frontend assets.
+COPY --from=frontend-build /build build
+
 COPY ./conf/supervisord.conf ./conf/supervisord.conf
 COPY ./conf/nginx/nginx.conf /etc/nginx/nginx.conf
 COPY ./conf/nginx/includes /etc/nginx/includes

requirements/dev.txt

@@ -2,8 +2,10 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements/dev.in
+#    pip-compile --allow-unsafe requirements/dev.in
 #
+appnope==0.1.3
+    # via ipython
 asttokens==2.2.1
     # via stack-data
 attrs==20.3.0
@@ -72,6 +74,8 @@ google-auth-oauthlib==1.0.0
     # via -r requirements/requirements.txt
 gunicorn==20.1.0
     # via -r requirements/requirements.txt
+h-assets==1.0.5
+    # via -r requirements/requirements.txt
 h-pyramid-sentry==1.2.4
     # via -r requirements/requirements.txt
 h-vialib==1.1.0
@@ -196,6 +200,7 @@ pyparsing==3.0.7
 pyramid==2.0
     # via
     #   -r requirements/requirements.txt
+    #   h-assets
     #   h-pyramid-sentry
     #   pyramid-exclog
     #   pyramid-ipython
@@ -321,5 +326,17 @@ zope-interface==5.2.0
     #   wired
 
 # The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools
+pip==23.1.2
+    # via pip-tools
+setuptools==67.7.2
+    # via
+    #   -r requirements/requirements.txt
+    #   gunicorn
+    #   jsonschema
+    #   pastedeploy
+    #   pip-tools
+    #   plaster
+    #   pyramid
+    #   supervisor
+    #   zope-deprecation
+    #   zope-interface

requirements/functests.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements/functests.in
+#    pip-compile --allow-unsafe requirements/functests.in
 #
 attrs==20.3.0
     # via
@@ -51,6 +51,8 @@ google-auth-oauthlib==1.0.0
     # via -r requirements/requirements.txt
 gunicorn==20.1.0
     # via -r requirements/requirements.txt
+h-assets==1.0.5
+    # via -r requirements/requirements.txt
 h-matchers==1.2.15
     # via -r requirements/functests.in
 h-pyramid-sentry==1.2.4
@@ -153,6 +155,7 @@ pyparsing==3.0.7
 pyramid==2.0
     # via
     #   -r requirements/requirements.txt
+    #   h-assets
     #   h-pyramid-sentry
     #   pyramid-exclog
     #   pyramid-jinja2
@@ -256,5 +259,16 @@ zope-interface==5.2.0
     #   wired
 
 # The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools
+pip==23.1.2
+    # via pip-tools
+setuptools==67.7.2
+    # via
+    #   -r requirements/requirements.txt
+    #   gunicorn
+    #   jsonschema
+    #   pastedeploy
+    #   pip-tools
+    #   plaster
+    #   pyramid
+    #   zope-deprecation
+    #   zope-interface

requirements/lint.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements/lint.in
+#    pip-compile --allow-unsafe requirements/lint.in
 #
 astroid==2.15.2
     # via pylint
@@ -85,6 +85,10 @@ gunicorn==20.1.0
     # via
     #   -r requirements/requirements.txt
     #   -r requirements/tests.txt
+h-assets==1.0.5
+    # via
+    #   -r requirements/requirements.txt
+    #   -r requirements/tests.txt
 h-matchers==1.2.15
     # via -r requirements/tests.txt
 h-pyramid-sentry==1.2.4
@@ -234,6 +238,7 @@ pyramid==2.0
     # via
     #   -r requirements/requirements.txt
     #   -r requirements/tests.txt
+    #   h-assets
     #   h-pyramid-sentry
     #   pyramid-exclog
     #   pyramid-jinja2
@@ -389,5 +394,19 @@ zope-interface==5.2.0
     #   wired
 
 # The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools
+pip==23.1.2
+    # via
+    #   -r requirements/tests.txt
+    #   pip-tools
+setuptools==67.7.2
+    # via
+    #   -r requirements/requirements.txt
+    #   -r requirements/tests.txt
+    #   gunicorn
+    #   jsonschema
+    #   pastedeploy
+    #   pip-tools
+    #   plaster
+    #   pyramid
+    #   zope-deprecation
+    #   zope-interface

requirements/requirements.in

@@ -1,5 +1,6 @@
 gunicorn
 checkmatelib
+h-assets
 h-pyramid-sentry
 h-vialib
 importlib_resources

requirements/requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements/requirements.in
+#    pip-compile --allow-unsafe requirements/requirements.in
 #
 attrs==20.3.0
     # via jsonschema
@@ -28,6 +28,8 @@ google-auth-oauthlib==1.0.0
     # via -r requirements/requirements.in
 gunicorn==20.1.0
     # via -r requirements/requirements.in
+h-assets==1.0.5
+    # via -r requirements/requirements.in
 h-pyramid-sentry==1.2.4
     # via -r requirements/requirements.in
 h-vialib==1.1.0
@@ -82,6 +84,7 @@ pyparsing==3.0.7
 pyramid==2.0
     # via
     #   -r requirements/requirements.in
+    #   h-assets
     #   h-pyramid-sentry
     #   pyramid-exclog
     #   pyramid-jinja2
@@ -148,4 +151,12 @@ zope-interface==5.2.0
     #   wired
 
 # The following packages are considered to be unsafe in a requirements file:
-# setuptools
+setuptools==67.7.2
+    # via
+    #   gunicorn
+    #   jsonschema
+    #   pastedeploy
+    #   plaster
+    #   pyramid
+    #   zope-deprecation
+    #   zope-interface

requirements/tests.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements/tests.in
+#    pip-compile --allow-unsafe requirements/tests.in
 #
 attrs==20.3.0
     # via
@@ -57,6 +57,8 @@ google-auth-oauthlib==1.0.0
     # via -r requirements/requirements.txt
 gunicorn==20.1.0
     # via -r requirements/requirements.txt
+h-assets==1.0.5
+    # via -r requirements/requirements.txt
 h-matchers==1.2.15
     # via -r requirements/tests.in
 h-pyramid-sentry==1.2.4
@@ -159,6 +161,7 @@ pyparsing==3.0.7
 pyramid==2.0
     # via
     #   -r requirements/requirements.txt
+    #   h-assets
     #   h-pyramid-sentry
     #   pyramid-exclog
     #   pyramid-jinja2
@@ -267,5 +270,16 @@ zope-interface==5.2.0
     #   wired
 
 # The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools
+pip==23.1.2
+    # via pip-tools
+setuptools==67.7.2
+    # via
+    #   -r requirements/requirements.txt
+    #   gunicorn
+    #   jsonschema
+    #   pastedeploy
+    #   pip-tools
+    #   plaster
+    #   pyramid
+    #   zope-deprecation
+    #   zope-interface

tests/unit/via/assets_test.py

@@ -0,0 +1,8 @@
+from via.assets import includeme
+
+
+def test_includeme(pyramid_config):
+    includeme(pyramid_config)
+
+    assets_env = pyramid_config.registry["assets_env"]
+    assert assets_env.assets_base_url == "/assets"

via/app.py

@@ -30,6 +30,12 @@
 }
 
 
+def configure_jinja2_assets(config):
+    jinja2_env = config.get_jinja2_environment()
+    jinja2_env.globals["asset_url"] = config.registry["assets_env"].url
+    jinja2_env.globals["asset_urls"] = config.registry["assets_env"].urls
+
+
 def load_settings(settings):
     """Load application settings from a dict or environment variables.
 
@@ -65,6 +71,7 @@ def create_app(_=None, **settings):
     config.include("pyramid_services")
     config.include("h_pyramid_sentry")
 
+    config.include("via.assets")
     config.include("via.views")
     config.include("via.services")
 
@@ -84,6 +91,8 @@ def create_app(_=None, **settings):
     # Add this as near to the end of your config as possible:
     config.include("pyramid_sanity")
 
+    config.action(None, configure_jinja2_assets, args=(config,))
+
     app = WhiteNoise(
         config.make_wsgi_app(),
         index_file=True,

via/assets.ini

@@ -0,0 +1,4 @@
+[bundles]
+
+video_player_js =
+  scripts/video_player.bundle.js

via/assets.py

@@ -0,0 +1,23 @@
+"""View for serving static assets under `/assets`."""
+
+import importlib_resources
+from h_assets import Environment, assets_view
+
+
+def includeme(config):
+    # Auto reload asset manifest when it changes in development.
+    auto_reload = config.registry.settings["dev"]
+    via_files = importlib_resources.files("via")
+
+    assets_env = Environment(
+        assets_base_url="/assets",
+        bundle_config_path=via_files / "assets.ini",
+        manifest_path=via_files / "../build/manifest.json",
+        auto_reload=auto_reload,
+    )
+
+    # Store asset environment in registry for use in registering `asset_urls`
+    # Jinja2 helper in `app.py`.
+    config.registry["assets_env"] = assets_env
+
+    config.add_view(route_name="assets", view=assets_view(assets_env))

via/views/__init__.py

@@ -5,6 +5,7 @@
 def add_routes(config):  # pragma: no cover
     """Add routes to pyramid config."""
 
+    config.add_route("assets", "/assets/*subpath")
     config.add_route("index", "/", factory=QueryURLResource)
     config.add_route("get_status", "/_status")
     config.add_route("view_pdf", "/pdf", factory=QueryURLResource)