fix(openfeature): separate enablement from source selection

Author: leoromanovsky

packages/dd-trace/src/openfeature/configuration_source.js

@@ -3,9 +3,12 @@
 const log = require('../log')
 
 const CONFIGURATION_SOURCE_AGENTLESS = 'agentless'
-const CONFIGURATION_SOURCE_DISABLED = 'disabled'
 const CONFIGURATION_SOURCE_REMOTE_CONFIG = 'remote_config'
 
+const DISABLED_RESOLUTION = Object.freeze({ enabled: false })
+const AGENTLESS_CONFIGURATION = Object.freeze({ enabled: true, source: CONFIGURATION_SOURCE_AGENTLESS })
+const REMOTE_CONFIG_CONFIGURATION = Object.freeze({ enabled: true, source: CONFIGURATION_SOURCE_REMOTE_CONFIG })
+
 const DEFAULT_AGENTLESS_PATH = '/api/v2/feature-flagging/config/rules-based/server'
 const DEFAULT_POLL_INTERVAL_SECONDS = 30
 const DEFAULT_REQUEST_TIMEOUT_SECONDS = 2
@@ -18,14 +21,14 @@ const MAX_POLL_INTERVAL_SECONDS = 60 * 60
  * @returns {object} Resolved source settings.
  */
 function resolve (config) {
-  const mode = resolveMode(config)
+  const configuration = resolveConfiguration(config)
 
-  if (mode !== CONFIGURATION_SOURCE_AGENTLESS) {
-    return { mode }
+  if (!configuration.enabled || configuration.source !== CONFIGURATION_SOURCE_AGENTLESS) {
+    return configuration
   }
 
   return {
-    mode,
+    ...configuration,
     endpoint: endpoint(config, config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE_AGENTLESS_BASE_URL),
     pollIntervalMs: positiveMilliseconds(
       config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE_AGENTLESS_POLL_INTERVAL_SECONDS,
@@ -61,7 +64,7 @@ function enable (config, getOpenfeatureProxy) {
     return
   }
 
-  if (sourceConfig.mode === CONFIGURATION_SOURCE_AGENTLESS) {
+  if (sourceConfig.source === CONFIGURATION_SOURCE_AGENTLESS) {
     const AgentlessConfigurationSource = require('./agentless_configuration_source')
     const source = new AgentlessConfigurationSource(sourceConfig, ufc => {
       getOpenfeatureProxy()._setConfiguration(ufc)
@@ -80,7 +83,7 @@ function enable (config, getOpenfeatureProxy) {
  */
 function isRemoteConfig (config) {
   try {
-    return resolveMode(config) === CONFIGURATION_SOURCE_REMOTE_CONFIG
+    return resolveConfiguration(config).source === CONFIGURATION_SOURCE_REMOTE_CONFIG
   } catch (error) {
     log.error('Unable to configure Feature Flagging configuration source', error)
     return false
@@ -97,7 +100,7 @@ function isRemoteConfig (config) {
  */
 function isEnabled (config) {
   try {
-    return resolveMode(config) !== CONFIGURATION_SOURCE_DISABLED
+    return resolveConfiguration(config).enabled
   } catch (error) {
     log.error('Unable to configure Feature Flagging configuration source', error)
     return false
@@ -109,10 +112,10 @@ function isEnabled (config) {
  * endpoint or timing configuration.
  *
  * @param {import('../config/config-base')} config - Tracer configuration.
- * @returns {string} Selected configuration-source mode.
+ * @returns {{enabled: boolean, source?: string}} Resolved enablement and source selection.
  */
-function resolveMode (config) {
-  if (config.DD_FEATURE_FLAGS_ENABLED === false) return CONFIGURATION_SOURCE_DISABLED
+function resolveConfiguration (config) {
+  if (config.DD_FEATURE_FLAGS_ENABLED === false) return DISABLED_RESOLUTION
 
   const value = config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE
   const origin = config.getOrigin?.('DD_FEATURE_FLAGS_CONFIGURATION_SOURCE')
@@ -126,16 +129,15 @@ function resolveMode (config) {
       : legacyEnabled !== undefined && legacyEnabled !== null
 
     if (hasExplicitLegacySetting) {
-      if (legacyEnabled === true) return CONFIGURATION_SOURCE_REMOTE_CONFIG
-      if (legacyEnabled === false) return CONFIGURATION_SOURCE_DISABLED
+      if (legacyEnabled === true) return REMOTE_CONFIG_CONFIGURATION
+      if (legacyEnabled === false) return DISABLED_RESOLUTION
     }
   }
 
-  const mode = String(value ?? '').trim().toLowerCase() || CONFIGURATION_SOURCE_AGENTLESS
-  if (mode !== CONFIGURATION_SOURCE_AGENTLESS && mode !== CONFIGURATION_SOURCE_REMOTE_CONFIG) {
-    throw new Error(`Unsupported Feature Flagging configuration source: ${mode}`)
-  }
-  return mode
+  const source = String(value ?? '').trim().toLowerCase() || CONFIGURATION_SOURCE_AGENTLESS
+  if (source === CONFIGURATION_SOURCE_AGENTLESS) return AGENTLESS_CONFIGURATION
+  if (source === CONFIGURATION_SOURCE_REMOTE_CONFIG) return REMOTE_CONFIG_CONFIGURATION
+  throw new Error(`Unsupported Feature Flagging configuration source: ${source}`)
 }
 
 /**

packages/dd-trace/test/config/index.spec.js

@@ -4950,6 +4950,8 @@ rules:
         DD_FEATURE_FLAGS_CONFIGURATION_SOURCE_AGENTLESS_REQUEST_TIMEOUT_SECONDS: 2,
       })
       assert.strictEqual(config.experimental.flaggingProvider.enabled, false)
+      assert.strictEqual(config.getOrigin('DD_FEATURE_FLAGS_CONFIGURATION_SOURCE'), 'default')
+      assert.strictEqual(config.getOrigin('experimental.flaggingProvider.enabled'), 'default')
     })
 
     it('reads the stable provider kill switch', () => {
@@ -4958,6 +4960,7 @@ rules:
       const config = getConfig()
 
       assert.strictEqual(config.DD_FEATURE_FLAGS_ENABLED, false)
+      assert.strictEqual(config.getOrigin('DD_FEATURE_FLAGS_ENABLED'), 'env_var')
     })
 
     for (const value of ['true', 'false']) {
@@ -4968,6 +4971,7 @@ rules:
 
         assert.strictEqual(config.DD_FEATURE_FLAGS_ENABLED, true)
         assert.strictEqual(config.experimental.flaggingProvider.enabled, value === 'true')
+        assert.strictEqual(config.getOrigin('experimental.flaggingProvider.enabled'), 'env_var')
       })
     }
 
@@ -4977,6 +4981,7 @@ rules:
       const config = getConfig()
 
       assert.strictEqual(config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE, 'remote_config')
+      assert.strictEqual(config.getOrigin('DD_FEATURE_FLAGS_CONFIGURATION_SOURCE'), 'env_var')
     })
 
     it('reads the canonical agentless environment variables', () => {

packages/dd-trace/test/openfeature/configuration_source.spec.js

@@ -46,15 +46,15 @@ describe('OpenFeature configuration source', () => {
     it(`normalizes ${JSON.stringify(value)} to the default agentless source`, () => {
       config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE = value
 
-      assert.strictEqual(configurationSource.resolve(config).mode, 'agentless')
+      assert.strictEqual(configurationSource.resolve(config).source, 'agentless')
     })
   }
 
   it('grandfathers the legacy enabled setting onto Remote Config when the source is defaulted', () => {
     config.experimental.flaggingProvider.enabled = true
     config.getOrigin.withArgs('experimental.flaggingProvider.enabled').returns('env_var')
 
-    assert.deepStrictEqual(configurationSource.resolve(config), { mode: 'remote_config' })
+    assert.deepStrictEqual(configurationSource.resolve(config), { enabled: true, source: 'remote_config' })
     assert.strictEqual(configurationSource.isRemoteConfig(config), true)
     assert.strictEqual(configurationSource.isEnabled(config), true)
   })
@@ -63,7 +63,7 @@ describe('OpenFeature configuration source', () => {
     config.experimental.flaggingProvider.enabled = false
     config.getOrigin.withArgs('experimental.flaggingProvider.enabled').returns('env_var')
 
-    assert.deepStrictEqual(configurationSource.resolve(config), { mode: 'disabled' })
+    assert.deepStrictEqual(configurationSource.resolve(config), { enabled: false })
     assert.strictEqual(configurationSource.isRemoteConfig(config), false)
     assert.strictEqual(configurationSource.isEnabled(config), false)
   })
@@ -72,7 +72,7 @@ describe('OpenFeature configuration source', () => {
     config.experimental.flaggingProvider.enabled = true
     config.getOrigin.returns('env_var')
 
-    assert.strictEqual(configurationSource.resolve(config).mode, 'agentless')
+    assert.strictEqual(configurationSource.resolve(config).source, 'agentless')
     assert.strictEqual(configurationSource.isRemoteConfig(config), false)
     assert.strictEqual(configurationSource.isEnabled(config), true)
   })
@@ -82,7 +82,7 @@ describe('OpenFeature configuration source', () => {
     config.experimental.flaggingProvider.enabled = false
     config.getOrigin.returns('env_var')
 
-    assert.deepStrictEqual(configurationSource.resolve(config), { mode: 'remote_config' })
+    assert.deepStrictEqual(configurationSource.resolve(config), { enabled: true, source: 'remote_config' })
     assert.strictEqual(configurationSource.isRemoteConfig(config), true)
     assert.strictEqual(configurationSource.isEnabled(config), true)
   })
@@ -93,7 +93,7 @@ describe('OpenFeature configuration source', () => {
     config.experimental.flaggingProvider.enabled = true
     config.getOrigin.returns('env_var')
 
-    assert.deepStrictEqual(configurationSource.resolve(config), { mode: 'disabled' })
+    assert.deepStrictEqual(configurationSource.resolve(config), { enabled: false })
     assert.strictEqual(configurationSource.isRemoteConfig(config), false)
     assert.strictEqual(configurationSource.isEnabled(config), false)
   })
@@ -206,19 +206,17 @@ describe('OpenFeature configuration source', () => {
     config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE = ' REMOTE_CONFIG '
     delete config.site
 
-    assert.deepStrictEqual(configurationSource.resolve(config), { mode: 'remote_config' })
+    assert.deepStrictEqual(configurationSource.resolve(config), { enabled: true, source: 'remote_config' })
     assert.strictEqual(configurationSource.isRemoteConfig(config), true)
   })
 
-  for (const value of ['offline', 'other']) {
-    it(`fails closed for the unsupported ${value} source`, () => {
-      config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE = value
+  it('fails closed for an unsupported source', () => {
+    config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE = 'other'
 
-      assert.throws(() => configurationSource.resolve(config), /Unsupported Feature Flagging configuration source/)
-      assert.strictEqual(configurationSource.isRemoteConfig(config), false)
-      sinon.assert.calledOnce(log.error)
-    })
-  }
+    assert.throws(() => configurationSource.resolve(config), /Unsupported Feature Flagging configuration source/)
+    assert.strictEqual(configurationSource.isRemoteConfig(config), false)
+    sinon.assert.calledOnce(log.error)
+  })
 
   it('falls back to positive timing defaults with warnings', () => {
     config.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE_AGENTLESS_POLL_INTERVAL_SECONDS = 0