382 lines
12 KiB
Ruby
382 lines
12 KiB
Ruby
# Gitlab::Git::Diff is a wrapper around native Rugged::Diff object
|
|
module Gitlab
|
|
module Git
|
|
class Diff
|
|
TimeoutError = Class.new(StandardError)
|
|
include Gitlab::EncodingHelper
|
|
|
|
# Diff properties
|
|
attr_accessor :old_path, :new_path, :a_mode, :b_mode, :diff
|
|
|
|
# Stats properties
|
|
attr_accessor :new_file, :renamed_file, :deleted_file
|
|
|
|
alias_method :new_file?, :new_file
|
|
alias_method :deleted_file?, :deleted_file
|
|
alias_method :renamed_file?, :renamed_file
|
|
|
|
attr_accessor :expanded
|
|
attr_writer :too_large
|
|
|
|
alias_method :expanded?, :expanded
|
|
|
|
SERIALIZE_KEYS = %i(diff new_path old_path a_mode b_mode new_file renamed_file deleted_file too_large).freeze
|
|
|
|
class << self
|
|
# The maximum size of a diff to display.
|
|
def size_limit
|
|
if RequestStore.active?
|
|
RequestStore['gitlab_git_diff_size_limit'] ||= find_size_limit
|
|
else
|
|
find_size_limit
|
|
end
|
|
end
|
|
|
|
# The maximum size before a diff is collapsed.
|
|
def collapse_limit
|
|
if RequestStore.active?
|
|
RequestStore['gitlab_git_diff_collapse_limit'] ||= find_collapse_limit
|
|
else
|
|
find_collapse_limit
|
|
end
|
|
end
|
|
|
|
def find_size_limit
|
|
if Feature.enabled?('gitlab_git_diff_size_limit_increase')
|
|
200.kilobytes
|
|
else
|
|
100.kilobytes
|
|
end
|
|
end
|
|
|
|
def find_collapse_limit
|
|
if Feature.enabled?('gitlab_git_diff_size_limit_increase')
|
|
100.kilobytes
|
|
else
|
|
10.kilobytes
|
|
end
|
|
end
|
|
|
|
def between(repo, head, base, options = {}, *paths)
|
|
straight = options.delete(:straight) || false
|
|
|
|
common_commit = if straight
|
|
base
|
|
else
|
|
# Only show what is new in the source branch
|
|
# compared to the target branch, not the other way
|
|
# around. The linex below with merge_base is
|
|
# equivalent to diff with three dots (git diff
|
|
# branch1...branch2) From the git documentation:
|
|
# "git diff A...B" is equivalent to "git diff
|
|
# $(git-merge-base A B) B"
|
|
repo.merge_base_commit(head, base)
|
|
end
|
|
|
|
options ||= {}
|
|
actual_options = filter_diff_options(options)
|
|
repo.diff(common_commit, head, actual_options, *paths)
|
|
end
|
|
|
|
# Return a copy of the +options+ hash containing only keys that can be
|
|
# passed to Rugged. Allowed options are:
|
|
#
|
|
# :max_size ::
|
|
# An integer specifying the maximum byte size of a file before a it
|
|
# will be treated as binary. The default value is 512MB.
|
|
#
|
|
# :context_lines ::
|
|
# The number of unchanged lines that define the boundary of a hunk
|
|
# (and to display before and after the actual changes). The default is
|
|
# 3.
|
|
#
|
|
# :interhunk_lines ::
|
|
# The maximum number of unchanged lines between hunk boundaries before
|
|
# the hunks will be merged into a one. The default is 0.
|
|
#
|
|
# :old_prefix ::
|
|
# The virtual "directory" to prefix to old filenames in hunk headers.
|
|
# The default is "a".
|
|
#
|
|
# :new_prefix ::
|
|
# The virtual "directory" to prefix to new filenames in hunk headers.
|
|
# The default is "b".
|
|
#
|
|
# :reverse ::
|
|
# If true, the sides of the diff will be reversed.
|
|
#
|
|
# :force_text ::
|
|
# If true, all files will be treated as text, disabling binary
|
|
# attributes & detection.
|
|
#
|
|
# :ignore_whitespace ::
|
|
# If true, all whitespace will be ignored.
|
|
#
|
|
# :ignore_whitespace_change ::
|
|
# If true, changes in amount of whitespace will be ignored.
|
|
#
|
|
# :ignore_whitespace_eol ::
|
|
# If true, whitespace at end of line will be ignored.
|
|
#
|
|
# :ignore_submodules ::
|
|
# if true, submodules will be excluded from the diff completely.
|
|
#
|
|
# :patience ::
|
|
# If true, the "patience diff" algorithm will be used (currenlty
|
|
# unimplemented).
|
|
#
|
|
# :include_ignored ::
|
|
# If true, ignored files will be included in the diff.
|
|
#
|
|
# :include_untracked ::
|
|
# If true, untracked files will be included in the diff.
|
|
#
|
|
# :include_unmodified ::
|
|
# If true, unmodified files will be included in the diff.
|
|
#
|
|
# :recurse_untracked_dirs ::
|
|
# Even if +:include_untracked+ is true, untracked directories will
|
|
# only be marked with a single entry in the diff. If this flag is set
|
|
# to true, all files under ignored directories will be included in the
|
|
# diff, too.
|
|
#
|
|
# :disable_pathspec_match ::
|
|
# If true, the given +*paths+ will be applied as exact matches,
|
|
# instead of as fnmatch patterns.
|
|
#
|
|
# :deltas_are_icase ::
|
|
# If true, filename comparisons will be made with case-insensitivity.
|
|
#
|
|
# :include_untracked_content ::
|
|
# if true, untracked content will be contained in the the diff patch
|
|
# text.
|
|
#
|
|
# :skip_binary_check ::
|
|
# If true, diff deltas will be generated without spending time on
|
|
# binary detection. This is useful to improve performance in cases
|
|
# where the actual file content difference is not needed.
|
|
#
|
|
# :include_typechange ::
|
|
# If true, type changes for files will not be interpreted as deletion
|
|
# of the "old file" and addition of the "new file", but will generate
|
|
# typechange records.
|
|
#
|
|
# :include_typechange_trees ::
|
|
# Even if +:include_typechange+ is true, blob -> tree changes will
|
|
# still usually be handled as a deletion of the blob. If this flag is
|
|
# set to true, blob -> tree changes will be marked as typechanges.
|
|
#
|
|
# :ignore_filemode ::
|
|
# If true, file mode changes will be ignored.
|
|
#
|
|
# :recurse_ignored_dirs ::
|
|
# Even if +:include_ignored+ is true, ignored directories will only be
|
|
# marked with a single entry in the diff. If this flag is set to true,
|
|
# all files under ignored directories will be included in the diff,
|
|
# too.
|
|
def filter_diff_options(options, default_options = {})
|
|
allowed_options = [:max_size, :context_lines, :interhunk_lines,
|
|
:old_prefix, :new_prefix, :reverse, :force_text,
|
|
:ignore_whitespace, :ignore_whitespace_change,
|
|
:ignore_whitespace_eol, :ignore_submodules,
|
|
:patience, :include_ignored, :include_untracked,
|
|
:include_unmodified, :recurse_untracked_dirs,
|
|
:disable_pathspec_match, :deltas_are_icase,
|
|
:include_untracked_content, :skip_binary_check,
|
|
:include_typechange, :include_typechange_trees,
|
|
:ignore_filemode, :recurse_ignored_dirs, :paths,
|
|
:max_files, :max_lines, :limits, :expanded]
|
|
|
|
if default_options
|
|
actual_defaults = default_options.dup
|
|
actual_defaults.keep_if do |key|
|
|
allowed_options.include?(key)
|
|
end
|
|
else
|
|
actual_defaults = {}
|
|
end
|
|
|
|
if options
|
|
filtered_opts = options.dup
|
|
filtered_opts.keep_if do |key|
|
|
allowed_options.include?(key)
|
|
end
|
|
filtered_opts = actual_defaults.merge(filtered_opts)
|
|
else
|
|
filtered_opts = actual_defaults
|
|
end
|
|
|
|
filtered_opts
|
|
end
|
|
end
|
|
|
|
def initialize(raw_diff, expanded: true)
|
|
@expanded = expanded
|
|
|
|
case raw_diff
|
|
when Hash
|
|
init_from_hash(raw_diff)
|
|
prune_diff_if_eligible
|
|
when Rugged::Patch, Rugged::Diff::Delta
|
|
init_from_rugged(raw_diff)
|
|
when Gitlab::GitalyClient::Diff
|
|
init_from_gitaly(raw_diff)
|
|
prune_diff_if_eligible
|
|
when Gitaly::CommitDelta
|
|
init_from_gitaly(raw_diff)
|
|
when nil
|
|
raise "Nil as raw diff passed"
|
|
else
|
|
raise "Invalid raw diff type: #{raw_diff.class}"
|
|
end
|
|
end
|
|
|
|
def to_hash
|
|
hash = {}
|
|
|
|
SERIALIZE_KEYS.each do |key|
|
|
hash[key] = send(key)
|
|
end
|
|
|
|
hash
|
|
end
|
|
|
|
def mode_changed?
|
|
a_mode && b_mode && a_mode != b_mode
|
|
end
|
|
|
|
def submodule?
|
|
a_mode == '160000' || b_mode == '160000'
|
|
end
|
|
|
|
def line_count
|
|
@line_count ||= Util.count_lines(@diff)
|
|
end
|
|
|
|
def too_large?
|
|
if @too_large.nil?
|
|
@too_large = @diff.bytesize >= self.class.size_limit
|
|
else
|
|
@too_large
|
|
end
|
|
end
|
|
|
|
# This is used by `to_hash` and `init_from_hash`.
|
|
alias_method :too_large, :too_large?
|
|
|
|
def too_large!
|
|
@diff = ''
|
|
@line_count = 0
|
|
@too_large = true
|
|
end
|
|
|
|
def collapsed?
|
|
return @collapsed if defined?(@collapsed)
|
|
|
|
@collapsed = !expanded && @diff.bytesize >= self.class.collapse_limit
|
|
end
|
|
|
|
def collapse!
|
|
@diff = ''
|
|
@line_count = 0
|
|
@collapsed = true
|
|
end
|
|
|
|
private
|
|
|
|
def init_from_rugged(rugged)
|
|
if rugged.is_a?(Rugged::Patch)
|
|
init_from_rugged_patch(rugged)
|
|
d = rugged.delta
|
|
else
|
|
d = rugged
|
|
end
|
|
|
|
@new_path = encode!(d.new_file[:path])
|
|
@old_path = encode!(d.old_file[:path])
|
|
@a_mode = d.old_file[:mode].to_s(8)
|
|
@b_mode = d.new_file[:mode].to_s(8)
|
|
@new_file = d.added?
|
|
@renamed_file = d.renamed?
|
|
@deleted_file = d.deleted?
|
|
end
|
|
|
|
def init_from_rugged_patch(patch)
|
|
# Don't bother initializing diffs that are too large. If a diff is
|
|
# binary we're not going to display anything so we skip the size check.
|
|
return if !patch.delta.binary? && prune_large_patch(patch)
|
|
|
|
@diff = encode!(strip_diff_headers(patch.to_s))
|
|
end
|
|
|
|
def init_from_hash(hash)
|
|
raw_diff = hash.symbolize_keys
|
|
|
|
SERIALIZE_KEYS.each do |key|
|
|
send(:"#{key}=", raw_diff[key.to_sym])
|
|
end
|
|
end
|
|
|
|
def init_from_gitaly(diff)
|
|
@diff = encode!(diff.patch) if diff.respond_to?(:patch)
|
|
@new_path = encode!(diff.to_path.dup)
|
|
@old_path = encode!(diff.from_path.dup)
|
|
@a_mode = diff.old_mode.to_s(8)
|
|
@b_mode = diff.new_mode.to_s(8)
|
|
@new_file = diff.from_id == BLANK_SHA
|
|
@renamed_file = diff.from_path != diff.to_path
|
|
@deleted_file = diff.to_id == BLANK_SHA
|
|
end
|
|
|
|
def prune_diff_if_eligible
|
|
if too_large?
|
|
too_large!
|
|
elsif collapsed?
|
|
collapse!
|
|
end
|
|
end
|
|
|
|
# If the patch surpasses any of the diff limits it calls the appropiate
|
|
# prune method and returns true. Otherwise returns false.
|
|
def prune_large_patch(patch)
|
|
size = 0
|
|
|
|
patch.each_hunk do |hunk|
|
|
hunk.each_line do |line|
|
|
size += line.content.bytesize
|
|
|
|
if size >= self.class.size_limit
|
|
too_large!
|
|
return true
|
|
end
|
|
end
|
|
end
|
|
|
|
if !expanded && size >= self.class.collapse_limit
|
|
collapse!
|
|
return true
|
|
end
|
|
|
|
false
|
|
end
|
|
|
|
# Strip out the information at the beginning of the patch's text to match
|
|
# Grit's output
|
|
def strip_diff_headers(diff_text)
|
|
# Delete everything up to the first line that starts with '---' or
|
|
# 'Binary'
|
|
diff_text.sub!(/\A.*?^(---|Binary)/m, '\1')
|
|
|
|
if diff_text.start_with?('---', 'Binary')
|
|
diff_text
|
|
else
|
|
# If the diff_text did not contain a line starting with '---' or
|
|
# 'Binary', return the empty string. No idea why; we are just
|
|
# preserving behavior from before the refactor.
|
|
''
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|