Merge branch 'bvl-license-check-issue-board-milestone' into 'master'

Check license for milestones on issue boards

Closes #2568

See merge request !2315

app/models/board.rb

 class Board < ActiveRecord::Base
+  prepend EE::Board
+
   belongs_to :project
-  belongs_to :milestone
 
   has_many :lists, -> { order(:list_type, :position) }, dependent: :delete_all
 
@@ -13,26 +14,4 @@ class Board < ActiveRecord::Base
   def closed_list
     lists.merge(List.closed).take
   end
-
-  def milestone
-    if milestone_id == Milestone::Upcoming.id
-      Milestone::Upcoming
-    else
-      super
-    end
-  end
-
-  def as_json(options = {})
-    milestone_attrs = options.fetch(:include, {})
-                             .extract!(:milestone)
-                             .dig(:milestone, :only)
-
-    super(options).tap do |json|
-      if milestone.present? && milestone_attrs.present?
-        json[:milestone] = milestone_attrs.each_with_object({}) do |attr, json|
-          json[attr] = milestone.public_send(attr)
-        end
-      end
-    end
-  end
 end

app/models/ee/board.rb

+module EE
+  module Board
+    extend ActiveSupport::Concern
+
+    prepended do
+      belongs_to :milestone
+    end
+
+    def milestone
+      return nil unless project.feature_available?(:issue_board_milestone)
+
+      if milestone_id == ::Milestone::Upcoming.id
+        ::Milestone::Upcoming
+      else
+        super
+      end
+    end
+
+    def as_json(options = {})
+      milestone_attrs = options.fetch(:include, {})
+                          .extract!(:milestone)
+                          .dig(:milestone, :only)
+
+      super(options).tap do |json|
+        if milestone.present? && milestone_attrs.present?
+          json[:milestone] = milestone_attrs.each_with_object({}) do |attr, json|
+            json[attr] = milestone.public_send(attr)
+          end
+        end
+      end
+    end
+  end
+end

app/models/license.rb

@@ -12,6 +12,7 @@ class License < ActiveRecord::Base
   GEO_FEATURE = 'GitLab_Geo'.freeze
   ISSUABLE_DEFAULT_TEMPLATES_FEATURE = 'GitLab_IssuableDefaultTemplates'.freeze
   ISSUE_BOARDS_FOCUS_MODE_FEATURE = 'IssueBoardsFocusMode'.freeze
+  ISSUE_BOARD_MILESTONE_FEATURE = 'IssueBoardMilestone'.freeze
   ISSUE_WEIGHTS_FEATURE = 'GitLab_IssueWeights'.freeze
   MERGE_REQUEST_APPROVERS_FEATURE = 'GitLab_MergeRequestApprovers'.freeze
   MERGE_REQUEST_REBASE_FEATURE = 'GitLab_MergeRequestRebase'.freeze
@@ -38,6 +39,7 @@ class License < ActiveRecord::Base
     file_lock: FILE_LOCK_FEATURE,
     issuable_default_templates: ISSUABLE_DEFAULT_TEMPLATES_FEATURE,
     issue_board_focus_mode: ISSUE_BOARDS_FOCUS_MODE_FEATURE,
+    issue_board_milestone: ISSUE_BOARD_MILESTONE_FEATURE,
     issue_weights: ISSUE_WEIGHTS_FEATURE,
     merge_request_approvers: MERGE_REQUEST_APPROVERS_FEATURE,
     merge_request_rebase: MERGE_REQUEST_REBASE_FEATURE,
@@ -58,6 +60,7 @@ class License < ActiveRecord::Base
     { FAST_FORWARD_MERGE_FEATURE => 1 },
     { ISSUABLE_DEFAULT_TEMPLATES_FEATURE => 1 },
     { ISSUE_BOARDS_FOCUS_MODE_FEATURE => 1 },
+    { ISSUE_BOARD_MILESTONE_FEATURE => 1 },
     { ISSUE_WEIGHTS_FEATURE => 1 },
     { MERGE_REQUEST_APPROVERS_FEATURE => 1 },
     { MERGE_REQUEST_REBASE_FEATURE => 1 },
@@ -98,6 +101,7 @@ class License < ActiveRecord::Base
     { GEO_FEATURE => 1 },
     { ISSUABLE_DEFAULT_TEMPLATES_FEATURE => 1 },
     { ISSUE_BOARDS_FOCUS_MODE_FEATURE => 1 },
+    { ISSUE_BOARD_MILESTONE_FEATURE => 1 },
     { ISSUE_WEIGHTS_FEATURE => 1 },
     { MERGE_REQUEST_APPROVERS_FEATURE => 1 },
     { MERGE_REQUEST_REBASE_FEATURE => 1 },

app/services/boards/update_service.rb

 module Boards
   class UpdateService < BaseService
     def execute(board)
-      board.update(name: params[:name], milestone_id: params[:milestone_id])
+      params.delete(:milestone_id) unless project.feature_available?(:issue_board_milestone)
+
+      board.update(params)
     end
   end
 end

app/views/projects/boards/_switcher.html.haml

@@ -49,9 +49,10 @@
             %li
               %a{ "href" => "#", "@click.stop.prevent" => "showPage('edit')" }
                 Edit board name
-            %li
-              %a{ "href" => "#", "@click.stop.prevent" => "showPage('milestone')" }
-                Edit board milestone
+            - if @project.feature_available?(:issue_board_milestone, current_user)
+              %li
+                %a{ "href" => "#", "@click.stop.prevent" => "showPage('milestone')" }
+                  Edit board milestone
             %li{ "v-if" => "showDelete" }
               %a.text-danger{ "href" => "#", "@click.stop.prevent" => "showPage('delete')" }
                 Delete board

app/views/projects/boards/components/_form.html.haml

@@ -10,32 +10,33 @@
         %input.form-control{ type: "text",
           id: "board-new-name",
           "v-model" => "board.name" }
-      .dropdown.board-inner-milestone-dropdown{ ":class" => "{ open: milestoneDropdownOpen }",
-        "v-if" => "currentPage === 'new'" }
-        %label.label-light{ for: "board-milestone" }
-          Board milestone
-        %button.dropdown-menu-toggle.wide{ type: "button",
-          "@click.stop.prevent" => "loadMilestones($event)" }
-          {{ milestoneToggleText }}
-          = icon("chevron-down")
-        .dropdown-menu.dropdown-menu-selectable{ "v-if" => "milestoneDropdownOpen",
-          ref: "milestoneDropdown" }
-          .dropdown-content
-            %ul
-              %li{ "v-for" => "milestone in extraMilestones" }
-                %a{ href: "#",
-                  ":class" => "{ 'is-active': milestone.id === board.milestone_id }",
-                  "@click.stop.prevent" => "selectMilestone(milestone)" }
-                  {{ milestone.title }}
-              %li.divider
-              %li{ "v-for" => "milestone in milestones" }
-                %a{ href: "#",
-                  ":class" => "{ 'is-active': milestone.id === board.milestone_id }",
-                  "@click.stop.prevent" => "selectMilestone(milestone)" }
-                  {{ milestone.title }}
-          = dropdown_loading
-        %span
-          Only show issues scheduled for the selected milestone
+      - if @project.feature_available?(:issue_board_milestone, current_user)
+        .dropdown.board-inner-milestone-dropdown{ ":class" => "{ open: milestoneDropdownOpen }",
+          "v-if" => "currentPage === 'new'" }
+          %label.label-light{ for: "board-milestone" }
+            Board milestone
+          %button.dropdown-menu-toggle.wide{ type: "button",
+            "@click.stop.prevent" => "loadMilestones($event)" }
+            {{ milestoneToggleText }}
+            = icon("chevron-down")
+          .dropdown-menu.dropdown-menu-selectable{ "v-if" => "milestoneDropdownOpen",
+            ref: "milestoneDropdown" }
+            .dropdown-content
+              %ul
+                %li{ "v-for" => "milestone in extraMilestones" }
+                  %a{ href: "#",
+                    ":class" => "{ 'is-active': milestone.id === board.milestone_id }",
+                    "@click.stop.prevent" => "selectMilestone(milestone)" }
+                    {{ milestone.title }}
+                %li.divider
+                %li{ "v-for" => "milestone in milestones" }
+                  %a{ href: "#",
+                    ":class" => "{ 'is-active': milestone.id === board.milestone_id }",
+                    "@click.stop.prevent" => "selectMilestone(milestone)" }
+                    {{ milestone.title }}
+            = dropdown_loading
+          %span
+            Only show issues scheduled for the selected milestone
       %board-milestone-select{ "v-if" => "currentPage == 'milestone'",
         ":milestone-path" => "milestonePath",
         ":select-milestone" => "selectMilestone",

changelogs/unreleased-ee/bvl-license-check-issue-board-milestone.yml

+---
+title: Add license checks for issue boards with milestones
+merge_request: 2315
+author:

lib/api/entities.rb

@@ -619,7 +619,8 @@ module API
       expose :id
       expose :name
       expose :project, using: Entities::BasicProjectDetails
-      expose :milestone
+      expose :milestone,
+             if: -> (board, _) { board.project.feature_available?(:issue_board_milestone) }
       expose :lists, using: Entities::List do |board|
         board.lists.destroyable
       end

spec/features/boards/board_with_milestone_spec.rb

@@ -10,156 +10,193 @@ describe 'Board with milestone', :feature, :js do
   before do
     project.team << [user, :master]
 
-    gitlab_sign_in(user)
+    login_as(user)
   end
 
-  context 'new board' do
+  context 'with the feature enabled' do
     before do
-      visit namespace_project_boards_path(project.namespace, project)
+      stub_licensed_features(issue_board_milestone: true)
     end
 
-    it 'creates board with milestone' do
-      create_board_with_milestone
+    context 'new board' do
+      before do
+        visit namespace_project_boards_path(project.namespace, project)
+      end
+
+      it 'creates board with milestone' do
+        create_board_with_milestone
 
-      expect(find('.tokens-container')).to have_content(milestone.title)
-      wait_for_requests
+        expect(find('.tokens-container')).to have_content(milestone.title)
+        wait_for_requests
 
-      find('.card', match: :first)
+        find('.card', match: :first)
 
-      expect(all('.board').last).to have_selector('.card', count: 1)
+        expect(all('.board').last).to have_selector('.card', count: 1)
+      end
     end
-  end
 
-  context 'update board' do
-    let!(:milestone_two) { create(:milestone, project: project) }
-    let!(:board) { create(:board, project: project, milestone: milestone) }
+    context 'update board' do
+      let!(:milestone_two) { create(:milestone, project: project) }
+      let!(:board) { create(:board, project: project, milestone: milestone) }
 
-    before do
-      visit namespace_project_boards_path(project.namespace, project)
-    end
+      before do
+        visit namespace_project_boards_path(project.namespace, project)
+      end
 
-    it 'defaults milestone filter' do
-      page.within '#js-multiple-boards-switcher' do
-        find('.dropdown-menu-toggle').click
+      it 'defaults milestone filter' do
+        page.within '#js-multiple-boards-switcher' do
+          find('.dropdown-menu-toggle').click
 
-        wait_for_requests
+          wait_for_requests
 
-        click_link board.name
-      end
+          click_link board.name
+        end
 
-      expect(find('.tokens-container')).to have_content(milestone.title)
+        expect(find('.tokens-container')).to have_content(milestone.title)
 
-      find('.card', match: :first)
+        find('.card', match: :first)
 
-      expect(all('.board').last).to have_selector('.card', count: 1)
-    end
+        expect(all('.board').last).to have_selector('.card', count: 1)
+      end
 
-    it 'sets board to any milestone' do
-      update_board_milestone('Any Milestone')
+      it 'sets board to any milestone' do
+        update_board_milestone('Any Milestone')
 
-      expect(page).not_to have_css('.js-visual-token')
-      expect(find('.tokens-container')).not_to have_content(milestone.title)
+        expect(page).not_to have_css('.js-visual-token')
+        expect(find('.tokens-container')).not_to have_content(milestone.title)
 
-      find('.card', match: :first)
+        find('.card', match: :first)
 
-      expect(page).to have_selector('.board', count: 3)
-      expect(all('.board').last).to have_selector('.card', count: 2)
-    end
+        expect(page).to have_selector('.board', count: 3)
+        expect(all('.board').last).to have_selector('.card', count: 2)
+      end
 
-    it 'sets board to upcoming milestone' do
-      update_board_milestone('Upcoming')
+      it 'sets board to upcoming milestone' do
+        update_board_milestone('Upcoming')
 
-      expect(find('.tokens-container')).not_to have_content(milestone.title)
+        expect(find('.tokens-container')).not_to have_content(milestone.title)
 
-      find('.board', match: :first)
+        find('.board', match: :first)
 
-      expect(all('.board')[1]).to have_selector('.card', count: 0)
-    end
+        expect(all('.board')[1]).to have_selector('.card', count: 0)
+      end
 
-    it 'does not allow milestone in filter to be editted' do
-      find('.filtered-search').native.send_keys(:backspace)
+      it 'does not allow milestone in filter to be editted' do
+        find('.filtered-search').native.send_keys(:backspace)
 
-      page.within('.tokens-container') do
-        expect(page).to have_selector('.value')
+        page.within('.tokens-container') do
+          expect(page).to have_selector('.value')
+        end
       end
-    end
 
-    it 'does not render milestone in hint dropdown' do
-      find('.filtered-search').click
+      it 'does not render milestone in hint dropdown' do
+        find('.filtered-search').click
 
-      page.within('#js-dropdown-hint') do
-        expect(page).not_to have_button('Milestone')
+        page.within('#js-dropdown-hint') do
+          expect(page).not_to have_button('Milestone')
+        end
       end
     end
-  end
 
-  context 'removing issue from board' do
-    let(:label) { create(:label, project: project) }
-    let!(:issue) { create(:labeled_issue, project: project, labels: [label], milestone: milestone) }
-    let!(:board) { create(:board, project: project, milestone: milestone) }
-    let!(:list) { create(:list, board: board, label: label, position: 0) }
+    context 'removing issue from board' do
+      let(:label) { create(:label, project: project) }
+      let!(:issue) { create(:labeled_issue, project: project, labels: [label], milestone: milestone) }
+      let!(:board) { create(:board, project: project, milestone: milestone) }
+      let!(:list) { create(:list, board: board, label: label, position: 0) }
 
-    before do
-      visit namespace_project_boards_path(project.namespace, project)
-    end
+      before do
+        visit namespace_project_boards_path(project.namespace, project)
+      end
 
-    it 'removes issues milestone when removing from the board' do
-      wait_for_requests
+      it 'removes issues milestone when removing from the board' do
+        wait_for_requests
 
-      first('.card .card-number').click
+        first('.card .card-number').click
 
-      click_button('Remove from board')
-      wait_for_requests
+        click_button('Remove from board')
+        wait_for_requests
 
-      expect(issue.reload.milestone).to be_nil
+        expect(issue.reload.milestone).to be_nil
+      end
     end
-  end
 
-  context 'new issues' do
-    let(:label) { create(:label, project: project) }
-    let!(:list1) { create(:list, board: board, label: label, position: 0) }
-    let!(:board) { create(:board, project: project, milestone: milestone) }
-    let!(:issue) { create(:issue, project: project) }
+    context 'new issues' do
+      let(:label) { create(:label, project: project) }
+      let!(:list1) { create(:list, board: board, label: label, position: 0) }
+      let!(:board) { create(:board, project: project, milestone: milestone) }
+      let!(:issue) { create(:issue, project: project) }
 
-    before do
-      visit namespace_project_boards_path(project.namespace, project)
-    end
+      before do
+        visit namespace_project_boards_path(project.namespace, project)
+      end
 
-    it 'creates new issue with boards milestone' do
-      wait_for_requests
+      it 'creates new issue with boards milestone' do
+        wait_for_requests
 
-      page.within(first('.board')) do
-        find('.btn-default').click
+        page.within(first('.board')) do
+          find('.btn-default').click
 
-        find('.form-control').set('testing new issue with milestone')
+          find('.form-control').set('testing new issue with milestone')
 
-        click_button('Submit issue')
+          click_button('Submit issue')
 
-        wait_for_requests
+          wait_for_requests
 
-        click_link('testing new issue with milestone')
+          click_link('testing new issue with milestone')
+        end
+
+        expect(page).to have_content(milestone.title)
       end
 
-      expect(page).to have_content(milestone.title)
+      it 'updates issue with milestone from add issues modal' do
+        wait_for_requests
+
+        click_button 'Add issues'
+
+        page.within('.add-issues-modal') do
+          card = find('.card', :first)
+          expect(page).to have_selector('.card', count: 1)
+
+          card.click
+
+          click_button 'Add 1 issue'
+        end
+
+        click_link(issue.title)
+
+        expect(page).to have_content(milestone.title)
+      end
     end
+  end
 
-    it 'updates issue with milestone from add issues modal' do
-      wait_for_requests
+  context 'with the feature disabled' do
+    before do
+      stub_licensed_features(issue_board_milestone: false)
+      visit namespace_project_boards_path(project.namespace, project)
+    end
 
-      click_button 'Add issues'
+    it "doesn't show the input when creating a board" do
+      page.within '#js-multiple-boards-switcher' do
+        find('.dropdown-menu-toggle').click
 
-      page.within('.add-issues-modal') do
-        card = find('.card', :first)
-        expect(page).to have_selector('.card', count: 1)
+        click_link 'Create new board'
 
-        card.click
+        # To make sure the form is shown
+        expect(page).to have_selector('#board-new-name')
 
-        click_button 'Add 1 issue'
+        expect(page).not_to have_button('Milestone')
       end
+    end
 
-      click_link(issue.title)
+    it "doesn't show the option to edit the milestone" do
+      page.within '#js-multiple-boards-switcher' do
+        find('.dropdown-menu-toggle').click
+
+        # To make sure the dropdown is open
+        expect(page).to have_link('Edit board name')
 
-      expect(page).to have_content(milestone.title)
+        expect(page).not_to have_link('Edit board milestone')
+      end
     end
   end
 

spec/models/board_spec.rb

@@ -12,27 +12,4 @@ describe Board do
     it { is_expected.to validate_presence_of(:name) }
     it { is_expected.to validate_presence_of(:project) }
   end
-
-  describe 'milestone' do
-    subject { described_class.new }
-
-    it 'returns Milestone::Upcoming for upcoming milestone id' do
-      subject.milestone_id = Milestone::Upcoming.id
-
-      expect(subject.milestone).to eq Milestone::Upcoming
-    end
-
-    it 'returns milestone for valid milestone id' do
-      milestone = create(:milestone)
-      subject.milestone_id = milestone.id
-
-      expect(subject.milestone).to eq milestone
-    end
-
-    it 'returns nil for invalid milestone id' do
-      subject.milestone_id = -1
-
-      expect(subject.milestone).to be_nil
-    end
-  end
 end

spec/models/ee/board_spec.rb

+require 'spec_helper'
+
+describe Board do
+  describe 'milestone' do
+    subject(:board) { build(:board) }
+
+    context 'when the feature is available' do
+      before do
+        stub_licensed_features(issue_board_milestone: true)
+      end
+
+      it 'returns Milestone::Upcoming for upcoming milestone id' do
+        board.milestone_id = Milestone::Upcoming.id
+
+        expect(board.milestone).to eq Milestone::Upcoming
+      end
+
+      it 'returns milestone for valid milestone id' do
+        milestone = create(:milestone)
+        board.milestone_id = milestone.id
+
+        expect(board.milestone).to eq milestone
+      end
+
+      it 'returns nil for invalid milestone id' do
+        board.milestone_id = -1
+
+        expect(board.milestone).to be_nil
+      end
+    end
+
+    it 'returns nil when the feature is not available' do
+      stub_licensed_features(issue_board_milestone: false)
+      milestone = create(:milestone)
+      board.milestone_id = milestone.id
+
+      expect(board.milestone).to be_nil
+    end
+  end
+end

spec/requests/api/boards_spec.rb

@@ -57,6 +57,24 @@ describe API::Boards do
         expect(response).to match_response_schema('public_api/v4/boards')
       end
     end
+
+    context 'with the issue_board_milestone-feature available' do
+      it 'returns the milestone when the `issue_board_milestone`-feature is enabled' do
+        stub_licensed_features(issue_board_milestone: true)
+
+        get api(base_url, user)
+
+        expect(json_response.first["milestone"]).not_to be_nil
+      end
+
+      it 'hides the milestone when the `issue_board_milestone`-feature is disabled' do
+        stub_licensed_features(issue_board_milestone: false)
+
+        get api(base_url, user)
+
+        expect(json_response.first["milestone"]).to be_nil
+      end
+    end
   end
 
   describe "GET /projects/:id/boards/:board_id/lists" do

spec/services/boards/update_service_spec.rb

@@ -24,5 +24,25 @@ describe Boards::UpdateService, services: true do
 
       expect(service.execute(board)).to eq false
     end
+
+    it 'udpates the milestone with issue board milestones enabled' do
+      stub_licensed_features(issue_board_milestone: true)
+      milestone = create(:milestone, project: project)
+
+      service = described_class.new(project, double, milestone_id: milestone.id)
+      service.execute(board)
+
+      expect(board.reload.milestone).to eq(milestone)
+    end
+
+    it 'udpates the milestone with the issue board milestones feature enabled' do
+      stub_licensed_features(issue_board_milestone: false)
+      milestone = create(:milestone, project: project)
+
+      service = described_class.new(project, double, milestone_id: milestone.id)
+      service.execute(board)
+
+      expect(board.reload.milestone).to be_nil
+    end
   end
 end