Merge branch 'persistent-callouts' into 'master'

Add backend for persistently dismissible callouts

See merge request gitlab-org/gitlab-ce!16735

app/controllers/user_callouts_controller.rb

+class UserCalloutsController < ApplicationController
+  def create
+    if ensure_callout.persisted?
+      respond_to do |format|
+        format.json { head :ok }
+      end
+    else
+      respond_to do |format|
+        format.json { head :bad_request }
+      end
+    end
+  end
+
+  private
+
+  def ensure_callout
+    current_user.callouts.find_or_create_by(feature_name: UserCallout.feature_names[feature_name])
+  end
+
+  def feature_name
+    params.require(:feature_name)
+  end
+end

app/helpers/user_callouts_helper.rb

+module UserCalloutsHelper
+  GKE_CLUSTER_INTEGRATION = 'gke_cluster_integration'.freeze
+
+  def show_gke_cluster_integration_callout?(project)
+    can?(current_user, :create_cluster, project) &&
+      !user_dismissed?(GKE_CLUSTER_INTEGRATION)
+  end
+
+  private
+
+  def user_dismissed?(feature_name)
+    current_user&.callouts&.find_by(feature_name: feature_name)
+  end
+end

app/models/user.rb

@@ -135,6 +135,7 @@ class User < ActiveRecord::Base
   has_many :assigned_merge_requests,  dependent: :nullify, foreign_key: :assignee_id, class_name: "MergeRequest" # rubocop:disable Cop/ActiveRecordDependent
 
   has_many :custom_attributes, class_name: 'UserCustomAttribute'
+  has_many :callouts, class_name: 'UserCallout'
   has_many :uploads, as: :model, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
 
   #

app/models/user_callout.rb

+class UserCallout < ActiveRecord::Base
+  belongs_to :user
+
+  enum feature_name: {
+    gke_cluster_integration: 1
+  }
+
+  validates :user, presence: true
+  validates :feature_name,
+    presence: true,
+    uniqueness: { scope: :user_id },
+    inclusion: { in: UserCallout.feature_names.keys }
+end

changelogs/unreleased/persistent-callouts.yml

+---
+title: Add backend for persistently dismissably callouts
+merge_request:
+author:
+type: added

config/routes.rb

@@ -60,6 +60,9 @@ Rails.application.routes.draw do
 
       resources :issues, module: :boards, only: [:index, :update]
     end
+
+    # UserCallouts
+    resources :user_callouts, only: [:create]
   end
 
   # Koding route

db/migrate/20180125214301_create_user_callouts.rb

+# See http://doc.gitlab.com/ce/development/migration_style_guide.html
+# for more information on how to write migrations for GitLab.
+
+class CreateUserCallouts < ActiveRecord::Migration
+  # Set this constant to true if this migration requires downtime.
+  DOWNTIME = false
+
+  def change
+    create_table :user_callouts do |t|
+      t.integer :feature_name, null: false
+      t.references :user, index: true, foreign_key: { on_delete: :cascade }, null: false
+    end
+
+    add_index :user_callouts, [:user_id, :feature_name], unique: true
+  end
+end

db/schema.rb

@@ -1769,6 +1769,14 @@ ActiveRecord::Schema.define(version: 20180202111106) do
 
   add_index "user_agent_details", ["subject_id", "subject_type"], name: "index_user_agent_details_on_subject_id_and_subject_type", using: :btree
 
+  create_table "user_callouts", force: :cascade do |t|
+    t.integer "feature_name", null: false
+    t.integer "user_id", null: false
+  end
+
+  add_index "user_callouts", ["user_id", "feature_name"], name: "index_user_callouts_on_user_id_and_feature_name", unique: true, using: :btree
+  add_index "user_callouts", ["user_id"], name: "index_user_callouts_on_user_id", using: :btree
+
   create_table "user_custom_attributes", force: :cascade do |t|
     t.datetime_with_timezone "created_at", null: false
     t.datetime_with_timezone "updated_at", null: false
@@ -2040,6 +2048,7 @@ ActiveRecord::Schema.define(version: 20180202111106) do
   add_foreign_key "todos", "projects", name: "fk_45054f9c45", on_delete: :cascade
   add_foreign_key "trending_projects", "projects", on_delete: :cascade
   add_foreign_key "u2f_registrations", "users"
+  add_foreign_key "user_callouts", "users", on_delete: :cascade
   add_foreign_key "user_custom_attributes", "users", on_delete: :cascade
   add_foreign_key "user_synced_attributes_metadata", "users", on_delete: :cascade
   add_foreign_key "users_star_projects", "projects", name: "fk_22cd27ddfc", on_delete: :cascade

spec/controllers/user_callouts_controller_spec.rb

+require 'spec_helper'
+
+describe UserCalloutsController do
+  let(:user) { create(:user) }
+
+  before do
+    sign_in(user)
+  end
+
+  describe "POST #create" do
+    subject { post :create, feature_name: feature_name, format: :json }
+
+    context 'with valid feature name' do
+      let(:feature_name) { UserCallout.feature_names.keys.first }
+
+      context 'when callout entry does not exist' do
+        it 'should create a callout entry with dismissed state' do
+          expect { subject }.to change { UserCallout.count }.by(1)
+        end
+
+        it 'should return success' do
+          subject
+
+          expect(response).to have_gitlab_http_status(:ok)
+        end
+      end
+
+      context 'when callout entry already exists' do
+        let!(:callout) { create(:user_callout, feature_name: UserCallout.feature_names.keys.first, user: user) }
+
+        it 'should return success' do
+          subject
+
+          expect(response).to have_gitlab_http_status(:ok)
+        end
+      end
+    end
+
+    context 'with invalid feature name' do
+      let(:feature_name) { 'bogus_feature_name' }
+
+      it 'should return bad request' do
+        subject
+
+        expect(response).to have_gitlab_http_status(:bad_request)
+      end
+    end
+  end
+end

spec/factories/user_callouts.rb

+FactoryBot.define do
+  factory :user_callout do
+    feature_name :gke_cluster_integration
+
+    user
+  end
+end

spec/helpers/user_callouts_helper_spec.rb

+require "spec_helper"
+
+describe UserCalloutsHelper do
+  let(:user) { create(:user) }
+
+  before do
+    allow(helper).to receive(:current_user).and_return(user)
+  end
+
+  describe '.show_gke_cluster_integration_callout?' do
+    let(:project) { create(:project) }
+
+    subject { helper.show_gke_cluster_integration_callout?(project) }
+
+    context 'when user can create a cluster' do
+      before do
+        allow(helper).to receive(:can?).with(anything, :create_cluster, anything)
+          .and_return(true)
+      end
+
+      context 'when user has not dismissed' do
+        before do
+          allow(helper).to receive(:user_dismissed?).and_return(false)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context 'when user dismissed' do
+        before do
+          allow(helper).to receive(:user_dismissed?).and_return(true)
+        end
+
+        it { is_expected.to be false }
+      end
+    end
+
+    context 'when user can not create a cluster' do
+      before do
+        allow(helper).to receive(:can?).with(anything, :create_cluster, anything)
+          .and_return(false)
+      end
+
+      it { is_expected.to be false }
+    end
+  end
+end

spec/models/user_callout_spec.rb

+require 'rails_helper'
+
+describe UserCallout do
+  let!(:callout) { create(:user_callout) }
+
+  describe 'relationships' do
+    it { is_expected.to belong_to(:user) }
+  end
+
+  describe 'validations' do
+    it { is_expected.to validate_presence_of(:user) }
+
+    it { is_expected.to validate_presence_of(:feature_name) }
+    it { is_expected.to validate_uniqueness_of(:feature_name).scoped_to(:user_id).ignoring_case_sensitivity }
+  end
+end