issuable.rb 11.1 KB
Newer Older
1
# == Issuable concern
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
2
#
3
# Contains common functionality shared between Issues and MergeRequests
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
4 5 6
#
# Used by Issue, MergeRequest
#
7
module Issuable
8
  extend ActiveSupport::Concern
9
  include CacheMarkdownField
10
  include Participable
11
  include Mentionable
12
  include Subscribable
13
  include StripAttribute
14
  include Awardable
15
  include Taskable
16
  include TimeTrackable
17
  include Importable
18

19
  # This object is used to gather issuable meta data for displaying
20
  # upvotes, downvotes, notes and closing merge requests count for issues and merge requests
21
  # lists avoiding n+1 queries and improving performance.
22
  IssuableMeta = Struct.new(:upvotes, :downvotes, :notes_count, :merge_requests_count)
23

24
  included do
25
    cache_markdown_field :title, pipeline: :single_line
26
    cache_markdown_field :description, issuable_state_filter_enabled: true
27

28 29
    belongs_to :author, class_name: "User"
    belongs_to :assignee, class_name: "User"
30
    belongs_to :updated_by, class_name: "User"
31
    belongs_to :last_edited_by, class_name: 'User'
32
    belongs_to :milestone
33
    has_many :notes, as: :noteable, inverse_of: :noteable, dependent: :destroy do
34
      def authors_loaded?
35
        # We check first if we're loaded to not load unnecessarily.
36 37
        loaded? && to_a.all? { |note| note.association(:author).loaded? }
      end
38 39 40 41 42

      def award_emojis_loaded?
        # We check first if we're loaded to not load unnecessarily.
        loaded? && to_a.all? { |note| note.association(:award_emoji).loaded? }
      end
43
    end
Timothy Andrew's avatar
Timothy Andrew committed
44

45 46
    has_many :label_links, as: :target, dependent: :destroy
    has_many :labels, through: :label_links
47
    has_many :todos, as: :target, dependent: :destroy
48

49 50
    has_one :metrics

Douwe Maan's avatar
Douwe Maan committed
51 52
    delegate :name,
             :email,
53
             :public_email,
Douwe Maan's avatar
Douwe Maan committed
54
             to: :author,
55
             allow_nil: true,
Douwe Maan's avatar
Douwe Maan committed
56 57 58 59
             prefix: true

    delegate :name,
             :email,
60
             :public_email,
Douwe Maan's avatar
Douwe Maan committed
61 62 63 64
             to: :assignee,
             allow_nil: true,
             prefix: true

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
65
    validates :author, presence: true
66
    validates :title, presence: true, length: { maximum: 255 }
67

68
    scope :authored, ->(user) { where(author_id: user) }
69
    scope :assigned_to, ->(u) { where(assignee_id: u.id)}
70
    scope :recent, -> { reorder(id: :desc) }
71
    scope :order_position_asc, -> { reorder(position: :asc) }
72 73
    scope :assigned, -> { where("assignee_id IS NOT NULL") }
    scope :unassigned, -> { where("assignee_id IS NULL") }
74
    scope :of_projects, ->(ids) { where(project_id: ids) }
75
    scope :of_milestones, ->(ids) { where(milestone_id: ids) }
76
    scope :with_milestone, ->(title) { left_joins_milestones.where(milestones: { title: title }) }
77
    scope :opened, -> { with_state(:opened, :reopened) }
78 79
    scope :only_opened, -> { with_state(:opened) }
    scope :only_reopened, -> { with_state(:reopened) }
80
    scope :closed, -> { with_state(:closed) }
81

82
    scope :left_joins_milestones,    -> { joins("LEFT OUTER JOIN milestones ON #{table_name}.milestone_id = milestones.id") }
83 84
    scope :order_milestone_due_desc, -> { left_joins_milestones.reorder('milestones.due_date IS NULL, milestones.id IS NULL, milestones.due_date DESC') }
    scope :order_milestone_due_asc,  -> { left_joins_milestones.reorder('milestones.due_date IS NULL, milestones.id IS NULL, milestones.due_date ASC') }
85

86
    scope :without_label, -> { joins("LEFT OUTER JOIN label_links ON label_links.target_type = '#{name}' AND label_links.target_id = #{table_name}.id").where(label_links: { id: nil }) }
87
    scope :join_project, -> { joins(:project) }
88
    scope :inc_notes_with_associations, -> { includes(notes: [:project, :author, :award_emoji]) }
89
    scope :references_project, -> { references(:project) }
90
    scope :non_archived, -> { join_project.where(projects: { archived: false }) }
91

92
    attr_mentionable :title, pipeline: :single_line
Yorick Peterse's avatar
Yorick Peterse committed
93 94 95 96 97 98
    attr_mentionable :description

    participant :author
    participant :assignee
    participant :notes_with_associations

99
    strip_attributes :title
100 101

    acts_as_paranoid
102 103

    after_save :update_assignee_cache_counts, if: :assignee_id_changed?
104
    after_save :record_metrics, unless: :imported?
105 106

    def update_assignee_cache_counts
107
      # make sure we flush the cache for both the old *and* new assignees(if they exist)
108
      previous_assignee = User.find_by_id(assignee_id_was) if assignee_id_was
109 110
      previous_assignee&.update_cache_counts
      assignee&.update_cache_counts
111
    end
112 113 114 115 116 117

    # We want to use optimistic lock for cases when only title or description are involved
    # http://api.rubyonrails.org/classes/ActiveRecord/Locking/Optimistic.html
    def locking_enabled?
      title_changed? || description_changed?
    end
118 119
  end

120
  module ClassMethods
121 122 123 124 125 126 127
    # Searches for records with a matching title.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # query - The search query as a String
    #
    # Returns an ActiveRecord::Relation.
128
    def search(query)
129
      where(arel_table[:title].matches("%#{query}%"))
130
    end
131

132 133 134 135 136 137 138
    # Searches for records with a matching title or description.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # query - The search query as a String
    #
    # Returns an ActiveRecord::Relation.
139
    def full_search(query)
140 141 142 143
      t = arel_table
      pattern = "%#{query}%"

      where(t[:title].matches(pattern).or(t[:description].matches(pattern)))
144 145
    end

146
    def sort(method, excluded_labels: [])
147 148 149 150 151
      sorted = case method.to_s
               when 'milestone_due_asc' then order_milestone_due_asc
               when 'milestone_due_desc' then order_milestone_due_desc
               when 'downvotes_desc' then order_downvotes_desc
               when 'upvotes_desc' then order_upvotes_desc
152 153
               when 'label_priority' then order_labels_priority(excluded_labels: excluded_labels)
               when 'priority' then order_due_date_and_labels_priority(excluded_labels: excluded_labels)
154
               when 'position_asc' then  order_position_asc
155 156 157 158 159 160
               else
                 order_by(method)
               end

      # Break ties with the ID column for pagination
      sorted.order(id: :desc)
161
    end
162

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    def order_due_date_and_labels_priority(excluded_labels: [])
      # The order_ methods also modify the query in other ways:
      #
      # - For milestones, we add a JOIN.
      # - For label priority, we change the SELECT, and add a GROUP BY.#
      #
      # After doing those, we need to reorder to the order we want. The existing
      # ORDER BYs won't work because:
      #
      # 1. We need milestone due date first.
      # 2. We can't ORDER BY a column that isn't in the GROUP BY and doesn't
      #    have an aggregate function applied, so we do a useless MIN() instead.
      #
      milestones_due_date = 'MIN(milestones.due_date)'

      order_milestone_due_asc.
        order_labels_priority(excluded_labels: excluded_labels, extra_select_columns: [milestones_due_date]).
        reorder(Gitlab::Database.nulls_last_order(milestones_due_date, 'ASC'),
                Gitlab::Database.nulls_last_order('highest_priority', 'ASC'))
    end

    def order_labels_priority(excluded_labels: [], extra_select_columns: [])
185 186 187
      params = {
        target_type: name,
        target_column: "#{table_name}.id",
188
        project_column: "#{table_name}.#{project_foreign_key}",
189 190 191 192
        excluded_labels: excluded_labels
      }

      highest_priority = highest_label_priority(params).to_sql
Felipe Artur's avatar
Felipe Artur committed
193

194 195 196 197 198 199
      select_columns = [
        "#{table_name}.*",
        "(#{highest_priority}) AS highest_priority"
      ] + extra_select_columns

      select(select_columns.join(', ')).
200 201
        group(arel_table[:id]).
        reorder(Gitlab::Database.nulls_last_order('highest_priority', 'ASC'))
202 203
    end

204
    def with_label(title, sort = nil)
205
      if title.is_a?(Array) && title.size > 1
206
        joins(:labels).where(labels: { title: title }).group(*grouping_columns(sort)).having("COUNT(DISTINCT labels.title) = #{title.size}")
207 208 209 210
      else
        joins(:labels).where(labels: { title: title })
      end
    end
211 212 213 214 215

    # Includes table keys in group by clause when sorting
    # preventing errors in postgres
    #
    # Returns an array of arel columns
216 217
    def grouping_columns(sort)
      grouping_columns = [arel_table[:id]]
218

Douwe Maan's avatar
Douwe Maan committed
219
      if %w(milestone_due_desc milestone_due_asc).include?(sort)
220
        milestone_table = Milestone.arel_table
221 222
        grouping_columns << milestone_table[:id]
        grouping_columns << milestone_table[:due_date]
223 224
      end

225
      grouping_columns
226
    end
227 228 229 230

    def to_ability_name
      model_name.singular
    end
231 232 233 234 235 236 237 238 239
  end

  def today?
    Date.today == created_at.to_date
  end

  def new?
    today? && created_at == updated_at
  end
240 241 242 243 244

  def is_being_reassigned?
    assignee_id_changed?
  end

245 246 247 248
  def open?
    opened? || reopened?
  end

Z.J. van de Weg's avatar
Z.J. van de Weg committed
249
  def user_notes_count
250 251 252 253 254 255 256
    if notes.loaded?
      # Use the in-memory association to select and count to avoid hitting the db
      notes.to_a.count { |note| !note.system? }
    else
      # do the count query
      notes.user.count
    end
Z.J. van de Weg's avatar
Z.J. van de Weg committed
257 258
  end

259
  def subscribed_without_subscriptions?(user, project)
260 261 262
    participants(user).include?(user)
  end

Kirill Zaitsev's avatar
Kirill Zaitsev committed
263
  def to_hook_data(user)
264
    hook_data = {
265
      object_kind: self.class.name.underscore,
Kirill Zaitsev's avatar
Kirill Zaitsev committed
266
      user: user.hook_attrs,
267 268
      project: project.hook_attrs,
      object_attributes: hook_attrs,
269
      labels: labels.map(&:hook_attrs),
270 271
      # DEPRECATED
      repository: project.hook_attrs.slice(:name, :url, :description, :homepage)
272
    }
273
    hook_data[:assignee] = assignee.hook_attrs if assignee
274 275

    hook_data
276
  end
277

278 279 280 281
  def labels_array
    labels.to_a
  end

282 283 284 285
  def label_names
    labels.order('title ASC').pluck(:title)
  end

286 287 288 289 290 291 292
  # Convert this Issuable class name to a format usable by Ability definitions
  #
  # Examples:
  #
  #   issuable.class           # => MergeRequest
  #   issuable.to_ability_name # => "merge_request"
  def to_ability_name
293
    self.class.to_ability_name
294 295
  end

296 297 298 299 300 301 302 303
  # Returns a Hash of attributes to be used for Twitter card metadata
  def card_attributes
    {
      'Author'   => author.try(:name),
      'Assignee' => assignee.try(:name)
    }
  end

304
  def notes_with_associations
305 306 307 308 309 310
    # If A has_many Bs, and B has_many Cs, and you do
    # `A.includes(b: :c).each { |a| a.b.includes(:c) }`, sadly ActiveRecord
    # will do the inclusion again. So, we check if all notes in the relation
    # already have their authors loaded (possibly because the scope
    # `inc_notes_with_associations` was used) and skip the inclusion if that's
    # the case.
311 312 313 314 315 316 317 318
    includes = []
    includes << :author unless notes.authors_loaded?
    includes << :award_emoji unless notes.award_emojis_loaded?
    if includes.any?
      notes.includes(includes)
    else
      notes
    end
319 320
  end

321 322 323
  def updated_tasks
    Taskable.get_updated_tasks(old_content: previous_changes['description'].first,
                               new_content: description)
324
  end
325 326 327 328 329 330 331 332 333

  ##
  # Method that checks if issuable can be moved to another project.
  #
  # Should be overridden if issuable can be moved.
  #
  def can_move?(*)
    false
  end
334

Yorick Peterse's avatar
Yorick Peterse committed
335 336 337 338 339
  def assignee_or_author?(user)
    # We're comparing IDs here so we don't need to load any associations.
    author_id == user.id || assignee_id == user.id
  end

340 341 342 343
  def record_metrics
    metrics = self.metrics || create_metrics
    metrics.record!
  end
344
end