flagsmith 4.1.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b908dee8f4935d4c754400d2e314e8a61e545dc242490ca396704f6b00ef1e1
-  data.tar.gz: 4c9203ad57f71fb3699b78ccb9a50aa7b4c89eaf1433803d0c16e3b7644a91c3
+  metadata.gz: 0d20d6b2aee787d2d25478b00eea5f1e06ad4f345097102b1381faf7455774d2
+  data.tar.gz: c782d13647ae7c5905e0a0b46cb0085a395adbb71c95101e0b424b719e2b1a52
 SHA512:
-  metadata.gz: a41d33186ccd7bf6b7405a123186888ea9aef9e0890762b2384d1681b897ceed602e471eb4903190bf09b0c1c48a6b99a831053f10dde55cbcd6e9875851dfde
-  data.tar.gz: e654da93bb040ce2a08fa0cb6b15d167a2b557853fec1e8deb3cd45df124177998d7fb40e6ccae777cf8e62b0cdc72efd0cbd3a8e6fd4fcd894ed2b23d228c90
+  metadata.gz: 135da46a33bde44fb78a54c769dc25caab7566b18c68a870306ef645cad2de6de75ee599af0fd851fa3a3562bae92bec57e57089f31fa4f9cb282fadf47df01a
+  data.tar.gz: ead1e0df360be3a4637892f8fec1c10415967a072604b42dc113ee5034a06a235294300de59014ab35c829aceb46acca9454f29138e02dd610fd97abaadae293

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flagsmith (4.1.1)
+    flagsmith (4.3.0)
       faraday (>= 2.0.1)
       faraday-retry
       semantic
@@ -39,8 +39,7 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.9)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -69,7 +68,6 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     semantic (1.6.1)
-    strscan (3.1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
 

data/lib/flagsmith/engine/segments/models.rb

@@ -37,15 +37,15 @@ module Flagsmith
 
         MATCHING_FUNCTIONS = {
           EQUAL => ->(other_value, self_value) { other_value == self_value },
-          GREATER_THAN => ->(other_value, self_value) { other_value > self_value },
-          GREATER_THAN_INCLUSIVE => ->(other_value, self_value) { other_value >= self_value },
-          LESS_THAN => ->(other_value, self_value) { other_value < self_value },
-          LESS_THAN_INCLUSIVE => ->(other_value, self_value) { other_value <= self_value },
+          GREATER_THAN => ->(other_value, self_value) { (other_value || false) && other_value > self_value },
+          GREATER_THAN_INCLUSIVE => ->(other_value, self_value) { (other_value || false) && other_value >= self_value },
+          LESS_THAN => ->(other_value, self_value) { (other_value || false) && other_value < self_value },
+          LESS_THAN_INCLUSIVE => ->(other_value, self_value) { (other_value || false) && other_value <= self_value },
           NOT_EQUAL => ->(other_value, self_value) { other_value != self_value },
-          CONTAINS => ->(other_value, self_value) { other_value.include? self_value },
+          CONTAINS => ->(other_value, self_value) { (other_value || false) && other_value.include?(self_value) },
 
-          NOT_CONTAINS => ->(other_value, self_value) { !other_value.include? self_value },
-          REGEX => ->(other_value, self_value) { other_value.match? self_value }
+          NOT_CONTAINS => ->(other_value, self_value) { (other_value || false) && !other_value.include?(self_value) },
+          REGEX => ->(other_value, self_value) { (other_value || false) && other_value.match?(self_value) }
         }.freeze
 
         def initialize(operator:, value:, property: nil)

data/lib/flagsmith/sdk/config.rb

@@ -4,10 +4,13 @@ module Flagsmith
   # Config options shared around Engine
   class Config
     DEFAULT_API_URL = 'https://edge.api.flagsmith.com/api/v1/'
+    DEFAULT_REALTIME_API_URL = 'https://realtime.flagsmith.com/'
+
     OPTIONS = %i[
       environment_key api_url custom_headers request_timeout_seconds enable_local_evaluation
       environment_refresh_interval_seconds retries enable_analytics default_flag_handler
-      offline_mode offline_handler polling_manager_failure_limit logger
+      offline_mode offline_handler polling_manager_failure_limit
+      realtime_api_url enable_realtime_updates logger
     ].freeze
 
     # Available Configs
@@ -40,6 +43,9 @@ module Flagsmith
     #                                            the entire environment, project, flags, etc.
     #   +polling_manager_failure_limit+        - An integer to control how long to suppress errors in
     #                                            the polling manager for local evaluation mode.
+    #   +realtime_api_url+                     - Override the realtime api URL to communicate with a
+    #                                            non-standard realtime endpoint.
+    #   +enable_realtime_updates+              - A boolean to enable realtime updates.
     #   +logger+                               - Pass your logger, default is Logger.new($stdout)
     #
     attr_reader(*OPTIONS)
@@ -62,6 +68,10 @@ module Flagsmith
       @offline_mode
     end
 
+    def realtime_mode?
+      @enable_realtime_updates
+    end
+
     def environment_flags_url
       'flags/'
     end
@@ -92,6 +102,9 @@ module Flagsmith
       @offline_mode = opts.fetch(:offline_mode, false)
       @offline_handler = opts[:offline_handler]
       @polling_manager_failure_limit = opts.fetch(:polling_manager_failure_limit, 10)
+      @realtime_api_url = opts.fetch(:realtime_api_url, Flagsmith::Config::DEFAULT_REALTIME_API_URL)
+      @realtime_api_url << '/' unless @realtime_api_url.end_with? '/'
+      @enable_realtime_updates = opts.fetch(:enable_realtime_updates, false)
       @logger = options.fetch(:logger, Logger.new($stdout).tap { |l| l.level = :debug })
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

data/lib/flagsmith/sdk/models/flags.rb

@@ -71,7 +71,7 @@ module Flagsmith
         def from_api(json_flag_data)
           new(
             enabled: json_flag_data[:enabled],
-            value: json_flag_data[:feature_state_value] || json_flag_data[:value],
+            value: json_flag_data.fetch(:feature_state_value) { json_flag_data[:value] },
             feature_name: json_flag_data.dig(:feature, :name),
             feature_id: json_flag_data.dig(:feature, :id)
           )

data/lib/flagsmith/sdk/realtime_client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'faraday'
+require 'json'
+
+module Flagsmith
+  # Ruby client for realtime access to flagsmith.com
+  class RealtimeClient
+    attr_accessor :running
+
+    def initialize(config)
+      @config = config
+      @thread = nil
+      @running = false
+      @main = nil
+    end
+
+    def endpoint
+      "#{@config.realtime_api_url}sse/environments/#{@main.environment.api_key}/stream"
+    end
+
+    def listen(main, remaining_attempts: Float::INFINITY, retry_interval: 0.5) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+      last_updated_at = 0
+      @main = main
+      @running = true
+      @thread = Thread.new do
+        while @running && remaining_attempts.positive?
+          remaining_attempts -= 1
+          @config.logger.warn 'Beginning to pull down realtime endpoint'
+          begin
+            sleep retry_interval
+            # Open connection to SSE endpoint
+            Faraday.new(url: endpoint).get do |req|
+              req.options.timeout = nil # Keep connection alive indefinitely
+              req.options.open_timeout = 10
+            end.body.each_line do |line| # rubocop:disable Style/MultilineBlockChain
+              # SSE protocol: Skip non-event lines
+              next if line.strip.empty? || line.start_with?(':')
+
+              # Parse SSE fields
+              next unless line.start_with?('data: ')
+
+              data = JSON.parse(line[6..].strip)
+              updated_at = data['updated_at']
+              next unless updated_at > last_updated_at
+
+              @config.logger.info "Realtime updating environment from #{last_updated_at} to #{updated_at}"
+              @main.update_environment
+              last_updated_at = updated_at
+            end
+          rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
+            @config.logger.warn "Connection failed: #{e.message}. Retrying in #{retry_interval} seconds..."
+          rescue StandardError => e
+            @config.logger.error "Error: #{e.message}. Retrying in #{retry_interval} seconds..."
+          end
+        end
+      end
+
+      @running = false
+    end
+  end
+end

data/lib/flagsmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flagsmith
-  VERSION = '4.1.1'
+  VERSION = '4.3.0'
 end

data/lib/flagsmith.rb

@@ -16,6 +16,7 @@ require 'flagsmith/sdk/pooling_manager'
 require 'flagsmith/sdk/models/flags'
 require 'flagsmith/sdk/models/segments'
 require 'flagsmith/sdk/offline_handlers'
+require 'flagsmith/sdk/realtime_client'
 
 require 'flagsmith/engine/core'
 
@@ -46,6 +47,7 @@ module Flagsmith
     # :environment_key, :api_url, :custom_headers, :request_timeout_seconds, :enable_local_evaluation,
     # :environment_refresh_interval_seconds, :retries, :enable_analytics, :default_flag_handler,
     # :offline_mode, :offline_handler, :polling_manager_failure_limit
+    # :realtime_api_url, :enable_realtime_updates, :logger
     #
     # You can see full description in the Flagsmith::Config
 
@@ -59,6 +61,7 @@ module Flagsmith
       @identity_overrides_by_identifier = {}
 
       validate_offline_mode!
+      validate_realtime_mode!
 
       api_client
       analytics_processor
@@ -78,10 +81,21 @@ module Flagsmith
             'Cannot use offline_handler and default_flag_handler at the same time.'
     end
 
+    def validate_realtime_mode!
+      return unless @config.realtime_mode? && !@config.local_evaluation?
+
+      raise Flagsmith::ClientError,
+            'The enable_realtime_updates config param requires a matching enable_local_evaluation param.'
+    end
+
     def api_client
       @api_client ||= Flagsmith::ApiClient.new(@config)
     end
 
+    def realtime_client
+      @realtime_client ||= Flagsmith::RealtimeClient.new(@config)
+    end
+
     def engine
       @engine ||= Flagsmith::Engine::Engine.new
     end
@@ -104,6 +118,14 @@ module Flagsmith
     def environment_data_polling_manager
       return nil unless @config.local_evaluation?
 
+      # Bypass the environment data polling manager if realtime
+      # is present in the configuration.
+      if @config.realtime_mode?
+        update_environment
+        realtime_client.listen self unless realtime_client.running
+        return
+      end
+
       update_environment if @environment_data_polling_manager.nil?
 
       @environment_data_polling_manager ||= Flagsmith::EnvironmentDataPollingManager.new(
@@ -148,11 +170,13 @@ module Flagsmith
     # environment, e.g. email address, username, uuid
     # traits { key => value } is a dictionary of traits to add / update on the identity in
     # Flagsmith, e.g. { "num_orders": 10 }
+    # in lieu of a trait value, a trait coniguration dictionary can be provided,
+    # e.g. { "num_orders": { "value": 10, "transient": true } }
     # returns Flags object holding all the flags for the given identity.
-    def get_identity_flags(identifier, **traits)
+    def get_identity_flags(identifier, transient = false, **traits) # rubocop:disable Style/OptionalBooleanParameter
       return get_identity_flags_from_document(identifier, traits) if environment
 
-      get_identity_flags_from_api(identifier, traits)
+      get_identity_flags_from_api(identifier, traits, transient)
     end
 
     def feature_enabled?(feature_name, default: false)
@@ -253,16 +277,16 @@ module Flagsmith
     end
 
     # rubocop:disable Metrics/MethodLength
-    def get_identity_flags_from_api(identifier, traits = {})
+    def get_identity_flags_from_api(identifier, traits, transient)
       if offline_handler
         begin
-          process_identity_flags_from_api(identifier, traits)
+          process_identity_flags_from_api(identifier, traits, transient)
         rescue StandardError
           get_identity_flags_from_document(identifier, traits)
         end
       else
         begin
-          process_identity_flags_from_api(identifier, traits)
+          process_identity_flags_from_api(identifier, traits, transient)
         rescue StandardError
           if default_flag_handler
             return Flagsmith::Flags::Collection.new(
@@ -276,8 +300,8 @@ module Flagsmith
     end
     # rubocop:enable Metrics/MethodLength
 
-    def process_identity_flags_from_api(identifier, traits = {})
-      data = generate_identities_data(identifier, traits)
+    def process_identity_flags_from_api(identifier, traits, transient)
+      data = generate_identities_data(identifier, traits, transient)
       json_response = api_client.post(@config.identities_url, data.to_json).body
 
       Flagsmith::Flags::Collection.from_api(
@@ -311,10 +335,13 @@ module Flagsmith
     end
     # rubocop:enable Metrics/MethodLength
 
-    def generate_identities_data(identifier, traits = {})
+    def generate_identities_data(identifier, traits, transient)
       {
         identifier: identifier,
-        traits: traits.map { |key, value| { trait_key: key, trait_value: value } }
+        transient: transient,
+        traits: traits.map do |key, value|
+          value.is_a?(Hash) ? { trait_key: key, trait_value: value[:value], transient: value[:transient] || false } : { trait_key: key, trait_value: value }
+        end
       }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flagsmith
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Tom Stuart
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -193,6 +193,7 @@ files:
 - lib/flagsmith/sdk/models/segments.rb
 - lib/flagsmith/sdk/offline_handlers.rb
 - lib/flagsmith/sdk/pooling_manager.rb
+- lib/flagsmith/sdk/realtime_client.rb
 - lib/flagsmith/version.rb
 homepage: https://flagsmith.com
 licenses: []