Compare commits
1 Commits
chore/ci-p
...
chore/reve
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a3877be51 |
17
.env.example
17
.env.example
@@ -1,23 +1,13 @@
|
|||||||
# Copy to .env for `docker compose up --build`. Local-dev runs (cargo run
|
# Copy to .env for `docker compose up --build`. Local-dev runs (cargo run
|
||||||
# / npm run dev) read backend/.env if present, or pick up the variables
|
# / npm run dev) read backend/.env if present, or pick up the variables
|
||||||
# from your shell.
|
# from your shell.
|
||||||
#
|
|
||||||
# Production note: COOKIE_SECURE=true (the default below) makes browsers
|
|
||||||
# refuse to send the session cookie over plain HTTP. Run with a TLS-
|
|
||||||
# terminating reverse proxy (Caddy, Traefik, nginx) in front — the
|
|
||||||
# compose file here doesn't ship one. Local/dev runs without HTTPS
|
|
||||||
# should set COOKIE_SECURE=false.
|
|
||||||
|
|
||||||
# ----- Postgres -----
|
# ----- Postgres -----
|
||||||
# These are read by the Postgres container *and* by DATABASE_URL below;
|
# These are read by the Postgres container *and* by DATABASE_URL below;
|
||||||
# changing them after the first boot won't migrate existing data, so set
|
# changing them after the first boot won't migrate existing data, so set
|
||||||
# them up front for any new deployment.
|
# them up front for any new deployment.
|
||||||
#
|
|
||||||
# POSTGRES_PASSWORD is REQUIRED — docker-compose.yml fails fast if it
|
|
||||||
# isn't set in this file, to prevent a deploy without an .env booting
|
|
||||||
# Postgres with a publicly-known credential.
|
|
||||||
POSTGRES_USER=mangalord
|
POSTGRES_USER=mangalord
|
||||||
POSTGRES_PASSWORD=change-me-to-a-strong-random-string
|
POSTGRES_PASSWORD=mangalord
|
||||||
POSTGRES_DB=mangalord
|
POSTGRES_DB=mangalord
|
||||||
|
|
||||||
# ----- Backend -----
|
# ----- Backend -----
|
||||||
@@ -61,3 +51,8 @@ MAX_FILE_BYTES=20971520
|
|||||||
# internal docker network. Override only if you're running the
|
# internal docker network. Override only if you're running the
|
||||||
# frontend container against a backend somewhere else.
|
# frontend container against a backend somewhere else.
|
||||||
BACKEND_URL=http://backend:8080
|
BACKEND_URL=http://backend:8080
|
||||||
|
# Per-request wall-clock cap for the /api/* reverse proxy (milliseconds).
|
||||||
|
# Default 300000 (5 min) covers a typical 200 MiB chapter upload over
|
||||||
|
# 25 Mbps; raise for users on slower upstream links or lower if a
|
||||||
|
# tighter front proxy already bounds the request lifetime.
|
||||||
|
BACKEND_PROXY_TIMEOUT_MS=300000
|
||||||
|
|||||||
@@ -3,8 +3,6 @@ name: deploy
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -65,10 +63,6 @@ jobs:
|
|||||||
build-and-push:
|
build-and-push:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [test-backend, test-frontend]
|
needs: [test-backend, test-frontend]
|
||||||
# PRs only run the test jobs; build + deploy are reserved for
|
|
||||||
# post-merge pushes to main. Without this gate every PR would push
|
|
||||||
# a tagged image to the registry and SSH-deploy to prod.
|
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
outputs:
|
outputs:
|
||||||
image_tag: ${{ steps.meta.outputs.image_tag }}
|
image_tag: ${{ steps.meta.outputs.image_tag }}
|
||||||
version: ${{ steps.meta.outputs.version }}
|
version: ${{ steps.meta.outputs.version }}
|
||||||
@@ -123,7 +117,6 @@ jobs:
|
|||||||
deploy:
|
deploy:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: build-and-push
|
needs: build-and-push
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
steps:
|
steps:
|
||||||
- name: SSH deploy
|
- name: SSH deploy
|
||||||
uses: appleboy/ssh-action@v1.0.3
|
uses: appleboy/ssh-action@v1.0.3
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
# Production-like compose. Requires a populated `.env` next to this
|
|
||||||
# file: at minimum POSTGRES_PASSWORD must be set to a non-default
|
|
||||||
# value (the `?required` form below fails fast otherwise). The
|
|
||||||
# frontend container expects HTTPS in front (Caddy/Traefik/nginx)
|
|
||||||
# because COOKIE_SECURE=true browsers will refuse to send the session
|
|
||||||
# cookie over plain HTTP.
|
|
||||||
services:
|
services:
|
||||||
postgres:
|
postgres:
|
||||||
image: postgres:16-alpine
|
image: postgres:16-alpine
|
||||||
environment:
|
environment:
|
||||||
POSTGRES_USER: ${POSTGRES_USER:-mangalord}
|
POSTGRES_USER: ${POSTGRES_USER:-mangalord}
|
||||||
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?POSTGRES_PASSWORD must be set in .env}
|
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-mangalord}
|
||||||
POSTGRES_DB: ${POSTGRES_DB:-mangalord}
|
POSTGRES_DB: ${POSTGRES_DB:-mangalord}
|
||||||
volumes:
|
volumes:
|
||||||
- postgres-data:/var/lib/postgresql/data
|
- postgres-data:/var/lib/postgresql/data
|
||||||
@@ -25,7 +19,7 @@ services:
|
|||||||
postgres:
|
postgres:
|
||||||
condition: service_healthy
|
condition: service_healthy
|
||||||
environment:
|
environment:
|
||||||
DATABASE_URL: postgres://${POSTGRES_USER:-mangalord}:${POSTGRES_PASSWORD:?POSTGRES_PASSWORD must be set in .env}@postgres:5432/${POSTGRES_DB:-mangalord}
|
DATABASE_URL: postgres://${POSTGRES_USER:-mangalord}:${POSTGRES_PASSWORD:-mangalord}@postgres:5432/${POSTGRES_DB:-mangalord}
|
||||||
BIND_ADDRESS: 0.0.0.0:8080
|
BIND_ADDRESS: 0.0.0.0:8080
|
||||||
STORAGE_DIR: /var/lib/mangalord/storage
|
STORAGE_DIR: /var/lib/mangalord/storage
|
||||||
RUST_LOG: ${RUST_LOG:-info,mangalord=debug}
|
RUST_LOG: ${RUST_LOG:-info,mangalord=debug}
|
||||||
|
|||||||
@@ -118,4 +118,77 @@ describe('hooks.server proxy', () => {
|
|||||||
expect(body.error.code).toBe('upstream_unavailable');
|
expect(body.error.code).toBe('upstream_unavailable');
|
||||||
expect(errSpy).toHaveBeenCalled();
|
expect(errSpy).toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('strips every hop-by-hop header listed in RFC 7230 §6.1', async () => {
|
||||||
|
// Defence in depth: axum doesn't emit these, but a future
|
||||||
|
// middleware that did would otherwise leak per-connection
|
||||||
|
// state across the proxy boundary.
|
||||||
|
fetchSpy.mockResolvedValueOnce(new Response('[]', { status: 200 }));
|
||||||
|
const resolve = vi.fn();
|
||||||
|
await handle({
|
||||||
|
event: makeEvent('/api/v1/health', {
|
||||||
|
headers: {
|
||||||
|
host: 'app.example.com',
|
||||||
|
'content-length': '0',
|
||||||
|
connection: 'keep-alive',
|
||||||
|
'keep-alive': 'timeout=5',
|
||||||
|
'proxy-authenticate': 'Basic realm=x',
|
||||||
|
'proxy-authorization': 'Basic xyz',
|
||||||
|
te: 'trailers',
|
||||||
|
trailer: 'Expires',
|
||||||
|
'transfer-encoding': 'chunked',
|
||||||
|
upgrade: 'websocket',
|
||||||
|
// A non-hop-by-hop header to ensure non-targets
|
||||||
|
// aren't accidentally stripped.
|
||||||
|
'x-custom': 'pass-through'
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
resolve
|
||||||
|
});
|
||||||
|
const init = fetchSpy.mock.calls[0][1] as RequestInit;
|
||||||
|
const headers = init.headers as Headers;
|
||||||
|
for (const h of [
|
||||||
|
'host',
|
||||||
|
'content-length',
|
||||||
|
'connection',
|
||||||
|
'keep-alive',
|
||||||
|
'proxy-authenticate',
|
||||||
|
'proxy-authorization',
|
||||||
|
'te',
|
||||||
|
'trailer',
|
||||||
|
'transfer-encoding',
|
||||||
|
'upgrade'
|
||||||
|
]) {
|
||||||
|
expect(headers.get(h), `${h} should be stripped`).toBeNull();
|
||||||
|
}
|
||||||
|
expect(headers.get('x-custom')).toBe('pass-through');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('aborts and returns 502 when the upstream stalls past the timeout', async () => {
|
||||||
|
const errSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
|
||||||
|
// Simulate an aborted fetch (AbortController.abort() raises a
|
||||||
|
// DOMException with name 'AbortError' on Node's fetch). The
|
||||||
|
// handler should treat it as the same upstream_unavailable
|
||||||
|
// 502 it uses for any other network failure.
|
||||||
|
const abortErr = new DOMException('aborted', 'AbortError');
|
||||||
|
fetchSpy.mockRejectedValueOnce(abortErr);
|
||||||
|
|
||||||
|
const resolve = vi.fn();
|
||||||
|
const resp = await handle({ event: makeEvent('/api/v1/slow'), resolve });
|
||||||
|
expect(resp.status).toBe(502);
|
||||||
|
const body = await resp.json();
|
||||||
|
expect(body.error.code).toBe('upstream_unavailable');
|
||||||
|
expect(errSpy).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('attaches an AbortSignal to the upstream fetch so it can time out', async () => {
|
||||||
|
fetchSpy.mockResolvedValueOnce(new Response('[]', { status: 200 }));
|
||||||
|
const resolve = vi.fn();
|
||||||
|
await handle({ event: makeEvent('/api/v1/health'), resolve });
|
||||||
|
const init = fetchSpy.mock.calls[0][1] as RequestInit;
|
||||||
|
expect(init.signal).toBeInstanceOf(AbortSignal);
|
||||||
|
// The signal hasn't fired (handler returned in time), but its
|
||||||
|
// presence is the contract this test is pinning.
|
||||||
|
expect(init.signal?.aborted).toBe(false);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -12,20 +12,66 @@ import type { Handle } from '@sveltejs/kit';
|
|||||||
|
|
||||||
const BACKEND_URL = process.env.BACKEND_URL ?? 'http://localhost:8080';
|
const BACKEND_URL = process.env.BACKEND_URL ?? 'http://localhost:8080';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hop-by-hop headers per RFC 7230 §6.1. These are scoped to a single
|
||||||
|
* transport-level connection and must not be forwarded by a proxy.
|
||||||
|
* Plus `host` and `content-length`: `host` would mislead the backend
|
||||||
|
* about its origin, and `content-length` is recomputed by the upstream
|
||||||
|
* fetch from the body stream.
|
||||||
|
*/
|
||||||
|
const HOP_BY_HOP_HEADERS = [
|
||||||
|
'host',
|
||||||
|
'content-length',
|
||||||
|
'connection',
|
||||||
|
'keep-alive',
|
||||||
|
'proxy-authenticate',
|
||||||
|
'proxy-authorization',
|
||||||
|
'te',
|
||||||
|
'trailer',
|
||||||
|
'transfer-encoding',
|
||||||
|
'upgrade'
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cap each proxied request at 5 minutes. The bound exists to surface
|
||||||
|
* a wedged backend (stuck on a slow DB query, deadlocked, etc.) as a
|
||||||
|
* 502 rather than letting the browser request hang indefinitely.
|
||||||
|
*
|
||||||
|
* The default leans toward the slow-upload end of the spectrum: at a
|
||||||
|
* 1 Mbps upstream, a 200 MiB chapter upload (the default
|
||||||
|
* `MAX_REQUEST_BYTES` cap) needs ~27 minutes; 300 s covers the more
|
||||||
|
* realistic 25 Mbps urban-broadband case (~64 s for the same upload)
|
||||||
|
* with comfortable headroom. Operators serving very slow clients
|
||||||
|
* should raise `BACKEND_PROXY_TIMEOUT_MS`; operators behind a
|
||||||
|
* tighter upstream proxy may want to lower it. A future improvement
|
||||||
|
* is an idle-based timeout (reset per chunk) instead of this
|
||||||
|
* wall-clock budget — that's a fair bit more code, deferred.
|
||||||
|
*/
|
||||||
|
const PROXY_TIMEOUT_MS = (() => {
|
||||||
|
const raw = process.env.BACKEND_PROXY_TIMEOUT_MS;
|
||||||
|
const n = raw ? Number(raw) : 300_000;
|
||||||
|
return Number.isFinite(n) && n > 0 ? n : 300_000;
|
||||||
|
})();
|
||||||
|
|
||||||
export const handle: Handle = async ({ event, resolve }) => {
|
export const handle: Handle = async ({ event, resolve }) => {
|
||||||
if (event.url.pathname.startsWith('/api/')) {
|
if (event.url.pathname.startsWith('/api/')) {
|
||||||
const target = `${BACKEND_URL}${event.url.pathname}${event.url.search}`;
|
const target = `${BACKEND_URL}${event.url.pathname}${event.url.search}`;
|
||||||
|
|
||||||
// Strip hop-by-hop headers — `host` would mislead the backend
|
|
||||||
// about the origin, and `content-length` will be recomputed.
|
|
||||||
const headers = new Headers(event.request.headers);
|
const headers = new Headers(event.request.headers);
|
||||||
headers.delete('host');
|
for (const h of HOP_BY_HOP_HEADERS) headers.delete(h);
|
||||||
headers.delete('content-length');
|
|
||||||
|
// AbortController times the upstream fetch out so a backend
|
||||||
|
// wedged on a slow DB query doesn't keep the browser request
|
||||||
|
// hanging forever. The `signal` is also wired into the
|
||||||
|
// RequestInit so the body stream is cancelled cleanly.
|
||||||
|
const ctrl = new AbortController();
|
||||||
|
const timeoutHandle = setTimeout(() => ctrl.abort(), PROXY_TIMEOUT_MS);
|
||||||
|
|
||||||
const init: RequestInit & { duplex?: 'half' } = {
|
const init: RequestInit & { duplex?: 'half' } = {
|
||||||
method: event.request.method,
|
method: event.request.method,
|
||||||
headers,
|
headers,
|
||||||
redirect: 'manual'
|
redirect: 'manual',
|
||||||
|
signal: ctrl.signal
|
||||||
};
|
};
|
||||||
if (event.request.method !== 'GET' && event.request.method !== 'HEAD') {
|
if (event.request.method !== 'GET' && event.request.method !== 'HEAD') {
|
||||||
init.body = event.request.body;
|
init.body = event.request.body;
|
||||||
@@ -39,11 +85,13 @@ export const handle: Handle = async ({ event, resolve }) => {
|
|||||||
upstream = await fetch(target, init);
|
upstream = await fetch(target, init);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
// Network-layer failure (DNS / connection refused / TLS
|
// Network-layer failure (DNS / connection refused / TLS
|
||||||
// handshake) — most commonly "backend container restarting".
|
// handshake / abort by timeout) — most commonly "backend
|
||||||
// SvelteKit's default 500 would be an HTML page that
|
// container restarting". SvelteKit's default 500 would be
|
||||||
// client.ts can't .json(), which masks the real cause. Emit
|
// an HTML page that client.ts can't .json(), which masks
|
||||||
// the standard envelope with a dedicated code instead.
|
// the real cause. Emit the standard envelope with a
|
||||||
|
// dedicated code instead.
|
||||||
console.error('Proxy to backend failed:', e);
|
console.error('Proxy to backend failed:', e);
|
||||||
|
clearTimeout(timeoutHandle);
|
||||||
return new Response(
|
return new Response(
|
||||||
JSON.stringify({
|
JSON.stringify({
|
||||||
error: {
|
error: {
|
||||||
@@ -58,6 +106,7 @@ export const handle: Handle = async ({ event, resolve }) => {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
clearTimeout(timeoutHandle);
|
||||||
return new Response(upstream.body, {
|
return new Response(upstream.body, {
|
||||||
status: upstream.status,
|
status: upstream.status,
|
||||||
statusText: upstream.statusText,
|
statusText: upstream.statusText,
|
||||||
|
|||||||
Reference in New Issue
Block a user