一人 bugs.ruby Advent Calendar 2021 25日目の記事になります。
今日で Advent Calendar も最後という事で今回は今年みた Ruby のバグをいくつか紹介してみようと思います。
またこれから紹介する修正済みのバグは Ruby 3.1 ではなくて古い Ruby でもバックポートされている可能性があるので注意してください（〜で修正済みと書かれていても RUby 2.7.x 系でバックポートされていて修正済みの可能性があります。
Integer#+ を書き換えると特定の値で Integer#times の挙動に影響を与えるというバグ報告です。
(2**1).times do
Integer.undef_method(:+)
Integer.define_method(:+) do |_other|
puts "my custom add"
end
end
(2**65).times do
Integer.undef_method(:+)
Integer.define_method(:+) do |_other|
puts "my custom add"
end
end
内部で Integer#+ を呼び出すようになっていたところを呼び出さないようにして対応済みです。
IO がクローズしているのにイテレーションが処理されてしまうというバグ報告です。
require "stringio"
strio = StringIO.new("1234")
strio.each_byte do |byte|
puts byte
strio.close
end
この問題は修正済みで最新版では IOError が発生するようになります。
require "stringio"
strio = StringIO.new("1234")
strio.each_byte do |byte|
puts byte
strio.close
end
Ruby 2.4 ~ 2.6 で Array#pack に空の Hash を渡すと Segmentation fault が発生するというバグ報告です。
[0].pack('c', {})
この問題は Ruby 2.7 以降では再現せず Ruby 2.6 は現状セキリュティサポートのみなのでこのチケットは閉じられています。
これは Ruby 3.1.0-dev で発生したバグになります。
次のように Module を継承して include した後に super を呼ぶとエラーになってしまうバグです。
class Mod1 < Module
def initialize(...)
super
end
end
p Mod1.new
class Mod2 < Module
def initialize(...)
include Enumerable
super
end
end
p Mod2.new
以下のコードだけでもエラーになったので include 後に Module#initialize を呼ぶとダメなのかも？
class Mod2 < Module
def initialize(...)
include Enumerable
super
end
end
p Mod2.new
これはまだ最新の 3.1.0-dev でも再現していたので Ruby 3.1 でも残ったままになってしまっているかも。
存在しない super を呼び出すとコアダンプするというバグ報告です。
次のコードを Ruby 3.0.2 で実行すると segv します。
module Probes
def self.included(base)
base.extend(ClassMethods)
end
module ClassMethods
def probe(*methods)
prepend(probing_module(methods))
end
def probing_module(methods)
Module.new do
methods.each do |method|
define_method(method) do |*args, **kwargs, &block|
super(*args, **kwargs, &block)
end
end
end
end
end
end
class Probed
include Probes
probe :danger!, :missing
def danger!
raise "BOOM"
end
end
5.times do
subject = Probed.new
subject.danger! rescue RuntimeError
subject.missing rescue NoMethodError
end
ちょっと分かりづらいので最小構成にすると以下のような感じです。
class Probed
def self.probing_module(methods)
Module.new do
methods.each do |method|
define_method(method) do |*args, **kwargs, &block|
super(*args, **kwargs, &block)
end
end
end
end
prepend probing_module [:danger!, :missing]
def danger!
end
end
subject = Probed.new
subject.danger!
subject.missing rescue NoMethodError
subject.danger!
この問題は既に修正されていて Ruby 3.0.3 にもバックポートされています。
次のように Ractor 内で別の Ractor のオブジェクトが書き換えられてしまうバグ報告です。
class C
attr_accessor :foo
def setter_proc
Ractor.make_shareable(proc {})
end
end
c = C.new
c.foo = 1
p c
proc = c.setter_proc
p c.frozen?
Ractor.new(proc) { |s| s.call(42) }.take
p c
この問題は修正済みで生成 Proc の self が共有可能オブジェクトかどうかまで参照するようになりました。
Ractor.make_shareable(nil.instance_eval { -> {} })
Ractor.make_shareable(-> {})
Hash リテラルで同名のキーが存在する場合に評価順が左からにならないバグ報告です。
これは Ruby 3.1 で修正されました。
ary = []
{ a: ary << 1, b: ary << 2, a: ary << 3 }
pp ary
Thread#join で引数を Float に変換しているが #to_f が呼ばれていないというバグ報告です。
Ruby 3.0 以降から再現するようになりました。
class Something
def to_f
0.1
end
end
Thread.new{ }.join(Something.new)
この問題は Ruby 3.1 で修正済みです。
以下のようなケースで Refinements が正しく反映されていないというバグ報告です。
module M
refine Array do
def min; :min; end
def max; :max; end
end
end
using M
pp [1, 2, 3].min
pp [1+0, 2, 3].min
これはレシーバがリテラルの場合に最適化を行っていて Refinements が反映されなくなってしまっているが原因らしいです。
これは Ruby 3.1 で修正済みです。
module M
refine Array do
def min; :min; end
def max; :max; end
end
end
using M
pp [1+0, 2, 3].min
以下のコードで Ruby がクラッシュするというバグ報告です。
loop do
m = Module.new do
prepend Module.new
def hello
end
end
klass = Class.new { include m }
m.send(:initialize_copy, Module.new)
GC.start
klass.new.hello rescue nil
end
上記のように Module#initialize_copy を呼び出すとクラッシュする可能性があるらしいです。
Ruby 3.1 では Module#initialize_copy を呼び出すと TypeError が発生するように修正されました。
module A
end
A.send(:initialize_copy, Module.new)
MatchData#{offset,begin,end} で発生した IndexError がエンコーディングを保持してないバグ報告です。
pp RUBY_VERSION
m = /.*/.match("foo")
m.offset("\u{3042}") rescue p $!.message
これは修正されて Ruby 3.0.3 以降では意図する文字コードで出力されます。
pp RUBY_VERSION
m = /.*/.match("foo")
m.offset("\u{3042}") rescue p $!.message
次のように再帰的な Hash を JSON.dump に渡すと VM がクラッシュするバグ報告です。
require 'json'
x = {}
x[:x] = x
p JSON.dump(x)
これは Ruby 2.7 から再現しており、Ruby 2.7 以前は SystemStackError が発生していました。
require 'json'
x = {}
x[:x] = x
p JSON.dump(x)
これは修正されて Ruby 3.1 からは SystemStackError が発生します。
次のように『カッコで囲まれていないパラメータを持つメソッドの戻り値を右代入で使用するとシンタックスエラーになる』というバグ報告です。
p do
end => a
p a
p(1) do
end => a
p a
p 1 do
end => a
p 1 do
end in a
このエラーは意図的ではないが修正するのは難しいらしいです。
以下のコードを Ruby 3.0 以降で実行すると segv するというバグ報告です。
def foo
caller_locations(2, 1).inspect
end
1.times.map { 1.times.map { foo } }
これは Ruby 3.0 の最適化のバグらしいです。
Ruby 3.0.3 以降では修正済みです。
以下のように TracePoint がネストしているとクラッシュするというバグ報告です。
one = TracePoint.new(:call) {}
two = TracePoint.new(:call) {}
obj = Object.new
obj.define_singleton_method(:foo) {}
foo = obj.method(:foo)
one.enable(target: foo) do
two.enable(target: foo) {}
end
修正 PR は既にあるんですが、いくつか問題がありまだマージされていません。
Ruby 2.6.5 で if 文よりも case when 文の方が遅いというバグ報告です。
require "benchmark/ips"
def deep_dup_case(obj)
case obj
when Integer, Float, TrueClass, FalseClass, NilClass
obj
when String
obj.dup
when Array
obj.map { |e| deep_dup_case(e) }
when Hash
duped = obj.dup
duped.each_pair do |key, value|
duped[key] = deep_dup_case(value)
end
else
obj.dup
end
end
def deep_dup_if(obj)
if Integer === obj || Float === obj || TrueClass === obj || FalseClass === obj || NilClass === obj
obj
elsif String === obj
obj.dup
elsif Array === obj
obj.map { |e| deep_dup_if(e) }
elsif Hash === obj
duped = obj.dup
duped.each_pair do |key, value|
duped[key] = deep_dup_if(value)
end
duped
else
obj.dup
end
end
obj = { "class" => "FooWorker", "args" => [1, 2, 3, "foobar"], "jid" => "123987123" }
Benchmark.ips do |x|
x.report("deep_dup_case") do
deep_dup_case(obj)
end
x.report("deep_dup_if") do
deep_dup_if(obj)
end
x.compare!
end
__END__
この問題は Ruby 3.1 で改善されています。
TracePoint の :return イベント時に TracePoint#parameters で正しく値が取得できないバグ報告です。
define_method(:bm) {|a|}
p method_parameters: method(:bm).parameters
trace = TracePoint.new(:call, :return){|tp|
mid = tp.method_id
if mid == :bm
p mid: mid, event: tp.event, tp_parameters: tp.parameters
end
}
trace.enable{
bm(0)
}
TracePoint#parameters だけではなくて define_method + TracePoint 全般の問題らしいです。
define_method(:bm) {|a|}
trace = TracePoint.new(:call, :return){|tp|
p [tp.event, tp.lineno] if tp.method_id == :bm
}
trace.enable{
bm(0)
}
この問題は Ruby 3.1 で修正済みです。
Integer#digits が遅いというバグ報告です。
Integer#to_s と比較してもかなり遅いらしい。
(9999**9999).to_s.chars.map(&:to_i).reverse
(9999**9999).digits
(99999**99999).to_s.chars.map(&:to_i).reverse
(99999**99999).digits
ちなみに Integer#digits は各桁を配列として返すメソッドになります。
pp 16.digits
pp 1234.digits
この問題は Ruby 3.1 で修正済みです。
ENV と ENV.clone したオブジェクトで挙動に一貫性がないというバグ報告です。
cloned_env = ENV.clone
p ENV.each_key{}.equal?(ENV)
p cloned_env.each_key{}.equal?(cloned_env)
ENV.delete('TEST')
err = ENV.fetch('TEST') rescue $!
p err.receiver.equal?(ENV)
err = cloned_env.fetch('TEST') rescue $!
p err.receiver.equal?(cloned_env)
ENV['TEST'] = 'TRUE'
p ENV.select!{ false }.equal?(ENV)
cloned_env['TEST'] = 'TRUE'
p cloned_env.select!{ false }.equal?(cloned_env)
このチケットがきっかけで Ruby 3.1 から以下のように挙動が変わりました。
Proc#hash の値が同じ値になるケースがあるというバグ報告です。
require 'set'
def capture(&block)
block
end
blocks = Array.new(1000) { capture { :foo } }
hashes = blocks.map(&:hash).uniq
ids = blocks.map(&:object_id).uniq
equality = blocks.map { blocks[0].eql?(_1) }.tally
hash = blocks.to_h { [_1, nil] }
set = blocks.to_set
puts(hashes.size)
puts(ids.size)
puts(equality.inspect)
puts(hash.size)
puts(set.size)
この問題は Ruby 3.1 で修正済みです。
Enumerator::Lazy#with_index の戻り値に対して size を呼ぶと意図しない値が返ってきたというバグ報告です。
p Enumerator::Lazy.new([1, 2, 3], 3){|y, v| y << v}.with_index.size
この問題は Ruby 3.0.2 で修正済みです。
0r === 0 や 0i === 0 は true を返すが case-when でマッチしないというバグ報告です。
p 0r === 0
p 0i === 0
case 0
when 0r
p :hoge
when 0i
p :foo
else
p :bar
end
これは最適化のバグらしく、最適化を無効にして実行すると問題なく動作します。
RubyVM::InstructionSequence.compile(<<END, specialized_instruction: false).eval
case 0
when 0r
p :hoge
when 0i
p :foo
else
p :bar
end
# => :hoge
END
この問題は Ruby 3.1 で修正済みです。
以下のように Array#zip だとイテレーションが1回余計に呼ばれているというバグ報告です。
i = 0
e = Enumerator.produce { i += 1 }
p [0, 0, 0, 0].zip e
p i
p [0, 0, 0, 0].each.zip e
p i
Enumerable#zip だと問題ないので対応する場合はこっちを使うとよさそう。
この問題は Ruby 3.1 で修正済みです。
以下のように多重代入した時に先に右辺のメソッドが呼び出されるというバグ報告です。
def foo
p :foo
[]
end
def bar
p :bar
end
x, foo[0] = bar, 0
foo[0] = bar
10年前のチケットで Ruby 3.1 で修正されました。
Ruby 3.1 だと以下のような挙動になります。
def foo
p :foo
[]
end
def bar
p :bar
end
x, foo[0] = bar, 0
以下のように .name が文字列以外を返した場合に SEGV するというバグ報告です。
class C
def self.name
42
end
end
C.this_method_does_not_exist
これは Ruby 3.0.0 で再現し、Ruby 3.0.1 では修正済みです。
以下のように StringScanner を使用すると SEGV するというバグ報告です。
require 'strscan'
string = 'ruby'
scnanner = StringScanner.new(string)
pre = Module.new do
def byteslice(*args)
end
end
string.singleton_class.prepend(pre)
scnanner.charpos
この問題は Ruby 3.0.3 で修正済みです。
Array#sort! のブロック内でレシーバを freeze すると例外が発生するがソート済みになっているというバグ報告です。
array = [1, 2, 3, 4, 5]
begin
array.sort! do |a, b|
array.freeze if a == 3
1
end
rescue => err
p err
end
p array
ちなみに break した場合はそこまでのソートになっている
array = [1, 2, 3, 4, 5]
array.sort! do |a, b|
break if a == 3
1
end
p array
この問題は Ruby 3.1 で修正済みです。
Hash リテラルでキーが重複している場合に以下のような評価順になるというバグ報告です。
{ foo: p(1), bar: p(2), foo: p(3) }
Ruby では左から右に評価されるのが一般的なので Ruby 3.1 では左から右に向かって評価されるように修正されました。
{ foo: p(1), bar: p(2), foo: p(3) }
以下のコードを実行した時に GC compaction でクラッシュするというバグ報告です。
GC.auto_compact = true
times = 20_000_000
arr = Array.new(times)
times.times do |i|
arr[i] = "#{i}"
end
arr = Array.new(1_000_000, 42)
GC.start
puts "ok"
この問題は Ruby 3.1 で修正済みです。
以下のように File#each_byte 内で File#close すると segv するというバグ報告です。
file = File.open(__FILE__)
file.each_byte do |byte|
file.close
end
この問題は Ruby 3.0.3 で修正済みです。
Module#name は非同期処理に対応していないので以下のようにすると segv するというバグ報告です。
class C
@iv = 1
end
Ractor.new {
loop {
C.name
}
}
class C
0.step { |i|
instance_variable_set("@iv#{i}", i)
}
end
この問題はまだ未修正のようです。
defined? の式で複数回メソッドが呼ばれることがあるというバグ報告です。
以下の例だと x メソッドが defined? 時に複数回呼ばれることがあるらしい。
public def x
$times_called += 1
end
def times_called
$times_called = 0
yield
$times_called
end
times_called { x }
times_called { -x }
times_called { --x }
times_called { ---x }
times_called { x+0+0 }
times_called { x.pred.pred }
times_called { x.x.x.x.x.x }
times_called { defined? x }
times_called { defined? -x }
times_called { defined? --x }
times_called { defined? ---x }
times_called { defined? x+0+0 }
times_called { defined? x.pred.pred }
times_called { defined? x.x.x.x.x.x }
これは defined? a.b.c.d を呼び出した時に a a.b a.b.c a.b.c.d が個別に呼び出されしまっているからのようです。
puts RubyVM::InstructionSequence.new("defined? a.b.c.d").disasm
__END__
この問題は Ruby 3.1 で修正済みです。
public def x
$times_called += 1
end
def times_called
$times_called = 0
yield
$times_called
end
p times_called { defined? x.x.x.x.x.x }
M.prepend M を呼び出すとエラーになるが副作用があるというバグ報告です。
以下のように M.prepend M を呼んだ場合とそうでない場合で差異があります。
module M; end
class C; end
C.prepend M
C.include M
module M2; end
M2.prepend M
C.include M2
p C.ancestors
M.prepend M rescue nil
module M3; end
M3.prepend M
C.include M3
p C.ancestors
これは Ruby 3.1 で修正済みです。
module M; end
class C; end
C.prepend M
C.include M
M.prepend M rescue nil
module M2; end
M2.prepend M
C.include M2
p C.ancestors
また、上記とは別に以下のように M.prepend M すると M.ancestors # => [M, M] となる問題もあってこれも Ruby 3.1 では修正済みです。
module M
end
pp M.ancestors
begin
M.prepend M
rescue => e
puts "error : #{e.message}"
end
pp M.ancestors
次のように ObjectSpace.dump に特異クラスを渡した場合に Ruby 3.0 だと "name" が含まれなくなっているというバグ報告です。
require "objspace"
puts ObjectSpace.dump(Object.new.singleton_class)
これは Ruby 3.1 でまた別の情報を返すようにして対応されたようです。
require "objspace"
puts ObjectSpace.dump(Object.new.singleton_class)
以下のように refine 後のメソッドを特異クラスを経由して private 化しようとするとエラーになるというバグ報告です。
module Nothing; end
class X
prepend Nothing
def hoge
end
end
X.new.singleton_class.class_eval { private :hoge }
module NeverUsed
refine X do
def hoge(*keys)
end
end
end
X.new.singleton_class.class_eval { private :hoge }
これは Ruby 3.0.1 で修正済みです。
次のように Ruby 3.0 で Hask#key? に DelegateClass を渡すと意図しない結果が返ってくるというバグ報告です。
puts "Running on Ruby: #{RUBY_DESCRIPTION}"
program = <<~EOS
require "delegate"
TypeName = DelegateClass(String)
hash = {
"Int" => true,
"Float" => true,
"String" => true,
"Boolean" => true,
"WidgetFilter" => true,
"WidgetAggregation" => true,
"WidgetEdge" => true,
"WidgetSortOrder" => true,
"WidgetGrouping" => true,
}
puts hash.key?(TypeName.new("WidgetAggregation"))
EOS
iterations = 20
results = iterations.times.map { `ruby -e '#{program}'`.chomp }.tally
puts "Results of checking `Hash#key?` #{iterations} times: #{results.inspect}"
この問題は Ruby 3.0.1 で修正済みです。
次のように super を呼び出す前と後でキーワード引数の値が変わってしまうというバグ報告です。
class BaseTest
def call(a:, b:, **)
end
end
class Test < BaseTest
def call(a:, b:, **options)
p options
super
p options
end
end
Test.new.call(a: 1, b: 2, c: {})
この問題は Ruby 3.1 で修正済みです。
これ、Ruby 3.0 系にバックポートしなくても大丈夫なんだろうか…。
おわりに
と、言うことで25日続けた 一人 bugs.ruby Advent Calendar 2021 もこれにて完走です。
最初はやろうかどうしようか迷っていたんですがなんだかんだ今年の Ruby を振り返る事ができて楽しかったです。
開発者の皆様、今年も1年間お疲れ様でした＆ありがとうございました。
