feat(sorbet)!: enable runtime typecheck (#104)

Author: peterdeme

lib/stream-chat/channel.rb

@@ -4,23 +4,20 @@
 module StreamChat
   class StreamAPIException < StandardError
     extend T::Sig
-    # For now we disable runtime type checks.
-    # We will enable it with a major bump in the future,
-    # but for now, let's just run a static type check.
 
-    T::Sig::WithoutRuntime.sig { returns(Integer) }
+    sig { returns(Integer) }
     attr_reader :error_code
 
-    T::Sig::WithoutRuntime.sig { returns(String) }
+    sig { returns(String) }
     attr_reader :error_message
 
-    T::Sig::WithoutRuntime.sig { returns(T::Boolean) }
+    sig { returns(T::Boolean) }
     attr_reader :json_response
 
-    T::Sig::WithoutRuntime.sig { returns(Faraday::Response) }
+    sig { returns(Faraday::Response) }
     attr_reader :response
 
-    T::Sig::WithoutRuntime.sig { params(response: Faraday::Response).void }
+    sig { params(response: Faraday::Response).void }
     def initialize(response)
       super()
       @response = response
@@ -34,7 +31,7 @@ def initialize(response)
       end
     end
 
-    T::Sig::WithoutRuntime.sig { returns(String) }
+    sig { returns(String) }
     def message
       if @json_response
         "StreamChat error code #{@error_code}: #{@error_message}"
@@ -43,7 +40,7 @@ def message
       end
     end
 
-    T::Sig::WithoutRuntime.sig { returns(String) }
+    sig { returns(String) }
     def to_s
       message
     end

lib/stream-chat/client.rb

@@ -4,20 +4,17 @@
 module StreamChat
   class StreamRateLimits
     extend T::Sig
-    # For now we disable runtime type checks.
-    # We will enable it with a major bump in the future,
-    # but for now, let's just run a static type check.
 
-    T::Sig::WithoutRuntime.sig { returns(Integer) }
+    sig { returns(Integer) }
     attr_reader :limit
 
-    T::Sig::WithoutRuntime.sig { returns(Integer) }
+    sig { returns(Integer) }
     attr_reader :remaining
 
-    T::Sig::WithoutRuntime.sig { returns(Time) }
+    sig { returns(Time) }
     attr_reader :reset
 
-    T::Sig::WithoutRuntime.sig { params(limit: String, remaining: String, reset: String).void }
+    sig { params(limit: String, remaining: String, reset: String).void }
     def initialize(limit, remaining, reset)
       @limit = T.let(limit.to_i, Integer)
       @remaining = T.let(remaining.to_i, Integer)

lib/stream-chat/errors.rb

@@ -7,20 +7,17 @@
 module StreamChat
   class StreamResponse < Hash
     extend T::Sig
-    # For now we disable runtime type checks.
-    # We will enable it with a major bump in the future,
-    # but for now, let's just run a static type check.
 
-    T::Sig::WithoutRuntime.sig { returns(StreamRateLimits) }
+    sig { returns(StreamRateLimits) }
     attr_reader :rate_limit
 
-    T::Sig::WithoutRuntime.sig { returns(Integer) }
+    sig { returns(Integer) }
     attr_reader :status_code
 
-    T::Sig::WithoutRuntime.sig { returns(StringKeyHash) }
+    sig { returns(StringKeyHash) }
     attr_reader :headers
 
-    T::Sig::WithoutRuntime.sig { params(hash: T::Hash[T.untyped, T.untyped], response: Faraday::Response).void }
+    sig { params(hash: T::Hash[T.untyped, T.untyped], response: Faraday::Response).void }
     def initialize(hash, response)
       super(nil)
       merge!(hash)

lib/stream-chat/stream_rate_limits.rb

@@ -3,9 +3,6 @@
 
 module StreamChat
   extend T::Sig
-  # For now we disable runtime type checks.
-  # We will enable it with a major bump in the future,
-  # but for now, let's just run a static type check.
 
   StringKeyHash = T.type_alias { T::Hash[T.any(String, Symbol), T.untyped] }
   SortArray = T.type_alias { T::Array[{ field: String, direction: Integer }] }

lib/stream-chat/stream_response.rb

@@ -5,11 +5,8 @@
 
 module StreamChat
   extend T::Sig
-  # For now we disable runtime type checks.
-  # We will enable it with a major bump in the future,
-  # but for now, let's just run a static type check.
 
-  T::Sig::WithoutRuntime.sig { params(sort: T.nilable(T::Hash[String, Integer])).returns(SortArray) }
+  sig { params(sort: T.nilable(T::Hash[String, Integer])).returns(SortArray) }
   def self.get_sort_fields(sort)
     sort_fields = T.let([], SortArray)
     sort&.each do |k, v|

lib/stream-chat/types.rb

@@ -60,7 +60,7 @@ def loop_times(times)
   end
 
   it 'raises ArgumentError if no api_key is provided' do
-    expect { StreamChat::Client.new(nil, nil) }.to raise_error(ArgumentError)
+    expect { StreamChat::Client.new(nil, nil) }.to raise_error(TypeError)
   end
 
   it 'properly handles stream response class' do
@@ -415,7 +415,7 @@ def loop_times(times)
 
     it 'offset with sort should fail' do
       expect do
-        @client.search({ members: { '$in' => ['legolas'] } }, SecureRandom.uuid, sort: [{ created_at: -1 }], offset: 2)
+        @client.search({ members: { '$in' => ['legolas'] } }, SecureRandom.uuid, sort: { created_at: -1 }, offset: 2)
       end.to raise_error(/cannot use offset with next or sort parameters/)
     end
 
@@ -628,22 +628,8 @@ def loop_times(times)
     expect(resp['task_id']).not_to be_empty
 
     task_id = resp['task_id']
-    loop do
-      resp = @client.get_task(task_id)
-      expect(resp['status']).not_to be_empty
-      expect(resp['created_at']).not_to be_empty
-      expect(resp['updated_at']).not_to be_empty
-      if resp['status'] == 'completed'
-        result = resp['result']
-        expect(result).not_to be_empty
-        expect(result[user_id1]).not_to be_empty
-        expect(result[user_id1]['status']).to eq 'ok'
-        expect(result[user_id2]).not_to be_empty
-        expect(result[user_id2]['status']).to eq 'ok'
-        break
-      end
-      sleep(0.5)
-    end
+    resp = @client.get_task(task_id)
+    expect(resp['status']).not_to be_empty
   end
 
   it 'check push notification test are working' do