Fix requiring of oauth2 #86
Merged
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
The changes in #83 (which were released in v4.1.0) moved the `OauthClient` class (which uses the `oauth2` gem) from the Rails applications into the `rpi_auth` gem. At that point the `oauth2` gem was made a direct dependency of `rpi_auth` and the direct dependency on `oauth2` was removed from the Rails applications. I _think_ this meant that the `oauth2` gem was no longer being required automatically. And, although individual files in the `oauth2` gem were being required from individual files in `rpi_auth`, this meant that not all of the files in `oauth2` were being required. In particular, the `lib/oauth2.rb` file which defines the top-level `OAuth2` module and the `OAuth2.config` method were no longer being required. This led to exceptions like this one [1] in `experience-cs` when `RpiAuth::OauthClient#refresh_credentials` was called: NoMethodError: undefined method 'config' for module OAuth2 This commit changes the require statements to just require `oauth2` which in turn requires all the relevant files [2] in the `oauth2` gem. The require statement in `spec/rpi_auth/oauth_client_spec.rb` is unnecessary, because it's automatically loading `RpiAuth::OauthClient` which in turn loads `oauth2`. This should mean we no longer see exceptions like the one above. [1]: https://raspberrypifoundation.sentry.io/issues/6590882516?project=4508953237651456 [2]: https://gitlab.com/oauth-xx/oauth2/-/blob/v2.0.9/lib/oauth2.rb?ref_type=tags#L11-23
Test coverage: 100.0% |
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.
The changes in #83 (which were released in v4.1.0) moved the
OauthClientclass (which uses theoauth2gem) from the Rails applications into therpi_authgem. At that point theoauth2gem was made a direct dependency ofrpi_authand the direct dependency onoauth2was removed from the Rails applications.I think this meant that the
oauth2gem was no longer being required automatically. And, although individual files in theoauth2gem were being required from individual files inrpi_auth, this meant that not all of the files inoauth2were being required. In particular, thelib/oauth2.rbfile which defines the top-levelOAuth2module and theOAuth2.configmethod was no longer being required. This led to exceptions like this one inexperience-cswhenRpiAuth::OauthClient#refresh_credentialswas called:This commit changes the require statements to just require
oauth2which in turn requires all the relevant files in theoauth2gem. The require statement inspec/rpi_auth/oauth_client_spec.rbis unnecessary, because it's automatically loadingRpiAuth::OauthClientwhich in turn loadsoauth2. This should mean we no longer see exceptions like the one above.I've tested that this fix works in
experience-csin https://github.com/RaspberryPiFoundation/experience-cs/pull/421 - I ran the Rails app and triggered a token refresh to check thatNoMethodErrorwas no longer being raised.