fix steep type checks

Author: THardy98

temporalio/lib/temporalio/envconfig.rb

@@ -245,7 +245,10 @@ def to_hash
         hash[:address] = @address if @address
         hash[:namespace] = @namespace if @namespace
         hash[:api_key] = @api_key if @api_key
-        hash[:tls] = @tls.to_hash if @tls && !@tls.to_hash.empty?
+        if @tls
+          tls_hash = @tls.to_hash # steep:ignore
+          hash[:tls] = tls_hash unless tls_hash.empty?
+        end
         hash[:grpc_meta] = @grpc_meta if @grpc_meta && !@grpc_meta.empty?
         hash
       end
@@ -257,7 +260,7 @@ def to_client_connect_config
         config[:target_host] = @address if @address
         config[:namespace] = @namespace if @namespace
         config[:api_key] = @api_key if @api_key
-        config[:tls] = @tls.to_connect_tls_config if @tls
+        config[:tls] = @tls.to_connect_tls_config if @tls # steep:ignore
         config[:rpc_metadata] = @grpc_meta if @grpc_meta && !@grpc_meta.empty?
         config
       end

temporalio/sig/temporalio/envconfig.rbs

@@ -0,0 +1,87 @@
+module Temporalio
+  module EnvConfig
+    def self.source_to_path_and_data: (untyped source) -> [String?, Array[Integer]?]
+
+    class ClientConfigTLS
+      attr_reader disabled: bool
+      attr_reader server_name: String?
+      attr_reader server_root_ca_cert: (Pathname | String)?
+      attr_reader client_cert: (Pathname | String)?
+      attr_reader client_private_key: (Pathname | String)?
+
+      def self.from_hash: (Hash[untyped, untyped]? hash) -> ClientConfigTLS?
+      def self.hash_to_source: (Hash[untyped, untyped]? hash) -> (Pathname | String)?
+
+      def initialize: (
+        ?disabled: bool,
+        ?server_name: String?,
+        ?server_root_ca_cert: (Pathname | String)?,
+        ?client_cert: (Pathname | String)?,
+        ?client_private_key: (Pathname | String)?
+      ) -> void
+
+      def to_hash: -> Hash[Symbol, untyped]
+      def to_connect_tls_config: -> (Hash[Symbol, untyped] | false)
+
+      private
+
+      def source_to_hash: (untyped source) -> Hash[Symbol, String]?
+      def read_source: (untyped source) -> String?
+    end
+
+    class ClientConfigProfile
+      attr_reader address: String?
+      attr_reader namespace: String?
+      attr_reader api_key: String?
+      attr_reader tls: ClientConfigTLS?
+      attr_reader grpc_meta: Hash[untyped, untyped]
+
+      def self.from_hash: (Hash[untyped, untyped] hash) -> ClientConfigProfile
+
+      def self.load: (
+        ?profile: String?,
+        ?config_source: (Pathname | String)?,
+        ?disable_file: bool,
+        ?disable_env: bool,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> ClientConfigProfile
+
+      def initialize: (
+        ?address: String?,
+        ?namespace: String?,
+        ?api_key: String?,
+        ?tls: ClientConfigTLS?,
+        ?grpc_meta: Hash[untyped, untyped]
+      ) -> void
+
+      def to_hash: -> Hash[Symbol, untyped]
+      def to_client_connect_config: -> Hash[Symbol, untyped]
+    end
+
+    class ClientConfig
+      attr_reader profiles: Hash[String, ClientConfigProfile]
+
+      def self.from_hash: (Hash[untyped, untyped] hash) -> ClientConfig
+
+      def self.load: (
+        ?config_source: (Pathname | String)?,
+        ?disable_file: bool,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> ClientConfig
+
+      def self.load_client_connect_config: (
+        ?profile: String?,
+        ?config_source: (Pathname | String)?,
+        ?disable_file: bool,
+        ?disable_env: bool,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> Hash[Symbol, untyped]
+
+      def initialize: (Hash[String, ClientConfigProfile] profiles) -> void
+      def to_hash: -> Hash[String, Hash[Symbol, untyped]]
+    end
+  end
+end 

temporalio/test/envconfig_test.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'pathname'
+require 'tmpdir'
 require 'temporalio/client'
 require 'temporalio/envconfig'
 require_relative 'test'
@@ -93,7 +94,7 @@ def test_load_profile_from_file_custom
       assert_equal 'custom-address', profile.address
       assert_equal 'custom-namespace', profile.namespace
       refute_nil profile.tls
-      assert_equal 'custom-server-name', profile.tls.server_name
+      assert_equal 'custom-server-name', profile.tls.server_name # steep:ignore
       assert_equal 'custom-value', profile.grpc_meta['custom-header']
 
       config = profile.to_client_connect_config
@@ -123,7 +124,7 @@ def test_load_profile_from_data_custom
     assert_equal 'custom-address', profile.address
     assert_equal 'custom-namespace', profile.namespace
     refute_nil profile.tls
-    assert_equal 'custom-server-name', profile.tls.server_name
+    assert_equal 'custom-server-name', profile.tls.server_name # steep:ignore
     assert_equal 'custom-value', profile.grpc_meta['custom-header']
 
     config = profile.to_client_connect_config
@@ -166,7 +167,7 @@ def test_load_profile_env_overrides
       assert_equal 'env-namespace', profile.namespace
       assert_equal 'env-api-key', profile.api_key
       refute_nil profile.tls
-      assert_equal 'env-server-name', profile.tls.server_name
+      assert_equal 'env-server-name', profile.tls.server_name # steep:ignore
 
       config = profile.to_client_connect_config
       assert_equal 'env-address', config[:target_host]
@@ -369,7 +370,7 @@ def test_load_profile_tls_options
       config_source: TOML_CONFIG_TLS_DETAILED, profile: 'tls_disabled'
     )
     refute_nil profile_disabled.tls
-    assert profile_disabled.tls.disabled
+    assert profile_disabled.tls.disabled # steep:ignore
 
     config_disabled = profile_disabled.to_client_connect_config
     assert_equal false, config_disabled[:tls]
@@ -379,13 +380,13 @@ def test_load_profile_tls_options
       config_source: TOML_CONFIG_TLS_DETAILED, profile: 'tls_with_certs'
     )
     refute_nil profile_certs.tls
-    assert_equal 'custom-server', profile_certs.tls.server_name
-    refute_nil profile_certs.tls.server_root_ca_cert
-    assert_equal 'ca-pem-data', profile_certs.tls.server_root_ca_cert
-    refute_nil profile_certs.tls.client_cert
-    assert_equal 'client-crt-data', profile_certs.tls.client_cert
-    refute_nil profile_certs.tls.client_private_key
-    assert_equal 'client-key-data', profile_certs.tls.client_private_key
+    assert_equal 'custom-server', profile_certs.tls.server_name # steep:ignore
+    refute_nil profile_certs.tls.server_root_ca_cert # steep:ignore
+    assert_equal 'ca-pem-data', profile_certs.tls.server_root_ca_cert # steep:ignore
+    refute_nil profile_certs.tls.client_cert # steep:ignore
+    assert_equal 'client-crt-data', profile_certs.tls.client_cert # steep:ignore
+    refute_nil profile_certs.tls.client_private_key # steep:ignore
+    assert_equal 'client-key-data', profile_certs.tls.client_private_key # steep:ignore
 
     config_certs = profile_certs.to_client_connect_config
     tls_config_certs = config_certs[:tls]
@@ -397,7 +398,7 @@ def test_load_profile_tls_options
   end
 
   def test_load_profile_tls_from_paths
-    Dir.mktmpdir do |tmpdir|
+    Dir.mktmpdir do |tmpdir| # steep:ignore
       # Create dummy cert files
       ca_pem_path = File.join(tmpdir, 'ca.pem')
       client_crt_path = File.join(tmpdir, 'client.crt')
@@ -419,13 +420,13 @@ def test_load_profile_tls_from_paths
 
       profile = Temporalio::EnvConfig::ClientConfigProfile.load(config_source: toml_config)
       refute_nil profile.tls
-      assert_equal 'custom-server', profile.tls.server_name
-      refute_nil profile.tls.server_root_ca_cert
-      assert_equal ca_pem_path, profile.tls.server_root_ca_cert
-      refute_nil profile.tls.client_cert
-      assert_equal client_crt_path, profile.tls.client_cert
-      refute_nil profile.tls.client_private_key
-      assert_equal client_key_path, profile.tls.client_private_key
+      assert_equal 'custom-server', profile.tls.server_name # steep:ignore
+      refute_nil profile.tls.server_root_ca_cert # steep:ignore
+      assert_equal ca_pem_path, profile.tls.server_root_ca_cert # steep:ignore
+      refute_nil profile.tls.client_cert # steep:ignore
+      assert_equal client_crt_path, profile.tls.client_cert # steep:ignore
+      refute_nil profile.tls.client_private_key # steep:ignore
+      assert_equal client_key_path, profile.tls.client_private_key # steep:ignore
 
       config = profile.to_client_connect_config
       tls_config = config[:tls]
@@ -895,7 +896,7 @@ def test_e2e_multi_profile_different_client_connections
   private
 
   def with_temp_config_file(content)
-    Dir.mktmpdir do |tmpdir|
+    Dir.mktmpdir do |tmpdir| # steep:ignore
       config_file = File.join(tmpdir, 'config.toml')
       File.write(config_file, content)
       yield config_file

temporalio/test/sig/envconfig_test.rbs

@@ -0,0 +1,10 @@
+class EnvConfigTest < Test
+  TOML_CONFIG_BASE: String
+  TOML_CONFIG_STRICT_FAIL: String
+  TOML_CONFIG_MALFORMED: String
+  TOML_CONFIG_TLS_DETAILED: String
+
+  private
+
+  def with_temp_config_file: [T] (String content) { (String config_file) -> T } -> T
+end