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

flagd provider: allow custom gRPC metadata on the in-process SyncFlags stream

Open
#403 1 comment 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

Problem

The in-process resolver of the flagd provider opens a long-lived gRPC stream. It calls the SyncFlags method. The provider builds the gRPC metadata for this call. The function _create_metadata adds only one header. It adds the flagd-selector header. It adds this header only when the user sets a selector.

The provider gives the user no way to add other metadata headers. The Config object has no field for custom metadata. The user cannot add a header to the sync stream.

Effect

A user cannot send an infrastructure-specific header on the sync stream. One example is a proxy timeout header. A proxy can close a stream after a default request timeout. To keep the stream open, the client must send a header such as x-envoy-upstream-rq-timeout-ms: 0. The current provider cannot send this header. Because of this, a proxy can close the long-lived sync stream.

Proposed change

  1. Add a sync_metadata option to FlagdProvider and to Config. The value is a sequence of key-value pairs (header name and header value).
  2. In _create_metadata, add these pairs to the metadata. Keep the flagd-selector header. Send both the selector header and the user headers together.
  3. Keep the current behavior when the user does not set sync_metadata. If the user sets no selector and no custom metadata, the function returns no metadata, as before.

Compatibility

The change is backward compatible. The custom metadata is added only when the user sets sync_metadata. The default behavior does not change.

Scope

The change is small. It touches config.py, provider.py, and grpc_watcher.py. It affects only the in-process resolver, because only that resolver uses the SyncFlags metadata function.

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 tracing the in-process SyncFlags stream and _create_metadata across config.py, provider.py, and grpc_watcher.py. Add the sync_metadata configuration path and verify that selector and custom key-value pairs are sent together, while no selector or custom metadata still produces no metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc, python
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.