allow proxy config during ng build when using `outputMode: server`
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- angular, typescript
- 領域
- build-system, cli
調査の方向性
報告されている outputMode: server の ng build フローから始め、ng serve のプロキシ設定の動作と比較してください。提供されている server.ts のリクエストハンドラーと serve-angular-ssr.ts の catch-all ルートを確認し、/api リクエストがどこで再帰するのかを把握してください。これらの API リクエストに対するアプリケーションフォールバックを必要とせずに、ビルドでルートを抽出できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Command
build
Description
I am facing a separate, but similar issue to #29005
@alan-agius4, in my case, the 30-sec timeout occurs because I am making api calls.
My setup is pretty standard:
- 2 angular 'client' apps (ssr with fastify)
- one 'server' api (fastify)
The '/api' route on both clients are expected to point to the same api instance
In production, '/api' on both client apps are routed the api via nginx and docker configuration
In development, I serve both the api and client locally, and use ng serve's proxy config
This means I can avoid having to stream my api data through my client's container. This is especially a win for production environment.
Because of this setup, I do not need to have a separate 'api' route in my client application.
BUT...
When angular tries to build my app, to extract the routes,
- it makes request to the angular engine
- in order to render the app, angular engine needs to make some api calls. Those api calls go to '/api'.
- but there is no nginx config, or proxy config, so it passes the request to the client's fastify instance.
- the client fastify instance does not have a handler for '/api' so it passes the request to the '*' route
- '*' route is handled by.... angular engine
And so it loops and loops.
A. It was not immediately obvious that is a problem of recursion, and not a problem of route not able to render.
B. This is probably behaving as intended. But it forces developers to implement a fallback for api routes, or any other route that is expected on the same origin, just to build in peace. This was not needed before. We did not need to have runtime things available at build-time.
C. Yes, api route example was there in the initial generated server.ts. But it did not tell me "DO NOT DELETE THIS - YOU WILL NEED THIS LATER". Basically, maybe a more thorough documention is in order
D. Alternatively, would it not be great if we configure the build action to pick up proxy information, just like ng serve?
Following are the relevant files for the server setup
server.ts
import { createNodeRequestHandler, isMainModule } from '@angular/ssr/node';
import { serveAngularSSR } from '@easworks/app-shell/utilities/angular-ssr';
import { fastifyCors } from '@fastify/cors';
import { fastify, FastifyInstance } from 'fastify';
import * as path from 'node:path';
import { fileURLToPath } from 'node:url';
import { parseEnv } from 'server-side/environment';
import { useProblemDetailsGlobally } from 'server-side/utils/fastify-problem-details';
import { getLoggerOptions } from 'server-side/utils/logging';
import { printRoutes } from 'server-side/utils/print-routes.plugin';
const envId = parseEnv.nodeEnv();
async function initServer() {
// const options = development ? {} : { http2: true };
const options = {};
const server = fastify({
...options,
logger: getLoggerOptions(envId)
});
return server;
}
async function configureServer(server: FastifyInstance) {
server.register(useProblemDetailsGlobally);
server.register(printRoutes);
server.register(serveAngularSSR, {
directory: path.resolve(fileURLToPath(import.meta.url), '../..'),
});
await server.register(fastifyCors, {
origin: true
});
}
const server = await initServer();
await configureServer(server);
async function closeServer(server: FastifyInstance) {
await server.close();
process.exit();
}
/**
* Start the server if this module is the main entry point.
* The server listens on the port defined by the `PORT` environment variable, or defaults to 4000.
*/
if (isMainModule(import.meta.url)) {
const host = '0.0.0.0';
const port = Number.parseInt(process.env['PORT'] as string);
try {
await server.listen({ host, port });
process.on('SIGTERM', () => closeServer(server));
process.on('SIGINT', () => closeServer(server));
}
catch (e) {
server.log.fatal(e);
closeServer(server);
}
}
/**
* The request handler used by the Angular CLI (dev-server and during build).
*/
export const reqHandler = createNodeRequestHandler(async (req, res) => {
await server.ready();
server.server.emit('request', req, res);
});
serve-angular-ssr.ts
import { AngularNodeAppEngine, writeResponseToNodeResponse } from '@angular/ssr/node';
import { fastifyStatic } from '@fastify/static';
import { FastifyPluginAsync } from 'fastify';
import fastifyPlugin from 'fastify-plugin';
import mime from 'mime';
import * as path from 'path';
interface ServeAngularSSROptions {
directory: string;
}
const pluginImpl: FastifyPluginAsync<
ServeAngularSSROptions
> = async (server, options) => {
const engine = new AngularNodeAppEngine();
const browserDirectory = path.resolve(options.directory, 'browser');
server.register(fastifyStatic, {
root: browserDirectory,
serve: false,
index: false,
redirect: false,
maxAge: '1y',
});
const htmlMime = mime.getType('html');
if (!htmlMime) throw new Error('invalid operation');
server.get('*', async (req, reply) => {
const extension = mime.getType(req.url);
if (extension && req.url !== '/index.html') {
return reply.sendFile(req.url);
} else {
reply.type(htmlMime);
const response = await engine.handle(req.raw);
if (response) return writeResponseToNodeResponse(response, reply.raw);
else return reply.send();
}
});
};
export const serveAngularSSR = fastifyPlugin(pluginImpl, { name: 'serveAngularSSR' });
Describe the solution you'd like
No response
Describe alternatives you've considered
No response
- 主要言語
- TypeScript
- スター
- 27k
- フォーク
- 11.8k
- 平均マージ
- 16時間 35分
- マージ済み PR(30日)
- 176
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
angular/angular-cli のほかの issue
-
area: @angular/build gemini-triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
angular/angular-cli#33955 ·
-
area: @angular/cli gemini-triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
angular/angular-cli#33055 · コメント 1 件 · リアクション 3 件 ·
-
area: @angular/build gemini-triaged
難易度 4/5 3〜5日 初心者へのやさしさ 72/100
angular/angular-cli#34137 ·
-
angular/build:library area: @angular/build gemini-triaged
angular/angular-cli#34131 · 担当者 1 名 ·
-
angular/build:library area: @angular/build gemini-triaged
angular/angular-cli#34130 · 担当者 1 名 ·
angular/angular-cli の issue をすべて見る
似ている issue
-
clawsweeper:linked-pr-open clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:message-loss issue-rating: 🦞 diamond lobster maturity:stable P2
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Eynzof/Hermes-CN-Desktop#616 ·
-
ZCode 3.14.3 に対応する オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
supermomonga/zcode-acp#24 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
growthbook/growthbook#7100 ·
-
triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100