api: Switch to defaulting threadsafe: :multithread

CHANGELOG.md

 ## **Unreleased**
 
-- Adds some multi-thread usage support to the API (create your API/client with `threadsafe: :multithread`)
+- Adds some multi-thread usage support to the API (create your API/client with `threadsafe: :multithread/true/false`)
+    The API will currently default to running with multi-threaded requests. In case your application is single-threaded - or never performs requests from multiple threads - then you can set `threadsafe: true/false` to support connection reuse.
 - Changes room finding to ignore non-canonical aliases by default
 - Improves room alias handling
 

lib/matrix_sdk/api.rb

@@ -39,9 +39,10 @@ module MatrixSdk
     # @option params [Hash] :global_headers Additional headers to set for all requests
     # @option params [Boolean] :skip_login Should the API skip logging in if the HS URL contains user information
     # @option params [Boolean] :synapse (true) Is the API connecting to a Synapse instance
-    # @option params [Boolean,:multithread] :threadsafe (true/:multithread) Should the connection be threadsafe - or
-    #   even safe for simultaneous multi-thread usage. Will default to +:multithread+ for JRuby, +true+ otherwise.
-    # @note Setting threadsafe to +:multithread+ currently doesn't support connection re-use
+    # @option params [Boolean,:multithread] :threadsafe (:multithread) Should the connection be threadsafe/mutexed - or
+    #   safe for simultaneous multi-thread usage. Will default to +:multithread+ - a.k.a. per-thread HTTP connections
+    #   and requests
+    # @note Using threadsafe +:multithread+ currently doesn't support connection re-use
     def initialize(homeserver, **params)
       @homeserver = homeserver
       raise ArgumentError, 'Homeserver URL must be String or URI' unless @homeserver.is_a?(String) || @homeserver.is_a?(URI)
@@ -67,7 +68,7 @@ module MatrixSdk
       @synapse = params.fetch(:synapse, true)
       @http = nil
 
-      self.threadsafe = params.fetch(:threadsafe, RUBY_ENGINE == 'jruby' ? :multithread : true)
+      self.threadsafe = params.fetch(:threadsafe, :multithread)
 
       ([params.fetch(:protocols, [:CS])].flatten - protocols).each do |proto|
         self.class.include MatrixSdk::Protocols.const_get(proto)
@@ -251,6 +252,7 @@ module MatrixSdk
     # @return [Boolean,:multithread]
     def threadsafe=(threadsafe)
       raise ArgumentError, 'Threadsafe must be either a boolean or :multithread' unless [true, false, :multithread].include? threadsafe
+      raise ArugmentError, 'JRuby only support :multithread/false for threadsafe' if RUBY_ENGINE == 'jruby' && threadsafe == true
 
       @threadsafe = threadsafe
       @http_lock = nil unless threadsafe == true

lib/matrix_sdk/protocols/msc.rb

@@ -136,10 +136,11 @@ module MatrixSdk::Protocols::MSC
             break
           end
         end
+
         break unless ctx[:run]
       end
-    rescue StandardError
-      @http_lock.unlock if @http_lock.owned?
+    ensure
+      @http_lock.unlock if @http_lock&.owned?
     end
     # rubocop:enable Metrics/BlockLength
 

test/api_creation_test.rb

@@ -202,7 +202,7 @@ class ApiTest < Test::Unit::TestCase
     response = Net::HTTPSuccess.new(nil, 200, 'GET')
     response.stubs(:body).returns({ user_id: '@alice:example.com' }.to_json)
 
-    api = MatrixSdk::Api.new 'https://example.com'
+    api = MatrixSdk::Api.new 'https://example.com', threadsafe: false
     http = api.send(:http)
 
     http.expects(:request).returns(response)
@@ -236,7 +236,7 @@ class ApiTest < Test::Unit::TestCase
     assert_equal 5, http.read_timeout
     assert_equal OpenSSL::SSL::VERIFY_PEER, http.verify_mode
 
-    api = MatrixSdk::Api.new 'https://example.com'
+    api = MatrixSdk::Api.new 'https://example.com', threadsafe: false
 
     api.send(:http).expects(:finish).times(4)
 

test/api_cs_protocol_test.rb

@@ -5,7 +5,7 @@ class ApiTest < Test::Unit::TestCase
     @http = mock
     @http.stubs(:active?).returns(true)
 
-    @api = MatrixSdk::Api.new 'https://example.com', protocols: :CS
+    @api = MatrixSdk::Api.new 'https://example.com', protocols: :CS, threadsafe: false
     @api.instance_variable_set :@http, @http
     @api.stubs(:print_http)
 

test/api_cs_protocol_verification_test.rb

@@ -5,7 +5,7 @@ class ApiCSVerificationTest < Test::Unit::TestCase
     @http = mock
     @http.stubs(:active?).returns(true)
 
-    @api = MatrixSdk::Api.new 'https://example.com', protocols: :CS, autoretry: false
+    @api = MatrixSdk::Api.new 'https://example.com', protocols: :CS, autoretry: false, threadsafe: false
     @api.instance_variable_set :@http, @http
     @api.stubs(:print_http)
 

test/api_ss_protocol_test.rb

@@ -5,7 +5,7 @@ class ApiSSTest < Test::Unit::TestCase
     @http = mock
     @http.stubs(:active?).returns(true)
 
-    @api = MatrixSdk::Api.new 'https://example.com', protocols: :SS
+    @api = MatrixSdk::Api.new 'https://example.com', protocols: :SS, threadsafe: false
     @api.instance_variable_set :@http, @http
     @api.stubs(:print_http)
   end