From 6fe5c48e96617b5a201e2ce5bb7df0e8359f9f23 Mon Sep 17 00:00:00 2001
From: Himanshu Kapoor <hkapoor@gitlab.com>
Date: Tue, 2 Jul 2024 16:43:05 +0200
Subject: [PATCH] Remove wiki sidebar limit

Remove the limit of 15 items in the wiki sidebar

Changelog: changed
---
 .../wikis/components/wiki_sidebar_entries.vue | 26 ++------
 locale/gitlab.pot                             |  3 -
 .../components/wiki_sidebar_entries_spec.js   | 66 ++++++-------------
 ...user_views_wiki_sidebar_shared_examples.rb | 13 ----
 4 files changed, 26 insertions(+), 82 deletions(-)

diff --git a/app/assets/javascripts/pages/shared/wikis/components/wiki_sidebar_entries.vue b/app/assets/javascripts/pages/shared/wikis/components/wiki_sidebar_entries.vue
index 2964d70c18b015..0a125a663cbfa4 100644
--- a/app/assets/javascripts/pages/shared/wikis/components/wiki_sidebar_entries.vue
+++ b/app/assets/javascripts/pages/shared/wikis/components/wiki_sidebar_entries.vue
@@ -4,8 +4,6 @@ import axios from '~/lib/utils/axios_utils';
 import { sidebarEntriesToTree } from '../utils';
 import WikiSidebarEntry from './wiki_sidebar_entry.vue';
 
-const SIDEBAR_LIMIT = 15;
-
 export default {
   components: {
     WikiSidebarEntry,
@@ -26,18 +24,12 @@ export default {
     };
   },
 
-  computed: {
-    countExceedsSidebarLimit() {
-      return this.totalCount > this.$options.SIDEBAR_LIMIT && !this.searchTerm;
-    },
-  },
-
   watch: {
     async searchTerm() {
       this.entries = sidebarEntriesToTree(
-        this.allEntries
-          .filter((entry) => entry.title.toLowerCase().includes(this.searchTerm.toLowerCase()))
-          .slice(0, SIDEBAR_LIMIT),
+        this.allEntries.filter((entry) =>
+          entry.title.toLowerCase().includes(this.searchTerm.toLowerCase()),
+        ),
       );
     },
   },
@@ -49,11 +41,10 @@ export default {
 
     entries = entries.filter((entry) => entry.slug !== '_sidebar');
 
-    this.entries = sidebarEntriesToTree(entries.slice(0, SIDEBAR_LIMIT));
+    this.entries = sidebarEntriesToTree(entries);
     this.totalCount = entries.length;
     this.allEntries = entries;
   },
-  SIDEBAR_LIMIT,
 };
 </script>
 <template>
@@ -73,21 +64,14 @@ export default {
       :page="entry"
       :search-term="searchTerm"
     />
-    <div v-if="countExceedsSidebarLimit" class="gl-text-secondary gl-mt-3 gl-ml-3 gl-inline-block">
-      {{ sprintf(s__('Wiki|+ %{count} more'), { count: totalCount - $options.SIDEBAR_LIMIT }) }}
-      <span class="gl-px-2">&middot;</span>
-    </div>
     <gl-button
       v-if="totalCount"
       category="tertiary"
       size="small"
       variant="link"
       data-testid="view-all-pages-button"
+      class="gl-ml-3 gl-mt-3"
       :href="viewAllPagesPath"
-      :class="{
-        'gl-ml-3 gl-mt-3': !countExceedsSidebarLimit,
-        'gl-mt-n1 gl-inline-block': countExceedsSidebarLimit,
-      }"
     >
       {{ s__('Wiki|View all pages') }}
     </gl-button>
diff --git a/locale/gitlab.pot b/locale/gitlab.pot
index 08bd73ae78cb85..166736bb29cec0 100644
--- a/locale/gitlab.pot
+++ b/locale/gitlab.pot
@@ -59908,9 +59908,6 @@ msgstr ""
 msgid "WikiPage|Write your content or drag files here…"
 msgstr ""
 
-msgid "Wiki|+ %{count} more"
-msgstr ""
-
 msgid "Wiki|Add custom sidebar"
 msgstr ""
 
diff --git a/spec/frontend/pages/shared/wikis/components/wiki_sidebar_entries_spec.js b/spec/frontend/pages/shared/wikis/components/wiki_sidebar_entries_spec.js
index 60e1bd783c8401..3740ba2c46d45d 100644
--- a/spec/frontend/pages/shared/wikis/components/wiki_sidebar_entries_spec.js
+++ b/spec/frontend/pages/shared/wikis/components/wiki_sidebar_entries_spec.js
@@ -9,18 +9,12 @@ import WikiSidebarEntry from '~/pages/shared/wikis/components/wiki_sidebar_entry
 
 const MOCK_SIDEBAR_PAGES_API = 'sidebar/pages/api';
 const MOCK_VIEW_ALL_PAGES_PATH = 'view/all/pages';
-const MOCK_ENTRIES_LESS_THAN_LIMIT = [
-  { title: '_sidebar', slug: '_sidebar', path: 'path/to/_sidebar' },
-  { title: 'Page 1', slug: 'page-1', path: 'path/to/page-1' },
-  { title: 'Page 2', slug: 'page-2', path: 'path/to/page-2' },
-  { title: 'Page 2.1', slug: 'page-2/page-1', path: 'path/to/page-2/page-1' },
-  { title: 'Page 3', slug: 'page-3', path: 'path/to/page-3' },
-];
 
-const MOCK_ENTRIES_MORE_THAN_LIMIT = [
+const MOCK_ENTRIES = [
   { title: '_sidebar', slug: '_sidebar', path: 'path/to/_sidebar' },
   { title: 'Page 1', slug: 'page-1', path: 'path/to/page-1' },
   { title: 'Page 2', slug: 'page-2', path: 'path/to/page-2' },
+  { title: 'Page 2/3', slug: 'page-2/3', path: 'path/to/page-2/3' },
   { title: 'Page 3', slug: 'page-3', path: 'path/to/page-3' },
   { title: 'Page 4', slug: 'page-4', path: 'path/to/page-4' },
   { title: 'Page 5', slug: 'page-5', path: 'path/to/page-5' },
@@ -74,7 +68,7 @@ describe('pages/shared/wikis/components/wiki_sidebar_entry', () => {
 
   describe('loading state', () => {
     beforeEach(() => {
-      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES_LESS_THAN_LIMIT);
+      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES);
       buildWrapper();
     });
 
@@ -114,9 +108,9 @@ describe('pages/shared/wikis/components/wiki_sidebar_entry', () => {
     });
   });
 
-  describe('when the page count is less than the limit', () => {
+  describe('displaying a list of all pages', () => {
     beforeEach(() => {
-      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES_LESS_THAN_LIMIT);
+      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES);
       buildWrapper();
 
       return waitForPromises();
@@ -130,15 +124,24 @@ describe('pages/shared/wikis/components/wiki_sidebar_entry', () => {
           path: 'path/to/page-2',
           title: 'Page 2',
           children: [
-            {
-              slug: 'page-2/page-1',
-              path: 'path/to/page-2/page-1',
-              title: 'Page 2.1',
-              children: [],
-            },
+            { slug: 'page-2/3', path: 'path/to/page-2/3', title: 'Page 2/3', children: [] },
           ],
         },
         { slug: 'page-3', path: 'path/to/page-3', title: 'Page 3', children: [] },
+        { slug: 'page-4', path: 'path/to/page-4', title: 'Page 4', children: [] },
+        { slug: 'page-5', path: 'path/to/page-5', title: 'Page 5', children: [] },
+        { slug: 'page-6', path: 'path/to/page-6', title: 'Page 6', children: [] },
+        { slug: 'page-7', path: 'path/to/page-7', title: 'Page 7', children: [] },
+        { slug: 'page-8', path: 'path/to/page-8', title: 'Page 8', children: [] },
+        { slug: 'page-9', path: 'path/to/page-9', title: 'Page 9', children: [] },
+        { slug: 'page-10', path: 'path/to/page-10', title: 'Page 10', children: [] },
+        { slug: 'page-11', path: 'path/to/page-11', title: 'Page 11', children: [] },
+        { slug: 'page-12', path: 'path/to/page-12', title: 'Page 12', children: [] },
+        { slug: 'page-13', path: 'path/to/page-13', title: 'Page 13', children: [] },
+        { slug: 'page-14', path: 'path/to/page-14', title: 'Page 14', children: [] },
+        { slug: 'page-15', path: 'path/to/page-15', title: 'Page 15', children: [] },
+        { slug: 'page-16', path: 'path/to/page-16', title: 'Page 16', children: [] },
+        { slug: 'page-17', path: 'path/to/page-17', title: 'Page 17', children: [] },
       ]);
     });
 
@@ -152,32 +155,9 @@ describe('pages/shared/wikis/components/wiki_sidebar_entry', () => {
     });
   });
 
-  describe('when the page count is more than limit', () => {
-    beforeEach(() => {
-      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES_MORE_THAN_LIMIT);
-      buildWrapper();
-
-      return waitForPromises();
-    });
-
-    it('lists the first 15 entries except _sidebar', () => {
-      expect(findAndMapEntriesToPages()).toMatchObject(MOCK_ENTRIES_MORE_THAN_LIMIT.slice(1, 16));
-    });
-
-    it('displays + X more text', () => {
-      // 17 - 15 = 2
-      expect(wrapper.text()).toContain('+ 2 more');
-    });
-
-    it('has a "View all pages" button', () => {
-      expect(findViewAllPagesButton().exists()).toBe(true);
-      expect(findViewAllPagesButton().attributes('href')).toBe(MOCK_VIEW_ALL_PAGES_PATH);
-    });
-  });
-
   describe('when searching for pages', () => {
     beforeEach(async () => {
-      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES_MORE_THAN_LIMIT);
+      mock.onGet(MOCK_SIDEBAR_PAGES_API).reply(HTTP_STATUS_OK, MOCK_ENTRIES);
       buildWrapper();
 
       await waitForPromises();
@@ -199,10 +179,6 @@ describe('pages/shared/wikis/components/wiki_sidebar_entry', () => {
       ]);
     });
 
-    it('does not display + X more text', () => {
-      expect(wrapper.text()).not.toMatch(/\+ \d+ more/);
-    });
-
     it('has a "View all pages" button', () => {
       expect(findViewAllPagesButton().exists()).toBe(true);
       expect(findViewAllPagesButton().attributes('href')).toBe(MOCK_VIEW_ALL_PAGES_PATH);
diff --git a/spec/support/shared_examples/features/wiki/user_views_wiki_sidebar_shared_examples.rb b/spec/support/shared_examples/features/wiki/user_views_wiki_sidebar_shared_examples.rb
index 8ae6b60ca7b110..236ce16974a6a4 100644
--- a/spec/support/shared_examples/features/wiki/user_views_wiki_sidebar_shared_examples.rb
+++ b/spec/support/shared_examples/features/wiki/user_views_wiki_sidebar_shared_examples.rb
@@ -130,18 +130,5 @@
         expect(wiki_new_page_link).to eq "#{wiki_link}/%7Bnew_page_title%7D"
       end
     end
-
-    context 'when there are more than 15 existing pages' do
-      before do
-        create(:wiki_page, wiki: wiki, title: 'my page 16')
-      end
-
-      it 'shows the first 15 pages in the sidebar' do
-        visit wiki_path(wiki)
-
-        expect(page).to have_text('my page', count: 15)
-        expect(page).to have_link('View all pages')
-      end
-    end
   end
 end
-- 
GitLab