Merge branch '8998_skip_pending_commits_if_not_head' into 'master'

Add auto-cancel for pending pipelines on branch, if they are not HEAD

See merge request !9362

14 files changed, 138 insertions, 57 deletions

diff --git a/app/controllers/projects/pipelines_controller.rb b/app/controllers/projects/pipelines_controller.rb
index 5de8301f74c..1780cc0233c 100644
--- a/app/controllers/projects/pipelines_controller.rb
+++ b/app/controllers/projects/pipelines_controller.rb
@@ -116,7 +116,7 @@ class Projects::PipelinesController < Projects::ApplicationController
   end
 
   def pipeline
-    @pipeline ||= project.pipelines.find_by!(id: params[:id])
+    @pipeline ||= project.pipelines.find_by!(id: params[:id]).present(current_user: current_user)
   end
 
   def commit
diff --git a/app/controllers/projects/pipelines_settings_controller.rb b/app/controllers/projects/pipelines_settings_controller.rb
index c8c80551ac9..ff50602831c 100644
--- a/app/controllers/projects/pipelines_settings_controller.rb
+++ b/app/controllers/projects/pipelines_settings_controller.rb
@@ -23,7 +23,7 @@ class Projects::PipelinesSettingsController < Projects::ApplicationController
   def update_params
     params.require(:project).permit(
       :runners_token, :builds_enabled, :build_allow_git_fetch, :build_timeout_in_minutes, :build_coverage_regex,
-      :public_builds
+      :public_builds, :auto_cancel_pending_pipelines
     )
   end
 end
diff --git a/app/models/ci/pipeline.rb b/app/models/ci/pipeline.rb
index c197e50ed69..37a81fa7781 100644
--- a/app/models/ci/pipeline.rb
+++ b/app/models/ci/pipeline.rb
@@ -4,9 +4,14 @@ module Ci
     include HasStatus
     include Importable
     include AfterCommitQueue
+    include Presentable
 
     belongs_to :project
     belongs_to :user
+    belongs_to :auto_canceled_by, class_name: 'Ci::Pipeline'
+
+    has_many :auto_canceled_pipelines, class_name: 'Ci::Pipeline', foreign_key: 'auto_canceled_by_id'
+    has_many :auto_canceled_jobs, class_name: 'CommitStatus', foreign_key: 'auto_canceled_by_id'
 
     has_many :statuses, class_name: 'CommitStatus', foreign_key: :commit_id
     has_many :builds, foreign_key: :commit_id
@@ -71,6 +76,10 @@ module Ci
         pipeline.update_duration
       end
 
+      before_transition canceled: any - [:canceled] do |pipeline|
+        pipeline.auto_canceled_by = nil
+      end
+
       after_transition [:created, :pending] => :running do |pipeline|
         pipeline.run_after_commit { PipelineMetricsWorker.perform_async(id) }
       end
@@ -216,9 +225,24 @@ module Ci
       cancelable_statuses.any?
     end
 
+    def auto_canceled?
+      canceled? && auto_canceled_by_id?
+    end
+
     def cancel_running
       Gitlab::OptimisticLocking.retry_lock(cancelable_statuses) do |cancelable|
-        cancelable.find_each(&:cancel)
+        cancelable.find_each do |job|
+          yield(job) if block_given?
+          job.cancel
+        end
+      end
+    end
+
+    def auto_cancel_running(pipeline)
+      update(auto_canceled_by: pipeline)
+
+      cancel_running do |job|
+        job.auto_canceled_by = pipeline
       end
     end
 
diff --git a/app/models/commit_status.rb b/app/models/commit_status.rb
index 17b322b5ae3..2c4033146bf 100644
--- a/app/models/commit_status.rb
+++ b/app/models/commit_status.rb
@@ -7,6 +7,7 @@ class CommitStatus < ActiveRecord::Base
 
   belongs_to :project
   belongs_to :pipeline, class_name: 'Ci::Pipeline', foreign_key: :commit_id
+  belongs_to :auto_canceled_by, class_name: 'Ci::Pipeline'
   belongs_to :user
 
   delegate :commit, to: :pipeline
@@ -137,6 +138,10 @@ class CommitStatus < ActiveRecord::Base
     false
   end
 
+  def auto_canceled?
+    canceled? && auto_canceled_by_id?
+  end
+
   # Added in 9.0 to keep backward compatibility for projects exported in 8.17
   # and prior.
   def gl_project_id
diff --git a/app/models/concerns/has_status.rb b/app/models/concerns/has_status.rb
index 0a1a65da05a..2f61709110c 100644
--- a/app/models/concerns/has_status.rb
+++ b/app/models/concerns/has_status.rb
@@ -76,6 +76,7 @@ module HasStatus
     scope :canceled, -> { where(status: 'canceled')  }
     scope :skipped, -> { where(status: 'skipped')  }
     scope :manual, -> { where(status: 'manual')  }
+    scope :created_or_pending, -> { where(status: [:created, :pending]) }
     scope :running_or_pending, -> { where(status: [:running, :pending]) }
     scope :finished, -> { where(status: [:success, :failed, :canceled]) }
     scope :failed_or_canceled, -> { where(status: [:failed, :canceled]) }
diff --git a/app/models/project.rb b/app/models/project.rb
index 2b467f95087..639615b91a2 100644
--- a/app/models/project.rb
+++ b/app/models/project.rb
@@ -262,6 +262,8 @@ class Project < ActiveRecord::Base
   scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
   scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
 
+  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
+
   # project features may be "disabled", "internal" or "enabled". If "internal",
   # they are only available to team members. This scope returns projects where
   # the feature is either enabled, or internal with permission for the user.
diff --git a/app/presenters/ci/build_presenter.rb b/app/presenters/ci/build_presenter.rb
index ed72ed14d72..c495c3f39bb 100644
--- a/app/presenters/ci/build_presenter.rb
+++ b/app/presenters/ci/build_presenter.rb
@@ -11,5 +11,11 @@ module Ci
     def erased_by_name
       erased_by.name if erased_by_user?
     end
+
+    def status_title
+      if auto_canceled?
+        "Job is redundant and is auto-canceled by Pipeline ##{auto_canceled_by_id}"
+      end
+    end
   end
 end
diff --git a/app/presenters/ci/pipeline_presenter.rb b/app/presenters/ci/pipeline_presenter.rb
new file mode 100644
index 00000000000..a542bdd8295
--- /dev/null
+++ b/app/presenters/ci/pipeline_presenter.rb
@@ -0,0 +1,11 @@
+module Ci
+  class PipelinePresenter < Gitlab::View::Presenter::Delegated
+    presents :pipeline
+
+    def status_title
+      if auto_canceled?
+        "Pipeline is redundant and is auto-canceled by Pipeline ##{auto_canceled_by_id}"
+      end
+    end
+  end
+end
diff --git a/app/services/ci/create_pipeline_service.rb b/app/services/ci/create_pipeline_service.rb
index 38a85e9fc42..21350be5557 100644
--- a/app/services/ci/create_pipeline_service.rb
+++ b/app/services/ci/create_pipeline_service.rb
@@ -53,6 +53,8 @@ module Ci
           .execute(pipeline)
       end
 
+      cancel_pending_pipelines if project.auto_cancel_pending_pipelines?
+
       pipeline.tap(&:process!)
     end
 
@@ -63,6 +65,22 @@ module Ci
       pipeline.git_commit_message =~ /\[(ci[ _-]skip|skip[ _-]ci)\]/i
     end
 
+    def cancel_pending_pipelines
+      Gitlab::OptimisticLocking.retry_lock(auto_cancelable_pipelines) do |cancelables|
+        cancelables.find_each do |cancelable|
+          cancelable.auto_cancel_running(pipeline)
+        end
+      end
+    end
+
+    def auto_cancelable_pipelines
+      project.pipelines
+        .where(ref: pipeline.ref)
+        .where.not(id: pipeline.id)
+        .where.not(sha: project.repository.sha_from_ref(pipeline.ref))
+        .created_or_pending
+    end
+
     def commit
       @commit ||= project.commit(origin_sha || origin_ref)
     end
diff --git a/app/views/ci/status/_badge.html.haml b/app/views/ci/status/_badge.html.haml
index c00c7f7407e..39c7fb0eba2 100644
--- a/app/views/ci/status/_badge.html.haml
+++ b/app/views/ci/status/_badge.html.haml
@@ -1,12 +1,13 @@
 - status = local_assigns.fetch(:status)
-- link = local_assigns.fetch(:link, true)
-- css_classes = "ci-status ci-#{status.group}"
+- link   = local_assigns.fetch(:link, true)
+- title  = local_assigns.fetch(:title, nil)
+- css_classes = "ci-status ci-#{status.group} #{'has-tooltip' if title.present?}"
 
 - if link && status.has_details?
-  = link_to status.details_path, class: css_classes do
+  = link_to status.details_path, class: css_classes, title: title do
     = custom_icon(status.icon)
     = status.text
 - else
-  %span{ class: css_classes }
+  %span{ class: css_classes, title: title }
     = custom_icon(status.icon)
     = status.text
diff --git a/app/views/projects/builds/_header.html.haml b/app/views/projects/builds/_header.html.haml
index 7eb17e887e7..104db85809c 100644
--- a/app/views/projects/builds/_header.html.haml
+++ b/app/views/projects/builds/_header.html.haml
@@ -1,14 +1,16 @@
+- pipeline = @build.pipeline
+
 .content-block.build-header.top-area
   .header-content
-    = render 'ci/status/badge', status: @build.detailed_status(current_user), link: false
+    = render 'ci/status/badge', status: @build.detailed_status(current_user), link: false, title: @build.status_title
     Job
     %strong.js-build-id ##{@build.id}
     in pipeline
-    = link_to pipeline_path(@build.pipeline) do
-      %strong ##{@build.pipeline.id}
+    = link_to pipeline_path(pipeline) do
+      %strong ##{pipeline.id}
     for commit
-    = link_to namespace_project_commit_path(@project.namespace, @project, @build.pipeline.sha) do
-      %strong= @build.pipeline.short_sha
+    = link_to namespace_project_commit_path(@project.namespace, @project, pipeline.sha) do
+      %strong= pipeline.short_sha
     from
     = link_to namespace_project_commits_path(@project.namespace, @project, @build.ref) do
       %code
diff --git a/app/views/projects/ci/builds/_build.html.haml b/app/views/projects/ci/builds/_build.html.haml
index 508465cbfb7..4700b7a9a45 100644
--- a/app/views/projects/ci/builds/_build.html.haml
+++ b/app/views/projects/ci/builds/_build.html.haml
@@ -1,3 +1,5 @@
+- job = build.present(current_user: current_user)
+- pipeline = job.pipeline
 - admin = local_assigns.fetch(:admin, false)
 - ref = local_assigns.fetch(:ref, nil)
 - commit_sha = local_assigns.fetch(:commit_sha, nil)
@@ -8,101 +10,101 @@
 
 %tr.build.commit{ class: ('retried' if retried) }
   %td.status
-    = render "ci/status/badge", status: build.detailed_status(current_user)
+    = render "ci/status/badge", status: job.detailed_status(current_user), title: job.status_title
 
   %td.branch-commit
-    - if can?(current_user, :read_build, build)
-      = link_to namespace_project_build_url(build.project.namespace, build.project, build) do
-        %span.build-link ##{build.id}
+    - if can?(current_user, :read_build, job)
+      = link_to namespace_project_build_url(job.project.namespace, job.project, job) do
+        %span.build-link ##{job.id}
     - else
-      %span.build-link ##{build.id}
+      %span.build-link ##{job.id}
 
     - if ref
-      - if build.ref
+      - if job.ref
         .icon-container
-          = build.tag? ? icon('tag') : icon('code-fork')
-        = link_to build.ref, namespace_project_commits_path(build.project.namespace, build.project, build.ref), class: "monospace branch-name"
+          = job.tag? ? icon('tag') : icon('code-fork')
+        = link_to job.ref, namespace_project_commits_path(job.project.namespace, job.project, job.ref), class: "monospace branch-name"
       - else
         .light none
       .icon-container.commit-icon
         = custom_icon("icon_commit")
 
     - if commit_sha
-      = link_to build.short_sha, namespace_project_commit_path(build.project.namespace, build.project, build.sha), class: "commit-id monospace"
+      = link_to job.short_sha, namespace_project_commit_path(job.project.namespace, job.project, job.sha), class: "commit-id monospace"
 
-    - if build.stuck?
+    - if job.stuck?
       = icon('warning', class: 'text-warning has-tooltip', title: 'Job is stuck. Check runners.')
 
     - if retried
       = icon('refresh', class: 'text-warning has-tooltip', title: 'Job was retried')
 
     .label-container
-      - if build.tags.any?
-        - build.tags.each do |tag|
+      - if job.tags.any?
+        - job.tags.each do |tag|
           %span.label.label-primary
             = tag
-      - if build.try(:trigger_request)
+      - if job.try(:trigger_request)
         %span.label.label-info triggered
-      - if build.try(:allow_failure)
+      - if job.try(:allow_failure)
         %span.label.label-danger allowed to fail
-      - if build.action?
+      - if job.action?
         %span.label.label-info manual
 
   - if pipeline_link
     %td
-      = link_to pipeline_path(build.pipeline) do
-        %span.pipeline-id ##{build.pipeline.id}
+      = link_to pipeline_path(pipeline) do
+        %span.pipeline-id ##{pipeline.id}
       %span by
-      - if build.pipeline.user
-        = user_avatar(user: build.pipeline.user, size: 20)
+      - if pipeline.user
+        = user_avatar(user: pipeline.user, size: 20)
       - else
         %span.monospace API
 
   - if admin
     %td
-      - if build.project
-        = link_to build.project.name_with_namespace, admin_namespace_project_path(build.project.namespace, build.project)
+      - if job.project
+        = link_to job.project.name_with_namespace, admin_namespace_project_path(job.project.namespace, job.project)
     %td
-      - if build.try(:runner)
-        = runner_link(build.runner)
+      - if job.try(:runner)
+        = runner_link(job.runner)
       - else
         .light none
 
   - if stage
     %td
-      = build.stage
+      = job.stage
 
   %td
-    = build.name
+    = job.name
 
   %td
-    - if build.duration
+    - if job.duration
       %p.duration
         = custom_icon("icon_timer")
-        = duration_in_numbers(build.duration)
+        = duration_in_numbers(job.duration)
 
-    - if build.finished_at
+    - if job.finished_at
       %p.finished-at
         = icon("calendar")
-        %span= time_ago_with_tooltip(build.finished_at)
+        %span= time_ago_with_tooltip(job.finished_at)
 
   %td.coverage
-    - if build.try(:coverage)
-      #{build.coverage}%
+    - if job.try(:coverage)
+      #{job.coverage}%
 
   %td
     .pull-right
-      - if can?(current_user, :read_build, build) && build.artifacts?
-        = link_to download_namespace_project_build_artifacts_path(build.project.namespace, build.project, build), rel: 'nofollow', download: '', title: 'Download artifacts', class: 'btn btn-build' do
+      - if can?(current_user, :read_build, job) && job.artifacts?
+        = link_to download_namespace_project_build_artifacts_path(job.project.namespace, job.project, job), rel: 'nofollow', download: '', title: 'Download artifacts', class: 'btn btn-build' do
           = icon('download')
-      - if can?(current_user, :update_build, build)
-        - if build.active?
-          = link_to cancel_namespace_project_build_path(build.project.namespace, build.project, build, return_to: request.original_url), method: :post, title: 'Cancel', class: 'btn btn-build' do
+      - if can?(current_user, :update_build, job)
+        - if job.active?
+          = link_to cancel_namespace_project_build_path(job.project.namespace, job.project, job, return_to: request.original_url), method: :post, title: 'Cancel', class: 'btn btn-build' do
             = icon('remove', class: 'cred')
         - elsif allow_retry
-          - if build.playable? && !admin
-            = link_to play_namespace_project_build_path(build.project.namespace, build.project, build, return_to: request.original_url), method: :post, title: 'Play', class: 'btn btn-build' do
+          - if job.playable? && !admin
+            = link_to play_namespace_project_build_path(job.project.namespace, job.project, job, return_to: request.original_url), method: :post, title: 'Play', class: 'btn btn-build' do
               = custom_icon('icon_play')
-          - elsif build.retryable?
-            = link_to retry_namespace_project_build_path(build.project.namespace, build.project, build, return_to: request.original_url), method: :post, title: 'Retry', class: 'btn btn-build' do
+          - elsif job.retryable?
+            = link_to retry_namespace_project_build_path(job.project.namespace, job.project, job, return_to: request.original_url), method: :post, title: 'Retry', class: 'btn btn-build' do
               = icon('repeat')
diff --git a/app/views/projects/pipelines/_info.html.haml b/app/views/projects/pipelines/_info.html.haml
index fc1d0989787..ab6baaf35b6 100644
--- a/app/views/projects/pipelines/_info.html.haml
+++ b/app/views/projects/pipelines/_info.html.haml
@@ -1,6 +1,6 @@
 .page-content-header
   .header-main-content
-    = render 'ci/status/badge', status: @pipeline.detailed_status(current_user)
+    = render 'ci/status/badge', status: @pipeline.detailed_status(current_user), title: @pipeline.status_title
     %strong Pipeline ##{@pipeline.id}
     triggered #{time_ago_with_tooltip(@pipeline.created_at)}
     - if @pipeline.user
diff --git a/app/views/projects/pipelines_settings/_show.html.haml b/app/views/projects/pipelines_settings/_show.html.haml
index 132f6372e40..a3f84476dea 100644
--- a/app/views/projects/pipelines_settings/_show.html.haml
+++ b/app/views/projects/pipelines_settings/_show.html.haml
@@ -21,7 +21,7 @@
             Git strategy for pipelines
           %p
             Choose between <code>clone</code> or <code>fetch</code> to get the recent application code
-            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'git-strategy')
+            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'git-strategy'), target: '_blank'
           .radio
             = f.label :build_allow_git_fetch_false do
               = f.radio_button :build_allow_git_fetch, 'false'
@@ -43,7 +43,7 @@
           = f.number_field :build_timeout_in_minutes, class: 'form-control', min: '0'
           %p.help-block
             Per job in minutes. If a job passes this threshold, it will be marked as failed.
-            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'timeout')
+            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'timeout'), target: '_blank'
 
         %hr
         .form-group
@@ -53,7 +53,16 @@
               %strong Public pipelines
             .help-block
               Allow everyone to access pipelines for public and internal projects
-              = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'visibility-of-pipelines')
+              = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'visibility-of-pipelines'), target: '_blank'
+        %hr
+        .form-group
+          .checkbox
+            = f.label :auto_cancel_pending_pipelines do
+              = f.check_box :auto_cancel_pending_pipelines, {}, 'enabled', 'disabled'
+              %strong Auto-cancel redundant, pending pipelines
+            .help-block
+              New pipelines will cancel older, pending pipelines on the same branch
+              = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'auto-cancel-pending-pipelines'), target: '_blank'
 
         %hr
         .form-group
@@ -65,7 +74,7 @@
           %p.help-block
             A regular expression that will be used to find the test coverage
             output in the job trace. Leave blank to disable
-            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'test-coverage-parsing')
+            = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'test-coverage-parsing'), target: '_blank'
           .bs-callout.bs-callout-info
             %p Below are examples of regex for existing tools:
             %ul