Merge branch 'ps-ide-defer-loading-terminal-modules' into 'master'

Chunk deferred runtime and terminal modules in Web IDE

See merge request gitlab-org/gitlab!47719

app/assets/javascripts/ide/components/ide.vue

 <script>
 import { mapActions, mapGetters, mapState } from 'vuex';
+import { GlButton, GlLoadingIcon } from '@gitlab/ui';
 import { __ } from '~/locale';
 import {
   WEBIDE_MARK_APP_START,
@@ -29,15 +30,17 @@ export default {
   components: {
     IdeSidebar,
     RepoEditor,
-    'error-message': () => import('./error_message.vue'),
-    'gl-button': () => import('@gitlab/ui/src/components/base/button/button.vue'),
-    'gl-loading-icon': () => import('@gitlab/ui/src/components/base/loading_icon/loading_icon.vue'),
-    'commit-editor-header': () => import('./commit_sidebar/editor_header.vue'),
-    'repo-tabs': () => import('./repo_tabs.vue'),
-    'ide-status-bar': () => import('./ide_status_bar.vue'),
-    'find-file': () => import('~/vue_shared/components/file_finder/index.vue'),
-    'right-pane': () => import('./panes/right.vue'),
-    'new-modal': () => import('./new_dropdown/modal.vue'),
+    GlButton,
+    GlLoadingIcon,
+    ErrorMessage: () => import(/* webpackChunkName: 'ide_runtime' */ './error_message.vue'),
+    CommitEditorHeader: () =>
+      import(/* webpackChunkName: 'ide_runtime' */ './commit_sidebar/editor_header.vue'),
+    RepoTabs: () => import(/* webpackChunkName: 'ide_runtime' */ './repo_tabs.vue'),
+    IdeStatusBar: () => import(/* webpackChunkName: 'ide_runtime' */ './ide_status_bar.vue'),
+    FindFile: () =>
+      import(/* webpackChunkName: 'ide_runtime' */ '~/vue_shared/components/file_finder/index.vue'),
+    RightPane: () => import(/* webpackChunkName: 'ide_runtime' */ './panes/right.vue'),
+    NewModal: () => import(/* webpackChunkName: 'ide_runtime' */ './new_dropdown/modal.vue'),
   },
   mixins: [glFeatureFlagsMixin()],
   data() {

app/assets/javascripts/ide/components/ide_side_bar.vue

@@ -14,8 +14,10 @@ export default {
     ResizablePanel,
     ActivityBar,
     IdeTree,
-    [leftSidebarViews.review.name]: () => import('./ide_review.vue'),
-    [leftSidebarViews.commit.name]: () => import('./repo_commit_section.vue'),
+    [leftSidebarViews.review.name]: () =>
+      import(/* webpackChunkName: 'ide_runtime' */ './ide_review.vue'),
+    [leftSidebarViews.commit.name]: () =>
+      import(/* webpackChunkName: 'ide_runtime' */ './repo_commit_section.vue'),
     CommitForm,
     IdeProjectHeader,
   },

app/assets/javascripts/ide/components/terminal/view.vue

 <script>
 import { mapActions, mapGetters, mapState } from 'vuex';
 import EmptyState from './empty_state.vue';
-import TerminalSession from './session.vue';
 
 export default {
   components: {
     EmptyState,
-    TerminalSession,
+    TerminalSession: () => import(/* webpackChunkName: 'ide_terminal' */ './session.vue'),
   },
   computed: {
     ...mapState('terminal', ['isShowSplash', 'paths']),

doc/development/testing_guide/frontend_testing.md

@@ -104,37 +104,6 @@ describe('Component', () => {
 
 Remember that the performance of each test depends on the environment.
 
-### Timout error due to async components
-
-If your component is fetching some other components asynchroneously based on some conditions, it might happen so that your Jest suite for this component will become flaky timing out from time to time.
-
-```javascript
-// ide.vue
-export default {
-  components: {
-    'error-message': () => import('./error_message.vue'),
-    'gl-button': () => import('@gitlab/ui/src/components/base/button/button.vue'),
-    ...
-};
-```
-
-To address this issue, you can "help" Jest by stubbing the async components so that Jest would not need to fetch those asynchroneously at the run-time.
-
-```javascript
-// ide_spec.js
-import { GlButton } from '@gitlab/ui';
-import ErrorMessage from '~/ide/components/error_message.vue';
-...
-return shallowMount(ide, {
-  ...
-  stubs: {
-    ErrorMessage,
-    GlButton,
-    ...
-  },
-})
-```
-
 ## What and how to test
 
 Before jumping into more gritty details about Jest-specific workflows like mocks and spies, we should briefly cover what to test with Jest.

spec/frontend/ide/components/ide_spec.js

 import Vuex from 'vuex';
 import { createLocalVue, shallowMount } from '@vue/test-utils';
-import { GlButton, GlLoadingIcon } from '@gitlab/ui';
+import waitForPromises from 'helpers/wait_for_promises';
 import { createStore } from '~/ide/stores';
 import ErrorMessage from '~/ide/components/error_message.vue';
-import FindFile from '~/vue_shared/components/file_finder/index.vue';
-import CommitEditorHeader from '~/ide/components/commit_sidebar/editor_header.vue';
-import RepoTabs from '~/ide/components/repo_tabs.vue';
-import IdeStatusBar from '~/ide/components/ide_status_bar.vue';
-import RightPane from '~/ide/components/panes/right.vue';
-import NewModal from '~/ide/components/new_dropdown/modal.vue';
-
 import ide from '~/ide/components/ide.vue';
 import { file } from '../helpers';
 import { projectData } from '../mock_data';
@@ -39,17 +32,6 @@ describe('WebIDE', () => {
     return shallowMount(ide, {
       store,
       localVue,
-      stubs: {
-        ErrorMessage,
-        GlButton,
-        GlLoadingIcon,
-        CommitEditorHeader,
-        RepoTabs,
-        IdeStatusBar,
-        FindFile,
-        RightPane,
-        NewModal,
-      },
     });
   }
 
@@ -74,27 +56,24 @@ describe('WebIDE', () => {
 
   describe('ide component, non-empty repo', () => {
     describe('error message', () => {
-      it('does not show error message when it is not set', () => {
-        wrapper = createComponent({
-          state: {
-            errorMessage: null,
-          },
-        });
-
-        expect(wrapper.find(ErrorMessage).exists()).toBe(false);
-      });
-
-      it('shows error message when set', () => {
-        wrapper = createComponent({
-          state: {
-            errorMessage: {
-              text: 'error',
+      it.each`
+        errorMessage         | exists
+        ${null}              | ${false}
+        ${{ text: 'error' }} | ${true}
+      `(
+        'should error message exists=$exists when errorMessage=$errorMessage',
+        async ({ errorMessage, exists }) => {
+          wrapper = createComponent({
+            state: {
+              errorMessage,
             },
-          },
-        });
+          });
 
-        expect(wrapper.find(ErrorMessage).exists()).toBe(true);
-      });
+          await waitForPromises();
+
+          expect(wrapper.find(ErrorMessage).exists()).toBe(exists);
+        },
+      );
     });
 
     describe('onBeforeUnload', () => {

spec/frontend/ide/components/terminal/view_spec.js

 import { shallowMount, createLocalVue } from '@vue/test-utils';
 import Vuex from 'vuex';
 import { TEST_HOST } from 'spec/test_constants';
+import waitForPromises from 'helpers/wait_for_promises';
 import TerminalEmptyState from '~/ide/components/terminal/empty_state.vue';
 import TerminalView from '~/ide/components/terminal/view.vue';
 import TerminalSession from '~/ide/components/terminal/session.vue';
@@ -17,7 +18,7 @@ describe('IDE TerminalView', () => {
   let getters;
   let wrapper;
 
-  const factory = () => {
+  const factory = async () => {
     const store = new Vuex.Store({
       modules: {
         terminal: {
@@ -30,6 +31,9 @@ describe('IDE TerminalView', () => {
     });
 
     wrapper = shallowMount(TerminalView, { localVue, store });
+
+    // Uses deferred components, so wait for those to load...
+    await waitForPromises();
   };
 
   beforeEach(() => {
@@ -59,8 +63,8 @@ describe('IDE TerminalView', () => {
     wrapper.destroy();
   });
 
-  it('renders empty state', () => {
-    factory();
+  it('renders empty state', async () => {
+    await factory();
 
     expect(wrapper.find(TerminalEmptyState).props()).toEqual({
       helpPath: TEST_HELP_PATH,
@@ -69,8 +73,8 @@ describe('IDE TerminalView', () => {
     });
   });
 
-  it('hides splash and starts, when started', () => {
-    factory();
+  it('hides splash and starts, when started', async () => {
+    await factory();
 
     expect(actions.startSession).not.toHaveBeenCalled();
     expect(actions.hideSplash).not.toHaveBeenCalled();
@@ -81,9 +85,9 @@ describe('IDE TerminalView', () => {
     expect(actions.hideSplash).toHaveBeenCalled();
   });
 
-  it('shows Web Terminal when started', () => {
+  it('shows Web Terminal when started', async () => {
     state.isShowSplash = false;
-    factory();
+    await factory();
 
     expect(wrapper.find(TerminalEmptyState).exists()).toBe(false);
     expect(wrapper.find(TerminalSession).exists()).toBe(true);