OpenFn / OpenFn/apollo

Return version to streaming APIs?

Open
#560 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

Apollo is now configured so that the version number is sent as a header in response to all requests. This is managed by the bun server.

I don't actually know how this works for streaming APIs (we have two - websockets and SSE events). Presumably we should send this headerin the handshake somewhere - it's too late to send it at the end. I'm not sure how this stuff works so will have to investigate.

It's not a pressing requirement: the only code which depends on the versions doesn't currently use a streaming API.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by investigating how the bun server handles the two streaming APIs mentioned: websockets and SSE events. Determine where version information can be returned during each handshake or connection setup, then verify that both streaming paths expose the version without relying on a response sent after streaming begins.

Written by the indexing model from the issue text.

Assessment

Tech stack
bun
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.