2018-07-25 09:30:33 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2019-03-28 13:17:42 +00:00
|
|
|
class Snippet < ApplicationRecord
|
2014-10-08 13:44:25 +00:00
|
|
|
include Gitlab::VisibilityLevel
|
2018-09-20 14:14:46 +00:00
|
|
|
include Redactable
|
2016-10-06 21:17:11 +00:00
|
|
|
include CacheMarkdownField
|
2017-03-10 01:29:11 +00:00
|
|
|
include Noteable
|
2015-04-21 13:23:20 +00:00
|
|
|
include Participable
|
2015-05-03 03:11:21 +00:00
|
|
|
include Sortable
|
2016-06-03 09:44:04 +00:00
|
|
|
include Awardable
|
2016-11-17 20:46:31 +00:00
|
|
|
include Mentionable
|
2017-02-01 18:15:59 +00:00
|
|
|
include Spammable
|
2017-05-18 12:24:34 +00:00
|
|
|
include Editable
|
2017-11-24 10:45:19 +00:00
|
|
|
include Gitlab::SQL::Pattern
|
2018-09-11 15:31:34 +00:00
|
|
|
include FromUnion
|
2020-01-16 15:08:41 +00:00
|
|
|
include IgnorableColumns
|
2020-02-13 15:08:52 +00:00
|
|
|
include HasRepository
|
2020-12-14 18:09:48 +00:00
|
|
|
include CanMoveRepositoryStorage
|
2020-04-22 12:09:29 +00:00
|
|
|
include AfterCommitQueue
|
2019-09-25 03:06:21 +00:00
|
|
|
extend ::Gitlab::Utils::Override
|
2022-07-19 12:10:09 +00:00
|
|
|
include CreatedAtFilterable
|
2011-10-20 19:00:00 +00:00
|
|
|
|
2020-05-19 12:08:21 +00:00
|
|
|
MAX_FILE_COUNT = 10
|
2020-03-17 06:09:21 +00:00
|
|
|
|
2022-08-30 18:09:50 +00:00
|
|
|
DESCRIPTION_LENGTH_MAX = 1.megabyte
|
|
|
|
|
2016-10-06 21:17:11 +00:00
|
|
|
cache_markdown_field :title, pipeline: :single_line
|
2017-05-03 15:26:49 +00:00
|
|
|
cache_markdown_field :description
|
2016-10-06 21:17:11 +00:00
|
|
|
cache_markdown_field :content
|
|
|
|
|
2018-09-20 14:14:46 +00:00
|
|
|
redact_field :description
|
|
|
|
|
2017-05-04 03:54:25 +00:00
|
|
|
# Aliases to make application_helper#edited_time_ago_with_tooltip helper work properly with snippets.
|
2019-09-18 14:02:45 +00:00
|
|
|
# See https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/10392/diffs#note_28719102
|
2017-05-04 03:54:25 +00:00
|
|
|
alias_attribute :last_edited_at, :updated_at
|
|
|
|
alias_attribute :last_edited_by, :updated_by
|
|
|
|
|
2016-10-06 21:17:11 +00:00
|
|
|
# If file_name changes, it invalidates content
|
|
|
|
alias_method :default_content_html_invalidator, :content_html_invalidated?
|
|
|
|
def content_html_invalidated?
|
|
|
|
default_content_html_invalidator || file_name_changed?
|
|
|
|
end
|
|
|
|
|
2015-05-03 03:14:31 +00:00
|
|
|
belongs_to :author, class_name: 'User'
|
|
|
|
belongs_to :project
|
2022-04-19 15:08:32 +00:00
|
|
|
alias_method :resource_parent, :project
|
2013-03-25 11:58:09 +00:00
|
|
|
|
2017-06-08 15:16:27 +00:00
|
|
|
has_many :notes, as: :noteable, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
2020-02-14 00:09:07 +00:00
|
|
|
has_many :user_mentions, class_name: "SnippetUserMention", dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
|
2020-02-13 15:08:52 +00:00
|
|
|
has_one :snippet_repository, inverse_of: :snippet
|
2021-02-23 12:10:56 +00:00
|
|
|
has_many :repository_storage_moves, class_name: 'Snippets::RepositoryStorageMove', inverse_of: :container
|
2020-07-08 09:09:17 +00:00
|
|
|
|
|
|
|
# We need to add the `dependent` in order to call the after_destroy callback
|
|
|
|
has_one :statistics, class_name: 'SnippetStatistics', dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
2011-10-16 21:07:10 +00:00
|
|
|
|
2012-12-14 05:34:05 +00:00
|
|
|
delegate :name, :email, to: :author, prefix: true, allow_nil: true
|
2011-10-16 21:07:10 +00:00
|
|
|
|
2012-10-09 00:10:04 +00:00
|
|
|
validates :author, presence: true
|
2016-12-02 12:54:57 +00:00
|
|
|
validates :title, presence: true, length: { maximum: 255 }
|
2015-02-03 05:15:44 +00:00
|
|
|
validates :file_name,
|
2017-07-05 16:01:38 +00:00
|
|
|
length: { maximum: 255 }
|
2022-08-30 18:09:50 +00:00
|
|
|
validates :description, bytesize: { maximum: -> { DESCRIPTION_LENGTH_MAX } }, if: :description_changed?
|
2016-06-16 18:55:04 +00:00
|
|
|
|
2013-01-22 15:10:00 +00:00
|
|
|
validates :content, presence: true
|
2022-08-30 18:09:50 +00:00
|
|
|
validates :content, bytesize: { maximum: -> { Gitlab::CurrentSettings.snippet_size_limit } }, if: :content_changed?
|
2019-12-02 12:06:45 +00:00
|
|
|
|
2020-06-23 15:08:41 +00:00
|
|
|
after_create :create_statistics
|
2020-02-14 00:09:07 +00:00
|
|
|
|
2012-10-09 00:10:04 +00:00
|
|
|
# Scopes
|
2019-01-16 12:09:29 +00:00
|
|
|
scope :are_internal, -> { where(visibility_level: Snippet::INTERNAL) }
|
2014-10-08 13:44:25 +00:00
|
|
|
scope :are_private, -> { where(visibility_level: Snippet::PRIVATE) }
|
2019-11-19 06:06:07 +00:00
|
|
|
scope :are_public, -> { public_only }
|
|
|
|
scope :are_secret, -> { public_only.where(secret: true) }
|
2019-01-16 12:09:29 +00:00
|
|
|
scope :fresh, -> { order("created_at DESC") }
|
2019-09-02 11:12:20 +00:00
|
|
|
scope :inc_author, -> { includes(:author) }
|
2018-07-16 16:18:52 +00:00
|
|
|
scope :inc_relations_for_view, -> { includes(author: :status) }
|
2021-03-16 00:09:44 +00:00
|
|
|
scope :inc_statistics, -> { includes(:statistics) }
|
2020-06-26 15:08:45 +00:00
|
|
|
scope :with_statistics, -> { joins(:statistics) }
|
2021-01-12 18:11:03 +00:00
|
|
|
scope :inc_projects_namespace_route, -> { includes(project: [:route, :namespace]) }
|
2011-10-27 07:14:50 +00:00
|
|
|
|
2019-12-10 15:07:52 +00:00
|
|
|
attr_mentionable :description
|
|
|
|
|
2016-05-26 11:38:28 +00:00
|
|
|
participant :author
|
|
|
|
participant :notes_with_associations
|
2015-04-21 13:23:20 +00:00
|
|
|
|
2017-02-01 18:15:59 +00:00
|
|
|
attr_spammable :title, spam_title: true
|
2022-08-22 09:11:23 +00:00
|
|
|
attr_spammable :description, spam_description: true
|
2017-02-01 18:15:59 +00:00
|
|
|
|
2019-11-19 06:06:07 +00:00
|
|
|
attr_encrypted :secret_token,
|
2022-08-01 15:11:13 +00:00
|
|
|
key: Settings.attr_encrypted_db_key_base_truncated,
|
|
|
|
mode: :per_attribute_iv,
|
2019-11-19 06:06:07 +00:00
|
|
|
algorithm: 'aes-256-cbc'
|
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
class << self
|
|
|
|
# Searches for snippets with a matching title, description or file name.
|
|
|
|
#
|
|
|
|
# This method uses ILIKE on PostgreSQL.
|
|
|
|
#
|
|
|
|
# query - The search query as a String.
|
|
|
|
#
|
|
|
|
# Returns an ActiveRecord::Relation.
|
|
|
|
def search(query)
|
|
|
|
fuzzy_search(query, [:title, :description, :file_name])
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
end
|
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def parent_class
|
|
|
|
::Project
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def sanitized_file_name(file_name)
|
|
|
|
file_name.gsub(/[^a-zA-Z0-9_\-\.]+/, '')
|
|
|
|
end
|
2020-04-27 12:09:41 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def with_optional_visibility(value = nil)
|
|
|
|
if value
|
|
|
|
where(visibility_level: value)
|
|
|
|
else
|
|
|
|
all
|
|
|
|
end
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def only_personal_snippets
|
|
|
|
where(project_id: nil)
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def only_project_snippets
|
|
|
|
where.not(project_id: nil)
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def only_include_projects_visible_to(current_user = nil)
|
|
|
|
levels = Gitlab::VisibilityLevel.levels_for_user(current_user)
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
joins(:project).where(projects: { visibility_level: levels })
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def only_include_projects_with_snippets_enabled(include_private: false)
|
|
|
|
column = ProjectFeature.access_level_attribute(:snippets)
|
|
|
|
levels = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
levels << ProjectFeature::PRIVATE if include_private
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
joins(project: :project_feature)
|
|
|
|
.where(project_features: { column => levels })
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
end
|
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def only_include_authorized_projects(current_user)
|
|
|
|
where(
|
|
|
|
'EXISTS (?)',
|
|
|
|
ProjectAuthorization
|
|
|
|
.select(1)
|
|
|
|
.where('project_id = snippets.project_id')
|
|
|
|
.where(user_id: current_user.id)
|
|
|
|
)
|
|
|
|
end
|
Rewrite SnippetsFinder to improve performance
This completely rewrites the SnippetsFinder class from the ground up in
order to improve its performance. The old code was beyond salvaging. It
was complex, included various Rails 5 workarounds, comments that
shouldn't be necessary, and most important of all: it produced a really
poorly performing database query.
As a result, I opted for rewriting the finder from scratch, instead of
trying to patch the existing code. Instead of trying to reuse as many
existing methods as possible, I opted for defining new methods
specifically meant for the SnippetsFinder. This requires some extra code
here and there, but allows us to have much more control over the
resulting SQL queries. It is these changes that then allow us to produce
a _much_ more efficient query.
To illustrate how bad the old query was, we will use my own snippets as
an example. Currently I have 52 snippets, most of which are global ones.
To retrieve these, you would run the following Ruby code:
user = User.find_by(username: 'yorickpeterse')
SnippetsFinder.new(user, author: user).execute
On GitLab.com the resulting query will take between 10 and 15 seconds to
run, producing the query plan found at
https://explain.depesz.com/s/Y5IX. Apart from the long execution time,
the total number of buffers (the sum of all shared hits) is around 185
GB, though the real number is probably (hopefully) much lower as I doubt
simply summing these numbers produces the true total number of buffers
used.
The new query's plan can be found at https://explain.depesz.com/s/wHdN,
and this query takes between 10 and 100-ish milliseconds to run. The
total number of buffers used is only about 30 MB.
Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/52639
2018-10-25 15:35:31 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def for_project_with_user(project, user = nil)
|
|
|
|
return none unless project.snippets_visible?(user)
|
|
|
|
|
|
|
|
if user && project.team.member?(user)
|
|
|
|
project.snippets
|
|
|
|
else
|
|
|
|
project.snippets.public_to_user(user)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def visible_to_or_authored_by(user)
|
|
|
|
query = where(visibility_level: Gitlab::VisibilityLevel.levels_for_user(user))
|
|
|
|
query.or(where(author_id: user.id))
|
|
|
|
end
|
|
|
|
|
|
|
|
def reference_prefix
|
|
|
|
'$'
|
|
|
|
end
|
2015-05-03 03:11:21 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
# Pattern used to extract `$123` snippet references from text
|
|
|
|
#
|
|
|
|
# This pattern supports cross-project references.
|
|
|
|
def reference_pattern
|
|
|
|
@reference_pattern ||= %r{
|
2015-12-01 14:51:27 +00:00
|
|
|
(#{Project.reference_pattern})?
|
|
|
|
#{Regexp.escape(reference_prefix)}(?<snippet>\d+)
|
2015-05-14 20:59:39 +00:00
|
|
|
}x
|
2021-11-30 15:14:19 +00:00
|
|
|
end
|
2015-05-14 20:59:39 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def link_reference_pattern
|
|
|
|
@link_reference_pattern ||= super("snippets", /(?<snippet>\d+)/)
|
|
|
|
end
|
2015-11-30 20:14:46 +00:00
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def find_by_id_and_project(id:, project:)
|
|
|
|
Snippet.find_by(id: id, project: project)
|
|
|
|
end
|
2020-03-05 00:07:49 +00:00
|
|
|
|
2021-12-08 21:10:18 +00:00
|
|
|
def find_by_project_title_trunc_created_at(project, title, created_at)
|
|
|
|
where(project: project, title: title)
|
|
|
|
.find_by(
|
|
|
|
"date_trunc('second', created_at at time zone :tz) at time zone :tz = :created_at",
|
|
|
|
tz: created_at.zone, created_at: created_at)
|
|
|
|
end
|
|
|
|
|
2021-11-30 15:14:19 +00:00
|
|
|
def max_file_limit
|
|
|
|
MAX_FILE_COUNT
|
|
|
|
end
|
2020-05-19 12:08:21 +00:00
|
|
|
end
|
|
|
|
|
2019-10-17 00:07:27 +00:00
|
|
|
def initialize(attributes = {})
|
|
|
|
# We can't use default_value_for because the database has a default
|
|
|
|
# value of 0 for visibility_level. If someone attempts to create a
|
|
|
|
# private snippet, default_value_for will assume that the
|
|
|
|
# visibility_level hasn't changed and will use the application
|
|
|
|
# setting default, which could be internal or public.
|
|
|
|
#
|
|
|
|
# To fix the problem, we assign the actual snippet default if no
|
|
|
|
# explicit visibility has been initialized.
|
|
|
|
attributes ||= {}
|
|
|
|
|
|
|
|
unless visibility_attribute_present?(attributes)
|
|
|
|
attributes[:visibility_level] = Gitlab::CurrentSettings.default_snippet_visibility
|
|
|
|
end
|
|
|
|
|
|
|
|
super
|
|
|
|
end
|
|
|
|
|
2017-11-22 13:20:35 +00:00
|
|
|
def to_reference(from = nil, full: false)
|
2015-05-03 03:11:21 +00:00
|
|
|
reference = "#{self.class.reference_prefix}#{id}"
|
|
|
|
|
2016-11-02 23:49:13 +00:00
|
|
|
if project.present?
|
2020-01-29 12:09:08 +00:00
|
|
|
"#{project.to_reference_base(from, full: full)}#{reference}"
|
2016-11-02 23:49:13 +00:00
|
|
|
else
|
|
|
|
reference
|
2015-05-03 03:11:21 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-02-26 00:14:54 +00:00
|
|
|
def all_files
|
|
|
|
list_files(default_branch)
|
|
|
|
end
|
|
|
|
|
2017-04-13 16:47:28 +00:00
|
|
|
def blob
|
2020-02-25 09:09:10 +00:00
|
|
|
@blob ||= Blob.decorate(SnippetBlob.new(self), self)
|
|
|
|
end
|
|
|
|
|
2022-02-26 00:14:54 +00:00
|
|
|
def blobs(paths = [])
|
2020-03-06 15:08:05 +00:00
|
|
|
return [] unless repository_exists?
|
|
|
|
|
2022-02-26 00:14:54 +00:00
|
|
|
paths = all_files if paths.empty?
|
|
|
|
items = paths.map { |path| [default_branch, path] }
|
2021-02-22 09:10:46 +00:00
|
|
|
|
|
|
|
repository.blobs_at(items).compact
|
2012-04-20 22:26:22 +00:00
|
|
|
end
|
|
|
|
|
2015-03-05 18:38:23 +00:00
|
|
|
def hook_attrs
|
|
|
|
attributes
|
|
|
|
end
|
|
|
|
|
2016-12-02 12:54:57 +00:00
|
|
|
def file_name
|
|
|
|
super.to_s
|
|
|
|
end
|
|
|
|
|
2014-10-08 13:44:25 +00:00
|
|
|
def visibility_level_field
|
2017-03-01 20:23:00 +00:00
|
|
|
:visibility_level
|
2014-12-12 11:15:42 +00:00
|
|
|
end
|
2014-10-08 13:44:25 +00:00
|
|
|
|
2018-12-11 06:28:06 +00:00
|
|
|
def embeddable?
|
2020-01-23 12:08:38 +00:00
|
|
|
Ability.allowed?(nil, :read_snippet, self)
|
2018-12-11 06:28:06 +00:00
|
|
|
end
|
|
|
|
|
2016-05-26 11:38:28 +00:00
|
|
|
def notes_with_associations
|
2016-06-03 18:47:09 +00:00
|
|
|
notes.includes(:author)
|
2016-05-26 11:38:28 +00:00
|
|
|
end
|
|
|
|
|
2021-07-20 06:08:37 +00:00
|
|
|
def check_for_spam?(user:)
|
2017-03-21 02:37:29 +00:00
|
|
|
visibility_level_changed?(to: Snippet::PUBLIC) ||
|
2022-08-22 09:11:23 +00:00
|
|
|
(public? && (title_changed? || description_changed?))
|
2019-09-25 03:06:21 +00:00
|
|
|
end
|
|
|
|
|
2017-02-01 18:15:59 +00:00
|
|
|
def spammable_entity_type
|
|
|
|
'snippet'
|
|
|
|
end
|
|
|
|
|
2019-06-21 04:45:27 +00:00
|
|
|
def to_ability_name
|
2020-01-23 12:08:38 +00:00
|
|
|
'snippet'
|
2019-06-21 04:45:27 +00:00
|
|
|
end
|
|
|
|
|
2019-11-19 06:06:07 +00:00
|
|
|
def valid_secret_token?(token)
|
|
|
|
return false unless token && secret_token
|
|
|
|
|
|
|
|
ActiveSupport::SecurityUtils.secure_compare(token.to_s, secret_token.to_s)
|
|
|
|
end
|
|
|
|
|
|
|
|
def as_json(options = {})
|
|
|
|
options[:except] = Array.wrap(options[:except])
|
|
|
|
options[:except] << :secret_token
|
|
|
|
|
|
|
|
super
|
|
|
|
end
|
|
|
|
|
2020-04-07 15:09:30 +00:00
|
|
|
override :repository
|
2020-02-13 15:08:52 +00:00
|
|
|
def repository
|
2020-09-09 00:08:42 +00:00
|
|
|
@repository ||= Gitlab::GlRepository::SNIPPET.repository_for(self)
|
2020-02-13 15:08:52 +00:00
|
|
|
end
|
|
|
|
|
2020-04-07 15:09:30 +00:00
|
|
|
override :repository_size_checker
|
2020-04-07 00:09:33 +00:00
|
|
|
def repository_size_checker
|
|
|
|
strong_memoize(:repository_size_checker) do
|
|
|
|
::Gitlab::RepositorySizeChecker.new(
|
2020-04-09 15:09:29 +00:00
|
|
|
current_size_proc: -> { repository.size.megabytes },
|
2020-10-12 18:08:31 +00:00
|
|
|
limit: Gitlab::CurrentSettings.snippet_size_limit,
|
2020-10-19 12:09:20 +00:00
|
|
|
namespace: nil
|
2020-04-07 00:09:33 +00:00
|
|
|
)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-04-07 15:09:30 +00:00
|
|
|
override :storage
|
2020-02-13 15:08:52 +00:00
|
|
|
def storage
|
|
|
|
@storage ||= Storage::Hashed.new(self, prefix: Storage::Hashed::SNIPPET_REPOSITORY_PATH_PREFIX)
|
|
|
|
end
|
|
|
|
|
2020-10-27 18:08:59 +00:00
|
|
|
# This is the full_path used to identify the the snippet repository.
|
2020-04-07 15:09:30 +00:00
|
|
|
override :full_path
|
2020-02-13 15:08:52 +00:00
|
|
|
def full_path
|
|
|
|
return unless persisted?
|
|
|
|
|
|
|
|
@full_path ||= begin
|
|
|
|
components = []
|
|
|
|
components << project.full_path if project_id?
|
2020-10-27 18:08:59 +00:00
|
|
|
components << 'snippets'
|
2020-02-13 15:08:52 +00:00
|
|
|
components << self.id
|
|
|
|
components.join('/')
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-09-16 12:10:15 +00:00
|
|
|
override :default_branch
|
|
|
|
def default_branch
|
2021-05-14 15:10:35 +00:00
|
|
|
super || Gitlab::DefaultBranch.value(object: project)
|
2020-09-16 12:10:15 +00:00
|
|
|
end
|
|
|
|
|
2020-02-13 15:08:52 +00:00
|
|
|
def repository_storage
|
2021-01-25 15:09:00 +00:00
|
|
|
snippet_repository&.shard_name || Repository.pick_storage_shard
|
2020-02-13 15:08:52 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def create_repository
|
2020-03-04 15:08:09 +00:00
|
|
|
return if repository_exists? && snippet_repository
|
2020-02-13 15:08:52 +00:00
|
|
|
|
2022-03-11 15:07:48 +00:00
|
|
|
repository.create_if_not_exists(default_branch)
|
2020-03-25 12:08:19 +00:00
|
|
|
track_snippet_repository(repository.storage)
|
2020-02-13 15:08:52 +00:00
|
|
|
end
|
|
|
|
|
2020-03-25 12:08:19 +00:00
|
|
|
def track_snippet_repository(shard)
|
|
|
|
snippet_repo = snippet_repository || build_snippet_repository
|
|
|
|
snippet_repo.update!(shard_name: shard, disk_path: disk_path)
|
2020-02-13 15:08:52 +00:00
|
|
|
end
|
|
|
|
|
2020-02-28 21:09:15 +00:00
|
|
|
def can_cache_field?(field)
|
|
|
|
field != :content || MarkupHelper.gitlab_markdown?(file_name)
|
|
|
|
end
|
|
|
|
|
2020-03-06 18:08:08 +00:00
|
|
|
def hexdigest
|
|
|
|
Digest::SHA256.hexdigest("#{title}#{description}#{created_at}#{updated_at}")
|
|
|
|
end
|
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
def file_name_on_repo
|
|
|
|
return if repository.empty?
|
|
|
|
|
2020-09-16 12:10:15 +00:00
|
|
|
list_files(default_branch).first
|
2020-07-01 15:08:45 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def list_files(ref = nil)
|
|
|
|
return [] if repository.empty?
|
|
|
|
|
2020-09-16 12:10:15 +00:00
|
|
|
repository.ls_files(ref || default_branch)
|
2020-04-21 15:21:10 +00:00
|
|
|
end
|
|
|
|
|
2020-09-02 09:10:23 +00:00
|
|
|
def multiple_files?
|
2020-09-16 12:10:15 +00:00
|
|
|
list_files.size > 1
|
2020-09-02 09:10:23 +00:00
|
|
|
end
|
2011-10-16 21:07:10 +00:00
|
|
|
end
|
2019-09-13 13:26:31 +00:00
|
|
|
|
2021-05-11 21:10:21 +00:00
|
|
|
Snippet.prepend_mod_with('Snippet')
|