045ff924a8
## Summary
Fix `./infra/local/dev.sh up all` failing on `port is already allocated` for port 4200: the `apps` profile (ADR-0030 — Angular dev-server on 4200) and the `serve-static` profile (Caddy reverse proxy for the production build, also defaulting to 4200) cannot run together. `up all` expanded to "every profile" without taking that conflict into account.
After this PR, `./infra/local/dev.sh up all` brings up the comprehensive dev stack — infra + `dbtools` + `observability` + `apps` — and `serve-static` stays available via the explicit `./infra/local/dev.sh up serve-static` invocation when a developer actually wants to test a production build.
## Root cause
`dev.compose.yml` publishes port 4200 in two services:
- `portal-shell` (profile `apps`): `${SHELL_PORT:-4200}:4200` — Angular dev-server.
- `serve-static` (profile `serve-static`): `${SERVE_STATIC_PORT:-4200}:4200` — Caddy serving the production build.
`dev.sh`'s `ALL_PROFILES` array was used both as:
1. the teardown / status / logs scope (so a manually-started profile is still reachable for `down` and friends), **and**
2. the expansion target for `up all`.
Conflating the two meant `up all` always tried to start `serve-static` even when `apps` was in scope — and the Docker port-publishing collision aborted the whole `up`.
## Fix
Split the two concerns:
```bash
# Every profile that exists — teardown / status / logs scope.
ALL_PROFILES=(dbtools observability serve-static apps)
# What `up all` expands to — serve-static excluded.
UP_ALL_PROFILES=(dbtools observability apps)
```
`serve-static` stays accessible:
- via explicit `dev.sh up serve-static` (the original way),
- via `dev.sh down` / `status` / `logs` (still in `ALL_PROFILES`).
Why exclude `serve-static` from `up all` rather than `apps`:
- `apps` is the new "no native toolchain" dev mode (ADR-0030) — it _is_ what a comprehensive dev `up` should boot.
- `serve-static` has zero value without a prior `nx build --configuration=production` (Caddy serves an empty `dist/` → 404 everywhere). Auto-starting it in `up all` would put a 404-machine in the stack by default.
- The port number can stay at the Angular convention (4200) for the dev-server, which matches the devcontainer's `forwardPorts`.
## What lands
| File | Change |
| --- | --- |
| `infra/local/dev.sh` | Split `ALL_PROFILES` (teardown scope) and `UP_ALL_PROFILES` (`up all` scope). Inline comment explains the exclusion of `serve-static`. Usage text updated. |
| `infra/README.md` | Cheat-sheet row for `up all` clarifies the new behaviour. |
## Out of scope
The script is **environment-agnostic** — it works identically when invoked on the local workstation or on `vm-dev`. Port publishing is on `0.0.0.0` by default, so services are reachable from a remote browser via the VM IP without any script change. The user-visible difference is only the URL host (`localhost:4200` locally vs `<vm-ip>:4200` from the workstation against the VM). No local-vs-vm mode in the script.
## Test plan
- [x] `bash -n infra/local/dev.sh` passes.
- [x] `./infra/local/dev.sh help` shows the updated `up all` description.
- [ ] **On vm-dev**: `./infra/local/dev.sh up all` brings up postgres / redis / otel-collector / pgweb / jaeger / apps-deps (exits 0) / portal-bff / portal-shell / portal-admin without port conflicts; `serve-static` is **not** started.
- [ ] `./infra/local/dev.sh up serve-static` (explicit) still starts Caddy on 4200, provided `apps` is **not** already up.
- [ ] `./infra/local/dev.sh down` and `status` still see serve-static if it was started manually (ALL_PROFILES retains it).
## Related
- Surfaced by the ADR-0030 dockerised dev mode VM validation — `up all` was added to the user-facing surface in that PR; this PR finishes wiring it.
- The port collision was flagged as a caveat in the ADR-0030 PR body ("don't run `apps` and `serve-static` together"). This PR turns the caveat into a script invariant instead of relying on the user to remember.
---------
Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr>
Reviewed-on: #261
173 lines
5.6 KiB
Bash
Executable File
173 lines
5.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Convenience wrapper around infra/local/dev.compose.yml. Documented
|
|
# in infra/README.md → "Local-dev stack" → "Convenience script".
|
|
#
|
|
# Hides the Compose-profile gotcha: `docker compose down` only acts
|
|
# on services whose profile is currently active, so anything brought
|
|
# up with `--profile X` keeps running unless the same flag is on
|
|
# `down`. Every teardown / status / log command in this script
|
|
# always includes every profile in scope, so profile-gated services
|
|
# are visible and stoppable.
|
|
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
COMPOSE_FILE="${SCRIPT_DIR}/dev.compose.yml"
|
|
|
|
# Every profile defined in dev.compose.yml, used as the teardown /
|
|
# status / logs scope so a profile started under a custom flag is
|
|
# always reachable later. Keep in sync if a new profile is added.
|
|
ALL_PROFILES=(dbtools observability serve-static apps)
|
|
|
|
# What `up all` expands to — everything you want running for a full
|
|
# dev session. `serve-static` is deliberately excluded:
|
|
# - it would collide with `apps` on host port 4200 (both publish the
|
|
# SPA there by default — Caddy serves the production build, the
|
|
# `apps` profile runs the Angular dev-server);
|
|
# - without a prior `nx build --configuration=production`, Caddy
|
|
# just 404s every request, so it adds nothing to a comprehensive
|
|
# `up all` invocation. Users who actually need it run
|
|
# `./infra/local/dev.sh up serve-static` (and `down` still tears
|
|
# it down because it's in ALL_PROFILES above).
|
|
UP_ALL_PROFILES=(dbtools observability apps)
|
|
|
|
# Build "--profile p1 --profile p2 …" as separate arguments.
|
|
build_all_profile_flags() {
|
|
local p
|
|
ALL_PROFILE_FLAGS=()
|
|
for p in "${ALL_PROFILES[@]}"; do
|
|
ALL_PROFILE_FLAGS+=(--profile "$p")
|
|
done
|
|
}
|
|
|
|
# Run docker compose with every profile flagged in.
|
|
dc_all() {
|
|
build_all_profile_flags
|
|
docker compose -f "$COMPOSE_FILE" "${ALL_PROFILE_FLAGS[@]}" "$@"
|
|
}
|
|
|
|
# Run docker compose with no profiles (core services only).
|
|
dc_core() {
|
|
docker compose -f "$COMPOSE_FILE" "$@"
|
|
}
|
|
|
|
# Run `up -d` with a custom set of profiles.
|
|
up_with_profiles() {
|
|
local p
|
|
local -a flags=()
|
|
for p in "$@"; do
|
|
flags+=(--profile "$p")
|
|
done
|
|
docker compose -f "$COMPOSE_FILE" "${flags[@]}" up -d
|
|
}
|
|
|
|
usage() {
|
|
cat <<'USAGE'
|
|
Usage: ./infra/local/dev.sh <command> [args]
|
|
|
|
Commands:
|
|
up [target...] Bring up the stack.
|
|
Targets:
|
|
(none) core only (postgres + redis + otel-collector)
|
|
all core + dbtools + observability + apps —
|
|
the full dev stack. serve-static is
|
|
EXCLUDED because it collides with apps
|
|
on port 4200; run it explicitly when
|
|
you actually want to serve a prod build.
|
|
dbtools core + pgweb
|
|
observability core + jaeger
|
|
serve-static core + caddy (production-build reverse proxy)
|
|
apps core + the three Nx dev servers in
|
|
Docker — no native Node/pnpm needed
|
|
(ADR-0030). portal-bff:3000,
|
|
portal-shell:4200, portal-admin:4300.
|
|
Multiple targets allowed (e.g. `up dbtools observability`).
|
|
|
|
down [-v] Tear the stack down. Always runs with every
|
|
profile in scope, so profile-gated services
|
|
(pgweb, jaeger) are caught too. -v also wipes
|
|
the named Docker volumes.
|
|
|
|
stop <service> Stop a single service (containers stay around).
|
|
Use `up <service>` (or restart) to bring it back.
|
|
|
|
restart <service> Restart a single service.
|
|
|
|
status docker compose ps, with every profile in scope.
|
|
|
|
logs [service] Follow logs (one service or all of them).
|
|
|
|
exec <service> <cmd> Run a command inside a running service container.
|
|
|
|
help Show this help.
|
|
|
|
<other> [args...] Anything else is passed through to
|
|
`docker compose -f dev.compose.yml ...` with
|
|
every profile in scope.
|
|
|
|
Examples:
|
|
./infra/local/dev.sh up
|
|
./infra/local/dev.sh up all
|
|
./infra/local/dev.sh up apps
|
|
./infra/local/dev.sh up observability
|
|
./infra/local/dev.sh down -v
|
|
./infra/local/dev.sh stop pgweb
|
|
./infra/local/dev.sh logs otel-collector
|
|
./infra/local/dev.sh exec postgres psql -U "$POSTGRES_USER" -d "$POSTGRES_DB"
|
|
USAGE
|
|
}
|
|
|
|
require_args() {
|
|
local verb="$1"
|
|
local n="$2"
|
|
local hint="$3"
|
|
if [[ $# -lt $((3 + n)) ]]; then
|
|
echo "Error: '$verb' requires $hint." >&2
|
|
echo "Try: ./infra/local/dev.sh help" >&2
|
|
exit 64
|
|
fi
|
|
}
|
|
|
|
cmd="${1:-help}"
|
|
[[ $# -gt 0 ]] && shift
|
|
|
|
case "$cmd" in
|
|
up | start)
|
|
if [[ $# -eq 0 ]]; then
|
|
dc_core up -d
|
|
elif [[ "$1" == "all" ]]; then
|
|
up_with_profiles "${UP_ALL_PROFILES[@]}"
|
|
else
|
|
up_with_profiles "$@"
|
|
fi
|
|
;;
|
|
down)
|
|
dc_all down "$@"
|
|
;;
|
|
stop)
|
|
require_args stop 1 "a service name (use 'down' to tear down the whole stack)" "$@"
|
|
dc_all stop "$@"
|
|
;;
|
|
restart)
|
|
require_args restart 1 "a service name" "$@"
|
|
dc_all restart "$@"
|
|
;;
|
|
status | ps)
|
|
dc_all ps "$@"
|
|
;;
|
|
logs)
|
|
dc_all logs -f "$@"
|
|
;;
|
|
exec)
|
|
require_args exec 2 "a service name and a command" "$@"
|
|
dc_all exec "$@"
|
|
;;
|
|
help | -h | --help | "")
|
|
usage
|
|
;;
|
|
*)
|
|
# Pass-through to docker compose, with profiles in scope.
|
|
dc_all "$cmd" "$@"
|
|
;;
|
|
esac
|