Separate BE roadmaps sort from epics sort

Use a separate UserPreference column to store the user-selected sorting
for roadmaps. Before we used to save it in the same column the epic list
sort used

db/schema.rb

@@ -2985,6 +2985,7 @@ ActiveRecord::Schema.define(version: 20190124200344) do
     t.integer "epic_notes_filter", limit: 2, default: 0, null: false
     t.string "issues_sort"
     t.string "merge_requests_sort"
+    t.string "roadmaps_sort"
     t.index ["user_id"], name: "index_user_preferences_on_user_id", unique: true, using: :btree
   end
 

ee/app/controllers/concerns/epics_actions.rb

@@ -11,7 +11,12 @@ module EpicsActions
   end
 
   def default_sort_order
-    sort_value_recently_created
+    default_sort_value || sort_value_recently_created
+  end
+
+  # Override this if you want your controller to have a different default sort order
+  def default_sort_value
+    nil
   end
 
   def update_cookie_value(value)

ee/app/controllers/groups/roadmap_controller.rb

@@ -20,7 +20,15 @@ module Groups
     private
 
     def issuable_sorting_field
-      :epics_sort
+      :roadmaps_sort
+    end
+
+    def default_sort_value
+      sort_value_start_date_soon
+    end
+
+    def remember_sorting_key
+      @remember_sorting_key ||= "roadmap_sort"
     end
 
     def persist_roadmap_layout

ee/db/migrate/20190123211816_add_roadmap_sort_to_user_preferences.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 AddRoadmapSortToUserPreferences < ActiveRecord::Migration[5.0]
+  include Gitlab::Database::MigrationHelpers
+
+  DOWNTIME = false
+
+  def up
+    add_column :user_preferences, :roadmaps_sort, :string, null: true
+  end
+
+  def down
+    remove_column :user_preferences, :roadmaps_sort
+  end
+end

ee/spec/controllers/groups/roadmap_controller_spec.rb

@@ -38,28 +38,36 @@ describe Groups::RoadmapController do
 
           get :show, params: { group_id: group, sort: 'start_date_asc' }
 
-          expect(cookies['epic_sort']).to eq('start_date_asc')
+          expect(cookies['roadmap_sort']).to eq('start_date_asc')
           expect(response).to have_gitlab_http_status(200)
         end
       end
 
       context 'when there is a user logged in' do
-        context 'when epics_sort is nil' do
-          it 'stores epics sorting param in user preference' do
+        context 'when roadmaps_sort is nil' do
+          it 'stores roadmaps sorting param in user preference' do
             get :show, params: { group_id: group, sort: 'start_date_asc' }
 
             expect(response).to have_gitlab_http_status(200)
-            expect(user.reload.user_preference.epics_sort).to eq('start_date_asc')
+            expect(user.reload.user_preference.roadmaps_sort).to eq('start_date_asc')
+          end
+
+          it 'defaults to sort_value_start_date_soon' do
+            user.user_preference.update(roadmaps_sort: nil)
+
+            get :show, params: { group_id: group }
+
+            expect(assigns(:sort)).to eq('start_date_asc')
           end
         end
 
-        context 'when epics_sort is present' do
-          it 'update epics_sort with current value' do
-            user.user_preference.update(epics_sort: 'created_desc')
+        context 'when roadmaps_sort is present' do
+          it 'update roadmaps_sort with current value' do
+            user.user_preference.update(roadmaps_sort: 'created_desc')
 
             get :show, params: { group_id: group, sort: 'start_date_asc' }
 
-            expect(user.reload.user_preference.epics_sort).to eq('start_date_asc')
+            expect(user.reload.user_preference.roadmaps_sort).to eq('start_date_asc')
             expect(response).to have_gitlab_http_status(200)
           end
         end

ee/spec/features/epics/epics_list_spec.rb

@@ -49,23 +49,23 @@ describe 'epics list', :js do
       page.within('.content-wrapper .content') do
         expect(find('.top-area')).to have_content('All 3')
 
-        page.within(".issuable-list") do
-          page.within("li:nth-child(1)") do
+        page.within('.issuable-list') do
+          page.within('li:nth-child(1)') do
             expect(page).to have_content(epic3.title)
           end
 
-          page.within("li:nth-child(2)") do
+          page.within('li:nth-child(2)') do
             expect(page).to have_content(epic2.title)
           end
 
-          page.within("li:nth-child(3)") do
+          page.within('li:nth-child(3)') do
             expect(page).to have_content(epic1.title)
           end
         end
       end
     end
 
-    it 'sorts by the selected value and stores the selection for epic list & roadmap' do
+    it 'sorts by the selected value and stores the selection for epic list' do
       page.within('.epics-other-filters') do
         click_button 'Created date'
         sort_options = find('ul.dropdown-menu-sort li').all('a').collect(&:text)
@@ -75,24 +75,24 @@ describe 'epics list', :js do
         expect(sort_options[2]).to eq('Start date')
         expect(sort_options[3]).to eq('Due date')
 
-        click_link 'Start date'
+        click_link 'Last updated'
       end
 
-      expect(page).to have_button('Start date')
+      expect(page).to have_button('Last updated')
 
       page.within('.content-wrapper .content') do
         expect(find('.top-area')).to have_content('All 3')
 
-        page.within(".issuable-list") do
-          page.within("li:nth-child(1)") do
+        page.within('.issuable-list') do
+          page.within('li:nth-child(1)') do
             expect(page).to have_content(epic3.title)
           end
 
-          page.within("li:nth-child(2)") do
+          page.within('li:nth-child(2)') do
             expect(page).to have_content(epic2.title)
           end
 
-          page.within("li:nth-child(3)") do
+          page.within('li:nth-child(3)') do
             expect(page).to have_content(epic1.title)
           end
         end
@@ -100,11 +100,43 @@ describe 'epics list', :js do
 
       visit group_epics_path(group)
 
-      expect(page).to have_button('Start date')
+      expect(page).to have_button('Last updated')
+    end
+
+    it 'sorts by the selected value and stores the selection for roadmap' do
+      visit group_roadmap_path(group)
+
+      page.within('.epics-other-filters') do
+        click_button 'Start date'
+        sort_options = find('ul.dropdown-menu-sort li').all('a').collect(&:text)
+
+        expect(sort_options[0]).to eq('Start date')
+        expect(sort_options[1]).to eq('Due date')
+
+        click_link 'Due date'
+      end
+
+      expect(page).to have_button('Due date')
+
+      page.within('.content-wrapper .content') do
+        page.within('.epics-list-section') do
+          page.within('div.epics-list-item:nth-child(1)') do
+            expect(page).to have_content(epic1.title)
+          end
+
+          page.within('div.epics-list-item:nth-child(2)') do
+            expect(page).to have_content(epic3.title)
+          end
+
+          page.within('div.epics-list-item:nth-child(3)') do
+            expect(page).to have_content(epic2.title)
+          end
+        end
+      end
 
       visit group_roadmap_path(group)
 
-      expect(page).to have_button('Start date')
+      expect(page).to have_button('Due date')
     end
 
     it 'renders the epic detail correctly after clicking the link' do