scale_rb 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df0775bbed0fb5886ee7aba23efa8660dfde37a1f437d1d83958a6cc3f82c1f
-  data.tar.gz: a6ad3ab392fdaa8b9a3f431f98a6d1e7b099b5ce43cb966e5055267d5515322d
+  metadata.gz: 946dbb730e56172125e2524d66c41650fb08a3b799576000b5254467080ec771
+  data.tar.gz: cae0b7ce708380ceeefa2bdd412abc30adbc5de5153b68bec12625497cf89e03
 SHA512:
-  metadata.gz: fd7a0fbc2f605c3fef4a0b88e7c8475db9ac7e63223130536fddb786040fc4af79e9306f101697e2ae990f04d913755086df2965e8b922638c7c8498455c0fc8
-  data.tar.gz: 378a219709b0cce2ea277b3e717bd2b0653984519c7593e5525a841155a47b1478c6a10cebf29480cc862cac78b33287e34c1a9a7f433679a8d9e66cfe0ce356
+  metadata.gz: 3d9b11df5acc3538b9fd7af4aabd1db74f9fb0f08ab7bc2620299d2145beee2805eeee12b1948e33a9198b0141b4b6c57187bb99f984743dbfb1c7e62e9b0ca7
+  data.tar.gz: df6d923402362b259384fe585a83ee490dc3e5bc5154d41b886a74ee1ab19d3e1fa0e92c0a3f8c2b5ffb976f12138418728b0c046ac23470bb1954b12a65a048

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 /metadata
+Gemfile.lock

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem 'rubocop', group: 'development', require: false

data/README.md

@@ -7,7 +7,7 @@ It is still under heavy development. Use the latest version.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'scale_rb', '~> 0.3.3'
+gem 'scale_rb', '~> 0.3.5'
 ```
 
 And then execute:

data/examples/ws_client_3.rb

@@ -2,12 +2,12 @@ require 'scale_rb'
 
 # ScaleRb.logger.level = Logger::DEBUG
 
-# Unsubscribe after receiving 5 new heads
+# Unsubscribe after receiving 4 new heads
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
   count = 0
 
   subscription_id = client.chain_subscribeNewHead do |head|
-    count = count + 1
+    count += 1
 
     if count < 5
       block_number = head[:number].to_i(16)

data/examples/ws_client_error_handling.rb

@@ -0,0 +1,9 @@
+require 'scale_rb'
+
+begin
+  ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |_client|
+    raise 'MyError'
+  end
+rescue StandardError => e
+  p e.message # "MyError"
+end

data/lib/client/ws_client.rb

@@ -1,42 +1,55 @@
 require 'async'
 require 'async/websocket/client'
 require 'async/http/endpoint'
-require 'async/queue'
-require 'json'
 
 require_relative 'client_ext'
 
 module ScaleRb
   class WsClient
-    def self.start(url)
 
-      Sync do |task|
-        endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
-
-        Async::WebSocket::Client.connect(endpoint) do |connection|
-          client = WsClient.new(connection)
-
-          recv_task = task.async do
-            while message = connection.read
-              data = message.parse
-              ScaleRb.logger.debug "Received message: #{data}"
-
-              task.async do
-                client.handle_response(data)
+    class << self
+      # @param [string] url
+      def start(url)
+        Sync do
+          endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+
+          Async::WebSocket::Client.connect(endpoint) do |connection|
+            client = WsClient.new(connection)
+
+            # `recv_task` does not raise errors (subclass of StandardError), so it will not be stopped by any errors.
+            recv_task = Async do
+              while (message = client.read_message)
+                data = parse_message(message)
+                next if data.nil?
+
+                ScaleRb.logger.debug "Received response: #{data}"
+                Async do
+                  client.handle_response(data)
+                end
               end
             end
-          end
 
-          client.supported_methods = client.rpc_methods()[:methods]
-          yield client
+            client.supported_methods = client.rpc_methods()[:methods]
+            yield client
 
-          recv_task.wait
-        ensure
-          recv_task&.stop
+            recv_task.wait
+          ensure
+            recv_task&.stop
+          end
         end
-      end # Sync
 
-    end # start
+      end
+
+      private
+
+      def parse_message(message)
+        message.parse
+      rescue StandardError => e
+        ScaleRb.logger.error "Error while parsing message: #{e.inspect}, message: #{message}"
+        nil
+      end
+    end
+
   end
 end
 
@@ -68,7 +81,7 @@ module ScaleRb
       if method.include?('unsubscribe')
         unsubscribe(method, args[0])
       elsif method.include?('subscribe')
-        raise "A subscribe method needs a block" unless block_given?
+        raise 'A subscribe method needs a block' unless block_given?
 
         subscribe(method, args) do |notification|
           yield notification[:params][:result]
@@ -101,7 +114,21 @@ module ScaleRb
       elsif response.key?(:method)
         @subscription_handler.handle(response)
       else
-        puts "Received an unknown message: #{response}"
+        ScaleRb.logger.info "Received an unknown response: #{response}"
+      end
+    rescue StandardError => e
+      ScaleRb.logger.error "Error while handling response: #{e.inspect}"
+      ScaleRb.logger.debug e.backtrace.join("\n")
+    end
+
+    def read_message
+      loop do
+        return @connection.read
+      rescue StandardError => e
+        ScaleRb.logger.error "Error while read message from connection: #{e.inspect}"
+        ScaleRb.logger.debug e.backtrace.join("\n")
+        sleep 1
+        retry
       end
     end
 
@@ -140,7 +167,7 @@ module ScaleRb
         callback.call(response)
         @callbacks.delete(id)
       else
-        ScaleRb.logger.debug "Received a message with unknown id: #{response}"
+        ScaleRb.logger.info "Received a message with unknown id: #{response}"
       end
     end
   end

data/lib/scale_rb/version.rb

@@ -1,3 +1,3 @@
 module ScaleRb
-  VERSION = '0.3.3'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Aki Wu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -109,7 +109,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -121,6 +120,7 @@ files:
 - examples/ws_client_2.rb
 - examples/ws_client_3.rb
 - examples/ws_client_4.rb
+- examples/ws_client_error_handling.rb
 - exe/metadata
 - lib/address.rb
 - lib/client/client_ext.rb
@@ -149,7 +149,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/wuminzhe/scale_rb/issues/
   source_code_uri: https://github.com/wuminzhe/scale_rb.git
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Ruby SCALE Codec Library, and, Substrate RPC Client
 test_files: []

data/Gemfile.lock

@@ -1,97 +0,0 @@
-PATH
-  remote: .
-  specs:
-    scale_rb (0.3.3)
-      async
-      async-http (~> 0.69.0)
-      async-websocket (~> 0.26.2)
-      base58
-      blake2b_rs (~> 0.1.4)
-      xxhash
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    async (2.14.2)
-      console (~> 1.25, >= 1.25.2)
-      fiber-annotation
-      io-event (~> 1.6, >= 1.6.5)
-    async-http (0.69.0)
-      async (>= 2.10.2)
-      async-pool (~> 0.7)
-      io-endpoint (~> 0.11)
-      io-stream (~> 0.4)
-      protocol-http (~> 0.26)
-      protocol-http1 (~> 0.19)
-      protocol-http2 (~> 0.18)
-      traces (>= 0.10)
-    async-pool (0.7.0)
-      async (>= 1.25)
-    async-websocket (0.26.2)
-      async-http (~> 0.54)
-      protocol-rack (~> 0.5)
-      protocol-websocket (~> 0.14)
-    base58 (0.2.3)
-    blake2b_rs (0.1.4)
-      ffi (~> 1.0)
-      thermite (~> 0)
-    console (1.27.0)
-      fiber-annotation
-      fiber-local (~> 1.1)
-      json
-    diff-lcs (1.5.0)
-    ffi (1.17.0)
-    fiber-annotation (0.2.0)
-    fiber-local (1.1.0)
-      fiber-storage
-    fiber-storage (0.1.2)
-    io-endpoint (0.13.0)
-    io-event (1.6.5)
-    io-stream (0.4.0)
-    json (2.7.2)
-    minitar (0.9)
-    protocol-hpack (1.5.0)
-    protocol-http (0.28.1)
-    protocol-http1 (0.19.1)
-      protocol-http (~> 0.22)
-    protocol-http2 (0.18.0)
-      protocol-hpack (~> 1.4)
-      protocol-http (~> 0.18)
-    protocol-rack (0.6.0)
-      protocol-http (~> 0.23)
-      rack (>= 1.0)
-    protocol-websocket (0.15.0)
-      protocol-http (~> 0.2)
-    rack (3.1.7)
-    rake (12.3.3)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    thermite (0.13.0)
-      minitar (~> 0.5)
-      rake (>= 10)
-      tomlrb (~> 1.2)
-    tomlrb (1.3.0)
-    traces (0.11.1)
-    xxhash (0.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  scale_rb!
-
-BUNDLED WITH
-   2.1.4