feat: add a built-output smoke test command (`nuxt preview --smoke`)

オープン
#1,661 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
bun, node.js, typescript
領域
cli, testing

調査の方向性

Read the existing nuxt preview command and the described ~550-line Bun smoke script to map how the built server is started and checked. Then trace how the CLI resolves the .output entry and handles environment and signals across runtimes. Done means a smoke command checks HTTP expectations and shutdown, exits nonzero on failure, and leaves no server process running.

索引モデルが issue の本文から書いたものです。

説明

nuxt preview starts .output/server/index.mjs, but it does not verify that the built output:

  • boots with the production environment,
  • serves the shell and all required assets/chunks,
  • starts with the intended runtime (Bun or Node),
  • runs Nitro close hooks and exits cleanly on SIGTERM/SIGINT.

nuxt build can pass while the deploy fails at runtime: a missing secret, a wrong database path, a missing asset, a preset regression (for example the Bun preset skipping close hooks), or a shutdown that hangs. We currently maintain a ~550-line smoke script for this.

What our script does:

  • reserves a free port, creates temporary SQLite databases, and applies migrations;
  • builds a minimal environment instead of inheriting the developer .env;
  • spawns .output/server/index.mjs with Bun;
  • waits for HTTP 200 and a known shell marker, and scans captured logs for forbidden content;
  • sends SIGTERM, asserts exit within 15 seconds and clean shutdown; on Windows it records that Bun's SIGTERM is termination-only;
  • is the last step of check -> build -> built-output Playwright -> smoke.

Proposal: nuxt preview --smoke (or nuxt build --smoke) with:

  • --url / --expect for a path plus expected status and optional body marker;
  • --timeout and --signal;
  • --env-file or --env for a minimal production environment;
  • an assertion that the process exits after the signal, optionally checking a close-hook marker;
  • a non-zero exit on failure, and no server process left behind;
  • support for the current runtime and .output layout without hard-coding Nitro internals.

What exists today:

  • nuxt preview starts the server but makes no assertions.
  • @nuxt/test-utils is excellent for tests that call the server, but it does not own the built process lifecycle or shutdown assertions.
  • Nitro close hooks are usually tested manually or with a custom script.

This could be a module, but a CLI command is the right home because it must know the output entry, environment loading and signal semantics. Happy to contribute the command or a shared helper. Our script is Bun-specific today; cross-platform signal handling is the main design work.

Additional information
  • Would you be willing to help implement this feature?
  • Could this feature be implemented as a module?
主要言語
TypeScript
スター
402
フォーク
125
平均マージ
2日 9時間
マージ済み PR(30日)
37

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nuxt/cli のほかの issue

nuxt/cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。