matrix_sdk 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1de46ea35a8763e17d834c9395dc95a12c3084557085a0eb6b8e5f1fa25979a
-  data.tar.gz: 13a55698bf72695e8e690d4d5f6618d7efe595f06c32c65580b10e9bf550724e
+  metadata.gz: 88e56c3775bf881fb720e4e262ff6073136204d26b72c03bb1bbd2a4138b90ee
+  data.tar.gz: c8f5223c4c0c4febda391e8320a90667b6438b92806ce0b9b7c251a506678730
 SHA512:
-  metadata.gz: 919a27ee7fd758c382eafe3f8aad89c13da2a6cc6542ccd8bfe52d09186d93453b12406dfe6b03b6aa63d1898dbacfb6dbced4f4e9606722ad04df4f237cf600
-  data.tar.gz: a8f5c0bc4fb07a089e0d1daebeb8996c6d36157550e73e3869a8bb55f25cc2c405a064654fc49c8bdb323f9d8c168b3c785e52b9f88fbc168ee29c152f7472a5
+  metadata.gz: 7ce44dc75ea446ff9f901d8309f58df4251c2c199540d27f086fbb77359974b5950da8c960540e3d7e89d1a40b7f264dfb9f1c5ad8462c4e94176fcb19fedc60
+  data.tar.gz: 0b2acb16c36524bac00528fe322984a587f8f0c951754d316148fbd337a5f0dafec6ce5daf3cdc5829673115bb96453b60475702633ca1e11718d5e78c8e37b0

data/CHANGELOG.md

@@ -1,6 +1,13 @@
+## 2.1.0 - 2020-05-22
+
+- Adds unique query IDs as well as duration in API debug output, to make it easier to track long requests
+- Finishes up MSC support, get sync over SSE working flawlessly
+- Exposes the #listen_forever method in the client abstraction
+- Fixes room access methods
+
 ## 2.0.1 - 2020-03-13
 
-- Add code for handling non-final MSC's in protocols
+- Adds code for handling non-final MSC's in protocols
   - Currently implementing clients parts of MSC2018 for Sync over Server Sent Events
 
 ## 2.0.0 - 2020-02-14

data/lib/matrix_sdk/api.rb

@@ -161,6 +161,7 @@ module MatrixSdk
     def protocols
       self
         .class.included_modules
+        .reject { |m| m&.name.nil? }
         .select { |m| m.name.start_with? 'MatrixSdk::Protocols::' }
         .map { |m| m.name.split('::').last.to_sym }
     end
@@ -272,14 +273,20 @@ module MatrixSdk
       loop do
         raise MatrixConnectionError, "Server still too busy to handle request after #{failures} attempts, try again later" if failures >= 10
 
-        print_http(request)
+        req_id = ('A'..'Z').to_a.sample(4).join
+
+        print_http(request, id: req_id)
         begin
+          dur_start = Time.now
           response = http.request request
-        rescue EOFError => e
+          dur_end = Time.now
+          duration = dur_end - dur_start
+        rescue EOFError
           logger.error 'Socket closed unexpectedly'
-          raise e
+          raise
         end
-        print_http(response)
+        print_http(response, duration: duration, id: req_id)
+
         data = JSON.parse(response.body, symbolize_names: true) rescue nil
 
         if response.is_a? Net::HTTPTooManyRequests
@@ -298,17 +305,26 @@ module MatrixSdk
       end
     end
 
+    # Generate a transaction ID
+    #
+    # @return [String] An arbitrary transaction ID
+    def transaction_id
+      ret = @transaction_id ||= 0
+      @transaction_id = @transaction_id.succ
+      ret
+    end
+
     private
 
-    def print_http(http, body: true)
+    def print_http(http, body: true, duration: nil, id: nil)
       return unless logger.debug?
 
       if http.is_a? Net::HTTPRequest
-        dir = '>'
+        dir = "#{id ? id + ' : ' : nil}>"
         logger.debug "#{dir} Sending a #{http.method} request to `#{http.path}`:"
       else
-        dir = '<'
-        logger.debug "#{dir} Received a #{http.code} #{http.message} response:"
+        dir = "#{id ? id + ' : ' : nil}<"
+        logger.debug "#{dir} Received a #{http.code} #{http.message} response:#{duration ? " [#{(duration * 1000).to_i}ms]" : nil}"
       end
       http.to_hash.map { |k, v| "#{k}: #{k == 'authorization' ? '[ REDACTED ]' : v.join(', ')}" }.each do |h|
         logger.debug "#{dir} #{h}"
@@ -324,12 +340,6 @@ module MatrixSdk
       logger.warn "#{e.class} occured while printing request debug; #{e.message}\n#{e.backtrace.join "\n"}"
     end
 
-    def transaction_id
-      ret = @transaction_id ||= 0
-      @transaction_id = @transaction_id.succ
-      ret
-    end
-
     def api_to_path(api)
       # TODO: <api>_current / <api>_latest
       "/_matrix/#{api.to_s.split('_').join('/')}"

data/lib/matrix_sdk/client.rb

@@ -424,12 +424,26 @@ module MatrixSdk
 
       @should_listen = true
       if api.protocol?(:MSC) && api.msc2108?
+        params[:filter] = sync_filter unless params.key? :filter
+        params[:filter] = params[:filter].to_json unless params[:filter].nil? || params[:filter].is_a?(String)
         params[:since] = @next_batch if @next_batch
-        thread = api.msc2108_sync_sse(params) do |data, event:, id:|
-          logger.debug "Handling SSE event '#{event}' from '#{id}'"
+
+        errors = 0
+        thread, cancel_token = api.msc2108_sync_sse(params) do |data, event:, id:|
           @next_batch = id if id
-          handle_sync_response(data) if event.to_sym == :sync
+          if event.to_sym == :sync
+            handle_sync_response(data)
+            errors = 0
+          elsif event.to_sym == :sync_error
+            logger.error "SSE Sync error received; #{data.type}: #{data.message}"
+            errors += 1
+
+            # TODO: Allow configuring
+            raise 'Aborting due to excessive errors' if errors >= 5
+          end
         end
+
+        @should_listen = cancel_token
       else
         thread = Thread.new { listen_forever(params) }
       end
@@ -441,8 +455,15 @@ module MatrixSdk
     def stop_listener_thread
       return unless @sync_thread
 
-      @should_listen = false
-      @sync_thread.join if @sync_thread.alive?
+      if @should_listen.is_a? Hash
+        @should_listen[:run] = false
+      else
+        @should_listen = false
+      end
+      if @sync_thread.alive?
+        ret = @sync_thread.join(2)
+        @sync_thread.kill unless ret
+      end
       @sync_thread = nil
     end
 
@@ -503,8 +524,6 @@ module MatrixSdk
       end
     end
 
-    private
-
     def listen_forever(timeout: 30, bad_sync_timeout: 5, sync_interval: 30, **params)
       orig_bad_sync_timeout = bad_sync_timeout + 0
       while @should_listen
@@ -528,6 +547,8 @@ module MatrixSdk
       fire_error(ErrorEvent.new(e, :listener_thread))
     end
 
+    private
+
     def post_authentication(data)
       @mxid = data[:user_id]
       @api.access_token = data[:access_token]

data/lib/matrix_sdk/protocols/msc.rb

@@ -2,16 +2,13 @@
 
 # Preliminary support for unmerged MSCs (Matrix Spec Changes)
 module MatrixSdk::Protocols::MSC
-  def self.included(_)
-    @msc = {}
-  end
-
   def refresh_mscs
     @msc = {}
   end
 
   # Check if there's support for MSC2108 - Sync over Server Sent Events
   def msc2108?
+    @msc ||= {}
     @msc[2108] ||= \
       begin
         request(:get, :client_r0, '/sync/sse', skip_auth: true, headers: { accept: 'text/event-stream' })
@@ -20,13 +17,13 @@ module MatrixSdk::Protocols::MSC
       rescue MatrixSdk::MatrixRequestError
         false
       end
+  rescue StandardError => e
+    logger.debug "Failed to check MSC2108 status;\n#{e.inspect}"
+    false
   end
 
   # Sync over Server Sent Events - MSC2108
   #
-  # @note With the default Ruby Net::HTTP server, body fragments are cached up to 16kB,
-  #       which will result in large batches and delays if your filters trim a lot of data.
-  #
   # @example Syncing over SSE
   #   @since = 'some token'
   #   api.msc2108_sync_sse(since: @since) do |data, event:, id:|
@@ -38,10 +35,11 @@ module MatrixSdk::Protocols::MSC
   #
   # @see Protocols::CS#sync
   # @see https://github.com/matrix-org/matrix-doc/pull/2108/
+  # rubocop:disable Metrics/MethodLength
   def msc2108_sync_sse(since: nil, **params, &on_data)
     raise ArgumentError, 'Must be given a block accepting two args - data and { event:, id: }' \
       unless on_data.is_a?(Proc) && on_data.arity == 2
-    raise MatrixNotAuthorizedError unless access_token
+    raise 'Needs to be logged in' unless access_token # TODO: Better error
 
     query = params.select do |k, _v|
       %i[filter full_state set_presence].include? k
@@ -53,20 +51,52 @@ module MatrixSdk::Protocols::MSC
       u.query = URI.encode_www_form(query)
     end)
     req['accept'] = 'text/event-stream'
+    req['accept-encoding'] = 'identity' # Disable compression on the SSE stream
     req['authorization'] = "Bearer #{access_token}"
     req['last-event-id'] = since if since
 
+    cancellation_token = { run: true }
+
     # rubocop:disable Metrics/BlockLength
-    thread = Thread.new do
+    thread = Thread.new(cancellation_token) do |ctx|
       print_http(req)
       http.request req do |response|
+        break unless ctx[:run]
+
         print_http(response, body: false)
         raise MatrixRequestError.new_by_code(JSON.parse(response.body, symbolize_names: true), response.code) unless response.is_a? Net::HTTPSuccess
 
+        # Override buffer size for BufferedIO
+        socket = response.instance_variable_get :@socket
+        if socket.is_a? Net::BufferedIO
+          socket.instance_eval do
+            def rbuf_fill
+              bufsize_override = 1024
+              loop do
+                case rv = @io.read_nonblock(bufsize_override, exception: false)
+                when String
+                  @rbuf << rv
+                  rv.clear
+                  return
+                when :wait_readable
+                  @io.to_io.wait_readable(@read_timeout) || raise(Net::ReadTimeout)
+                when :wait_writable
+                  @io.to_io.wait_writable(@read_timeout) || raise(Net::ReadTimeout)
+                when nil
+                  raise EOFError, 'end of file reached'
+                end
+              end
+            end
+          end
+        end
+
+        stream_id = ('A'..'Z').to_a.sample(4).join
+
+        logger.debug "MSC2108 : #{stream_id} : Starting SSE stream."
+
         buffer = ''
         response.read_body do |chunk|
           buffer += chunk
-          logger.debug "< MSC2108: Received #{chunk.length}B of data."
 
           while (index = buffer.index(/\r\n\r\n|\n\n/))
             stream = buffer.slice!(0..index)
@@ -86,20 +116,32 @@ module MatrixSdk::Protocols::MSC
               /^id:(.+)$/.match(part) do |m_id|
                 id = m_id[1].strip
               end
+              /^:(.+)$/.match(part) do |m_comment|
+                logger.debug "MSC2108 : #{stream_id} : Received comment '#{m_comment[1].strip}'"
+              end
             end
 
-            data = JSON.parse(data, symbolize_names: true)
+            if %w[sync sync_error].include? event
+              data = JSON.parse(data, symbolize_names: true)
+              yield((MatrixSdk::Response.new self, data), event: event, id: id)
+            elsif event
+              logger.info "MSC2108 : #{stream_id} : Received unknown event '#{event}'; #{data}"
+            end
+          end
 
-            yield((MatrixSdk::Response.new self, data), event: event, id: id)
+          unless ctx[:run]
+            socket.close
+            break
           end
         end
+        break unless ctx[:run]
       end
     end
     # rubocop:enable Metrics/BlockLength
 
-    thread.abort_on_exception = true
     thread.run
 
-    thread
+    [thread, cancellation_token]
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/matrix_sdk/room.rb

@@ -590,7 +590,7 @@ module MatrixSdk
     #
     # @param join_rule [:invite,:public] The join rule of the room
     def join_rule=(join_rule)
-      client.api.set_join_rule(id, join_rule)
+      client.api.set_room_join_rules(id, join_rule)
       @join_rule = join_rule
     end
 
@@ -606,7 +606,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_guest_access(id, guest_access)
+      client.api.set_room_guest_access(id, guest_access)
       @guest_access = guest_access
     end
 

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha