Merge branch '294043-add-an-epics-board-index-page' into 'master'

[RUN-AS-IF-FOSS] Epic Boards index page

See merge request gitlab-org/gitlab!53100

app/controllers/concerns/boards_actions.rb

@@ -34,16 +34,26 @@ module BoardsActions
 
   def boards
     strong_memoize(:boards) do
-      Boards::ListService.new(parent, current_user).execute
+      existing_boards = boards_finder.execute
+      if existing_boards.any?
+        existing_boards
+      else
+        # if no board exists, create one
+        [board_create_service.execute.payload]
+      end
     end
   end
 
   def board
     strong_memoize(:board) do
-      boards.find(params[:id])
+      board_finder.execute.first
     end
   end
 
+  def board_type
+    board_klass.to_type
+  end
+
   def serializer
     BoardSerializer.new(current_user: current_user)
   end

app/controllers/concerns/multiple_boards_actions.rb

@@ -65,6 +65,7 @@ module MultipleBoardsActions
   private
 
   def redirect_to_recent_board
+    return unless board_type == Board.to_type
     return if request.format.json? || !parent.multiple_issue_boards_available? || !latest_visited_board
 
     redirect_to board_path(latest_visited_board.board)

app/controllers/groups/boards_controller.rb

@@ -3,6 +3,7 @@
 class Groups::BoardsController < Groups::ApplicationController
   include BoardsActions
   include RecordUserLastActivity
+  include Gitlab::Utils::StrongMemoize
 
   before_action :authorize_read_board!, only: [:index, :show]
   before_action :assign_endpoint_vars
@@ -14,6 +15,28 @@ class Groups::BoardsController < Groups::ApplicationController
 
   private
 
+  def board_klass
+    Board
+  end
+
+  def boards_finder
+    strong_memoize :boards_finder do
+      Boards::ListService.new(parent, current_user)
+    end
+  end
+
+  def board_finder
+    strong_memoize :board_finder do
+      Boards::ListService.new(parent, current_user, board_id: params[:id])
+    end
+  end
+
+  def board_create_service
+    strong_memoize :board_create_service do
+      Boards::CreateService.new(parent, current_user)
+    end
+  end
+
   def assign_endpoint_vars
     @boards_endpoint = group_boards_path(group)
     @namespace_path = group.to_param

app/controllers/projects/boards_controller.rb

@@ -15,6 +15,28 @@ class Projects::BoardsController < Projects::ApplicationController
 
   private
 
+  def board_klass
+    Board
+  end
+
+  def boards_finder
+    strong_memoize :boards_finder do
+      Boards::ListService.new(parent, current_user)
+    end
+  end
+
+  def board_finder
+    strong_memoize :board_finder do
+      Boards::ListService.new(parent, current_user, board_id: params[:id])
+    end
+  end
+
+  def board_create_service
+    strong_memoize :board_create_service do
+      Boards::CreateService.new(parent, current_user)
+    end
+  end
+
   def assign_endpoint_vars
     @boards_endpoint = project_boards_path(project)
     @bulk_issues_path = bulk_update_project_issues_path(project)

app/graphql/resolvers/board_resolver.rb

@@ -13,7 +13,7 @@ module Resolvers
     def resolve(id: nil)
       return unless parent
 
-      ::Boards::ListService.new(parent, context[:current_user], board_id: extract_board_id(id)).execute(create_default_board: false).first
+      ::Boards::ListService.new(parent, context[:current_user], board_id: extract_board_id(id)).execute.first
     rescue ActiveRecord::RecordNotFound
       nil
     end

app/graphql/resolvers/boards_resolver.rb

@@ -16,7 +16,7 @@ module Resolvers
 
       return Board.none unless parent
 
-      ::Boards::ListService.new(parent, context[:current_user], board_id: extract_board_id(id)).execute(create_default_board: false)
+      ::Boards::ListService.new(parent, context[:current_user], board_id: extract_board_id(id)).execute
     rescue ActiveRecord::RecordNotFound
       Board.none
     end

app/helpers/boards_helper.rb

@@ -21,7 +21,8 @@ module BoardsHelper
       group_id: @group&.id,
       labels_filter_base_path: build_issue_link_base,
       labels_fetch_path: labels_fetch_path,
-      labels_manage_path: labels_manage_path
+      labels_manage_path: labels_manage_path,
+      board_type: board.to_type
     }
   end
 

app/models/board.rb

@@ -44,6 +44,14 @@ class Board < ApplicationRecord
   def scoped?
     false
   end
+
+  def self.to_type
+    name.demodulize
+  end
+
+  def to_type
+    self.class.to_type
+  end
 end
 
 Board.prepend_if_ee('EE::Board')

app/services/boards/list_service.rb

@@ -2,9 +2,7 @@
 
 module Boards
   class ListService < Boards::BaseService
-    def execute(create_default_board: true)
-      create_board! if create_default_board && parent.boards.empty?
-
+    def execute
       find_boards
     end
 
@@ -18,10 +16,6 @@ module Boards
       parent.boards.first_board
     end
 
-    def create_board!
-      Boards::CreateService.new(parent, current_user).execute
-    end
-
     def find_boards
       found =
         if parent.multiple_issue_boards_available?

app/services/boards/visits/create_service.rb

@@ -5,6 +5,7 @@ module Boards
     class CreateService < Boards::BaseService
       def execute(board)
         return unless current_user && Gitlab::Database.read_write?
+        return unless board.is_a?(Board) # other board types do not support board visits yet
 
         if parent.is_a?(Group)
           BoardGroupRecentVisit.visited!(current_user, board)

app/views/shared/boards/_show.html.haml

@@ -6,7 +6,10 @@
 - @no_breadcrumb_container = true
 - @no_container = true
 - @content_class = "issue-boards-content js-focus-mode-board"
-- breadcrumb_title _("Issue Boards")
+- if board.to_type == "EpicBoard"
+  - breadcrumb_title _("Epic Boards")
+- else
+  - breadcrumb_title _("Issue Boards")
 - page_title("#{board.name}", _("Boards"))
 - add_page_specific_style 'page_bundles/boards'
 

ee/app/assets/javascripts/epic_boards/index.js

+// This is a true violation of @gitlab/no-runtime-template-compiler, as it
+// relies on app/views/shared/boards/_show.html.haml for its
+// template.
+/* eslint-disable @gitlab/no-runtime-template-compiler */
+import Vue from 'vue';
+import VueApollo from 'vue-apollo';
+import { mapActions } from 'vuex';
+
+import BoardSidebar from 'ee_component/boards/components/board_sidebar';
+import toggleLabels from 'ee_component/boards/toggle_labels';
+
+import BoardContent from '~/boards/components/board_content.vue';
+import createDefaultClient from '~/lib/graphql';
+
+import store from '~/boards/stores';
+import '~/boards/filters/due_date_filters';
+import BoardAddIssuesModal from '~/boards/components/modal/index.vue';
+import { NavigationType, parseBoolean } from '~/lib/utils/common_utils';
+import mountMultipleBoardsSwitcher from '~/boards/mount_multiple_boards_switcher';
+
+Vue.use(VueApollo);
+
+const apolloProvider = new VueApollo({
+  defaultClient: createDefaultClient(),
+});
+
+export default () => {
+  const $boardApp = document.getElementById('board-app');
+
+  // check for browser back and trigger a hard reload to circumvent browser caching.
+  window.addEventListener('pageshow', (event) => {
+    const isNavTypeBackForward =
+      window.performance && window.performance.navigation.type === NavigationType.TYPE_BACK_FORWARD;
+
+    if (event.persisted || isNavTypeBackForward) {
+      window.location.reload();
+    }
+  });
+
+  // eslint-disable-next-line no-new
+  new Vue({
+    el: $boardApp,
+    components: {
+      BoardContent,
+      BoardSidebar,
+      BoardAddIssuesModal,
+      BoardSettingsSidebar: () => import('~/boards/components/board_settings_sidebar.vue'),
+    },
+    provide: {
+      boardId: $boardApp.dataset.boardId,
+      groupId: parseInt($boardApp.dataset.groupId, 10),
+      rootPath: $boardApp.dataset.rootPath,
+      currentUserId: gon.current_user_id || null,
+      canUpdate: $boardApp.dataset.canUpdate,
+      labelsFetchPath: $boardApp.dataset.labelsFetchPath,
+      labelsManagePath: $boardApp.dataset.labelsManagePath,
+      labelsFilterBasePath: $boardApp.dataset.labelsFilterBasePath,
+      timeTrackingLimitToHours: parseBoolean($boardApp.dataset.timeTrackingLimitToHours),
+      weightFeatureAvailable: parseBoolean($boardApp.dataset.weightFeatureAvailable),
+      boardWeight: $boardApp.dataset.boardWeight
+        ? parseInt($boardApp.dataset.boardWeight, 10)
+        : null,
+      scopedLabelsAvailable: parseBoolean($boardApp.dataset.scopedLabels),
+    },
+    store,
+    apolloProvider,
+    data() {
+      return {
+        state: {},
+        loading: 0,
+        boardsEndpoint: $boardApp.dataset.boardsEndpoint,
+        recentBoardsEndpoint: $boardApp.dataset.recentBoardsEndpoint,
+        listsEndpoint: $boardApp.dataset.listsEndpoint,
+        disabled: parseBoolean($boardApp.dataset.disabled),
+        bulkUpdatePath: $boardApp.dataset.bulkUpdatePath,
+        parent: $boardApp.dataset.parent,
+        detailIssueVisible: false,
+      };
+    },
+    created() {
+      this.setInitialBoardData({
+        boardId: $boardApp.dataset.boardId,
+        fullPath: $boardApp.dataset.fullPath,
+        boardType: this.parent,
+        disabled: this.disabled,
+        boardConfig: {
+          milestoneId: parseInt($boardApp.dataset.boardMilestoneId, 10),
+          milestoneTitle: $boardApp.dataset.boardMilestoneTitle || '',
+          iterationId: parseInt($boardApp.dataset.boardIterationId, 10),
+          iterationTitle: $boardApp.dataset.boardIterationTitle || '',
+          assigneeId: $boardApp.dataset.boardAssigneeId,
+          assigneeUsername: $boardApp.dataset.boardAssigneeUsername,
+          labels: $boardApp.dataset.labels ? JSON.parse($boardApp.dataset.labels) : [],
+          labelIds: $boardApp.dataset.labelIds ? JSON.parse($boardApp.dataset.labelIds) : [],
+          weight: $boardApp.dataset.boardWeight
+            ? parseInt($boardApp.dataset.boardWeight, 10)
+            : null,
+        },
+      });
+    },
+    methods: {
+      ...mapActions(['setInitialBoardData']),
+      getNodes(data) {
+        return data[this.parent]?.board?.lists.nodes;
+      },
+    },
+  });
+
+  toggleLabels();
+
+  mountMultipleBoardsSwitcher({
+    fullPath: $boardApp.dataset.fullPath,
+    rootPath: $boardApp.dataset.boardsEndpoint,
+  });
+};

ee/app/assets/javascripts/pages/groups/epic_boards/index.js

+import initEpicBoards from 'ee/epic_boards';
+import UsersSelect from '~/users_select';
+import ShortcutsNavigation from '~/behaviors/shortcuts/shortcuts_navigation';
+
+new UsersSelect(); // eslint-disable-line no-new
+new ShortcutsNavigation(); // eslint-disable-line no-new
+initEpicBoards();

ee/app/controllers/groups/epic_boards_controller.rb

 # frozen_string_literal: true
-class Groups::EpicBoardsController < Groups::BoardsController
+class Groups::EpicBoardsController < Groups::ApplicationController
   include BoardsActions
+  include RecordUserLastActivity
+  include Gitlab::Utils::StrongMemoize
+  extend ::Gitlab::Utils::Override
 
   before_action :authorize_read_board!, only: [:index]
+  before_action :assign_endpoint_vars
+
+  feature_category :boards
+
+  private
+
+  def board_klass
+    ::Boards::EpicBoard
+  end
+
+  def boards_finder
+    strong_memoize :boards_finder do
+      ::Boards::EpicBoardsFinder.new(parent)
+    end
+  end
+
+  def board_finder
+    strong_memoize :board_finder do
+      ::Boards::EpicBoardsFinder.new(parent, id: params[:id])
+    end
+  end
+
+  def board_create_service
+    strong_memoize :board_create_service do
+      ::Boards::EpicBoards::CreateService.new(parent, current_user)
+    end
+  end
+
+  override :respond_with
+  def respond_with(resource)
+    # no JSON for epic boards
+    respond_to do |format|
+      format.html
+    end
+  end
+
+  def assign_endpoint_vars
+    @boards_endpoint = group_epic_boards_path(group)
+    @namespace_path = group.to_param
+    @labels_endpoint = group_labels_path(group)
+  end
 
   def authorize_read_board!
     access_denied! unless Feature.enabled?(:epic_boards, group) && can?(current_user, :read_epic_board, group)

ee/app/models/boards/epic_board.rb

@@ -14,5 +14,61 @@ module Boards
     def lists
       epic_lists
     end
+
+    def self.to_type
+      name.demodulize
+    end
+
+    def to_type
+      self.class.to_type
+    end
+
+    def resource_parent
+      group
+    end
+
+    def group_board?
+      true
+    end
+
+    def scoped?
+      false
+    end
+
+    def milestone_id
+      nil
+    end
+
+    def milestone
+      nil
+    end
+
+    def iteration_id
+      nil
+    end
+
+    def iteration
+      nil
+    end
+
+    def assignee_id
+      nil
+    end
+
+    def assignee
+      nil
+    end
+
+    def label_ids
+      []
+    end
+
+    def labels
+      []
+    end
+
+    def weight
+      nil
+    end
   end
 end

ee/app/views/groups/epic_boards/index.html.haml

+= render "shared/boards/show", board: @boards.first

ee/spec/controllers/groups/epic_boards_controller_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Groups::EpicBoardsController do
+  let(:group) { create(:group) }
+  let(:user) { create(:user) }
+
+  before do
+    group.add_maintainer(user)
+    sign_in(user)
+  end
+
+  describe 'GET index' do
+    it 'creates a new board when group does not have one' do
+      expect { list_boards }.to change(group.epic_boards, :count).by(1)
+    end
+
+    context 'with unauthorized user' do
+      let(:other_user) { create(:user) }
+
+      before do
+        sign_in(other_user)
+      end
+
+      it 'returns a not found 404 response' do
+        list_boards
+
+        expect(response).to have_gitlab_http_status(:not_found)
+      end
+    end
+
+    context 'json request' do
+      it 'is not supported' do
+        list_boards(format: :json)
+
+        expect(response).to have_gitlab_http_status(:not_found)
+      end
+    end
+
+    it_behaves_like 'pushes wip limits to frontend' do
+      let(:params) { { group_id: group } }
+      let(:parent) { group }
+    end
+
+    def list_boards(format: :html)
+      get :index, params: { group_id: group }, format: format
+    end
+  end
+end

locale/gitlab.pot

@@ -11523,6 +11523,9 @@ msgstr ""
 msgid "Epic"
 msgstr ""
 
+msgid "Epic Boards"
+msgstr ""
+
 msgid "Epic cannot be found."
 msgstr ""
 

spec/support/shared_examples/services/boards/boards_list_service_shared_examples.rb

 # frozen_string_literal: true
 
 RSpec.shared_examples 'boards list service' do
-  context 'when parent does not have a board' do
-    it 'creates a new parent board' do
-      expect { service.execute }.to change(parent.boards, :count).by(1)
-    end
-
-    it 'delegates the parent board creation to Boards::CreateService' do
-      expect_any_instance_of(Boards::CreateService).to receive(:execute).once
-
-      service.execute
-    end
-
-    context 'when create_default_board is false' do
-      it 'does not create a new parent board' do
-        expect { service.execute(create_default_board: false) }.not_to change(parent.boards, :count)
-      end
-    end
-  end
-
-  context 'when parent has a board' do
-    before do
-      create(:board, resource_parent: parent)
-    end
-
-    it 'does not create a new board' do
-      expect { service.execute }.not_to change(parent.boards, :count)
-    end
+  it 'does not create a new board' do
+    expect { service.execute }.not_to change(parent.boards, :count)
   end
 
   it 'returns parent boards' do