Skip to content

feat: add missing steps for config and improve wording #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2025
Merged

feat: add missing steps for config and improve wording #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 45 additions & 40 deletions gherkin/config.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
Feature: Configuration Test
"""markdown
This is the official option configuration table
| Option name | Environment variable name | Explanation | Type & Values | Default | Compatible resolver |
| --------------------- | ------------------------------ | ------------------------------------------------------------------------------- | ---------------------------- | ----------------------------- | ------------------- |
| resolver | FLAGD_RESOLVER | mode of operation | String - `rpc`, `in-process` | rpc | rpc & in-process |
| host | FLAGD_HOST | remote host | String | localhost | rpc & in-process |
| port | FLAGD_PORT | remote port | int | 8013 (rpc), 8015 (in-process) | rpc & in-process |
| targetUri | FLAGD_TARGET_URI | alternative to host/port, supporting custom name resolution | string | null | rpc & in-process |
| tls | FLAGD_TLS | connection encryption | boolean | false | rpc & in-process |
| socketPath | FLAGD_SOCKET_PATH | alternative to host port, unix socket | String | null | rpc & in-process |
| certPath | FLAGD_SERVER_CERT_PATH | tls cert path | String | null | rpc & in-process |
| deadlineMs | FLAGD_DEADLINE_MS | deadline for unary calls, and timeout for initialization | int | 500 | rpc & in-process |
| streamDeadlineMs | FLAGD_STREAM_DEADLINE_MS | deadline for streaming calls, useful as an application-layer keepalive | int | 600000 | rpc & in-process |
| retryBackoffMs | FLAGD_RETRY_BACKOFF_MS | initial backoff for stream retry | int | 1000 | rpc & in-process |
| retryBackoffMaxMs | FLAGD_RETRY_BACKOFF_MAX_MS | maximum backoff for stream retry | int | 120000 | rpc & in-process |
| retryGracePeriod | FLAGD_RETRY_GRACE_PERIOD | time before provider moves from STALE to ERROR state | int | 5 | rpc & in-process |
| keepAliveTime | FLAGD_KEEP_ALIVE_TIME_MS | http 2 keepalive | long | 0 | rpc & in-process |
| cache | FLAGD_CACHE | enable cache of static flags | String - `lru`, `disabled` | lru | rpc |
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | max size of static flag cache | int | 1000 | rpc |
| selector | FLAGD_SOURCE_SELECTOR | selects a single sync source to retrieve flags from only that source | string | null | in-process |
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | offline, file-based flag definitions, overrides host/port/targetUri | string | null | in-process |
| offlinePollIntervalMs | FLAGD_OFFLINE_POLL_MS | poll interval for reading offlineFlagSourcePath | int | 5000 | in-process |
| contextEnricher | - | sync-metadata to evaluation context mapping function | function | identity function | in-process |
"""
| Option name | Environment variable name | Explanation | Type & Values | Default | Compatible resolver |
| --------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------------------------- | ------------------- |
| resolver | FLAGD_RESOLVER | mode of operation | String - `rpc`, `in-process` | rpc | rpc & in-process |
| host | FLAGD_HOST | remote host | String | localhost | rpc & in-process |
| port | FLAGD_PORT | remote port | int | 8013 (rpc), 8015 (in-process) | rpc & in-process |
| targetUri | FLAGD_TARGET_URI | alternative to host/port, supporting custom name resolution | string | null | rpc & in-process |
| tls | FLAGD_TLS | connection encryption | boolean | false | rpc & in-process |
| socketPath | FLAGD_SOCKET_PATH | alternative to host port, unix socket | String | null | rpc & in-process |
| certPath | FLAGD_SERVER_CERT_PATH | tls cert path | String | null | rpc & in-process |
| deadlineMs | FLAGD_DEADLINE_MS | deadline for unary calls, and timeout for initialization | int | 500 | rpc & in-process |
| streamDeadlineMs | FLAGD_STREAM_DEADLINE_MS | deadline for streaming calls, useful as an application-layer keepalive | int | 600000 | rpc & in-process |
| retryBackoffMs | FLAGD_RETRY_BACKOFF_MS | initial backoff for stream retry | int | 1000 | rpc & in-process |
| retryBackoffMaxMs | FLAGD_RETRY_BACKOFF_MAX_MS | maximum backoff for stream retry | int | 120000 | rpc & in-process |
| retryGracePeriod | FLAGD_RETRY_GRACE_PERIOD | time before provider moves from STALE to ERROR state | int | 5 | rpc & in-process |
| keepAliveTime | FLAGD_KEEP_ALIVE_TIME_MS | http 2 keepalive | long | 0 | rpc & in-process |
| cache | FLAGD_CACHE | enable cache of static flags | String - `lru`, `disabled` | lru | rpc |
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | max size of static flag cache | int | 1000 | rpc |
| selector | FLAGD_SOURCE_SELECTOR | selects a single sync source to retrieve flags from only that source | string | null | in-process |
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | offline, file-based flag definitions, overrides host/port/targetUri | string | null | in-process |
| offlinePollIntervalMs | FLAGD_OFFLINE_POLL_MS | poll interval for reading offlineFlagSourcePath | int | 5000 | in-process |
| contextEnricher | - | sync-metadata to evaluation context mapping function | function | identity function | in-process |
| fatalStatusCodes | FLAGD_FATAL_STATUS_CODES | a list of gRPC status codes, which will cause streams to give up and put the provider in a PROVIDER_FATAL state | array | [] | rpc & in-process |
"""

Scenario Outline: Default Config
When a config was initialized
Expand All @@ -36,10 +37,11 @@ Feature: Configuration Test

@rpc @in-process
Scenarios: Basic Connection
| option | type | default |
| host | String | localhost |
| port | Integer | 8013 |
| tls | Boolean | false |
| option | type | default |
| host | String | localhost |
| port | Integer | 8013 |
| tls | Boolean | false |
| fatalStatusCodes | StringList | |

@rpc @in-process @targetURI
Scenarios: Target URI
Expand Down Expand Up @@ -136,10 +138,11 @@ Feature: Configuration Test

@rpc @in-process
Scenarios: Basic Connection
| option | type | value |
| host | String | local |
| tls | Boolean | True |
| port | Integer | 1234 |
| option | type | value |
| host | String | local |
| tls | Boolean | True |
| port | Integer | 1234 |
| fatalStatusCodes | StringList | A, B |

@rpc @in-process @targetURI
Scenarios: Target URI
Expand Down Expand Up @@ -203,10 +206,11 @@ Feature: Configuration Test

@rpc @in-process
Scenarios: Basic Connection
| option | env | type | value |
| host | FLAGD_HOST | String | local |
| tls | FLAGD_TLS | Boolean | True |
| port | FLAGD_PORT | Integer | 1234 |
| option | env | type | value |
| host | FLAGD_HOST | String | local |
| tls | FLAGD_TLS | Boolean | True |
| port | FLAGD_PORT | Integer | 1234 |
| fatalStatusCodes | FLAGD_FATAL_STATUS_CODES | StringList | C, D |

@rpc @in-process @targetURI
Scenarios: Target URI
Expand Down Expand Up @@ -279,10 +283,11 @@ Feature: Configuration Test

@rpc @in-process
Scenarios: Basic Connection
| option | env | type | value | env-value |
| host | FLAGD_HOST | String | local | l |
| tls | FLAGD_TLS | Boolean | True | False |
| port | FLAGD_PORT | Integer | 1234 | 3456 |
| option | env | type | value | env-value |
| host | FLAGD_HOST | String | local | l |
| tls | FLAGD_TLS | Boolean | True | False |
| port | FLAGD_PORT | Integer | 1234 | 3456 |
| fatalStatusCodes | FLAGD_FATAL_STATUS_CODES | StringList | A, B | C, D |

@rpc @in-process @targetURI
Scenarios: Target URI
Expand Down Expand Up @@ -327,5 +332,5 @@ Feature: Configuration Test

@in-process @providerId
Scenarios: providerId
| option | env | type | value | env-value |
| providerId | FLAGD_PROVIDER_ID | String | providerId | env-prov |
| option | env | type | value | env-value |
| providerId | FLAGD_PROVIDER_ID | String | providerId | env-prov |
2 changes: 1 addition & 1 deletion gherkin/connection.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Feature: flagd provider disconnect and reconnect functionality
And a forbidden flagd provider
And a error event handler
Then the error event handler should have been executed within 5000ms
And the client is in fatal state
And the client should be in fatal state
Copy link
Member

@leakonvalinka leakonvalinka Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use "provider" instead of "client"? In my understanding, the state of the provider (which the client is connected to) should be fatal, not the client itself.

Copy link
Member Author

@aepfli aepfli Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

depends, on how you check this. There has been already some discussion about this. if we call it provider we would need to wait for the event listener to run with an fatal event, which is currently not the case. But we can check on the client what state it has (it will use the provider state). Anyways providers are theoretically stateless, and the client is managing the state. So i think we are fine here.

Copy link
Member

@leakonvalinka leakonvalinka Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Just mentioned it because it confused me at first as in java the corresponding client method is getProviderState().


@targetURI @rpc
Scenario: Connection via TargetUri rpc
Expand Down