rails-archiver 0.1.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22767f51d1fefb73fd2d17b703a0ee846509bb99fc4dd2bed27c06a28fcdfc60
-  data.tar.gz: d04f42ec798d1df81fc3ee76575d4e1658563b73e4087f1e1639553b489b52b6
+  metadata.gz: ddfcaefd86b70ef668e8ba941e20f68a96a62a704ad9e931fbe72343a6ef7ddb
+  data.tar.gz: d3283d3fbbb8abeafab718a445b7f129cef999f531b7766998af860c22de2c90
 SHA512:
-  metadata.gz: a9b6176a12fd8fd673ebb726dcaa4dd08f2a3e561718685693870f78d0661b863e7ca03b2ea8a9da8f8e18e73f1128115c20af17f65aee08e070911584473958
-  data.tar.gz: 176e5169d8d4756fdae4ff8fcbe5e8f5bcde4395a262a332321e7cbbdf1e61530e7373b1fd389217d5c747190d4dbb0023aa1aab48c29df5128ac7827a7a502d
+  metadata.gz: a69726e5dff1eb032dcb915c67804cce258f970652045561a52a727a073493844a5879d79e2bb982d6a9427c834f0d33e1873759c29c463765d65894cb19674e
+  data.tar.gz: 34eb78437f58aced9d64fe518e0183f8ecc5dc24e8d24e88194d7d379a5c9ecd138c00bbc46f54f23fef280ea8994acd12b8c9a86decbc0d3fa04d9014896917

data/.gitignore

@@ -0,0 +1,3 @@
+### Ruby template
+*.gem
+.idea

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## UNRELEASED
+
+# [0.3.0] - 2025-05-22
+- Added retries for delete table operations to handle SQL Timeouts and deadlocks.
+
+# [0.2.0] - 2025-01-20
+- Added support for enum columns - should be able to handle both keys and values.
+- Refactored the `unarchiver` method to more easily subclass `Unarchiver`.
+- For `belongs_to` associations, replace foreign key attributes with actual reference to the relevant object while archiving to avoid issues with validation.

data/lib/rails-archiver/archiver.rb

@@ -1,4 +1,5 @@
 require 'tmpdir'
+require 'rails-archiver/utils/deadlock_retry'
 # Takes a database model and:
 # 1) Visits all dependent associations
 # 2) Saves everything in one giant JSON hash
@@ -122,15 +123,26 @@ module RailsArchiver
         delete_query = <<-SQL
           DELETE FROM `#{table}` WHERE `id` IN (#{group.compact.join(',')})
         SQL
-        ActiveRecord::Base.connection.delete(delete_query)
+        RailsArchiver::Utils::DeadlockRetry.wrap do
+          ActiveRecord::Base.connection.delete(delete_query)
+        end
       end
 
       @logger.info("Finished deleting from #{table}")
     end
 
+    # @return [Class]
+    def unarchiver_class
+      RailsArchiver::Unarchiver
+    end
+
     # @return [RailsArchiver::Unarchiver]
-    def unarchiver
-      unarchiver = RailsArchiver::Unarchiver.new(@model, :logger => @logger)
+    # @param crash_on_errors [Boolean]
+    def unarchiver(crash_on_errors: false)
+      unarchiver = unarchiver_class.new(@model,
+                                        logger: @logger,
+                                        crash_on_errors: crash_on_errors
+      )
       unarchiver.transport = self.transport
       unarchiver
     end

data/lib/rails-archiver/unarchiver.rb

@@ -11,18 +11,24 @@ module RailsArchiver
     attr_accessor :errors, :transport
 
     # @param model [ActiveRecord::Base]
-    # @param options [Hash]
-    #   * logger [Logger]
-    #   * new_copy [Boolean] if true, create all new objects instead of
-    #                        replacing existing ones.
-    #   * crash_on_errors [Boolean] if true, do not do any imports if any
-    #                               models' validations failed.
-    def initialize(model, options={})
+    # @param logger [Logger]
+    # @param new_copy [Boolean] if true, create all new objects instead of
+    #                           replacing existing ones.
+    # @param crash_on_errors [Boolean] if true, do not do any imports if any
+    #                           models' validations failed.
+    # @param transport [Symbol|RailsArchiver::Transport::Base]
+    def initialize(model,
+                   transport: :in_memory,
+                   logger: Logger.new(STDOUT),
+                   new_copy: false, crash_on_errors: false)
       @model = model
-      @logger = options.delete(:logger) || Logger.new(STDOUT)
-      @options = options
+      @logger = logger
+      @options = {
+        new_copy: new_copy,
+        crash_on_errors: crash_on_errors
+      }
       # Transport for downloading
-      self.transport = _get_transport(options.delete(:transport) || :in_memory)
+      self.transport = _get_transport(transport)
       self.errors = []
     end
 
@@ -58,7 +64,7 @@ module RailsArchiver
         end
       end
       if @options[:crash_on_errors] && self.errors.any?
-        raise ImportError.new("Errors occurred during load - please see 'errors' method for more details")
+        raise ImportError.new("Errors occurred during load: #{self.errors.join("\n")}")
       end
     end
 
@@ -114,13 +120,52 @@ module RailsArchiver
       end
 
       model
+    rescue => e
+      self.errors << "Error importing class #{klass.name}: #{e.message}"
     end
 
     private
 
+    # @param model [ActiveRecord::Base]
+    # @param field [String]
+    # @param attrs [Hash]
+    def assign_enum_value(model, field, attrs)
+      entries = model.class.public_send(field.pluralize)
+      is_integer = entries.values.first.is_a?(Integer)
+      value = attrs[field]
+      valid = if entries.keys.include?(value)
+                true
+              elsif is_integer && entries.values.include?(value.to_i)
+                true
+              else
+                entries.values.include?(value)
+              end
+
+      return if valid
+
+      @logger.warn("Invalid value for #{field}: #{attrs[field]}")
+      new_value = model.class.columns.find { |a| a.name == field }.default
+      new_value = new_value.to_i if is_integer && new_value
+      attrs[field] = new_value
+    end
+
     # @param model [ActiveRecord::Base]
     # @param attrs [Hash]
     def _assign_attributes(model, attrs)
+      # Handle integer enum values that were turned into strings
+      if model.class.respond_to?(:attribute_types)
+        enums = model.class.attribute_types.select { |_, v| v.is_a?(ActiveRecord::Enum::EnumType) }
+        enums.keys.each do |field|
+          assign_enum_value(model, field, attrs)
+        end
+      end
+      model.class.reflect_on_all_associations(:belongs_to).each do |assoc|
+        if attrs[assoc.foreign_key].present?
+          record = assoc.klass.find_by(assoc.association_primary_key => attrs[assoc.foreign_key])
+          attrs[assoc.name] = record if record
+        end
+      end
+
       if model.method(:attributes=).arity == 1
         model.attributes = attrs
       else

data/lib/rails-archiver/utils/deadlock_retry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RailsArchiver
+  module Utils
+    # Utility module to retry a block of code in case of a deadlock.
+    module DeadlockRetry
+      class << self
+
+        RETRY_COUNT = 2
+
+        def wrap(&block)
+          count = RETRY_COUNT
+          begin
+            ActiveRecord::Base.transaction(&block)
+          rescue ActiveRecord::Deadlocked, ActiveRecord::LockWaitTimeout => e
+            raise if count <= 0
+
+            Rails.logger.error("Error: #{e.message}. Retrying. #{count} attempts remaining")
+            count -= 1
+
+            sleep(Random.rand(5.0) + 0.5)
+
+            retry
+          end
+        end
+      end
+    end
+  end
+end

data/rails-archiver.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name         = 'rails-archiver'
   s.require_paths = %w(. lib lib/rails-archiver)
-  s.version      = '0.1.8'
-  s.date         = '2024-07-03'
+  s.version      = '0.3.0'
+  s.date         = '2025-05-22'
   s.summary      = 'Fully archive a Rails model'
   s.description  = <<-EOF
   EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-archiver
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
 - README.md
 - lib/rails-archiver.rb
 - lib/rails-archiver/archiver.rb
@@ -51,6 +53,7 @@ files:
 - lib/rails-archiver/transport/in_memory.rb
 - lib/rails-archiver/transport/s3.rb
 - lib/rails-archiver/unarchiver.rb
+- lib/rails-archiver/utils/deadlock_retry.rb
 - rails-archiver.gemspec
 homepage: https://github.com/dorner/rails-archiver
 licenses: