matrix_sdk 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7db96470aa545490e2dc289243a1c133a708548e334748fee72cfa1bdba68543
-  data.tar.gz: 863bf01f82c86e9a6329bb505c727a872bf2f2b7b5dd8f51fbc633d74675d8b6
+  metadata.gz: fd493a721423c1f1a7da7b2ff678ad8e1a949f258fe613616ebedab39d5ae204
+  data.tar.gz: 52e6563d1dbb42cd5acddf3809df720fb6ecc5b6f49cbdc14606450e908c32c6
 SHA512:
-  metadata.gz: f529e7679bd36fcad10184795d78f5dd0a72b0a496fe5f3a10d976d3a33e033cf2367ffb01b68bca3e0844ed91f496921a28e2ef7b20a5bd9589c21bb28a321e
-  data.tar.gz: e32d7dcbff2eac544e25f5c7598ac5f743e60dab8eac6394d1054a118882b0efdb3a69dca8ac93d1fae6ed6cf5912d6576156c3dcc9541c0b8b37bc6f9507600
+  metadata.gz: 1fa0a6cbae2b6fa8ab91961df79082017be6a50028cc7b318ad70a5be9c76b8488b4b24cbef5e5a768ac34076236430683d518c18fccb296290599427bd71095
+  data.tar.gz: f62ad6791ee5f3921869d2431e55e3a1f44501af1b8c966a957fbcacbcaf809edb2e47b8d8b65d1393c268ff58b19e21fc966b1660c671d4d257121bf832dadf

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.8.0 - 2022-08-19
+
+- Drops support for EoL Ruby 2.6
+- Adds helpers for accessing room state
+- Fixes Client#sync_token usage
+- Improves caching of state events in rooms
+
 ## 2.7.0 - 2022-08-12
 
 - Adds a bot subsystem + DSL 

data/lib/matrix_sdk/bot/base.rb

@@ -47,11 +47,15 @@ module MatrixSdk::Bot
         client.join_room(ev[:room_id])
       end
 
+      @event = nil
+
       logger.warn 'The bot abstraction is not fully finalized and can be expected to change.'
     end
 
     def logger
-      @logger || self.class.logger
+      return @logger if instance_variable_defined?(:@logger) && @logger
+
+      self.class.logger
     end
 
     def self.logger

data/lib/matrix_sdk/client.rb

@@ -21,8 +21,8 @@ module MatrixSdk
     # @!attribute sync_filter [rw] The global sync filter
     #   @return [Hash,String] A filter definition, either as defined by the
     #           Matrix spec, or as an identifier returned by a filter creation request
-    attr_reader :api, :next_batch
-    attr_accessor :cache, :sync_filter, :sync_token
+    attr_reader :api
+    attr_accessor :cache, :sync_filter, :next_batch
 
     events :error, :event, :account_data, :presence_event, :invite_event, :leave_event, :ephemeral_event, :state_event
     ignore_inspect :api,
@@ -75,7 +75,6 @@ module MatrixSdk
       @identity_server = nil
       @mxid = nil
 
-      @sync_token = nil
       @sync_thread = nil
       @sync_filter = { room: { timeline: { limit: params.fetch(:sync_filter_limit, 20) }, state: { lazy_load_members: true } } }
 
@@ -99,6 +98,9 @@ module MatrixSdk
       @mxid = params[:user_id]
     end
 
+    alias sync_token next_batch
+    alias sync_token= next_batch=
+
     # Gets the currently logged in user's MXID
     #
     # @return [MXID] The MXID of the current user
@@ -684,6 +686,7 @@ module MatrixSdk
           # TODO Run this in a thread?
           room.tinycache_adapter.cleanup
           room.account_data.tinycache_adapter.cleanup
+          room.room_state.tinycache_adapter.cleanup
         end
       end
 

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..-1].split(':') # rubocop:disable Style/SlicingWithRange # Keep support for slightly older Rubies
+      @localpart, @domain, @port = identifier[1..].split(':')
       @port = @port.to_i if @port
 
       raise ArgumentError, 'Identifier is not a valid MXID' unless valid?

data/lib/matrix_sdk/protocols/cs.rb

@@ -519,6 +519,8 @@ module MatrixSdk::Protocols::CS
     request(:put, client_api_latest, "/rooms/#{room_id}/state/#{event_type}#{"/#{state_key}" unless state_key.nil?}", body: content, query: query)
   end
 
+  alias set_room_state send_state_event
+
   # Sends a message event to a room
   # @param room_id [MXID,String] The room ID to send the message event to
   # @param event_type [String] The event type of the message

data/lib/matrix_sdk/room.rb

@@ -37,9 +37,6 @@ module MatrixSdk
     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
-
     alias room_id id
     alias members joined_members
 
@@ -84,6 +81,12 @@ module MatrixSdk
 
       @prev_batch = nil
 
+      %i[name topic canonical_alias avatar_url].each do |type|
+        room_state.tinycache_adapter.write("m.room.#{type}", { type => data.delete(type) }) if data.key? type
+      end
+      room_state.tinycache_adapter.write('m.room.join_rules', { join_rule: data.delete(:join_rule) }) if data.key? :join_rule
+      room_state.tinycache_adapter.write('m.room.history_visibility', { history_visibility: data.delete(:world_readable) ? :world_readable : nil }) if data.key? :world_readable
+
       data.each do |k, v|
         next if %i[client].include? k
 
@@ -175,7 +178,7 @@ module MatrixSdk
 
     # @return [String, nil] the canonical alias of the room
     def canonical_alias
-      client.api.get_room_state(id, 'm.room.canonical_alias')[:alias]
+      get_state('m.room.canonical_alias')[:alias]
     rescue MatrixSdk::MatrixNotFoundError
       nil
     end
@@ -208,7 +211,7 @@ module MatrixSdk
     #
     # @return [String,nil] The room name - if any
     def name
-      client.api.get_room_name(id)[:name]
+      get_state('m.room.name')[:name]
     rescue MatrixNotFoundError
       # No room name has been specified
       nil
@@ -244,7 +247,7 @@ module MatrixSdk
     #
     # @return [String,nil] The avatar URL - if any
     def avatar_url
-      client.api.get_room_avatar(id)[:url]
+      get_state('m.room.avatar_url')[:url]
     rescue MatrixNotFoundError
       # No avatar has been set
       nil
@@ -254,7 +257,7 @@ module MatrixSdk
     #
     # @return [String,nil] The topic of the room
     def topic
-      client.api.get_room_topic(id)[:topic]
+      get_state('m.room.topic')[:topic]
     rescue MatrixNotFoundError
       # No room name has been specified
       nil
@@ -264,14 +267,14 @@ module MatrixSdk
     #
     # @return [:can_join,:forbidden] The current guest access right
     def guest_access
-      client.api.get_room_guest_access(id)[:guest_access]&.to_sym
+      get_state('m.room.guest_access')[:guest_access]&.to_sym
     end
 
     # Gets the join rule for the room
     #
     # @return [:public,:knock,:invite,:private] The current join rule
     def join_rule
-      client.api.get_room_join_rules(id)[:join_rule]&.to_sym
+      get_state('m.room.join_rules')[:join_rule]&.to_sym
     end
 
     # Checks if +guest_access+ is set to +:can_join+
@@ -289,11 +292,27 @@ module MatrixSdk
       join_rule == :knock
     end
 
+    def room_state
+      return MatrixSdk::Util::StateEventCache.new self if client.cache == :none
+
+      @room_state ||= MatrixSdk::Util::StateEventCache.new self
+    end
+
+    # Gets a state object in the room
+    def get_state(type, state_key: nil)
+      room_state[type, state_key]
+    end
+
+    # Sets a state object in the room
+    def set_state(type, data, state_key: nil)
+      room_state[type, state_key] = data
+    end
+
     # Gets the history visibility of the room
     #
     # @return [:invited,:joined,:shared,:world_readable] The current history visibility for the room
     def history_visibility
-      client.api.get_room_state(id, 'm.room.history_visibility')[:history_visibility]&.to_sym
+      get_state('m.room.history_visibility')[:history_visibility]&.to_sym
     end
 
     # Checks if the room history is world readable
@@ -309,7 +328,7 @@ module MatrixSdk
     # @param canonical_only [Boolean] Should the list of aliases only contain the canonical ones
     # @return [Array[String]] The assigned room aliases
     def aliases(canonical_only: true)
-      canonical = client.api.get_room_state(id, 'm.room.canonical_alias') rescue {}
+      canonical = get_state('m.room.canonical_alias') rescue {}
       aliases = ([canonical[:alias]].compact + (canonical[:alt_aliases] || [])).uniq.sort
       return aliases if canonical_only
 
@@ -598,8 +617,7 @@ module MatrixSdk
     #
     # @return [Response] The content of the m.room.create event
     def creation_info
-      # Not caching here, easier to cache the important values separately instead
-      client.api.get_room_creation_info(id)
+      room_state['m.room.create']
     end
 
     # Retrieves the type of the room
@@ -607,9 +625,6 @@ module MatrixSdk
     # @return ['m.space',String,nil] The type of the room
     def room_type
       # Can't change, so a permanent cache is ok
-      return @room_type if @room_type_retrieved || @room_type
-
-      @room_type_retrieved = true
       @room_type ||= creation_info[:type]
     end
 
@@ -617,6 +632,7 @@ module MatrixSdk
     #
     # @return [String] The version of the room
     def room_version
+      # Can't change, so a permanent cache is ok
       @room_version ||= creation_info[:room_version]
     end
 
@@ -691,8 +707,7 @@ module MatrixSdk
     #
     # @param name [String] The new name to set
     def name=(name)
-      tinycache_adapter.write(:name, name)
-      client.api.set_room_name(id, name)
+      room_state['m.room.name'] = { name: name }
       name
     end
 
@@ -700,7 +715,7 @@ module MatrixSdk
     #
     # @return [Boolean] if the name was changed or not
     def reload_name!
-      clear_name_cache
+      room_state.expire('m.room.name')
     end
     alias refresh_name! reload_name!
 
@@ -708,8 +723,7 @@ module MatrixSdk
     #
     # @param topic [String] The new topic to set
     def topic=(topic)
-      tinycache_adapter.write(:topic, topic)
-      client.api.set_room_topic(id, topic)
+      room_state['m.room.topic'] = { topic: topic }
       topic
     end
 
@@ -717,7 +731,7 @@ module MatrixSdk
     #
     # @return [Boolean] if the topic was changed or not
     def reload_topic!
-      clear_topic_cache
+      room_state.expire('m.room.topic')
     end
     alias refresh_topic! reload_topic!
 
@@ -736,6 +750,7 @@ module MatrixSdk
     # @note The list of aliases is not sorted, ordering changes will result in
     #       alias list updates.
     def reload_aliases!
+      room_state.expire('m.room.canonical_alias')
       clear_aliases_cache
     end
     alias refresh_aliases! reload_aliases!
@@ -752,8 +767,7 @@ module MatrixSdk
     #
     # @param join_rule [:invite,:public] The join rule of the room
     def join_rule=(join_rule)
-      client.api.set_room_join_rules(id, join_rule)
-      tinycache_adapter.write(:join_rule, join_rule)
+      room_state['m.room.join_rules'] = { join_rule: join_rule }
       join_rule
     end
 
@@ -769,8 +783,7 @@ module MatrixSdk
     #
     # @param guest_access [:can_join,:forbidden] The new guest access status of the room
     def guest_access=(guest_access)
-      client.api.set_room_guest_access(id, guest_access)
-      tinycache_adapter.write(:guest_access, guest_access)
+      room_state['m.room.guest_access'] = { guest_access: guest_access }
       guest_access
     end
 
@@ -781,8 +794,7 @@ module MatrixSdk
       avatar_url = URI(avatar_url) unless avatar_url.is_a? URI
       raise ArgumentError, 'Must be a valid MXC URL' unless avatar_url.is_a? URI::MXC
 
-      client.api.set_room_avatar(id, avatar_url)
-      tinycache_adapter.write(:avatar_url, avatar_url)
+      room_state['m.room.avatar_url'] = { avatar_url: avatar_url }
       avatar_url
     end
 
@@ -792,7 +804,7 @@ module MatrixSdk
     # @return [Hash] The current power levels as set for the room
     # @see Protocols::CS#get_power_levels
     def power_levels
-      client.api.get_power_levels(id)
+      get_state('m.room.power_levels')
     end
 
     # Gets the power level of a user in the room
@@ -889,8 +901,9 @@ module MatrixSdk
     def modify_user_power_levels(users = nil, users_default = nil)
       return false if users.nil? && users_default.nil?
 
-      data = power_levels_without_cache
-      tinycache_adapter.write(:power_levels, data)
+      room_state.tinycache_adapter.expire 'm.room.power_levels'
+
+      data = power_levels
       data[:users_default] = users_default unless users_default.nil?
 
       if users
@@ -908,7 +921,7 @@ module MatrixSdk
         end
       end
 
-      client.api.set_power_levels(id, data)
+      room_state['m.room.power_levels'] = data
       true
     end
 
@@ -920,8 +933,9 @@ module MatrixSdk
     def modify_required_power_levels(events = nil, params = {})
       return false if events.nil? && (params.nil? || params.empty?)
 
-      data = power_levels_without_cache
-      tinycache_adapter.write(:power_levels, data)
+      room_state.tinycache_adapter.expire 'm.room.power_levels'
+
+      data = power_levels
       data.merge!(params)
       data.delete_if { |_k, v| v.nil? }
 
@@ -931,7 +945,7 @@ module MatrixSdk
         data[:events].delete_if { |_k, v| v.nil? }
       end
 
-      client.api.set_power_levels(id, data)
+      room_state['m.room.power_levels'] = data
       true
     end
 
@@ -948,26 +962,6 @@ module MatrixSdk
       tinycache_adapter.write(:joined_members, members)
     end
 
-    def handle_power_levels(event)
-      tinycache_adapter.write(:power_levels, event[:content])
-    end
-
-    def handle_room_name(event)
-      tinycache_adapter.write(:name, event.dig(*%i[content name]))
-    end
-
-    def handle_room_topic(event)
-      tinycache_adapter.write(:topic, event.dig(*%i[content topic]))
-    end
-
-    def handle_room_guest_access(event)
-      tinycache_adapter.write(:guest_access, event.dig(*%i[content guest_access])&.to_sym)
-    end
-
-    def handle_room_join_rules(event)
-      tinycache_adapter.write(:join_rule, event.dig(*%i[content join_rule])&.to_sym)
-    end
-
     def handle_room_member(event)
       return unless client.cache == :all
 
@@ -982,7 +976,8 @@ module MatrixSdk
     end
 
     def handle_room_canonical_alias(event)
-      canonical_alias = tinycache_adapter.write(:canonical_alias, event.dig(*%i[content alias]))
+      room_state.tinycache_adapter.write('m.room.canonical_alias', event[:content], expires_in: room_state.cache_time)
+      canonical_alias = event.dig(*%i[content alias])
 
       data = tinycache_adapter.read(:aliases) || []
       data << canonical_alias
@@ -1003,16 +998,6 @@ module MatrixSdk
       }
     end
 
-    INTERNAL_HANDLERS = {
-      'm.room.canonical_alias' => :handle_room_canonical_alias,
-      'm.room.guest_access' => :handle_room_guest_access,
-      'm.room.join_rules' => :handle_room_join_rules,
-      'm.room.member' => :handle_room_member,
-      'm.room.name' => :handle_room_name,
-      'm.room.power_levels' => :handle_power_levels,
-      'm.room.topic' => :handle_room_topic
-    }.freeze
-
     def put_event(event)
       ensure_room_handlers[:event].fire(MatrixEvent.new(self, event), event[:type]) if room_handlers?
 
@@ -1037,8 +1022,20 @@ module MatrixSdk
       ensure_room_handlers[:ephemeral_event].fire(MatrixEvent.new(self, event), event[:type])
     end
 
+    INTERNAL_HANDLERS = {
+      'm.room.canonical_alias' => :handle_room_canonical_alias,
+      'm.room.member' => :handle_room_member
+    }.freeze
+
     def put_state_event(event)
-      send(INTERNAL_HANDLERS[event[:type]], event) if INTERNAL_HANDLERS.key? event[:type]
+      if INTERNAL_HANDLERS.key? event[:type]
+        send(INTERNAL_HANDLERS[event[:type]], event)
+      elsif client.cache != :none
+        adapter = room_state.tinycache_adapter
+        key = event[:type]
+        key += "|#{event[:state_key]}" unless event[:state_key].nil? || event[:state_key].empty?
+        adapter.write(key, event[:content], expires_in: room_state.cache_time)
+      end
 
       return unless room_handlers?
 

data/lib/matrix_sdk/util/state_event_cache.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module MatrixSdk::Util
+  class StateEventCache
+    extend MatrixSdk::Extensions
+    extend MatrixSdk::Util::Tinycache
+    include Enumerable
+
+    attr_reader :room
+
+    attr_accessor :cache_time
+
+    ignore_inspect :client, :room, :tinycache_adapter
+
+    def initialize(room, cache_time: 30 * 60, **_params)
+      raise ArgumentError, 'Must be given a Room instance' unless room.is_a? MatrixSdk::Room
+
+      @room = room
+      @cache_time = cache_time
+    end
+
+    def client
+      @room.client
+    end
+
+    def reload!
+      tinycache_adapter.clear
+    end
+
+    def keys
+      tinycache_adapter.send(:cache).keys.map do |type|
+        real_type = type.split('|').first
+        state_key = type.split('|').last
+        state_key = nil if state_key == real_type
+
+        [real_type, state_key]
+      end
+    end
+
+    def values
+      keys.map { |key| tinycache_adapter.read(key) }
+    end
+
+    def size
+      keys.count
+    end
+
+    def key?(type, key = nil)
+      keys.key?("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def expire(type, key = nil)
+      tinycache_adapter.expire("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def each(live: false)
+      return to_enum(__method__, live: live) { keys.count } unless block_given?
+
+      keys.each do |type|
+        real_type = type.split('|').first
+        state_key = type.split('|').last
+        state_key = nil if state_key == real_type
+
+        v = live ? self[real_type, key: state_key] : tinycache_adapter.read(type)
+        # hash = v.hash
+        yield [real_type, state_key], v
+        # self[key] = v if hash != v.hash
+      end
+    end
+
+    def delete(type, key = nil)
+      type = type.to_s unless type.is_a? String
+      client.api.set_room_state(room.id, type, {}, **{ state_key: key }.compact)
+      tinycache_adapter.delete("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def [](type, key = nil)
+      type = type.to_s unless type.is_a? String
+      tinycache_adapter.fetch("#{type}#{key ? "|#{key}" : ''}", expires_in: @cache_time) do
+        client.api.get_room_state(room.id, type, **{ key: key }.compact)
+      rescue MatrixSdk::MatrixNotFoundError
+        {}
+      end
+    end
+
+    def []=(type, key = nil, value) # rubocop:disable Style/OptionalArguments Not possible to put optional last
+      type = type.to_s unless type.is_a? String
+      client.api.set_room_state(room.id, type, value, **{ state_key: key }.compact)
+      tinycache_adapter.write("#{type}#{key ? "|#{key}" : ''}", value)
+    end
+  end
+end

data/lib/matrix_sdk/util/tinycache.rb

@@ -76,24 +76,18 @@ 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
             named = args.delete_at(-1) if args.last.is_a? Hash
+            named ||= {}
 
-            if named
-              __send__(method_names[:without_cache], *args, **named)
-            else
-              __send__(method_names[:without_cache], *args)
-            end
+            __send__(method_names[:without_cache], *args, **named)
           end
         end
 
         define_method(method_names[:without_cache]) do |*args|
           orig = method(method_name).super_method
           named = args.delete_at(-1) if args.last.is_a? Hash
+          named ||= {}
 
-          if named
-            orig.call(*args, **named)
-          else
-            orig.call(*args)
-          end
+          orig.call(*args, **named)
         end
 
         define_method(method_names[:clear_cache]) do |*args|

data/lib/matrix_sdk/util/tinycache_adapter.rb

@@ -58,6 +58,12 @@ module MatrixSdk::Util
       true
     end
 
+    def expire(key)
+      return unless exist? key
+
+      cache[key].expires_at = Time.at(0)
+    end
+
     def clear
       @cache = {}
     end

data/lib/matrix_sdk/version.rb

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

data/lib/matrix_sdk.rb

@@ -38,6 +38,7 @@ module MatrixSdk
 
   module Util
     autoload :AccountDataCache, 'matrix_sdk/util/account_data_cache'
+    autoload :StateEventCache, 'matrix_sdk/util/state_event_cache'
     autoload :Tinycache, 'matrix_sdk/util/tinycache'
     autoload :TinycacheAdapter, 'matrix_sdk/util/tinycache_adapter'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -113,6 +113,7 @@ files:
 - lib/matrix_sdk/util/account_data_cache.rb
 - lib/matrix_sdk/util/events.rb
 - lib/matrix_sdk/util/extensions.rb
+- lib/matrix_sdk/util/state_event_cache.rb
 - lib/matrix_sdk/util/tinycache.rb
 - lib/matrix_sdk/util/tinycache_adapter.rb
 - lib/matrix_sdk/util/uri.rb