Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

chore: make feature.spec and segements.spec more resilient (#7289)

Browse Source 
This PR attempts to make the feature.spec and segements.spec test suites
more reliable. They have been flaking out a lot recently, and this will
hopefully make them less flaky.

The way of handling it is a little different for each test suite.

## feature.spec

Some of the failures we're seeing for the feature/feauture.spec test
suite are due to uncaught resize observer issues (possibly triggered by
the banners).

We can ignore these errors as they don't impact functionality, only
rendering, and are likely to resolve themselves quickly in real-world
scenarios.

On the other hand, it might also ignore actual errors, so I'm not a 100%
on this. Would love some input.

However, MDN has some info on [observation
errors](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver#observation_errors):

> As long as the error event does not fire indefinitely, resize observer
will settle and produce a stable, likely correct, layout. However,
visitors may see a flash of broken layout, as a sequence of changes
expected to happen in a single frame is instead happening over multiple
frames.

Based on that, I think this is a pretty safe error to ignore. 

I'm unsure whether catching this exception is only set in the `after`
cleanup or whether it pollutes the cy object for all tests, but I think
it's fine either way. But if you have ideas, I'd love to hear them.

## segments.spec

The issue here appears to be that when we first input the segment's name
in the form, it takes a little time for the UI to become ready, so the
first characters of the string are cut off.

This is a known [issue that the cypress team are
aware](https://github.com/cypress-io/cypress/issues/3817), but that
isn't likely to get fixed any time soon because no one can give them a
reproducible example.

You can see the effect of this on segments that haven't been cleaned up
in the preview:

![image](https://github.com/Unleash/unleash/assets/17786332/1db59906-a2ee-4149-869b-81f2245b4399)

To work around it, we add a 500ms wait before we start filling out the
form. Yes, adding [waits in your tests is an
antipattern](https://docs.cypress.io/guides/references/best-practices#Unnecessary-Waiting),
but it's the easiest way around in this case.

We *could* investigate and find a way not to need that, but that would
likely be a much larger project. This appears to mitigate the issue
immediately, so is at least a pretty good temporary fix in my opinion.
We also already do this in other tests, so there is a precedent for it.
This commit is contained in:
Thomas Heartman 2024-06-07 08:37:53 +02:00 committed by GitHub
parent 2e4601f5ba
commit 215608c4b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
frontend/cypress/integration/feature/feature.spec.ts
View File

@ -5,9 +5,6 @@ describe('feature', () => {
const featureToggleName = `unleash-e2e-${randomId}`;
const projectName = `unleash-e2e-project-${randomId}`;
const variant1 = 'variant1';
const variant2 = 'variant2';
before(() => {
cy.runBefore();
cy.login_UI();
@ -15,6 +12,22 @@ describe('feature', () => {
});
after(() => {
cy.on('uncaught:exception', (err) => {
if (
err.message.includes(
'ResizeObserver loop completed with undelivered notifications',
)
) {
console.log(
'Ignored an uncaught resize observer error:',
err.message,
);
// ignore resize observer errors
// https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver#observation_errors
// returning false here prevents Cypress from failing the test
return false;
}
});
cy.deleteFeature_API(featureToggleName, projectName);
cy.deleteProject_API(projectName);
});

2
frontend/cypress/support/UI.ts
View File

@ -101,6 +101,8 @@ export const createSegment_UI = (segmentName: string): Chainable<any> => {
cy.intercept('POST', '/api/admin/segments').as('createSegment');
cy.wait(500);
cy.get("[data-testid='SEGMENT_NAME_ID']").type(segmentName);
cy.get("[data-testid='SEGMENT_DESC_ID']").type('hello-world');
cy.get("[data-testid='SEGMENT_NEXT_BTN_ID']").click();