Send email to Namespace owners when CI minutes have been consumed

An email is sent to all owners when all CI minutes have been used, this
also includes extra CI minutes.

app/helpers/runners_helper.rb

@@ -39,3 +39,5 @@ module RunnersHelper
     end
   end
 end
+
+RunnersHelper.prepend(EE::RunnersHelper)

db/migrate/20190606014128_add_last_ci_minutes_notification_at_to_namespaces.rb

+# frozen_string_literal: true
+
+# See http://doc.gitlab.com/ce/development/migration_style_guide.html
+# for more information on how to write migrations for GitLab.
+
+class AddLastCiMinutesNotificationAtToNamespaces < ActiveRecord::Migration[5.1]
+  DOWNTIME = false
+
+  def change
+    add_column :namespaces, :last_ci_minutes_notification_at, :datetime_with_timezone
+  end
+end

db/schema.rb

@@ -2052,6 +2052,7 @@ ActiveRecord::Schema.define(version: 20190611161641) do
     t.integer "custom_project_templates_group_id"
     t.boolean "auto_devops_enabled"
     t.integer "extra_shared_runners_minutes_limit"
+    t.datetime_with_timezone "last_ci_minutes_notification_at"
     t.index ["created_at"], name: "index_namespaces_on_created_at", using: :btree
     t.index ["custom_project_templates_group_id", "type"], name: "index_namespaces_on_custom_project_templates_group_id_and_type", where: "(custom_project_templates_group_id IS NOT NULL)", using: :btree
     t.index ["file_template_project_id"], name: "index_namespaces_on_file_template_project_id", using: :btree

doc/user/admin_area/settings/continuous_integration.md

@@ -134,6 +134,14 @@ to a different Group.
 be deducted from your Additional Minutes quota immediately after your purchase of additional
 minutes.
 
+## What happens when my CI minutes quota run out
+
+When the CI minutes quota run out, an email is sent automatically to notifies the owner(s) of the group/namespace which
+includes a link to [purchase more minutes](https://customers.gitlab.com/plans).
+
+If you are not the owner of the group, you will need to contact them to let them know they need to
+[purchase more minutes](https://customers.gitlab.com/plans).
+
 ## Archive jobs **[CORE ONLY]**
 
 Archiving jobs is useful for reducing the CI/CD footprint on the system by
@@ -160,4 +168,4 @@ questions that you know someone might ask.
 
 Each scenario can be a third-level heading, e.g. `### Getting error message X`.
 If you have none to add when creating a doc, leave this section in place
-but commented out to help encourage others to add to it in the future. -->
+but commented out to help encourage others to add to it in the future. -->
\ No newline at end of file

ee/app/helpers/ee/runners_helper.rb

+# frozen_string_literal: true
+module EE
+  module RunnersHelper
+    def purchase_shared_runner_minutes_link(user, project)
+      if ::Gitlab.com? && can?(user, :admin_project, project)
+        link_to(_("Click here"), EE::SUBSCRIPTIONS_PLANS_URL, target: '_blank', rel: 'noopener') + s_("Pipelines| to purchase more minutes.")
+      else
+        s_("Pipelines|Pipelines will not run anymore on shared Runners.")
+      end
+    end
+  end
+end

ee/app/mailers/ci_minutes_usage_mailer.rb

+# frozen_string_literal: true
+
+class CiMinutesUsageMailer < BaseMailer
+  def notify(namespace_name, contact_email)
+    @namespace_name = namespace_name
+
+    mail(
+      to: contact_email,
+      subject: "GitLab CI Runner Minutes quota for #{namespace_name} has run out"
+    )
+  end
+end

ee/app/models/ee/namespace.rb

@@ -28,6 +28,8 @@ module EE
     PLANS = NAMESPACE_PLANS_TO_LICENSE_PLANS.keys.freeze
 
     prepended do
+      include EachBatch
+
       belongs_to :plan
 
       has_one :namespace_statistics

ee/app/services/ci_minutes_usage_notify_service.rb

+# frozen_string_literal: true
+
+class CiMinutesUsageNotifyService < BaseService
+  def execute
+    return unless namespace.shared_runners_minutes_used? && namespace.last_ci_minutes_notification_at.nil?
+
+    namespace.update_columns(last_ci_minutes_notification_at: Time.now)
+
+    owners.each do |user|
+      CiMinutesUsageMailer.notify(namespace.name, user.email).deliver_later
+    end
+  end
+
+  private
+
+  def namespace
+    @namespace ||= project.shared_runners_limit_namespace
+  end
+
+  def owners
+    namespace.user? ? [namespace.owner] : namespace.owners
+  end
+end

ee/app/views/ci_minutes_usage_mailer/notify.html.haml

+%p
+  This is an automated notification to let you know that your CI Runner Minutes quota for "#{@namespace_name}" has run out.
+%p
+  Click #{link_to('here', EE::SUBSCRIPTIONS_PLANS_URL)} to purchase more minutes.
+%p
+  If you need assistance, please contact #{link_to('GitLab support', 'https://support.gitlab.com')}.

ee/app/views/ci_minutes_usage_mailer/notify.text.erb

+This is an automated notification to let you know that your CI Runner Minutes quota for "<%= @namespace_name %>" has run out.
+
+Please visit <%= EE::SUBSCRIPTIONS_PLANS_URL %> to purchase more minutes.
+
+If you need assistance, please contact GitLab support (https://support.gitlab.com).

ee/app/views/shared/_shared_runners_minutes_limit.html.haml

@@ -3,10 +3,11 @@
 - scope = (project || namespace).full_path
 - has_limit = (project || namespace).shared_runners_minutes_limit_enabled?
 - can_see_status = project.nil? || can?(current_user, :create_pipeline, project)
+
 - if cookies[:hide_shared_runner_quota_message].blank? && has_limit && namespace.shared_runners_minutes_used? && can_see_status
   .shared-runner-quota-message.alert.alert-warning.d-none.d-sm-block{ data: { scope: scope } }
     = namespace.name
-    has exceeded their pipeline minutes quota. Pipelines will not run anymore on shared Runners.
+    has exceeded its pipeline minutes quota. #{purchase_shared_runner_minutes_link(current_user, project)}
 
     .float-right
       = link_to 'Remind later', '#', class: 'hide-shared-runner-limit-message alert-link'

ee/app/workers/clear_shared_runners_minutes_worker.rb

@@ -19,6 +19,10 @@ class ClearSharedRunnersMinutesWorker
         .update_all("extra_shared_runners_minutes_limit = #{extra_minutes_left_sql} FROM namespace_statistics")
     end
 
+    Namespace.where.not(last_ci_minutes_notification_at: nil).each_batch do |relation|
+      relation.update_all(last_ci_minutes_notification_at: nil)
+    end
+
     NamespaceStatistics.where.not(shared_runners_seconds: 0)
       .update_all(
         shared_runners_seconds: 0,

ee/app/workers/ee/build_finished_worker.rb

@@ -4,6 +4,9 @@ module EE
   module BuildFinishedWorker
     def process_build(build)
       UpdateBuildMinutesService.new(build.project, nil).execute(build)
+      # We need to use `reset` on `project` because their AR associations have been cached
+      # and `Namespace#namespace_statistics` will return stale data.
+      CiMinutesUsageNotifyService.new(build.project.reset).execute
 
       super
     end

ee/changelogs/unreleased/11629-notify-users-when-their-ci-minutes-quota-has-run-out.yml

+---
+title: Notify users when their CI minutes quota has run out
+merge_request: 13735
+author:
+type: added

ee/lib/ee/api/namespaces.rb

@@ -18,6 +18,17 @@ module EE
           def custom_namespace_present_options
             { requested_hosted_plan: params[:requested_hosted_plan] }
           end
+
+          def update_namespace(namespace)
+            update_attrs = declared_params(include_missing: false)
+
+            # Reset last_ci_minutes_notification_at if customer purchased extra CI minutes.
+            if params[:extra_shared_runners_minutes_limit].present?
+              update_attrs[:last_ci_minutes_notification_at] = nil
+            end
+
+            namespace.update(update_attrs)
+          end
         end
 
         resource :namespaces do
@@ -48,7 +59,7 @@ module EE
 
             break not_found!('Namespace') unless namespace
 
-            if namespace.update(declared_params(include_missing: false))
+            if update_namespace(namespace)
               present namespace, with: ::API::Entities::Namespace, current_user: current_user
             else
               render_validation_error!(namespace)

ee/spec/features/ci_shared_runner_warnings_spec.rb

@@ -32,12 +32,12 @@ describe 'CI shared runner limits' do
 
         it 'displays a warning message on project homepage' do
           visit_project_home
-          expect_quota_exceeded_alert("#{group.name} has exceeded their pipeline minutes quota.")
+          expect_quota_exceeded_alert("#{group.name} has exceeded its pipeline minutes quota.")
         end
 
         it 'displays a warning message on pipelines page' do
           visit_project_pipelines
-          expect_quota_exceeded_alert("#{group.name} has exceeded their pipeline minutes quota.")
+          expect_quota_exceeded_alert("#{group.name} has exceeded its pipeline minutes quota.")
         end
       end
 

ee/spec/requests/api/namespaces_spec.rb

@@ -156,6 +156,18 @@ describe API::Namespaces do
         expect(json_response['message']).to eq('plan' => ['is not included in the list'])
       end
     end
+
+    context 'when namespace has a value for last_ci_minutes_notification_at' do
+      before do
+        group1.update_attribute(:last_ci_minutes_notification_at, Time.now)
+      end
+
+      it 'resets that value when assigning extra CI minutes' do
+        expect do
+          put api("/namespaces/#{group1.full_path}", admin), params: { plan: 'silver', extra_shared_runners_minutes_limit: 1000 }
+        end.to change { group1.reload.last_ci_minutes_notification_at }.to(nil)
+      end
+    end
   end
 
   describe 'POST :id/gitlab_subscription' do

ee/spec/services/ci_minutes_usage_notify_service_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CiMinutesUsageNotifyService do
+  shared_examples 'namespace with available CI minutes' do
+    context 'when usage is below the quote' do
+      it 'does not send the email' do
+        expect(CiMinutesUsageMailer).not_to receive(:notify)
+
+        subject
+      end
+    end
+  end
+
+  shared_examples 'namespace with all CI minutes used' do
+    context 'when usage is over the quote' do
+      it 'sends the email to the owner' do
+        expect(CiMinutesUsageMailer).to receive(:notify).once.with(namespace.name, user.email).and_return(spy)
+
+        subject
+      end
+    end
+  end
+
+  describe '#execute' do
+    let(:extra_ci_minutes) { 0 }
+    let(:namespace) do
+      create(:namespace, shared_runners_minutes_limit: 2000, extra_shared_runners_minutes_limit: extra_ci_minutes)
+    end
+
+    let(:project) { create(:project, namespace: namespace) }
+    let(:user) { create(:user) }
+    let(:user_2) { create(:user) }
+
+    let(:ci_minutes_used) { 0 }
+    let!(:namespace_statistics) do
+      create(:namespace_statistics, namespace: namespace, shared_runners_seconds: ci_minutes_used * 60)
+    end
+
+    subject { described_class.new(project).execute }
+
+    context 'with a personal namespace' do
+      before do
+        namespace.update(owner_id: user.id)
+      end
+
+      it_behaves_like 'namespace with available CI minutes' do
+        let(:ci_minutes_used) { 1900 }
+      end
+
+      it_behaves_like 'namespace with all CI minutes used' do
+        let(:ci_minutes_used) { 2500 }
+      end
+    end
+
+    context 'with a Group' do
+      let!(:namespace) do
+        create(:group, shared_runners_minutes_limit: 2000, extra_shared_runners_minutes_limit: extra_ci_minutes)
+      end
+
+      context 'with a single owner' do
+        before do
+          namespace.add_owner(user)
+        end
+
+        it_behaves_like 'namespace with available CI minutes' do
+          let(:ci_minutes_used) { 1900 }
+        end
+
+        it_behaves_like 'namespace with all CI minutes used' do
+          let(:ci_minutes_used) { 2500 }
+        end
+
+        context 'with extra CI minutes' do
+          let(:extra_ci_minutes) { 1000 }
+
+          it_behaves_like 'namespace with available CI minutes' do
+            let(:ci_minutes_used) { 2500 }
+          end
+
+          it_behaves_like 'namespace with all CI minutes used' do
+            let(:ci_minutes_used) { 3100 }
+          end
+        end
+      end
+
+      context 'with multiple owners' do
+        before do
+          namespace.add_owner(user)
+          namespace.add_owner(user_2)
+        end
+
+        it_behaves_like 'namespace with available CI minutes' do
+          let(:ci_minutes_used) { 1900 }
+        end
+
+        context 'when usage is over the quote' do
+          let(:ci_minutes_used) { 2001 }
+
+          it 'sends the email to all the owners' do
+            expect(CiMinutesUsageMailer).to receive(:notify).with(namespace.name, user.email).and_return(spy)
+            expect(CiMinutesUsageMailer).to receive(:notify).with(namespace.name, user_2.email).and_return(spy)
+
+            subject
+          end
+
+          context 'when last_ci_minutes_notification_at has a value' do
+            before do
+              namespace.update_attribute(:last_ci_minutes_notification_at, Time.now)
+            end
+
+            it 'does not notify owners' do
+              expect(CiMinutesUsageMailer).not_to receive(:notify)
+
+              subject
+            end
+          end
+        end
+      end
+    end
+  end
+end

ee/spec/workers/build_finished_worker_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BuildFinishedWorker do
+  let(:ci_runner) { create(:ci_runner) }
+  let(:build) { create(:ee_ci_build, :success, runner: ci_runner) }
+  let(:project) { build.project }
+  let(:namespace) { project.shared_runners_limit_namespace }
+
+  subject do
+    described_class.new.perform(build.id)
+  end
+
+  def namespace_stats
+    namespace.namespace_statistics || namespace.create_namespace_statistics
+  end
+
+  def project_stats
+    project.statistics || project.create_statistics(namespace: project.namespace)
+  end
+
+  describe '#perform' do
+    before do
+      allow_any_instance_of(EE::Project).to receive(:shared_runners_minutes_limit_enabled?).and_return(true)
+    end
+
+    it 'updates the project stats' do
+      expect { subject }.to change { project_stats.reload.shared_runners_seconds }
+    end
+
+    it 'updates the namespace stats' do
+      expect { subject }.to change { namespace_stats.reload.shared_runners_seconds }
+    end
+
+    it 'notifies the owners of Groups' do
+      namespace.update_attribute(:shared_runners_minutes_limit, 2000)
+      namespace_stats.update_attribute(:shared_runners_seconds, 2100 * 60)
+
+      expect(CiMinutesUsageMailer).to receive(:notify).once.with(namespace.name, namespace.owner.email).and_return(spy)
+
+      subject
+    end
+  end
+end

locale/gitlab.pot

@@ -2645,6 +2645,9 @@ msgstr ""
 msgid "Click any <strong>project name</strong> in the project list below to navigate to the project milestone."
 msgstr ""
 
+msgid "Click here"
+msgstr ""
+
 msgid "Click the <strong>Download</strong> button and wait for downloading to complete."
 msgstr ""
 
@@ -9443,6 +9446,9 @@ msgstr ""
 msgid "Pipelines settings for '%{project_name}' were successfully updated."
 msgstr ""
 
+msgid "Pipelines| to purchase more minutes."
+msgstr ""
+
 msgid "Pipelines|API"
 msgstr ""
 
@@ -9464,6 +9470,9 @@ msgstr ""
 msgid "Pipelines|Loading Pipelines"
 msgstr ""
 
+msgid "Pipelines|Pipelines will not run anymore on shared Runners."
+msgstr ""
+
 msgid "Pipelines|Project cache successfully reset."
 msgstr ""