stream: eos on closed

[ronag]

stream.finished should be invoked if stream is already closed/destroyed. Currently there is a potential deadlock depending on when stream.finished is called.

For writable premature close is close before finish, i.e. it should look for finished instead of ended.

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• tests and/or benchmarks are included
• documentation is changed or added
• commit message follows commit guidelines

[Trott]

/ping @nodejs/streams

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/24624/

[mcollina]

Would you mind to add the equivalent test for Readable as well?

[ronag]

@mcollina updated

[ronag]

@benjamingr ping

[mcollina]

LGTM

[mcollina]

@nodejs/tsc this needs another review.

[ronag]

@mcollina: Should this maybe result in a ERR_STREAM_DESTROYED?

[ronag]

Yes please.

@mcollina: done

[ronag]

@Trott: Updated PR description to describe the included changes from the other PR (which is now closed).

[ronag]

This needs another CITGM (once Travis is ok) given the recent changes.

[ronag]

There is an added test for this change. We should always be emitting premature close unless we've seen finish or end events. I don't think this actually changes anything in practice.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25315/

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25317/

[mcollina]

This will need a rebase, otherwise it looks good to land.

[ronag]

rebased

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/25326/

[mcollina]

Landed in b03845b

[mafintosh]

A little late to the party here, but this includes a big change in behaviour for streams.

Since the finished flag is used instead of the ended flag, this PR changes the behaiviour of eos to the following:

const stream = require('stream')
const ws = new stream.Writable({
  write (data, enc, cb) {
    process.nextTick(cb, null)
  }
})

finished(ws, function (err) {
  console.log('This used to *not* error:', err)
})

ws.write('data')
ws.end()
ws.emit('close') // modules tend to emit close on resource close but in a non error state

I was just bitten by this in a debugging session, so unsure if that was an intentional change?
If so I think it should be clearly documented :)

Streams are hard.