summaryrefslogtreecommitdiff
path: root/app/models/blob_viewer
diff options
context:
space:
mode:
authorDouwe Maan <douwe@selenight.nl>2017-05-12 14:43:06 -0500
committerDouwe Maan <douwe@selenight.nl>2017-05-13 11:46:10 -0500
commitacffc062133e5793ac08b9529ab54689557766d4 (patch)
tree019482c4b8af8fcd4a0dabf89a4c47c389e37730 /app/models/blob_viewer
parent4328bc1769c52393580cb777d34dbd6ebff089cf (diff)
downloadgitlab-ce-acffc062133e5793ac08b9529ab54689557766d4.tar.gz
Specify explicitly whether a blob viewer should be loaded asynchronously
Diffstat (limited to 'app/models/blob_viewer')
-rw-r--r--app/models/blob_viewer/base.rb38
-rw-r--r--app/models/blob_viewer/client_side.rb2
-rw-r--r--app/models/blob_viewer/download.rb10
-rw-r--r--app/models/blob_viewer/license.rb5
-rw-r--r--app/models/blob_viewer/server_side.rb15
-rw-r--r--app/models/blob_viewer/static.rb14
6 files changed, 42 insertions, 42 deletions
diff --git a/app/models/blob_viewer/base.rb b/app/models/blob_viewer/base.rb
index 7164e4ece78..0f1430bfd98 100644
--- a/app/models/blob_viewer/base.rb
+++ b/app/models/blob_viewer/base.rb
@@ -2,11 +2,11 @@ module BlobViewer
class Base
PARTIAL_PATH_PREFIX = 'projects/blob/viewers'.freeze
- class_attribute :partial_name, :loading_partial_name, :type, :extensions, :file_types, :client_side, :binary, :switcher_icon, :switcher_title, :max_size, :absolute_max_size
+ class_attribute :partial_name, :loading_partial_name, :type, :extensions, :file_types, :load_async, :binary, :switcher_icon, :switcher_title, :max_size, :absolute_max_size
self.loading_partial_name = 'loading'
- delegate :partial_path, :loading_partial_path, :rich?, :simple?, :client_side?, :server_side?, :text?, :binary?, to: :class
+ delegate :partial_path, :loading_partial_path, :rich?, :simple?, :text?, :binary?, to: :class
attr_reader :blob
attr_accessor :override_max_size
@@ -35,12 +35,8 @@ module BlobViewer
type == :auxiliary
end
- def self.client_side?
- client_side
- end
-
- def self.server_side?
- !client_side?
+ def self.load_async?
+ load_async
end
def self.binary?
@@ -59,6 +55,10 @@ module BlobViewer
false
end
+ def load_async?
+ self.class.load_async? && render_error.nil?
+ end
+
def too_large?
max_size && blob.raw_size > max_size
end
@@ -83,29 +83,13 @@ module BlobViewer
# binary from `blob_raw_url` and does its own format validation and error
# rendering, especially for potentially large binary formats.
def render_error
- return @render_error if defined?(@render_error)
-
- @render_error =
- if server_side_but_stored_externally?
- # Files that are not stored in the repository, like LFS files and
- # build artifacts, 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_externally
- elsif override_max_size ? absolutely_too_large? : too_large?
- :too_large
- end
+ if override_max_size ? absolutely_too_large? : too_large?
+ :too_large
+ end
end
def prepare!
# To be overridden by subclasses
end
-
- private
-
- def server_side_but_stored_externally?
- server_side? && blob.stored_externally?
- end
end
end
diff --git a/app/models/blob_viewer/client_side.rb b/app/models/blob_viewer/client_side.rb
index 42ec68f864b..27e48528dae 100644
--- a/app/models/blob_viewer/client_side.rb
+++ b/app/models/blob_viewer/client_side.rb
@@ -3,7 +3,7 @@ module BlobViewer
extend ActiveSupport::Concern
included do
- self.client_side = true
+ self.load_async = false
self.max_size = 10.megabytes
self.absolute_max_size = 50.megabytes
end
diff --git a/app/models/blob_viewer/download.rb b/app/models/blob_viewer/download.rb
index adc06587f69..074e7204814 100644
--- a/app/models/blob_viewer/download.rb
+++ b/app/models/blob_viewer/download.rb
@@ -1,17 +1,9 @@
module BlobViewer
class Download < Base
include Simple
- # We treat the Download viewer as if it renders the content client-side,
- # so that it doesn't attempt to load the entire blob contents and is
- # rendered synchronously instead of loaded asynchronously.
- include ClientSide
+ include Static
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
end
end
diff --git a/app/models/blob_viewer/license.rb b/app/models/blob_viewer/license.rb
index 5e60ff2af97..6751ea15a5d 100644
--- a/app/models/blob_viewer/license.rb
+++ b/app/models/blob_viewer/license.rb
@@ -1,10 +1,7 @@
module BlobViewer
class License < Base
- # We treat the License viewer as if it renders the content client-side,
- # so that it doesn't attempt to load the entire blob contents and is
- # rendered synchronously instead of loaded asynchronously.
- include ClientSide
include Auxiliary
+ include Static
self.partial_name = 'license'
self.file_types = %i(license)
diff --git a/app/models/blob_viewer/server_side.rb b/app/models/blob_viewer/server_side.rb
index e8c5c17b824..ed8c1373f53 100644
--- a/app/models/blob_viewer/server_side.rb
+++ b/app/models/blob_viewer/server_side.rb
@@ -3,7 +3,7 @@ module BlobViewer
extend ActiveSupport::Concern
included do
- self.client_side = false
+ self.load_async = true
self.max_size = 2.megabytes
self.absolute_max_size = 5.megabytes
end
@@ -13,5 +13,18 @@ module BlobViewer
blob.load_all_data!(blob.project.repository)
end
end
+
+ def render_error
+ if blob.stored_externally?
+ # Files that are not stored in the repository, like LFS files and
+ # build artifacts, 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.
+ return :server_side_but_stored_externally
+ end
+
+ super
+ end
end
end
diff --git a/app/models/blob_viewer/static.rb b/app/models/blob_viewer/static.rb
new file mode 100644
index 00000000000..c9e257e5388
--- /dev/null
+++ b/app/models/blob_viewer/static.rb
@@ -0,0 +1,14 @@
+module BlobViewer
+ module Static
+ extend ActiveSupport::Concern
+
+ included do
+ self.load_async = false
+ end
+
+ # We can always render a static viewer, even if the blob is too large.
+ def render_error
+ nil
+ end
+ end
+end