skyfall 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1d8eea31c1c63f4aabd513a470083862b653f4fb1ba5a0a638da1d9e8cba3af
-  data.tar.gz: 15e57a872800ad3a0c2a0f38be1ed31694617e82fe0981e1c9a1598c9f70e325
+  metadata.gz: ce06b8a7ef3783cd255621d6868a737735b782999a8cab76b70cf1f869e2cd1d
+  data.tar.gz: 9edea42903a17cb83ee717ea92c81e9a853b530a24f0bc803f70835b3bed1ba2
 SHA512:
-  metadata.gz: 84544c24ff44ed583df898567b260db3b23517de6248b105f6199de49f2a3bcfaaada701bb62252c59a44af2845321637cfa4ab5061b9f8f800d27107fb2f83e
-  data.tar.gz: fb62308d1e517fdd257633a19f503dc9f9fce7d5b6b4d778a588c19facbe8c45ff60cca3e242ae9024c4975c9ca84326083e4eeddedd0da8d34f3ae9f647d05b
+  metadata.gz: 1b04bb91b734fe84d984af3c6a8c78959230d5ef865109882d86c5f0b2537f0a8b25678dcace7f5d8c26e560f871edba4de07f38273e2e7cf17088fd125a08e2
+  data.tar.gz: 5dffcf8a308789995d16293a9b8caba848374ab80c147a0ef87f440cb2c98887b4d81f3eb447d74c2bfc608ae448b54d9ada90556eb6e55cf59cc1df37e15390

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.2.0] - 2023-07-24
+
+- switched the websocket library from `websocket-client-simple` to `faye-websocket`, which should make event parsing up to ~30× faster (!)
+- added `auto_reconnect` property to `Stream` (on by default) - if true, it will try to reconnect with an exponential backoff when the websocket disconnects, until you call `Stream#disconnect`
+
+Note:
+
+- calling `sleep` is no longer needed after connecting - call `connect` on a new thread instead to get previously default behavior of running the event loop asynchronously
+- the disconnect event no longer passes an error object in the argument
+- there is currently no "heartbeat" feature as in 0.1.x that checks for a stuck connection - but it doesn't seem to be needed
+
 ## [0.1.3] - 2023-07-04
 
 - allow passing a previously saved cursor to websocket to replay any missed events

data/README.md

@@ -41,8 +41,6 @@ When you're ready, open the connection by calling `connect`:
 sky.connect
 ```
 
-The connection is started asynchronously on a separate thread. If you're running this code in a simple script (and not as a part of a server), call e.g. `sleep` without arguments or `loop { STDIN.read }` to prevent the script for exiting while the connection is open.
-
 
 ### Processing messages
 

data/example/firehose.rb

@@ -21,7 +21,7 @@ end
 
 sky.on_connect { puts "Connected" }
 sky.on_disconnect { puts "Disconnected" }
+sky.on_reconnect { puts "Reconnecting..." }
 sky.on_error { |e| puts "ERROR: #{e}" }
 
 sky.connect
-sleep

data/lib/skyfall/stream.rb

@@ -1,7 +1,8 @@
 require_relative 'websocket_message'
 
+require 'eventmachine'
+require 'faye/websocket'
 require 'uri'
-require 'websocket-client-simple'
 
 module Skyfall
   class Stream
@@ -11,7 +12,9 @@ module Skyfall
       :subscribe_repos => SUBSCRIBE_REPOS
     }
 
-    attr_accessor :heartbeat_timeout, :heartbeat_interval, :cursor
+    MAX_RECONNECT_INTERVAL = 300
+
+    attr_accessor :heartbeat_timeout, :heartbeat_interval, :cursor, :auto_reconnect
 
     def initialize(server, endpoint, cursor = nil)
       @endpoint = check_endpoint(endpoint)
@@ -22,93 +25,71 @@ module Skyfall
       @heartbeat_interval = 5
       @heartbeat_timeout = 30
       @last_update = nil
+      @auto_reconnect = true
+      @connection_attempts = 0
     end
 
     def connect
-      return if @websocket
+      return if @ws
 
       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
 
-          atp_message = Skyfall::WebsocketMessage.new(msg.data)
-          stream.cursor = atp_message.seq
+      @handlers[:connecting]&.call(url)
+      @engines_on = true
 
-          handlers[:raw_message]&.call(msg.data)
-          handlers[:message]&.call(atp_message)
-        end
-
-        ws.on :open do
-          handlers[:connect]&.call
+      EM.run do
+        EventMachine.error_handler do |e|
+          @handlers[:error]&.call(e)
         end
 
-        ws.on :close do |e|
-          handlers[:disconnect]&.call(e)
-        end
+        @ws = Faye::WebSocket::Client.new(url)
 
-        ws.on :error do |e|
-          handlers[:error]&.call(e)
+        @ws.on(:open) do |e|
+          @handlers[:connect]&.call
         end
-      end
 
-      if @heartbeat_interval && @heartbeat_timeout && @heartbeat_thread.nil?
-        hb_interval = @heartbeat_interval
-        hb_timeout = @heartbeat_timeout
+        @ws.on(:message) do |msg|
+          @connection_attempts = 0
 
-        @last_update = Time.now
+          data = msg.data.pack('C*')
+          @handlers[:raw_message]&.call(data)
 
-        @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
+          if @handlers[:message]
+            atp_message = Skyfall::WebsocketMessage.new(data)
+            @cursor = atp_message.seq
+            @handlers[:message].call(atp_message)
+          else
+            @cursor = nil
           end
         end
-      end
-    end
 
-    def force_restart
-      @websocket.close
-      @websocket = nil
+        @ws.on(:error) do |e|
+          @handlers[:error]&.call(e)
+        end
 
-      timeout = 5
+        @ws.on(:close) do |e|
+          @ws = nil
 
-      loop do
-        begin
-          @handlers[:reconnect]&.call
-          connect
-          break
-        rescue Exception => e
-          @handlers[:error]&.call(e)
-          sleep(timeout)
-          timeout *= 2
+          if @auto_reconnect && @engines_on
+            EM.add_timer(reconnect_delay) do
+              @connection_attempts += 1
+              @handlers[:reconnect]&.call
+              connect
+            end
+          else
+            @engines_on = false
+            @handlers[:disconnect]&.call
+            EM.stop_event_loop unless @ws
+          end
         end
       end
-
-      @last_update = Time.now
     end
 
     def disconnect
-      return unless @websocket
-
-      @heartbeat_thread&.kill
-      @heartbeat_thread = nil
+      return unless EM.reactor_running?
 
-      @websocket.close
-      @websocket = nil
-    end
-
-    def notify_heartbeat
-      @heartbeat_mutex.synchronize { @last_update = Time.now }
+      @engines_on = false
+      EM.stop_event_loop
     end
 
     alias close disconnect
@@ -144,6 +125,14 @@ module Skyfall
 
     private
 
+    def reconnect_delay
+      if @connection_attempts == 0
+        0
+      else
+        [2 ** (@connection_attempts - 1), MAX_RECONNECT_INTERVAL].min
+      end
+    end
+
     def build_websocket_url
       url = "wss://#{@server}/xrpc/#{@endpoint}"
       url += "?cursor=#{@cursor}" if @cursor

data/lib/skyfall/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -51,25 +51,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.9.6
 - !ruby/object:Gem::Dependency
-  name: websocket-client-simple
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.11.2
 description: "\n    Skyfall is a Ruby library for connecting to the \"firehose\" of
   the Bluesky social network, i.e. a websocket which\n    streams all new posts and
   everything else happening on the Bluesky network in real time. The code connects