skyfall 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc7ba74da06a265f8b1af42633b4c462f87fbf5764b38505628d9255bd97831
-  data.tar.gz: 9bbb8e00563fdab6ee906ce82a3ddcde4936b8f0ee187da4d4f8032f5f344446
+  metadata.gz: b1d8eea31c1c63f4aabd513a470083862b653f4fb1ba5a0a638da1d9e8cba3af
+  data.tar.gz: 15e57a872800ad3a0c2a0f38be1ed31694617e82fe0981e1c9a1598c9f70e325
 SHA512:
-  metadata.gz: 440c94077709828c54814ed8a4d520dbb513755412fa5baaee443d55f2493833e5c9196ffbcee256a118b8bdc6e41d92479fa041514ab8d9d16978aa4ec1d4c7
-  data.tar.gz: b43da862f141b6ed476036eee85c8514a3b93a7a93bcaa16e089ee6149137c6b548639351445b2d3bddb3e2c458e8dc6e2c3eaa3f71d2efb9d92dad734f2fbf1
+  metadata.gz: 84544c24ff44ed583df898567b260db3b23517de6248b105f6199de49f2a3bcfaaada701bb62252c59a44af2845321637cfa4ab5061b9f8f800d27107fb2f83e
+  data.tar.gz: fb62308d1e517fdd257633a19f503dc9f9fce7d5b6b4d778a588c19facbe8c45ff60cca3e242ae9024c4975c9ca84326083e4eeddedd0da8d34f3ae9f647d05b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.3] - 2023-07-04
+
+- allow passing a previously saved cursor to websocket to replay any missed events
+- the cursor is also kept in memory and automatically used when reconnecting
+- added "connecting" callback with url as argument
+- fixed connecting to websocket when endpoint is given as a string
+- improved error handling during parsing
+
 ## [0.1.2] - 2023-06-15
 
 - added rkey property for Operation

data/lib/skyfall/errors.rb

@@ -4,4 +4,15 @@ module Skyfall
 
   class UnsupportedError < StandardError
   end
+
+  class SubscriptionError < StandardError
+    attr_reader :error_type, :error_message
+
+    def initialize(error_type, error_message = nil)
+      @error_type = error_type
+      @error_message = error_message
+
+      super("Subscription error: #{error_type}" + (error_message ? " (#{error_message})" : ""))
+    end
+  end
 end

data/lib/skyfall/stream.rb

@@ -1,4 +1,6 @@
 require_relative 'websocket_message'
+
+require 'uri'
 require 'websocket-client-simple'
 
 module Skyfall
@@ -9,11 +11,12 @@ module Skyfall
       :subscribe_repos => SUBSCRIBE_REPOS
     }
 
-    attr_accessor :heartbeat_timeout, :heartbeat_interval
+    attr_accessor :heartbeat_timeout, :heartbeat_interval, :cursor
 
-    def initialize(server, endpoint)
+    def initialize(server, endpoint, cursor = nil)
       @endpoint = check_endpoint(endpoint)
       @server = check_hostname(server)
+      @cursor = cursor
       @handlers = {}
       @heartbeat_mutex = Mutex.new
       @heartbeat_interval = 5
@@ -24,19 +27,21 @@ module Skyfall
     def connect
       return if @websocket
 
-      url = "wss://#{@server}/xrpc/#{@endpoint}"
+      url = build_websocket_url
       handlers = @handlers
       stream = self
 
+      handlers[:connecting]&.call(url)
+
       @websocket = WebSocket::Client::Simple.connect(url) do |ws|
         ws.on :message do |msg|
           stream.notify_heartbeat
-          handlers[:raw_message]&.call(msg.data)
 
-          if handlers[:message]
-            atp_message = Skyfall::WebsocketMessage.new(msg.data)
-            handlers[:message].call(atp_message)
-          end
+          atp_message = Skyfall::WebsocketMessage.new(msg.data)
+          stream.cursor = atp_message.seq
+
+          handlers[:raw_message]&.call(msg.data)
+          handlers[:message]&.call(atp_message)
         end
 
         ws.on :open do
@@ -116,6 +121,10 @@ module Skyfall
       @handlers[:raw_message] = block
     end
 
+    def on_connecting(&block)
+      @handlers[:connecting] = block
+    end
+
     def on_connect(&block)
       @handlers[:connect] = block
     end
@@ -135,6 +144,12 @@ module Skyfall
 
     private
 
+    def build_websocket_url
+      url = "wss://#{@server}/xrpc/#{@endpoint}"
+      url += "?cursor=#{@cursor}" if @cursor
+      url
+    end
+
     def check_endpoint(endpoint)
       if endpoint.is_a?(String)
         raise ArgumentError("Invalid endpoint name: #{endpoint}") if endpoint.strip.empty? || !endpoint.include?('.')
@@ -144,6 +159,8 @@ module Skyfall
       else
         raise ArgumentError("Endpoint should be a string or a symbol")
       end
+
+      endpoint
     end
 
     def check_hostname(server)

data/lib/skyfall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skyfall
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/skyfall/websocket_message.rb

@@ -15,15 +15,7 @@ module Skyfall
     attr_reader :type, :repo, :time, :seq, :commit, :prev, :blocks, :operations
 
     def initialize(data)
-      objects = CBOR.decode_sequence(data)
-      raise DecodeError.new("Invalid number of objects: #{objects.length}") unless objects.length == 2
-
-      @type_object, @data_object = objects
-      raise DecodeError.new("Invalid object type: #{@type_object}") unless @type_object.is_a?(Hash)
-      raise DecodeError.new("Invalid object type: #{@data_object}") unless @data_object.is_a?(Hash)
-      raise DecodeError.new("Missing data: #{@type_object}") unless @type_object['op'] && @type_object['t']
-      raise DecodeError.new("Invalid message type: #{@type_object['t']}") unless @type_object['t'].start_with?('#')
-      raise UnsupportedError.new("Unexpected CBOR object: #{@type_object}") unless @type_object['op'] == 1
+      @type_object, @data_object = decode_cbor_objects(data)
 
       @type = @type_object['t'][1..-1].to_sym
       @operations = []
@@ -54,5 +46,32 @@ module Skyfall
       vars = keys.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(", ")
       "#<#{self.class}:0x#{object_id} #{vars}>"
     end
+
+    private
+
+    def decode_cbor_objects(data)
+      objects = CBOR.decode_sequence(data)
+
+      if objects.length < 2
+        raise DecodeError.new("Malformed message: #{objects.inspect}")
+      elsif objects.length > 2
+        raise DecodeError.new("Invalid number of objects: #{objects.length}")
+      end
+
+      type_object, data_object = objects
+
+      if data_object['error']
+        raise SubscriptionError.new(data_object['error'], data_object['message'])
+      end
+
+      raise DecodeError.new("Invalid object type: #{type_object}") unless type_object.is_a?(Hash)
+      raise UnsupportedError.new("Unexpected CBOR object: #{type_object}") unless type_object['op'] == 1
+      raise DecodeError.new("Missing data: #{type_object} #{objects.inspect}") unless type_object['op'] && type_object['t']
+      raise DecodeError.new("Invalid message type: #{type_object['t']}") unless type_object['t'].start_with?('#')
+
+      raise DecodeError.new("Invalid object type: #{data_object}") unless data_object.is_a?(Hash)
+
+      [type_object, data_object]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32