[GR-19220] Better foreign exception handling (#2706)

PullRequest: truffleruby/3461

Author: eregon

CHANGELOG.md

@@ -13,6 +13,7 @@ Bug fixes:
 * Update `Process` methods to use `module_function` (@bjfish).
 * Fix `File::Stat`'s `#executable?` and `#executable_real?` predicates that unconditionally returned `true` for a superuser (#2690, @andrykonchin).
 * The `strip` option `--keep-section=.llvmbc` is not supported on macOS (#2697, @eregon).
+* Disallow the marshaling of polyglot exceptions since we can't properly reconstruct them (@nirvdrum).
 
 Compatibility:
 
@@ -23,6 +24,7 @@ Compatibility:
 * Fix `IO.pipe` - allow overriding `IO.new` that is used to create new pipes (#2692, @andykonchin).
 * Fix exception message when there are missing or extra keyword arguments - it contains all the missing/extra keywords now (#1522, @andrykonchin).
 * Always terminate native strings with enough `\0` bytes (#2704, @eregon).
+* Support `#dup` and `#clone` on foreign strings (@eregon).
 
 Performance:
 

spec/truffle/interop/polyglot/foreign_exception_spec.rb

@@ -90,6 +90,12 @@
     end
   end
 
+  it 'cannot be marshaled' do
+    -> {
+      Marshal.dump(@foreign)
+    }.should raise_error(TypeError)
+  end
+
   describe "when reaching the top-level" do
     it "is printed like a Ruby exception" do
       out = ruby_exe('raise Truffle::Debug.foreign_exception "main"', args: "2>&1", exit_status: 1, escape: false)

spec/truffle/interop/polyglot/foreign_string_spec.rb

@@ -14,6 +14,7 @@
     @java_string = Truffle::Interop.as_string("abc")
     @truffle_string = Truffle::Interop.as_truffle_string("abc")
     @foreign_string = Truffle::Debug.foreign_string("abc")
+    @all = [@java_character, @java_string, @truffle_string, @foreign_string]
   end
 
   it "are of the expected Java class" do
@@ -99,6 +100,33 @@
     @foreign_string.should == "abc"
   end
 
+  it "supports #+@ and then mutation" do
+    @all.each do |foreign_string|
+      copy = +foreign_string
+      copy << "."
+      copy.should == "#{foreign_string}."
+    end
+  end
+
+  it "supports #dup and then mutation" do
+    @all.each do |foreign_string|
+      copy = foreign_string.dup
+      copy << "."
+      copy.should == "#{foreign_string}."
+    end
+  end
+
+  it "supports #clone and then mutation" do
+    @all.each do |foreign_string|
+      foreign_string.clone.should.frozen?
+      foreign_string.clone(freeze: true).should.frozen?
+
+      copy = foreign_string.clone(freeze: false)
+      copy << "."
+      copy.should == "#{foreign_string}."
+    end
+  end
+
   it "has all Ruby String methods" do
     @java_character.should == "C"
     @java_string.capitalize.should == "Abc"

src/main/ruby/truffleruby/core/truffle/polyglot.rb

@@ -312,6 +312,14 @@ def backtrace_locations
     def backtrace
       backtrace_locations&.map(&:to_s)
     end
+
+    def marshal_dump
+      raise TypeError, "Foreign exception cannot be dumped: #{inspect}"
+    end
+
+    def marshal_load(array)
+      raise TypeError, 'Foreign exception cannot be restored'
+    end
   end
 
   module ExecutableTrait
@@ -525,11 +533,27 @@ def delete(member)
 
   class ForeignObject < Object
     include ObjectTrait
+
+    class << self
+      undef_method :new
+    end
+
+    def self.__allocate__
+      raise TypeError, "allocator undefined for #{self}"
+    end
   end
 
   class ForeignException < Exception # rubocop:disable Lint/InheritException
     include ObjectTrait
     include ExceptionTrait
+
+    class << self
+      undef_method :new
+    end
+
+    def self.__allocate__
+      raise TypeError, "allocator undefined for #{self}"
+    end
   end
   # endregion
 end

src/main/ruby/truffleruby/core/truffle/polyglot_methods.rb

@@ -128,6 +128,10 @@ def clear(...)
       to_s.clear(...)
     end
 
+    def clone(...)
+      to_s.clone(...)
+    end
+
     def codepoints(...)
       to_s.codepoints(...)
     end
@@ -180,6 +184,10 @@ def dump(...)
       to_s.dump(...)
     end
 
+    def dup(...)
+      to_s.dup(...)
+    end
+
     def each_byte(...)
       to_s.each_byte(...)
     end

tool/generate-polyglot-methods.rb

@@ -17,11 +17,13 @@ module Polyglot
   module StringTrait
 RUBY
 
-string_methods = String.public_instance_methods(false).sort
+string_methods = String.public_instance_methods(false)
 # Already implemented
 string_methods -= %i[to_s to_str freeze frozen?]
+# Kernel methods which we want to handle by converting to a Ruby String first
+string_methods += %i[clone dup]
 
-string_methods.each do |name|
+string_methods.sort.each do |name|
   code << <<-RUBY
     def #{name}(...)
       to_s.#{name}(...)