What is the best approach to handle large file uploads in a rails app?
Asked Answered
T

6

47

I am interested in understanding the different approaches to handling large file uploads in a Rails application, 2-5Gb files.

I understand that in order to transfer a file of this size it will need to be broken down into smaller parts, I have done some research and here is what I have so far.

  • Server-side config will be required to accept large POST requests and probably a 64bit machine to handle anything over 4Gb.
  • AWS supports multipart upload.
  • HTML5 FileSystemAPI has a persistent uploader that uploads the file in chunks.
  • A library for Bitorrent although this requires a transmission client which is not ideal

Can all of these methods be resumed like FTP, the reason I dont want to use FTP is that I want to keep in the web app if this is possible? I have used carrierwave and paperclip but I am looking for something that will be able to be resumed as uploading a 5Gb file could take some time!

Of these approaches I have listed I would like to undertand what has worked well and if there are other approaches that I may be missing? No plugins if possible, would rather not use Java Applets or Flash. Another concern is that these solutions hold the file in memory while uploading, that is also a constraint I would rather avoid if possible.

Thaxter answered 25/5, 2013 at 12:26 Comment(0)
E
38

I've dealt with this issue on several sites, using a few of the techniques you've illustrated above and a few that you haven't. The good news is that it is actually pretty realistic to allow massive uploads.

A lot of this depends on what you actually plan to do with the file after you have uploaded it... The more work you have to do on the file, the closer you are going to want it to your server. If you need to do immediate processing on the upload, you probably want to do a pure rails solution. If you don't need to do any processing, or it is not time-critical, you can start to consider "hybrid" solutions...

Believe it or not, I've actually had pretty good luck just using mod_porter. Mod_porter makes apache do a bunch of the work that your app would normally do. It helps not tie up a thread and a bunch of memory during the upload. It results in a file local to your app, for easy processing. If you pay attention to the way you are processing the uploaded files (think streams), you can make the whole process use very little memory, even for what would traditionally be fairly expensive operations. This approach requires very little actual setup to your app to get working, and no real modification to your code, but it does require a particular environment (apache server), as well as the ability to configure it.

I've also had good luck using jQuery-File-Upload, which supports good stuff like chunked and resumable uploads. Without something like mod_porter, this can still tie up an entire thread of execution during upload, but it should be decent on memory, if done right. This also results in a file that is "close" and, as a result, easy to process. This approach will require adjustments to your view layer to implement, and will not work in all browsers.

You mentioned FTP and bittorrent as possible options. These are not as bad of options as you might think, as you can still get the files pretty close to the server. They are not even mutually exclusive, which is nice, because (as you pointed out) they do require an additional client that may or may not be present on the uploading machine. The way this works is, basically, you set up an area for them to dump to that is visible by your app. Then, if you need to do any processing, you run a cron job (or whatever) to monitor that location for uploads and trigger your servers processing method. This does not get you the immediate response the methods above can provide, but you can set the interval to be small enough to get pretty close. The only real advantage to this method is that the protocols used are better suited to transferring large files, the additional client requirement and fragmented process usually outweigh any benefits from that, in my experience.

If you don't need any processing at all, your best bet may be to simply go straight to S3 with them. This solution falls down the second you actually need to do anything with the files other than server them as static assets....

I do not have any experience using the HTML5 FileSystemAPI in a rails app, so I can't speak to that point, although it seems that it would significantly limit the clients you are able to support.

Unfortunately, there is not one real silver bullet - all of these options need to be weighed against your environment in the context of what you are trying to accomplish. You may not be able to configure your web server or permanently write to your local file system, for example. For what it's worth, I think jQuery-File-Upload is probably your best bet in most environments, as it only really requires modification to your application, so you could move an implementation to another environment most easily.

Erythroblastosis answered 3/6, 2013 at 23:53 Comment(0)
A
6

This project is a new protocol over HTTP to support resumable upload for large files. It bypass Rails by providing its own server.

http://tus.io/

Alvinaalvine answered 26/7, 2016 at 13:29 Comment(0)
L
3

http://www.jedi.be/blog/2009/04/10/rails-and-large-large-file-uploads-looking-at-the-alternatives/ has some good comparisons of the options, including some outside of Rails.

Please go through it.It was helpful in my case

Also another site to go to is:- http://bclennox.com/extremely-large-file-uploads-with-nginx-passenger-rails-and-jquery

Please let me know if any of this does not work out

Lasandralasater answered 4/6, 2013 at 7:40 Comment(0)
K
1

I would by-pass the rails server and post your large files(split into chunks) directly from the browser to Amazon Simple Storage. Take a look at this post on splitting files with JavaScript. I'm a little curious how performant this setup would be and I feel like tinkering with this setup this weekend.

Karilynn answered 1/6, 2013 at 2:43 Comment(1)
@eabharam..There is a bit of performance issue when using amazon.have tried it out onceLasandralasater
E
1

I think that Brad Werth nailed the answer

just one approach could be upload directly to S3 (and even if you do need some reprocessing after you could theoretical use aws lambda to notify your app ... but to be honest I'm just guessing here, I'm about to solve the same problem myself, I'll expand on this later)

http://aws.amazon.com/articles/1434

if you use carrierwave

Ecology answered 27/5, 2015 at 20:41 Comment(0)
S
1

Let me also pin down few options that might help others looking for a real world solution.

I have a Rails 6 with Ruby 2.7 and the main purpose of this app is to create a Google drive like environment where users can upload images and videos and them process them again for high quality.

Obviously we did tried using local processing using Sidekiq background jobs but it was overwhelming during large uploads like 1GB and more. We did tried tuts.io but personally I think is not quite easy to setup just like Jquery File uploads.

So we experimented with AWS..moving in steps listed below and it worked like a charm....uploading directly to S3 from the browser.

  • using React drop zone uploader...we uploads multiple files to S3.
  • we setup Aws Lambda for an input bucket to get triggered for all types of object creations on that bucket.
  • this Lambda converts the file and again uploads the reprocessed one to another one - output bucket and notifies us using Aws SNS to keep a track of what worked and what failed.
  • in Rails side... we just dynamically use the new output bucket and then serve it with Aws Cloud-front distribution.

You may check Aws notes on MediaConvert to check step by step guide and they also have a well written Github repos for all sorts of experimentation.

So, from the user's point of view, he can upload one large file, with Acceleration enabled on the S3, the React library show uploading progress and once it gets uploaded, Rails callback api again verifies its existence in the S3 BUCKET like mybucket/user_id/file_uploaded_slug and then its confirmed to user through a simple flash message. You can also configure Lambda to notify end user on successful upload/encoding, if needed.

Refer this documentation - https://github.com/mike1011/aws-media-services-vod-automation/tree/master/MediaConvert-WorkflowWatchFolderAndNotification

Hope it helps someone here.

Sinapism answered 25/1, 2021 at 8:7 Comment(3)
Hi @Milind, does your implementation also report file progress for multiple uploads? If so, how did you handle this?Coper
Details added @CoperSinapism
Great, thanks @SinapismCoper

© 2022 - 2024 — McMap. All rights reserved.