eppo-server-sdk 3.2.8 → 3.4.0

data/README.md

@@ -7,6 +7,23 @@ Refer to our [SDK documentation](https://docs.geteppo.com/feature-flags/sdks/rub
 ## Supported Ruby Versions
 This version of the SDK is compatible with Ruby 3.0.6 and above.
 
+## Logging
+
+Ruby SDK uses [`env_logger`](https://docs.rs/env_logger/) for logging.
+
+Starting from version 3.3.0, the log level can be configured via `EPPO_LOG` environment variable using one of the following values:
+- `off`
+- `error`
+- `warn`
+- `info` (default)
+- `debug`
+- `trace`
+
+Alternatively, it can be configured using `log_level` parameter for `EppoClient::Config` constructor:
+```ruby
+config = EppoClient::Config.new("sdk-key", log_level: "debug")
+```
+
 # Contributing
 
 ## Testing with local version of `eppo_core`
@@ -21,8 +38,40 @@ eppo_core = { path = '../eppo_core' }
 
 Make sure you remove the override before updating `Cargo.lock`. Otherwise, the lock file will be missing `eppo_core` checksum and will be unsuitable for release. (CI will warn you if you do this accidentally.)
 
+## Build locally
+
+Install all dependencies:
+```sh
+bundle install
+```
+
+Build native extension:
+```sh
+bundle exec rake build
+```
+
+Run tests:
+```sh
+bundle exec rspec
+```
+
 ## Releasing
 
 * Bump versions in `ruby-sdk/lib/eppo_client/version.rb` and `ruby-sdk/ext/eppo_client/Cargo.toml`
 * Run `cargo update --workspace --verbose` to update `Cargo.lock`
 * Run `bundle` to update `Gemfile.lock`
+
+
+## Building Ruby native lib
+
+1. Clone this repository at the desired Ruby SDK tag, eg.: `git clone --depth 1 --branch ruby-sdk@x.y.z https://github.com/Eppo-exp/eppo-multiplatform.git`
+2. Open `build.sh` and update `rb-sys-dock --platform <platform>` with the desired platform, eg.: `rb-sys-dock --platform x86_64-linux`
+3. Run `docker build --build-arg WORKDIR=$(pwd) -f Dockerfile.ruby.build -t ruby-sdk-builder .` to build the builder docker image
+4. Run the following command to build the gem with native lib:
+```
+mkdir -p rust/cargo/registry && docker run --rm -it \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v /tmp:/tmp -v \
+  $(pwd)/rust:$(pwd)/rust ruby-sdk-builder
+```
+5. The gem will be available at `ruby-sdk/pkg/eppo-server-sdk-x.y.z-arch.gem`

data/ext/eppo_client/Cargo.toml

@@ -1,18 +1,18 @@
 [package]
 name = "eppo_client"
 # TODO: this version and lib/eppo_client/version.rb should be in sync
-version = "3.2.8"
+version = "3.4.0"
 edition = "2021"
 license = "MIT"
 publish = false
-rust-version = "1.71.1"
+rust-version = "1.75.0"
 
 [lib]
 crate-type = ["cdylib"]
 
 [dependencies]
 env_logger = { version = "0.11.3", features = ["unstable-kv"] }
-eppo_core = { version = "4.1.0", features = ["vendored"] }
+eppo_core = { version = "=7.0.0", features = ["vendored", "magnus"] }
 log = { version = "0.4.21", features = ["kv_serde"] }
 magnus = { version = "0.6.4" }
 serde = { version = "1.0.203", features = ["derive"] }

data/ext/eppo_client/src/client.rs

@@ -1,4 +1,4 @@
-use std::{cell::RefCell, sync::Arc, time::Duration};
+use std::{cell::RefCell, str::FromStr, sync::Arc, time::Duration};
 
 use eppo_core::{
     configuration_fetcher::{ConfigurationFetcher, ConfigurationFetcherConfig},
@@ -8,7 +8,7 @@ use eppo_core::{
     ufc::VariationType,
     Attributes, ContextAttributes,
 };
-use magnus::{error::Result, exception, prelude::*, Error, TryConvert, Value};
+use magnus::{error::Result, exception, prelude::*, Error, IntoValue, Ruby, TryConvert, Value};
 
 use crate::{configuration::Configuration, SDK_METADATA};
 
@@ -19,6 +19,7 @@ pub struct Config {
     base_url: String,
     poll_interval: Option<Duration>,
     poll_jitter: Duration,
+    log_level: Option<log::LevelFilter>,
 }
 
 impl TryConvert for Config {
@@ -29,11 +30,22 @@ impl TryConvert for Config {
         let poll_interval_seconds =
             Option::<u64>::try_convert(val.funcall("poll_interval_seconds", ())?)?;
         let poll_jitter_seconds = u64::try_convert(val.funcall("poll_jitter_seconds", ())?)?;
+
+        let log_level = {
+            let s = Option::<String>::try_convert(val.funcall("log_level", ())?)?;
+            s.map(|s| {
+                log::LevelFilter::from_str(&s)
+                    .map_err(|err| Error::new(exception::runtime_error(), err.to_string()))
+            })
+            .transpose()?
+        };
+
         Ok(Config {
             api_key,
             base_url,
             poll_interval: poll_interval_seconds.map(Duration::from_secs),
             poll_jitter: Duration::from_secs(poll_jitter_seconds),
+            log_level,
         })
     }
 }
@@ -52,6 +64,23 @@ pub struct Client {
 
 impl Client {
     pub fn new(config: Config) -> Client {
+        // Initialize logger
+        {
+            let mut builder = env_logger::Builder::from_env(
+                env_logger::Env::new()
+                    .filter_or("EPPO_LOG", "eppo=info")
+                    .write_style("EPPO_LOG_STYLE"),
+            );
+
+            if let Some(log_level) = config.log_level {
+                builder.filter_module("eppo", log_level);
+            }
+
+            // Logger can only be set once, so we ignore the initialization error here if client is
+            // re-initialized.
+            let _ = builder.try_init();
+        };
+
         let configuration_store = Arc::new(ConfigurationStore::new());
 
         let poller_thread = if let Some(poll_interval) = config.poll_interval {
@@ -87,7 +116,8 @@ impl Client {
     }
 
     pub fn get_assignment(
-        &self,
+        ruby: &Ruby,
+        rb_self: &Self,
         flag_key: String,
         subject_key: String,
         subject_attributes: Value,
@@ -96,7 +126,7 @@ impl Client {
         let expected_type: VariationType = serde_magnus::deserialize(expected_type)?;
         let subject_attributes: Attributes = serde_magnus::deserialize(subject_attributes)?;
 
-        let result = self
+        let result = rb_self
             .evaluator
             .get_assignment(
                 &flag_key,
@@ -107,7 +137,7 @@ impl Client {
             // TODO: maybe expose possible errors individually.
             .map_err(|err| Error::new(exception::runtime_error(), err.to_string()))?;
 
-        Ok(serde_magnus::serialize(&result).expect("assignment value should be serializable"))
+        Ok(result.into_value_with(&ruby))
     }
 
     pub fn get_assignment_details(
@@ -117,6 +147,8 @@ impl Client {
         subject_attributes: Value,
         expected_type: Value,
     ) -> Result<Value> {
+        let ruby = Ruby::get_with(subject_attributes);
+
         let expected_type: VariationType = serde_magnus::deserialize(expected_type)?;
         let subject_attributes: Attributes = serde_magnus::deserialize(subject_attributes)?;
 
@@ -127,7 +159,7 @@ impl Client {
             Some(expected_type),
         );
 
-        Ok(serde_magnus::serialize(&result).expect("assignment value should be serializable"))
+        Ok(result.into_value_with(&ruby))
     }
 
     pub fn get_bandit_action(
@@ -144,7 +176,7 @@ impl Client {
         .map_err(|err| {
             Error::new(
                 exception::runtime_error(),
-                format!("enexpected value for subject_attributes: {err}"),
+                format!("Unexpected value for subject_attributes: {err}"),
             )
         })?;
         let actions = serde_magnus::deserialize(actions)?;

data/ext/eppo_client/src/lib.rs

@@ -14,8 +14,6 @@ pub(crate) const SDK_METADATA: SdkMetadata = SdkMetadata {
 
 #[magnus::init]
 fn init(ruby: &Ruby) -> Result<(), Error> {
-    env_logger::Builder::from_env(env_logger::Env::new().default_filter_or("eppo=debug")).init();
-
     let eppo_client = ruby.define_module("EppoClient")?;
     let core = eppo_client.define_module("Core")?;
 

data/lib/eppo_client/client.rb

@@ -22,7 +22,7 @@ module EppoClient
     def init(config)
       config.validate
 
-      if !@core.nil?
+      if @core
         STDERR.puts "Eppo Warning: multiple initialization of the client"
         @core.shutdown
       end
@@ -91,7 +91,10 @@ module EppoClient
       log_assignment(result[:assignment_event])
       log_bandit_action(result[:bandit_event])
 
-      return {:variation => result[:variation], :action => result[:action]}
+      {
+        :variation => result[:variation],
+        :action => result[:action]
+      }
     end
 
     def get_bandit_action_details(flag_key, subject_key, subject_attributes, actions, default_variation)
@@ -102,7 +105,7 @@ module EppoClient
       log_assignment(result[:assignment_event])
       log_bandit_action(result[:bandit_event])
 
-      return {
+      {
         :variation => result[:variation],
         :action => result[:action],
         :evaluationDetails => details
@@ -116,13 +119,11 @@ module EppoClient
       logger = Logger.new($stdout)
       begin
         assignment = @core.get_assignment(flag_key, subject_key, subject_attributes, expected_type)
-        if not assignment then
-          return default_value
-        end
+        return default_value unless assignment
 
         log_assignment(assignment[:event])
 
-        return assignment[:value][:value]
+        return assignment[:value]
       rescue StandardError => error
         logger.debug("[Eppo SDK] Failed to get assignment: #{error}")
 
@@ -137,19 +138,16 @@ module EppoClient
       result, event = @core.get_assignment_details(flag_key, subject_key, subject_attributes, expected_type)
       log_assignment(event)
 
-      if not result[:variation] then
+      if !result[:variation]
         result[:variation] = default_value
-      else
-        # unwrap from AssignmentValue to untyped value
-        result[:variation] = result[:variation][:value]
       end
 
-      return result
+      result
     end
     # rubocop:enable Metrics/MethodLength
 
     def log_assignment(event)
-      if not event then return end
+      return unless event
 
       # Because rust's AssignmentEvent has a #[flatten] extra_logging
       # field, serde_magnus serializes it as a normal HashMap with
@@ -170,7 +168,7 @@ module EppoClient
     end
 
     def log_bandit_action(event)
-      if not event then return end
+      return unless event
 
       begin
         @assignment_logger.log_bandit_action(event)

data/lib/eppo_client/config.rb

@@ -6,14 +6,15 @@ require_relative "assignment_logger"
 module EppoClient
   # The class for configuring the Eppo client singleton
   class Config
-    attr_reader :api_key, :assignment_logger, :base_url, :poll_interval_seconds, :poll_jitter_seconds
+    attr_reader :api_key, :assignment_logger, :base_url, :poll_interval_seconds, :poll_jitter_seconds, :log_level
 
-    def initialize(api_key, assignment_logger: AssignmentLogger.new, base_url: EppoClient::Core::DEFAULT_BASE_URL, poll_interval_seconds: EppoClient::Core::DEFAULT_POLL_INTERVAL_SECONDS, poll_jitter_seconds: EppoClient::Core::DEFAULT_POLL_JITTER_SECONDS, initial_configuration: nil)
+    def initialize(api_key, assignment_logger: AssignmentLogger.new, base_url: EppoClient::Core::DEFAULT_BASE_URL, poll_interval_seconds: EppoClient::Core::DEFAULT_POLL_INTERVAL_SECONDS, poll_jitter_seconds: EppoClient::Core::DEFAULT_POLL_JITTER_SECONDS, initial_configuration: nil, log_level: nil)
       @api_key = api_key
       @assignment_logger = assignment_logger
       @base_url = base_url
       @poll_interval_seconds = poll_interval_seconds
       @poll_jitter_seconds = poll_jitter_seconds
+      @log_level = log_level
     end
 
     def validate

data/lib/eppo_client/version.rb

@@ -2,5 +2,5 @@
 
 # TODO: this version and ext/eppo_client/Cargo.toml should be in sync
 module EppoClient
-  VERSION = "3.2.8"
+  VERSION = "3.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eppo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 3.2.8
+  version: 3.4.0
 platform: ruby
 authors:
 - Eppo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Eppo SDK for Ruby