Skip to content

Commit 2fb0057

Browse files
committed
docs(o11y): revise terminology to remove 'gate' metaphor
1 parent 0f92c35 commit 2fb0057

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

packages/google-api-core/google/api_core/observability/options.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def resolve_feature_flags(
9797
Behavior depends on whether the `env_var` name contains "EXPERIMENTAL":
9898
9999
- **Experimental Path** (env_var contains "EXPERIMENTAL"):
100-
Strict gating. Requires the environment variable to be explicitly 'true'.
100+
Strict control. Requires the environment variable to be explicitly 'true'.
101101
If a programmatic provider is passed but the environment variable is not 'true',
102102
raises ValueError (Fail Fast).
103103
@@ -114,7 +114,7 @@ def resolve_feature_flags(
114114
bool: True if the feature is resolved to enabled, False otherwise.
115115
116116
Raises:
117-
ValueError: If a provider is passed for an experimental feature without opening the gate.
117+
ValueError: If a provider is provided for an experimental feature without enabling the experimental environment variable.
118118
"""
119119

120120
# Check for programmatic feature provider
@@ -125,10 +125,10 @@ def resolve_feature_flags(
125125

126126
# EXPERIMENTAL PATH:
127127
# Resolution Hierarchy:
128-
# 1. EXPERIMENTAL Gate
129-
# 2. Fail Fast if Provider present but EXPERIMENTAL Gate is closed
128+
# 1. EXPERIMENTAL Environment Variable
129+
# 2. Fail Fast if Provider present but EXPERIMENTAL Environment Variable is not enabled
130130
if "EXPERIMENTAL" in env_var:
131-
# Fail Fast if provider present but gate is closed
131+
# Fail Fast if provider present but experimental environment variable is not enabled
132132
if env_var_setting is not True and has_provider:
133133
raise ValueError(
134134
f"Experimental feature requires {env_var} to be set to 'true' to use programmatic providers."

packages/google-api-core/tests/unit/observability/test_options.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@ def test_resolve_feature_flags_ga_enabled_via_env():
107107
assert result is True
108108

109109

110-
@pytest.mark.parametrize("gate_value", [None, False])
111-
def test_resolve_feature_flags_exp_blocked_with_provider_fails_fast(gate_value):
112-
"""Verify that passing a provider to an experimental feature without the gate raises ValueError."""
113-
# Setup: Experimental env var is set to gate_value (None means not set)
114-
set_test_env_override("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", gate_value)
110+
@pytest.mark.parametrize("exp_env_state", [None, False], ids=["missing", "disabled"])
111+
def test_resolve_feature_flags_exp_blocked_with_provider_fails_fast(exp_env_state):
112+
"""Verify that passing a provider to an experimental feature raises ValueError if the experimental environment variable is disabled or missing."""
113+
# Setup: Experimental env var is set to exp_env_state (None means not set)
114+
set_test_env_override("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", exp_env_state)
115115
client_options = {"tracer_provider": object()}
116116

117117
# Action & Assertion
@@ -124,7 +124,7 @@ def test_resolve_feature_flags_exp_blocked_with_provider_fails_fast(gate_value):
124124

125125

126126
def test_resolve_feature_flags_exp_enabled_with_provider():
127-
"""Verify that experimental feature is enabled if gate is True, even with provider."""
127+
"""Verify that experimental feature is enabled if the experimental environment variable is enabled and a provider is provided."""
128128
set_test_env_override("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", True)
129129
client_options = {"tracer_provider": object()}
130130

@@ -137,7 +137,7 @@ def test_resolve_feature_flags_exp_enabled_with_provider():
137137

138138

139139
def test_resolve_feature_flags_ga_enabled_via_provider():
140-
"""Verify that a GA feature is enabled if a provider is passed, bypassing env var."""
140+
"""Verify that a GA feature is enabled if a provider is provided, ignoring the environment variable."""
141141
# Env var is False, but provider is present
142142
set_test_env_override("GOOGLE_SDK_PYTHON_TRACING_ENABLED", False)
143143
client_options = {"tracer_provider": object()}
@@ -154,7 +154,7 @@ def test_resolve_feature_flags_ga_enabled_via_provider():
154154
"env_val", [None, False], ids=["env_not_set", "env_explicit_false"]
155155
)
156156
def test_resolve_feature_flags_ga_fallback_to_false(env_val):
157-
"""Verify that a GA feature returns False if no flags are present."""
157+
"""Verify that a GA feature is disabled if neither a provider is provided nor the environment variable is enabled."""
158158
set_test_env_override("GOOGLE_SDK_PYTHON_TRACING_ENABLED", env_val)
159159
result = options.resolve_feature_flags(
160160
env_var="GOOGLE_SDK_PYTHON_TRACING_ENABLED",

0 commit comments

Comments
 (0)