sbmt-strangler 0.9.1 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bb8754c88d1b03e5d4a32bc244c6e14351d0e875dfd12bbf9011cb08c450ce
-  data.tar.gz: 3ac98da59470beb7f2d023352072bc589867e5af9d2160d07a805529577e7482
+  metadata.gz: fb3b0530db252f7ac57631610a89b1f9750942275cba851f6d7fdb4ed2e2b825
+  data.tar.gz: 7478e5f4f6363858378ee48ad7eee94271133611f19351336885cec31d581928
 SHA512:
-  metadata.gz: e1d13adacfa0630878515a07ae6619ddd23d2182a1fb17183be233ef7c10e0552c8917404d9728961e2fc14d0aa68131c328245b111465a56370a6d8e3d87086
-  data.tar.gz: 405bf3d3146936259e97aeb52f6d0a5065d5080be4891b9cff97463fde3df32a6d998a5b1b023b630b1e1fc4c35dc353384dfcf09431f9549d7e641cd065ef69
+  metadata.gz: ce4c1ffc70a7286300e776e01dba508231c7dfac722d0f833eae264a68921f01d21a36d1031e507410c47642fd573912b9afc5cba16bce008c48644b0286ef29
+  data.tar.gz: 88236ec2185c89cc6eb8cbe1672439b6d4cf8ef617f0a098ed449470400378c58a753763f6653b768a8115f72f73fc542d26a26faf5475eef86fb6c6edae87ad

data/Appraisals

@@ -4,7 +4,8 @@
 
 versions_map = {
   "7.0" => %w[3.1],
-  "7.1" => %w[3.2 3.3]
+  "7.1" => %w[3.2 3.3],
+  "8.0" => %w[3.2 3.3]
 }
 
 current_ruby_version = RUBY_VERSION.split(".").first(2).join(".")

data/CHANGELOG.md

@@ -5,6 +5,37 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.14.1] - 2026-03-16
+
+### Fixed
+- Use `params_tracking_allowlist` directly without permitting
+
+## [0.14.0] - 2025-06-05
+
+### Changed
+- Support Rails v8
+
+## [0.11.0] - 2024-09-08
+
+### Changed
+- `compose` receives two parameters now - `responses` and `rails_controller`
+
+## [0.10.1] - 2024-09-02
+
+### Fixed
+- Use `Rails.application.executor.wrap` for application code running inside new thread
+
+## [0.10.0] - 2024-08-05
+
+### Added
+- Add composition mode
+
+## [0.9.2] - 2024-07-12
+
+### Changed
+- Now ONTIME flipper flags can work with any hours range
+- Now hours range don't include last value to work
+
 ## [0.9.1] - 2024-07-02
 
 ### Added

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source ENV.fetch("NEXUS_PUBLIC_SOURCE_URL", "https://rubygems.org")
 
 gemspec

data/config/initializers/yabeda.rb

@@ -4,7 +4,9 @@ module Sbmt
   module Strangler
     module Metrics
       module Yabeda
-        HTTP_BUCKETS = [0.01, 0.02, 0.04, 0.1, 0.2, 0.5, 0.8, 1, 1.5, 2, 5, 15, 30, 60].freeze
+        DEFAULT_BUCKETS = [0.01, 0.02, 0.04, 0.1, 0.2, 0.5, 0.8, 1, 1.5, 2, 5, 15, 30, 60].freeze
+        HTTP_BUCKETS = DEFAULT_BUCKETS
+        COMPOSITION_BUCKETS = DEFAULT_BUCKETS
 
         ::Yabeda.configure do
           group :sbmt_strangler do
@@ -38,3 +40,27 @@ module Sbmt
     end
   end
 end
+
+# Declaring composition step duration metric in an `after_initialize` block
+# allows user to customize buckets in his app-level configuration file:
+#
+#     # config/initializers/strangler.rb
+#     Sbmt::Strangler.configure do |strangler|
+#       strangler.composition_step_duration_metric_buckets = [0.1, 0.2, 0.3]
+#     end
+#
+Rails.application.config.after_initialize do
+  ::Yabeda.configure do
+    group :sbmt_strangler do
+      composition_buckets =
+        ::Sbmt::Strangler.configuration.composition_step_duration_metric_buckets ||
+        ::Sbmt::Strangler::Metrics::Yabeda::COMPOSITION_BUCKETS
+
+      histogram :composition_step_duration,
+        tags: %i[step part type level parent controller action],
+        unit: :seconds,
+        buckets: composition_buckets,
+        comment: "Composition step duration"
+    end
+  end
+end

data/dip.yml

@@ -48,6 +48,8 @@ interaction:
         command: bundle exec appraisal rails-7.0 rspec
       rails-7.1:
         command: bundle exec appraisal rails-7.1 rspec
+      rails-8.0:
+        command: bundle exec appraisal rails-8.0 rspec
 
   rubocop:
     description: Run Ruby linter

data/lib/sbmt/strangler/action/composition/errors/configuration_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Strangler
+    class Action
+      module Composition
+        module Errors
+          class ConfigurationError < StandardError; end
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/action/composition/errors/max_level_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Strangler
+    class Action
+      module Composition
+        module Errors
+          class MaxLevelError < StandardError; end
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/action/composition/metrics.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Strangler
+    class Action
+      module Composition
+        module Metrics
+          private
+
+          def with_metrics(rails_controller:, part: nil)
+            result = nil
+            with_yabeda_duration_measurement(rails_controller: rails_controller, part: part) do
+              with_open_telemetry_tracing(part: part) do
+                result = yield
+              end
+            end
+            result
+          end
+
+          def with_yabeda_duration_measurement(rails_controller:, part: nil)
+            result = nil
+            yabeda_tags = {
+              step: name.to_s,
+              part: part&.to_s,
+              type: type.to_s,
+              level: level.to_s,
+              parent: parent&.name&.to_s,
+              controller: rails_controller.controller_path,
+              action: rails_controller.action_name
+            }
+            Yabeda.sbmt_strangler.composition_step_duration.measure(yabeda_tags) do
+              result = yield
+            end
+            result
+          end
+
+          def with_open_telemetry_tracing(part: nil)
+            return yield unless Object.const_defined?(:OpenTelemetry)
+
+            span_name = "Composition step: #{name} (#{type})"
+            span_name += " / #{part}" unless part.nil?
+
+            span_attrs = {
+              "step" => name.to_s,
+              "type" => type.to_s,
+              "level" => level
+            }
+            span_attrs["part"] = part.to_s unless part.nil?
+            span_attrs["parent"] = parent.name.to_s unless parent.nil?
+
+            result = nil
+            ::OpenTelemetry.tracer_provider.tracer("Sbmt::Strangler")
+              .in_span(span_name, attributes: span_attrs, kind: :internal) do |_span|
+                result = yield
+              end
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/action/composition/step.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative "metrics"
+require_relative "errors/configuration_error"
+require_relative "errors/max_level_error"
+
+module Sbmt
+  module Strangler
+    class Action
+      module Composition
+        class Step
+          include Metrics
+
+          TYPES = %i[sync async].freeze
+          MAX_LEVEL = 2
+
+          attr_reader :name, :type, :level, :parent
+
+          def initialize(name:, type: :sync, level: 0, parent: nil)
+            if name.nil? || name.to_s == ""
+              raise Errors::ConfigurationError, "Composition step name must be a non-empty string or symbol"
+            end
+
+            if TYPES.exclude?(type)
+              raise Errors::ConfigurationError, "Composition step type must be a symbol from #{TYPES}"
+            end
+
+            if !parent.nil? && !parent.is_a?(self.class)
+              raise Errors::ConfigurationError, "Composition step parent must be either #{self.class} or nil"
+            end
+
+            if !level.is_a?(Integer) && level >= 0
+              raise Errors::ConfigurationError, "Composition step level must be a non-negative integer"
+            end
+
+            if level > MAX_LEVEL
+              raise Errors::MaxLevelError, "Composition step is too deeply nested"
+            end
+
+            @name = name
+            @type = type
+            @level = level
+            @parent = parent
+            @sync_steps = {}
+            @async_steps = {}
+          end
+
+          def call(rails_controller, previous_responses: {})
+            with_metrics(rails_controller: rails_controller) do
+              result = begin
+                with_metrics(part: :process, rails_controller: rails_controller) do
+                  process_lambda.call(rails_controller, previous_responses)
+                end
+              rescue => error
+                handle_error(error)
+
+                {} # TODO: Better error handling in composition.
+              end
+
+              # process composition if there are nested steps
+              if composite?
+                result = call_composition(rails_controller, previous_responses: previous_responses.merge(name => result))
+              end
+
+              result
+            end
+          end
+
+          def composite?
+            @sync_steps.any? || @async_steps.any?
+          end
+
+          def sync(name, &)
+            if @async_steps.key?(name)
+              raise Errors::ConfigurationError, "Composition step #{name.inspect} has been already defined as async"
+            end
+
+            @sync_steps[name] ||=
+              Sbmt::Strangler::Action::Composition::Step.new(
+                name: name,
+                type: :sync,
+                parent: self,
+                level: level + 1
+              )
+            yield(@sync_steps[name]) if block_given?
+            self
+          end
+
+          def async(name, &)
+            if @sync_steps.key?(name)
+              raise Errors::ConfigurationError, "Composition step #{name.inspect} has been already defined as sync"
+            end
+
+            @async_steps[name] ||=
+              Sbmt::Strangler::Action::Composition::Step.new(
+                name: name,
+                type: :async,
+                parent: self,
+                level: level + 1
+              )
+            yield(@async_steps[name]) if block_given?
+            self
+          end
+
+          def process(&block)
+            @process_lambda = block
+            self
+          end
+
+          def compose(&block)
+            @compose_lambda = block
+            self
+          end
+
+          private
+
+          attr_reader :sync_steps, :async_steps, :process_lambda, :compose_lambda
+
+          def call_composition(rails_controller, previous_responses: {})
+            responses = nil
+
+            with_metrics(part: :substeps, rails_controller: rails_controller) do
+              async_responses = async_steps.map do |name, step|
+                Concurrent::Promises.future do
+                  Rails.application.executor.wrap do
+                    result = step.call(rails_controller, previous_responses: previous_responses)
+                    {name => result}
+                  end
+                end
+              end
+
+              sync_responses = sync_steps.reduce(previous_responses) do |result, (name, step)|
+                result.merge(name => step.call(rails_controller, previous_responses: result))
+              end
+
+              responses = async_responses.map(&:value).reduce(sync_responses) do |result, step_result|
+                result.merge(step_result)
+              end
+            end
+
+            with_metrics(part: :compose, rails_controller: rails_controller) do
+              compose_lambda.call(responses, rails_controller)
+            end
+          rescue => error
+            handle_error(error)
+
+            {} # TODO: Better error handling in composition.
+          end
+
+          def handle_error(error)
+            Sbmt::Strangler.logger.error(error.message)
+            Sbmt::Strangler.error_tracker.error(error)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/strangler/action.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "action/composition/step"
+
 module Sbmt
   module Strangler
     class Action
@@ -32,6 +34,18 @@ module Sbmt
       def http_client
         @http_client ||= Sbmt::Strangler::Http::Client.new(http_options: http)
       end
+
+      def composition(&)
+        if block_given?
+          @composition ||= Composition::Step.new(name: :root)
+          yield(@composition)
+        end
+        @composition
+      end
+
+      def composition?
+        !composition.nil?
+      end
     end
   end
 end

data/lib/sbmt/strangler/configuration.rb

@@ -9,6 +9,7 @@ module Sbmt
       option :action_controller_base_class, default: "ActionController::Base"
       option :error_tracker, default: "Sbmt::Strangler::ErrorTracker"
       option :flipper_actor, default: ->(_http_params, _headers) {}
+      option :composition_step_duration_metric_buckets, default: nil
 
       attr_reader :controllers, :http
 

data/lib/sbmt/strangler/flipper.rb

@@ -30,7 +30,13 @@ module Sbmt
               .compact
 
           hour_now = DateTime.now.in_time_zone.hour
-          hours_ranges.any? { |range| (range.first..range.last).cover?(hour_now) }
+          hours_ranges.any? do |range|
+            return (range.first...range.last).cover?(hour_now) if range.last > range.first
+
+            range_last = range.last + 24
+            (range.first...range_last).cover?(hour_now + 24) ||
+              (range.first...range_last).cover?(hour_now)
+          end
         end
       end
     end

data/lib/sbmt/strangler/metric_tracker.rb

@@ -14,7 +14,7 @@ module Sbmt
       end
 
       def log_unallowed_params
-        unallowed_params = all_request_params - allowed_request_params
+        unallowed_params = all_request_params_keys - allowed_request_params_keys
         Sbmt::Strangler.logger.log_warn(<<~WARN.strip) if unallowed_params.any?
           Not allowed parameters in #{controller_path}##{action_name}: #{unallowed_params}
         WARN
@@ -47,21 +47,25 @@ module Sbmt
 
       private
 
-      delegate :http_params, :allowed_params, :controller_path, :action_name, to: :rails_controller
+      delegate :http_params, :strangler_action, :controller_path, :action_name, to: :rails_controller
 
       def common_tags
         {
-          params: allowed_request_params.join(","),
+          params: allowed_request_params_keys.join(","),
           controller: controller_path,
           action: action_name
         }
       end
 
-      def allowed_request_params
-        @allowed_request_params ||= allowed_params.keys.map(&:to_s).sort.uniq
+      def allowed_request_params_keys
+        @allowed_request_params ||= if strangler_action.params_tracking_allowlist.blank?
+          all_request_params_keys
+        else
+          (all_request_params_keys & strangler_action.params_tracking_allowlist).sort
+        end
       end
 
-      def all_request_params
+      def all_request_params_keys
         @all_request_params ||= http_params.keys.map(&:to_s).sort.uniq
       end
     end

data/lib/sbmt/strangler/mixin.rb

@@ -9,12 +9,6 @@ module Sbmt
         params.to_unsafe_h.except(:action, :controller, :format)
       end
 
-      def allowed_params
-        return http_params if strangler_action.params_tracking_allowlist.blank?
-
-        params.permit(*strangler_action.params_tracking_allowlist).to_h
-      end
-
       def allowed_headers
         if strangler_action.headers_allowlist.blank?
           return request.headers.select { |name, _| name.starts_with?("HTTP_") }.to_h

data/lib/sbmt/strangler/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module Strangler
-    VERSION = "0.9.1"
+    VERSION = "0.14.1"
   end
 end

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

@@ -9,8 +9,17 @@ module Sbmt
         include Dry::Monads::Result::Mixin
 
         def call
-          mirror_task = Concurrent::Promises.future { mirror_call }
-          proxy_task = Concurrent::Promises.future { http_request(http_params) }
+          mirror_task = Concurrent::Promises.future do
+            Rails.application.executor.wrap do
+              mirror_call
+            end
+          end
+
+          proxy_task = Concurrent::Promises.future do
+            Rails.application.executor.wrap do
+              http_request(http_params)
+            end
+          end
 
           mirror_call_result = mirror_task.value!
           origin_response = proxy_task.value!
@@ -45,7 +54,12 @@ module Sbmt
         end
 
         def mirror_call
-          value = strangler_action.mirror.call(rails_controller)
+          value = if strangler_action.composition?
+            strangler_action.composition.call(rails_controller)
+          else
+            strangler_action.mirror.call(rails_controller)
+          end
+
           Success(value)
         rescue => err
           handle_error(err)

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

@@ -40,7 +40,12 @@ module Sbmt
         delegate :track_mirror_call, :track_render_call, to: :metric_tracker
 
         def mirror_call
-          value = strangler_action.mirror.call(rails_controller)
+          value = if strangler_action.composition?
+            strangler_action.composition.call(rails_controller)
+          else
+            strangler_action.mirror.call(rails_controller)
+          end
+
           Success(value)
         rescue => err
           handle_error(err)

data/sbmt-strangler.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   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["allowed_push_host"] = ENV.fetch("NEXUS_URL", "https://rubygems.org")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   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 "rails", ">= 6.1", "< 8.1"
   spec.add_dependency "yabeda", ">= 0.11"
   spec.add_dependency "flipper", ">= 1.2.2"
   spec.add_dependency "concurrent-ruby", ">= 1.2.3"
@@ -54,6 +54,6 @@ Gem::Specification.new do |spec|
   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 "sentry-rails", "> 6.0.0"
   spec.add_development_dependency "debug"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-strangler
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.14.1
 platform: ruby
 authors:
 - sbermarket team
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,7 +60,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +70,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
@@ -372,14 +371,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -395,7 +394,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Utility for strangler pattern
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -420,6 +418,10 @@ files:
 - lefthook.yml
 - lib/sbmt/strangler.rb
 - lib/sbmt/strangler/action.rb
+- lib/sbmt/strangler/action/composition/errors/configuration_error.rb
+- lib/sbmt/strangler/action/composition/errors/max_level_error.rb
+- lib/sbmt/strangler/action/composition/metrics.rb
+- lib/sbmt/strangler/action/composition/step.rb
 - lib/sbmt/strangler/action_invoker.rb
 - lib/sbmt/strangler/builder.rb
 - lib/sbmt/strangler/configurable.rb
@@ -451,7 +453,6 @@ metadata:
   source_code_uri: https://github.com/SberMarket-Tech/sbmt-strangler
   changelog_uri: https://github.com/SberMarket-Tech/sbmt-strangler/-/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'false'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -466,8 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Utility for strangler pattern
 test_files: []