optimizely-sdk 5.0.0 → 5.0.1

data/lib/optimizely/odp/odp_manager.rb

@@ -1,159 +1,159 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2022, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-
-require 'optimizely/logger'
-require_relative '../helpers/constants'
-require_relative '../helpers/validator'
-require_relative '../exceptions'
-require_relative 'odp_config'
-require_relative 'lru_cache'
-require_relative 'odp_segment_manager'
-require_relative 'odp_event_manager'
-
-module Optimizely
-  class OdpManager
-    ODP_LOGS = Helpers::Constants::ODP_LOGS
-    ODP_MANAGER_CONFIG = Helpers::Constants::ODP_MANAGER_CONFIG
-    ODP_CONFIG_STATE = Helpers::Constants::ODP_CONFIG_STATE
-
-    # update_odp_config must be called to complete initialization
-    def initialize(
-      disable:,
-      segments_cache: nil,
-      segment_manager: nil,
-      event_manager: nil,
-      fetch_segments_timeout: nil,
-      odp_event_timeout: nil,
-      odp_flush_interval: nil,
-      logger: nil
-    )
-      @enabled = !disable
-      @segment_manager = segment_manager
-      @event_manager = event_manager
-      @logger = logger || NoOpLogger.new
-      @odp_config = OdpConfig.new
-
-      unless @enabled
-        @logger.log(Logger::INFO, ODP_LOGS[:ODP_NOT_ENABLED])
-        return
-      end
-
-      unless @segment_manager
-        segments_cache ||= LRUCache.new(
-          Helpers::Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_CAPACITY],
-          Helpers::Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_TIMEOUT_SECONDS]
-        )
-        @segment_manager = Optimizely::OdpSegmentManager.new(segments_cache, nil, @logger, timeout: fetch_segments_timeout)
-      end
-
-      @event_manager ||= Optimizely::OdpEventManager.new(logger: @logger, request_timeout: odp_event_timeout, flush_interval: odp_flush_interval)
-
-      @segment_manager.odp_config = @odp_config
-    end
-
-    def fetch_qualified_segments(user_id:, options:)
-      # Returns qualified segments for the user from the cache or the ODP server if not in the cache.
-      #
-      # @param user_id - The user id.
-      # @param options - An array of OptimizelySegmentOptions used to ignore and/or reset the cache.
-      #
-      # @return - Array of qualified segments or nil.
-      options ||= []
-      unless @enabled
-        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_NOT_ENABLED])
-        return nil
-      end
-
-      if @odp_config.odp_state == ODP_CONFIG_STATE[:UNDETERMINED]
-        @logger.log(Logger::ERROR, 'Cannot fetch segments before the datafile has loaded.')
-        return nil
-      end
-
-      @segment_manager.fetch_qualified_segments(ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID], user_id, options)
-    end
-
-    def identify_user(user_id:)
-      unless @enabled
-        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (ODP disabled).')
-        return
-      end
-
-      case @odp_config.odp_state
-      when ODP_CONFIG_STATE[:UNDETERMINED]
-        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (datafile not ready).')
-        return
-      when ODP_CONFIG_STATE[:NOT_INTEGRATED]
-        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (ODP not integrated).')
-        return
-      end
-
-      @event_manager.send_event(
-        type: ODP_MANAGER_CONFIG[:EVENT_TYPE],
-        action: 'identified',
-        identifiers: {ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID] => user_id},
-        data: {}
-      )
-    end
-
-    def send_event(type:, action:, identifiers:, data:)
-      # Send an event to the ODP server.
-      #
-      # @param type - the event type.
-      # @param action - the event action name.
-      # @param identifiers - a hash for identifiers.
-      # @param data - a hash for associated data. The default event data will be added to this data before sending to the ODP server.
-      unless @enabled
-        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_NOT_ENABLED])
-        return
-      end
-
-      unless Helpers::Validator.odp_data_types_valid?(data)
-        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_INVALID_DATA])
-        return
-      end
-
-      @event_manager.send_event(type: type, action: action, identifiers: identifiers, data: data)
-    end
-
-    def update_odp_config(api_key, api_host, segments_to_check)
-      # Update the odp config, reset the cache and send signal to the event processor to update its config.
-      # Start the event manager if odp is integrated.
-      return unless @enabled
-
-      config_changed = @odp_config.update(api_key, api_host, segments_to_check)
-      unless config_changed
-        @logger.log(Logger::DEBUG, 'Odp config was not changed.')
-        return
-      end
-
-      @segment_manager.reset
-
-      if @event_manager.running?
-        @event_manager.update_config
-      elsif @odp_config.odp_state == ODP_CONFIG_STATE[:INTEGRATED]
-        @event_manager.start!(@odp_config)
-      end
-    end
-
-    def stop!
-      return unless @enabled
-
-      @event_manager.stop!
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2022, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+require 'optimizely/logger'
+require_relative '../helpers/constants'
+require_relative '../helpers/validator'
+require_relative '../exceptions'
+require_relative 'odp_config'
+require_relative 'lru_cache'
+require_relative 'odp_segment_manager'
+require_relative 'odp_event_manager'
+
+module Optimizely
+  class OdpManager
+    ODP_LOGS = Helpers::Constants::ODP_LOGS
+    ODP_MANAGER_CONFIG = Helpers::Constants::ODP_MANAGER_CONFIG
+    ODP_CONFIG_STATE = Helpers::Constants::ODP_CONFIG_STATE
+
+    # update_odp_config must be called to complete initialization
+    def initialize(
+      disable:,
+      segments_cache: nil,
+      segment_manager: nil,
+      event_manager: nil,
+      fetch_segments_timeout: nil,
+      odp_event_timeout: nil,
+      odp_flush_interval: nil,
+      logger: nil
+    )
+      @enabled = !disable
+      @segment_manager = segment_manager
+      @event_manager = event_manager
+      @logger = logger || NoOpLogger.new
+      @odp_config = OdpConfig.new
+
+      unless @enabled
+        @logger.log(Logger::INFO, ODP_LOGS[:ODP_NOT_ENABLED])
+        return
+      end
+
+      unless @segment_manager
+        segments_cache ||= LRUCache.new(
+          Helpers::Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_CAPACITY],
+          Helpers::Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_TIMEOUT_SECONDS]
+        )
+        @segment_manager = Optimizely::OdpSegmentManager.new(segments_cache, nil, @logger, timeout: fetch_segments_timeout)
+      end
+
+      @event_manager ||= Optimizely::OdpEventManager.new(logger: @logger, request_timeout: odp_event_timeout, flush_interval: odp_flush_interval)
+
+      @segment_manager.odp_config = @odp_config
+    end
+
+    def fetch_qualified_segments(user_id:, options:)
+      # Returns qualified segments for the user from the cache or the ODP server if not in the cache.
+      #
+      # @param user_id - The user id.
+      # @param options - An array of OptimizelySegmentOptions used to ignore and/or reset the cache.
+      #
+      # @return - Array of qualified segments or nil.
+      options ||= []
+      unless @enabled
+        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_NOT_ENABLED])
+        return nil
+      end
+
+      if @odp_config.odp_state == ODP_CONFIG_STATE[:UNDETERMINED]
+        @logger.log(Logger::ERROR, 'Cannot fetch segments before the datafile has loaded.')
+        return nil
+      end
+
+      @segment_manager.fetch_qualified_segments(ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID], user_id, options)
+    end
+
+    def identify_user(user_id:)
+      unless @enabled
+        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (ODP disabled).')
+        return
+      end
+
+      case @odp_config.odp_state
+      when ODP_CONFIG_STATE[:UNDETERMINED]
+        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (datafile not ready).')
+        return
+      when ODP_CONFIG_STATE[:NOT_INTEGRATED]
+        @logger.log(Logger::DEBUG, 'ODP identify event is not dispatched (ODP not integrated).')
+        return
+      end
+
+      @event_manager.send_event(
+        type: ODP_MANAGER_CONFIG[:EVENT_TYPE],
+        action: 'identified',
+        identifiers: {ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID] => user_id},
+        data: {}
+      )
+    end
+
+    def send_event(type:, action:, identifiers:, data:)
+      # Send an event to the ODP server.
+      #
+      # @param type - the event type.
+      # @param action - the event action name.
+      # @param identifiers - a hash for identifiers.
+      # @param data - a hash for associated data. The default event data will be added to this data before sending to the ODP server.
+      unless @enabled
+        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_NOT_ENABLED])
+        return
+      end
+
+      unless Helpers::Validator.odp_data_types_valid?(data)
+        @logger.log(Logger::ERROR, ODP_LOGS[:ODP_INVALID_DATA])
+        return
+      end
+
+      @event_manager.send_event(type: type, action: action, identifiers: identifiers, data: data)
+    end
+
+    def update_odp_config(api_key, api_host, segments_to_check)
+      # Update the odp config, reset the cache and send signal to the event processor to update its config.
+      # Start the event manager if odp is integrated.
+      return unless @enabled
+
+      config_changed = @odp_config.update(api_key, api_host, segments_to_check)
+      unless config_changed
+        @logger.log(Logger::DEBUG, 'Odp config was not changed.')
+        return
+      end
+
+      @segment_manager.reset
+
+      if @event_manager.running?
+        @event_manager.update_config
+      elsif @odp_config.odp_state == ODP_CONFIG_STATE[:INTEGRATED]
+        @event_manager.start!(@odp_config)
+      end
+    end
+
+    def stop!
+      return unless @enabled
+
+      @event_manager.stop!
+    end
+  end
+end

data/lib/optimizely/odp/odp_segment_api_manager.rb

@@ -1,122 +1,122 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2022, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-
-require 'json'
-require_relative '../exceptions'
-
-module Optimizely
-  class OdpSegmentApiManager
-    # Interface that handles fetching audience segments.
-
-    def initialize(logger: nil, proxy_config: nil, timeout: nil)
-      @logger = logger || NoOpLogger.new
-      @proxy_config = proxy_config
-      @timeout = timeout || Optimizely::Helpers::Constants::ODP_GRAPHQL_API_CONFIG[:REQUEST_TIMEOUT]
-    end
-
-    # Fetch segments from the ODP GraphQL API.
-    #
-    # @param api_key - public api key
-    # @param api_host - domain url of the host
-    # @param user_key - vuid or fs_user_id (client device id or fullstack id)
-    # @param user_value - value of user_key
-    # @param segments_to_check - array of segments to check
-
-    def fetch_segments(api_key, api_host, user_key, user_value, segments_to_check)
-      url = "#{api_host}/v3/graphql"
-
-      headers = {'Content-Type' => 'application/json', 'x-api-key' => api_key.to_s}
-
-      payload = {
-        query: 'query($userId: String, $audiences: [String]) {' \
-               "customer(#{user_key}: $userId) " \
-               '{audiences(subset: $audiences) {edges {node {name state}}}}}',
-        variables: {
-          userId: user_value.to_s,
-          audiences: segments_to_check || []
-        }
-      }.to_json
-
-      begin
-        response = Helpers::HttpUtils.make_request(
-          url, :post, payload, headers, @timeout, @proxy_config
-        )
-      rescue SocketError, Timeout::Error, Net::ProtocolError, Errno::ECONNRESET => e
-        @logger.log(Logger::DEBUG, "GraphQL download failed: #{e}")
-        log_segments_failure('network error')
-        return nil
-      rescue Errno::EINVAL, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, HTTPUriError => e
-        log_segments_failure(e)
-        return nil
-      end
-
-      status = response.code.to_i
-      if status >= 400
-        log_segments_failure(status)
-        return nil
-      end
-
-      begin
-        response = JSON.parse(response.body)
-      rescue JSON::ParserError
-        log_segments_failure('JSON decode error')
-        return nil
-      end
-
-      if response.include?('errors')
-        error = response['errors'].first if response['errors'].is_a? Array
-        error_code = extract_component(error, 'extensions', 'code')
-        if error_code == 'INVALID_IDENTIFIER_EXCEPTION'
-          log_segments_failure('invalid identifier', Logger::WARN)
-        else
-          error_class = extract_component(error, 'extensions', 'classification') || 'decode error'
-          log_segments_failure(error_class)
-        end
-        return nil
-      end
-
-      audiences = extract_component(response, 'data', 'customer', 'audiences', 'edges')
-      unless audiences
-        log_segments_failure('decode error')
-        return nil
-      end
-
-      audiences.filter_map do |edge|
-        name = extract_component(edge, 'node', 'name')
-        state = extract_component(edge, 'node', 'state')
-        unless name && state
-          log_segments_failure('decode error')
-          return nil
-        end
-        state == 'qualified' ? name : nil
-      end
-    end
-
-    private
-
-    def log_segments_failure(message, level = Logger::ERROR)
-      @logger.log(level, format(Optimizely::Helpers::Constants::ODP_LOGS[:FETCH_SEGMENTS_FAILED], message))
-    end
-
-    def extract_component(hash, *components)
-      hash.dig(*components) if hash.is_a? Hash
-    rescue TypeError
-      nil
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2022, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+require 'json'
+require_relative '../exceptions'
+
+module Optimizely
+  class OdpSegmentApiManager
+    # Interface that handles fetching audience segments.
+
+    def initialize(logger: nil, proxy_config: nil, timeout: nil)
+      @logger = logger || NoOpLogger.new
+      @proxy_config = proxy_config
+      @timeout = timeout || Optimizely::Helpers::Constants::ODP_GRAPHQL_API_CONFIG[:REQUEST_TIMEOUT]
+    end
+
+    # Fetch segments from the ODP GraphQL API.
+    #
+    # @param api_key - public api key
+    # @param api_host - domain url of the host
+    # @param user_key - vuid or fs_user_id (client device id or fullstack id)
+    # @param user_value - value of user_key
+    # @param segments_to_check - array of segments to check
+
+    def fetch_segments(api_key, api_host, user_key, user_value, segments_to_check)
+      url = "#{api_host}/v3/graphql"
+
+      headers = {'Content-Type' => 'application/json', 'x-api-key' => api_key.to_s}
+
+      payload = {
+        query: 'query($userId: String, $audiences: [String]) {' \
+               "customer(#{user_key}: $userId) " \
+               '{audiences(subset: $audiences) {edges {node {name state}}}}}',
+        variables: {
+          userId: user_value.to_s,
+          audiences: segments_to_check || []
+        }
+      }.to_json
+
+      begin
+        response = Helpers::HttpUtils.make_request(
+          url, :post, payload, headers, @timeout, @proxy_config
+        )
+      rescue SocketError, Timeout::Error, Net::ProtocolError, Errno::ECONNRESET => e
+        @logger.log(Logger::DEBUG, "GraphQL download failed: #{e}")
+        log_segments_failure('network error')
+        return nil
+      rescue Errno::EINVAL, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, HTTPUriError => e
+        log_segments_failure(e)
+        return nil
+      end
+
+      status = response.code.to_i
+      if status >= 400
+        log_segments_failure(status)
+        return nil
+      end
+
+      begin
+        response = JSON.parse(response.body)
+      rescue JSON::ParserError
+        log_segments_failure('JSON decode error')
+        return nil
+      end
+
+      if response.include?('errors')
+        error = response['errors'].first if response['errors'].is_a? Array
+        error_code = extract_component(error, 'extensions', 'code')
+        if error_code == 'INVALID_IDENTIFIER_EXCEPTION'
+          log_segments_failure('invalid identifier', Logger::WARN)
+        else
+          error_class = extract_component(error, 'extensions', 'classification') || 'decode error'
+          log_segments_failure(error_class)
+        end
+        return nil
+      end
+
+      audiences = extract_component(response, 'data', 'customer', 'audiences', 'edges')
+      unless audiences
+        log_segments_failure('decode error')
+        return nil
+      end
+
+      audiences.filter_map do |edge|
+        name = extract_component(edge, 'node', 'name')
+        state = extract_component(edge, 'node', 'state')
+        unless name && state
+          log_segments_failure('decode error')
+          return nil
+        end
+        state == 'qualified' ? name : nil
+      end
+    end
+
+    private
+
+    def log_segments_failure(message, level = Logger::ERROR)
+      @logger.log(level, format(Optimizely::Helpers::Constants::ODP_LOGS[:FETCH_SEGMENTS_FAILED], message))
+    end
+
+    def extract_component(hash, *components)
+      hash.dig(*components) if hash.is_a? Hash
+    rescue TypeError
+      nil
+    end
+  end
+end