diff options
author | Douwe Maan <douwe@selenight.nl> | 2017-04-26 15:29:12 -0500 |
---|---|---|
committer | Douwe Maan <douwe@selenight.nl> | 2017-04-27 12:23:27 -0500 |
commit | c6b2a22f63bc7561beb3e596b14c62021d64c6e7 (patch) | |
tree | 58bb8bc42d95cebf098aa170c652a1875eca6120 /app/models/blob_viewer | |
parent | 787866a91f4a7125336707dc9e58d338d0d6fde2 (diff) | |
download | gitlab-ce-c6b2a22f63bc7561beb3e596b14c62021d64c6e7.tar.gz |
Explain BlobViewer::Base#render_error
Diffstat (limited to 'app/models/blob_viewer')
-rw-r--r-- | app/models/blob_viewer/base.rb | 15 | ||||
-rw-r--r-- | app/models/blob_viewer/download.rb | 1 |
2 files changed, 16 insertions, 0 deletions
diff --git a/app/models/blob_viewer/base.rb b/app/models/blob_viewer/base.rb index d3674530273..ab89429d07d 100644 --- a/app/models/blob_viewer/base.rb +++ b/app/models/blob_viewer/base.rb @@ -55,8 +55,23 @@ module BlobViewer too_large? && !absolutely_too_large? end + # This method is used on the server side to check whether we can attempt to + # render the blob at all. Human-readible error messages are found in the + # `BlobHelper#blob_render_error_reason` helper. + # + # This method does not and should not load the entire blob contents into + # memory, and should not be overridden to do so in order to validate the + # format of the blob. + # + # Prefer to implement a client-side viewer, where the JS component loads the + # binary from `blob_raw_url` and does its own format validation and error + # rendering, especially for potentially large binary formats. def render_error if server_side_but_stored_in_lfs? + # Files stored in LFS can only be rendered using a client-side viewer, + # since we do not want to read large amounts of data into memory on the + # server side. Client-side viewers use JS and can fetch the file from + # `blob_raw_url` using AJAX. :server_side_but_stored_in_lfs elsif override_max_size ? absolutely_too_large? : too_large? :too_large diff --git a/app/models/blob_viewer/download.rb b/app/models/blob_viewer/download.rb index 7bc45fe992c..adc06587f69 100644 --- a/app/models/blob_viewer/download.rb +++ b/app/models/blob_viewer/download.rb @@ -9,6 +9,7 @@ module BlobViewer self.partial_name = 'download' self.binary = true + # We can always render the Download viewer, even if the blob is in LFS or too large. def render_error nil end |