✅ Add TruffleRuby and JRuby to CI

.github/workflows/test.yml

@@ -19,13 +19,14 @@ jobs:
       matrix:
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-        experimental: [false]
-        exclude:
-          - { ruby: head, os: windows-latest }
         include:
-          - { ruby: head, os: windows-latest, experimental: true }
+          - { ruby: head,                                 experimental: true }
+          # - { ruby: jruby,            os: ubuntu-latest,  experimental: true }
+          - { ruby: jruby-head,       os: ubuntu-latest,  experimental: true }
+          # - { ruby: truffleruby,      os: ubuntu-latest,  experimental: true }
+          - { ruby: truffleruby-head, os: ubuntu-latest,  experimental: true }
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
+    continue-on-error: ${{ matrix.experimental || false }}
     timeout-minutes: 15
     steps:
     - uses: actions/checkout@v4
@@ -40,7 +41,8 @@ jobs:
       timeout-minutes: 5 # _should_ finish in under a minute
 
     - uses: joshmfrankel/simplecov-check-action@main
-      if: matrix.os == 'ubuntu-latest' && github.event_name != 'pull_request'
+      if: ${{ matrix.os == 'ubuntu-latest' && github.event_name != 'pull_request' &&
+        !startsWith(matrix.ruby, 'truffleruby') && !startsWith(matrix.ruby, 'jruby') }}
       with:
         check_job_name: "SimpleCov - ${{ matrix.ruby }}"
         minimum_suite_coverage: 90

lib/net/imap.rb

@@ -1116,8 +1116,8 @@ def tls_verified?; @tls_verified end
     #
     # Related: #logout, #logout!
     def disconnect
+      in_logout_state = try_state_logout?
       return if disconnected?
-      state_logout!
       begin
         begin
           # try to call SSL::SSLSocket#io.
@@ -1131,11 +1131,15 @@ def disconnect
       rescue Exception => e
         @receiver_thread.raise(e)
       end
-      @receiver_thread.join
       synchronize do
         @sock.close
       end
+      @receiver_thread.join
       raise e if e
+    ensure
+      # Try again after shutting down the receiver thread.  With no reciever
+      # left to wait for, any remaining locks should be _very_ brief.
+      state_logout! unless in_logout_state
     end
 
     # Returns true if disconnected from the server.
@@ -3062,8 +3066,8 @@ def idle(timeout = nil, &response_handler)
             raise @exception || Net::IMAP::Error.new("connection closed")
           end
         ensure
+          remove_response_handler(response_handler)
           unless @receiver_thread_terminating
-            remove_response_handler(response_handler)
             put_string("DONE#{CRLF}")
             response = get_tagged_response(tag, "IDLE", idle_response_timeout)
           end
@@ -3346,8 +3350,6 @@ def start_receiver_thread
       rescue Exception => ex
         @receiver_thread_exception = ex
         # don't exit the thread with an exception
-      ensure
-        state_logout!
       end
     end
 
@@ -3429,6 +3431,8 @@ def receive_responses
           @idle_done_cond.signal
         end
       end
+    ensure
+      state_logout!
     end
 
     def get_tagged_response(tag, cmd, timeout = nil)
@@ -3791,15 +3795,29 @@ def state_selected!
     end
 
     def state_unselected!
-      state_authenticated! if connection_state.to_sym == :selected
+      synchronize do
+        state_authenticated! if connection_state.to_sym == :selected
+      end
     end
 
     def state_logout!
+      return true if connection_state in [:logout, *]
       synchronize do
+        return true if connection_state in [:logout, *]
         @connection_state = ConnectionState::Logout.new
       end
     end
 
+    # don't wait to aqcuire the lock
+    def try_state_logout?
+      return true if connection_state in [:logout, *]
+      return false unless acquired_lock = mon_try_enter
+      state_logout!
+      true
+    ensure
+      mon_exit if acquired_lock
+    end
+
     def sasl_adapter
       SASLAdapter.new(self, &method(:send_command_with_continuations))
     end

lib/net/imap/data_lite.rb

@@ -24,10 +24,56 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-
 module Net
   class IMAP
-    data_or_object = RUBY_VERSION >= "3.2.0" ? ::Data : Object
+
+    # :nocov:
+    # Skip coverage: how much of the file runs depends on the engine version.
+
+    # Test whether RUBY_ENGINE has sufficient support for ::Data.
+    # TODO: golf this down to the bare minimum that's failing.
+    data_or_object = ::Object
+    if defined?(::Data) && ::Data.respond_to?(:define)
+      begin
+        class TestData < ::Data
+          def self.YAML(data)
+            coder = Struct.new(:map).new(data)
+            data = self.allocate
+            data.init_with(coder)
+            data
+          end
+          def init_with(coder) initialize(**coder.map.transform_keys(&:to_sym)) end
+          def deconstruct; [:ok, *super] end
+        end
+
+        class TestDataDefine < TestData.define(:str, :bool)
+          def initialize(str: nil, bool: nil)
+            str  => String       | nil; str  = -str if str
+            bool => true | false | nil; bool = !!bool
+            super
+          end
+        end
+
+        test_init = TestDataDefine.YAML({"str" => "str"})
+        test_empty = TestData.define[]
+
+        if test_init.deconstruct != [:ok, "str", false]
+          raise "subclassing misbehaves"
+        elsif test_empty.deconstruct != [:ok]
+          raise "can't define empty"
+        end
+        data_or_object = ::Data
+      rescue => ex
+        warn "Insufficient implementation of Data: %s (%s) for %s %s" % [
+          ex, ex.class, RUBY_ENGINE, RUBY_ENGINE_VERSION,
+        ]
+        data_or_object = ::Object
+      ensure
+        remove_const :TestData       if const_defined?(:TestData)
+        remove_const :TestDataDefine if const_defined?(:TestDataDefine)
+      end
+    end
+
     class DataLite < data_or_object
       def encode_with(coder) coder.map = to_h.transform_keys(&:to_s)        end
       def init_with(coder) initialize(**coder.map.transform_keys(&:to_sym)) end
@@ -37,9 +83,7 @@ def init_with(coder) initialize(**coder.map.transform_keys(&:to_sym)) end
   end
 end
 
-# :nocov:
-# Need to skip test coverage for the rest, because it isn't loaded by ruby 3.2+.
-return if RUBY_VERSION >= "3.2.0"
+return unless Net::IMAP::DataLite.superclass == Object
 
 module Net
   class IMAP

test/lib/helper.rb

@@ -1,31 +1,34 @@
-require "simplecov"
-
-# Cannot use ".simplecov" file: simplecov-json triggers a circular require.
-require "simplecov-json"
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::JSONFormatter,
-])
-
-SimpleCov.start do
-  command_name "Net::IMAP tests"
-  enable_coverage  :branch
-  primary_coverage :branch
-  enable_coverage_for_eval
-
-  add_filter "/test/"
-  add_filter "/rakelib/"
-
-  add_group "Parser", %w[lib/net/imap/response_parser.rb
-                         lib/net/imap/response_parser]
-  add_group "Config", %w[lib/net/imap/config.rb
-                         lib/net/imap/config]
-  add_group "SASL", %w[lib/net/imap/sasl.rb
-                       lib/net/imap/sasl
-                       lib/net/imap/authenticators.rb]
-  add_group "StringPrep", %w[lib/net/imap/stringprep.rb
-                             lib/net/imap/stringprep]
+if RUBY_ENGINE == "ruby" # C Ruby only
+  require "simplecov"
+
+  # Cannot use ".simplecov" file: simplecov-json triggers a circular require.
+  require "simplecov-json"
+  SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+  ])
+
+  SimpleCov.start do
+    command_name "Net::IMAP tests"
+    enable_coverage  :branch
+    primary_coverage :branch
+    enable_coverage_for_eval
+
+    add_filter "/test/"
+    add_filter "/rakelib/"
+
+    add_group "Parser", %w[lib/net/imap/response_parser.rb
+                          lib/net/imap/response_parser]
+    add_group "Config", %w[lib/net/imap/config.rb
+                          lib/net/imap/config]
+    add_group "SASL", %w[lib/net/imap/sasl.rb
+                        lib/net/imap/sasl
+                        lib/net/imap/authenticators.rb]
+    add_group "StringPrep", %w[lib/net/imap/stringprep.rb
+                              lib/net/imap/stringprep]
+  end
 end
+
 require "test/unit"
 require "core_assertions"
 
@@ -54,4 +57,44 @@ def assert_pattern
     end
   end
 
+  def pend_if(condition, *args, &block)
+    if condition
+      pend(*args, &block)
+    else
+      block.call if block
+    end
+  end
+
+  def pend_unless(condition, *args, &block)
+    if condition
+      block.call if block
+    else
+      pend(*args, &block)
+    end
+  end
+
+  def omit_unless_cruby(msg = "test omitted for non-CRuby", &block)
+    omit_unless(RUBY_ENGINE == "ruby", msg, &block)
+  end
+
+  def omit_if_truffleruby(msg = "test omitted on TruffleRuby", &block)
+    omit_if(RUBY_ENGINE == "truffleruby", msg, &block)
+  end
+
+  def omit_if_jruby(msg = "test omitted on JRuby", &block)
+    omit_if(RUBY_ENGINE == "jruby", msg, &block)
+  end
+
+  def pend_unless_cruby(msg = "test is pending for non-CRuby", &block)
+    pend_unless(RUBY_ENGINE == "ruby", msg, &block)
+  end
+
+  def pend_if_truffleruby(msg = "test is pending on TruffleRuby", &block)
+    pend_if(RUBY_ENGINE == "truffleruby", msg, &block)
+  end
+
+  def pend_if_jruby(msg = "test is pending on JRuby", &block)
+    pend_if(RUBY_ENGINE == "jruby", msg, &block)
+  end
+
 end

test/net/imap/test_config.rb

@@ -270,10 +270,15 @@ def duck.to_r   = 1/11111
   test "#freeze" do
     config = Config.new(open_timeout: 1)
     config.freeze
-    assert_raise FrozenError do
-      config.open_timeout = 2
+    assert config.frozen?
+    assert config.__send__(:data).frozen?
+    pend_if_truffleruby "https://github.com/oracle/truffleruby/issues/3850" do
+      assert_raise FrozenError do
+        config.open_timeout = 2
+        assert_equal 1, config.open_timeout
+      end
+      assert_equal 1, config.open_timeout
     end
-    assert_same 1, config.open_timeout
   end
 
   test "#dup" do
@@ -302,10 +307,14 @@ def duck.to_r   = 1/11111
     original.freeze
     copy = original.clone
     assert copy.frozen?
-    assert_raise FrozenError do
-      copy.open_timeout = 2
+    assert copy.__send__(:data).frozen?
+    pend_if_truffleruby "https://github.com/oracle/truffleruby/issues/3850" do
+      assert_raise FrozenError do
+        copy.open_timeout = 2
+        assert_equal 1, copy.open_timeout
+      end
+      assert_equal 1, copy.open_timeout
     end
-    assert_equal 1, copy.open_timeout
   end
 
   test "#inherited? and #reset(attr)" do