feat: added eval reasons to variable properties (#122)

* feat: added eval reasons to variable properties

* chore: add eval reason capability to ruby

* chore: update bucketing lib and use correct eval reasons

* chore: attempt to debug failing harness tests

* chore: fix _feature being returned in allVariables

* fix: filter out _feature in allVariables return

* chore: add eval reason to agg_variable_defaulted metadata

* chore: update bucketing lib for events eval reasons

* chore: added default reason to event metadata

* chore: removed unused reasons and details

* chore: try to run cloud for ruby test harness

Author: jsalaber

.github/workflows/test-harness.yml

@@ -14,3 +14,4 @@ jobs:
         with:
           sdks-to-test: ruby
           sdk-github-sha: ${{github.event.pull_request.head.sha}}
+          sdk-capabilities: '{ "Ruby": ["clientCustomData", "v2Config", "allVariables", "allFeatures", "evalReason", "eventsEvalReason", "variablesFeatureId"]}'

lib/devcycle-ruby-server-sdk.rb

@@ -29,6 +29,7 @@
 require 'devcycle-ruby-server-sdk/eval_hooks_runner'
 require 'devcycle-ruby-server-sdk/models/eval_hook'
 require 'devcycle-ruby-server-sdk/models/eval_hook_context'
+require 'devcycle-ruby-server-sdk/eval_reasons'
 
 # APIs
 require 'devcycle-ruby-server-sdk/api/client'

lib/devcycle-ruby-server-sdk/api/client.rb

@@ -195,16 +195,19 @@ def variable(user, key, default, opts = {})
           value = default
           type = determine_variable_type(default)
           defaulted = true
+          eval = { reason: DevCycle::EVAL_REASONS::DEFAULT, details: DevCycle::DEFAULT_REASON_DETAILS::USER_NOT_TARGETED }
           if local_bucketing_initialized? && @local_bucketing.has_config
             type_code = variable_type_code_from_type(type)
             variable_pb = variable_for_user_pb(user, key, type_code)
             unless variable_pb.nil?
               value = get_variable_value(variable_pb)
               defaulted = false
             end
+            eval = get_eval_reason(variable_pb)
           else
+            eval = { reason: DevCycle::EVAL_REASONS::DEFAULT, details: DevCycle::DEFAULT_REASON_DETAILS::MISSING_CONFIG }
             @logger.warn("Local bucketing not initialized, returning default value for variable #{key}")
-            variable_event = Event.new({ type: DevCycle::EventTypes[:agg_variable_defaulted], target: key })
+            variable_event = Event.new({ type: DevCycle::EventTypes[:agg_variable_defaulted], target: key, metaData: { evalReason: DevCycle::EVAL_REASONS::DEFAULT }})
             bucketed_config = BucketedUserConfig.new({}, {}, {}, {}, {}, {}, [])
             @event_queue.queue_aggregate_event(variable_event, bucketed_config)
           end
@@ -214,7 +217,8 @@ def variable(user, key, default, opts = {})
             value: value,
             type: type,
             defaultValue: default,
-            isDefaulted: defaulted
+            isDefaulted: defaulted,
+            eval: eval
           })
         end
 
@@ -574,6 +578,18 @@ def get_variable_value(variable_pb)
       end
     end
 
+    def get_eval_reason(variable_pb)
+      if variable_pb.nil?
+        { reason: DevCycle::EVAL_REASONS::DEFAULT, details: DevCycle::DEFAULT_REASON_DETAILS::USER_NOT_TARGETED}
+      else
+        if variable_pb.eval.nil?
+          { reason: DevCycle::EVAL_REASONS::DEFAULT, details: DevCycle::DEFAULT_REASON_DETAILS::USER_NOT_TARGETED }
+        else
+          { reason: variable_pb.eval.reason, details: variable_pb.eval.details, target_id: variable_pb.eval.target_id }
+        end
+      end
+    end
+
     # Adds an eval hook to the client
     # @param [EvalHook] eval_hook The eval hook to add
     # @return [void]

lib/devcycle-ruby-server-sdk/eval_reasons.rb

@@ -0,0 +1,13 @@
+module DevCycle
+  # Evaluation reasons for successful evaluations
+  module EVAL_REASONS
+    DEFAULT = 'DEFAULT'
+    ERROR = 'ERROR'
+  end
+
+  # Default reason details
+  module DEFAULT_REASON_DETAILS
+    MISSING_CONFIG = 'Missing Config'
+    USER_NOT_TARGETED = 'User Not Targeted'
+  end
+end

lib/devcycle-ruby-server-sdk/localbucketing/bucketing-lib.release.wasm

@@ -66,4 +66,12 @@ message SDKVariable_PB {
   double doubleValue = 5;
   string stringValue = 6;
   NullableString evalReason = 7;
+  NullableString _feature = 8; 
+  EvalReason_PB eval = 9;
 }
+
+message EvalReason_PB {
+  string reason = 1;
+  string details = 2;
+  string target_id = 3;
+}

lib/devcycle-ruby-server-sdk/localbucketing/proto/variableForUserParams.proto

@@ -1,5 +1,5 @@
 #!/bin/bash
-BUCKETING_LIB_VERSION="1.35.1"
+BUCKETING_LIB_VERSION="1.41.0"
 WAT_DOWNLOAD=0
 rm bucketing-lib.release.wasm
-wget "https://unpkg.com/@devcycle/bucketing-assembly-script@$BUCKETING_LIB_VERSION/build/bucketing-lib.release.wasm"
+wget "https://unpkg.com/@devcycle/bucketing-assembly-script@$BUCKETING_LIB_VERSION/build/bucketing-lib.release.wasm"

lib/devcycle-ruby-server-sdk/localbucketing/proto/variableForUserParams_pb.rb

@@ -29,6 +29,9 @@ class Variable
 
     attr_accessor :defaultValue
 
+    # Variable evaluation details
+    attr_accessor :eval
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -58,7 +61,8 @@ def self.attribute_map
         :'type' => :'type',
         :'value' => :'value',
         :'defaultValue' => :'defaultValue',
-        :'isDefaulted' => :'isDefaulted'
+        :'isDefaulted' => :'isDefaulted',
+        :'eval' => :'eval'
       }
     end
 
@@ -120,6 +124,10 @@ def initialize(attributes = {})
       if attributes.key?(:'defaultValue')
         self.defaultValue = attributes[:'defaultValue']
       end
+
+      if attributes.key?(:'eval')
+        self.eval = attributes[:'eval']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?

lib/devcycle-ruby-server-sdk/localbucketing/update_wasm.sh

@@ -21,16 +21,18 @@
     sdk_key = ENV["DEVCYCLE_SERVER_SDK_KEY"]
     if sdk_key.nil?
       puts("SDK KEY NOT SET - SKIPPING INIT")
-      return
+      @skip_tests = true
+    else
+      # run before each test
+      options = DevCycle::Options.new(enable_cloud_bucketing: true)
+      @api_instance = DevCycle::Client.new(sdk_key, options)
+      
+      @user = DevCycle::User.new({
+          user_id: 'test-user',
+          appVersion: '1.2.3'
+      })
+      @skip_tests = false
     end
-    # run before each test
-    options = DevCycle::Options.new(enable_cloud_bucketing: true)
-    @api_instance = DevCycle::Client.new(sdk_key, options)
-    
-    @user = DevCycle::User.new({
-        user_id: 'test-user',
-        appVersion: '1.2.3'
-    })
   end
 
   after do