@venizia/ardor 0.3.6 → 0.3.7

package/dist/presets/app/files/.configs/builders/Dockerfile

@@ -5,7 +5,7 @@
 #   docker build -f {{appPath}}/.configs/builders/Dockerfile -t {{app}} \
 #     --build-arg APP_BUILD_COMMIT="$(git rev-parse HEAD)" \
 #     --build-arg APP_BUILD_BRANCH="$(git rev-parse --abbrev-ref HEAD)" .
-#   docker run --rm -p 8080:8080 -e API_UPSTREAM=http://api:3000 {{app}}
+#   docker run --rm -p 8080:8080 -e API_UPSTREAM=http://api:3000 -e VITE_API_URL=/api {{app}}
 #
 # The preset cannot know which workspace packages this app needs, so the whole context is copied (the
 # .dockerignore at the root filters it), then installed and built. A project can list the packages by
@@ -64,6 +64,11 @@ LABEL org.opencontainers.image.revision="${APP_BUILD_COMMIT}"
 COPY --from=builder /home/bun/app/{{appPath}}/.configs/builders/nginx.conf.template /etc/nginx/templates/default.conf.template
 COPY --from=builder --chown=101:101 /home/bun/app/{{appPath}}/dist /usr/share/nginx/html
 
+# The runtime config: this script writes /usr/share/nginx/html/config.js from the VITE_ environment variables
+# when the container starts. 0755 because the base entrypoint skips a script without the executable bit; the
+# file it rewrites is the one the build copied from src/public, owned by 101 above.
+COPY --from=builder --chmod=0755 /home/bun/app/{{appPath}}/.configs/builders/docker-entrypoint.d/40-runtime-config.sh /docker-entrypoint.d/40-runtime-config.sh
+
 # Where /api goes: a compose service name, a cluster service, an address (an origin, with no path).
 ENV API_UPSTREAM=http://api:3000
 
@@ -71,7 +76,8 @@ ENV API_UPSTREAM=http://api:3000
 # gives to `resolver`: nginx looks the upstream up per request, so the container starts without it.
 ENV NGINX_ENTRYPOINT_LOCAL_RESOLVERS=1
 
-# No ENTRYPOINT on purpose: the base image's /docker-entrypoint.sh renders the templates.
+# No ENTRYPOINT on purpose: the base image's /docker-entrypoint.sh renders the templates and runs the
+# scripts of /docker-entrypoint.d/ (a custom ENTRYPOINT would replace it and skip both).
 EXPOSE 8080
 
 CMD ["nginx", "-g", "daemon off;"]

package/dist/presets/app/files/.configs/builders/docker-entrypoint.d/40-runtime-config.sh

@@ -0,0 +1,93 @@
+#!/bin/sh
+# Writes /usr/share/nginx/html/config.js from the container's environment, so one built image serves
+# every environment: `docker run -e VITE_API_URL=https://api.example.com image`.
+#
+# The nginx image runs every executable file of /docker-entrypoint.d/ in `sort -V` order before it starts
+# nginx. The 40 puts this after the base image's own scripts. A script without the executable bit is
+# skipped, hence `COPY --chmod=0755` in the Dockerfile; the Dockerfile must not declare an ENTRYPOINT,
+# which would replace the script that runs this directory.
+#
+# What is published: the variables named VITE_ followed by capitals, digits and underscores, and nothing
+# else. That is Vite's own rule for what reaches the browser, so the same names work in dev and here.
+# Every published value is readable by every visitor: never put a secret in a VITE_ variable. A name
+# with SECRET, PASSWORD or TOKEN in it stops the container, to catch that mistake early (a name with KEY
+# is fine: public keys are normal). Values are escaped as JavaScript string content, so no value can
+# end its string or the file.
+#
+# RUNTIME_CONFIG_TARGET names another file, for the tests; it is not a VITE_ name, so it is never published.
+set -eu
+
+TARGET="${RUNTIME_CONFIG_TARGET:-/usr/share/nginx/html/config.js}"
+
+# A read-only file is one the operator mounted over config.js: keep it as it is.
+if [ -e "$TARGET" ] && [ ! -w "$TARGET" ]; then
+  echo "[runtime-config] $TARGET is read-only (mounted): keeping the supplied file"
+  exit 0
+fi
+
+# One awk program, so the values never pass through a shell expansion. ENVIRON holds them as they are.
+BODY=$(awk '
+function escape(text,   result, index_, character) {
+  result = ""
+  for (index_ = 1; index_ <= length(text); index_++) {
+    character = substr(text, index_, 1)
+    result = result ((character in escapes) ? escapes[character] : character)
+  }
+  return result
+}
+
+BEGIN {
+  for (code = 1; code < 32; code++) {
+    escapes[sprintf("%c", code)] = sprintf("\\u%04x", code)
+  }
+  escapes[sprintf("%c", 127)] = "\\u007f"
+  escapes["\\"] = "\\\\"
+  escapes["\""] = "\\\""
+  escapes["<"] = "\\u003c"
+  escapes[">"] = "\\u003e"
+  escapes["&"] = "\\u0026"
+
+  count = 0
+  failed = 0
+  for (name in ENVIRON) {
+    if (name !~ /^VITE_[A-Z0-9_]+$/) {
+      continue
+    }
+    if (name ~ /SECRET|PASSWORD|TOKEN/) {
+      print "[runtime-config] " name " looks like a secret, and every VITE_ variable is published to every visitor: rename it or keep it out of VITE_" > "/dev/stderr"
+      failed = 1
+      continue
+    }
+    names[++count] = name
+  }
+  if (failed) {
+    exit 1
+  }
+
+  for (i = 2; i <= count; i++) {
+    current = names[i]
+    for (j = i - 1; j >= 1 && names[j] > current; j--) {
+      names[j + 1] = names[j]
+    }
+    names[j + 1] = current
+  }
+
+  for (i = 1; i <= count; i++) {
+    printf "  \"%s\": \"%s\"%s\n", names[i], escape(ENVIRON[names[i]]), (i < count ? "," : "")
+  }
+}
+' </dev/null) || {
+  echo "[runtime-config] FATAL: config.js was not written" >&2
+  exit 1
+}
+
+{
+  printf 'window.__APP_CONFIG__ = Object.freeze({'
+  if [ -n "$BODY" ]; then
+    printf '\n%s\n' "$BODY"
+  fi
+  printf '});\n'
+} >"$TARGET"
+
+NAMES=$(printf '%s\n' "$BODY" | sed -n 's/^  "\([A-Z0-9_]*\)": .*/\1/p' | tr '\n' ' ')
+echo "[runtime-config] wrote $TARGET with: ${NAMES:-nothing}"

package/dist/presets/app/files/.configs/builders/nginx.conf.template

@@ -20,6 +20,12 @@ server {
     proxy_set_header X-Forwarded-Proto $scheme;
   }
 
+  # The runtime config is written when the container starts and has no hash in its name: never cached.
+  location = /config.js {
+    add_header Cache-Control "no-store";
+    try_files $uri =404;
+  }
+
   # The built files carry a content hash in their name, so a browser may keep them for good.
   location /assets/ {
     expires 1y;

package/dist/presets/app/files/_env.example

@@ -6,3 +6,8 @@ PORT={{devPort}}
 
 # The backend the dev server forwards /api to. Empty: the one chosen when the app was added (none, if it had no backend).
 API_URL={{apiUrl}}
+
+# The API the app calls. Empty: /api. In dev the app reads it as import.meta.env.VITE_API_URL; in the image it
+# is the VITE_API_URL given to `docker run -e`, which config.js carries to the browser when the container starts.
+# Every VITE_ variable is public: anything published is readable by every visitor. Never put a secret in one.
+VITE_API_URL=

package/dist/presets/app/files/src/application.test.ts

@@ -1,10 +1,11 @@
 import 'reflect-metadata';
 
-import { describe, expect, test } from 'bun:test';
+import { afterEach, describe, expect, test } from 'bun:test';
 
 import {
   BaseArdorApplication,
   CoreBindings,
+  RUNTIME_CONFIG_GLOBAL,
   type IApplicationInfo,
   type IArtifactIndex,
 } from '@venizia/ardor';
@@ -24,14 +25,26 @@ class TestApplication extends BaseArdorApplication {
   bindContext(): void {}
 }
 
+const restUrlOf = async (): Promise<unknown> => {
+  const application = new TestApplication();
+
+  await application.start();
+
+  return application.get<{ url: string }>({ key: CoreBindings.REST_DATA_PROVIDER_OPTIONS }).url;
+};
+
 describe('AdminConfiguration', () => {
+  afterEach(() => {
+    Reflect.deleteProperty(globalThis, RUNTIME_CONFIG_GLOBAL);
+  });
+
   test('binds the REST data provider options under their key', async () => {
-    const application = new TestApplication();
+    expect(await restUrlOf()).toBe('/api');
+  });
 
-    await application.start();
+  test('the API url is the one config.js wrote when the container started', async () => {
+    Reflect.set(globalThis, RUNTIME_CONFIG_GLOBAL, { VITE_API_URL: 'https://api.example.com' });
 
-    expect(application.get({ key: CoreBindings.REST_DATA_PROVIDER_OPTIONS })).toMatchObject({
-      url: '/api',
-    });
+    expect(await restUrlOf()).toBe('https://api.example.com');
   });
 });

package/dist/presets/app/files/src/configurations/admin.configuration.ts

@@ -5,6 +5,7 @@ import {
   DefaultI18nProvider,
   DefaultRestDataProvider,
   englishMessages,
+  getRuntimeConfig,
   inject,
   provide,
 } from '@venizia/ardor';
@@ -20,8 +21,16 @@ export class AdminConfiguration {
 
   @provide({ key: CoreBindings.REST_DATA_PROVIDER_OPTIONS })
   restDataProviderOptions() {
-    // No sign-in: no request carries an Authorization header.
-    return { url: '/api', noAuthPathRegex: /./ };
+    // No sign-in: no request carries an Authorization header. The API is `/api` (the image's nginx
+    // forwards it to API_UPSTREAM) unless VITE_API_URL says otherwise: set in .env in dev, or written to
+    // config.js when the container starts, so one built image serves every environment.
+    const url = getRuntimeConfig({
+      key: 'VITE_API_URL',
+      buildTimeEnv: import.meta.env,
+      defaultValue: '/api',
+    });
+
+    return { url, noAuthPathRegex: /./ };
   }
 
   @provide({ key: CoreBindings.I18N_PROVIDER_OPTIONS })

package/dist/presets/app/files/src/index.html

@@ -9,6 +9,9 @@
   </head>
   <body>
     <div id="root"></div>
+    <!-- The runtime config: a classic script, so it runs before the module below. The image rewrites it when the
+         container starts; src/public/config.js is the empty one that dev and the build use. -->
+    <script src="/config.js"></script>
     <script type="module" src="/main.tsx"></script>
   </body>
 </html>

package/dist/presets/app/files/src/public/config.js

@@ -0,0 +1,3 @@
+// The runtime config. The image's entrypoint replaces this file when the container starts, with the VITE_
+// environment variables; in dev and in the build it is empty, and the app falls back to import.meta.env.
+window.__APP_CONFIG__ = {};

package/dist/presets/app/preset.json

@@ -13,7 +13,7 @@
   "dependencies": {
     "@reduxjs/toolkit": "^2.13.0",
     "@tanstack/react-query": "^5.104.5",
-    "@venizia/ardor": "0.3.6",
+    "@venizia/ardor": "0.3.7",
     "@venizia/ignis-connectors": "0.3.6",
     "@venizia/ignis-filter": "0.3.6",
     "@venizia/ignis-helpers": "0.3.6",

package/dist/presets/lib/preset.json

@@ -5,7 +5,7 @@
   "devDependencies": {
     "@types/bun": "^1.4.3",
     "@types/react": "^19",
-    "@venizia/ardor": "^0.3.6",
+    "@venizia/ardor": "^0.3.7",
     "@venizia/dev-configs": "0.3.6",
     "eslint": "^10.13.0",
     "oxfmt": "0.74.0",
@@ -18,7 +18,7 @@
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "@venizia/ardor": "^0.3.6",
+    "@venizia/ardor": "^0.3.7",
     "react": "^19.3.1",
     "react-dom": "^19.3.1",
     "react-router-dom": "^7.18.4",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ardor",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "ARDOR - frontend application framework for the VENIZIA family. One entry point over ardor-kernel, ardor-react and ardor-admin: IGNIS inversion of control, a REST data layer, auth and i18n providers, and the React bindings for a react-admin application.",
   "keywords": [
     "ardor",
@@ -79,9 +79,9 @@
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ardor-admin": "0.3.6",
-    "@venizia/ardor-kernel": "0.3.6",
-    "@venizia/ardor-react": "0.3.6"
+    "@venizia/ardor-admin": "0.3.7",
+    "@venizia/ardor-kernel": "0.3.7",
+    "@venizia/ardor-react": "0.3.7"
   },
   "peerDependencies": {
     "@reduxjs/toolkit": ">=2.13.0",