fix(docker): generate env.js at runtime with escaping (#7)

Author: KFilippopolitis

.gitignore

@@ -49,6 +49,8 @@ Thumbs.db
 # Compiled source
 *.js
 *.js.map
+!src/assets/env.js
+!src/assets/env.template.js
 
 # TypeScript type definition files
 *.d.ts

Dockerfile

@@ -36,8 +36,10 @@ ENV PLATFORM_BACKEND_SERVER=platform-backend-service:8080 \
     JUPYTER_SERVER=jupyterhub:8000 \
     JUPYTER_CONTEXT=notebook \
     JUPYTER_LANDING_PATH=/hub/spawn
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+RUN chmod +x /docker-entrypoint.sh
 COPY nginx.conf.template /etc/nginx/templates/default.conf.template
 RUN rm -rf /usr/share/nginx/html/*
 COPY --from=build /app/dist/fl-platform/browser /usr/share/nginx/html
 EXPOSE 80
-CMD ["/bin/sh", "-c", "envsubst '$$PLATFORM_BACKEND_SERVER $$PLATFORM_BACKEND_CONTEXT $$NOTEBOOK_ENABLED $$JUPYTER_SERVER $$JUPYTER_CONTEXT' < /etc/nginx/templates/default.conf.template > /etc/nginx/conf.d/default.conf && envsubst '$$FRONTEND_VERSION $$BACKEND_VERSION $$EXAFLOW_VERSION $$MIP_VERSION $$NOTEBOOK_ENABLED $$JUPYTER_CONTEXT $$JUPYTER_LANDING_PATH' < /usr/share/nginx/html/assets/env.template.js > /usr/share/nginx/html/assets/env.js && exec nginx -g 'daemon off;'"]
+CMD ["/docker-entrypoint.sh"]

docker-entrypoint.sh

@@ -0,0 +1,38 @@
+#!/bin/sh
+
+set -eu
+
+escape_js() {
+  printf '%s' "$1" | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g'
+}
+
+FRONTEND_VERSION_ESCAPED=$(escape_js "${FRONTEND_VERSION:-}")
+BACKEND_VERSION_ESCAPED=$(escape_js "${BACKEND_VERSION:-}")
+EXAFLOW_VERSION_ESCAPED=$(escape_js "${EXAFLOW_VERSION:-}")
+MIP_VERSION_ESCAPED=$(escape_js "${MIP_VERSION:-}")
+NOTEBOOK_ENABLED_ESCAPED=$(escape_js "${NOTEBOOK_ENABLED:-0}")
+JUPYTER_CONTEXT_ESCAPED=$(escape_js "${JUPYTER_CONTEXT:-notebook}")
+JUPYTER_LANDING_PATH_ESCAPED=$(escape_js "${JUPYTER_LANDING_PATH:-/hub/spawn}")
+
+envsubst '$PLATFORM_BACKEND_SERVER $PLATFORM_BACKEND_CONTEXT $NOTEBOOK_ENABLED $JUPYTER_SERVER $JUPYTER_CONTEXT' \
+  < /etc/nginx/templates/default.conf.template \
+  > /etc/nginx/conf.d/default.conf
+
+mkdir -p /usr/share/nginx/html/assets
+
+cat > /usr/share/nginx/html/assets/env.js <<EOF
+(function (window) {
+    window.__env = window.__env || {};
+
+    // Environment variables
+    window.__env.FRONTEND_VERSION = "${FRONTEND_VERSION_ESCAPED}";
+    window.__env.BACKEND_VERSION = "${BACKEND_VERSION_ESCAPED}";
+    window.__env.EXAFLOW_VERSION = "${EXAFLOW_VERSION_ESCAPED}";
+    window.__env.MIP_VERSION = "${MIP_VERSION_ESCAPED}";
+    window.__env.NOTEBOOK_ENABLED = "${NOTEBOOK_ENABLED_ESCAPED}";
+    window.__env.JUPYTER_CONTEXT_PATH = "/${JUPYTER_CONTEXT_ESCAPED}";
+    window.__env.JUPYTER_LANDING_PATH = "${JUPYTER_LANDING_PATH_ESCAPED}";
+}(this));
+EOF
+
+exec nginx -g 'daemon off;'

src/assets/env.js

@@ -0,0 +1,12 @@
+(function (window) {
+    window.__env = window.__env || {};
+
+    // Environment variables
+    window.__env.FRONTEND_VERSION = '';
+    window.__env.BACKEND_VERSION = '';
+    window.__env.EXAFLOW_VERSION = '';
+    window.__env.MIP_VERSION = '';
+    window.__env.NOTEBOOK_ENABLED = '0';
+    window.__env.JUPYTER_CONTEXT_PATH = '/notebook';
+    window.__env.JUPYTER_LANDING_PATH = '/hub/spawn';
+}(this));

src/assets/env.template.js

@@ -0,0 +1,12 @@
+(function (window) {
+    window.__env = window.__env || {};
+
+    // Environment variables
+    window.__env.FRONTEND_VERSION = '${FRONTEND_VERSION}';
+    window.__env.BACKEND_VERSION = '${BACKEND_VERSION}';
+    window.__env.EXAFLOW_VERSION = '${EXAFLOW_VERSION}';
+    window.__env.MIP_VERSION = '${MIP_VERSION}';
+    window.__env.NOTEBOOK_ENABLED = '${NOTEBOOK_ENABLED}';
+    window.__env.JUPYTER_CONTEXT_PATH = '/${JUPYTER_CONTEXT}';
+    window.__env.JUPYTER_LANDING_PATH = '${JUPYTER_LANDING_PATH}';
+}(this));