Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1f087581d4 | ||
|
|
2147fcec35 | ||
|
|
d99b909f9f | ||
|
|
49b1d5f0ba | ||
|
|
6475696709 |
@@ -84,13 +84,23 @@ jobs:
|
||||
run: pnpm test
|
||||
|
||||
# Sentry toont bij elke fout uit welke commit de build komt
|
||||
# Dit artefact (dist) is ook wat naar productie gaat: bewust zonder
|
||||
# OFFERINGS_URL, dus met de gecommitte pakketlijst. De testbuild met de
|
||||
# pakketten uit het CMS is job build-test.
|
||||
# Dit artefact (dist) is ook wat naar productie gaat: met de gecommitte
|
||||
# pakketlijst (snapshot), zonder testadres en met dicht formulier. De
|
||||
# CMS-host schrijft de actuele gegevens bij elk verzoek in de HTML.
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
run: |
|
||||
# Zonder deze waarden meet de site stilletjes niets: liever een rode build
|
||||
for name in VITE_SENTRY_DSN VITE_UMAMI_SCRIPT_URL VITE_UMAMI_WEBSITE_ID; do
|
||||
[ -n "${!name}" ] || { echo "$name ontbreekt: stel de Gitea-variabele PROD_${name#VITE_} in"; exit 1; }
|
||||
done
|
||||
pnpm build
|
||||
env:
|
||||
VITE_RELEASE: ${{ github.sha }}
|
||||
# Monitoring van de productiesite (src/monitoring/config.ts)
|
||||
VITE_APP_ENV: production
|
||||
VITE_SENTRY_DSN: ${{ vars.PROD_SENTRY_DSN }}
|
||||
VITE_UMAMI_SCRIPT_URL: ${{ vars.PROD_UMAMI_SCRIPT_URL }}
|
||||
VITE_UMAMI_WEBSITE_ID: ${{ vars.PROD_UMAMI_WEBSITE_ID }}
|
||||
|
||||
- name: Audit (productiepakketten, blokkerend)
|
||||
run: pnpm audit:deps
|
||||
@@ -105,10 +115,10 @@ jobs:
|
||||
path: web/dist/client/
|
||||
retention-days: 7
|
||||
|
||||
# De build voor de testsite: zelfde code als dist, maar met de pakketten uit
|
||||
# het CMS van de testomgeving (OFFERINGS_URL uit de repo-variabele
|
||||
# ASF_OFFERINGS_URL_TEST). Productie krijgt dit artefact nooit: die blijft op
|
||||
# dist met de gecommitte lijst tot er een productie-CMS is.
|
||||
# De build voor de testsite: zelfde code als dist, maar met het eigen adres
|
||||
# van de testsite en het formulier open. De pakketten komen niet meer uit
|
||||
# het CMS bij de build: de CMS-host injecteert ze bij elk verzoek.
|
||||
# Productie krijgt dit artefact nooit.
|
||||
build-test:
|
||||
needs: check
|
||||
if: (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_test == 'true') || (github.event_name == 'push' && github.ref == 'refs/heads/master')
|
||||
@@ -137,11 +147,20 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build (testomgeving, pakketten uit het CMS)
|
||||
run: pnpm build
|
||||
- name: Build (testomgeving)
|
||||
run: |
|
||||
# Zonder deze waarden meet de site stilletjes niets: liever een rode build
|
||||
for name in VITE_SENTRY_DSN VITE_UMAMI_SCRIPT_URL VITE_UMAMI_WEBSITE_ID; do
|
||||
[ -n "${!name}" ] || { echo "$name ontbreekt: stel de Gitea-variabele TEST_${name#VITE_} in"; exit 1; }
|
||||
done
|
||||
pnpm build
|
||||
env:
|
||||
VITE_RELEASE: ${{ github.sha }}
|
||||
OFFERINGS_URL: ${{ vars.ASF_OFFERINGS_URL_TEST }}
|
||||
# Monitoring van de testsite (src/monitoring/config.ts)
|
||||
VITE_APP_ENV: test
|
||||
VITE_SENTRY_DSN: ${{ vars.TEST_SENTRY_DSN }}
|
||||
VITE_UMAMI_SCRIPT_URL: ${{ vars.TEST_UMAMI_SCRIPT_URL }}
|
||||
VITE_UMAMI_WEBSITE_ID: ${{ vars.TEST_UMAMI_WEBSITE_ID }}
|
||||
# De testsite staat op zichzelf: canonical, og:url, og:image,
|
||||
# JSON-LD en sitemap wijzen naar het eigen adres, zodat een gedeelde
|
||||
# link (WhatsApp, Discord) ook zijn eigen plaatje toont. Alleen in
|
||||
@@ -193,18 +212,26 @@ jobs:
|
||||
- name: Upload naar de testserver
|
||||
env:
|
||||
# Secrets via env, zodat bash tekens als $ of ` niet nog eens uitlegt
|
||||
SSHPASS: ${{ secrets.PI_MAIN_PASSWORD }}
|
||||
SSH_PORT: ${{ secrets.PI_MAIN_PORT }}
|
||||
SSH_USER: ${{ secrets.PI_MAIN_USERNAME }}
|
||||
SSH_HOST: ${{ secrets.PI_MAIN_ADDRESS }}
|
||||
DEPLOY_PATH: ${{ vars.DEPLOY_PATH_TEST }}
|
||||
SSH_KEY: ${{ secrets.TEST_HOST_SSH_KEY }}
|
||||
SSH_PORT: ${{ secrets.TEST_HOST_PORT }}
|
||||
SSH_USER: ${{ secrets.TEST_HOST_USERNAME }}
|
||||
SSH_HOST: ${{ secrets.TEST_HOST_ADDRESS }}
|
||||
DEPLOY_PATH: ${{ vars.TEST_DEPLOY_PATH }}
|
||||
run: |
|
||||
case "$DEPLOY_PATH" in
|
||||
''|'/'|*' '*) echo "DEPLOY_PATH_TEST ontbreekt of is ongeldig: '$DEPLOY_PATH'"; exit 1 ;;
|
||||
''|'/'|*' '*) echo "TEST_DEPLOY_PATH ontbreekt of is ongeldig: '$DEPLOY_PATH'"; exit 1 ;;
|
||||
esac
|
||||
sudo apt-get update && sudo apt-get install -y sshpass
|
||||
SSH="sshpass -e ssh -p $SSH_PORT -o StrictHostKeyChecking=accept-new $SSH_USER@$SSH_HOST"
|
||||
$SSH "set -e
|
||||
for name in SSH_KEY SSH_PORT SSH_USER SSH_HOST; do
|
||||
[ -n "${!name}" ] || { echo "Secret TEST_HOST_${name#SSH_} ontbreekt"; exit 1; }
|
||||
done
|
||||
# Inloggen met de deploysleutel, geen wachtwoord. De sleutel gaat naar
|
||||
# een tijdelijk bestand dat na afloop verdwijnt.
|
||||
KEY_FILE="$(mktemp)"
|
||||
trap 'rm -f "$KEY_FILE"' EXIT
|
||||
printf '%s\n' "$SSH_KEY" > "$KEY_FILE"
|
||||
chmod 600 "$KEY_FILE"
|
||||
SSH_OPTS=(-i "$KEY_FILE" -o IdentitiesOnly=yes -o BatchMode=yes -o StrictHostKeyChecking=accept-new)
|
||||
ssh -p "$SSH_PORT" "${SSH_OPTS[@]}" "$SSH_USER@$SSH_HOST" "set -e
|
||||
if [ -e '$DEPLOY_PATH/wp-config.php' ] || [ -d '$DEPLOY_PATH/wp-content' ]; then
|
||||
echo 'Geweigerd: $DEPLOY_PATH bevat WordPress'; exit 1
|
||||
fi
|
||||
@@ -215,7 +242,7 @@ jobs:
|
||||
# mag. Zo zijn groeps-schrijfrechten op de doelmap genoeg.
|
||||
# dotglob: ook bestanden die met een punt beginnen gaan mee.
|
||||
shopt -s dotglob
|
||||
sshpass -e scp -P "$SSH_PORT" -o StrictHostKeyChecking=accept-new -r dist/* "$SSH_USER@$SSH_HOST:$DEPLOY_PATH/"
|
||||
scp -P "$SSH_PORT" "${SSH_OPTS[@]}" -r dist/* "$SSH_USER@$SSH_HOST:$DEPLOY_PATH/"
|
||||
echo "Gedeployd naar test: ${GITHUB_REF_NAME} (${GITHUB_SHA::7})"
|
||||
|
||||
# Vergelijkt wat de server teruggeeft met dist. Met de oude nginx-config
|
||||
@@ -223,18 +250,17 @@ jobs:
|
||||
# dus staan voor de deploy (zie pi-install-instructions.md).
|
||||
- name: Controle na deploy
|
||||
env:
|
||||
HEALTH_URL: ${{ vars.HEALTH_CHECK_URL_TEST }}
|
||||
# 'true' zodra test.andreaslop.nl door de CMS-host (Api.AndreaSlopFotografie)
|
||||
# wordt bediend in plaats van nginx: dan controleert het script ook de
|
||||
# exacte CSP en de CMS-routes. Zet hem om samen met de proxy-route.
|
||||
SERVED_BY_CMS: ${{ vars.ASF_TEST_SERVED_BY_CMS }}
|
||||
HEALTH_URL: ${{ vars.TEST_HEALTH_URL }}
|
||||
# De CSP komt uit dezelfde bron als de build (Umami en Sentry)
|
||||
VITE_APP_ENV: test
|
||||
VITE_SENTRY_DSN: ${{ vars.TEST_SENTRY_DSN }}
|
||||
VITE_UMAMI_SCRIPT_URL: ${{ vars.TEST_UMAMI_SCRIPT_URL }}
|
||||
VITE_UMAMI_WEBSITE_ID: ${{ vars.TEST_UMAMI_WEBSITE_ID }}
|
||||
run: |
|
||||
if [ -z "$HEALTH_URL" ]; then echo "Geen HEALTH_CHECK_URL_TEST ingesteld; overgeslagen"; exit 0; fi
|
||||
if [ "$SERVED_BY_CMS" = "true" ]; then
|
||||
if [ -z "$HEALTH_URL" ]; then echo "Geen TEST_HEALTH_URL ingesteld; overgeslagen"; exit 0; fi
|
||||
# test.andreaslop.nl wordt door de CMS-host bediend: het script
|
||||
# controleert ook de exacte CSP en de CMS-routes
|
||||
EXPECTED_CSP="$(node config/printCsp.ts)" bash deploy/verify-deployment.sh "$HEALTH_URL" dist --test --cms
|
||||
else
|
||||
bash deploy/verify-deployment.sh "$HEALTH_URL" dist --test
|
||||
fi
|
||||
echo "Test bereikbaar en gelijk aan de build"
|
||||
|
||||
# Lighthouse tegen de gebouwde site (mobiel en desktop)
|
||||
@@ -343,17 +369,19 @@ jobs:
|
||||
name: dist
|
||||
path: web/dist
|
||||
|
||||
# FTP met TLS (verplicht) naar de webhoster, in drie rondes (zie
|
||||
# deploy/upload-production.sh): eerst alles behalve HTML en web.config,
|
||||
# dan web.config en alle HTML, en pas daarna oude bestanden opruimen. Zo
|
||||
# verwijst een bezoeker nooit naar een bestand dat er nog niet staat.
|
||||
# Deze job kan pas draaien als er een webhost is.
|
||||
- name: Upload naar productie (FTPS)
|
||||
# Gewone FTP (het productiepakket biedt geen FTPS) naar de map met
|
||||
# voorgerenderde pagina's van de CMS-host, in drie rondes (zie
|
||||
# deploy/upload-production.sh): eerst alles behalve HTML, dan alle HTML,
|
||||
# en pas daarna oude bestanden opruimen. Zo verwijst een bezoeker nooit
|
||||
# naar een bestand dat er nog niet staat. De host zelf en zijn web.config
|
||||
# komen uit de CMS-pijplijn. Deze job kan pas draaien als er een webhost is.
|
||||
- name: Upload naar productie (gewone FTP)
|
||||
env:
|
||||
FTP_HOST: ${{ secrets.FTP_HOST }}
|
||||
FTP_USER: ${{ secrets.FTP_USERNAME }}
|
||||
LFTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
|
||||
FTP_DIR: ${{ vars.FTP_REMOTE_DIR || 'wwwroot' }}
|
||||
FTP_HOST: ${{ secrets.PROD_HOST_ADDRESS }}
|
||||
FTP_PORT: ${{ secrets.PROD_HOST_PORT }}
|
||||
FTP_USER: ${{ secrets.PROD_HOST_USERNAME }}
|
||||
LFTP_PASSWORD: ${{ secrets.PROD_HOST_PASSWORD }}
|
||||
FTP_DIR: ${{ vars.PROD_DEPLOY_PATH || 'wwwroot' }}
|
||||
run: |
|
||||
sudo apt-get update && sudo apt-get install -y lftp
|
||||
bash deploy/upload-production.sh dist "$FTP_DIR"
|
||||
@@ -361,8 +389,8 @@ jobs:
|
||||
|
||||
- name: Controle na deploy
|
||||
env:
|
||||
HEALTH_URL: ${{ vars.HEALTH_CHECK_URL_PRODUCTION }}
|
||||
HEALTH_URL: ${{ vars.PROD_HEALTH_URL }}
|
||||
run: |
|
||||
if [ -z "$HEALTH_URL" ]; then echo "Geen HEALTH_CHECK_URL_PRODUCTION ingesteld; overgeslagen"; exit 0; fi
|
||||
if [ -z "$HEALTH_URL" ]; then echo "Geen PROD_HEALTH_URL ingesteld; overgeslagen"; exit 0; fi
|
||||
bash deploy/verify-deployment.sh "$HEALTH_URL" dist
|
||||
echo "Productie bereikbaar en gelijk aan de build"
|
||||
|
||||
@@ -51,7 +51,7 @@ The hero of the homepage comes from the CMS hero module (`GET /api/v1/hero`); th
|
||||
Decision (Bryan, 2026-11-15): the hosting package has one entry per website. The CMS host (Kestrel) is that entry and serves the website itself (the prerendered pages), `/admin` and `/api/v1/*`. In production IIS (or the proxy) therefore passes **all** requests to the CMS host, not only `/api/v1/*`, and serves no static files or HTML cache of its own. This holds for the test host and for ASF production alike.
|
||||
|
||||
- **Test (ASF):** nginx on the proxy Pi forwards everything for `test.andreaslop.nl` to the CMS host (`web/deploy/nginx/test.andreaslop.nl.proxy.conf`), which serves the site files and the API. Nothing to add.
|
||||
- **Production: not in place yet.** The generated `web/deploy/iis/web.config` and the FTP upload of static files (`web/deploy/upload-production.sh`) still describe the old idea of IIS serving the files. They have to change with the production hosting: IIS keeps only the redirects (www, HTTPS) and the pass-through to the CMS host, and the prerendered `dist/` goes to the CMS host's prerendered-pages folder as on test. Security headers then come from the CMS host (as on test). This is part of the production hosting work, not of the packages feature. Until then production builds use the committed snapshot and the live calls fail safely (the baked list stays; the browser console shows a 404 for the API). Change generated server files only in `web/config/serverConfig.ts` and run `pnpm server-config`.
|
||||
- **Production: not in place yet.** The FTP upload (`web/deploy/upload-production.sh`) is now plain FTP into the CMS host's prerendered-pages folder and no longer puts a `web.config` on the server (the host's own `web.config` comes from the CMS pipeline). The generated `web/deploy/iis/web.config` still describes the old idea of IIS serving the files and has to change with the production hosting: IIS keeps only the redirects (www, HTTPS) and the pass-through to the CMS host, and the prerendered `dist/` goes to the CMS host's prerendered-pages folder as on test. Security headers then come from the CMS host (as on test). This is part of the production hosting work, not of the packages feature. Until then production builds use the committed snapshot and the live calls fail safely (the baked list stays; the browser console shows a 404 for the API). Change generated server files only in `web/config/serverConfig.ts` and run `pnpm server-config`.
|
||||
- **Host injection (built in the site; the host side is the CMS repo's work):** the build leaves markers in the prerendered pages and the CMS host fills them from live data, so a CMS change is visible to search engines at once without a rebuild. Contract and plan: `aidlc-docs/features/asf-cms-host-injection/plan.md`; golden files for the list HTML: `web/contract/host-injection/`.
|
||||
- Markers: `<!--CMS:DATA-->` + `<script type="application/json" id="cms-data">` (root document, every page), `<!--CMS:OFFERINGS-HTML-->`, `<!--CMS:BANNER-TOP-HTML-->` and `<!--CMS:BANNER-BOTTOM-HTML-->` regions (home page), `<!--CMS:OFFER-JSON-LD slug="...">` before the ld+json block of the newborn, zwangerschap and gezin pages, and `<span data-cms-price="slug">` in their price block.
|
||||
- In the page: `CmsRegion` renders the plain HTML between the markers (`lib/cmsHtml.ts`, styled by `.cms-*` rules in `theme.ts`) and React leaves it alone until hydration, so a host that wrote different data causes no hydration mismatch; after hydration the styled components take over. `PackagesProvider` reads the data block in the first render after hydration (`hostCmsData`); a block with `"source":"build"` is the baked one and counts as "no host data", so the page asks the API as before. The site address comes from `siteUrl` in the block (`setSiteUrl` in `client.tsx`), because the script files cannot be rewritten per host.
|
||||
@@ -60,11 +60,10 @@ Decision (Bryan, 2026-11-15): the hosting package has one entry per website. The
|
||||
## Environment and variables
|
||||
|
||||
| Name | Where | Meaning |
|
||||
| --------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| --------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `OFFERINGS_URL` | build env | Site address that serves the API (for example `https://test.andreaslop.nl`). Unset gives the snapshot. |
|
||||
| `ASF_OFFERINGS_URL_TEST` | Gitea repo variable | Value of `OFFERINGS_URL` for the test build. Set by SLS, not by feature sessions. |
|
||||
| `API_PROXY_TARGET` | dev env | Forwards `/api` in `pnpm dev` to a CMS host. |
|
||||
| `VITE_SITE_URL` | build env | Address the site presents itself under (canonical, og:*, JSON-LD, sitemap). Only the test build sets it (`https://test.andreaslop.nl`); unset gives `https://andreaslop.nl`. |
|
||||
| `VITE_CONTACT_FORM_ENABLED` | build env | Opens the contact form when exactly `true`. Only the test build sets it; unset keeps the form closed (production). Opening it in production needs Bryan's explicit go, after the captcha decision ([go-live-checklist.md](go-live-checklist.md)). |
|
||||
|
||||
The production artifact is built without `OFFERINGS_URL` on purpose: production must never carry the prices of the test CMS.
|
||||
No build sets `OFFERINGS_URL` any more (since the host injection, 2026-11-18): the CMS host writes the current data into the HTML. The variable stays supported for a local build against a CMS. The production artifact never carries the prices of the test CMS.
|
||||
|
||||
+26
-3
@@ -20,8 +20,8 @@ Dispatch from the CLI (the token comes from your git credentials, never print it
|
||||
|
||||
## Jobs
|
||||
|
||||
1. `check`: lint, format, unit/property/axe tests (coverage threshold 100% on `src/lib/**`), build **without** `OFFERINGS_URL` (so with the committed snapshot), audit. Uploads artifact `dist` (this is what production gets).
|
||||
2. `build-test`: builds again with `OFFERINGS_URL=${{ vars.ASF_OFFERINGS_URL_TEST }}` (packages and banners from the test CMS) and `VITE_SITE_URL=https://test.andreaslop.nl` (see "Own address of the test site") and uploads `dist-test`.
|
||||
1. `check`: lint, format, unit/property/axe tests (coverage threshold 100% on `src/lib/**`), build (with the committed package snapshot), audit. Uploads artifact `dist` (this is what production gets).
|
||||
2. `build-test`: builds again with `VITE_CONTACT_FORM_ENABLED=true` and `VITE_SITE_URL=https://test.andreaslop.nl` (see "Own address of the test site") and uploads `dist-test`.
|
||||
3. `deploy-test`: needs `check` and `build-test`, downloads `dist-test`, uploads to the ASF test host and runs the deployment check (served by the CMS host, admin files, POST status).
|
||||
4. `lighthouse`: against the built site with the preview stub (`--audit-route --contact-stub`).
|
||||
5. `deploy-production`: manual, from `release/*` only, uses artifact `dist`.
|
||||
@@ -52,4 +52,27 @@ The test site stands on its own: in the test build `VITE_SITE_URL` is `https://t
|
||||
|
||||
There used to be a nightly test build (`schedule`, 03:15 UTC) that baked the CMS data into the HTML for search engines. It is gone: the CMS host writes the packages, banners and hero into the first HTML of every request (cache 60 s, refreshed at once on a change; NFR-10), so a content change is visible without a rebuild. A rebuild is only needed for code and design. The nightly run also put `master` over ASF-test every night, which would undo a feature branch deployed there.
|
||||
|
||||
The production site gets the same only when the ASF production site is served by the CMS host (the IIS pipeline, later; see [go-live-checklist.md](go-live-checklist.md)). Until then production shows the committed snapshot. The test build still sets `OFFERINGS_URL`; removing that (and `VITE_SITE_URL`) is a separate follow-up once host injection is confirmed end to end.
|
||||
The production site gets the same only when the ASF production site is served by the CMS host (the IIS pipeline, later; see [go-live-checklist.md](go-live-checklist.md)). Until then production shows the committed snapshot. The test build no longer sets `OFFERINGS_URL` (removed 2026-11-18, once the host injection was confirmed on ASF-test); it still sets `VITE_SITE_URL` (own address of the test site) and `VITE_CONTACT_FORM_ENABLED`.
|
||||
|
||||
## Names of the repo variables and secrets
|
||||
|
||||
Format `{ENV}_{GROUP}_{NAME}` with `ENV` = `TEST` or `PROD`, no app part (this repo only deploys the ASF site) and no `VITE` (the pipeline maps a value to `VITE_...` in the build). Decision of Bryan, 2026-11-18; the full list is in the SLS repo (`aidlc-docs/_shared/gitea-naamgeving-variabelen.md`). Repo variables and secrets are created by SLS, not by feature sessions.
|
||||
|
||||
| Name | Kind | Used by |
|
||||
| -------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `TEST_DEPLOY_PATH` | variable | `deploy-test`: target folder on the Pi |
|
||||
| `TEST_HEALTH_URL` | variable | `deploy-test`: check after the deploy |
|
||||
| `PROD_DEPLOY_PATH` | variable | `deploy-production`: remote folder (default `wwwroot`) |
|
||||
| `PROD_HEALTH_URL` | variable | `deploy-production`: check after the deploy |
|
||||
| `TEST_SENTRY_DSN`, `TEST_UMAMI_SCRIPT_URL`, `TEST_UMAMI_WEBSITE_ID` | variable | `build-test` and the CSP check in `deploy-test` (as `VITE_SENTRY_DSN`, `VITE_UMAMI_SCRIPT_URL`, `VITE_UMAMI_WEBSITE_ID`, `VITE_APP_ENV=test`) |
|
||||
| `PROD_SENTRY_DSN`, `PROD_UMAMI_SCRIPT_URL`, `PROD_UMAMI_WEBSITE_ID` | variable | `check` (the production artifact; `VITE_APP_ENV=production`) |
|
||||
| `PROD_HOST_ADDRESS`, `PROD_HOST_USERNAME`, `PROD_HOST_PASSWORD` | secrets | `deploy-production`: FTP (plain FTP, no FTPS, at the hosting partner) |
|
||||
| `TEST_HOST_ADDRESS`, `TEST_HOST_PORT`, `TEST_HOST_USERNAME`, `TEST_HOST_SSH_KEY` | secrets | `deploy-test`: SSH key login to the Pi (one shared deploy key; no password) |
|
||||
|
||||
Removed: `PI_MAIN_*` (the SSH password login; the old secrets are deleted by Bryan after a green run), `DEPLOY_PATH_TEST`, `HEALTH_CHECK_URL_TEST`, `HEALTH_CHECK_URL_PRODUCTION`, `FTP_REMOTE_DIR`, `FTP_HOST`, `FTP_USERNAME`, `FTP_PASSWORD` (renamed), `ASF_OFFERINGS_URL_TEST` and `ASF_TEST_SERVED_BY_CMS` (no longer needed). The old names in the repo are removed by SLS after a green run.
|
||||
|
||||
**Monitoring per build.** Sentry and Umami settings are no longer in the code (`src/monitoring/config.ts`): every build gets them for its own environment and measures only on that environment's host (production build on `andreaslop.nl`, test build on `test.andreaslop.nl`; any other host measures nothing). The CSP origins for Umami and Sentry (`config/securityHeaders.ts`) come from the same variables, so a build without them has neither a measurement nor those origins; the build steps fail when a variable is empty. Unit and browser tests use the production values from `config/monitoringTestEnv.ts` (public values, the same as the variables); `pnpm server-config` does too, so the committed generated files carry the production CSP. The CMS host has its own copy of the origins in its environment (CMS repo).
|
||||
|
||||
## Plain FTP to production
|
||||
|
||||
The production package only offers plain FTP, no FTPS or SFTP. `deploy/upload-production.sh` therefore never tries TLS (`ftp:ssl-allow no`, passive mode) and sends the user name, the password and the files unencrypted. Measures: a separate FTP account with rights only on the folder of the prerendered pages, a unique strong password that only exists as the secret `PROD_HOST_PASSWORD`, rotating it after the first rollout, and asking the host whether SFTP or explicit FTPS can be switched on. The script uploads in three rounds (everything except HTML, then all HTML, then cleaning up old files) into the prerendered-pages folder of the CMS host (`PROD_DEPLOY_PATH`, the exact folder is still open, see `aidlc-docs/features/asf-production-iis/plan.md`, A2). It does not put a `web.config` there and deletes nothing outside that folder; the host and its `web.config` come from the CMS pipeline. `PROD_HOST_PORT` is optional (default 21).
|
||||
|
||||
@@ -11,7 +11,7 @@ What must be true before the CMS-driven parts of the site go to production. Brya
|
||||
|
||||
- [ ] Production hosting in place with the CMS host as the one entry of the website: IIS passes ALL requests to the CMS host (not only `/api/v1/*`) and serves no static files itself; the prerendered `dist/` is deployed to the CMS host ([cms-integration.md](cms-integration.md), "Hosting"). The generated IIS config and the production upload script are updated for this. Without it production keeps the committed snapshot and the console shows a 404 per page view for the API.
|
||||
- [ ] `web/src/content/offerings.snapshot.json` holds the real, current packages (production builds use it).
|
||||
- [ ] The production CMS holds the real packages. The test CMS prices must never end up in the production artifact (it is built without `OFFERINGS_URL`).
|
||||
- [ ] The production CMS holds the real packages. The test CMS prices must never end up in the production artifact (no build fetches packages from a CMS any more).
|
||||
|
||||
## Hero
|
||||
|
||||
@@ -42,7 +42,6 @@ The contact form must not go live before the statement does.
|
||||
## Other open items
|
||||
|
||||
- ASF production hosting: CMS host behind IIS pass-through (separate feature, see above).
|
||||
- Privacy statement as JSON (Bryan, 2026-11-17): `web/src/content/privacyContent.ts` may become a JSON file, but not now. Do it in the feature that sets up the production pipeline on IIS, together with the text itself (the `[OPEN:]` points, the captcha paragraph, the final wording). Keep the `PLACEHOLDER_MARK` check (`unresolvedPlaceholders()`), the captcha section (`onlyWithCaptcha`) and their tests. Put this in the plan of that feature.
|
||||
- Host injection of CMS data into the prerendered pages (plan: `aidlc-docs/features/asf-cms-host-injection/plan.md`, after the current merges).
|
||||
- First ASF administrator and removal of the setup token (CMS).
|
||||
- Messages created by the Playwright test run in the ASF test CMS are archived by Bryan.
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
// De monitoringinstellingen die de tests als productiebuild zien. De echte
|
||||
// waarden komen in de pipeline uit de Gitea-variabelen PROD_SENTRY_DSN,
|
||||
// PROD_UMAMI_SCRIPT_URL en PROD_UMAMI_WEBSITE_ID (en TEST_...); deze openbare
|
||||
// waarden zijn er hetzelfde als, zodat de gegenereerde serverconfiguratie en de
|
||||
// CSP in de tests vergelijkbaar blijven. Zie src/monitoring/config.ts.
|
||||
export const monitoringTestEnv = {
|
||||
VITE_APP_ENV: 'production',
|
||||
VITE_SENTRY_DSN:
|
||||
'https://12ec77dcc3216a98b96d3fb3dac13f66@o4511795618185216.ingest.de.sentry.io/4512282287472720',
|
||||
VITE_UMAMI_SCRIPT_URL: 'https://analytics.slpsoftware.nl/script.js',
|
||||
VITE_UMAMI_WEBSITE_ID: '3edbb7d1-4388-4f2d-9cef-11ade88ace96',
|
||||
};
|
||||
@@ -1,4 +1,4 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { contentSecurityPolicy, securityHeaders } from './securityHeaders';
|
||||
|
||||
const umami = 'https://analytics.slpsoftware.nl';
|
||||
@@ -12,7 +12,17 @@ const captchaFrames = [
|
||||
const directive = (csp: string, name: string) =>
|
||||
csp.split('; ').find((d) => d.startsWith(name + ' ')) ?? '';
|
||||
|
||||
afterEach(() => vi.unstubAllEnvs());
|
||||
|
||||
describe('securityHeaders', () => {
|
||||
it('noemt Umami en Sentry niet zonder monitoringinstellingen in de build', () => {
|
||||
vi.stubEnv('VITE_SENTRY_DSN', '');
|
||||
const csp = contentSecurityPolicy('production');
|
||||
expect(csp).not.toContain(umami);
|
||||
expect(csp).not.toContain(sentry);
|
||||
expect(directive(csp, 'script-src')).toBe("script-src 'self'");
|
||||
});
|
||||
|
||||
it('productie-CSP heeft geen onveilige uitzonderingen voor scripts', () => {
|
||||
const csp = contentSecurityPolicy('production');
|
||||
expect(csp).not.toContain('unsafe-eval');
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// HTTP-securityheaders voor de Vite dev- en preview-server. De productieset is
|
||||
// ook het voorschrift voor de toekomstige host (zie NFR-SEC-01/02).
|
||||
|
||||
import { sentryIngestOrigin, umamiOrigin } from '../src/monitoring/config.ts';
|
||||
import { monitoringOrigins } from '../src/monitoring/config.ts';
|
||||
|
||||
type Mode = 'production' | 'development';
|
||||
|
||||
@@ -21,19 +21,24 @@ export const captchaFrameOrigins = [
|
||||
'https://global1.frcapi.com',
|
||||
];
|
||||
|
||||
const productionCsp: Record<string, string[]> = {
|
||||
// De herkomsten van Umami en Sentry komen uit de build-omgeving (zie
|
||||
// src/monitoring/config.ts); zonder die instellingen staan ze er niet in.
|
||||
function productionCsp(): Record<string, string[]> {
|
||||
const origins = monitoringOrigins();
|
||||
return {
|
||||
'default-src': ["'self'"],
|
||||
'script-src': ["'self'", umamiOrigin],
|
||||
'script-src': ["'self'", ...origins.umami],
|
||||
'style-src': ["'self'", "'unsafe-inline'"],
|
||||
'img-src': ["'self'", 'data:'],
|
||||
'font-src': ["'self'"],
|
||||
'connect-src': ["'self'", umamiOrigin, sentryIngestOrigin],
|
||||
'connect-src': ["'self'", ...origins.umami, ...origins.sentry],
|
||||
'frame-src': captchaFrameOrigins,
|
||||
'object-src': ["'none'"],
|
||||
'base-uri': ["'self'"],
|
||||
'form-action': ["'self'"],
|
||||
'frame-ancestors': ["'none'"],
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
// Alleen wat de Vite dev-server zelf nodig heeft: een inline script voor
|
||||
// React Refresh en een websocket voor hot reload.
|
||||
@@ -43,7 +48,7 @@ const developmentExtras: Record<string, string[]> = {
|
||||
};
|
||||
|
||||
export function contentSecurityPolicy(mode: Mode): string {
|
||||
return Object.entries(productionCsp)
|
||||
return Object.entries(productionCsp())
|
||||
.map(([directive, sources]) => {
|
||||
const extra =
|
||||
mode === 'development'
|
||||
|
||||
@@ -2,8 +2,15 @@
|
||||
// Draait direct met Node (type stripping), zonder extra tooling.
|
||||
import { mkdirSync, writeFileSync } from 'node:fs';
|
||||
import { dirname } from 'node:path';
|
||||
import { monitoringTestEnv } from './monitoringTestEnv.ts';
|
||||
import { serverConfigFiles } from './serverConfig.ts';
|
||||
|
||||
// The committed files carry the CSP of the production build; the origins of
|
||||
// Umami and Sentry come from the environment (src/monitoring/config.ts)
|
||||
for (const [name, value] of Object.entries(monitoringTestEnv)) {
|
||||
process.env[name] ??= value;
|
||||
}
|
||||
|
||||
for (const [path, generate] of Object.entries(serverConfigFiles)) {
|
||||
mkdirSync(dirname(path), { recursive: true });
|
||||
writeFileSync(path, generate());
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
#!/usr/bin/env bash
|
||||
# Upload naar productie in drie rondes (BR-HST-14, 15; FR-PR-18).
|
||||
# Gebruik: upload-production.sh <dist-map> <doelmap-op-de-server>
|
||||
# Verbinding: FTP_HOST, FTP_USER en LFTP_PASSWORD uit de omgeving (FTPS).
|
||||
# De doelmap is de map met voorgerenderde pagina's van de CMS-host; de host
|
||||
# (en zijn web.config) staat er los van en wordt door de CMS-pijplijn gedeployd.
|
||||
# Verbinding: FTP_HOST, FTP_USER en LFTP_PASSWORD uit de omgeving, optioneel
|
||||
# FTP_PORT. Gewone FTP, geen FTPS: het productiepakket biedt alleen dat. De
|
||||
# gegevens gaan dus onversleuteld over het netwerk (zie docs/deploy-and-ci.md,
|
||||
# "Plain FTP"); daarom nooit TLS proberen en een eigen FTP-account met rechten
|
||||
# alleen op deze map.
|
||||
# Alleen voor de test: LFTP_OPEN (bijvoorbeeld file:///) vervangt de
|
||||
# verbinding, en UPLOAD_PASS=1|2|3 voert maar één ronde uit.
|
||||
set -euo pipefail
|
||||
@@ -36,7 +42,6 @@ done
|
||||
|
||||
here="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
bash "$here/check-artifact.sh" "$dist"
|
||||
cp "$here/iis/web.config" "$dist/web.config"
|
||||
|
||||
pass="${UPLOAD_PASS:-all}"
|
||||
case "$pass" in
|
||||
@@ -48,7 +53,7 @@ wants() { [ "$pass" = all ] || [ "$pass" = "$1" ]; }
|
||||
# Geen back-ups: lftp zet standaard een kopie met een tijdstempel
|
||||
# (web.config~20261101221045~) naast elk bestand dat het overschrijft. Op de
|
||||
# host zou elke deploy er een achterlaten, bereikbaar voor wie de naam raadt.
|
||||
settings="set ftp:ssl-force true; set ftp:ssl-protect-data true; set net:max-retries 3; set xfer:make-backup no;"
|
||||
settings="set ftp:ssl-allow no; set ftp:passive-mode on; set net:max-retries 3; set xfer:make-backup no;"
|
||||
|
||||
# Elke opdracht krijgt een eigen lftp-sessie, zodat het script bij een mislukte
|
||||
# ronde stopt (set -e) voordat de volgende ronde begint: de HTML gaat nooit
|
||||
@@ -60,22 +65,25 @@ run_lftp() {
|
||||
else
|
||||
: "${FTP_HOST:?FTP_HOST ontbreekt}" "${FTP_USER:?FTP_USER ontbreekt}"
|
||||
: "${LFTP_PASSWORD:?LFTP_PASSWORD ontbreekt}"
|
||||
lftp --env-password -u "$FTP_USER" "$FTP_HOST" -e "$commands"
|
||||
local port=()
|
||||
if [ -n "${FTP_PORT:-}" ]; then
|
||||
[[ "$FTP_PORT" =~ ^[0-9]+$ ]] || { echo "Ongeldige FTP_PORT" >&2; exit 2; }
|
||||
port=(-p "$FTP_PORT")
|
||||
fi
|
||||
lftp --env-password -u "$FTP_USER" "${port[@]}" "$FTP_HOST" -e "$commands"
|
||||
fi
|
||||
}
|
||||
|
||||
# Ronde 1: alles behalve HTML en web.config, dus ook /assets. Nieuwe
|
||||
# bestanden met hash in de naam storen de oude release niet.
|
||||
# Ronde 1: alles behalve HTML, dus ook /assets. Nieuwe bestanden met hash in
|
||||
# de naam storen de oude release niet.
|
||||
if wants 1; then
|
||||
echo "== Ronde 1: alles behalve HTML en web.config"
|
||||
run_lftp "mirror --reverse --verbose --exclude-glob '*.html' --exclude-glob web.config $dist/ $remote/;"
|
||||
echo "== Ronde 1: alles behalve HTML"
|
||||
run_lftp "mirror --reverse --verbose --exclude-glob '*.html' $dist/ $remote/;"
|
||||
fi
|
||||
# Ronde 2: web.config vlak voor de HTML (de regels passen bij de nieuwe
|
||||
# bestanden), dan alle HTML, ook de geneste pagina's en 404.html. Pas nu
|
||||
# verwijst iets naar de nieuwe assets.
|
||||
# Ronde 2: alle HTML, ook de geneste pagina's en 404.html. Pas nu verwijst
|
||||
# iets naar de nieuwe assets.
|
||||
if wants 2; then
|
||||
echo "== Ronde 2: web.config en alle HTML"
|
||||
run_lftp "put -O $remote $dist/web.config;"
|
||||
echo "== Ronde 2: alle HTML"
|
||||
run_lftp "mirror --reverse --verbose --include-glob '*.html' $dist/ $remote/;"
|
||||
fi
|
||||
# Ronde 3: opruimen als laatste, zodat bezoekers met de oude HTML hun oude
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
# headers staan met de exacte waarde op elk antwoord (pagina, asset,
|
||||
# 301, 404, robots.txt), cachebeleid, alleen gzip (nooit br), een
|
||||
# procentgecodeerd pad blijft gecodeerd, en /admin, /health en
|
||||
# /api/v1/System/capabilities (zonder Offerings) antwoorden.
|
||||
# /api/v1/System/capabilities (met Offerings en Hero) antwoorden.
|
||||
set -euo pipefail
|
||||
|
||||
if [ "$#" -lt 2 ] || [ "$#" -gt 4 ]; then
|
||||
@@ -272,7 +272,7 @@ if [ "$cms_mode" -eq 1 ]; then
|
||||
fail "POST /: status $status, verwacht 405"
|
||||
fi
|
||||
|
||||
# De CMS-routes: health, admin, API (zonder Offerings), onbekend API-pad
|
||||
# De CMS-routes: health, admin, API (met Offerings en Hero), onbekend API-pad
|
||||
fetch /health
|
||||
if [ "$status" != "200" ]; then fail "/health: status $status, verwacht 200"; fi
|
||||
|
||||
@@ -301,8 +301,13 @@ if [ "$cms_mode" -eq 1 ]; then
|
||||
fetch /api/v1/System/capabilities
|
||||
if [ "$status" != "200" ]; then
|
||||
fail "/api/v1/System/capabilities: status $status, verwacht 200"
|
||||
elif grep -qi 'offerings' "$work/body"; then
|
||||
fail "/api/v1/System/capabilities noemt Offerings; die module hoort voor ASF uit te staan"
|
||||
else
|
||||
# De site haalt pakketten, banners en de hero uit deze modules
|
||||
for module in Offerings Hero; do
|
||||
if ! grep -qi "\"$module\"" "$work/body"; then
|
||||
fail "/api/v1/System/capabilities noemt $module niet; de site heeft die module nodig"
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
# Een onbekend API-pad is een API-404, nooit de website
|
||||
|
||||
@@ -539,7 +539,6 @@ describe.skipIf(toolsMissing || lftpMissing)('upload-production.sh', () => {
|
||||
'robots.txt',
|
||||
'soorten-fotoshoots/newborn.html',
|
||||
'stale.txt',
|
||||
'web.config',
|
||||
]);
|
||||
|
||||
const third = await upload(dist, target, '3');
|
||||
@@ -551,7 +550,6 @@ describe.skipIf(toolsMissing || lftpMissing)('upload-production.sh', () => {
|
||||
'over-mij.html',
|
||||
'robots.txt',
|
||||
'soorten-fotoshoots/newborn.html',
|
||||
'web.config',
|
||||
]);
|
||||
});
|
||||
|
||||
@@ -567,19 +565,18 @@ describe.skipIf(toolsMissing || lftpMissing)('upload-production.sh', () => {
|
||||
);
|
||||
expect(rounds).toEqual(['1', '2', '3']);
|
||||
|
||||
const expected = [...validFiles, 'web.config'].sort();
|
||||
const expected = [...validFiles].sort();
|
||||
expect(await tree(target)).toEqual(expected);
|
||||
});
|
||||
|
||||
it('laat bij een tweede deploy geen back-upbestanden met ~ achter', async () => {
|
||||
const { dist, target } = await setup();
|
||||
expect((await upload(dist, target)).code).toBe(0);
|
||||
// Nu bestaat web.config al op de host, en alles wordt overschreven
|
||||
// Nu bestaat alles al op de host en wordt het overschreven
|
||||
await write(dist, 'robots.txt', 'nieuwe inhoud');
|
||||
expect((await upload(dist, target)).code).toBe(0);
|
||||
const files = await tree(target);
|
||||
expect(files.filter((file) => file.includes('~'))).toEqual([]);
|
||||
expect(files).toContain('web.config');
|
||||
});
|
||||
|
||||
it('weigert een ongeldige build en uploadt dan niets', async () => {
|
||||
@@ -590,13 +587,12 @@ describe.skipIf(toolsMissing || lftpMissing)('upload-production.sh', () => {
|
||||
expect(await tree(target)).toEqual(['stale.txt']);
|
||||
});
|
||||
|
||||
it('neemt de web.config uit deploy/iis over', async () => {
|
||||
it('zet geen web.config op de server: die hoort bij de CMS-host', async () => {
|
||||
const { dist, target } = await setup();
|
||||
const run = await upload(dist, target);
|
||||
expect(run.code).toBe(0);
|
||||
expect(await readFile(join(target, 'web.config'), 'utf8')).toBe(
|
||||
await readFile(join(deployDir, 'iis/web.config'), 'utf8'),
|
||||
);
|
||||
expect(existsSync(join(target, 'web.config'))).toBe(false);
|
||||
expect(existsSync(join(dist, 'web.config'))).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -666,7 +662,7 @@ touch '${slash(marker)}'
|
||||
},
|
||||
);
|
||||
|
||||
it('zet in elke lftp-sessie de back-ups uit en de TLS-eisen aan', async () => {
|
||||
it('zet in elke lftp-sessie de back-ups uit en TLS uit (gewone FTP)', async () => {
|
||||
const dist = await makeDist();
|
||||
const bin = await makeTemp('andreaslop-fakebin-');
|
||||
const log = join(bin, 'opdrachten');
|
||||
@@ -690,11 +686,53 @@ printf '%s\\n' "$2" >> '${slash(log)}'
|
||||
const sessions = (await readFile(log, 'utf8'))
|
||||
.split('\n')
|
||||
.filter(Boolean);
|
||||
// Ronde 1, web.config, ronde 2 (HTML) en ronde 3
|
||||
expect(sessions).toHaveLength(4);
|
||||
// Ronde 1, ronde 2 (HTML) en ronde 3
|
||||
expect(sessions).toHaveLength(3);
|
||||
for (const commands of sessions) {
|
||||
expect(commands).toContain('set xfer:make-backup no;');
|
||||
expect(commands).toContain('set ftp:ssl-force true;');
|
||||
expect(commands).toContain('set ftp:ssl-allow no;');
|
||||
expect(commands).toContain('set ftp:passive-mode on;');
|
||||
expect(commands).not.toContain('ssl-force');
|
||||
}
|
||||
});
|
||||
|
||||
it('geeft FTP_PORT door aan lftp en weigert een ongeldige poort', async () => {
|
||||
const dist = await makeDist();
|
||||
const bin = await makeTemp('andreaslop-fakebin-');
|
||||
const log = join(bin, 'argumenten');
|
||||
await writeFile(
|
||||
join(bin, 'lftp'),
|
||||
`#!/bin/sh
|
||||
printf '%s\n' "$*" >> '${slash(log)}'
|
||||
`,
|
||||
{ mode: 0o755 },
|
||||
);
|
||||
const env = {
|
||||
PATH: `${bin}${delimiter}${process.env.PATH ?? ''}`,
|
||||
FTP_HOST: 'ftp.example.test',
|
||||
FTP_USER: 'gebruiker',
|
||||
LFTP_PASSWORD: 'geheim',
|
||||
};
|
||||
const bad = await runScript(
|
||||
'upload-production.sh',
|
||||
[basename(dist), 'wwwroot'],
|
||||
{ ...env, FTP_PORT: '21; rm -rf' },
|
||||
dirname(dist),
|
||||
);
|
||||
expect(bad.code).toBe(2);
|
||||
expect(existsSync(log)).toBe(false);
|
||||
|
||||
const good = await runScript(
|
||||
'upload-production.sh',
|
||||
[basename(dist), 'wwwroot'],
|
||||
{ ...env, FTP_PORT: '2121' },
|
||||
dirname(dist),
|
||||
);
|
||||
expect(good.code).toBe(0);
|
||||
for (const line of (await readFile(log, 'utf8'))
|
||||
.split('\n')
|
||||
.filter(Boolean)) {
|
||||
expect(line).toContain('-u gebruiker -p 2121 ftp.example.test');
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { render } from '@testing-library/react';
|
||||
import { afterEach, describe, expect, it } from 'vitest';
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import UmamiAnalytics from './UmamiAnalytics';
|
||||
|
||||
const umamiScripts = () =>
|
||||
@@ -8,6 +8,7 @@ const umamiScripts = () =>
|
||||
);
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
umamiScripts().forEach((script) => script.remove());
|
||||
});
|
||||
|
||||
@@ -18,9 +19,13 @@ describe('UmamiAnalytics', () => {
|
||||
});
|
||||
|
||||
it.each([
|
||||
['andreaslop.nl', '3edbb7d1-4388-4f2d-9cef-11ade88ace96'],
|
||||
['test.andreaslop.nl', '7fb301ab-6ecc-4aea-beee-71bcb6009bfe'],
|
||||
])('telt op %s met de juiste website', (hostname, websiteId) => {
|
||||
['production', 'andreaslop.nl', '3edbb7d1-4388-4f2d-9cef-11ade88ace96'],
|
||||
['test', 'test.andreaslop.nl', 'test-website'],
|
||||
])(
|
||||
'telt in de %s-build op %s met de juiste website',
|
||||
(environment, hostname, websiteId) => {
|
||||
vi.stubEnv('VITE_APP_ENV', environment);
|
||||
vi.stubEnv('VITE_UMAMI_WEBSITE_ID', websiteId);
|
||||
render(<UmamiAnalytics hostname={hostname} />);
|
||||
|
||||
const [script] = umamiScripts();
|
||||
@@ -30,6 +35,12 @@ describe('UmamiAnalytics', () => {
|
||||
domains: hostname,
|
||||
doNotTrack: 'true',
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
it('voegt geen script toe op de host van de andere omgeving', () => {
|
||||
render(<UmamiAnalytics hostname="test.andreaslop.nl" />);
|
||||
expect(umamiScripts()).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('voegt het script maar één keer toe', () => {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { useEffect } from 'react';
|
||||
import { monitoringFor, umamiOrigin } from '@/monitoring/config';
|
||||
import { monitoringFor } from '@/monitoring/config';
|
||||
|
||||
const SCRIPT_ELEMENT_ID = 'umami-analytics-script';
|
||||
|
||||
@@ -16,7 +16,7 @@ export default function UmamiAnalytics({ hostname }: { hostname?: string }) {
|
||||
|
||||
const script = document.createElement('script');
|
||||
script.id = SCRIPT_ELEMENT_ID;
|
||||
script.src = `${umamiOrigin}/script.js`;
|
||||
script.src = monitoring.umamiScriptUrl;
|
||||
script.defer = true;
|
||||
script.dataset.websiteId = monitoring.umamiWebsiteId;
|
||||
script.dataset.domains = host;
|
||||
|
||||
@@ -1,11 +1,22 @@
|
||||
import fc from 'fast-check';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import {
|
||||
monitoredHostnames,
|
||||
monitoringConfig,
|
||||
monitoringFor,
|
||||
sentryIngestOrigin,
|
||||
monitoringOrigins,
|
||||
} from './config';
|
||||
|
||||
const dsn = 'https://key@o1.ingest.de.sentry.io/2';
|
||||
const script = 'https://analytics.example.nl/script.js';
|
||||
const raw = (extra: Record<string, unknown> = {}) => ({
|
||||
environment: 'production',
|
||||
sentryDsn: dsn,
|
||||
umamiScriptUrl: script,
|
||||
umamiWebsiteId: 'site-1',
|
||||
...extra,
|
||||
});
|
||||
|
||||
// Alles wat geen test- of productiehost is
|
||||
const otherHostname = fc
|
||||
.oneof(
|
||||
@@ -25,32 +36,89 @@ const otherHostname = fc
|
||||
)
|
||||
.filter((host) => !monitoredHostnames.includes(host));
|
||||
|
||||
describe('monitoringFor', () => {
|
||||
it('productiehost meet als production met de productiewebsite', () => {
|
||||
expect(monitoringFor('andreaslop.nl')).toEqual({
|
||||
afterEach(() => vi.unstubAllEnvs());
|
||||
|
||||
describe('monitoringConfig', () => {
|
||||
it('leest de waarden uit de omgeving van de build', () => {
|
||||
// De testomgeving (vite.config.ts) is de productiebuild
|
||||
expect(monitoringConfig()).toMatchObject({
|
||||
environment: 'production',
|
||||
umamiWebsiteId: '3edbb7d1-4388-4f2d-9cef-11ade88ace96',
|
||||
});
|
||||
vi.stubEnv('VITE_APP_ENV', 'test');
|
||||
vi.stubEnv('VITE_UMAMI_WEBSITE_ID', ' abc ');
|
||||
expect(monitoringConfig()).toMatchObject({
|
||||
environment: 'test',
|
||||
umamiWebsiteId: 'abc',
|
||||
});
|
||||
});
|
||||
|
||||
it('testhost meet als test met de testwebsite', () => {
|
||||
expect(monitoringFor('test.andreaslop.nl')).toEqual({
|
||||
environment: 'test',
|
||||
umamiWebsiteId: '7fb301ab-6ecc-4aea-beee-71bcb6009bfe',
|
||||
it('geeft null als er iets ontbreekt of ongeldig is', () => {
|
||||
expect(monitoringConfig(raw())).not.toBeNull();
|
||||
for (const bad of [
|
||||
{ environment: 'staging' },
|
||||
{ environment: undefined },
|
||||
{ sentryDsn: undefined },
|
||||
{ sentryDsn: 'http://key@host/1' },
|
||||
{ sentryDsn: 'geen url' },
|
||||
{ umamiScriptUrl: '' },
|
||||
{ umamiScriptUrl: 'http://analytics.example.nl/script.js' },
|
||||
{ umamiWebsiteId: ' ' },
|
||||
{ umamiWebsiteId: 5 },
|
||||
]) {
|
||||
expect(monitoringConfig(raw(bad))).toBeNull();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('monitoringFor', () => {
|
||||
it('productiebuild meet alleen op de productiehost', () => {
|
||||
const config = monitoringConfig(raw());
|
||||
expect(monitoringFor('andreaslop.nl', config)).toEqual({
|
||||
environment: 'production',
|
||||
sentryDsn: dsn,
|
||||
umamiScriptUrl: script,
|
||||
umamiWebsiteId: 'site-1',
|
||||
});
|
||||
expect(monitoringFor('test.andreaslop.nl', config)).toBeNull();
|
||||
});
|
||||
|
||||
it('testbuild meet alleen op de testhost', () => {
|
||||
const config = monitoringConfig(raw({ environment: 'test' }));
|
||||
expect(monitoringFor('test.andreaslop.nl', config)?.environment).toBe(
|
||||
'test',
|
||||
);
|
||||
expect(monitoringFor('andreaslop.nl', config)).toBeNull();
|
||||
});
|
||||
|
||||
it('meet niets zonder instellingen', () => {
|
||||
expect(monitoringFor('andreaslop.nl', null)).toBeNull();
|
||||
});
|
||||
|
||||
it('elke andere host meet niets (M1)', () => {
|
||||
fc.assert(
|
||||
fc.property(otherHostname, (host) => {
|
||||
expect(monitoringFor(host)).toBeNull();
|
||||
expect(
|
||||
monitoringFor(
|
||||
host,
|
||||
monitoringConfig(raw({ environment: 'test' })),
|
||||
),
|
||||
).toBeNull();
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it('Sentry-ingest is de EU-host uit de DSN, zonder sleutel', () => {
|
||||
expect(sentryIngestOrigin).toBe(
|
||||
'https://o4511795618185216.ingest.de.sentry.io',
|
||||
);
|
||||
describe('monitoringOrigins', () => {
|
||||
it('zijn de herkomst van het Umami-script en van de Sentry-ingest, zonder sleutel', () => {
|
||||
expect(monitoringOrigins(monitoringConfig(raw()))).toEqual({
|
||||
umami: ['https://analytics.example.nl'],
|
||||
sentry: ['https://o1.ingest.de.sentry.io'],
|
||||
});
|
||||
});
|
||||
|
||||
it('zijn leeg zonder instellingen', () => {
|
||||
expect(monitoringOrigins(null)).toEqual({ umami: [], sentry: [] });
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,43 +1,96 @@
|
||||
// Instellingen voor Sentry en Umami (monitoring-plan M1/M2). Deze waarden zijn
|
||||
// openbaar: ze staan hoe dan ook in de browser van elke bezoeker.
|
||||
// Instellingen voor Sentry en Umami (monitoring-plan M1/M2). De waarden zijn
|
||||
// openbaar (ze staan in de browser van elke bezoeker) maar komen niet meer uit
|
||||
// de code: de pipeline geeft ze per omgeving mee aan de build, uit de Gitea-
|
||||
// variabelen {TEST|PROD}_SENTRY_DSN, _UMAMI_SCRIPT_URL en _UMAMI_WEBSITE_ID,
|
||||
// als VITE_SENTRY_DSN, VITE_UMAMI_SCRIPT_URL, VITE_UMAMI_WEBSITE_ID en
|
||||
// VITE_APP_ENV ('test' of 'production'). Eén build hoort dus bij één omgeving.
|
||||
// Geen imports uit Vite: config/securityHeaders.ts leest dit bestand ook in Node.
|
||||
|
||||
export type MonitoringEnvironment = 'test' | 'production';
|
||||
|
||||
export interface Monitoring {
|
||||
export interface MonitoringConfig {
|
||||
environment: MonitoringEnvironment;
|
||||
sentryDsn: string;
|
||||
umamiScriptUrl: string;
|
||||
umamiWebsiteId: string;
|
||||
}
|
||||
|
||||
export const sentryDsn =
|
||||
'https://12ec77dcc3216a98b96d3fb3dac13f66@o4511795618185216.ingest.de.sentry.io/4512282287472720';
|
||||
export type Monitoring = MonitoringConfig;
|
||||
|
||||
// Waar de browser fouten naartoe stuurt; nodig voor connect-src in de CSP
|
||||
export const sentryIngestOrigin = new URL(sentryDsn).origin;
|
||||
// De host waarop de build van een omgeving meet
|
||||
const hostnameByEnvironment: Record<MonitoringEnvironment, string> = {
|
||||
production: 'andreaslop.nl',
|
||||
test: 'test.andreaslop.nl',
|
||||
};
|
||||
|
||||
export const umamiOrigin = 'https://analytics.slpsoftware.nl';
|
||||
// In de Vite-build staan de waarden in import.meta.env (statisch vervangen,
|
||||
// daarom elke naam los); de buildscripts onder Node lezen process.env.
|
||||
const fromProcess = (name: string): unknown =>
|
||||
typeof process === 'undefined' ? undefined : process.env[name];
|
||||
|
||||
// Eén build voor beide omgevingen: de hostname bepaalt de omgeving
|
||||
const monitoringByHostname = new Map<string, Monitoring>([
|
||||
[
|
||||
'andreaslop.nl',
|
||||
{
|
||||
environment: 'production',
|
||||
umamiWebsiteId: '3edbb7d1-4388-4f2d-9cef-11ade88ace96',
|
||||
},
|
||||
],
|
||||
[
|
||||
'test.andreaslop.nl',
|
||||
{
|
||||
environment: 'test',
|
||||
umamiWebsiteId: '7fb301ab-6ecc-4aea-beee-71bcb6009bfe',
|
||||
},
|
||||
],
|
||||
]);
|
||||
|
||||
// Onbekende host (localhost, Lighthouse CI, previews): niets meten (M1)
|
||||
export function monitoringFor(hostname: string): Monitoring | null {
|
||||
return monitoringByHostname.get(hostname) ?? null;
|
||||
function rawSettings(): Record<keyof MonitoringConfig, unknown> {
|
||||
const env = import.meta.env;
|
||||
return {
|
||||
environment: env?.VITE_APP_ENV ?? fromProcess('VITE_APP_ENV'),
|
||||
sentryDsn: env?.VITE_SENTRY_DSN ?? fromProcess('VITE_SENTRY_DSN'),
|
||||
umamiScriptUrl:
|
||||
env?.VITE_UMAMI_SCRIPT_URL ?? fromProcess('VITE_UMAMI_SCRIPT_URL'),
|
||||
umamiWebsiteId:
|
||||
env?.VITE_UMAMI_WEBSITE_ID ?? fromProcess('VITE_UMAMI_WEBSITE_ID'),
|
||||
};
|
||||
}
|
||||
|
||||
export const monitoredHostnames = [...monitoringByHostname.keys()];
|
||||
const isHttps = (value: string): boolean => {
|
||||
try {
|
||||
return new URL(value).protocol === 'https:';
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
// De instellingen van deze build, of null als er iets ontbreekt of ongeldig is
|
||||
// (dan meet de site niets: liever geen meting dan een kapotte)
|
||||
export function monitoringConfig(
|
||||
raw: Record<keyof MonitoringConfig, unknown> = rawSettings(),
|
||||
): MonitoringConfig | null {
|
||||
const { environment, sentryDsn, umamiScriptUrl, umamiWebsiteId } = raw;
|
||||
if (environment !== 'test' && environment !== 'production') return null;
|
||||
const text = (value: unknown) =>
|
||||
typeof value === 'string' ? value.trim() : '';
|
||||
const dsn = text(sentryDsn);
|
||||
const script = text(umamiScriptUrl);
|
||||
const website = text(umamiWebsiteId);
|
||||
if (!isHttps(dsn) || !isHttps(script) || website === '') return null;
|
||||
return {
|
||||
environment,
|
||||
sentryDsn: dsn,
|
||||
umamiScriptUrl: script,
|
||||
umamiWebsiteId: website,
|
||||
};
|
||||
}
|
||||
|
||||
// Onbekende host (localhost, Lighthouse CI, previews, de andere omgeving):
|
||||
// niets meten (M1)
|
||||
export function monitoringFor(
|
||||
hostname: string,
|
||||
config: MonitoringConfig | null = monitoringConfig(),
|
||||
): Monitoring | null {
|
||||
if (!config || hostname !== hostnameByEnvironment[config.environment]) {
|
||||
return null;
|
||||
}
|
||||
return { ...config };
|
||||
}
|
||||
|
||||
// De herkomsten voor de CSP: Umami voor script-src en connect-src, de Sentry-
|
||||
// ingest voor connect-src. Leeg zonder meting.
|
||||
export function monitoringOrigins(
|
||||
config: MonitoringConfig | null = monitoringConfig(),
|
||||
): { umami: string[]; sentry: string[] } {
|
||||
if (!config) return { umami: [], sentry: [] };
|
||||
return {
|
||||
umami: [new URL(config.umamiScriptUrl).origin],
|
||||
sentry: [new URL(config.sentryDsn).origin],
|
||||
};
|
||||
}
|
||||
|
||||
export const monitoredHostnames = Object.values(hostnameByEnvironment);
|
||||
|
||||
@@ -11,6 +11,7 @@ async function freshSentry() {
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
init.mockReset();
|
||||
captureException.mockReset();
|
||||
});
|
||||
@@ -27,6 +28,7 @@ describe('Sentry', () => {
|
||||
});
|
||||
|
||||
it('start op test met omgeving test en zonder persoonsgegevens', async () => {
|
||||
vi.stubEnv('VITE_APP_ENV', 'test');
|
||||
const { startSentry } = await freshSentry();
|
||||
startSentry('test.andreaslop.nl');
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { monitoringFor, sentryDsn } from './config';
|
||||
import { monitoringFor } from './config';
|
||||
|
||||
// Sentry laadt pas na het load-event, buiten de hoofdbundel (M4). Fouten van
|
||||
// daarvoor wachten in een wachtrij en gaan mee zodra Sentry klaar is.
|
||||
@@ -33,7 +33,7 @@ export function startSentry(hostname = window.location.hostname): void {
|
||||
// Alleen fouten: geen tracing, geen replay, geen persoonsgegevens (M5).
|
||||
// Sinds SDK 11 verzamelt Sentry standaard alles; daarom alles expliciet uit.
|
||||
Sentry.init({
|
||||
dsn: sentryDsn,
|
||||
dsn: monitoring.sentryDsn,
|
||||
environment: monitoring.environment,
|
||||
release: import.meta.env.VITE_RELEASE,
|
||||
dataCollection: {
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { monitoringTestEnv } from './config/monitoringTestEnv.ts';
|
||||
import { configDefaults, defineConfig } from 'vitest/config';
|
||||
import react from '@vitejs/plugin-react';
|
||||
import { tanstackStart } from '@tanstack/react-start/plugin/vite';
|
||||
@@ -80,6 +81,7 @@ export default defineConfig(({ mode }) => ({
|
||||
preview: { headers: securityHeaders('production') },
|
||||
test: {
|
||||
environment: 'jsdom',
|
||||
env: monitoringTestEnv,
|
||||
// De CI-runner (Raspberry Pi, arm64) is ±5-8x trager dan een pc; de
|
||||
// eerste render met axe duurt daar tot 7 s. 5 s (standaard) is te krap.
|
||||
testTimeout: 20_000,
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
import { monitoringTestEnv } from './config/monitoringTestEnv.ts';
|
||||
|
||||
// Browsertests (BR-TST-05, BR-TST-06) tegen de gebouwde site in dist/client.
|
||||
// Los van vite.config.ts: de Start-plugin en de jsdom-opzet van de
|
||||
@@ -8,6 +9,7 @@ export default defineConfig({
|
||||
resolve: { tsconfigPaths: true },
|
||||
test: {
|
||||
environment: 'node',
|
||||
env: monitoringTestEnv,
|
||||
include: ['e2e/**/*.e2e.ts'],
|
||||
// De CI-runner (Raspberry Pi) is veel trager dan een pc: Chrome starten
|
||||
// en een pagina hydrateren kost daar vele seconden. Tests die alle 11
|
||||
|
||||
Reference in New Issue
Block a user