- ruby-core - ml.ruby-lang.org

[ruby-core:114938] [Ruby master Feature#18915] New error class: NotImplementedYetError or scope change for NotImplementedError
by zdennis (Zach Dennis) 02 Oct '23

02 Oct '23

Issue #18915 has been updated by zdennis (Zach Dennis). File not-implemented-error-docs.patch added Whoops, last patch upload failed. Patch actually applied here. ---------------------------------------- Feature #18915: New error class: NotImplementedYetError or scope change for NotImplementedError https://bugs.ruby-lang.org/issues/18915#change-104812 * Author: Quintasan (Michał Zając) * Status: Open * Priority: Normal ---------------------------------------- # Abstract Introduce `NotImplementedYetError` exception that should be used in case when the codepath has not been implemented by the developer for some reason (maybe they're designing an abstract class or are designing some sort of interface to reuse later on) OR extend the meaning of `NotImplementedError` to cover those usecases so we don't have to introduce another exception # Background `NotImplementedError` is supposed to be raised `if the underlying operating system or Ruby runtime does not support them` (https://ruby-doc.org/core-3.1.2/NotImplementedError.html) However it appears that many people are misusing this exception by raising this in a superclass from which they later inherit from. I do realize that Ruby promotes duck-typing (the default RuboCop style guide has a cop for this – https://github.com/rubocop/ruby-style-guide#duck-typing) However I have seen this being discussed numerous times: * https://github.com/rubocop/ruby-style-guide/issues/458 * http://chrisstump.online/2016/03/23/stop-abusing-notimplementederror/ * https://oleg0potapov.medium.com/ruby-notimplementederror-dont-use-it-dff1fd… * https://gitlab.com/gitlab-org/gitlab/-/issues/354314 (which I'm the author of) * https://github.com/rmosolgo/graphql-ruby/issues/2067 (here the author actually confused it with Python's `NotImplementedError`) * https://stackoverflow.com/questions/13668068/how-to-signal-not-implemented-… # Proposal Create `NotImplementedYetError` exception OR Allow raising `NotImplementedError` in cases other than OS or Ruby runtime incompatibilities # Evaluation ### Add `NotImplementedYetError` I think a new exception is a better idea than changing the usage of an existing one just because "everyone is using it". That said it would require people to refactor their code which might prevent wider adoption of the new exception. ### Change scope of `NotImplementedError` This would require the least amount of changes possible (only a documentation change) and I believe there would be no compatibility problems whatsoever. ---Files-------------------------------- not-implemented-error-docs.patch (0 Bytes) not-implemented-error-docs.patch (1.57 KB) -- https://bugs.ruby-lang.org/

2 1

[ruby-core:114935] [Ruby master Bug#18553] Memory leak on compiling method call with kwargs
by peterzhu2118 (Peter Zhu) 02 Oct '23

02 Oct '23

Issue #18553 has been updated by peterzhu2118 (Peter Zhu). Status changed from Open to Closed This was fixed in #19906, so I will close this issue. ---------------------------------------- Bug #18553: Memory leak on compiling method call with kwargs https://bugs.ruby-lang.org/issues/18553#change-104808 * Author: ibylich (Ilya Bylich) * Status: Closed * Priority: Normal * Assignee: ko1 (Koichi Sasada) * ruby -v: ruby 3.2.0dev * Backport: 2.6: UNKNOWN, 2.7: UNKNOWN, 3.0: UNKNOWN, 3.1: UNKNOWN ---------------------------------------- The following code produces a memory leak: ```ruby p(foo: 1) ``` It comes from the allocation in `compile.c`: ```c struct rb_callinfo_kwarg *kw_arg = rb_xmalloc_mul_add(len, sizeof(VALUE), sizeof(struct rb_callinfo_kwarg)); ``` Later it's packed into `struct rb_callinfo`, but `imemo_callinfo` is a GC-managed object that has no `free` calls in `obj_free` function in gc.c. [I've tried to fix it](https://github.com/ruby/ruby/pull/5488/files#diff-d1cee85c3b0e24a64519c… by calling `free` on `callinfo->kwarg` and it fixed leak in `./miniruby -e 'p(foo: 1)'`, but it breaks `make install`. My addition causes a double-free error, looks like either `callinfo` or `callinfo->kwarg` is shared between multiple objects. `kwarg` field is a `const` pointer, so that's somewhat expected (I was under impression that `const` qualifier is redundant) :) I'm pretty sure old versions of Ruby are also affected by this memory leak. -- https://bugs.ruby-lang.org/

2 1

[ruby-core:114937] [Ruby master Feature#18915] New error class: NotImplementedYetError or scope change for NotImplementedError
by zdennis (Zach Dennis) 02 Oct '23

02 Oct '23

Issue #18915 has been updated by zdennis (Zach Dennis). File not-implemented-error-docs.patch added Attached is a patch to update the documentation for NotImplementedError to expand its scope beyond just missing features on the underlying platform. The current documentation has been in place since just before Ruby 1.9.2. Historically, it appears that Ruby hasn't limited its usage of NotImplementedError to errors that originate from features missing from the underlying platform (e.g. system calls) since at least 1.8.0. I believe the example provided in the current NotImplementedError documentation was meant as an example, not to suggest the only scope in which this error can be used. Ruby itself invalidates most of the interpretation provided in the Background section of this ticket. Here are just three examples: - [numeric.c](https://github.com/ruby/ruby/blob/50520cc1930331bccdb94730e17ddc… raises NotImplementedError when a class needs provide its own <=> method. - [delegate.rb](https://github.com/ruby/ruby/blob/c4d22d47f8bd019ae6df98fafb9d… raises NotImplementedError to indicate that a __getobj__ and __setobj__ need to provided by a subclass. - [tsort](https://github.com/ruby/ruby/blob/6dcd39997679914dad1c23f95adb3f7d84… uses this error and documents it expressly as: Should be implemented by a extended class. There are more examples to be found in Ruby as well. Outside of Ruby, this pattern is also commonly used as a way to communicate the intent to an application, framework, or library developer. Here are four examples from popular projects: - [rails uses this pattern](https://github.com/search?q=org%3Arails%20NotImplementedError&type… - [minitest uses this pattern](https://github.com/search?q=repo%3Aminitest%2Fminitest%20NotImplem… - [rspec uses this pattern](https://github.com/search?q=org%3Arspec%20NotImplementedError&type… - [dry-rb libraries use this pattern](https://github.com/search?q=org%3Adry-rb+NotImplementedError&type=… Additionally, even the latest Programming Ruby 3.2 book by PragPub uses an example of this in Chapter 6: Inheritance and Messages. ---------------------------------------- Feature #18915: New error class: NotImplementedYetError or scope change for NotImplementedError https://bugs.ruby-lang.org/issues/18915#change-104811 * Author: Quintasan (Michał Zając) * Status: Open * Priority: Normal ---------------------------------------- # Abstract Introduce `NotImplementedYetError` exception that should be used in case when the codepath has not been implemented by the developer for some reason (maybe they're designing an abstract class or are designing some sort of interface to reuse later on) OR extend the meaning of `NotImplementedError` to cover those usecases so we don't have to introduce another exception # Background `NotImplementedError` is supposed to be raised `if the underlying operating system or Ruby runtime does not support them` (https://ruby-doc.org/core-3.1.2/NotImplementedError.html) However it appears that many people are misusing this exception by raising this in a superclass from which they later inherit from. I do realize that Ruby promotes duck-typing (the default RuboCop style guide has a cop for this – https://github.com/rubocop/ruby-style-guide#duck-typing) However I have seen this being discussed numerous times: * https://github.com/rubocop/ruby-style-guide/issues/458 * http://chrisstump.online/2016/03/23/stop-abusing-notimplementederror/ * https://oleg0potapov.medium.com/ruby-notimplementederror-dont-use-it-dff1fd… * https://gitlab.com/gitlab-org/gitlab/-/issues/354314 (which I'm the author of) * https://github.com/rmosolgo/graphql-ruby/issues/2067 (here the author actually confused it with Python's `NotImplementedError`) * https://stackoverflow.com/questions/13668068/how-to-signal-not-implemented-… # Proposal Create `NotImplementedYetError` exception OR Allow raising `NotImplementedError` in cases other than OS or Ruby runtime incompatibilities # Evaluation ### Add `NotImplementedYetError` I think a new exception is a better idea than changing the usage of an existing one just because "everyone is using it". That said it would require people to refactor their code which might prevent wider adoption of the new exception. ### Change scope of `NotImplementedError` This would require the least amount of changes possible (only a documentation change) and I believe there would be no compatibility problems whatsoever. ---Files-------------------------------- not-implemented-error-docs.patch (0 Bytes) -- https://bugs.ruby-lang.org/

1 0

[ruby-core:114925] [Ruby master Bug#19906] fix kwarg memory leak
by HParker (Adam Hess) 01 Oct '23

01 Oct '23

Issue #19906 has been reported by HParker (Adam Hess). ---------------------------------------- Bug #19906: fix kwarg memory leak https://bugs.ruby-lang.org/issues/19906 * Author: HParker (Adam Hess) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- GitHub PR: https://github.com/ruby/ruby/pull/8556 ci info tracks kwargs and which are shared across aliases ```ruby 30.times do 100_000.times do def foo(k:); yield; end alias bar foo undef foo end puts `ps -o rss= -p #{$$}` end ``` before: ``` 30364 45120 59700 73932 88512 102680 116884 130884 145308 159688 174468 188680 203016 216908 231568 246096 260592 274900 289168 303420 317620 331956 346148 360708 374880 389172 403472 417824 432016 446040 460196 474604 489152 503248 517504 531944 546228 560520 574760 589108 ``` after: ``` 8760 8940 9156 9540 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9548 9556 9564 9564 9564 9564 9564 9564 9564 9564 9564 9564 9564 9564 9576 9744 9744 9744 9744 9744 9936 ``` -- https://bugs.ruby-lang.org/

2 2

[ruby-core:114933] [Ruby master Bug#10416] Create mechanism for updating of Unicode data files downstreams when we want
by nobu (Nobuyoshi Nakada) 01 Oct '23

01 Oct '23

Issue #10416 has been updated by nobu (Nobuyoshi Nakada). The current enc-unicode.rb seems to fail because of `Indic_Conjunct_break` properties with values. I'm not sure how these properties should be handled well. `/\p{InCB_Liner}/` or `/\p{InCB=Liner}/` as the comments in that file? https://github.com/nobu/ruby/tree/unicode-15.1 is the former. ---------------------------------------- Bug #10416: Create mechanism for updating of Unicode data files downstreams when we want https://bugs.ruby-lang.org/issues/10416#change-104804 * Author: duerst (Martin Dürst) * Status: Open * Priority: Normal * Assignee: nobu (Nobuyoshi Nakada) * ruby -v: ruby 2.2.0dev (2014-10-22 trunk 48092) [x86_64-cygwin] * Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN ---------------------------------------- The current mechanism for updating Unicode data files will create the following problem: Downstream compilers/packagers will download Unicode data files ONE time (they may already have done so). However, if they don't activate ALWAYS_UPDATE_UNICODE = yes, these files will never get updated, and they will stay on Unicode version 7.0 even if in five years Unicode is e.g. on version 12.0. On the other hand, if they activate ALWAYS_UPDATE_UNICODE = yes (and assuming issue #10415 gets fixed), they constantly update to the latest version of Unicode. That's good for those who actually want this, but now what our current policy is. What's missing is that we (Ruby core) can make sure downstream checkouts update to a new Unicode version when we want then to do so (as we e.g. can do for other parts that are based on Unicode data, see e.g. https://bugs.ruby-lang.org/issues/9092) without sending an email to everybody and hoping they read and follow it. [Currently, the only solution I know will work is the one pointed out by Yui Naruse in https://bugs.ruby-lang.org/issues/10084#note-17, but I'm okay with any other solution.] -- https://bugs.ruby-lang.org/

1 0

[ruby-core:114475] [Ruby master Bug#19845] `Fiber[key] = value` fails if key is not interned.
by ioquatix (Samuel Williams) 30 Sep '23

30 Sep '23

Issue #19845 has been reported by ioquatix (Samuel Williams). ---------------------------------------- Bug #19845: `Fiber[key] = value` fails if key is not interned. https://bugs.ruby-lang.org/issues/19845 * Author: ioquatix (Samuel Williams) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- See https://github.com/ruby/ruby/pull/8273 for the fix. -- https://bugs.ruby-lang.org/

2 2

[ruby-core:114847] [Ruby master Bug#19896] Ruby method refinement memory leak
by HParker (Adam Hess) 30 Sep '23

30 Sep '23

Issue #19896 has been reported by HParker (Adam Hess). ---------------------------------------- Bug #19896: Ruby method refinement memory leak https://bugs.ruby-lang.org/issues/19896 * Author: HParker (Adam Hess) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- GitHub pull request: https://github.com/ruby/ruby/pull/8487 When method redefinitions happen, sometimes the final definition does not get cleaned up, Reproducable with the same script from: https://bugs.ruby-lang.org/issues/19894 ``` ruby 10.times do 20_000.times do $c = Class.new do def foo; end end $m = Module.new do refine $c do def foo; end end end Class.new do using $m def initialize o = $c.new o.method(:foo).unbind end end.new end puts `ps -o rss= -p #{$$}` end ``` before: ``` 19792 20944 22224 23504 24784 26064 27344 28624 29776 31056 ``` after: ``` 18560 18560 18560 18560 18560 18560 18560 18560 18560 18560 ``` -- https://bugs.ruby-lang.org/

2 1

[ruby-core:114889] [Ruby master Bug#19901] Module clone memory leak
by HParker (Adam Hess) 30 Sep '23

30 Sep '23

Issue #19901 has been reported by HParker (Adam Hess). ---------------------------------------- Bug #19901: Module clone memory leak https://bugs.ruby-lang.org/issues/19901 * Author: HParker (Adam Hess) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- GitHub PR: https://github.com/ruby/ruby/pull/8503 reproduction: ```ruby m = Module.new 20.times do 100_000.times do m.clone end puts `ps -o rss= -p #{$$}` end ``` before: ``` 21544 24708 27860 31024 33928 37360 40264 43432 46600 49768 52936 55840 59008 62176 65344 68512 71680 74584 77752 80920 ``` after: ``` 18808 18808 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 18872 ``` -- https://bugs.ruby-lang.org/

2 1

[ruby-core:114897] [Ruby master Bug#19903] Fix memory leak in generating and loading iseq
by HParker (Adam Hess) 30 Sep '23

30 Sep '23

Issue #19903 has been reported by HParker (Adam Hess). ---------------------------------------- Bug #19903: Fix memory leak in generating and loading iseq https://bugs.ruby-lang.org/issues/19903 * Author: HParker (Adam Hess) * Status: Open * Priority: Normal * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- PR: https://github.com/ruby/ruby/pull/8512 Reproduction: ```ruby 10.times do 100_000.times do RubyVM::InstructionSequence.load_from_binary(RubyVM::InstructionSequence.compile("def foo(bar:); end; foo(bar: :baz)").to_binary) end puts `ps -o rss= -p #{$$}` end ``` before: ``` 39636 60756 82140 103260 124380 145764 166884 188004 209388 230508 ``` after: ``` 25184 31784 38648 45248 51848 58712 65312 71912 78776 85376 ``` -- https://bugs.ruby-lang.org/

2 1

[ruby-core:114181] [Ruby master Bug#19767] [Not really a bug, but more a not ideal notification] "historical binary regexp match" when using the "n" modifier in a ruby regex
by rubyFeedback (robert heiler) 29 Sep '23

29 Sep '23

Issue #19767 has been reported by rubyFeedback (robert heiler). ---------------------------------------- Bug #19767: [Not really a bug, but more a not ideal notification] "historical binary regexp match" when using the "n" modifier in a ruby regex https://bugs.ruby-lang.org/issues/19767 * Author: rubyFeedback (robert heiler) * Status: Open * Priority: Normal * ruby -v: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux] * Backport: 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN ---------------------------------------- To get my knowledge about ruby regexes up-to-date I have been going through this tutorial/book here at: https://learnbyexample.github.io/Ruby_Regexp/unicode.html One example they provide is this, with some odd characters: 'fox:αλεπού'.scan(/\w+/n) This will match the found word ("fox"), but it also reports the following warning: warning: historical binary regexp match /.../n against UTF-8 string Now: this may be obvious to others, but to me personally I am not sure what a "historical" binary regexp match actually is. I assume it may have meant that this was more used in the past, and may be discouraged now? Or is something else meant? What does "historical" mean in this context? I may not be the only one who does not fully understand the term historical. Most of ruby's warnings are fairly easy to understand, but this one seems odd. Right now I do not know whether we can use the "n" modifier in a regex - not that I really have a good use case for it (I am using UTF-8 these days, so I don't seem to need ASCII-8BIT anyway), but perhaps the warning could be changed a little. I have no good alternative suggestion how it can be changed, largely because I do not know what it actually means, e. g. what is "historical" about it (but, even then, I'd actually recommend against using the word "historical" because I don't understand what it means; deprecated is easy to understand, historical does not tell me anything). Perhaps it could be expressed somewhat differently and we could get rid of the word "historical" there? Either way, it's a tiny issue so I was not even sure whether to report it. But, from the point of view of other warnings, I believe the term "historical" does not tell the user enough about what the issue is here. (irb):1: warning: historical binary regexp match /.../n against UTF-8 string => ["fox"] -- https://bugs.ruby-lang.org/

3 2