When `sourceStream` errors, yield a `{ errors: [...] }` response

At a glance

• Identifier: #1127
• Stage: RFC 1 / Proposal
• Champion: @benjie
• Latest activity: Added to WG agenda on 2025-01-09
• Spec PR: https://github.com/graphql/graphql-spec/pull/1127
• Related:
  • #1099

Spec PR description

See https://github.com/graphql/graphql-spec/pull/1099/files#r1799509253

Currently if sourceStream generates an error, then responseStream repeats the error. This is the behavior implemented in graphql-js and is problematic.

GraphQL captures execution errors and wraps them in an { errors: [...] } payload for query and mutation operations; it should do the same for stream errors in a subscription operation.

This PR makes this change. It is technically a breaking change, I think, so will require careful thought.

Timeline

• Added to WG agenda on 2025-01-09
• Mentioned in WG notes on 2025-01-01
• Commit pushed on 2024-12-05 by benjie: Merge branch 'main' into streams-editorial-suggestions
• Added to WG agenda on 2024-12-05
• Mentioned in WG notes on 2024-12-01
• Spec PR created on 2024-11-21 by benjie
• 3 commits pushed on 2024-11-21:
  • benjie committed "Don't complete with error."
  • benjie committed "Don't use a new algorithm, no need to DRY"
  • benjie committed "Internal errors should be passed up the chain"
• Commit pushed on 2024-06-11 by leebyron: feedback and use definition syntax
• Commit pushed on 2024-06-06 by leebyron: Editorial changes for Event Streams