closure_tree 3.7.2 → 3.7.3

data/README.md

@@ -396,6 +396,12 @@ Parallelism is not tested with Rails 3.0.x nor 3.1.x due to this
 
 ## Change log
 
+### 3.7.3
+
+Due to MySQL's inability to lock rows properly, I've switched to advisory_locks for
+all write paths. This will prevent deadlocks, addressing
+[issue 41](https://github.com/mceachen/closure_tree/issues/41).
+
 ### 3.7.2
 
 * Support for UUID primary keys. Addresses

data/lib/closure_tree.rb

@@ -1,8 +1,9 @@
 require 'active_support'
+require 'active_record'
 
 ActiveSupport.on_load :active_record do
-  require 'closure_tree/acts_as_tree'
   require 'with_advisory_lock'
+  require 'closure_tree/acts_as_tree'
 
   ActiveRecord::Base.send :extend, ClosureTree::ActsAsTree
 end

data/lib/closure_tree/acts_as_tree.rb

@@ -216,20 +216,23 @@ module ClosureTree
 
     # Find a child node whose +ancestry_path+ minus self.ancestry_path is +path+
     def find_or_create_by_path(path, attributes = {})
-      subpath = path.is_a?(Enumerable) ? path.dup : [path]
-      child_name = subpath.shift
-      return self unless child_name
-      child = transaction do
-        lock!
-        attrs = {name_sym => child_name}
-        attrs[:type] = self.type if ct_subclass? && ct_has_type?
-        self.children.where(attrs).first || begin
-          child = self.class.new(attributes.merge(attrs))
-          self.children << child
-          child
+      with_advisory_lock("closure_tree") do
+        transaction do
+          subpath = path.is_a?(Enumerable) ? path.dup : [path]
+          child_name = subpath.shift
+          return self unless child_name
+          child = transaction do
+            attrs = {name_sym => child_name}
+            attrs[:type] = self.type if ct_subclass? && ct_has_type?
+            self.children.where(attrs).first || begin
+              child = self.class.new(attributes.merge(attrs))
+              self.children << child
+              child
+            end
+          end
+          child.find_or_create_by_path(subpath, attributes)
         end
       end
-      child.find_or_create_by_path(subpath, attributes)
     end
 
     def find_all_by_generation(generation_level)
@@ -284,18 +287,22 @@ module ClosureTree
     end
 
     def rebuild!
-      delete_hierarchy_references unless @was_new_record
-      hierarchy_class.create!(:ancestor => self, :descendant => self, :generations => 0)
-      unless root?
-        connection.execute <<-SQL
+      with_advisory_lock("closure_tree") do
+        transaction do
+          delete_hierarchy_references unless @was_new_record
+          hierarchy_class.create!(:ancestor => self, :descendant => self, :generations => 0)
+          unless root?
+            connection.execute <<-SQL
           INSERT INTO #{quoted_hierarchy_table_name}
             (ancestor_id, descendant_id, generations)
           SELECT x.ancestor_id, #{ct_quote(id)}, x.generations + 1
           FROM #{quoted_hierarchy_table_name} x
           WHERE x.descendant_id = #{ct_quote(self.ct_parent_id)}
-        SQL
+            SQL
+          end
+          children.each { |c| c.rebuild! }
+        end
       end
-      children.each { |c| c.rebuild! }
     end
 
     def ct_before_destroy
@@ -351,7 +358,7 @@ module ClosureTree
       # Rebuilds the hierarchy table based on the parent_id column in the database.
       # Note that the hierarchy table will be truncated.
       def rebuild!
-        with_advisory_lock("closure_tree.#{ct_class}.rebuild") do
+        with_advisory_lock("closure_tree") do
           transaction do
             hierarchy_class.delete_all # not destroy_all -- we just want a simple truncate.
             roots.each { |n| n.send(:rebuild!) } # roots just uses the parent_id column, so this is safe.
@@ -371,15 +378,15 @@ module ClosureTree
       def find_or_create_by_path(path, attributes = {})
         subpath = path.dup
         root_name = subpath.shift
-        root = with_advisory_lock("closure_tree.#{ct_class}.find_or_create(#{root_name})") do
+        with_advisory_lock("closure_tree") do
           transaction do
             # shenanigans because find_or_create can't infer we want the same class as this:
             # Note that roots will already be constrained to this subclass (in the case of polymorphism):
-            roots.where(name_sym => root_name).first ||
-              create!(attributes.merge(name_sym => root_name))
+            root = roots.where(name_sym => root_name).first
+            root ||= create!(attributes.merge(name_sym => root_name))
+            root.find_or_create_by_path(subpath, attributes)
           end
         end
-        root.find_or_create_by_path(subpath, attributes)
       end
 
       def hash_tree_scope(limit_depth = nil)
@@ -566,29 +573,34 @@ module ClosureTree
 
     def add_sibling(sibling_node, use_update_all = true, add_after = true)
       fail "can't add self as sibling" if self == sibling_node
-      # issue 18: we need to set the order_value explicitly so subsequent orders will work.
-      update_attribute(:order_value, 0) if self.order_value.nil?
-      sibling_node.order_value = self.order_value.to_i + (add_after ? 1 : -1)
-      # We need to incr the before_siblings to make room for sibling_node:
-      if use_update_all
-        col = quoted_order_column(false)
-        # issue 21: we have to use the base class, so STI doesn't get in the way of only updating the child class instances:
-        ct_base_class.update_all(
-          ["#{col} = #{col} #{add_after ? '+' : '-'} 1", "updated_at = now()"],
-          ["#{quoted_parent_column_name} = ? AND #{col} #{add_after ? '>=' : '<='} ?",
-            ct_parent_id,
-            sibling_node.order_value])
-      else
-        last_value = sibling_node.order_value.to_i
-        (add_after ? siblings_after : siblings_before.reverse).each do |ea|
-          last_value += (add_after ? 1 : -1)
-          ea.order_value = last_value
-          ea.save!
+      # issue 40: we need to lock the parent to prevent deadlocks on parallel sibling additions
+      with_advisory_lock("closure_tree") do
+        transaction do
+          # issue 18: we need to set the order_value explicitly so subsequent orders will work.
+          update_attribute(:order_value, 0) if self.order_value.nil?
+          sibling_node.order_value = self.order_value.to_i + (add_after ? 1 : -1)
+          # We need to incr the before_siblings to make room for sibling_node:
+          if use_update_all
+            col = quoted_order_column(false)
+            # issue 21: we have to use the base class, so STI doesn't get in the way of only updating the child class instances:
+            ct_base_class.update_all(
+              ["#{col} = #{col} #{add_after ? '+' : '-'} 1", "updated_at = now()"],
+              ["#{quoted_parent_column_name} = ? AND #{col} #{add_after ? '>=' : '<='} ?",
+                ct_parent_id,
+                sibling_node.order_value])
+          else
+            last_value = sibling_node.order_value.to_i
+            (add_after ? siblings_after : siblings_before.reverse).each do |ea|
+              last_value += (add_after ? 1 : -1)
+              ea.order_value = last_value
+              ea.save!
+            end
+          end
+          sibling_node.parent = self.parent
+          sibling_node.save!
+          sibling_node.reload
         end
       end
-      sibling_node.parent = self.parent
-      sibling_node.save!
-      sibling_node.reload # <- because siblings_before and siblings_after will have changed.
     end
   end
-end
+end

data/lib/closure_tree/version.rb

@@ -1,3 +1,3 @@
 module ClosureTree
-  VERSION = "3.7.2" unless defined?(::ClosureTree::VERSION)
+  VERSION = "3.7.3" unless defined?(::ClosureTree::VERSION)
 end

data/spec/db/database.yml

@@ -1,10 +1,10 @@
-sqlite3:
+sqlite:
   adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
   database: spec/sqlite3.db
   pool: 50
   timeout: 5000
 
-pg:
+postgresql:
   adapter: postgresql
   username: postgres
   database: closure_tree_test

data/spec/db/schema.rb

@@ -11,34 +11,34 @@ end
 
 ActiveRecord::Schema.define(:version => 0) do
 
-  create_table "nodes", :id => false do |t|
-    t.string "id"
+  create_table "tags", :force => true do |t|
     t.string "name"
-    t.string "parent_id"
+    t.string "title"
+    t.integer "parent_id"
+    t.integer "sort_order"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
 
-  force_add_index "nodes", [:id], :name => "node_id", :unique => true
-
-  create_table "node_hierarchies", :id => false, :force => true do |t|
-    t.string "ancestor_id", :null => false
-    t.string "descendant_id", :null => false
+  create_table "tag_hierarchies", :id => false, :force => true do |t|
+    t.integer "ancestor_id", :null => false
+    t.integer "descendant_id", :null => false
     t.integer "generations", :null => false
   end
 
-  create_table "tags", :force => true do |t|
+  create_table "tags_uuid", :id => false, :force => true do |t|
+    t.string "id", :unique => true
     t.string "name"
     t.string "title"
-    t.integer "parent_id"
+    t.string "parent_id"
     t.integer "sort_order"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
 
-  create_table "tag_hierarchies", :id => false, :force => true do |t|
-    t.integer "ancestor_id", :null => false
-    t.integer "descendant_id", :null => false
+  create_table "tag_hierarchies_uuid", :id => false, :force => true do |t|
+    t.string "ancestor_id", :null => false
+    t.string "descendant_id", :null => false
     t.integer "generations", :null => false
   end
 

data/spec/parallel_prepend_sibling_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe "threadhot" do
+
+  before :each do
+    LabelHierarchy.delete_all
+    Label.delete_all
+    @iterations = 5
+    @workers = 8
+  end
+
+  def prepend_sibling_at_even_second(run_at)
+    ActiveRecord::Base.connection.reconnect!
+    sibling = Label.new(:name => SecureRandom.hex(10))
+    target = Label.find(@target.id)
+    sleep(run_at - Time.now.to_f)
+    target.prepend_sibling sibling
+  end
+
+  def run_workers
+    start_time = Time.now.to_i + 2
+    @times = @iterations.times.collect { |ea| start_time + (ea * 2) }
+    @names = @times.collect { |ea| ea.to_s }
+    @threads = @workers.times.collect do
+      Thread.new do
+        @times.each { |ea| prepend_sibling_at_even_second(ea) }
+      end
+    end
+    @threads.each { |ea| ea.join }
+  end
+
+  it "prepend_sibling on a non-root node doesn't cause deadlocks" do
+    @target = Label.find_or_create_by_path %w(root parent)
+    run_workers
+    children = Label.roots
+    uniq_sort_orders = children.collect { |ea| ea.sort_order }.uniq
+    children.size.should == uniq_sort_orders.size
+
+    # The only non-root node should be "root":
+    Label.all.select { |ea| ea.root? }.should == [@target.parent]
+  end
+
+# SQLite doesn't like parallelism, and Rails 3.0 and 3.1 have known threading issues. SKIP.
+end if ((ENV["DB"] != "sqlite3") && (ActiveRecord::VERSION::STRING =~ /^3.2/))

data/spec/parallel_spec.rb

@@ -56,4 +56,4 @@ describe "threadhot" do
   end
 
 # SQLite doesn't like parallelism, and Rails 3.0 and 3.1 have known threading issues. SKIP.
-end if ((ENV["DB"] != "sqlite3") && (ActiveRecord::VERSION::STRING =~ /^3.2/))
+end if ((ENV["DB"] != "sqlite") && (ActiveRecord::VERSION::STRING =~ /^3.2/))

data/spec/spec_helper.rb

@@ -7,11 +7,7 @@ require 'bundler/setup'
 require 'rspec'
 require 'logger'
 
-require 'active_support'
-require 'active_model'
-require 'active_record'
 require 'action_controller' # rspec-rails needs this :(
-require 'with_advisory_lock'
 require 'closure_tree'
 require 'tmpdir'
 
@@ -58,4 +54,4 @@ RSpec.configure do |config|
   config.after(:all) do
     FileUtils.remove_entry_secure ENV['FLOCK_DIR']
   end
-end
+end

data/spec/support/models.rb

@@ -1,15 +1,5 @@
 require 'uuidtools'
 
-class Node < ActiveRecord::Base
-  acts_as_tree :dependent => :destroy
-  before_create :generate_uuid
-  attr_accessible :name
-
-  def generate_uuid
-    self.id = UUIDTools::UUID.random_create.to_s
-  end
-end
-
 class Tag < ActiveRecord::Base
   acts_as_tree :dependent => :destroy, :order => "name"
   before_destroy :add_destroyed_tag

data/spec/tag_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-shared_examples_for Tag do
+shared_examples_for "Tag (1)" do
 
   it "has correct accessible_attributes" do
     Tag.accessible_attributes.to_a.should =~ %w(parent name)
@@ -146,8 +146,10 @@ shared_examples_for Tag do
     end
 
   end
+end
 
-  describe "Tag with fixtures" do
+shared_examples_for "Tag (2)" do
+  describe "Tag (2)" do
 
     fixtures :tags
 
@@ -367,7 +369,8 @@ describe Tag do
       Tag.ancestors.should_not include(ActiveModel::ForbiddenAttributesProtection)
     end
   end
-  it_behaves_like Tag
+  it_behaves_like "Tag (1)"
+  it_behaves_like "Tag (2)"
 end
 
 describe "Tag with AR whitelisted attributes enabled" do
@@ -380,7 +383,8 @@ describe "Tag with AR whitelisted attributes enabled" do
       Tag.ancestors.should_not include(ActiveModel::ForbiddenAttributesProtection)
     end
   end
-  it_behaves_like Tag
+  it_behaves_like "Tag (1)"
+  it_behaves_like "Tag (2)"
 end
 
 # This has to be the last one, because we include strong parameters into Tag
@@ -391,6 +395,29 @@ describe "Tag with strong parameters" do
       include ActiveModel::ForbiddenAttributesProtection
     end
   end
-  it_behaves_like Tag
+  it_behaves_like "Tag (1)"
+  it_behaves_like "Tag (2)"
 end
 
+describe "Tag with UUID" do
+  before(:all) do
+    # Change tables
+    Tag.table_name = Tag.table_name.gsub('tags', 'tags_uuid')
+    Tag.reset_column_information
+    TagHierarchy.table_name = TagHierarchy.table_name.gsub('tag_hierarchies', 'tag_hierarchies_uuid')
+    TagHierarchy.reset_column_information
+
+    # We have to reset a few other caches
+    Tag.closure_tree_options[:hierarchy_table_name] = 'tag_hierarchies_uuid'
+    Tag.reflections.each do |key, ref|
+      ref.instance_variable_set('@table_name', nil)
+      ref.instance_variable_set('@quoted_table_name', nil)
+      ref.options[:order].sub! 'tag_hierarchies', 'tag_hierarchies_uuid' if ref.options[:order]
+    end
+
+    # Add ID
+    Tag.before_create { self.id = UUIDTools::UUID.random_create.to_s }
+  end
+
+  it_behaves_like "Tag (1)"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closure_tree
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.7.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +223,7 @@ files:
 - spec/fixtures/tags.yml
 - spec/hash_tree_spec.rb
 - spec/label_spec.rb
-- spec/node_spec.rb
+- spec/parallel_prepend_sibling_spec.rb
 - spec/parallel_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
@@ -243,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2260215237559696293
+      hash: -1398803141248485966
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -252,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2260215237559696293
+      hash: -1398803141248485966
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -267,7 +267,7 @@ test_files:
 - spec/fixtures/tags.yml
 - spec/hash_tree_spec.rb
 - spec/label_spec.rb
-- spec/node_spec.rb
+- spec/parallel_prepend_sibling_spec.rb
 - spec/parallel_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb

data/spec/node_spec.rb

@@ -1,148 +0,0 @@
-require 'spec_helper'
-
-shared_examples_for Node do
-
-  it "has correct accessible_attributes" do
-    Node.accessible_attributes.to_a.should =~ %w(parent name)
-  end
-
-  describe "empty db" do
-
-    def nuke_db
-      NodeHierarchy.delete_all
-      Node.delete_all
-    end
-
-    before :each do
-      nuke_db
-    end
-
-    context "empty db" do
-      it "should return no entities" do
-        Node.roots.should be_empty
-        Node.leaves.should be_empty
-      end
-    end
-
-    context "1 node db" do
-      it "should return the only entity as a root and leaf" do
-        a = Node.create!(:name => "a")
-        Node.roots.should == [a]
-        Node.leaves.should == [a]
-      end
-    end
-
-    context "2 node db" do
-      it "should return a simple root and leaf" do
-        root = Node.create!(:name => "root")
-        leaf = root.add_child(Node.create!(:name => "leaf"))
-        Node.roots.should == [root]
-        Node.leaves.should == [leaf]
-      end
-    end
-
-    context "3 node collection.create db" do
-      before :each do
-        @root = Node.create! :name => "root"
-        @mid = @root.children.create! :name => "mid"
-        @leaf = @mid.children.create! :name => "leaf"
-      end
-
-      it "should create all nodes" do
-        Node.all.should =~ [@root, @mid, @leaf]
-      end
-
-      it "should return a root and leaf without middle node" do
-        Node.roots.should == [@root]
-        Node.leaves.should == [@leaf]
-      end
-
-      it "should delete leaves" do
-        Node.leaves.destroy_all
-        Node.roots.should == [@root] # untouched
-        Node.leaves.should == [@mid]
-      end
-
-      it "should delete everything if you delete the roots" do
-        Node.roots.destroy_all
-        Node.all.should be_empty
-        Node.roots.should be_empty
-        Node.leaves.should be_empty
-      end
-    end
-
-    context "3 node explicit_create db" do
-      before :each do
-        @root = Node.create!(:name => "root")
-        @mid = @root.add_child(Node.create!(:name => "mid"))
-        @leaf = @mid.add_child(Node.create!(:name => "leaf"))
-      end
-
-      it "should create all nodes" do
-        Node.all.should =~ [@root, @mid, @leaf]
-      end
-
-      it "should return a root and leaf without middle node" do
-        Node.roots.should == [@root]
-        Node.leaves.should == [@leaf]
-      end
-
-      it "should prevent parental loops from torso" do
-        @mid.children << @root
-        @root.valid?.should be_false
-        @mid.reload.children.should == [@leaf]
-      end
-
-      it "should prevent parental loops from toes" do
-        @leaf.children << @root
-        @root.valid?.should be_false
-        @leaf.reload.children.should be_empty
-      end
-
-      it "should support re-parenting" do
-        @root.children << @leaf
-        Node.leaves.should =~ [@leaf, @mid]
-      end
-
-      it "cleans up hierarchy references for leaves" do
-        @leaf.destroy
-        NodeHierarchy.find_all_by_ancestor_id(@leaf.id).should be_empty
-        NodeHierarchy.find_all_by_descendant_id(@leaf.id).should be_empty
-      end
-
-      it "cleans up hierarchy references" do
-        @mid.destroy
-        NodeHierarchy.find_all_by_ancestor_id(@mid.id).should be_empty
-        NodeHierarchy.find_all_by_descendant_id(@mid.id).should be_empty
-        @root.reload.should be_root
-        root_hiers = @root.ancestor_hierarchies.to_a
-        root_hiers.size.should == 1
-        NodeHierarchy.find_all_by_ancestor_id(@root.id).should == root_hiers
-        NodeHierarchy.find_all_by_descendant_id(@root.id).should == root_hiers
-      end
-    end
-
-    it "performs as the readme says it does" do
-      grandparent = Node.create(:name => 'Grandparent')
-      parent = grandparent.children.create(:name => 'Parent')
-      child1 = Node.create(:name => 'First Child', :parent => parent)
-      child2 = Node.new(:name => 'Second Child')
-      parent.children << child2
-      child3 = Node.new(:name => 'Third Child')
-      parent.add_child child3
-      grandparent.self_and_descendants.collect(&:name).should ==
-        ["Grandparent", "Parent", "First Child", "Second Child", "Third Child"]
-      child1.ancestry_path.should ==
-        ["Grandparent", "Parent", "First Child"]
-      child3.ancestry_path.should ==
-        ["Grandparent", "Parent", "Third Child"]
-      d = Node.find_or_create_by_path %w(a b c d)
-      h = Node.find_or_create_by_path %w(e f g h)
-      e = h.root
-      d.add_child(e) # "d.children << e" would work too, of course
-      h.ancestry_path.should == %w(a b c d e f g h)
-    end
-
-  end
-
-end