path: root/spec/frontend/ide/components/commit_sidebar/form_spec.js

import Vue from 'vue';
import { getByText } from '@testing-library/dom';
import { createComponentWithStore } from 'helpers/vue_mount_component_helper';
import { projectData } from 'jest/ide/mock_data';
import waitForPromises from 'helpers/wait_for_promises';
import { createStore } from '~/ide/stores';
import consts from '~/ide/stores/modules/commit/constants';
import CommitForm from '~/ide/components/commit_sidebar/form.vue';
import { leftSidebarViews } from '~/ide/constants';
import {
  createCodeownersCommitError,
  createUnexpectedCommitError,
  createBranchChangedCommitError,
  branchAlreadyExistsCommitError,
} from '~/ide/lib/errors';

describe('IDE commit form', () => {
  const Component = Vue.extend(CommitForm);
  let vm;
  let store;

  const beginCommitButton = () => vm.$el.querySelector('[data-testid="begin-commit-button"]');

  beforeEach(() => {
    store = createStore();
    store.state.changedFiles.push('test');
    store.state.currentProjectId = 'abcproject';
    store.state.currentBranchId = 'master';
    Vue.set(store.state.projects, 'abcproject', { ...projectData });

    vm = createComponentWithStore(Component, store).$mount();
  });

  afterEach(() => {
    vm.$destroy();
  });

  it('enables begin commit button when there are changes', () => {
    expect(beginCommitButton()).not.toHaveAttr('disabled');
  });

  it('disables begin commit button when there are no changes', async () => {
    store.state.changedFiles = [];
    await vm.$nextTick();

    expect(beginCommitButton()).toHaveAttr('disabled');
  });

  describe('compact', () => {
    beforeEach(() => {
      vm.isCompact = true;

      return vm.$nextTick();
    });

    it('renders commit button in compact mode', () => {
      expect(beginCommitButton()).not.toBeNull();
      expect(beginCommitButton().textContent).toContain('Commit');
    });

    it('does not render form', () => {
      expect(vm.$el.querySelector('form')).toBeNull();
    });

    it('renders overview text', () => {
      vm.$store.state.stagedFiles.push('test');

      return vm.$nextTick(() => {
        expect(vm.$el.querySelector('p').textContent).toContain('1 changed file');
      });
    });

    it('shows form when clicking commit button', () => {
      beginCommitButton().click();

      return vm.$nextTick(() => {
        expect(vm.$el.querySelector('form')).not.toBeNull();
      });
    });

    it('toggles activity bar view when clicking commit button', () => {
      beginCommitButton().click();

      return vm.$nextTick(() => {
        expect(store.state.currentActivityView).toBe(leftSidebarViews.commit.name);
      });
    });

    it('collapses if lastCommitMsg is set to empty and current view is not commit view', async () => {
      store.state.lastCommitMsg = 'abc';
      store.state.currentActivityView = leftSidebarViews.edit.name;
      await vm.$nextTick();

      // if commit message is set, form is uncollapsed
      expect(vm.isCompact).toBe(false);

      store.state.lastCommitMsg = '';
      await vm.$nextTick();

      // collapsed when set to empty
      expect(vm.isCompact).toBe(true);
    });

    it('collapses if in commit view but there are no changes and vice versa', async () => {
      store.state.currentActivityView = leftSidebarViews.commit.name;
      await vm.$nextTick();

      // expanded by default if there are changes
      expect(vm.isCompact).toBe(false);

      store.state.changedFiles = [];
      await vm.$nextTick();

      expect(vm.isCompact).toBe(true);

      store.state.changedFiles.push('test');
      await vm.$nextTick();

      // uncollapsed once again
      expect(vm.isCompact).toBe(false);
    });

    it('collapses if switched from commit view to edit view and vice versa', async () => {
      store.state.currentActivityView = leftSidebarViews.edit.name;
      await vm.$nextTick();

      expect(vm.isCompact).toBe(true);

      store.state.currentActivityView = leftSidebarViews.commit.name;
      await vm.$nextTick();

      expect(vm.isCompact).toBe(false);

      store.state.currentActivityView = leftSidebarViews.edit.name;
      await vm.$nextTick();

      expect(vm.isCompact).toBe(true);
    });

    describe('when window height is less than MAX_WINDOW_HEIGHT', () => {
      let oldHeight;

      beforeEach(() => {
        oldHeight = window.innerHeight;
        window.innerHeight = 700;
      });

      afterEach(() => {
        window.innerHeight = oldHeight;
      });

      it('stays collapsed when switching from edit view to commit view and back', async () => {
        store.state.currentActivityView = leftSidebarViews.edit.name;
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);

        store.state.currentActivityView = leftSidebarViews.commit.name;
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);

        store.state.currentActivityView = leftSidebarViews.edit.name;
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);
      });

      it('stays uncollapsed if changes are added or removed', async () => {
        store.state.currentActivityView = leftSidebarViews.commit.name;
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);

        store.state.changedFiles = [];
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);

        store.state.changedFiles.push('test');
        await vm.$nextTick();

        expect(vm.isCompact).toBe(true);
      });

      it('uncollapses when clicked on Commit button in the edit view', async () => {
        store.state.currentActivityView = leftSidebarViews.edit.name;
        beginCommitButton().click();
        await waitForPromises();

        expect(vm.isCompact).toBe(false);
      });
    });
  });

  describe('full', () => {
    beforeEach(() => {
      vm.isCompact = false;

      return vm.$nextTick();
    });

    it('updates commitMessage in store on input', () => {
      const textarea = vm.$el.querySelector('textarea');

      textarea.value = 'testing commit message';

      textarea.dispatchEvent(new Event('input'));

      return vm.$nextTick().then(() => {
        expect(vm.$store.state.commit.commitMessage).toBe('testing commit message');
      });
    });

    it('updating currentActivityView not to commit view sets compact mode', () => {
      store.state.currentActivityView = 'a';

      return vm.$nextTick(() => {
        expect(vm.isCompact).toBe(true);
      });
    });

    it('always opens itself in full view current activity view is not commit view when clicking commit button', () => {
      beginCommitButton().click();

      return vm.$nextTick(() => {
        expect(store.state.currentActivityView).toBe(leftSidebarViews.commit.name);
        expect(vm.isCompact).toBe(false);
      });
    });

    describe('discard draft button', () => {
      it('hidden when commitMessage is empty', () => {
        expect(vm.$el.querySelector('.btn-default').textContent).toContain('Collapse');
      });

      it('resets commitMessage when clicking discard button', () => {
        vm.$store.state.commit.commitMessage = 'testing commit message';

        return vm
          .$nextTick()
          .then(() => {
            vm.$el.querySelector('.btn-default').click();
          })
          .then(() => vm.$nextTick())
          .then(() => {
            expect(vm.$store.state.commit.commitMessage).not.toBe('testing commit message');
          });
      });
    });

    describe('when submitting', () => {
      beforeEach(() => {
        jest.spyOn(vm, 'commitChanges');

        vm.$store.state.stagedFiles.push('test');
        vm.$store.state.commit.commitMessage = 'testing commit message';
      });

      it('calls commitChanges', () => {
        vm.commitChanges.mockResolvedValue({ success: true });

        return vm.$nextTick().then(() => {
          vm.$el.querySelector('.btn-success').click();

          expect(vm.commitChanges).toHaveBeenCalled();
        });
      });

      it.each`
        createError                                          | props
        ${() => createCodeownersCommitError('test message')} | ${{ actionPrimary: { text: 'Create new branch' } }}
        ${createUnexpectedCommitError}                       | ${{ actionPrimary: null }}
      `('opens error modal if commitError with $error', async ({ createError, props }) => {
        jest.spyOn(vm.$refs.commitErrorModal, 'show');

        const error = createError();
        store.state.commit.commitError = error;

        await vm.$nextTick();

        expect(vm.$refs.commitErrorModal.show).toHaveBeenCalled();
        expect(vm.$refs.commitErrorModal).toMatchObject({
          actionCancel: { text: 'Cancel' },
          ...props,
        });
        // Because of the legacy 'mountComponent' approach here, the only way to
        // test the text of the modal is by viewing the content of the modal added to the document.
        expect(document.body).toHaveText(error.messageHTML);
      });
    });

    describe('with error modal with primary', () => {
      beforeEach(() => {
        jest.spyOn(vm.$store, 'dispatch').mockReturnValue(Promise.resolve());
      });

      const commitActions = [
        ['commit/updateCommitAction', consts.COMMIT_TO_NEW_BRANCH],
        ['commit/commitChanges'],
      ];

      it.each`
        commitError                       | expectedActions
        ${createCodeownersCommitError}    | ${commitActions}
        ${createBranchChangedCommitError} | ${commitActions}
        ${branchAlreadyExistsCommitError} | ${[['commit/addSuffixToBranchName'], ...commitActions]}
      `(
        'updates commit action and commits for error: $commitError',
        async ({ commitError, expectedActions }) => {
          store.state.commit.commitError = commitError('test message');

          await vm.$nextTick();

          getByText(document.body, 'Create new branch').click();

          await waitForPromises();

          expect(vm.$store.dispatch.mock.calls).toEqual(expectedActions);
        },
      );
    });
  });

  describe('commitButtonText', () => {
    it('returns commit text when staged files exist', () => {
      vm.$store.state.stagedFiles.push('testing');

      expect(vm.commitButtonText).toBe('Commit');
    });

    it('returns stage & commit text when staged files do not exist', () => {
      expect(vm.commitButtonText).toBe('Stage & Commit');
    });
  });
});