data_shifter 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ebcb5560026f1fcfda0f56953e6a3e139d5fd831c5bb935f352b214c526a7c9
-  data.tar.gz: 7b8d142da33da3ead2adc2033a7ad6ab35b9d280da9b50704301d5f0ab093428
+  metadata.gz: 8f9ab924aaeb0638f2061907484bc7ba4f5e795a1ea58e96f1ae8b0a7542b150
+  data.tar.gz: 24a81ebe9a5e1f0d27d4cec1494fd26c4c8d1209ddca2aba6cd606dec14e4dda
 SHA512:
-  metadata.gz: f104c5879fc422025eb752313da24db5a56af3ba2494adf47e7247e49cdcf3ddbd0d91129dafde8a911580e72dc4ae4229b90f7ff081fbd1c2dee20716672959
-  data.tar.gz: df5cd362bbb77d66f6d555e5483471429ee1e2c9c089272d39a342ca0967e3de9165a482bc14d50618efc9061763fbac61faf6f14e16a44243a4cc8925aa76ea
+  metadata.gz: f5834ec7a2545de4342cc3f9205c8ce0f3a0b53fdfbebacd1452b7196c1b7cb606c4fa4d32e8e7d92532ff7e958f5537d2cba51e0176f9d760cdad9fa8b31498
+  data.tar.gz: cefd020aedd8a63f65f0bb507bcf8843a65fac12debfb78e47cd0e74b485e98746a8d3b805e0c2be6071254488308a1c10b47fb9e5280f13425d6eade6f4113d

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 * N/A
 
+## [0.3.3]
+
+* [Bugfix] Dry-run net guard now allows loopback hosts (`127.0.0.1`, `::1`, `localhost`) by default. Previously, any tracing/metrics sidecar listening on loopback (Datadog agent on 8126, statsd on 8125, OTLP collectors, etc.) would trip `WebMock::NetConnectNotAllowedError` from a background tracer thread and abort the rake task — even when the shift itself made no HTTP calls. Opt out with `DataShifter.config.allow_loopback_requests = false` for strict net blocking.
+
+## [0.3.2.1]
+
+* [Bugfix] Dry-run Sidekiq guard restores the previous `Sidekiq::Testing` mode (`fake!`, `inline!`, or `disable!`) instead of always calling `disable!`, which leaked global state and could leave later specs enqueueing work to real Redis.
+
 ## [0.3.2]
 
 * [Bugfix] Rake tasks exit quietly after a failed shift run when the shift already printed its failure summary; failures before that summary are still reported on stderr. Replaces rescuing only `Axn::Failure`, which missed most re-raised exceptions from `run!`.

data/README.md

@@ -111,10 +111,10 @@ In **dry run** mode, DataShifter automatically blocks or fakes these side effect
 
 | Service      | Behavior in dry run |
 |-------------|----------------------|
-| **HTTP**    | Blocked via WebMock (`disable_net_connect!`). Allow specific hosts with `allow_external_requests [...]` or `DataShifter.config.allow_external_requests`. |
+| **HTTP**    | Blocked via WebMock (`disable_net_connect!`). Loopback (`127.0.0.1`, `::1`, `localhost`) is allowed by default so tracing/metrics sidecars (Datadog agent, statsd, OTLP collector, etc.) keep working; opt out with `DataShifter.config.allow_loopback_requests = false`. Allow other hosts with `allow_external_requests [...]` or `DataShifter.config.allow_external_requests`. |
 | **ActionMailer** | `perform_deliveries = false` (restored after run). |
 | **ActiveJob**    | Queue adapter set to `:test` (restored after run). |
-| **Sidekiq**      | `Sidekiq::Testing.fake!` (restored with `disable!` after run). Only applied if `Sidekiq::Testing` is already loaded. |
+| **Sidekiq**      | `Sidekiq::Testing.fake!` for the run; previous mode (`fake!`, `inline!`, or `disable!`) is restored after. Only applied if `Sidekiq::Testing` is already loaded. |
 
 **Guarding other side effects:** For anything we don't cover (e.g. another service, or allowed HTTP that mutates), use e.g. `return if dry_run?` in your shift. DB changes are always rolled back in dry run; only non-DB side effects need this.
 
@@ -222,6 +222,11 @@ DataShifter.configure do |config|
   # Hosts allowed for HTTP during dry run only (no effect in commit mode)
   config.allow_external_requests = ["api.readonly.example.com"]
 
+  # Allow loopback HTTP (127.0.0.1, ::1, localhost) during dry runs (default: true).
+  # Needed so tracing/metrics sidecars (Datadog agent on 8126, statsd on 8125, OTLP
+  # collector, etc.) keep working in dry-run mode.
+  config.allow_loopback_requests = true
+
   # Suppress repeated log messages during a shift run (default: true)
   config.suppress_repeated_logs = true
 

data/lib/data_shifter/configuration.rb

@@ -16,6 +16,11 @@ module DataShifter
     # Has no effect in commit mode — HTTP is unrestricted when dry_run is false.
     attr_accessor :allow_external_requests
 
+    # Whether to allow loopback HTTP (127.0.0.1, ::1, localhost) during dry runs. Default: true.
+    # Loopback is rarely "external" and is needed for tracing/metrics sidecars (Datadog agent on
+    # 8126, statsd on 8125, OTLP collector, etc.). Set to false if you want strict net blocking.
+    attr_accessor :allow_loopback_requests
+
     # Whether to suppress repeated log messages during a shift run. Default: true.
     # Can be overridden per shift with `suppress_repeated_logs true/false`.
     attr_accessor :suppress_repeated_logs
@@ -33,6 +38,7 @@ module DataShifter
 
     def initialize
       @allow_external_requests = []
+      @allow_loopback_requests = true
       @suppress_repeated_logs = true
       @repeated_log_cap = 1000
       @progress_enabled = true

data/lib/data_shifter/internal/side_effect_guards.rb

@@ -12,8 +12,15 @@ module DataShifter
     #   production runs never load WebMock. On restore we revert to the previous state (enable!
     #   or disable!) so e.g. specs that had WebMock enabled are not left with it disabled.
     # - ActionMailer / ActiveJob / Sidekiq: no extra loading; we only toggle existing config
-    #   for the duration of the block and restore in ensure, so impact is scoped to the run.
+    #   for the duration of the block and restore in ensure (Sidekiq restores prior fake/inline/disable).
     module SideEffectGuards
+      # Loopback hosts allowed by default during dry-run net blocking (unless opted out via
+      # DataShifter.config.allow_loopback_requests = false). Localhost is by definition local —
+      # the guard's purpose is to prevent accidental *external* state mutations, not to fight
+      # tracing/metrics sidecars (Datadog agent on 8126, statsd on 8125, OTLP collector, etc.)
+      # which commonly listen on these hosts.
+      DEFAULT_LOOPBACK_HOSTS = %w[127.0.0.1 ::1 localhost].freeze
+
       class << self
         # Applies side-effect guards, yields, then restores. Call only when running in dry run.
         def with_guards(shift_class:, &block)
@@ -62,7 +69,8 @@ module DataShifter
         def allowed_net_hosts(shift_class)
           per_shift = shift_class.respond_to?(:_allow_external_requests) ? shift_class._allow_external_requests : []
           global = DataShifter.config.allow_external_requests
-          Array(per_shift) + Array(global)
+          loopback = DataShifter.config.allow_loopback_requests ? DEFAULT_LOOPBACK_HOSTS : []
+          Array(per_shift) + Array(global) + loopback
         end
 
         def webmock_net_connect_error
@@ -97,10 +105,23 @@ module DataShifter
         def apply_sidekiq(saved)
           return unless Sidekiq::Testing.respond_to?(:fake!)
 
+          saved[:sidekiq_testing_mode] = capture_sidekiq_testing_mode
           Sidekiq::Testing.fake!
           saved[:sidekiq] = true
         end
 
+        def capture_sidekiq_testing_mode
+          if Sidekiq::Testing.respond_to?(:__test_mode)
+            Sidekiq::Testing.__test_mode
+          elsif Sidekiq::Testing.fake?
+            :fake
+          elsif Sidekiq::Testing.inline?
+            :inline
+          else
+            :disable
+          end
+        end
+
         def restore_guards(saved)
           if saved.delete(:webmock)
             (saved.delete(:webmock_was_enabled) ? WebMock.enable! : WebMock.disable!)
@@ -112,7 +133,18 @@ module DataShifter
 
           return unless saved.delete(:sidekiq)
 
-          Sidekiq::Testing.disable!
+          restore_sidekiq_testing_mode(saved.delete(:sidekiq_testing_mode))
+        end
+
+        def restore_sidekiq_testing_mode(mode)
+          case mode
+          when :fake
+            Sidekiq::Testing.fake!
+          when :inline
+            Sidekiq::Testing.inline!
+          else
+            Sidekiq::Testing.disable!
+          end
         end
       end
     end

data/lib/data_shifter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DataShifter
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_shifter
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Kali Donovan