matrix_sdk 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24a67aeb6af66f75480104c5c0dc44987e2fe54163ed96047da58bf091476752
-  data.tar.gz: e5935a94b430a1b195b55d748415cc0ad95ea649e32f5e97045cc82726dd2bd3
+  metadata.gz: 50821866efab2cbd39daf23bc9ff3bd7864bca5638f76c766a8ba26ab91c7423
+  data.tar.gz: 2601cf5141e824b322f5310e09b72d42059162e1ac87da11243167d2604f1801
 SHA512:
-  metadata.gz: 1ea88ea4c76b573dad7b03aeba49e91b8f7c01040118c38032b49ca00cfbe687bd931c4e17387545e27df529f6ae06fc835ee964b5e79489fb0c5cf84186b35b
-  data.tar.gz: e2a6a5cd78e7629ffb2cc4af5ec9c9154f2f63db570479ebb2c6fa9aff13b7b231bea877d56694ae799019698af8d4a87394f88fa162dcb172dbbd1ede09fc8f
+  metadata.gz: 7bb45dfcb6696b75ed0be95b92fbb3f569b258d4d0456a3cd8ea16fd22d5e3d5050607e6229bfa0e32b84fc0248e554db8f93d48cd970b2ff95475cf0bcfba85
+  data.tar.gz: 58d8524e9d83ef570ca19a41f28758fc129c1a3988ea3522a994e58eaa93c4807850b63a2171423dd69a948738e69468542d56d882ecf98c60e6f8607928b6d1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.6.0 - 2022-07-15
+
+- 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
+- Improves Ruby 3.0+ support
+- Improves debug output by supporting PP (Ruby pretty print) on all MatrixSdk objects
+
 ## 2.5.0 - 2022-01-14
 
 - Adds preliminary support for the Matrix v1.1 `client/v3` API

data/README.md

@@ -8,6 +8,8 @@ Live YARD documentation can be found at; https://ruby-sdk.ananace.dev
 
 ## Example usage
 
+For more fully-featured examples, check the [examples](examples/) folder.
+
 ```ruby
 # Raw API usage
 require 'matrix_sdk'

data/lib/matrix_sdk/api.rb

@@ -19,7 +19,7 @@ module MatrixSdk
     }.freeze
 
     attr_accessor :access_token, :connection_address, :connection_port, :device_id, :autoretry, :global_headers
-    attr_reader :homeserver, :validate_certificate, :open_timeout, :read_timeout, :well_known, :proxy_uri
+    attr_reader :homeserver, :validate_certificate, :open_timeout, :read_timeout, :well_known, :proxy_uri, :threadsafe
 
     ignore_inspect :access_token, :logger
 
@@ -39,7 +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 [Hash] :well_known The .well-known object that the server was discovered through, should not be set manually
+    # @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)
@@ -64,7 +67,8 @@ module MatrixSdk
       @global_headers.merge!(params.fetch(:global_headers)) if params.key? :global_headers
       @synapse = params.fetch(:synapse, true)
       @http = nil
-      @http_lock = Mutex.new
+
+      self.threadsafe = params.fetch(:threadsafe, :multithread)
 
       ([params.fetch(:protocols, [:CS])].flatten - protocols).each do |proto|
         self.class.include MatrixSdk::Protocols.const_get(proto)
@@ -244,6 +248,17 @@ module MatrixSdk
       @proxy_uri = proxy_uri
     end
 
+    # @param [Boolean,:multithread] threadsafe What level of thread-safety the API should use
+    # @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
+      @threadsafe
+    end
+
     # Perform a raw Matrix API request
     #
     # @example Simple API query
@@ -284,15 +299,23 @@ module MatrixSdk
         print_http(req_obj, id: req_id)
         response = duration = nil
 
-        @http_lock.synchronize do
+        loc_http = http
+        perform_request = proc do
           dur_start = Time.now
-          response = http.request req_obj
+          response = loc_http.request req_obj
           dur_end = Time.now
           duration = dur_end - dur_start
         rescue EOFError
           logger.error 'Socket closed unexpectedly'
           raise
         end
+
+        if @threadsafe == true
+          http_lock.synchronize { perform_request.call }
+        else
+          perform_request.call
+          loc_http.finish if @threadsafe == :multithread
+        end
         print_http(response, duration: duration, id: req_id)
 
         begin
@@ -395,18 +418,26 @@ module MatrixSdk
 
       host = (@connection_address || homeserver.host)
       port = (@connection_port || homeserver.port)
-      @http ||= if proxy_uri
-                  Net::HTTP.new(host, port, proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
-                else
-                  Net::HTTP.new(host, port)
-                end
-
-      @http.open_timeout = open_timeout if open_timeout
-      @http.read_timeout = read_timeout if read_timeout
-      @http.use_ssl = homeserver.scheme == 'https'
-      @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_PEER : ::OpenSSL::SSL::VERIFY_NONE
-      @http.start
-      @http
+
+      connection = @http unless @threadsafe == :multithread
+      connection ||= if proxy_uri
+                       Net::HTTP.new(host, port, proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+                     else
+                       Net::HTTP.new(host, port)
+                     end
+
+      connection.open_timeout = open_timeout if open_timeout
+      connection.read_timeout = read_timeout if read_timeout
+      connection.use_ssl = homeserver.scheme == 'https'
+      connection.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_PEER : ::OpenSSL::SSL::VERIFY_NONE
+      connection.start
+      @http = connection unless @threadsafe == :multithread
+
+      connection
+    end
+
+    def http_lock
+      @http_lock ||= Mutex.new if @threadsafe == true
     end
   end
 end

data/lib/matrix_sdk/client.rb

@@ -395,15 +395,16 @@ module MatrixSdk
     # @param only_canonical [Boolean] Only match alias against the canonical alias
     # @return [Room] The found room
     # @return [nil] If no room was found
-    def find_room(room_id_or_alias, only_canonical: false)
+    def find_room(room_id_or_alias, only_canonical: true)
       room_id_or_alias = MXID.new(room_id_or_alias.to_s) unless room_id_or_alias.is_a? MXID
       raise ArgumentError, 'Must be a room id or alias' unless room_id_or_alias.room?
 
       return @rooms.fetch(room_id_or_alias.to_s, nil) if room_id_or_alias.room_id?
 
-      return @rooms.values.find { |r| r.canonical_alias == room_id_or_alias.to_s } if only_canonical
+      room = @rooms.values.find { |r| r.aliases.include? room_id_or_alias.to_s }
+      return room if only_canonical
 
-      @rooms.values.find { |r| r.aliases.include? room_id_or_alias.to_s }
+      room || @rooms.values.find { |r| r.aliases(canonical_only: false).include? room_id_or_alias.to_s }
     end
 
     # Get a User instance from a MXID

data/lib/matrix_sdk/mxid.rb

@@ -12,7 +12,7 @@ module MatrixSdk
 
       # TODO: Community-as-a-Room / Profile-as-a-Room, in case they're going for room aliases
       @sigil = identifier[0]
-      @localpart, @domain, @port = identifier[1..].split(':')
+      @localpart, @domain, @port = identifier[1..-1].split(':') # rubocop:disable Style/SlicingWithRange # Keep support for slightly older Rubies
       @port = @port.to_i if @port
 
       raise ArgumentError, 'Identifier is not a valid MXID' unless valid?

data/lib/matrix_sdk/protocols/cs.rb

@@ -203,7 +203,7 @@ module MatrixSdk::Protocols::CS
     data[:device_id] = device_id if device_id
 
     request(:post, client_api_latest, '/login', body: data, query: query).tap do |resp|
-      @access_token = resp.token if resp.key?(:token) && options[:store_token]
+      @access_token = resp.access_token if resp.key?(:access_token) && options[:store_token]
       @device_id = resp.device_id if resp.key?(:device_id) && options[:store_device_id]
     end
   end
@@ -912,31 +912,23 @@ module MatrixSdk::Protocols::CS
     send_state_event(room_id, 'm.room.avatar', content, **params)
   end
 
-  # Gets a list of current aliases of a room
+  # Gets a list of currently known aliases of a room
   #
   # @param [MXID,String] room_id The room ID to look up
-  # @param [Hash] params Extra options to provide to the request, see #get_room_state
   # @return [Response] A response hash with the array :aliases
-  # @raise [MatrixNotFoundError] Raised if no aliases has been set on the room by the specified HS
-  # @see get_room_state
-  # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-avatar
+  # @raise [MatrixForbiddenError] Raised if the user doesn't have the right to read aliases
+  # @see https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidaliases
   #      The Matrix Spec, for more information about the event and data
   # @example Looking up aliases for a room
   #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org')
-  #   # MatrixSdk::MatrixNotFoundError: HTTP 404 (M_NOT_FOUND): Event not found.
-  #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org', key: 'matrix.org')
   #   # => {:aliases=>["#matrix:matrix.org"]}
-  #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org', key: 'kittenface.studio')
-  #   # => {:aliases=>["#worlddominationhq:kittenface.studio"]}
-  # @example A way to find all aliases for a room
-  #   api.get_room_state('!mjbDjyNsRXndKLkHIe:matrix.org')
-  #      .select { |ch| ch[:type] == 'm.room.aliases' }
-  #      .map { |ch| ch[:content][:aliases] }
-  #      .flatten
-  #      .compact
-  #   # => ["#synapse:im.kabi.tk", "#synapse:matrix.org", "#synapse-community:matrix.org", "#synapse-ops:matrix.org", "#synops:matrix.org", ...
   def get_room_aliases(room_id, **params)
-    get_room_state(room_id, 'm.room.aliases', **params)
+    query = {}
+    query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
+
+    room_id = ERB::Util.url_encode room_id.to_s
+
+    request(:get, client_api_latest, "/rooms/#{room_id}/aliases", query: query)
   end
 
   # Gets a list of pinned events in a room

data/lib/matrix_sdk/protocols/msc.rb

@@ -60,9 +60,9 @@ module MatrixSdk::Protocols::MSC
     # rubocop:disable Metrics/BlockLength
     thread = Thread.new(cancellation_token) do |ctx|
       print_http(req)
-      @http_lock.lock
+      @http_lock&.lock
       http.request req do |response|
-        @http_lock.unlock
+        @http_lock&.unlock
         break unless ctx[:run]
 
         print_http(response, body: false)
@@ -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
 

data/lib/matrix_sdk/room.rb

@@ -31,9 +31,11 @@ module MatrixSdk
     ignore_inspect :client, :events, :prev_batch, :logger, :tinycache_adapter
 
     # Requires heavy lookups, so they're cached for an hour
-    cached :joined_members, :aliases, cache_level: :all, expires_in: 60 * 60
-    # Only cache unfiltered requests for all members
-    cached :all_members, unless: proc { |args| args.any? }, cache_level: :all, expires_in: 3600
+    cached :joined_members, cache_level: :all, expires_in: 60 * 60
+
+    # Only cache unfiltered requests for aliases and members
+    cached :aliases, unless: proc { |args| args.any? }, cache_level: :all, expires_in: 60 * 60
+    cached :all_members, unless: proc { |args| args.any? }, cache_level: :all, expires_in: 60 * 60
 
     # Much simpler to look up, and lighter data-wise, so the cache is wider
     cached :canonical_alias, :name, :avatar_url, :topic, :guest_access, :join_rule, :power_levels, cache_level: :some, expires_in: 15 * 60
@@ -272,15 +274,14 @@ module MatrixSdk
 
     # Gets the room aliases
     #
+    # @param canonical_only [Boolean] Should the list of aliases only contain the canonical ones
     # @return [Array[String]] The assigned room aliases
-    def aliases
-      client.api.get_room_aliases(id).aliases
-    rescue MatrixNotFoundError
-      data = client.api.get_room_state_all(id)
-      data.select { |chunk| chunk[:type] == 'm.room.aliases' && !chunk.dig(*%i[content aliases]).nil? }
-          .map { |chunk| chunk.dig(*%i[content aliases]) }
-          .flatten
-          .compact
+    def aliases(canonical_only: true)
+      canonical = client.api.get_room_state(id, 'm.room.canonical_alias') rescue {}
+      aliases = ([canonical[:alias]].compact + (canonical[:alt_aliases] || [])).uniq.sort
+      return aliases if canonical_only
+
+      (aliases + client.api.get_room_aliases(id).aliases).uniq.sort
     end
 
     #
@@ -904,16 +905,8 @@ module MatrixSdk
 
       data = tinycache_adapter.read(:aliases) || []
       data << canonical_alias
-      tinycache_adapter.write(:aliases, data)
-    end
-
-    def handle_room_aliases(event)
-      tinycache_adapter.write(:aliases, []) unless tinycache_adapter.exist? :aliases
-
-      aliases = tinycache_adapter.read(:aliases) || []
-      aliases.concat(event.dig(*%i[content aliases]))
-
-      tinycache_adapter.write(:aliases, aliases)
+      data += event.dig(*%i[content alt_aliases]) || []
+      tinycache_adapter.write(:aliases, data.uniq.sort)
     end
 
     def room_handlers?
@@ -929,7 +922,6 @@ module MatrixSdk
     end
 
     INTERNAL_HANDLERS = {
-      'm.room.aliases' => :handle_room_aliases,
       'm.room.canonical_alias' => :handle_room_canonical_alias,
       'm.room.guest_access' => :handle_room_guest_access,
       'm.room.join_rules' => :handle_room_join_rules,

data/lib/matrix_sdk/rooms/space.rb

@@ -6,12 +6,12 @@ module MatrixSdk::Rooms
 
     def tree(suggested_only: nil, max_rooms: nil)
       begin
-        data = client.api.request :get, :client_unstable, "/org.matrix.msc2946/rooms/#{id}/spaces", query: {
+        data = client.api.request :get, :client_r0, "/rooms/#{id}/spaces", query: {
           suggested_only: suggested_only,
           max_rooms_per_space: max_rooms
         }.compact
       rescue MatrixRequestError
-        data = client.api.request :get, :client_r0, "/rooms/#{id}/spaces", query: {
+        data = client.api.request :get, :client_unstable, "/org.matrix.msc2946/rooms/#{id}/spaces", query: {
           suggested_only: suggested_only,
           max_rooms_per_space: max_rooms
         }.compact

data/lib/matrix_sdk/user.rb

@@ -132,7 +132,7 @@ module MatrixSdk
 
     # Returns all the current device keys for the user, retrieving them if necessary
     def device_keys
-      @device_keys ||= client.api.keys_query(device_keys: { id => [] }).yield_self do |resp|
+      @device_keys ||= client.api.keys_query(device_keys: { id => [] }).yield_self do |resp| # rubocop:disable Style/ObjectThen # Keep Ruby 2.5 support a little longer
         resp.dig(:device_keys, id.to_sym)
       end
     end

data/lib/matrix_sdk/util/extensions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pp'
+
 unless Object.respond_to? :yield_self
   class Object
     def yield_self
@@ -51,13 +53,20 @@ module MatrixSdk
 
     def ignore_inspect(*symbols)
       class_eval %*
-        def inspect
-          reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
-          "\\\#<\#{self.class} \#{instance_variables
+        include PP::ObjectMixin
+
+        def pretty_print_instance_variables
+          instance_variables
             .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
-            .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
+            .sort
         end
-      *, __FILE__, __LINE__ - 7
+
+        def pretty_print(pp)
+          pp.pp_object(self)
+        end
+
+        alias inspect pretty_print_inspect
+      *, __FILE__, __LINE__ - 14
     end
   end
 

data/lib/matrix_sdk/util/tinycache.rb

@@ -75,13 +75,25 @@ module MatrixSdk::Util
 
         define_method(method_names[:with_cache]) do |*args|
           tinycache_adapter.fetch(__send__(method_names[:cache_key], *args), expires_in: expires_in) do
-            __send__(method_names[:without_cache], *args)
+            named = args.delete_at(-1) if args.last.is_a? Hash
+
+            if named
+              __send__(method_names[:without_cache], *args, **named)
+            else
+              __send__(method_names[:without_cache], *args)
+            end
           end
         end
 
         define_method(method_names[:without_cache]) do |*args|
           orig = method(method_name).super_method
-          orig.call(*args)
+          named = args.delete_at(-1) if args.last.is_a? Hash
+
+          if named
+            orig.call(*args, **named)
+          else
+            orig.call(*args)
+          end
         end
 
         define_method(method_names[:clear_cache]) do |*args|

data/lib/matrix_sdk/util/uri.rb

@@ -7,14 +7,20 @@ module URI
   class MXC < Generic
     def full_path
       select(:host, :port, :path, :query, :fragment)
-        .reject(&:nil?)
+        .compact
         .join
     end
   end
 
-  @@schemes['MXC'] = MXC
+  # TODO: Use +register_scheme+ on Ruby >=3.1 and fall back to old behavior
+  # for older Rubies. May be removed at EOL of Ruby 3.0.
+  if respond_to? :register_scheme
+    register_scheme 'MXC', MXC
+  else
+    @@schemes['MXC'] = MXC
+  end
 
-  unless @@schemes.key? 'MATRIX'
+  unless scheme_list.key? 'MATRIX'
     # A matrix: URI according to MSC2312
     class MATRIX < Generic
       attr_reader :authority, :action, :mxid, :mxid2, :via
@@ -84,6 +90,12 @@ module URI
       end
     end
 
-    @@schemes['MATRIX'] = MATRIX
+    # TODO: Use +register_scheme+ on Ruby >=3.1 and fall back to old behavior
+    # for older Rubies. May be removed at EOL of Ruby 3.0.
+    if respond_to? :register_scheme
+      register_scheme 'MATRIX', MATRIX
+    else
+      @@schemes['MATRIX'] = MATRIX
+    end
   end
 end

data/lib/matrix_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MatrixSdk
-  VERSION = '2.5.0'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: SDK for applications using the Matrix protocol