data_shifter 0.3.1 → 0.3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1568faec72d1ca39a77cc6fa884293bc0320a14d3451188cc3e64d93ac4084cd
-  data.tar.gz: fbc54ed6c02befcd7aef52b2f1d82b470144c52b1748db362ec6733be2fe0f42
+  metadata.gz: a2c27a241f01fd293278fdd45a9b8d5961d3a9ba304a95f657fd591ab5e2b4d6
+  data.tar.gz: 4db9925bd3e55bc8420bab92d9ed92a9e86e868ac0a1151f00b5245bace24319
 SHA512:
-  metadata.gz: e890c867409768503d140de8f4ab781d2caca51438b336aa954dced6991bd129d6930c25148e6553f63fa39168b247960e7fc304187802e84d17fa83eec10d44
-  data.tar.gz: 50fe503f813721a6c098081e6055aba2dca1980e0e593c979928a39e088e912d0af1ced7181220a9fed2531eed113b0b036bea436ce2d116131138f307062913
+  metadata.gz: 151626dbec0bae6d652a71cfcf814ccd79ee442211275dcfa4e62a8d0de04838376a6c67385826f3c4320126ef28d2ac37889e61d59b12f2d29a794296cc921d
+  data.tar.gz: 2a696741fbfde60b730cc29470b4c47063813cd2dd3995726961c1405283f32e38203659625c56316d5dd5d06abe3bb251ad455a96d298ec1f38129e558bb4e0

data/CHANGELOG.md

@@ -4,6 +4,15 @@
 
 * N/A
 
+## [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!`.
+* [Changed] Setup failures (load, constantize, etc.) print a short framed report on stderr with rake task, file path (relative to `Rails.root`), exception, and a Rails-cleaned backtrace (capped) instead of a full `Exception#full_message` dump.
+
 ## [0.3.1]
 
 * [Bugfix] No longer swallowing unexpected exceptions (errors in *loading* a data shift still need to be reported). No change to handling of exceptions raised while *running* a shift.

data/README.md

@@ -114,7 +114,7 @@ In **dry run** mode, DataShifter automatically blocks or fakes these side effect
 | **HTTP**    | Blocked via WebMock (`disable_net_connect!`). Allow specific 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.
 

data/Rakefile

@@ -4,9 +4,7 @@ require "bundler/gem_tasks"
 require "rubocop/rake_task"
 
 task :spec do
-  Dir.chdir("spec/dummy_app") do
-    sh "BUNDLE_GEMFILE=Gemfile bundle exec rspec spec/"
-  end
+  sh "bundle exec rspec"
 end
 
 RuboCop::RakeTask.new

data/lib/data_shifter/internal/rake_exception_reporting.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/isolated_execution_state"
+
+module DataShifter
+  module Internal
+    # Tracks whether Axn's on_error path already printed failure context (summary).
+    # Used by rake tasks to avoid duplicating setup failure output.
+    module RakeExceptionReporting
+      KEY = :data_shifter_rake_failure_summary_reported
+
+      module_function
+
+      def clear!
+        ActiveSupport::IsolatedExecutionState.delete(KEY)
+      end
+
+      def mark_failure_summary_reported!
+        ActiveSupport::IsolatedExecutionState[KEY] = true
+      end
+
+      def failure_summary_reported?
+        ActiveSupport::IsolatedExecutionState[KEY] == true
+      end
+    end
+  end
+end

data/lib/data_shifter/internal/rake_setup_output.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+require_relative "colors"
+
+module DataShifter
+  module Internal
+    # Formatted stderr output when a rake data:shift task fails before the shift summary (load, constantize, etc.).
+    module RakeSetupOutput
+      extend self
+
+      BACKTRACE_LIMIT = 12
+      DIVIDER = "=" * 60
+      SEPARATOR = "-" * 60
+
+      def print_failure(io:, exception:, file_path:, task_name:)
+        lines = filtered_backtrace(exception, file_path)
+        display = relative_display_path(file_path)
+
+        io.puts ""
+        io.puts Colors.red(DIVIDER, io:)
+        io.puts Colors.error("DATA SHIFT SETUP FAILED", io:)
+        io.puts Colors.dim(SEPARATOR, io:)
+        io.puts "Rake task:   data:shift:#{task_name}"
+        io.puts "File:        #{display}"
+        io.puts Colors.dim(SEPARATOR, io:)
+        io.puts Colors.error("#{exception.class}: #{exception.message}", io:)
+        if lines.any?
+          io.puts ""
+          io.puts Colors.dim("Backtrace:", io:)
+          lines.each { |line| io.puts Colors.dim("  #{line}", io:) }
+        end
+        io.puts Colors.red(DIVIDER, io:)
+        io.puts ""
+      end
+
+      private
+
+      def relative_display_path(file_path)
+        if defined?(Rails) && Rails.root
+          Pathname(file_path).relative_path_from(Rails.root).to_s
+        else
+          file_path.to_s
+        end
+      rescue ArgumentError
+        file_path.to_s
+      end
+
+      def filtered_backtrace(exception, file_path)
+        raw = exception.backtrace || []
+        cleaned =
+          if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner) && Rails.backtrace_cleaner
+            Rails.backtrace_cleaner.clean(raw)
+          else
+            raw
+          end
+        lines = cleaned.map(&:to_s).reject(&:empty?).first(BACKTRACE_LIMIT)
+        return lines if lines.any?
+
+        needle = file_path.to_s
+        lines = raw.select { |ln| ln.start_with?(needle) || ln.include?("/data_shifts/") }.first(BACKTRACE_LIMIT)
+        return lines if lines.any?
+
+        raw.first(BACKTRACE_LIMIT)
+      end
+    end
+  end
+end

data/lib/data_shifter/internal/side_effect_guards.rb

@@ -12,7 +12,7 @@ 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
       class << self
         # Applies side-effect guards, yields, then restores. Call only when running in dry run.
@@ -97,10 +97,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 +125,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/railtie.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require "axn"
 require "rails/railtie"
 
+require_relative "internal/rake_setup_output"
+
 module DataShifter
   class Railtie < Rails::Railtie
     # Extract description DSL from shift file without loading it.
@@ -67,12 +68,15 @@ module DataShifter
               klass.run!
             rescue Interrupt
               exit(130)
-            rescue Axn::Failure
-              # run! re-raises after on_error :_print_summary; avoid Rake's duplicate backtrace.
-              exit(1)
             rescue StandardError => e
-              # Errors raised while loading the shift class still need to be reported
-              warn e.full_message(highlight: false, order: :top)
+              unless Internal::RakeExceptionReporting.failure_summary_reported?
+                Internal::RakeSetupOutput.print_failure(
+                  io: $stderr,
+                  exception: e,
+                  file_path:,
+                  task_name:,
+                )
+              end
               exit(1)
             end
           end

data/lib/data_shifter/shift.rb

@@ -59,7 +59,7 @@ module DataShifter
     around :_with_transaction_for_dry_run
     before :_reset_tracking
     on_success :_print_summary
-    on_error :_print_summary
+    on_error :_print_summary_for_axn_error
 
     class_attribute :_transaction_mode, default: :single
     class_attribute :_progress_enabled, default: nil
@@ -253,6 +253,7 @@ module DataShifter
     end
 
     def _reset_tracking
+      Internal::RakeExceptionReporting.clear!
       @stats = { processed: 0, succeeded: 0, failed: 0, skipped: 0 }
       @errors = []
       @skip_reasons = Hash.new(0)
@@ -277,6 +278,11 @@ module DataShifter
       )
     end
 
+    def _print_summary_for_axn_error
+      _print_summary
+      Internal::RakeExceptionReporting.mark_failure_summary_reported!
+    end
+
     # --- Override points ---
 
     def collection

data/lib/data_shifter/version.rb

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

data/lib/data_shifter.rb

@@ -3,6 +3,7 @@
 require_relative "data_shifter/version"
 require_relative "data_shifter/configuration"
 require_relative "data_shifter/errors"
+require_relative "data_shifter/internal/rake_exception_reporting"
 require_relative "data_shifter/shift"
 require_relative "data_shifter/railtie"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_shifter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2.1
 platform: ruby
 authors:
 - Kali Donovan
@@ -121,6 +121,8 @@ files:
 - lib/data_shifter/internal/log_deduplicator.rb
 - lib/data_shifter/internal/output.rb
 - lib/data_shifter/internal/progress_bar.rb
+- lib/data_shifter/internal/rake_exception_reporting.rb
+- lib/data_shifter/internal/rake_setup_output.rb
 - lib/data_shifter/internal/record_utils.rb
 - lib/data_shifter/internal/side_effect_guards.rb
 - lib/data_shifter/internal/signal_handler.rb