featureflip 2.3.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcc479d4aca550b2c17f8a988df92f7a7406a8712765767311f9f712c56f1fd1
-  data.tar.gz: c9281f409c2736e2c6b929cd39fb433e38969b496b59d7387b61de7ba0dc6ce5
+  metadata.gz: c796399a9211346f5354865f41d6cc5d0b62660d6f38efb6bc37c2861530a570
+  data.tar.gz: be799703942cd3fbe68f14a106913ce54e3bd2010d36e33be28bc356c59013b2
 SHA512:
-  metadata.gz: 8935a5f95ab48a7ce6c05af6a832aa8eca8cd1b1d5e66c20475f4a7a9fec38ec186313269f98bbd4d766eca22ff36dec814854beee2bfca77229b3e7a62f0067
-  data.tar.gz: 222fb9607a98518003f733a9abfcb3bb65143b33b05a5d4e7bf281e875573c33a4a28a83275a286328cb986cbdf622a1155f75e29188b5729a3f32a2f2ce906a
+  metadata.gz: '09edab24cf6796f2360677ffad03c5dbdd44a5382a0b9254d06e49b1d8883bd9e887e938f4f5f8d582911f8e681be7c571d008676a80cc7959f2b0181f05c563'
+  data.tar.gz: 5d18d268fd63154306ad2326f9fb8f7b5033f8c395e5eb43760ec0b291c59f7378e2cfbc71b80487a70fbf717cba72763b937b557971cb536ce79e1aa772f88d

data/lib/featureflip/config.rb

@@ -4,6 +4,11 @@ module Featureflip
                   :flush_batch_size, :init_timeout, :connect_timeout, :read_timeout,
                   :max_stream_retries, :send_events, :logger
 
+    # Evaluation inspectors -- callables invoked once per variation call with a
+    # Models::EvaluationEvent. Always an Array; non-callable entries are dropped
+    # on assignment rather than blowing up on the evaluation hot path.
+    attr_reader :inspectors
+
     def initialize(
       sdk_key: nil,
       base_url: "https://eval.featureflip.io",
@@ -16,7 +21,8 @@ module Featureflip
       read_timeout: 10,
       max_stream_retries: 5,
       send_events: true,
-      logger: nil
+      logger: nil,
+      inspectors: nil
     )
       @sdk_key = sdk_key
       @base_url = base_url
@@ -30,10 +36,23 @@ module Featureflip
       @max_stream_retries = max_stream_retries
       @send_events = send_events
       @logger = logger || default_logger
+      self.inspectors = inspectors
 
       validate!
     end
 
+    # Accepts a single callable or an array of callables. Anything that does not
+    # respond to #call is filtered out here, so the evaluation path never has to
+    # guard against it.
+    def inspectors=(value)
+      list = case value
+             when nil then []
+             when Array then value
+             else [value]
+             end
+      @inspectors = list.select { |i| i.respond_to?(:call) }.freeze
+    end
+
     def validate!
       finalize!
       validate_positive_fields!

data/lib/featureflip/data_source/streaming.rb

@@ -25,9 +25,9 @@ module Featureflip
       # raises Net::ReadTimeout, which drives reconnect/backoff/polling. Set to
       # 3× the ping (3 missed pings) so it never severs a healthy stream but still
       # detects a dead socket within a bounded time. MUST stay finite and
-      # > SERVER_PING_INTERVAL_SECONDS. (The rest of the family runs an infinite
-      # read timeout — java readTimeout(0) / python read=None / csharp #1526 —
-      # and has the same latent half-open hole; ruby closes it here.)
+      # > SERVER_PING_INTERVAL_SECONDS. (The rest of the server family now runs the
+      # same finite 90s watchdog — java readTimeout(90s) / python read=90.0 / csharp
+      # an idle-timeout CTS reset per event — so half-open detection is uniform.)
       STREAM_READ_TIMEOUT = SERVER_PING_INTERVAL_SECONDS * 3
 
       # Base reconnect backoff; also the floor applied after a healthy stream

data/lib/featureflip/models/evaluation_event.rb

@@ -0,0 +1,29 @@
+module Featureflip
+  module Models
+    # The payload handed to every registered evaluation inspector, once per
+    # variation call. This is the frozen cross-SDK inspector contract (see
+    # docs/superpowers/specs/2026-07-13-sdk-onevaluation-inspector-design.md),
+    # spelled in Ruby snake_case:
+    #
+    #   flag_key         the flag key evaluated
+    #   context          the full evaluation context -- a copy, so mutating it
+    #                    cannot affect the caller's hash
+    #   value            the value the caller actually receives (default applied)
+    #   variation_key    winning arm; nil on flag-not-found and on error
+    #   reason           this SDK's native reason string (PascalCase, matching
+    #                    EvaluationDetail#reason -- deliberately NOT converted)
+    #   rule_id          set only on a rule match
+    #   prerequisite_key set only on a prerequisite failure
+    #   timestamp        ISO-8601 string
+    EvaluationEvent = Struct.new(
+      :flag_key, :context, :value, :variation_key, :reason,
+      :rule_id, :prerequisite_key, :timestamp,
+      keyword_init: true
+    ) do
+      def initialize(flag_key:, context:, value:, reason:, timestamp:,
+                     variation_key: nil, rule_id: nil, prerequisite_key: nil)
+        super
+      end
+    end
+  end
+end

data/lib/featureflip/shared_core.rb

@@ -1,10 +1,36 @@
 require "timeout"
+require "time"
 
 module Featureflip
   class SharedCore
     LIVE_CORES = {}
     LIVE_CORES_MUTEX = Mutex.new
 
+    # Exception classes that are deliberately NOT isolated when an evaluation
+    # inspector raises them (see #notify_inspectors). Everything else -- every
+    # StandardError, plus the Exception-but-not-StandardError classes a buggy
+    # callback realistically raises (NotImplementedError and other ScriptErrors,
+    # Minitest::Assertion, RSpec::Expectations::ExpectationNotMetError) -- is
+    # caught and logged so the caller's value is never affected.
+    #
+    # These four are re-raised because swallowing them would break something the
+    # inspector has no business breaking:
+    #   SystemExit        `exit`/`abort` -- the process is deliberately going down
+    #   SignalException   SIGTERM and (via its subclass Interrupt) Ctrl-C
+    #   NoMemoryError     the VM is out of memory; there is nothing safe to do
+    #   SystemStackError  the stack is blown; unwinding is the only safe move
+    # Timeout::ExitException is the private class `Timeout.timeout` throws into
+    # the running thread to unwind it; eating it would silently neutralise a
+    # caller that wrapped its variation call in a timeout.
+    INSPECTOR_UNISOLATED_ERRORS = [
+      SystemExit,
+      SignalException,
+      NoMemoryError,
+      SystemStackError,
+      (Timeout::ExitException if defined?(Timeout::ExitException))
+    ].compact.freeze
+    private_constant :INSPECTOR_UNISOLATED_ERRORS
+
     # --- Class-level factory methods ---
 
     def self._get_or_create(sdk_key, config)
@@ -52,6 +78,12 @@ module Featureflip
     def initialize(sdk_key:, config:)
       @sdk_key = sdk_key
       @config = config
+      # Snapshot the (already-filtered) inspector list at construction: config is
+      # immutable-after-init from the core's point of view, so the evaluation path
+      # needs no locking. Deliberately excluded from _configs_equal -- callables
+      # aren't structurally comparable and a differing inspector must not trigger
+      # the "different config" warning.
+      @inspectors = config.inspectors || []
       @store = Store::FlagStore.new
       @evaluator = Evaluation::Evaluator.new
       @initialized = false
@@ -124,6 +156,8 @@ module Featureflip
       context = normalize_context(context)
 
       if @test_mode
+        # Test-mode cores are built by _create_for_testing, which has no user
+        # config, so there are never inspectors to notify here.
         value = @test_values.fetch(key, default_value)
         reason = @test_values.key?(key) ? "Fallthrough" : "FlagNotFound"
         return Models::EvaluationDetail.new(value: value, reason: reason)
@@ -132,6 +166,7 @@ module Featureflip
       flag = @store.get_flag(key)
       unless flag
         record_evaluation(key, context, nil)
+        notify_inspectors(key, context, default_value, reason: "FlagNotFound")
         return Models::EvaluationDetail.new(value: default_value, reason: "FlagNotFound")
       end
 
@@ -141,12 +176,33 @@ module Featureflip
         get_segment: method(:get_segment),
         all_flags: @store.all_flags_map
       )
+
+      # Malformed config: the evaluator selected a variation key the flag does
+      # not define (e.g. a fallthrough/rule naming a since-deleted variation).
+      # Degrade to the caller's default and report Error, mirroring the engine's
+      # ServeVariation + the C#/Java SDKs (#1989). A variation that genuinely
+      # exists with a nil value is NOT this case -- hence the key lookup rather
+      # than a `value.nil?` check, which cannot tell the two apart.
+      reason = if result.variation_key && !result.variation_key.empty? &&
+                  flag.get_variation(result.variation_key).nil?
+                 "Error"
+               else
+                 result.reason
+               end
+
       value = result.value.nil? ? default_value : result.value
       record_evaluation(key, context, result.variation_key)
+      notify_inspectors(
+        key, context, value,
+        reason: reason,
+        variation_key: result.variation_key,
+        rule_id: result.rule_id,
+        prerequisite_key: result.prerequisite_key
+      )
 
       Models::EvaluationDetail.new(
         value: value,
-        reason: result.reason,
+        reason: reason,
         rule_id: result.rule_id,
         variation_key: result.variation_key,
         prerequisite_key: result.prerequisite_key
@@ -155,6 +211,7 @@ module Featureflip
       # Prerequisite-resolution failures return PrerequisiteFailed cleanly through
       # the evaluator; this rescue only fires on unexpected exceptions (malformed
       # config, programming errors), so prerequisite_key has no defined value.
+      notify_inspectors(key, context, default_value, reason: "Error")
       Models::EvaluationDetail.new(value: default_value, reason: "Error", prerequisite_key: nil)
     end
 
@@ -342,9 +399,51 @@ module Featureflip
       })
     end
 
+    # Fire the registered evaluation inspectors. Called once per variation call
+    # on every exit path of variation_detail (success, flag-not-found, error)
+    # with the reason and value the caller actually receives. A raising inspector
+    # is isolated: it neither changes the returned value nor stops its siblings.
+    def notify_inspectors(flag_key, context, value, reason:, variation_key: nil,
+                          rule_id: nil, prerequisite_key: nil)
+      return if @inspectors.nil? || @inspectors.empty?
+
+      event = Models::EvaluationEvent.new(
+        flag_key: flag_key,
+        # Shallow copy so a buggy inspector cannot mutate the caller's hash.
+        context: context.dup,
+        value: value,
+        variation_key: variation_key,
+        reason: reason,
+        rule_id: rule_id,
+        prerequisite_key: prerequisite_key,
+        # Millisecond precision, matching the sibling SDKs (PHP's "Y-m-d\TH:i:s.v\Z",
+        # C#'s "o", Python's isoformat). Whole-second stamps make an analytics sink
+        # that de-duplicates on (flag, user, timestamp) drop repeat exposures inside
+        # the same second, so the digit argument is load-bearing -- don't drop it.
+        timestamp: Time.now.utc.iso8601(3)
+      )
+
+      @inspectors.each do |inspector|
+        begin
+          inspector.call(event)
+        # Order matters: the un-isolated list is matched first, then everything
+        # else is contained. `rescue StandardError` is too narrow (an assertion
+        # failure or NotImplementedError from an inspector would escape into the
+        # caller's request handler, which the inspector contract forbids) and a
+        # bare `rescue Exception` is too wide (it would eat Ctrl-C). See
+        # INSPECTOR_UNISOLATED_ERRORS above before changing either arm.
+        rescue *INSPECTOR_UNISOLATED_ERRORS
+          raise
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          @config.logger&.warn("Featureflip: evaluation inspector raised #{e.class}: #{e.message}")
+        end
+      end
+    end
+
     def init_test_mode(flags)
       @sdk_key = "test-key"
       @config = Config.new
+      @inspectors = []
       @store = Store::FlagStore.new
       @evaluator = Evaluation::Evaluator.new
       @initialized = true

data/lib/featureflip/store/flag_store.rb

@@ -32,10 +32,20 @@ module Featureflip
         @mutex.synchronize { @flags.dup }
       end
 
+      # Apply a single flag delta (SSE `flag.created` / `flag.updated`).
+      #
+      # Rejects only a *strictly older* config. Equal versions must be applied:
+      # the wire version is second-granular, so two edits to one flag inside the
+      # same wall-clock second carry an identical version, and treating equal as
+      # stale discarded the second edit outright. With streaming on there is no
+      # polling snapshot to correct it, so the store evaluated against the
+      # pre-edit config until an SSE `sync` or reconnect.
+      #
+      # Re-applying an identical config is harmless; dropping a real one is not.
       def upsert(flag)
         @mutex.synchronize do
           existing = @flags[flag.key]
-          return if existing && existing.version >= flag.version
+          return if existing && existing.version > flag.version
           @flags[flag.key] = flag
         end
       end

data/lib/featureflip/version.rb

@@ -1,3 +1,3 @@
 module Featureflip
-  VERSION = "2.3.0"
+  VERSION = "2.4.1"
 end

data/lib/featureflip.rb

@@ -4,6 +4,7 @@ require_relative "featureflip/config"
 require_relative "featureflip/models/flag"
 require_relative "featureflip/models/segment"
 require_relative "featureflip/models/evaluation_detail"
+require_relative "featureflip/models/evaluation_event"
 require_relative "featureflip/evaluation/bucketing"
 require_relative "featureflip/evaluation/condition_evaluator"
 require_relative "featureflip/evaluation/evaluator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featureflip
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Featureflip
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-13 00:00:00.000000000 Z
+date: 2026-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.0'
 description: Server-side SDK for evaluating feature flags with Featureflip
 email:
 executables: []
@@ -85,6 +85,7 @@ files:
 - lib/featureflip/events/event_processor.rb
 - lib/featureflip/http/client.rb
 - lib/featureflip/models/evaluation_detail.rb
+- lib/featureflip/models/evaluation_event.rb
 - lib/featureflip/models/flag.rb
 - lib/featureflip/models/segment.rb
 - lib/featureflip/shared_core.rb