storage: createReadStream() never errors when a download stalls mid-body

Offen
#9,515 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
30/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Bereich
networking

Rechercherichtung

Start from File#createReadStream in the storage library and trace how it builds the underlying request through teeny-request/node-fetch, since the issue states the documented timeout no longer covers the response body after headers arrive (storage >= 8.0.1). The reproduction script (a local HTTP server that sends headers and a partial body) is the first thing to run to confirm the current hang. Done means a stalled stream emits an error after an idle interval and a test covers that path.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

api: storage
Library name

@google-cloud/storage

What would you like to see in the library?

An idle timeout for File#createReadStream(): if no body bytes arrive for a set time, the stream emits an error.

Why

A download that stops mid-body never emits an error or end, so a pipeline that reads from the stream waits forever. In production we see occasional downloads of multi-gigabyte objects stop partway through. Each one then hung for days until we stopped the process by hand.

This worked in early versions. In 2017, a stalled createReadStream() raised ESOCKETTIMEOUT (#2317), because the library used request, whose timeout set a socket idle timeout. That protection was lost later:

  • With teeny-request 9.x / node-fetch 2 (storage ≤ 8.0.0), the request timeout stopped when the response headers arrived. node-fetch 2 applied its body timeout only to buffered reads (.text(), .json()), not to a piped stream.
  • With teeny-request ≥ 10 (storage ≥ 8.0.1), the documented timeout has no effect at all. See #9514.

googleapis/nodejs-storage#24 reports the same hang. Its last comment (storage 6.12, Node.js 20) also sees streams that hang forever.

Reproduction

storage 8.1.0, Node.js 22.22.1:

const http = require('node:http')
const { Storage } = require('@google-cloud/storage')

// The server sends the response headers and part of the body, then stops sending.
const server = http.createServer((req, res) => {
  res.writeHead(200, { 'content-type': 'application/octet-stream' })
  res.write('first part of the file\n')
})
server.listen(0, () => {
  const storage = new Storage({
    apiEndpoint: `http://127.0.0.1:${server.address().port}`,
    projectId: 'repro',
    useAuthWithCustomEndpoint: false,
  })
  let bytes = 0
  storage.bucket('bucket').file('file.jsonl').createReadStream({ validation: false })
    .on('data', (chunk) => { bytes += chunk.length })
    .on('error', (err) => { console.log('error:', err.message); process.exit(0) })
    .on('end', () => { console.log('end'); process.exit(0) })
  setTimeout(() => {
    console.log(`after 90 s: ${bytes} bytes received, no error, no end`)
    process.exit(1)
  }, 90000)
})

Output: after 90 s: 23 bytes received, no error, no end

Alternatives considered

We now wrap the stream in our own watchdog. It aborts the pipeline when no data moves for 10 minutes. Every user who streams large objects has to build the same thing. Node's built-in fetch (undici) has bodyTimeout for this case, with a default of 5 minutes.

Vorherrschende Sprache
TypeScript
Sterne
3.2k
Forks
732
Ø Merge
2 T. 11 Std.
Gemergte PRs (30 T.)
99

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-cloud-node

Alle Issues in googleapis/google-cloud-node

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.