From f54d36fe86e01b1aa86e20fe00dcb16c53c5869d Mon Sep 17 00:00:00 2001
From: Gustavo Caso <gustavo.caso@datadoghq.com>
Date: Tue, 27 Jun 2023 09:56:27 +0100
Subject: [PATCH] add default_proc option to store block value as default value

---
 lib/datadog/core/configuration/option.rb      |  2 +-
 .../core/configuration/option_definition.rb   | 24 +++++++++++++++
 lib/datadog/core/configuration/settings.rb    |  5 ++--
 .../active_job/configuration/settings.rb      |  2 +-
 .../delayed_job/configuration/settings.rb     |  2 +-
 .../contrib/faraday/configuration/settings.rb |  2 +-
 .../contrib/grpc/configuration/settings.rb    |  2 +-
 .../contrib/que/configuration/settings.rb     |  2 +-
 .../contrib/resque/configuration/settings.rb  |  2 +-
 .../shoryuken/configuration/settings.rb       |  2 +-
 .../contrib/sidekiq/configuration/settings.rb |  2 +-
 .../sneakers/configuration/settings.rb        |  2 +-
 .../configuration/option_definition_spec.rb   | 29 +++++++++++++++++++
 .../datadog/core/configuration/option_spec.rb |  8 +++++
 14 files changed, 74 insertions(+), 12 deletions(-)

diff --git a/lib/datadog/core/configuration/option.rb b/lib/datadog/core/configuration/option.rb
index 1b27c06fd93..8c186aede9f 100644
--- a/lib/datadog/core/configuration/option.rb
+++ b/lib/datadog/core/configuration/option.rb
@@ -50,7 +50,7 @@ def default_value
           if definition.default.instance_of?(Proc)
             context_eval(&definition.default)
           else
-            definition.default
+            definition.default_proc || definition.default
           end
         end
 
diff --git a/lib/datadog/core/configuration/option_definition.rb b/lib/datadog/core/configuration/option_definition.rb
index a9c82ed86b5..ca24d725111 100644
--- a/lib/datadog/core/configuration/option_definition.rb
+++ b/lib/datadog/core/configuration/option_definition.rb
@@ -11,6 +11,7 @@ class OptionDefinition
 
         attr_reader \
           :default,
+          :default_proc,
           :delegate_to,
           :depends_on,
           :name,
@@ -21,6 +22,7 @@ class OptionDefinition
 
         def initialize(name, meta = {}, &block)
           @default = meta[:default]
+          @default_proc = meta[:default_proc]
           @delegate_to = meta[:delegate_to]
           @depends_on = meta[:depends_on] || []
           @name = name.to_sym
@@ -38,11 +40,14 @@ def build(context)
         # Acts as DSL for building OptionDefinitions
         # @public_api
         class Builder
+          class InvalidOptionError < StandardError; end
+
           attr_reader \
             :helpers
 
           def initialize(name, options = {})
             @default = nil
+            @default_proc = nil
             @delegate_to = nil
             @depends_on = []
             @helpers = {}
@@ -57,6 +62,8 @@ def initialize(name, options = {})
 
             # Apply block if given.
             yield(self) if block_given?
+
+            validate_options!
           end
 
           def depends_on(*values)
@@ -67,6 +74,10 @@ def default(value = nil, &block)
             @default = block || value
           end
 
+          def default_proc(&block)
+            @default_proc = block
+          end
+
           def delegate_to(&block)
             @delegate_to = block
           end
@@ -96,6 +107,7 @@ def apply_options!(options = {})
             return if options.nil? || options.empty?
 
             default(options[:default]) if options.key?(:default)
+            default_proc(&options[:default_proc]) if options.key?(:default_proc)
             delegate_to(&options[:delegate_to]) if options.key?(:delegate_to)
             depends_on(*options[:depends_on]) if options.key?(:depends_on)
             on_set(&options[:on_set]) if options.key?(:on_set)
@@ -111,6 +123,7 @@ def to_definition
           def meta
             {
               default: @default,
+              default_proc: @default_proc,
               delegate_to: @delegate_to,
               depends_on: @depends_on,
               on_set: @on_set,
@@ -119,6 +132,17 @@ def meta
               type: @type
             }
           end
+
+          private
+
+          def validate_options!
+            if !@default.nil? && @default_proc
+              raise InvalidOptionError,
+                'Using `default` and `default_proc` is not allowed. Please use one or the other.' \
+                                'If you want to store a block as the default value use `default_proc`'\
+                                ' otherwise use `default`'
+            end
+          end
         end
       end
     end
diff --git a/lib/datadog/core/configuration/settings.rb b/lib/datadog/core/configuration/settings.rb
index 2c05310ab41..276ac5f5fd9 100644
--- a/lib/datadog/core/configuration/settings.rb
+++ b/lib/datadog/core/configuration/settings.rb
@@ -472,8 +472,9 @@ def initialize(*_)
         # @default `->{ Time.now }`
         # @return [Proc<Time>]
         option :time_now_provider do |o|
-          o.default { -> { ::Time.now } }
-
+          o.default_proc do
+            ::Time.now
+          end
           o.on_set do |time_provider|
             Core::Utils::Time.now_provider = time_provider
           end
diff --git a/lib/datadog/tracing/contrib/active_job/configuration/settings.rb b/lib/datadog/tracing/contrib/active_job/configuration/settings.rb
index 18e1da9013f..aa650edc18c 100644
--- a/lib/datadog/tracing/contrib/active_job/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/active_job/configuration/settings.rb
@@ -25,7 +25,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end
       end
diff --git a/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb b/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb
index c46b621d109..b77b024d1f1 100644
--- a/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb
@@ -26,7 +26,7 @@ class Settings < Contrib::Configuration::Settings
 
             option :service_name
             option :client_service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end
       end
diff --git a/lib/datadog/tracing/contrib/faraday/configuration/settings.rb b/lib/datadog/tracing/contrib/faraday/configuration/settings.rb
index 599c5e34a08..b11b413f3af 100644
--- a/lib/datadog/tracing/contrib/faraday/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/faraday/configuration/settings.rb
@@ -28,7 +28,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :distributed_tracing, default: true
-            option :error_handler, default: DEFAULT_ERROR_HANDLER
+            option :error_handler, default_proc: DEFAULT_ERROR_HANDLER
             option :split_by_domain, default: false
 
             option :service_name do |o|
diff --git a/lib/datadog/tracing/contrib/grpc/configuration/settings.rb b/lib/datadog/tracing/contrib/grpc/configuration/settings.rb
index 5f26a7dff01..d4b53b408f3 100644
--- a/lib/datadog/tracing/contrib/grpc/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/grpc/configuration/settings.rb
@@ -35,7 +35,7 @@ class Settings < Contrib::Configuration::Settings
               end
             end
 
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end
       end
diff --git a/lib/datadog/tracing/contrib/que/configuration/settings.rb b/lib/datadog/tracing/contrib/que/configuration/settings.rb
index a8c75c35f0e..153e7ed56fa 100644
--- a/lib/datadog/tracing/contrib/que/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/que/configuration/settings.rb
@@ -33,7 +33,7 @@ class Settings < Contrib::Configuration::Settings
             option :tag_data do |o|
               o.default { env_to_bool(Ext::ENV_TAG_DATA_ENABLED, false) }
             end
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end
       end
diff --git a/lib/datadog/tracing/contrib/resque/configuration/settings.rb b/lib/datadog/tracing/contrib/resque/configuration/settings.rb
index ee062dd5dfd..4158119feec 100644
--- a/lib/datadog/tracing/contrib/resque/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/resque/configuration/settings.rb
@@ -25,7 +25,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end
       end
diff --git a/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb b/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb
index 0fa4b404462..31d9fc4683b 100644
--- a/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb
@@ -25,7 +25,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             option :tag_body, default: false
           end
         end
diff --git a/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb b/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb
index 54268fb1109..5909eafaa87 100644
--- a/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb
@@ -30,7 +30,7 @@ class Settings < Contrib::Configuration::Settings
 
             option :service_name
             option :client_service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             option :quantize, default: {}
             option :distributed_tracing, default: false
           end
diff --git a/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb b/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb
index fa29427d196..da6c5c4c00a 100644
--- a/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb
+++ b/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb
@@ -23,7 +23,7 @@ class Settings < Contrib::Configuration::Settings
             end
 
             option :service_name
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :error_handler, default_proc: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
             option :tag_body, default: false
           end
         end
diff --git a/spec/datadog/core/configuration/option_definition_spec.rb b/spec/datadog/core/configuration/option_definition_spec.rb
index 9c5c31d2316..1e80f6e8aa0 100644
--- a/spec/datadog/core/configuration/option_definition_spec.rb
+++ b/spec/datadog/core/configuration/option_definition_spec.rb
@@ -176,6 +176,7 @@
           it 'generates an OptionDefinition with defaults' do
             is_expected.to have_attributes(
               default: nil,
+              default_proc: nil,
               delegate_to: nil,
               depends_on: [],
               name: name,
@@ -209,6 +210,23 @@
         end
       end
     end
+
+    context 'validate_options!' do
+      context 'when default and default_proc is provided' do
+        let(:initialize_block) do
+          proc do |o|
+            o.default false
+            o.default_proc { true }
+          end
+        end
+
+        it do
+          expect do
+            is_expected
+          end.to raise_error(described_class::InvalidOptionError)
+        end
+      end
+    end
   end
 
   describe '#depends_on' do
@@ -253,6 +271,16 @@
     end
   end
 
+  describe '#default_proc' do
+    subject(:default_proc) { builder.default_proc(&block) }
+
+    context 'given a block' do
+      let(:block) { proc { false } }
+
+      it { is_expected.to be block }
+    end
+  end
+
   describe '#delegate_to' do
     subject(:delegate_to) { builder.delegate_to(&block) }
 
@@ -424,6 +452,7 @@
     it 'contains the arguments for OptionDefinition' do
       expect(meta.keys).to include(
         :default,
+        :default_proc,
         :delegate_to,
         :depends_on,
         :on_set,
diff --git a/spec/datadog/core/configuration/option_spec.rb b/spec/datadog/core/configuration/option_spec.rb
index c9ff32adb35..590c08c1272 100644
--- a/spec/datadog/core/configuration/option_spec.rb
+++ b/spec/datadog/core/configuration/option_spec.rb
@@ -9,6 +9,7 @@
     instance_double(
       Datadog::Core::Configuration::OptionDefinition,
       default: default,
+      default_proc: default_proc,
       delegate_to: delegate,
       on_set: nil,
       resetter: nil,
@@ -16,6 +17,7 @@
     )
   end
   let(:default) { double('default') }
+  let(:default_proc) { nil }
   let(:delegate) { nil }
   let(:setter) { proc { setter_value } }
   let(:setter_value) { double('setter_value') }
@@ -251,5 +253,11 @@
     context 'when default is not a block' do
       it { is_expected.to be default }
     end
+
+    context 'when default_proc is defined' do
+      let(:default_proc) { proc { 'default_proc' } }
+
+      it { is_expected.to be default_proc }
+    end
   end
 end