julien
b427576d5e
## Summary
Make the toggle between the two `apps`-profile access modes — `localhost` (VSCode Remote-SSH port forwarding) and HTTPS hostname (`apf-portal.dev-XX.local` via the mkcert team CA) — a **single-file edit** in `infra/local/.env`. Today the switch needs touching two files (the BFF's own `.env` for the four `ENTRA_*_REDIRECT_URI`, plus `infra/local/.env` for `NX_SERVE_CONFIGURATION`), with the extra cost that the BFF `.env` then carries mode-specific values and can drift from the `localhost`-friendly defaults that native `nx serve` (no Docker) expects.
After this PR:
- `apps/portal-bff/.env` stays at `localhost` defaults always — native `nx serve` works untouched, no mode-aware editing of secrets-bearing files.
- `infra/local/.env` is the **only** file a developer touches to flip between modes. Mode A is the default. Mode B is a five-line block to uncomment.
## How
The four `ENTRA_*_REDIRECT_URI` values are added to the `portal-bff` service's `environment:` block in `dev.compose.yml` with Compose interpolation that defaults to `localhost` and accepts overrides from `infra/local/.env`:
```yaml
ENTRA_REDIRECT_URI: ${ENTRA_REDIRECT_URI:-http://localhost:3000/api/auth/callback}
ENTRA_POST_LOGOUT_REDIRECT_URI: ${ENTRA_POST_LOGOUT_REDIRECT_URI:-http://localhost:4200/}
ENTRA_ADMIN_REDIRECT_URI: ${ENTRA_ADMIN_REDIRECT_URI:-http://localhost:3000/api/admin/auth/callback}
ENTRA_ADMIN_POST_LOGOUT_REDIRECT_URI: ${ENTRA_ADMIN_POST_LOGOUT_REDIRECT_URI:-http://localhost:4300/}
```
Compose's `environment:` block wins over `env_file:`, so the BFF inside the container always sees these — `localhost` when nothing is set in `infra/local/.env`, the HTTPS hostname values when Mode B is enabled. The BFF's own `.env` is irrelevant to the container's redirect URIs in either mode; it remains the canonical source for `localhost`-friendly defaults that native `nx serve` (running outside Docker) reads as before.
## What lands
| File | Change |
| --- | --- |
| `infra/local/dev.compose.yml` | Four `ENTRA_*_REDIRECT_URI` lines added to the `portal-bff` service's `environment:` block with `${VAR:-localhost-default}` interpolation. Inline comment explains the mode-toggle intent and points at `infra/README.md`. |
| `infra/local/.env.example` | The end-of-file "Apps" block is restructured into two clearly labelled profiles: **Mode A — Localhost (DEFAULT)** (an empty block — nothing to set) and **Mode B — HTTPS hostname** (a commented five-line template the developer uncomments). |
| `apps/portal-bff/.env.example` | Comment block above the redirect-URI defaults updated: instead of telling the developer to override these values here, it now explains they stay at `localhost` regardless and points at the compose-level override in `infra/local/.env`. |
| `infra/README.md` | New "**Switching between dev modes — `localhost` vs hostname**" subsection between "Dockerised app dev mode" and "HTTPS dev-server setup". Comparison table + step-by-step for Mode A + pointer to the HTTPS / mkcert subsections that follow for Mode B. |
## Test plan
- [x] Compose validates with no env overrides — the four `ENTRA_*_REDIRECT_URI` resolve to their `localhost` defaults (Mode A).
- [x] Compose validates with the four `ENTRA_*` plus `NX_SERVE_CONFIGURATION=https` set in the environment — the URIs resolve to the HTTPS hostname values (Mode B).
- [ ] **On vm-jg**: starting from a fresh checkout, leave `infra/local/.env` at its `.env.example` defaults. `./infra/local/dev.sh up apps`. Open `http://localhost:4200/` via VSCode Remote-SSH port forwarding. Login succeeds — the BFF receives `ENTRA_REDIRECT_URI=http://localhost:3000/api/auth/callback`.
- [ ] **On vm-jg**: uncomment the five Mode B lines in `infra/local/.env` (replacing `dev-jg` with the actual hostname). `./infra/local/dev.sh down && up apps`. Open `https://apf-portal.dev-jg.local:4200/`. Login succeeds against the HTTPS URIs.
- [ ] **Native WSL `nx serve`** (no Docker): unchanged — keeps reading `apps/portal-bff/.env`'s `localhost` defaults; the compose override never runs in this path.
## Related
- [ADR-0030](docs/decisions/0030-dockerised-dev-mode.md) — dockerised dev mode this finishes for the toggle-between-modes case.
- PR #263 (`feat(spa): opt-in 'https' nx serve config`) — provides the SPA-side TLS plumbing the Mode B switch enables.
- PR #264 (`docs(infra): document team mkcert CA on vm-gitlab`) — documents the trust root that Mode B relies on.
---------
Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr>
Reviewed-on: #265
64 lines
2.8 KiB
Bash
64 lines
2.8 KiB
Bash
# Local-dev secrets and ports for `infra/local/dev.compose.yml`.
|
|
# Copy to `.env` (which is git-ignored) and adjust as needed.
|
|
#
|
|
# cp .env.example .env
|
|
# $EDITOR .env
|
|
|
|
# ---------------------------------------------------------------- Postgres
|
|
# `POSTGRES_PASSWORD` is mandatory — the compose refuses to boot
|
|
# without it.
|
|
#
|
|
# Picking a password — keep it URL-safe in dev. The BFF reads its
|
|
# Postgres URL via `DATABASE_URL` and Prisma demands the URL form;
|
|
# any `@`, `#`, `:`, `/`, `?`, `%`, `&`, `=`, `+`, `;` in the
|
|
# password must be URL-encoded in `apps/portal-bff/.env`. Easiest
|
|
# avoided by sticking to alphanumerics + `-_.~` in dev.
|
|
POSTGRES_USER=portal
|
|
POSTGRES_PASSWORD=portal_dev_change_me
|
|
POSTGRES_DB=portal_dev
|
|
POSTGRES_PORT=5432
|
|
|
|
# ---------------------------------------------------------------- Redis
|
|
# Same — mandatory.
|
|
REDIS_PASSWORD=redis_dev_change_me
|
|
REDIS_PORT=6379
|
|
|
|
# ---------------------------------------------------------------- OTel
|
|
OTEL_GRPC_PORT=4317
|
|
OTEL_HTTP_PORT=4318
|
|
|
|
# ---------------------------------------------------------------- Optional viewers / tooling
|
|
# Only consumed when the matching Compose profile is activated:
|
|
# --profile dbtools → pgweb
|
|
# --profile observability → Jaeger UI
|
|
# --profile serve-static → Caddy serving the production build
|
|
PGWEB_PORT=8081
|
|
JAEGER_UI_PORT=16686
|
|
SERVE_STATIC_PORT=4200
|
|
|
|
# ---------------------------------------------------------------- Apps (`--profile apps`)
|
|
# Two access modes for the SPA dev-servers — pick one. The switch
|
|
# happens entirely in this file (compose interpolates the SPA's nx
|
|
# serve --configuration AND the BFF's ENTRA_*_REDIRECT_URI from here);
|
|
# `apps/portal-bff/.env` stays at its localhost defaults regardless.
|
|
# See infra/README.md → "Switching between dev modes".
|
|
|
|
# === Mode A — Localhost / VSCode port-forwarding (DEFAULT) ===
|
|
# Leave the entire Mode B block below commented. The SPA dev-servers
|
|
# stay on plain HTTP, the BFF receives the `http://localhost:*`
|
|
# redirect URIs already registered in Entra. Browse `http://
|
|
# localhost:4200/` from the workstation — VSCode Remote-SSH auto-
|
|
# forwards 4200 / 4300 / 3000 from the VM.
|
|
|
|
# === Mode B — HTTPS via hostname (apf-portal.dev-XX.local) ===
|
|
# Required when the SPA is accessed via a hostname (Entra refuses
|
|
# `http:` for non-`localhost` redirect URIs — see the team mkcert CA
|
|
# setup in infra/README.md). Replace `dev-jg` with YOUR hostname and
|
|
# uncomment the five lines.
|
|
#
|
|
# NX_SERVE_CONFIGURATION=https
|
|
# ENTRA_REDIRECT_URI=https://apf-portal.dev-jg.local:4200/api/auth/callback
|
|
# ENTRA_POST_LOGOUT_REDIRECT_URI=https://apf-portal.dev-jg.local:4200/
|
|
# ENTRA_ADMIN_REDIRECT_URI=https://apf-portal.dev-jg.local:4300/api/admin/auth/callback
|
|
# ENTRA_ADMIN_POST_LOGOUT_REDIRECT_URI=https://apf-portal.dev-jg.local:4300/
|