feat: added eval reasons to variable properties

Author: jsalaber

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,12 +195,16 @@ def variable(user, key, default, opts = {})
           value = default
           type = determine_variable_type(default)
           defaulted = true
+          eval = { reason: DevCycle::DEFAULT_REASONS::UNKNOWN, details: DevCycle::EVAL_REASON_DETAILS::UNKNOWN }
           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
+              eval = get_eval_reason(variable_pb)
+            else
+              eval = { reason: DevCycle::DEFAULT_REASONS::USER_NOT_TARGETED, details: DevCycle::DEFAULT_REASONS::USER_NOT_TARGETED }
             end
           else
             @logger.warn("Local bucketing not initialized, returning default value for variable #{key}")
@@ -214,7 +218,8 @@ def variable(user, key, default, opts = {})
             value: value,
             type: type,
             defaultValue: default,
-            isDefaulted: defaulted
+            isDefaulted: defaulted,
+            eval: eval
           })
         end
 
@@ -574,6 +579,15 @@ def get_variable_value(variable_pb)
       end
     end
 
+    def get_eval_reason(variable_pb)
+      if variable_pb.eval.nil?
+        { reason: DevCycle::DEFAULT_REASONS::UNKNOWN, details: DevCycle::DEFAULT_REASONS::UNKNOWN }
+      else
+        puts ("variable_pb.eval bruh: #{variable_pb.eval}")
+        { reason: variable_pb.eval.reason, details: variable_pb.eval.details }
+      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,55 @@
+module DevCycle
+  # Default reasons for evaluation failures
+  module DEFAULT_REASONS
+    MISSING_CONFIG = 'MISSING_CONFIG'
+    MISSING_VARIABLE = 'MISSING_VARIABLE'
+    MISSING_FEATURE = 'MISSING_FEATURE'
+    MISSING_VARIATION = 'MISSING_VARIATION'
+    MISSING_VARIABLE_FOR_VARIATION = 'MISSING_VARIABLE_FOR_VARIATION'
+    USER_NOT_IN_ROLLOUT = 'USER_NOT_IN_ROLLOUT'
+    USER_NOT_TARGETED = 'USER_NOT_TARGETED'
+    INVALID_VARIABLE_TYPE = 'INVALID_VARIABLE_TYPE'
+    UNKNOWN = 'UNKNOWN'
+  end
+
+  # Evaluation reasons for successful evaluations
+  module EVAL_REASONS
+    TARGETING_MATCH = 'TARGETING_MATCH'
+    SPLIT = 'SPLIT'
+    DEFAULT = 'DEFAULT'
+    DISABLED = 'DISABLED'
+    ERROR = 'ERROR'
+    OVERRIDE = 'OVERRIDE'
+    OPT_IN = 'OPT_IN'
+  end
+
+  # Detailed evaluation reason descriptions
+  module EVAL_REASON_DETAILS
+    # All Users
+    ALL_USERS = 'All Users'
+    # Audiences
+    AUDIENCE_MATCH = 'Audience Match'
+    NOT_IN_AUDIENCE = 'Not in Audience'
+    # Opt-In
+    OPT_IN = 'Opt-In'
+    NOT_OPTED_IN = 'Not Opt-In'
+    # Overrides
+    OVERRIDE = 'Override'
+    # Split details
+    RANDOM_DISTRIBUTION = 'Random Distribution'
+    ROLLOUT = 'Rollout'
+    # User Specific
+    USER_ID = 'User ID'
+    EMAIL = 'Email'
+    COUNTRY = 'Country'
+    PLATFORM = 'Platform'
+    PLATFORM_VERSION = 'Platform Version'
+    APP_VERSION = 'App Version'
+    DEVICE_MODEL = 'Device Model'
+    CUSTOM_DATA = 'Custom Data'
+    # Error cases
+    ERROR = 'Error'
+    DEFAULT = 'Default'
+    UNKNOWN = 'Unknown'
+  end
+end 

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

@@ -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_pb.rb

@@ -1,5 +1,5 @@
 #!/bin/bash
-BUCKETING_LIB_VERSION="1.35.1"
+BUCKETING_LIB_VERSION="1.40.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"

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

@@ -34,7 +34,7 @@ class Feature
     attr_accessor :variationName
 
     # Evaluation reasoning
-    attr_accessor :eval_reason
+    attr_accessor :eval
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -67,7 +67,7 @@ def self.attribute_map
         :'_variation' => :'_variation',
         :'variationKey' => :'variationKey',
         :'variationName' => :'variationName',
-        :'eval_reason' => :'evalReason'
+        :'eval' => :'eval'
       }
     end
 
@@ -133,10 +133,6 @@ def initialize(attributes = {})
       if attributes.key?(:'variationName')
         self.variationName = attributes[:'variationName']
       end
-
-      if attributes.key?(:'eval_reason')
-        self.eval_reason = attributes[:'eval_reason']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?

lib/devcycle-ruby-server-sdk/models/feature.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/models/variable.rb

@@ -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