Clean up jira issues list root spec

ee/spec/frontend/integrations/jira/issues_list/components/__snapshots__/jira_issues_list_root_spec.js.snap

+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`JiraIssuesListRoot renders issuable-list component with correct props 1`] = `
+Object {
+  "currentPage": 1,
+  "currentTab": "opened",
+  "defaultPageSize": 2,
+  "enableLabelPermalinks": true,
+  "initialFilterValue": Array [
+    Object {
+      "type": "filtered-search-term",
+      "value": Object {
+        "data": "foo",
+      },
+    },
+  ],
+  "initialSortBy": "created_desc",
+  "isManualOrdering": false,
+  "issuableSymbol": "#",
+  "issuables": Array [],
+  "issuablesLoading": false,
+  "labelFilterParam": "labels",
+  "namespace": "gitlab-org/gitlab-test",
+  "nextPage": 2,
+  "previousPage": 0,
+  "recentSearchesStorageKey": "jira_issues",
+  "searchInputPlaceholder": "Search Jira issues",
+  "searchTokens": Array [],
+  "showBulkEditSidebar": false,
+  "showPaginationControls": false,
+  "sortOptions": Array [
+    Object {
+      "id": 1,
+      "sortDirection": Object {
+        "ascending": "created_asc",
+        "descending": "created_desc",
+      },
+      "title": "Created date",
+    },
+    Object {
+      "id": 2,
+      "sortDirection": Object {
+        "ascending": "updated_asc",
+        "descending": "updated_desc",
+      },
+      "title": "Last updated",
+    },
+  ],
+  "tabCounts": null,
+  "tabs": Array [
+    Object {
+      "id": "state-opened",
+      "name": "opened",
+      "title": "Open",
+      "titleTooltip": "Filter by issues that are currently opened.",
+    },
+    Object {
+      "id": "state-closed",
+      "name": "closed",
+      "title": "Closed",
+      "titleTooltip": "Filter by issues that are currently closed.",
+    },
+    Object {
+      "id": "state-all",
+      "name": "all",
+      "title": "All",
+      "titleTooltip": "Show all issues.",
+    },
+  ],
+  "totalItems": 0,
+  "urlParams": Object {
+    "labels[]": undefined,
+    "page": 1,
+    "search": "foo",
+    "sort": "created_desc",
+    "state": "opened",
+  },
+}
+`;

ee/spec/frontend/integrations/jira/issues_list/components/jira_issues_list_root_spec.js

@@ -2,13 +2,12 @@ import { shallowMount } from '@vue/test-utils';
 import MockAdapter from 'axios-mock-adapter';
 
 import JiraIssuesListRoot from 'ee/integrations/jira/issues_list/components/jira_issues_list_root.vue';
-import { stubComponent } from 'helpers/stub_component';
-
+import waitForPromises from 'helpers/wait_for_promises';
 import createFlash from '~/flash';
 import IssuableList from '~/issuable_list/components/issuable_list_root.vue';
-import { IssuableStates, IssuableListTabs, AvailableSortOptions } from '~/issuable_list/constants';
 import axios from '~/lib/utils/axios_utils';
 import { convertObjectPropsToCamelCase } from '~/lib/utils/common_utils';
+import httpStatus from '~/lib/utils/http_status';
 
 import { mockProvide, mockJiraIssues } from '../mock_data';
 
@@ -20,31 +19,31 @@ jest.mock('~/issuable_list/constants', () => ({
   AvailableSortOptions: jest.requireActual('~/issuable_list/constants').AvailableSortOptions,
 }));
 
-const createComponent = ({ provide = mockProvide, initialFilterParams = {} } = {}) =>
-  shallowMount(JiraIssuesListRoot, {
-    propsData: {
-      initialFilterParams,
-    },
-    provide,
-    stubs: {
-      IssuableList: stubComponent(IssuableList),
-    },
-  });
-
-describe('JiraIssuesListRoot', () => {
-  const resolvedValue = {
+const resolvedValue = {
   headers: {
     'x-page': 1,
     'x-total': 3,
   },
   data: mockJiraIssues,
-  };
+};
+
+describe('JiraIssuesListRoot', () => {
   let wrapper;
   let mock;
 
+  const findIssuableList = () => wrapper.find(IssuableList);
+
+  const createComponent = ({ provide = mockProvide, initialFilterParams = {} } = {}) => {
+    wrapper = shallowMount(JiraIssuesListRoot, {
+      propsData: {
+        initialFilterParams,
+      },
+      provide,
+    });
+  };
+
   beforeEach(() => {
     mock = new MockAdapter(axios);
-    wrapper = createComponent();
   });
 
   afterEach(() => {
@@ -52,62 +51,20 @@ describe('JiraIssuesListRoot', () => {
     mock.restore();
   });
 
-  describe('computed', () => {
-    describe('showPaginationControls', () => {
-      it.each`
-        issuesListLoading | issuesListLoadFailed | issues            | totalIssues              | returnValue
-        ${true}           | ${false}             | ${[]}             | ${0}                     | ${false}
-        ${false}          | ${true}              | ${[]}             | ${0}                     | ${false}
-        ${false}          | ${false}             | ${mockJiraIssues} | ${mockJiraIssues.length} | ${true}
-      `(
-        'returns $returnValue when issuesListLoading is $issuesListLoading, issuesListLoadFailed is $issuesListLoadFailed, issues is $issues and totalIssues is $totalIssues',
-        ({ issuesListLoading, issuesListLoadFailed, issues, totalIssues, returnValue }) => {
-          wrapper.setData({
-            issuesListLoading,
-            issuesListLoadFailed,
-            issues,
-            totalIssues,
-          });
+  describe('on mount', () => {
+    describe('while loading', () => {
+      it('sets issuesListLoading to `true`', () => {
+        jest.spyOn(axios, 'get').mockResolvedValue(new Promise(() => {}));
 
-          expect(wrapper.vm.showPaginationControls).toBe(returnValue);
-        },
-      );
-    });
-
-    describe('urlParams', () => {
-      it('returns object containing `state`, `page`, `sort` and `search` properties', () => {
-        wrapper.setData({
-          currentState: 'closed',
-          currentPage: 2,
-          sortedBy: 'created_asc',
-          filterParams: {
-            search: 'foo',
-          },
-        });
-
-        expect(wrapper.vm.urlParams).toMatchObject({
-          state: 'closed',
-          page: 2,
-          sort: 'created_asc',
-          search: 'foo',
-        });
-      });
-    });
-  });
-
-  describe('methods', () => {
-    describe('fetchIssues', () => {
-      it('sets issuesListLoading to true and issuesListLoadFailed to false', () => {
-        wrapper.vm.fetchIssues();
+        createComponent();
 
-        expect(wrapper.vm.issuesListLoading).toBe(true);
-        expect(wrapper.vm.issuesListLoadFailed).toBe(false);
+        const issuableList = findIssuableList();
+        expect(issuableList.props('issuablesLoading')).toBe(true);
       });
 
       it('calls `axios.get` with `issuesFetchPath` and query params', () => {
-        jest.spyOn(axios, 'get').mockResolvedValue(resolvedValue);
-
-        wrapper.vm.fetchIssues();
+        jest.spyOn(axios, 'get');
+        createComponent();
 
         expect(axios.get).toHaveBeenCalledWith(
           mockProvide.issuesFetchPath,
@@ -123,17 +80,28 @@ describe('JiraIssuesListRoot', () => {
           }),
         );
       });
+    });
 
-      it('sets `currentPage` and `totalIssues` from response headers and `issues` & `issuesCount` from response body when request is successful', async () => {
+    describe('when request succeeds', () => {
+      beforeEach(async () => {
         jest.spyOn(axios, 'get').mockResolvedValue(resolvedValue);
 
-        await wrapper.vm.fetchIssues();
+        createComponent();
+        await waitForPromises();
+      });
 
-        const firstIssue = convertObjectPropsToCamelCase(mockJiraIssues[0], { deep: true });
+      it('sets `currentPage` and `totalIssues` from response headers and `issues` & `issuesCount` from response body when request is successful', async () => {
+        const issuableList = findIssuableList();
+        const issuablesProp = issuableList.props('issuables');
+
+        expect(issuableList.props('currentPage')).toBe(resolvedValue.headers['x-page']);
+        expect(issuableList.props('previousPage')).toBe(resolvedValue.headers['x-page'] - 1);
+        expect(issuableList.props('nextPage')).toBe(resolvedValue.headers['x-page'] + 1);
+        expect(issuableList.props('totalItems')).toBe(resolvedValue.headers['x-total']);
+        expect(issuablesProp).toHaveLength(mockJiraIssues.length);
 
-        expect(wrapper.vm.currentPage).toBe(resolvedValue.headers['x-page']);
-        expect(wrapper.vm.totalIssues).toBe(resolvedValue.headers['x-total']);
-        expect(wrapper.vm.issues[0]).toEqual({
+        const firstIssue = convertObjectPropsToCamelCase(mockJiraIssues[0], { deep: true });
+        expect(issuablesProp[0]).toEqual({
           ...firstIssue,
           id: 31596,
           author: {
@@ -141,127 +109,179 @@ describe('JiraIssuesListRoot', () => {
             id: 0,
           },
         });
-        expect(wrapper.vm.issuesCount[IssuableStates.Opened]).toBe(3);
       });
 
-      it('sets `issuesListLoadFailed` to true and calls `createFlash` when request fails', async () => {
-        jest.spyOn(axios, 'get').mockRejectedValue({});
+      it('sets issuesListLoading to `false`', () => {
+        const issuableList = findIssuableList();
+        expect(issuableList.props('issuablesLoading')).toBe(false);
+      });
+    });
+
+    describe('when request fails', () => {
+      it.each`
+        APIErrorMessage | expectedRenderedErrorMessage
+        ${'API error'}  | ${'API error'}
+        ${undefined}    | ${'An error occurred while loading issues'}
+      `(
+        'calls `createFlash` with "$expectedRenderedErrorMessage" when API responds with "$APIErrorMessage"',
+        async ({ APIErrorMessage, expectedRenderedErrorMessage }) => {
+          jest.spyOn(axios, 'get');
+          mock
+            .onGet(mockProvide.issuesFetchPath)
+            .replyOnce(httpStatus.INTERNAL_SERVER_ERROR, { errors: [APIErrorMessage] });
 
-        await wrapper.vm.fetchIssues();
+          createComponent();
+
+          await waitForPromises();
 
-        expect(wrapper.vm.issuesListLoadFailed).toBe(true);
           expect(createFlash).toHaveBeenCalledWith({
-          message: 'An error occurred while loading issues',
+            message: expectedRenderedErrorMessage,
             captureError: true,
             error: expect.any(Object),
           });
+        },
+      );
+    });
   });
 
-      it('sets `issuesListLoading` to false when request completes', async () => {
-        jest.spyOn(axios, 'get').mockRejectedValue({});
+  it('renders issuable-list component with correct props', async () => {
+    createComponent({ initialFilterParams: { search: 'foo' } });
 
-        await wrapper.vm.fetchIssues();
+    await waitForPromises();
 
-        expect(wrapper.vm.issuesListLoading).toBe(false);
+    const issuableList = findIssuableList();
+    expect(issuableList.exists()).toBe(true);
+    expect(issuableList.props()).toMatchSnapshot();
   });
+
+  describe('issuable-list events', () => {
+    beforeEach(async () => {
+      jest.spyOn(axios, 'get');
+      createComponent();
+      await waitForPromises();
     });
 
-    describe('fetchIssuesBy', () => {
-      it('sets provided prop value for given prop name and calls `fetchIssues`', () => {
-        jest.spyOn(wrapper.vm, 'fetchIssues');
+    it('"click-tab" event executes GET request correctly', async () => {
+      const issuableList = findIssuableList();
 
-        wrapper.vm.fetchIssuesBy('currentPage', 2);
+      issuableList.vm.$emit('click-tab', 'closed');
+      await waitForPromises();
 
-        expect(wrapper.vm.currentPage).toBe(2);
-        expect(wrapper.vm.fetchIssues).toHaveBeenCalled();
-      });
+      expect(axios.get).toHaveBeenCalledWith(mockProvide.issuesFetchPath, {
+        params: {
+          labels: undefined,
+          page: 1,
+          per_page: 2,
+          search: undefined,
+          sort: 'created_desc',
+          state: 'closed',
+          with_labels_details: true,
+        },
       });
+      expect(issuableList.props('currentTab')).toBe('closed');
     });
 
-  describe('template', () => {
-    const getIssuableList = () => wrapper.find(IssuableList);
+    it('"page-change" event executes GET request correctly', async () => {
+      const mockPage = 2;
+      const issuableList = findIssuableList();
 
-    it('renders issuable-list component', async () => {
-      wrapper.setData({
-        filterParams: {
-          search: 'foo',
-        },
-      });
+      issuableList.vm.$emit('page-change', mockPage);
+      await waitForPromises();
 
-      await wrapper.vm.$nextTick();
-
-      expect(getIssuableList().exists()).toBe(true);
-      expect(getIssuableList().props()).toMatchObject({
-        namespace: mockProvide.projectFullPath,
-        tabs: IssuableListTabs,
-        currentTab: 'opened',
-        searchInputPlaceholder: 'Search Jira issues',
-        searchTokens: [],
-        sortOptions: AvailableSortOptions,
-        initialFilterValue: [
-          {
-            type: 'filtered-search-term',
-            value: {
-              data: 'foo',
-            },
+      expect(axios.get).toHaveBeenCalledWith(mockProvide.issuesFetchPath, {
+        params: {
+          labels: undefined,
+          page: mockPage,
+          per_page: 2,
+          search: undefined,
+          sort: 'created_desc',
+          state: 'opened',
+          with_labels_details: true,
         },
-        ],
-        initialSortBy: 'created_desc',
-        issuables: [],
-        issuablesLoading: true,
-        showPaginationControls: wrapper.vm.showPaginationControls,
-        defaultPageSize: 2, // mocked value in tests
-        totalItems: 0,
-        currentPage: 1,
-        previousPage: 0,
-        nextPage: 2,
-        urlParams: wrapper.vm.urlParams,
-        recentSearchesStorageKey: 'jira_issues',
-        enableLabelPermalinks: true,
       });
+      expect(issuableList.props('currentPage')).toBe(mockPage);
+      expect(issuableList.props('previousPage')).toBe(mockPage - 1);
+      expect(issuableList.props('nextPage')).toBe(mockPage + 1);
     });
 
-    describe('issuable-list events', () => {
-      beforeEach(() => {
-        jest.spyOn(wrapper.vm, 'fetchIssues');
-      });
+    it('"sort" event executes GET request correctly', async () => {
+      const mockSortBy = 'updated_asc';
+      const issuableList = findIssuableList();
 
-      it('click-tab event changes currentState value and calls fetchIssues via `fetchIssuesBy`', () => {
-        getIssuableList().vm.$emit('click-tab', 'closed');
+      issuableList.vm.$emit('sort', mockSortBy);
+      await waitForPromises();
 
-        expect(wrapper.vm.currentState).toBe('closed');
-        expect(wrapper.vm.fetchIssues).toHaveBeenCalled();
+      expect(axios.get).toHaveBeenCalledWith(mockProvide.issuesFetchPath, {
+        params: {
+          labels: undefined,
+          page: 1,
+          per_page: 2,
+          search: undefined,
+          sort: 'created_desc',
+          state: 'opened',
+          with_labels_details: true,
+        },
       });
-
-      it('page-change event changes currentPage value and calls fetchIssues via `fetchIssuesBy`', () => {
-        getIssuableList().vm.$emit('page-change', 2);
-
-        expect(wrapper.vm.currentPage).toBe(2);
-        expect(wrapper.vm.fetchIssues).toHaveBeenCalled();
+      expect(issuableList.props('initialSortBy')).toBe(mockSortBy);
     });
 
-      it('sort event changes sortedBy value and calls fetchIssues via `fetchIssuesBy`', () => {
-        getIssuableList().vm.$emit('sort', 'updated_asc');
-
-        expect(wrapper.vm.sortedBy).toBe('updated_asc');
-        expect(wrapper.vm.fetchIssues).toHaveBeenCalled();
-      });
+    it('filter event sets `filterParams` value and calls fetchIssues', async () => {
+      const mockFilterTerm = 'foo';
+      const issuableList = findIssuableList();
 
-      it('filter event sets `filterParams` value and calls fetchIssues', () => {
-        getIssuableList().vm.$emit('filter', [
+      issuableList.vm.$emit('filter', [
         {
           type: 'filtered-search-term',
           value: {
-              data: 'foo',
+            data: mockFilterTerm,
           },
         },
       ]);
+      await waitForPromises();
 
-        expect(wrapper.vm.filterParams).toEqual({
-          search: 'foo',
+      expect(axios.get).toHaveBeenCalledWith(mockProvide.issuesFetchPath, {
+        params: {
+          labels: undefined,
+          page: 1,
+          per_page: 2,
+          search: mockFilterTerm,
+          sort: 'created_desc',
+          state: 'opened',
+          with_labels_details: true,
+        },
       });
-        expect(wrapper.vm.fetchIssues).toHaveBeenCalled();
     });
   });
+
+  describe('pagination', () => {
+    it.each`
+      scenario                 | issuesListLoadFailed | issues            | shouldShowPaginationControls
+      ${'fails'}               | ${true}              | ${[]}             | ${false}
+      ${'returns no issues'}   | ${false}             | ${[]}             | ${false}
+      ${`returns some issues`} | ${false}             | ${mockJiraIssues} | ${true}
+    `(
+      'sets `showPaginationControls` prop to $shouldShowPaginationControls when request $scenario',
+      async ({ issuesListLoadFailed, issues, shouldShowPaginationControls }) => {
+        jest.spyOn(axios, 'get');
+        mock
+          .onGet(mockProvide.issuesFetchPath)
+          .replyOnce(
+            issuesListLoadFailed ? httpStatus.INTERNAL_SERVER_ERROR : httpStatus.OK,
+            issues,
+            {
+              'x-page': 1,
+              'x-total': 3,
+            },
+          );
+
+        createComponent();
+
+        await waitForPromises();
+
+        expect(findIssuableList().props('showPaginationControls')).toBe(
+          shouldShowPaginationControls,
+        );
+      },
+    );
   });
 });