All posts
Node.js のファイルダウンロードで進捗が表示されなかったときのメモ

Node.js サーバーに置いた大きめのファイルを、Express から fs のストリームを使って返す処理を作りました。扱うファイルは最大で約1GBです。
ダウンロード自体はできたのですが、ブラウザにプログレスバーが表示されず、いつ終わるのか分かりません。ファイルサイズは Content-Length に設定していたので、それだけでは足りないのかと調べることにしました。
ファイルサイズをヘッダーに設定する
まず、fs.stat() で取得したサイズを Content-Length に設定し、ファイルをストリームで返していました。
const fs = require('fs')
// Express のミドルウェア
const download = (req, res, next) => {
const filePath = req.asset.filePath
fs.stat(filePath, (err, stat) => {
if (err) {
return next(err)
}
const filename = encodeURIComponent(req.asset.title)
res.set({
'Content-Type': req.asset.mime,
'Content-Disposition': `inline; filename*=utf-8''${filename}`,
'Content-Length': stat.size,
})
const fileStream = fs.createReadStream(filePath)
fileStream.on('error', (streamError) => {
if (res.headersSent) {
res.destroy(streamError)
return
}
next(streamError)
})
res.on('close', () => {
fileStream.destroy()
})
fileStream.pipe(res)
})
}Content-Length は、レスポンスボディーのサイズをバイト単位で示すヘッダーです。受信側が全体のサイズを把握するための情報になります。[MDN の Content-Length の説明]
この時点では、今回試した環境ではプログレスバーが表示されませんでした。
Connection: close を追加して試す
調べているうちに接続の維持が関係しているのではないかと考え、次のヘッダーを追加して試しました。
res.set({
'Content-Type': req.asset.mime,
'Content-Disposition': `inline; filename*=utf-8''${filename}`,
'Content-Length': stat.size,
'Connection': 'close',
})再度テストしたところ、この環境ではプログレスバーが表示されました。
Connection: close は HTTP/1.x の接続をレスポンス後に閉じるための指定です。プログレスバーを表示するためのヘッダーではなく、今回の結果だけでは、なぜ表示が変わったのかまでは特定できていません。
また、Connection のような接続単位のヘッダーは HTTP/2・HTTP/3 では使用できません。同じ症状でも、ブラウザ、プロキシ、圧縮設定、実際に届くレスポンスヘッダーなどを確認する必要がありそうです。[MDN の Connection の説明]




Discussion