fino-redis 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9974c2bc5e434114c5184d48f9c7d2654437c669e27b016fedd4694fb9404201
-  data.tar.gz: 1f74ae02ccc9e4ff3c23a25a23f37f34b2a4f3eec45bd7b3f12bcaefe6e9121f
+  metadata.gz: bf8532d7c9300576fc53693bc44a1ae65cecc2177c7cffe1ced5e233c915272a
+  data.tar.gz: 0a8d663f550775de858394e53c6ee522e07d0a90fe257fd1c6d5a16773a743cc
 SHA512:
-  metadata.gz: 1892e8b1672e070d5c608a21f2350f510fd5555434603c82296863bd8344eee9793da4102d017050246e131575dffdc83cb146386f139489b5b4dc753f8e9e44
-  data.tar.gz: 281ed65e05cf646c8672ccd85be6f85ee53ee1a3d7b74b7d78ea0ff86a4d1ce7151f014b127d1d49e4817e351cbcb456f9945c2b5f9511e30f1bdce245fed7b8
+  metadata.gz: c7257b235d5755fb4474fb5e3a478b8e97b0a80a78b54b11967faf871bf70f3e34e3f7a4f49da1cf24729df12052617c6ec1b9fd1ebff255f5cccd40daf8937c
+  data.tar.gz: 5c44aa7255f8e5bb2ea16a8167acd64385e031a22635ebd583ebeac17aead3dd5c8acf504bd2134c4f550c5f3dc329d88b3593df9bf4e2676ed94037cffbb073

data/README.md

@@ -1,6 +1,6 @@
 # Fino
 
-⚠️ Fino is under active development. API changes are possible ⚠️
+⚠️ Fino in active development phase at wasn't properly battle tested in production just yet. Give us a star and stay tuned for Production test results and new features
 
 Fino is a dynamic settings engine for Ruby and Rails
 
@@ -23,10 +23,15 @@ Fino.configure do
   settings do
     setting :maintenance_mode, :boolean, default: false
 
+    setting :api_rate_limit,
+            :integer,
+            default: 1000,
+            description: "Maximum API requests per minute per user to prevent abuse"
+
     section :openai, label: "OpenAI" do
       setting :model,
               :string,
-              default: "gpt-4o",
+              default: "gpt-5",
               description: "OpenAI model"
 
       setting :temperature,
@@ -51,7 +56,7 @@ end
 ### Work with settings
 
 ```ruby
-Fino.value(:model, at: :openai) #=> "gpt-4o"
+Fino.value(:model, at: :openai) #=> "gpt-5"
 Fino.value(:temperature, at: :openai) #=> 0.7
 
 Fino.values(:model, :temperature, at: :openai) #=> ["gpt-4", 0.7]
@@ -60,12 +65,46 @@ Fino.set(model: "gpt-5", at: :openai)
 Fino.value(:model, at: :openai) #=> "gpt-5"
 ```
 
-### Manage settings via UI
+### Overrides
 
 ```ruby
-gem "fino-rails"
+Fino.value(:model, at: :openai) #=> "gpt-5"
+
+Fino.set(model: "gpt-5", at: :openai, overrides: { "qa" => "our_local_model_not_to_pay_to_sam_altman" })
+
+Fino.value(:model, at: :openai) #=> "gpt-5"
+Fino.value(:model, at: :openai, for: "qa") #=> "our_local_model_not_to_pay_to_sam_altman"
+```
+
+### A/B testing
+
+```ruby
+Fino.value(:model, at: :openai) #=> "gpt-5"
+
+# "gpt-5" becomes the control variant value and a 20.0% variant is created with value "gpt-6"
+Fino.set(model: "gpt-5", at: :openai, variants: { 20.0 => "gpt-6" })
+
+Fino.setting(:model, at: :openai).experiment.variant(for: "user_1") #=> #<Fino::AbTesting::Variant percentage: 20.0, value: "gpt-6">
+
+# Picked variant is sticked to the user
+Fino.value(:model, at: :openai, for: "user_1") #=> "gpt-6"
+Fino.value(:model, at: :openai, for: "user_1") #=> "gpt-6"
+
+Fino.value(:model, at: :openai, for: "user_2") #=> "gpt-5"
 ```
 
+## Rails integration
+
+Fino easily integrates with Rails. Just add the gem to your Gemfile:
+
+```
+gem "fino-rails", require: false
+```
+
+to get built-in UI engine for your settings!
+
+### UI engine
+
 Mount Fino Rails engine in your `config/routes.rb`:
 
 ```ruby
@@ -74,4 +113,84 @@ Rails.application.routes.draw do
 end
 ```
 
-<img width="1229" height="641" alt="Screenshot 2025-09-04 at 16 01 51" src="https://github.com/user-attachments/assets/646df84c-c25b-4890-9637-c481e18c9bd4" />
+### Configuration
+
+```ruby
+Rails.application.configure do
+  config.fino.instrument = true
+  config.fino.log = true
+  config.fino.cache_within_request = false
+  config.fino.preload_before_request = true
+end
+```
+
+<img width="1493" height="676" alt="Screenshot 2025-09-19 at 13 09 06" src="https://github.com/user-attachments/assets/19b6147a-e18c-41cf-aac7-99111efcc9d5" />
+
+<img width="1775" height="845" alt="Screenshot 2025-09-19 at 13 09 33" src="https://github.com/user-attachments/assets/c0010abd-285d-43d0-ae5d-ce0edb781309" />
+
+## Performance tweaks
+
+1. In Memory cache
+
+   Fino provides in-memory settings caching functionality which will store settings received from adaper in memory for
+   a very quick access. As this kind of cache is not distributed between machines, but belongs to each process
+   separately, it's impossible to invalidate all at once, so be aware that setting update application time will depend
+   on cache TTL you configure
+
+   ```ruby
+   Fino.configure do
+     # ...
+     cache { Fino::Cache::Memory.new(expires_in: 3.seconds) }
+     # ...
+   end
+   ```
+
+2. Request scoped cache
+
+   When using Fino in Rails context it's possible to cache settings within request, in current thread storage. This is
+   safe way to cache settings as it's lifetime is limited, thus it is enabled by default
+
+   ```ruby
+   Rails.application.configure do
+     config.fino.cache_within_request = true
+   end
+   ```
+
+3. Preloading
+
+   In Rails context it is possible to tell Fino to preload multiple settings before processing request in a single
+   adapter call. Preloading is recommended for requests that use multiple different settings in their logic
+
+   ```ruby
+   # Preload all settings
+   Rails.application.configure do
+     config.fino.preload_before_request = true
+   end
+
+   # Preload specific subset of settings depending on request
+   Rails.application.configure do
+     config.fino.preload_before_request = ->(request) {
+       case request.path
+       when "request/using/all/settings"
+         true
+       when "request/not/using/settings"
+         false
+       when "request/using/specific/settings"
+         [
+           :api_rate_limit,
+           openai: [:model, :temperature]
+         ]
+       end
+     }
+   end
+   ```
+
+## Releasing
+
+`rake release`
+
+## Contributing
+
+1. Fork it
+2. Do contribution
+6. Create Pull Request into this repo

data/lib/fino/redis/adapter.rb

@@ -6,6 +6,8 @@ class Fino::Redis::Adapter
   using Fino::CustomRedisScripts
 
   DEFAULT_REDIS_NAMESPACE = "fino"
+  SETTINGS_NAMESPACE = "s"
+  PERSISTED_SETTINGS_KEYS_REDIS_KEY = "psl"
   SCOPE_PREFIX = "s"
   VARIANT_PREFIX = "v"
   VALUE_KEY = "v"
@@ -15,8 +17,16 @@ class Fino::Redis::Adapter
     @redis_namespace = namespace
   end
 
-  def read(setting_definition)
-    redis.hgetall(redis_key_for(setting_definition))
+  def read(setting_key)
+    redis.hgetall(redis_key_for(setting_key))
+  end
+
+  def read_multi(setting_keys)
+    keys = setting_keys.map { |setting_key| redis_key_for(setting_key) }
+
+    redis.pipelined do |pipeline|
+      keys.each { |key| pipeline.hgetall(key) }
+    end
   end
 
   def write(setting_definition, value, overrides, variants)
@@ -29,27 +39,35 @@ class Fino::Redis::Adapter
     end
 
     variants.each do |variant|
-      next if variant.value == Fino::Variant::CONTROL
+      next if variant.value == Fino::AbTesting::Variant::CONTROL_VALUE
 
       hash["#{VARIANT_PREFIX}/#{variant.percentage}/#{VALUE_KEY}"] = serialize_value.call(variant.value)
     end
 
-    redis.mapped_hreplace(redis_key_for(setting_definition), hash)
+    redis.multi do |r|
+      r.mapped_hreplace(redis_key_for(setting_definition.key), hash)
+      r.sadd(build_redis_key(PERSISTED_SETTINGS_KEYS_REDIS_KEY), setting_definition.key)
+    end
   end
 
-  def read_multi(setting_definitions)
-    keys = setting_definitions.map { |definition| redis_key_for(definition) }
+  def read_persisted_setting_keys
+    redis.smembers(build_redis_key(PERSISTED_SETTINGS_KEYS_REDIS_KEY))
+  end
 
-    redis.pipelined do |pipeline|
-      keys.each { |key| pipeline.hgetall(key) }
+  def clear(setting_key)
+    _, cleared = redis.multi do |r|
+      r.del(redis_key_for(setting_key))
+      r.srem(build_redis_key(PERSISTED_SETTINGS_KEYS_REDIS_KEY), setting_key)
     end
+
+    cleared == 1
   end
 
   def fetch_value_from(raw_adapter_data)
     raw_adapter_data.key?(VALUE_KEY) ? raw_adapter_data.delete(VALUE_KEY) : Fino::EMPTINESS
   end
 
-  def fetch_scoped_values_from(raw_adapter_data)
+  def fetch_raw_overrides_from(raw_adapter_data)
     raw_adapter_data.each_with_object({}) do |(key, value), memo|
       next unless key.start_with?("#{SCOPE_PREFIX}/")
 
@@ -72,7 +90,11 @@ class Fino::Redis::Adapter
 
   attr_reader :redis, :redis_namespace
 
-  def redis_key_for(setting_definition)
-    "#{redis_namespace}:#{setting_definition.path.join(':')}"
+  def redis_key_for(setting_key)
+    build_redis_key(SETTINGS_NAMESPACE, setting_key)
+  end
+
+  def build_redis_key(*parts)
+    [redis_namespace, *parts].join(":")
   end
 end

data/lib/fino/redis/custom_redis_scripts.rb

@@ -1,12 +1,24 @@
 # frozen_string_literal: true
 
 module Fino::CustomRedisScripts
+  module_function
+
+  def mapped_hreplace(connection, key, values_mapping)
+    connection.del(key)
+    connection.mapped_hmset(key, values_mapping)
+  end
+
   refine Redis do
     def mapped_hreplace(key, values_mapping)
-      multi do |r|
-        r.del(key)
-        r.mapped_hmset(key, values_mapping)
+      multi do |multi|
+        Fino::CustomRedisScripts.mapped_hreplace(multi, key, values_mapping)
       end
     end
   end
+
+  refine Redis::MultiConnection do
+    def mapped_hreplace(key, values_mapping)
+      Fino::CustomRedisScripts.mapped_hreplace(self, key, values_mapping)
+    end
+  end
 end

data/lib/fino/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Fino
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
   REQUIRED_RUBY_VERSION = ">= 3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fino-redis
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Egor Iskrenkov
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement