Fix Rails 8.2 deprecation warnings and improve Rack compatibility #1483
+582
−70
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update .gitignore to exclude all log files in the log/ directory to prevent them from being tracked in the repository. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Enhance test coverage measurement capabilities: Changes: - Configure SimpleCov with detailed settings in test_helper.rb - Add filters to exclude test/, config/, vendor/ directories - Add coverage groups (Controllers, Resources, Serializers, etc.) - Enable branch coverage tracking (Ruby 2.5+) - Configure multi-format output (HTML + Console) - Clean up .gitignore (remove duplicate coverage entry) - Update .dockerignore to exclude coverage artifacts - Add coverage instructions to CLAUDE.md (local & Docker) Test results with Rails 6.1.7.10: - Line Coverage: 92.04% (3491/3793 lines) - Branch Coverage: 85.13% (853/1002 branches) - All 674 tests passing Usage: COVERAGE=true bundle exec rake test docker-compose run -e COVERAGE=true rails-6.1 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Implement Rails 7.1 compatibility fixes while maintaining backward compatibility with Rails 6.1 and 7.0: Changes: - Fix version-conditional app initialization in test_helper.rb - Rails 7.1+ requires TestApp.initialize! before rails/test_help - Rails 6.1/7.0 require opposite order - Fix schema compatibility in active_record.rb - Change t.string :length option to :limit (Rails 7.1 deprecation) - Change t.references :references option to foreign_key: false - Disable SQLite foreign key constraints in test environment - Rails 7.1 enables strict FK constraints by default - Added PRAGMA foreign_keys = OFF for test compatibility Backward compatibility verified: - Rails 6.1.7.10: ✅ 674/674 tests passing - Rails 7.0.10: ✅ 674/674 tests passing Rails 7.1.6 status: - 664/674 tests passing (98.5%) - 1 failure: RequestTest expecting 422, got 0 - 9 errors: "Invalid response code: 0" in controller tests Remaining work: - Investigate and fix response code 0 errors - Get all 674 tests passing in Rails 7.1.6 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Fix status code handling for Rack 3.0+ compatibility: Root cause: - Rack 3.0+ deprecated :unprocessable_entity symbol in favor of :unprocessable_content - When JSONAPI::Error looked up :unprocessable_entity in Rack::Utils::SYMBOL_TO_STATUS_CODE, it returned nil, causing response status to be 0 instead of 422 - This broke 10 tests that expected proper error status codes Solution: - Add DEPRECATED_STATUS_SYMBOLS mapping in JSONAPI::Error - Implement status_code_for() helper method that: 1. Tries the symbol directly first (works for all non-deprecated symbols) 2. Falls back to new symbol if deprecated symbol not found 3. Returns nil-safe string result - Apply helper to both initialize() and update_with_overrides() methods This maintains full backward compatibility: - Rails 6.1 with Rack 2.x: :unprocessable_entity works directly - Rails 7.0 with Rack 2.x: :unprocessable_entity works directly - Rails 7.1+ with Rack 3.x: :unprocessable_entity maps to :unprocessable_content Test results: - Rails 6.1.7.10: ✅ 674/674 tests passing - Rails 7.0.10: ✅ 674/674 tests passing - Rails 7.1.6: ✅ 674/674 tests passing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add full Rails 7.2 compatibility while maintaining backward compatibility with Rails 6.1, 7.0, and 7.1. Key Changes: 1. Deprecation API Updates (Rails 7.2 made methods private): - Add JSONAPI.warn_deprecated() helper method - Replace all ActiveSupport::Deprecation.warn calls - Handle ActiveSupport::Deprecation.silenced= conditionally in tests - Falls back to Kernel#warn with [DEPRECATION] prefix for Rails 7.2+ 2. Configuration Initialization Fix: - Change from attr_accessor to custom getter method - Ensures @configuration ||= Configuration.new works reliably - Fixed "undefined method for nil" errors in 304 tests 3. Test Fixture Path Changes: - Rails 7.2 changed fixture_path= to fixture_paths= (array) - Add conditional handling in three test classes: * Minitest::Test * ActiveSupport::TestCase * ActionDispatch::IntegrationTest 4. Test Helper Deprecation Silencing: - Update test_helper.rb to handle Rails 7.2 deprecators API - Conditional logic for silencing deprecation warnings Files Modified: - lib/jsonapi/configuration.rb: Added warn_deprecated helper + fixed getter - lib/jsonapi/basic_resource.rb: Use JSONAPI.warn_deprecated - lib/jsonapi/acts_as_resource_controller.rb: Use JSONAPI.warn_deprecated - lib/jsonapi/relationship.rb: Use JSONAPI.warn_deprecated - test/test_helper.rb: Fixture paths + deprecation silencing - test/unit/resource/resource_test.rb: Conditional silenced= handling - test/integration/requests/request_test.rb: Conditional silenced= handling Test Results: - Rails 6.1.7.10: ✅ 674/674 tests passing - Rails 7.0.10: ✅ 674/674 tests passing - Rails 7.1.6: ✅ 674/674 tests passing - Rails 7.2.3: ✅ 674/674 tests passing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add full Rails 8.0 compatibility while maintaining backward compatibility
with Rails 6.1, 7.0, 7.1, and 7.2.
Key Changes:
1. SQLite3 Dependency Update:
- Rails 8.0 requires sqlite3 >= 2.1 (was ~> 1.4)
- Add conditional gem requirement in Gemfile:
* Rails 8.x: sqlite3 >= 2.1
* Rails 6-7: sqlite3 ~> 1.4
- Use bundle lock --add-platform ruby for cross-platform support
2. Schema Format Configuration:
- Rails 8.0 removed :none as valid schema_format option
- Add version-conditional logic in test_helper.rb:
* Rails 8.0+: Use :ruby format
* Rails < 8.0: Use :none format (disables schema dumps)
Files Modified:
- Gemfile: Added Rails 8.x sqlite3 version condition
- test/test_helper.rb: Conditional schema_format based on Rails version
Test Results:
- Rails 6.1.7.10: ✅ 674/674 tests passing
- Rails 7.0.10: ✅ 674/674 tests passing
- Rails 7.1.6: ✅ 674/674 tests passing
- Rails 7.2.3: ✅ 674/674 tests passing
- Rails 8.0.4: ✅ 674/674 tests passing
All backward compatibility maintained across Rails 6.1-8.0.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Preserve original initialization order for Rails < 7.1 - Use new initialization order only for Rails 7.1+ - Keep SimpleCov improvements - Maintain fixture_path/fixture_paths compatibility
Fix CI failures with Ruby 2.6 and Rails 6.0/6.1 by adding explicit require 'logger' to prevent NameError: uninitialized constant ActiveSupport::LoggerThreadSafeLevel::Logger
Add default_sort to Api::V2::BookCommentResource to ensure stable ordering across cache and non-cache scenarios. Without explicit ordering, PostgreSQL may return results in different orders, causing cache test failures. Fixes: RequestTest#test_pagination_related_resources_data_includes
The test was failing on Ruby 2.7 with Rails 5.2.8.1 because ActiveRecord deprecation warnings were appearing in stderr alongside the expected performance warning, causing the exact string match assertion to fail. Changes: - Replace assert_equal with assert_match to check for presence of the performance warning rather than exact stderr match - Replace assert_empty with refute_match to verify the performance warning doesn't appear when disabled, while tolerating environment- specific deprecation warnings This makes the test more robust across different Ruby/Rails versions while still validating the core functionality. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add explicit ordering by id to Book's book_comments and approved_book_comments associations. Without explicit ordering, PostgreSQL returns relationship data in non-deterministic order, causing cache test failures where warmup response differs from normal response. The previous fix added default_sort to BookCommentResource, which handles collection queries, but didn't affect relationship linkage data in included resources. This fix ensures stable ordering at the ActiveRecord association level. Fixes: RequestTest#test_pagination_related_resources_data_includes Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Expand GitHub Actions CI matrix to test newly supported versions: Ruby versions added: - Ruby 3.3 - Ruby 3.4 Rails versions added/updated: - Rails 8.1.2 (newly supported) - Rails 8.0.4 (newly supported) - Rails 7.2.3 (newly supported) - Rails 7.1.6 (newly supported) - Rails 7.0.10 (updated from 7.0.4) - Rails 6.1.7.10 (updated from 6.1.7) Compatibility matrix: - Ruby 2.6: Rails 5.1.7 - 6.1.7.10 - Ruby 2.7: Rails 5.1.7 - 7.0.10 - Ruby 3.0: Rails 6.1.7.10 - 7.1.6 - Ruby 3.1: Rails 6.1.7.10 - 7.2.3 - Ruby 3.2: Rails 6.1.7.10 - 8.1.2 - Ruby 3.3: Rails 6.1.7.10 - 8.1.2 - Ruby 3.4: Rails 7.2.3 - 8.1.2 This expands test coverage from ~20 to ~61 combinations across PostgreSQL and SQLite databases, ensuring comprehensive validation of the gem's Rails 8.1 support. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Ruby 3.4 removed csv from the default gems, requiring it to be explicitly added as a dependency. The gem is used in three places: - lib/jsonapi/basic_resource.rb:734 - parsing filter values - lib/jsonapi/request.rb:353 - parsing included resources - lib/jsonapi/request.rb:415 - parsing sorts Without this dependency, Ruby 3.4 fails with: cannot load such file -- csv (LoadError) Adding csv as a runtime dependency is safe for all Ruby versions as it's available in the standard library for older versions. Fixes Ruby 3.4 CI failures. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The previous fix adding order(:id) to Book's has_many :book_comments
association was not sufficient. In some contexts (particularly with
Rails 8 and caching), the association scope was not being applied
consistently, leading to non-deterministic ordering in PostgreSQL.
Adding default_scope { order(:id) } to BookComment ensures that all
queries against this model return results in a consistent order,
regardless of how they are accessed (direct queries, associations,
eager loading, etc.).
This is a test-only change that ensures stable test results across
different Rails versions and database engines.
Fixes: RequestTest#test_pagination_related_resources_data_includes
(flaky on Rails 8.1.2 + PostgreSQL)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Rails 7.1-8.1 support with Ruby 3.3-3.4 compatibility
- Add Dockerfile with Ruby 3.2 and required dependencies - Add docker-compose.yml with services for Rails 6.1 and 7.0 - Add .dockerignore to exclude unnecessary files from Docker context - Update .gitignore to use coverage/ directory and remove duplicate entry This provides an easy way to test the gem with different Rails versions in isolated Docker environments.
Expand docker-compose.yml to include services for all supported Rails versions from the CI matrix: Services added: - rails-7.1: Rails 7.1.6 - rails-7.2: Rails 7.2.3 - rails-8.0: Rails 8.0.4 - rails-8.1: Rails 8.1.2 Updated services: - rails-6.1: 6.1.7 → 6.1.7.10 - rails-7.0: 7.0.4 → 7.0.10 - shell: default Rails version 6.1.7 → 8.1.2 Usage: docker-compose run rails-7.1 docker-compose run rails-7.2 docker-compose run rails-8.0 docker-compose run rails-8.1 This matches the expanded CI matrix and enables local testing across all supported Rails versions. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change command from "bundle update" to "rm -f Gemfile.lock && bundle install" to avoid dependency conflicts between different Rails versions. With "bundle update", the existing Gemfile.lock would cause version resolution failures when switching between Rails versions, especially when both activerecord and railties are specified with different version requirements. Removing Gemfile.lock ensures each container gets the correct dependencies for its specified RAILS_VERSION environment variable. Tested and verified all services pass: - Rails 6.1.7.10: 674 runs, 8772 assertions, 0 failures ✅ - Rails 7.0.10: 674 runs, 8772 assertions, 0 failures ✅ - Rails 7.1.6: 674 runs, 8772 assertions, 0 failures ✅ - Rails 7.2.3: 674 runs, 8772 assertions, 0 failures ✅ - Rails 8.0.4: 674 runs, 8772 assertions, 0 failures ✅ - Rails 8.1.2: 674 runs, 8772 assertions, 0 failures ✅ Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add test/test_db-shm and test/test_db-wal to .gitignore to exclude SQLite Write-Ahead Logging (WAL) mode files that are created during test execution. These files are temporary database files created by SQLite when WAL mode is enabled and should not be tracked in version control. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Docker Compose services for older Rails versions to enable comprehensive testing across the full compatibility matrix: Services added: - rails-5.1: Rails 5.1.7 - rails-5.2: Rails 5.2.8.1 - rails-6.0: Rails 6.0.6 Usage: docker-compose run rails-5.1 docker-compose run rails-5.2 docker-compose run rails-6.0 This completes the Docker setup for all Rails versions supported in the CI matrix (5.1.7 through 8.1.2). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Dockerfile.ruby2.7 to support older Rails versions that are not compatible with Ruby 3.2. Based on CI matrix compatibility: Ruby 2.7 supports: - Rails 5.1.7 ✅ - Rails 5.2.8.1 ✅ - Rails 6.0.6 ✅ - Rails 6.1.7.10 (also works with Ruby 3.2) - Rails 7.0.10 (also works with Ruby 3.2) Ruby 3.2 (existing Dockerfile): - Rails 6.1.7.10 ✅ - Rails 7.0.10 ✅ - Rails 7.1.6 ✅ - Rails 7.2.3 ✅ - Rails 8.0.4 ✅ - Rails 8.1.2 ✅ Changes: - Add Dockerfile.ruby2.7 with Ruby 2.7 base image - Update docker-compose.yml to use Ruby 2.7 for Rails 5.1, 5.2, 6.0 - Add bundle-cache-ruby27 volume for separate gem caching - Keep Ruby 3.2 for Rails 6.1-8.1 This ensures all Rails versions in the CI matrix can be tested locally with the appropriate Ruby version. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Ruby 2.7 requires bundler < 2.5. Install bundler 2.4.22 specifically to avoid compatibility issues. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Psych patch to allow loading Date, Time, DateTime classes from YAML fixtures in Rails 6.0 test environment. Rails 6.0 + Ruby 2.7 combination uses Psych 3.1+, which introduced stricter security for YAML.load. The default safe_load behavior rejects Date/Time/DateTime classes, causing test fixtures to fail. Solution: Patch Psych.load to use unsafe_load in test environment. This is safe since we're only loading trusted test fixture files. Fixes error: Psych::DisallowedClass: Tried to load unspecified class: Date Test result: Rails 6.0.6 now passes all 674 tests ✅ Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Replace Ruby 3.2 with Ruby 3.1.5 for Rails 6.1-8.1 testing. This change will be validated by running tests on each version sequentially. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Updated Docker configuration to use specific Ruby versions for each Rails version: - Rails 5.1-6.0: Ruby 2.7 with bundler 2.4.22 - Rails 6.1-7.2: Ruby 3.1.5 with bundler 2.4.14 - Rails 8.0-8.1: Ruby 3.4 with bundler 2.4.14 Rails 8.0+ requires Ruby >= 3.2.0, so we use Ruby 3.4 for these versions. All tests pass successfully for all 9 Rails versions. Changes: - Created Dockerfile.ruby3.1 for Ruby 3.1.5 - Created Dockerfile.ruby3.4 for Ruby 3.4 - Updated docker-compose.yml to use appropriate Ruby versions - Added separate bundle cache volumes for each Ruby version Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add Docker support for multi-version Rails testing
This commit addresses two issues: 1. Rails 8.2 Deprecation Warning: Update routing_ext.rb to use keyword arguments instead of hash arguments when calling `resource` and `resources` methods. The hash argument support will be removed in Rails 8.2. 2. Rack Compatibility: Update status_code_for method to prefer Rack::Utils.status_code (Rack 3.0+) while maintaining backward compatibility with Rack 2.x using SYMBOL_TO_STATUS_CODE. Addresses feedback from #1 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Author
|
I'm sorry, this is misstake. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses two issues raised in feedback comments on speee#1:
Rails 8.2 Deprecation Warning (comment)
routing_ext.rbto use keyword arguments (**options) instead of hash argumentsRack Compatibility (comment)
status_code_formethod to preferRack::Utils.status_code(Rack 3.0+)SYMBOL_TO_STATUS_CODEChanges
lib/jsonapi/routing_ext.rb(lines 49, 136): Changedoptionsto**optionslib/jsonapi/error.rb(status_code_for method): Updated to useRack::Utils.status_codewith fallbackTest Results
All tests pass across multiple Rails versions:
Test plan
🤖 Generated with Claude Code