sbmt-strangler 0.9.1

data/lib/sbmt/strangler/work_modes/mirror.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sbmt
+  module Strangler
+    module WorkModes
+      class Mirror < Base
+        include Dry::Monads::Result::Mixin
+
+        def call
+          mirror_task = Concurrent::Promises.future { mirror_call }
+          proxy_task = Concurrent::Promises.future { http_request(http_params) }
+
+          mirror_call_result = mirror_task.value!
+          origin_response = proxy_task.value!
+
+          begin
+            track_mirror_call(mirror_call_result.success?)
+            if mirror_call_result.success?
+              mirror_result = mirror_call_result.value!
+              origin_result = copy_of_origin_result(origin_response)
+              compare_call_result = compare_call(origin_result, mirror_result)
+              track_compare_call(compare_call_result.success?)
+              track_compare_call_result(compare_call_result.value!) if compare_call_result.success?
+            end
+          rescue => err
+            handle_error(err)
+          end
+
+          render_origin_response(origin_response)
+        end
+
+        private
+
+        delegate :http_params, :http_request, :render_origin_response, to: :rails_controller
+        delegate :track_mirror_call, :track_compare_call, :track_compare_call_result, to: :metric_tracker
+
+        def copy_of_origin_result(origin_response)
+          if origin_response.success?
+            origin_response.value!.deep_dup
+          else
+            origin_response.failure.deep_dup
+          end
+        end
+
+        def mirror_call
+          value = strangler_action.mirror.call(rails_controller)
+          Success(value)
+        rescue => err
+          handle_error(err)
+          Failure(nil)
+        end
+
+        MATCH_ERROR = :error
+
+        def compare_call(origin_result, mirror_result)
+          cmp = strangler_action.compare.call(origin_result, mirror_result)
+          raise "Strangler action compare lambda must return a boolean value instead of #{cmp}!" unless cmp.in?([true, false])
+          Success(cmp)
+        rescue => err
+          handle_error(err)
+          Failure(nil)
+        end
+
+        def handle_error(err)
+          Sbmt::Strangler.error_tracker.error(err)
+          Sbmt::Strangler.logger.error(err)
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/work_modes/proxy.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sbmt
+  module Strangler
+    module WorkModes
+      class Proxy < Base
+        def call
+          origin_response = http_request(http_params)
+          render_origin_response(origin_response)
+        end
+
+        private
+
+        delegate :http_params, :http_request, :render_origin_response, to: :rails_controller
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/work_modes/replace.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Sbmt
+  module Strangler
+    module WorkModes
+      class Replace < Base
+        include Dry::Monads::Result::Mixin
+
+        def call
+          mirror_call_result = mirror_call
+          track_mirror_call(mirror_call_result.success?)
+
+          unless mirror_call_result.success?
+            render(
+              json: {error: "Mirror lambda call failed!"},
+              status: :internal_server_error
+            ) # TODO: Возможно стоит сделать фолбэк на проксирование?
+            return
+          end
+
+          render_call_result = render_call(mirror_call_result.value!)
+          track_render_call(render_call_result.success?)
+
+          unless render_call_result.success?
+            render(
+              json: {error: "Render lambda call failed!"},
+              status: :internal_server_error
+            ) # TODO: Возможно стоит сделать фолбэк на проксирование?
+            return
+          end
+
+          render render_call_result.value!
+        end
+
+        private
+
+        delegate :render, to: :rails_controller
+        delegate :track_mirror_call, :track_render_call, to: :metric_tracker
+
+        def mirror_call
+          value = strangler_action.mirror.call(rails_controller)
+          Success(value)
+        rescue => err
+          handle_error(err)
+          Failure(nil)
+        end
+
+        def render_call(mirror_result)
+          value = strangler_action.render.call(mirror_result)
+          Success(value)
+        rescue => err
+          handle_error(err)
+          Failure(nil)
+        end
+
+        def handle_error(err)
+          Sbmt::Strangler.error_tracker.error(err)
+          Sbmt::Strangler.logger.error(err)
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "rails"
+require "dry-monads"
+require "yabeda"
+require "faraday"
+require "faraday/net_http_persistent"
+require "flipper"
+require "concurrent"
+require "securerandom"
+require "oj"
+
+begin
+  require "sentry-rails"
+rescue LoadError
+  # optional dependency
+end
+
+begin
+  require "opentelemetry-instrumentation-concurrent_ruby"
+rescue LoadError
+  Warning.warn <<~WARN if Object.const_defined?(:Opentelemetry)
+    WARNING! It looks like you're using OpenTelemetry but you didn't install an instrumentation for the concurrent-ruby gem.
+    sbmt-strangler runs your code using concurrent-ruby futures in mirror mode, so this is very adviced to install
+    the instrumentation (opentelemetry-instrumentation-concurrent_ruby gem) to get traces in mirror mode!
+  WARN
+end
+
+require_relative "strangler/configurable"
+require_relative "strangler/http"
+require_relative "strangler/action"
+require_relative "strangler/controller"
+require_relative "strangler/configuration"
+require_relative "strangler/mixin"
+require_relative "strangler/builder"
+require_relative "strangler/action_invoker"
+require_relative "strangler/const_definer"
+require_relative "strangler/errors"
+require_relative "strangler/error_tracker"
+require_relative "strangler/logger"
+require_relative "strangler/flipper"
+require_relative "strangler/feature_flags"
+require_relative "strangler/metric_tracker"
+require_relative "strangler/work_modes/proxy"
+require_relative "strangler/work_modes/mirror"
+require_relative "strangler/work_modes/replace"
+
+require_relative "strangler/engine"
+
+module Sbmt
+  module Strangler
+    module_function
+
+    # Public: Configure strangler.
+    #
+    #   Sbmt::Strangler.configure do |config|
+    #     config.controller(...) do |controller|
+    #       controller.action(...) do {...}
+    #     end
+    #   end
+    #
+    # Yields Sbmt::Strangler::Configuration instance.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Public: Returns Sbmt::Strangler::Configuration instance.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def action_controller_base_class
+      @action_controller_base_class ||= configuration.action_controller_base_class.constantize
+    end
+
+    def error_tracker
+      @error_tracker ||= configuration.error_tracker.constantize
+    end
+
+    def logger
+      @logger ||= Sbmt::Strangler::Logger.new
+    end
+  end
+end

data/sbmt-strangler.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "lib/sbmt/strangler/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sbmt-strangler"
+  spec.version = Sbmt::Strangler::VERSION
+  spec.authors = ["sbermarket team"]
+
+  spec.summary = "Utility for strangler pattern"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/SberMarket-Tech/sbmt-strangler"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/-/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "false" # rubocop:disable Gemspec/RequireMFA
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "> 2.0"
+  spec.add_dependency "faraday-net_http_persistent", "~> 2.0"
+  spec.add_dependency "net-http-persistent", ">= 4.0.1"
+  spec.add_dependency "rails", ">= 6.1", "< 8"
+  spec.add_dependency "yabeda", ">= 0.11"
+  spec.add_dependency "flipper", ">= 1.2.2"
+  spec.add_dependency "concurrent-ruby", ">= 1.2.3"
+  spec.add_dependency "oj"
+  spec.add_dependency "dry-monads"
+  spec.add_dependency "dry-struct"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rswag-specs"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "standard", ">= 1.7"
+  spec.add_development_dependency "zeitwerk"
+  spec.add_development_dependency "sentry-rails", "> 5.2.0"
+  spec.add_development_dependency "debug"
+end