Restore ActionDispatch::Http::UploadedFile compatibility with IO.copy_stream #35382
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
In rails#28676 the `#to_path` method was added to `ActionDispatch::Http::UploadedFile`. This broke usage with `IO.copy_stream`: source = ActionDispatch::Http::UploadedFile.new(...) IO.copy_stream(source, destination) # ~> TypeError: can't convert ActionDispatch::Http::UploadedFile to IO (ActionDispatch::Http::UploadedFile#to_io gives Tempfile) Normally `IO.copy_stream` just calls `#read` on the source object. However, when `#to_path` is defined, `IO.copy_stream` calls `#to_io` in order to retrieve the raw `File` object. In that case it trips up, because `ActionDispatch::Http::UploadedFile#to_io` returned a `Tempfile` object, which is not an `IO` subclass. We fix this by having `#to_io` return an actual `File` object.
janko
force-pushed
the
restore-io-copy-stream-compatibility-with-uploaded-file
branch
from
b2215cf
to
32b2942
Compare
janko
deleted the
restore-io-copy-stream-compatibility-with-uploaded-file
branch
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.
Shrine relies on
ActionDispatch::Http::UploadedFileworking withIO.copy_stream. In #28676,#to_pathmethod was added toActionDispatch::Http::UploadedFile, which broke usage withIO.copy_stream(shrinerb/shrine#353):Normally
IO.copy_streamjust calls#readon the source object to read the content. However, when#to_pathis defined,IO.copy_streamcalls#to_ioin order to retrieve the rawFileobject. In this case it trips up, becauseActionDispatch::Http::UploadedFile#to_ioreturned aTempfileobject, which is not anIOsubclass.We fix this by modifying
#to_ioto return an actualFileobject (which is aIOsubclass). I think this is also more correct behaviour in general.I had to test this with an actual
Tempfileobject, so then I also updated the rest of the tests to use an actualTempfileobjects (which simplified them).