Skip to content

test(GlPopover): Reduce test flakiness

Mark Florian requested to merge 2199-fix-flaky-popover-spec into main

What does this MR do?

test(GlPopover): Reduce test flakiness

It seems that @vue/compat ends up destroying the popover element faster than Vue 2, making a race more likely.

Why's it a race? The problem is the use of the findByTestId command.

In this popover test, if the popover element is destroyed fast enough, we're doing something like:

cy.get('i-do-not-exist').first().should('not.exist');

That will always fail, since there's no "first" element to assert should not exist.

We simply need to remove the .first() call to fix this.

test: Rename Cypress command

This renames our custom findByTestId Cypress command to getByTestId. This name more closely mirrors the terminology Cypress uses:

The cy.get command always starts its search from the cy.root element. In most cases, it is the document element, unless used inside the .within() command. The .find command starts its search from the current subject.

See https://docs.cypress.io/api/commands/get#Get-vs-Find.

This also removes the .first() call, so it can be used with negative assertions like .should('not.exist'). Tests which really do need .first() can call that explicitly.

chore: Ignore Cypress test artifacts

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.

Closes #2199 (closed)

Edited by Mark Florian

Merge request reports