open-feature / open-feature/python-sdk-contrib

[OFREP] Add SSE event stream support

Open
#366 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
27
Forks
33
Avg merge
5h 7m
Merged PRs (30d)
9

Description

Context

ADR-0008 defines Server-Sent Events (SSE) as an optional real-time change notification mechanism for OFREP. The OpenAPI spec PR adds the corresponding eventStreams field to evaluation responses.

The OFREP provider currently does stateless per-request evaluation with no change detection. SSE support would allow the provider to receive real-time notifications when the underlying flag configuration changes and emit PROVIDER_CONFIGURATION_CHANGED events so the host application can react.

Scope

Parse the optional eventStreams array from the POST /ofrep/v1/evaluate/flags/{key} response and connect to any entries with type: "sse". On receiving a refetchEvaluation event, emit a PROVIDER_CONFIGURATION_CHANGED event.

1. Parse eventStreams and manage SSE connections (High)
  • On a successful evaluation response, check for an eventStreams array
  • For each entry with type: "sse", resolve the connection URL from either url or endpoint.origin + endpoint.requestUri
  • Ignore entries with unknown types for forward compatibility
  • Maintain a single SSE connection (deduplicate across evaluation responses returning the same URL)
2. Handle change events (High)
  • On receiving an event with data.type: "refetchEvaluation", emit PROVIDER_CONFIGURATION_CHANGED
  • On SSE connection failure, continue reconnection attempts
3. Inactivity timeout (Low)
  • Apply an effective inactivityDelaySec: client override > response value > default 120 seconds
  • On timeout, close the connection; on resume, reconnect

References

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 with the POST /ofrep/v1/evaluate/flags/{key} response handling and read ADR-0008 alongside the OpenAPI spec changes. Review launchdarkly/python-eventsource for the SSE client approach; done means parsing supported eventStreams entries, maintaining deduplicated connections, emitting PROVIDER_CONFIGURATION_CHANGED for refetchEvaluation events, and handling reconnection and inactivity timeout behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.