@hexlet/frontend-blog-server 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/dist/bin/cli.js +54 -2
- package/dist/src/app.d.ts +1 -0
- package/dist/src/app.js +20 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -14,6 +14,19 @@ npx frontend-blog-server start -s ./dist # API и собранный SPA из
|
|
|
14
14
|
|
|
15
15
|
С флагом `-s` сервер раздаёт сборку по `/` и API по `/api`, так что фронтенд и API живут на одном origin. На любой путь вне `/api` сервер отдаёт `index.html`, и клиентский роутинг работает при прямом заходе по адресу. Порт берётся из `-p`, затем из переменной `PORT`, иначе 8080.
|
|
16
16
|
|
|
17
|
+
### Приложение со своим сервером (Next.js)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx frontend-blog-server start --app "node server.js" # Next.js из сборки standalone
|
|
21
|
+
npx frontend-blog-server start --app "node server.js" --app-port 3002 # другой внутренний порт
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
С флагом `--app` сервер блога запускает команду приложения и ждёт, пока оно откроет свой порт (по умолчанию 3001). Запросы к `/api` сервер блога обрабатывает сам, остальные передаёт приложению вместе с исходным хостом в `X-Forwarded-Host`. Наружу открыт один порт из `-p` или `PORT`, а `/api/health` отвечает, только когда поднято и приложение.
|
|
25
|
+
|
|
26
|
+
Приложение получает три переменные окружения. `PORT` и `HOSTNAME=127.0.0.1` задают адрес, на котором оно слушает. `BLOG_API_URL` содержит адрес API для серверного кода, например `http://127.0.0.1:8080`, потому что `fetch` на сервере относительный путь не принимает. Код в браузере обращается к API по относительному пути `/api/...`.
|
|
27
|
+
|
|
28
|
+
Если приложение завершается, сервер блога завершается вместе с ним.
|
|
29
|
+
|
|
17
30
|
Стартовые статьи по умолчанию на русском и английском. Переменная `SEED_LOCALE=es` включает испанский набор с теми же пользователями, категориями и порядком статей. Другое значение останавливает запуск с ошибкой.
|
|
18
31
|
|
|
19
32
|
## Контракт API
|
package/dist/bin/cli.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { spawn } from "node:child_process";
|
|
3
|
+
import { connect } from "node:net";
|
|
3
4
|
import { cpSync, existsSync, mkdirSync, readFileSync } from "node:fs";
|
|
4
5
|
import { createRequire } from "node:module";
|
|
5
6
|
import { dirname, join, resolve } from "node:path";
|
|
@@ -15,7 +16,9 @@ cli
|
|
|
15
16
|
.option("-a, --address <address>", "host to listen on", { default: "0.0.0.0" })
|
|
16
17
|
.option("-p, --port <port>", "port to listen on", { default: process.env.PORT ?? "8080" })
|
|
17
18
|
.option("-s, --static <dir>", "serve a built SPA from <dir> with SPA fallback")
|
|
18
|
-
.
|
|
19
|
+
.option("--app <command>", "run an app server (Next.js) and proxy everything outside /api to it")
|
|
20
|
+
.option("--app-port <port>", "port for the app server started by --app", { default: "3001" })
|
|
21
|
+
.action(async (options) => {
|
|
19
22
|
// Запуск через Fastify CLI (программно): резолвим бинарь fastify-cli и стартуем плагин.
|
|
20
23
|
const pkgPath = require.resolve("fastify-cli/package.json");
|
|
21
24
|
const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
|
|
@@ -25,6 +28,24 @@ cli
|
|
|
25
28
|
const env = { ...process.env };
|
|
26
29
|
if (options.static)
|
|
27
30
|
env.SPA_DIR = resolve(process.cwd(), options.static);
|
|
31
|
+
let appChild;
|
|
32
|
+
if (options.app) {
|
|
33
|
+
// Приложение слушает только loopback, снаружи его видно через прокси сервера блога.
|
|
34
|
+
// BLOG_API_URL нужен серверному коду приложения: относительный адрес там не работает.
|
|
35
|
+
appChild = spawn(options.app, {
|
|
36
|
+
shell: true,
|
|
37
|
+
stdio: "inherit",
|
|
38
|
+
env: {
|
|
39
|
+
...process.env,
|
|
40
|
+
PORT: String(options.appPort),
|
|
41
|
+
HOSTNAME: "127.0.0.1",
|
|
42
|
+
BLOG_API_URL: `http://127.0.0.1:${options.port}`,
|
|
43
|
+
},
|
|
44
|
+
});
|
|
45
|
+
appChild.on("exit", (code) => process.exit(code ?? 1));
|
|
46
|
+
await waitForPort(Number(options.appPort));
|
|
47
|
+
env.APP_UPSTREAM = `http://127.0.0.1:${options.appPort}`;
|
|
48
|
+
}
|
|
28
49
|
const child = spawn(process.execPath, [
|
|
29
50
|
fastifyCli,
|
|
30
51
|
"start",
|
|
@@ -36,8 +57,39 @@ cli
|
|
|
36
57
|
String(options.port),
|
|
37
58
|
appPath,
|
|
38
59
|
], { stdio: "inherit", env });
|
|
39
|
-
child.on("exit", (code) =>
|
|
60
|
+
child.on("exit", (code) => {
|
|
61
|
+
appChild?.kill();
|
|
62
|
+
process.exit(code ?? 0);
|
|
63
|
+
});
|
|
64
|
+
for (const signal of ["SIGINT", "SIGTERM"]) {
|
|
65
|
+
process.on(signal, () => {
|
|
66
|
+
appChild?.kill(signal);
|
|
67
|
+
child.kill(signal);
|
|
68
|
+
});
|
|
69
|
+
}
|
|
40
70
|
});
|
|
71
|
+
// Сервер блога стартует после приложения, поэтому /api/health отвечает, только когда
|
|
72
|
+
// поднято и то и другое. Проверка здоровья в compose и на Render на это опирается.
|
|
73
|
+
function waitForPort(port, timeoutMs = 60_000) {
|
|
74
|
+
const deadline = Date.now() + timeoutMs;
|
|
75
|
+
return new Promise((resolvePromise, reject) => {
|
|
76
|
+
const attempt = () => {
|
|
77
|
+
const socket = connect(port, "127.0.0.1");
|
|
78
|
+
socket.once("connect", () => {
|
|
79
|
+
socket.end();
|
|
80
|
+
resolvePromise();
|
|
81
|
+
});
|
|
82
|
+
socket.once("error", () => {
|
|
83
|
+
socket.destroy();
|
|
84
|
+
if (Date.now() > deadline)
|
|
85
|
+
reject(new Error(`App did not open port ${port}`));
|
|
86
|
+
else
|
|
87
|
+
setTimeout(attempt, 200);
|
|
88
|
+
});
|
|
89
|
+
};
|
|
90
|
+
attempt();
|
|
91
|
+
});
|
|
92
|
+
}
|
|
41
93
|
// --- contract: извлечь контракт API (TypeSpec + OpenAPI), запечённый в пакет ---
|
|
42
94
|
cli
|
|
43
95
|
.command("contract [dir]", "извлечь контракт API (openapi.yaml + main.tsp) в каталог (по умолчанию ./contract)")
|
package/dist/src/app.d.ts
CHANGED
package/dist/src/app.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { existsSync } from "node:fs";
|
|
2
2
|
import { resolve } from "node:path";
|
|
3
|
+
import fastifyHttpProxy from "@fastify/http-proxy";
|
|
3
4
|
import fastifyStatic from "@fastify/static";
|
|
4
5
|
import { z } from "zod";
|
|
5
6
|
import { createState, verifyPassword, } from "./state.js";
|
|
@@ -38,13 +39,31 @@ const app = async (fastify, options) => {
|
|
|
38
39
|
const state = createState(parseSeedLocale(options.seedLocale ?? process.env.SEED_LOCALE));
|
|
39
40
|
// Собранный SPA из опции плагина (тесты) или из SPA_DIR (CLI `start -s`). Фронтенд и API
|
|
40
41
|
// живут на одном origin, поэтому CORS не нужен: в разработке запросы проксирует дев-сервер.
|
|
41
|
-
const
|
|
42
|
+
const upstream = options.upstream ?? process.env.APP_UPSTREAM;
|
|
43
|
+
const staticDir = upstream ? undefined : (options.staticDir ?? process.env.SPA_DIR);
|
|
42
44
|
const root = staticDir ? resolve(process.cwd(), staticDir) : undefined;
|
|
43
45
|
if (root && !existsSync(root))
|
|
44
46
|
fastify.log.warn(`SPA directory ${root} not found, serving API only`);
|
|
45
47
|
const serveSpa = root !== undefined && existsSync(root);
|
|
46
48
|
if (serveSpa)
|
|
47
49
|
await fastify.register(fastifyStatic, { root, prefix: "/" });
|
|
50
|
+
if (upstream) {
|
|
51
|
+
// Next.js проверяет server actions сравнением Origin с X-Forwarded-Host или Host. Прокси
|
|
52
|
+
// переписывает Host на адрес upstream, поэтому исходный хост уходит в X-Forwarded-Host.
|
|
53
|
+
await fastify.register(fastifyHttpProxy, {
|
|
54
|
+
upstream,
|
|
55
|
+
prefix: "/",
|
|
56
|
+
replyOptions: {
|
|
57
|
+
rewriteRequestHeaders: (request, headers) => ({
|
|
58
|
+
...headers,
|
|
59
|
+
"x-forwarded-host": request.headers["x-forwarded-host"] ?? request.headers.host,
|
|
60
|
+
"x-forwarded-proto": request.headers["x-forwarded-proto"] ?? request.protocol,
|
|
61
|
+
}),
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
// Неизвестный путь API остаётся ошибкой API и в Next.js не уходит.
|
|
65
|
+
fastify.all("/api/*", async (_request, reply) => fail(reply, 404, "not_found", "Resource not found"));
|
|
66
|
+
}
|
|
48
67
|
fastify.setNotFoundHandler((request, reply) => {
|
|
49
68
|
if (serveSpa && !request.raw.url?.startsWith("/api")) {
|
|
50
69
|
reply.sendFile("index.html");
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hexlet/frontend-blog-server",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "Hexlet-provided backend for the blog project. Implements the contract/ OpenAPI in-memory and serves a built SPA.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/src/app.js",
|
|
@@ -44,6 +44,7 @@
|
|
|
44
44
|
},
|
|
45
45
|
"license": "MIT",
|
|
46
46
|
"dependencies": {
|
|
47
|
+
"@fastify/http-proxy": "^11.6.9",
|
|
47
48
|
"@fastify/static": "^10.1.8",
|
|
48
49
|
"cac": "^7.1.0",
|
|
49
50
|
"fastify": "^5.12.7",
|