Merge branch...

Merge branch '331774-fix-new-package-settings-page-to-not-animate-to-close-on-page-load' into 'master'

Fix settings_block animations glitches

See merge request gitlab-org/gitlab!74411

app/assets/javascripts/vue_shared/components/settings/settings_block.vue

@@ -24,10 +24,13 @@ export default {
     },
   },
   data() {
+    const forceOpen = !this.collapsible || this.defaultExpanded;
     return {
       // Non-collapsible sections should always be expanded.
       // For collapsible sections, fall back to defaultExpanded.
-      sectionExpanded: !this.collapsible || this.defaultExpanded,
+      sectionExpanded: forceOpen,
+      initialised: forceOpen,
+      animating: false,
     };
   },
   computed: {
@@ -53,7 +56,12 @@ export default {
     toggleSectionExpanded() {
       this.sectionExpanded = !this.sectionExpanded;
 
+      if (!this.initialised) {
+        this.initialised = true;
+      }
+
       if (this.sectionExpanded) {
+        this.animating = true;
         this.$refs.settingsContent.focus();
       }
     },
@@ -68,7 +76,10 @@ export default {
 </script>
 
 <template>
-  <section class="settings" :class="{ 'no-animate': !slideAnimated, expanded: sectionExpanded }">
+  <section
+    class="settings"
+    :class="{ 'no-animate': !slideAnimated, expanded: sectionExpanded, animating }"
+  >
     <div class="settings-header">
       <h4>
         <span
@@ -103,12 +114,14 @@ export default {
       </p>
     </div>
     <div
+      v-show="initialised"
       :id="settingsContentId"
       ref="settingsContent"
       :aria-labelledby="settingsLabelId"
       tabindex="-1"
       role="region"
       class="settings-content"
+      @animationend="animating = false"
     >
       <slot></slot>
     </div>

spec/frontend/vue_shared/components/settings/__snapshots__/settings_block_spec.js.snap

@@ -50,6 +50,7 @@ exports[`Settings Block renders the correct markup 1`] = `
     class="settings-content"
     id="settings_content_3"
     role="region"
+    style="display: none;"
     tabindex="-1"
   >
     <div

spec/frontend/vue_shared/components/settings/settings_block_spec.js

 import { GlButton } from '@gitlab/ui';
-import { shallowMount } from '@vue/test-utils';
+import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
 import SettingsBlock from '~/vue_shared/components/settings/settings_block.vue';
 
 describe('Settings Block', () => {
   let wrapper;
 
   const mountComponent = (propsData) => {
-    wrapper = shallowMount(SettingsBlock, {
+    wrapper = shallowMountExtended(SettingsBlock, {
       propsData,
       slots: {
         title: '<div data-testid="title-slot"></div>',
@@ -20,11 +20,13 @@ describe('Settings Block', () => {
     wrapper.destroy();
   });
 
-  const findDefaultSlot = () => wrapper.find('[data-testid="default-slot"]');
-  const findTitleSlot = () => wrapper.find('[data-testid="title-slot"]');
-  const findDescriptionSlot = () => wrapper.find('[data-testid="description-slot"]');
+  const findDefaultSlot = () => wrapper.findByTestId('default-slot');
+  const findTitleSlot = () => wrapper.findByTestId('title-slot');
+  const findDescriptionSlot = () => wrapper.findByTestId('description-slot');
   const findExpandButton = () => wrapper.findComponent(GlButton);
-  const findSectionTitleButton = () => wrapper.find('[data-testid="section-title-button"]');
+  const findSectionTitleButton = () => wrapper.findByTestId('section-title-button');
+  // we are using a non js class for this finder because this class determine the component structure
+  const findSettingsContent = () => wrapper.find('.settings-content');
 
   const expectExpandedState = ({ expanded = true } = {}) => {
     const settingsExpandButton = findExpandButton();
@@ -62,6 +64,26 @@ describe('Settings Block', () => {
     expect(findDescriptionSlot().exists()).toBe(true);
   });
 
+  it('content is hidden before first expansion', async () => {
+    // this is a regression test for the bug described here: https://gitlab.com/gitlab-org/gitlab/-/issues/331774
+    mountComponent();
+
+    // content is hidden
+    expect(findDefaultSlot().isVisible()).toBe(false);
+
+    // expand
+    await findSectionTitleButton().trigger('click');
+
+    // content is visible
+    expect(findDefaultSlot().isVisible()).toBe(true);
+
+    // collapse
+    await findSectionTitleButton().trigger('click');
+
+    // content is still visible (and we have a closing animation)
+    expect(findDefaultSlot().isVisible()).toBe(true);
+  });
+
   describe('slide animation behaviour', () => {
     it('is animated by default', () => {
       mountComponent();
@@ -81,6 +103,20 @@ describe('Settings Block', () => {
         expect(wrapper.classes('no-animate')).toBe(noAnimatedClass);
       },
     );
+
+    it('sets the animating class only during the animation', async () => {
+      mountComponent();
+
+      expect(wrapper.classes('animating')).toBe(false);
+
+      await findSectionTitleButton().trigger('click');
+
+      expect(wrapper.classes('animating')).toBe(true);
+
+      await findSettingsContent().trigger('animationend');
+
+      expect(wrapper.classes('animating')).toBe(false);
+    });
   });
 
   describe('expanded behaviour', () => {