skyfall 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4045bf9dcd6a2ed5078cb557a64dc67c9e3d3c829a2909d9451c72c89f591c42
-  data.tar.gz: 1b2813d54fbd7cdd34334404f1e9607d05bbf923584009eedd0b630f8182fd7b
+  metadata.gz: 0c827cbd3a6c7563d7a84ea7ec0547b0b75f5bfa1626373493ede36d9c8c10c1
+  data.tar.gz: 840e0cb0a8d007e2aa49a7805d15b68494a87cf03c756056cc618aaba476eb25
 SHA512:
-  metadata.gz: 5c439017a0d277eb20977600847e74c8d52570ebb4eed3db5c39624d573b44dcc7b2404154131cf828f15df97b132a2b16de2eb608b6ed3a64e52c5a8f80b1e1
-  data.tar.gz: feadd80a468759c3a1a62b634e22ac4aa950bad708ffed6d7ed77b575a21c8841c01a0dc145da039f36203be0f92695d251f76e41de395d2296b4a1afd0e87fe
+  metadata.gz: b87ccd4ee8fd5652ccb72e8b4312e03a0dbc938c01c0d47b4b0cf7896c89e9ad6e9482fd9fc914210098d7be8867a0198197db788569f63c30edbf9cf5dedc11
+  data.tar.gz: 86b9fcc440daeaa3e1bfea26a1707c5789bbf7141d2d21c1f279e1704c717c048807bda01f5dba05de1cfebc101715247fa0901fb9a42b641e6516f265c0e716

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.1] - 2023-06-13
+
+- added heartbeat thread to restart websocket if it stops responding
+
 ## [0.1.0] - 2023-06-01
 
 - connecting to the firehose websocket

data/README.md

@@ -52,7 +52,8 @@ Each message passed to `on_message` is an instance of the `WebsocketMessage` cla
 - `seq` (sequential number)
 - `time` (Time)
 - `repo` (string) - DID of the repository (user account)
-- `commit` - CID
+- `commit` - CID of the commit
+- `prev` - CID of the previous commit in that repo
 - `operations` - list of operations (usually one)
 
 Operations are objects of type `Operation` and have such properties:
@@ -63,9 +64,9 @@ Operations are objects of type `Operation` and have such properties:
 - `action` (symbol) - `:create`, `:update` or `:delete`
 - `uri` (string) - the at:// URI
 - `type` (symbol) - short name of the collection, e.g. `:bsky_post`
-- `cid` - CID
+- `cid` - CID of the operation/record (`nil` for delete operations)
 
-Most operations will also have an attached record (JSON object) with details of the post, like etc. The record data is currently available as a Ruby hash via `raw_record` property (custom types will be added in a later version).
+Create and update operations will also have an attached record (JSON object) with details of the post, like etc. The record data is currently available as a Ruby hash via `raw_record` property (custom types will be added in a later version).
 
 So for example, in order to filter only "create post" operations and print their details, you can do something like this:
 

data/lib/skyfall/cid.rb

@@ -16,6 +16,14 @@ module Skyfall
       CID.new(data[1..-1])
     end
 
+    def self.from_json(string)
+      raise DecodeError.new("Unexpected CID length") unless string.length == 59
+      raise DecodeError.new("Unexpected CID prefix") unless string[0] == 'b'
+
+      data = Base32.decode(string[1..-1].upcase)
+      CID.new(data)
+    end
+
     def initialize(data)
       @data = data
     end

data/lib/skyfall/collection.rb

@@ -7,5 +7,6 @@ module Skyfall
     BSKY_BLOCK = "app.bsky.graph.block"
     BSKY_PROFILE = "app.bsky.actor.profile"
     BSKY_LISTITEM = "app.bsky.graph.listitem"
+    BSKY_FEED = "app.bsky.feed.generator"
   end
 end

data/lib/skyfall/operation.rb

@@ -33,6 +33,7 @@ module Skyfall
       when Collection::BSKY_BLOCK then :bsky_block
       when Collection::BSKY_PROFILE then :bsky_profile
       when Collection::BSKY_LISTITEM then :bsky_listitem
+      when Collection::BSKY_FEED then :bsky_feed
       else :unknown
       end
     end

data/lib/skyfall/stream.rb

@@ -9,10 +9,16 @@ module Skyfall
       :subscribe_repos => SUBSCRIBE_REPOS
     }
 
+    attr_accessor :heartbeat_timeout, :heartbeat_interval
+
     def initialize(server, endpoint)
       @endpoint = check_endpoint(endpoint)
       @server = check_hostname(server)
       @handlers = {}
+      @heartbeat_mutex = Mutex.new
+      @heartbeat_interval = 5
+      @heartbeat_timeout = 30
+      @last_update = nil
     end
 
     def connect
@@ -20,9 +26,11 @@ module Skyfall
 
       url = "wss://#{@server}/xrpc/#{@endpoint}"
       handlers = @handlers
+      stream = self
 
       @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]
@@ -43,15 +51,61 @@ module Skyfall
           handlers[:error]&.call(e)
         end
       end
+
+      if @heartbeat_interval && @heartbeat_timeout && @heartbeat_thread.nil?
+        hb_interval = @heartbeat_interval
+        hb_timeout = @heartbeat_timeout
+
+        @last_update = Time.now
+
+        @heartbeat_thread = Thread.new do
+          loop do
+            sleep(hb_interval)
+            @heartbeat_mutex.synchronize do
+              if Time.now - @last_update > hb_timeout
+                force_restart
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def force_restart
+      @websocket.close
+      @websocket = nil
+
+      timeout = 5
+
+      loop do
+        begin
+          @handlers[:reconnect]&.call
+          connect
+          break
+        rescue Exception => e
+          @handlers[:error]&.call(e)
+          sleep(timeout)
+          timeout *= 2
+        end
+      end
+
+      @last_update = Time.now
     end
 
     def disconnect
       return unless @websocket
 
+      @heartbeat_thread&.kill
+      @heartbeat_thread = nil
+
       @websocket.close
       @websocket = nil
     end
 
+    def notify_heartbeat
+      @heartbeat_mutex.synchronize { @last_update = Time.now }
+    end
+
     alias close disconnect
 
     def on_message(&block)
@@ -74,6 +128,10 @@ module Skyfall
       @handlers[:error] = block
     end
 
+    def on_reconnect(&block)
+      @handlers[:reconnect] = block
+    end
+
 
     private
 

data/lib/skyfall/version.rb

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

data/lib/skyfall/websocket_message.rb

@@ -12,7 +12,7 @@ module Skyfall
     using Skyfall::Extensions
 
     attr_reader :type_object, :data_object
-    attr_reader :type, :repo, :time, :seq, :commit, :blocks, :operations
+    attr_reader :type, :repo, :time, :seq, :commit, :prev, :blocks, :operations
 
     def initialize(data)
       objects = CBOR.decode_sequence(data)
@@ -34,7 +34,9 @@ module Skyfall
 
       return unless @type == :commit
 
-      @commit = CID.from_cbor_tag(@data_object['commit'])
+      @commit = @data_object['commit'] && CID.from_cbor_tag(@data_object['commit'])
+      @prev = @data_object['prev'] && CID.from_cbor_tag(@data_object['prev'])
+
       @blocks = CarArchive.new(@data_object['blocks'])
 
       @operations = @data_object['ops'].map { |op|

metadata

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