Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use weak references in descendants tracker #31442

Merged
merged 1 commit into from
Mar 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions activesupport/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
* Use weak references in descendants tracker to allow anonymous subclasses to
be garbage collected.

*Edgars Beigarts*

* Update `ActiveSupport::Notifications::Instrumenter#instrument` to make
passing a block optional. This will let users use
`ActiveSupport::Notifications` messaging features outside of
Expand Down
54 changes: 50 additions & 4 deletions activesupport/lib/active_support/descendants_tracker.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# frozen_string_literal: true

require "weakref"

module ActiveSupport
# This module provides an internal implementation to track descendants
# which is faster than iterating through ObjectSpace.
Expand All @@ -8,7 +10,8 @@ module DescendantsTracker

class << self
def direct_descendants(klass)
@@direct_descendants[klass] || []
descendants = @@direct_descendants[klass]
descendants ? descendants.to_a : []
end

def descendants(klass)
Expand All @@ -34,15 +37,17 @@ def clear
# This is the only method that is not thread safe, but is only ever called
# during the eager loading phase.
def store_inherited(klass, descendant)
(@@direct_descendants[klass] ||= []) << descendant
(@@direct_descendants[klass] ||= DescendantsArray.new) << descendant
end

private

def accumulate_descendants(klass, acc)
if direct_descendants = @@direct_descendants[klass]
acc.concat(direct_descendants)
direct_descendants.each { |direct_descendant| accumulate_descendants(direct_descendant, acc) }
direct_descendants.each do |direct_descendant|
acc << direct_descendant
accumulate_descendants(direct_descendant, acc)
end
end
end
end
Expand All @@ -59,5 +64,46 @@ def direct_descendants
def descendants
DescendantsTracker.descendants(self)
end

# DescendantsArray is an array that contains weak references to classes.
class DescendantsArray # :nodoc:
include Enumerable

def initialize
@refs = []
end

def initialize_copy(orig)
@refs = @refs.dup
end

def <<(klass)
cleanup!
@refs << WeakRef.new(klass)
end

def each
@refs.each do |ref|
yield ref.__getobj__
rescue WeakRef::RefError
end
end

def refs_size
@refs.size
end

def cleanup!
@refs.delete_if { |ref| !ref.weakref_alive? }
end

def reject!
@refs.reject! do |ref|
yield ref.__getobj__
rescue WeakRef::RefError
true
end
end
end
end
end
9 changes: 9 additions & 0 deletions activesupport/test/descendants_tracker_test_cases.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ def test_descendants
assert_equal_sets [], Child2.descendants
end

def test_descendants_with_garbage_collected_classes
1.times do
child_klass = Class.new(Parent)
assert_equal_sets [Child1, Grandchild1, Grandchild2, Child2, child_klass], Parent.descendants
end
GC.start
assert_equal_sets [Child1, Grandchild1, Grandchild2, Child2], Parent.descendants
end

def test_direct_descendants
assert_equal_sets [Child1, Child2], Parent.direct_descendants
assert_equal_sets [Grandchild1, Grandchild2], Child1.direct_descendants
Expand Down