Add explicit require where OpenStruct is used
#114
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
`OpenStruct` is used by `MockMessage` to represent a message's headers and delivery information, but the file does not actually require the `ostruct` library which provides this type. Many of our projects will somehow transitively require it anyway as it's extensively used in Ruby, so this omission hasn't caused issues so far, but we've encountered a problem on `search-api-v2` now where a completely unrelated dependency was updated and no longer uses `ostruct`, causing tests that use `MockMessage` to fail as the library is no longer loaded.
| @@ -1,3 +1,5 @@ | |||
| require "ostruct" | |||
There was a problem hiding this comment.
heya, just checking, does this mean you'll be removing the ostruct requirement from other apps?
There was a problem hiding this comment.
if so it might be worth linking those PRs in the description for this one
There was a problem hiding this comment.
Ah no - the app I've been having problems with did not actually require ostruct at all. This meant it suddenly broke when another one of it's dependencies stopped requiring it.
There was a problem hiding this comment.
It shouldn't cause issues for it to be additionally required in any other app though!
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.
OpenStructis used byMockMessageto represent a message's headers and delivery information, but the file (or indeed the entire library) does not actually require theostructlibrary which provides this type.Many of our projects will somehow transitively require it anyway as it's extensively used in Ruby, so this omission hasn't caused issues so far, but we've encountered a problem on
search-api-v2now where a completely unrelated dependency was updated and no longer usesostruct, causing tests that useMockMessageto fail as the library is no longer loaded.