Add test support for Ruby 2.6 and 2.7 and 3.0 #256
Merged
Conversation
This file contains 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
davidpatrick
changed the title
davidpatrick
changed the title
Merged
eric-hemasystems
pushed a commit
to eric-hemasystems/sync_attr_with_auth0
that referenced
this pull request
Feb 18, 2021
For BloodRelay I want to use a newer version of the Auth0 library. URI.escape has been throwing deprecation warnings for a while but now it's removed from Ruby 3 which means we need to be on a newer version of Auth0 that no longer uses that method[1]. Had to decide if we want to stay on the 4.x series of Auth0 or the 5.x series due to a breaking change in `create_user` (or have our library detect the version and call with the right arguments)[2]. I opted to require v5 since it is better tested against recent versions of Ruby[3]. Upgrading the auth0 gem required moving to the 2.2.x series of the JWT library. The method doing the base64 encoding of the JWT signature has moved. Also the `typ` header is no longer generated[4]. It seems it is not required by the spec but Auth0 does require it so adding it as a parameter manually. The algorithm param is the same as the default. I just had to specify it to pass in header options. Other than these library upgrades and the code changes caused by the upgrades this commit includes no change in functionality. The test suite passes but since it's heavily mocked I'll also note I have already tested this against an upgraded version of BR to verify it really doesn't break anything (this is how the `typ` thing was discovered). 1. auth0/ruby-auth0#202 2. auth0/ruby-auth0#244 3. auth0/ruby-auth0#256 4. jwt/ruby-jwt#233
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hello, maintainers - thank you for the great gem.
This is super useful, and makes our life a lot easier to work with auth0!
This PR is a suggestion to explicitly cover latest versions of Ruby using circle ci.
While it make sense to provide support to apps that relies on older ruby, I hope this gem to also cover latest versions, 2.6 and 2.7. (Ideally up to Ruby 3.0, which I didn't include in this PR for the sake of keeping this PR concise. Let me submit a separate PR if needed)
Changes
Test codes only. No changes have been made that impacts on the actual running codes.
With a few further steps , this gem would pass tests against Ruby 3.0 (at least it did at my local environment), but I'd like to stop here to avoid making the purpose of this PR overcomplicated.
References
Ruby's latest patch versions are 3.0.0, 2.7.2, 2.6.6 respectively. 2.5.8 is in security maintenance mode, and will be go EOL in Mar 31 this year.
https://www.ruby-lang.org/en/downloads/branches/
The syntax for matrix builds is described below.
Circle CI matrix builds
As a small (but maybe important) note, deprecation warnings will not be emitted after Ruby 2.7.2.
https://www.ruby-lang.org/en/news/2020/10/02/ruby-2-7-2-released/
https://bugs.ruby-lang.org/issues/17000
Testing
Checklist