Add RBS validation and runtime type checking to CI

This commit implements comprehensive RBS type checking for both the main gem and Pro package:

1. CI Integration:
   - Added `rake rbs:validate` to main lint workflow
   - Added RBS validation to Pro gem lint workflow
   - Added Steep static type checker to CI pipeline

2. Runtime Type Checking:
   - Configured RSpec to run with RBS runtime checking for gem tests
   - Tests now run with RBS_TEST_TARGET='ReactOnRails::*' RUBYOPT='-rrbs/test/setup'
   - This provides runtime validation of type signatures during test execution

3. Steep Static Type Checker:
   - Added steep gem to development dependencies
   - Created Steepfile configuration for static type analysis
   - Added `rake rbs:steep` task for running static type checks
   - Added `rake rbs:all` task to run both validation and steep checks

4. Pro Gem RBS Types:
   - Created sig/ directory structure for Pro gem
   - Added type signatures for:
     - ReactOnRailsPro module
     - Configuration class with all attributes
     - Error, Cache, and Utils modules
   - Foundation for expanding type coverage in Pro package

5. Documentation:
   - Configured Steepfile to check lib/ directory
   - Set up library dependencies for proper type resolution

Follows best practices from Evil Martians' "Climbing Steep Hills" article:
- Static validation with rbs validate
- Runtime checking with rbs/test/setup
- Static analysis with Steep

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

Author: justin808

.github/workflows/lint-js-and-ruby.yml

@@ -89,6 +89,10 @@ jobs:
         run: bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
       - name: Lint Ruby
         run: bundle exec rubocop
+      - name: Validate RBS type signatures
+        run: bundle exec rake rbs:validate
+      - name: Run Steep type checker
+        run: bundle exec rake rbs:steep
       - name: Install Node modules with Yarn for dummy app
         run: cd spec/dummy && yarn install --no-progress --no-emoji --frozen-lockfile
       - name: Save dummy app ruby gems to cache

.github/workflows/pro-lint.yml

@@ -123,6 +123,9 @@ jobs:
       - name: Lint Ruby
         run: bundle exec rubocop
 
+      - name: Validate RBS type signatures
+        run: bundle exec rbs -I sig validate
+
       - name: Lint JS
         run: yarn run nps eslint
 

Gemfile.development_dependencies

@@ -34,6 +34,7 @@ group :development, :test do
   gem "pry-rails"
   gem "pry-rescue"
   gem "rbs", require: false
+  gem "steep", require: false
   gem "rubocop", "1.61.0", require: false
   gem "rubocop-performance", "~>1.20.0", require: false
   gem "rubocop-rspec", "~>2.26", require: false

Gemfile.lock

@@ -120,6 +120,7 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     crass (1.0.6)
+    csv (3.3.5)
     date (3.3.4)
     debug (1.9.2)
       irb (~> 1.10)
@@ -133,6 +134,7 @@ GEM
     erubi (1.13.1)
     execjs (2.9.1)
     ffi (1.16.3)
+    fileutils (1.8.0)
     gem-release (2.2.2)
     generator_spec (0.10.0)
       activesupport (>= 3.0.0)
@@ -347,6 +349,7 @@ GEM
       sass (~> 3.5, >= 3.5.5)
     sdoc (2.6.1)
       rdoc (>= 5.0)
+    securerandom (0.4.1)
     selenium-webdriver (4.9.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
@@ -373,11 +376,29 @@ GEM
       sprockets (>= 3.0.0)
     sqlite3 (1.7.3)
       mini_portile2 (~> 2.8.0)
+    steep (1.9.4)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.8)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+      uri (>= 0.12.0)
     stringio (3.1.7)
     strscan (3.1.0)
     sync (0.5.0)
     term-ansicolor (1.8.0)
       tins (~> 1.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     thor (1.4.0)
     tilt (2.3.0)
     timeout (0.4.1)
@@ -397,6 +418,7 @@ GEM
     uglifier (4.2.0)
       execjs (>= 0.3.0, < 3)
     unicode-display_width (2.5.0)
+    uri (1.1.1)
     webdrivers (5.3.0)
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
@@ -455,6 +477,7 @@ DEPENDENCIES
   spring (~> 4.0)
   sprockets (~> 4.0)
   sqlite3 (~> 1.6)
+  steep
   turbo-rails
   turbolinks
   uglifier

Steepfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Steepfile - Configuration for Steep type checker
+# See https://github.com/soutaro/steep for documentation
+
+D = Steep::Diagnostic
+
+target :lib do
+  # Specify the directories to type check
+  check "lib"
+
+  # Specify RBS signature directories
+  signature "sig"
+
+  # Configure libraries (gems) - Steep will load their RBS signatures
+  configure_code_diagnostics(D::Ruby.default)
+
+  # Library configuration
+  library "pathname"
+  library "singleton"
+  library "logger"
+  library "monitor"
+  library "securerandom"
+end

rakelib/rbs.rake

@@ -34,5 +34,26 @@ namespace :rbs do
     sig_files.each { |f| puts "  #{f}" }
     puts "\nTotal: #{sig_files.count} files"
   end
+
+  desc "Run Steep type checker"
+  task :steep do
+    puts "Running Steep type checker..."
+
+    result = system("bundle exec steep check")
+
+    case result
+    when true
+      puts "✓ Steep type checking passed"
+    when false
+      puts "✗ Steep type checking failed"
+      exit 1
+    when nil
+      puts "✗ Steep command not found or could not be executed"
+      exit 1
+    end
+  end
+
+  desc "Run all RBS checks (validate + steep)"
+  task all: %i[validate steep]
 end
 # rubocop:enable Metrics/BlockLength

rakelib/run_rspec.rake

@@ -22,7 +22,9 @@ namespace :run_rspec do
 
   desc "Run RSpec for top level only"
   task :gem do
-    run_tests_in("", rspec_args: File.join("spec", "react_on_rails"))
+    run_tests_in("",
+                 rspec_args: File.join("spec", "react_on_rails"),
+                 env_vars: "RBS_TEST_TARGET='ReactOnRails::*' RUBYOPT='-rrbs/test/setup'")
   end
 
   desc "Runs dummy rspec with turbolinks"

react_on_rails_pro/sig/react_on_rails_pro.rbs

@@ -0,0 +1,5 @@
+module ReactOnRailsPro
+  def self.configure: () { (Configuration) -> void } -> void
+
+  def self.configuration: () -> Configuration
+end

react_on_rails_pro/sig/react_on_rails_pro/cache.rbs

@@ -0,0 +1,7 @@
+module ReactOnRailsPro
+  module Cache
+    def self.fetch: (String key) { () -> String } -> String
+
+    def self.enabled?: () -> bool
+  end
+end

react_on_rails_pro/sig/react_on_rails_pro/configuration.rbs

@@ -0,0 +1,100 @@
+module ReactOnRailsPro
+  class Configuration
+    DEFAULT_RENDERER_URL: String
+    DEFAULT_RENDERER_METHOD: String
+    DEFAULT_RENDERER_FALLBACK_EXEC_JS: bool
+    DEFAULT_RENDERER_HTTP_POOL_SIZE: Integer
+    DEFAULT_RENDERER_HTTP_POOL_TIMEOUT: Integer
+    DEFAULT_RENDERER_HTTP_POOL_WARN_TIMEOUT: Float
+    DEFAULT_SSR_TIMEOUT: Integer
+    DEFAULT_PRERENDER_CACHING: bool
+    DEFAULT_TRACING: bool
+    DEFAULT_DEPENDENCY_GLOBS: Array[untyped]
+    DEFAULT_EXCLUDED_DEPENDENCY_GLOBS: Array[untyped]
+    DEFAULT_REMOTE_BUNDLE_CACHE_ADAPTER: nil
+    DEFAULT_RENDERER_REQUEST_RETRY_LIMIT: Integer
+    DEFAULT_THROW_JS_ERRORS: bool
+    DEFAULT_RENDERING_RETURNS_PROMISES: bool
+    DEFAULT_PROFILE_SERVER_RENDERING_JS_CODE: bool
+    DEFAULT_RAISE_NON_SHELL_SERVER_RENDERING_ERRORS: bool
+    DEFAULT_ENABLE_RSC_SUPPORT: bool
+    DEFAULT_RSC_PAYLOAD_GENERATION_URL_PATH: String
+    DEFAULT_RSC_BUNDLE_JS_FILE: String
+    DEFAULT_REACT_CLIENT_MANIFEST_FILE: String
+    DEFAULT_REACT_SERVER_CLIENT_MANIFEST_FILE: String
+
+    attr_accessor renderer_url: String?
+    attr_accessor renderer_password: String?
+    attr_accessor tracing: bool?
+    attr_accessor server_renderer: String?
+    attr_accessor renderer_use_fallback_exec_js: bool?
+    attr_accessor prerender_caching: bool?
+    attr_accessor renderer_http_pool_size: Integer?
+    attr_accessor renderer_http_pool_timeout: Integer?
+    attr_accessor renderer_http_pool_warn_timeout: Float?
+    attr_accessor dependency_globs: Array[String]?
+    attr_accessor excluded_dependency_globs: Array[String]?
+    attr_accessor rendering_returns_promises: bool?
+    attr_accessor remote_bundle_cache_adapter: Module?
+    attr_accessor ssr_pre_hook_js: String?
+    attr_accessor assets_to_copy: Array[String]?
+    attr_accessor renderer_request_retry_limit: Integer?
+    attr_accessor throw_js_errors: bool?
+    attr_accessor ssr_timeout: Integer?
+    attr_accessor profile_server_rendering_js_code: bool?
+    attr_accessor raise_non_shell_server_rendering_errors: bool?
+    attr_accessor enable_rsc_support: bool?
+    attr_accessor rsc_payload_generation_url_path: String?
+    attr_accessor rsc_bundle_js_file: String?
+    attr_accessor react_client_manifest_file: String?
+    attr_accessor react_server_client_manifest_file: String?
+
+    def initialize: (
+      ?renderer_url: String?,
+      ?renderer_password: String?,
+      ?server_renderer: String?,
+      ?renderer_use_fallback_exec_js: bool?,
+      ?prerender_caching: bool?,
+      ?renderer_http_pool_size: Integer?,
+      ?renderer_http_pool_timeout: Integer?,
+      ?renderer_http_pool_warn_timeout: Float?,
+      ?tracing: bool?,
+      ?dependency_globs: Array[String]?,
+      ?excluded_dependency_globs: Array[String]?,
+      ?rendering_returns_promises: bool?,
+      ?remote_bundle_cache_adapter: Module?,
+      ?ssr_pre_hook_js: String?,
+      ?assets_to_copy: Array[String]?,
+      ?renderer_request_retry_limit: Integer?,
+      ?throw_js_errors: bool?,
+      ?ssr_timeout: Integer?,
+      ?profile_server_rendering_js_code: bool?,
+      ?raise_non_shell_server_rendering_errors: bool?,
+      ?enable_rsc_support: bool?,
+      ?rsc_payload_generation_url_path: String?,
+      ?rsc_bundle_js_file: String?,
+      ?react_client_manifest_file: String?,
+      ?react_server_client_manifest_file: String?
+    ) -> void
+
+    def setup_config_values: () -> void
+
+    def check_react_on_rails_support_for_rsc: () -> void
+
+    def setup_execjs_profiler_if_needed: () -> void
+
+    def node_renderer?: () -> bool
+
+    private
+
+    def setup_assets_to_copy: () -> void
+
+    def configure_default_url_if_not_provided: () -> void
+
+    def validate_url: () -> void
+
+    def validate_remote_bundle_cache_adapter: () -> void
+
+    def setup_renderer_password: () -> void
+  end
+end