matrix_sdk 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af1e7af0f473a5c44df1ede83655cdbdb120e215e42f125b6af576740b88aa6
-  data.tar.gz: cca80fe97ca22f0ddb0c5a2b39b24b70345baa25fb20bea305fa019f46ca7d3a
+  metadata.gz: 550080056a38ee354ff8e633069d71f207e1927a567fcaed4f7ed9792bcbb79a
+  data.tar.gz: ae8909f5a1092873453c4b7a876315efd29882cee353252d9bd92f069ce3c4ac
 SHA512:
-  metadata.gz: 0e4c694d8489dae1b2602d01f4aab08b20119c6697e83b41a2a463adb7ebcaf7b1afd439db04a6e54a0979c5a93be865c8afa3d2d03b4ca34b98f82afae87a5f
-  data.tar.gz: 8f52c12d1eb8af55ac5bc011852c9d5f648e9de1cc3241ea1ed76530036b02cff373cb69b8a4c721956add3df1359377d79b2fa2562e8dab8efe5ce877596e2d
+  metadata.gz: 5838b47c8ea7df7becdb7dadcb07e57c31526c8c3cdd025a18cc2add7db9e9da9f0aff62a16ed4a3a5306566785f941e7cdba90e664f2b872959c7774b4ec4bc
+  data.tar.gz: 3fcad5ea834b2dd0e6d68e55a8e88e5a88b444d07491f381420c4749ca1ff5375030f3a7c4b1b535ff947422caf7c4b86f81633d425614a05e5577aa9a4963ff

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.1.3 - 2020-09-18
+
+- Adds separate state event handler as Client#on_state_event
+- Changes Client sync interval to by-default run at full speed
+- Fixes state events being sent twice if included in both timeline and state of a sync
+- Improves error reporting of broken 200 responses
+- Improves event handlers for rooms, to not depend on a specific room object instance anymore
+
 ## 2.1.2 - 2020-09-10
 
 - Adds method for reading complete member lists for rooms, improves the CS spec adherence

data/lib/matrix_sdk/api.rb

@@ -101,30 +101,30 @@ module MatrixSdk
       elsif target == :server
         # Attempt SRV record discovery
         target_uri = begin
-                       require 'resolv'
-                       resolver = Resolv::DNS.new
-                       srv = "_matrix._tcp.#{domain}"
-                       logger.debug "Trying DNS #{srv}..."
-                       d = resolver.getresource(srv, Resolv::DNS::Resource::IN::SRV)
-                       d
-                     rescue StandardError => e
-                       logger.debug "DNS lookup failed with #{e.class}: #{e.message}"
-                       nil
-                     end
+          require 'resolv'
+          resolver = Resolv::DNS.new
+          srv = "_matrix._tcp.#{domain}"
+          logger.debug "Trying DNS #{srv}..."
+          d = resolver.getresource(srv, Resolv::DNS::Resource::IN::SRV)
+          d
+        rescue StandardError => e
+          logger.debug "DNS lookup failed with #{e.class}: #{e.message}"
+          nil
+        end
 
         if target_uri.nil?
           # Attempt .well-known discovery for server-to-server
           well_known = begin
-                         wk_uri = URI("https://#{domain}/.well-known/matrix/server")
-                         logger.debug "Trying #{wk_uri}..."
-                         data = Net::HTTP.start(wk_uri.host, wk_uri.port, use_ssl: true, open_timeout: 5, read_timeout: 5, write_timeout: 5) do |http|
-                           http.get(wk_uri.path).body
-                         end
-                         JSON.parse(data)
-                       rescue StandardError => e
-                         logger.debug "Well-known failed with #{e.class}: #{e.message}"
-                         nil
-                       end
+            wk_uri = URI("https://#{domain}/.well-known/matrix/server")
+            logger.debug "Trying #{wk_uri}..."
+            data = Net::HTTP.start(wk_uri.host, wk_uri.port, use_ssl: true, open_timeout: 5, read_timeout: 5, write_timeout: 5) do |http|
+              http.get(wk_uri.path).body
+            end
+            JSON.parse(data)
+          rescue StandardError => e
+            logger.debug "Well-known failed with #{e.class}: #{e.message}"
+            nil
+          end
 
           target_uri = well_known['m.server'] if well_known&.key?('m.server')
         else
@@ -133,16 +133,16 @@ module MatrixSdk
       elsif %i[client identity].include? target
         # Attempt .well-known discovery
         well_known = begin
-                       wk_uri = URI("https://#{domain}/.well-known/matrix/client")
-                       logger.debug "Trying #{wk_uri}..."
-                       data = Net::HTTP.start(wk_uri.host, wk_uri.port, use_ssl: true, open_timeout: 5, read_timeout: 5, write_timeout: 5) do |http|
-                         http.get(wk_uri.path).body
-                       end
-                       data = JSON.parse(data)
-                     rescue StandardError => e
-                       logger.debug "Well-known failed with #{e.class}: #{e.message}"
-                       nil
-                     end
+          wk_uri = URI("https://#{domain}/.well-known/matrix/client")
+          logger.debug "Trying #{wk_uri}..."
+          data = Net::HTTP.start(wk_uri.host, wk_uri.port, use_ssl: true, open_timeout: 5, read_timeout: 5, write_timeout: 5) do |http|
+            http.get(wk_uri.path).body
+          end
+          JSON.parse(data)
+        rescue StandardError => e
+          logger.debug "Well-known failed with #{e.class}: #{e.message}"
+          nil
+        end
 
         if well_known
           key = 'm.homeserver'
@@ -304,7 +304,12 @@ module MatrixSdk
         end
         print_http(response, duration: duration, id: req_id)
 
-        data = JSON.parse(response.body, symbolize_names: true) rescue nil
+        begin
+          data = JSON.parse(response.body, symbolize_names: true)
+        rescue JSON::JSONError => e
+          logger.debug "#{e.class} error when parsing response. #{e}"
+          data = nil
+        end
 
         if response.is_a? Net::HTTPTooManyRequests
           raise MatrixRequestError.new_by_code(data, response.code) unless autoretry
@@ -315,7 +320,13 @@ module MatrixSdk
           next
         end
 
-        return MatrixSdk::Response.new self, data if response.is_a? Net::HTTPSuccess
+        if response.is_a? Net::HTTPSuccess
+          unless data
+            logger.error "Received non-parsable data in 200 response; #{response.body.inspect}"
+            raise MatrixConnectionError, response
+          end
+          return MatrixSdk::Response.new self, data
+        end
         raise MatrixRequestError.new_by_code(data, response.code) if data
 
         raise MatrixConnectionError.class_by_code(response.code), response

data/lib/matrix_sdk/client.rb

@@ -23,7 +23,7 @@ module MatrixSdk
     attr_reader :api, :next_batch
     attr_accessor :cache, :sync_filter
 
-    events :error, :event, :presence_event, :invite_event, :leave_event, :ephemeral_event
+    events :error, :event, :presence_event, :invite_event, :leave_event, :ephemeral_event, :state_event
     ignore_inspect :api,
                    :on_event, :on_presence_event, :on_invite_event, :on_leave_event, :on_ephemeral_event
 
@@ -70,8 +70,6 @@ module MatrixSdk
         @api = Api.new hs_url, params
       end
 
-      @rooms = {}
-      @users = {}
       @cache = client_cache
       @identity_server = nil
 
@@ -79,7 +77,6 @@ module MatrixSdk
       @sync_thread = nil
       @sync_filter = { room: { timeline: { limit: params.fetch(:sync_filter_limit, 20) }, state: { lazy_load_members: true } } }
 
-      @should_listen = false
       @next_batch = nil
 
       @bad_sync_timeout_limit = 60 * 60
@@ -88,6 +85,11 @@ module MatrixSdk
         instance_variable_set("@#{k}", v) if instance_variable_defined? "@#{k}"
       end
 
+      @rooms = {}
+      @room_handlers = {}
+      @users = {}
+      @should_listen = false
+
       raise ArgumentError, 'Cache value must be one of of [:all, :some, :none]' unless %i[all some none].include? @cache
 
       return unless params[:user_id]
@@ -524,7 +526,7 @@ module MatrixSdk
       end
     end
 
-    def listen_forever(timeout: 30, bad_sync_timeout: 5, sync_interval: 30, **params)
+    def listen_forever(timeout: 30, bad_sync_timeout: 5, sync_interval: 0, **params)
       orig_bad_sync_timeout = bad_sync_timeout + 0
       while @should_listen
         begin
@@ -560,6 +562,8 @@ module MatrixSdk
     def handle_state(room_id, state_event)
       return unless state_event.key? :type
 
+      on_state_event.fire(MatrixEvent.new(self, state_event), state_event[:type])
+
       room = ensure_room(room_id)
       room.send :put_state_event, state_event
       content = state_event[:content]
@@ -618,7 +622,12 @@ module MatrixSdk
 
         join[:timeline][:events].each do |event|
           event[:room_id] = room_id.to_s
-          handle_state(room_id, event) if event.key? :state_key
+          # Avoid sending two identical state events if it's both in state and timeline
+          if event.key?(:state_key)
+            state_event = join.dig(:state, :events).find { |ev| ev[:event_id] == event[:event_id] }
+
+            handle_state(room_id, event) unless event == state_event
+          end
           room.send :put_event, event
 
           fire_event(MatrixEvent.new(self, event), event[:type])

data/lib/matrix_sdk/room.rb

@@ -42,19 +42,11 @@ module MatrixSdk
     #        The timeline events are what will end up in here
     attr_reader :id, :client, :topic, :aliases, :members, :events
 
-    # @!attribute [r] on_event
-    #   @return [EventHandlerArray] The list of event handlers for all events
-    # @!attribute [r] on_state_event
-    #   @return [EventHandlerArray] The list of event handlers for only state events
-    # @!attribute [r] on_ephemeral_event
-    #   @return [EventHandlerArray] The list of event handlers for only ephemeral events
-    events :event, :state_event, :ephemeral_event
     # @!method inspect
     #   An inspect method that skips a handful of instance variables to avoid
     #   flooding the terminal with debug data.
     #   @return [String] a regular inspect string without the data for some variables
-    ignore_inspect :client, :members, :events, :prev_batch, :logger,
-                   :on_event, :on_state_event, :on_ephemeral_event
+    ignore_inspect :client, :members, :events, :prev_batch, :logger
 
     alias room_id id
 
@@ -85,8 +77,6 @@ module MatrixSdk
       room_id = MXID.new room_id unless room_id.is_a?(MXID)
       raise ArgumentError, 'room_id must be a valid Room ID' unless room_id.room_id?
 
-      event_initialize
-
       @name = nil
       @topic = nil
       @canonical_alias = nil
@@ -114,6 +104,30 @@ module MatrixSdk
       logger.debug "Created room #{room_id}"
     end
 
+
+    #
+    # Event handlers
+    #
+
+    # @!attribute [r] on_event
+    #   @return [EventHandlerArray] The list of event handlers for all events
+    def on_event
+      ensure_room_handlers[:event]
+    end
+
+    # @!attribute [r] on_state_event
+    #   @return [EventHandlerArray] The list of event handlers for only state events
+    def on_state_event
+      ensure_room_handlers[:state_event]
+    end
+
+    # @!attribute [r] on_ephemeral_event
+    #   @return [EventHandlerArray] The list of event handlers for only ephemeral events
+    def on_ephemeral_event
+      ensure_room_handlers[:ephemeral_event]
+    end
+
+
     #
     # State readers
     #
@@ -523,10 +537,10 @@ module MatrixSdk
     # @return [Boolean] if the name was changed or not
     def reload_name!
       data = begin
-               client.api.get_room_name(id)
-             rescue MatrixNotFoundError
-               nil
-             end
+        client.api.get_room_name(id)
+      rescue MatrixNotFoundError
+        nil
+      end
       changed = data[:name] != @name
       @name = data[:name] if changed
       changed
@@ -546,10 +560,10 @@ module MatrixSdk
     # @return [Boolean] if the topic was changed or not
     def reload_topic!
       data = begin
-               client.api.get_room_topic(id)
-             rescue MatrixNotFoundError
-               nil
-             end
+        client.api.get_room_topic(id)
+      rescue MatrixNotFoundError
+        nil
+      end
       changed = data[:topic] != @topic
       @topic = data[:topic] if changed
       changed
@@ -681,19 +695,35 @@ module MatrixSdk
       members << member unless members.any? { |m| m.id == member.id }
     end
 
+    def room_handlers?
+      client.instance_variable_get(:@room_handlers).key? id
+    end
+
+    def ensure_room_handlers
+      client.instance_variable_get(:@room_handlers)[id] ||= {
+        event: MatrixSdk::EventHandlerArray.new,
+        state_event: MatrixSdk::EventHandlerArray.new,
+        ephemeral_event: MatrixSdk::EventHandlerArray.new
+      }
+    end
+
     def put_event(event)
+      ensure_room_handlers[:event].fire(MatrixEvent.new(self, event), event[:type]) if room_handlers?
+
       @events.push event
       @events.shift if @events.length > @event_history_limit
-
-      fire_event MatrixEvent.new(self, event)
     end
 
     def put_ephemeral_event(event)
-      fire_ephemeral_event MatrixEvent.new(self, event)
+      return unless room_handlers?
+
+      ensure_room_handlers[:ephemeral_event].fire(MatrixEvent.new(self, event), event[:type])
     end
 
     def put_state_event(event)
-      fire_state_event MatrixEvent.new(self, event)
+      return unless room_handlers?
+
+      ensure_room_handlers[:state_event].fire(MatrixEvent.new(self, event), event[:type])
     end
   end
 end

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha