Skip to content

test(integration-tests): Unflake some tests #7076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 8, 2023
Merged

test(integration-tests): Unflake some tests #7076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f589f02
Attempt 1
Feb 7, 2023
49a3b5c
Fix approximation flakes
Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/integration-tests/suites/tracing/browsertracing/backgroundtab-pageload/subject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
document.getElementById('go-background').addEventListener('click', () => {
Object.defineProperty(document, 'hidden', { value: true, writable: true });
const ev = document.createEvent('Event');
ev.initEvent('visibilitychange');
document.dispatchEvent(ev);
setTimeout(() => {
Object.defineProperty(document, 'hidden', { value: true, writable: true });
const ev = document.createEvent('Event');
ev.initEvent('visibilitychange');
document.dispatchEvent(ev);
}, 250);
});
6 changes: 4 additions & 2 deletions packages/integration-tests/suites/tracing/browsertracing/backgroundtab-pageload/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ sentryTest('should finish pageload transaction when the page goes background', a

await page.goto(url);

void page.click('#go-background');
const pageloadTransactionPromise = getFirstSentryEnvelopeRequest<Event>(page);

const pageloadTransaction = await getFirstSentryEnvelopeRequest<Event>(page);
await page.click('#go-background');

const pageloadTransaction = await pageloadTransactionPromise;
Comment on lines +14 to +16
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just Promise.all (kicking off the page click first?)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is inherently gonna produce the race condition again that I want to remove with this change. Listen first -> then the interaction -> wait for interaction outcome. Mixing step 1 and 2 is dangerous.


expect(pageloadTransaction.contexts?.trace?.op).toBe('pageload');
expect(pageloadTransaction.contexts?.trace?.status).toBe('cancelled');
Expand Down
19 changes: 12 additions & 7 deletions packages/integration-tests/suites/tracing/metrics/web-vitals-cls/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ sentryTest('should capture a "GOOD" CLS vital with its source(s).', async ({ get

expect(eventData.measurements).toBeDefined();
expect(eventData.measurements?.cls?.value).toBeDefined();
expect(eventData.measurements?.cls?.value).toBeCloseTo(0.05);

// Flakey value dependent on timings -> we check for a range
expect(eventData.measurements?.cls?.value).toBeGreaterThan(0.03);
expect(eventData.measurements?.cls?.value).toBeLessThan(0.07);

expect(eventData.tags?.['cls.source.1']).toBe('body > div#content > p#partial');
});

Expand All @@ -28,7 +32,11 @@ sentryTest('should capture a "MEH" CLS vital with its source(s).', async ({ getL

expect(eventData.measurements).toBeDefined();
expect(eventData.measurements?.cls?.value).toBeDefined();
expect(eventData.measurements?.cls?.value).toBeCloseTo(0.21);

// Flakey value dependent on timings -> we check for a range
expect(eventData.measurements?.cls?.value).toBeGreaterThan(0.18);
expect(eventData.measurements?.cls?.value).toBeLessThan(0.23);

expect(eventData.tags?.['cls.source.1']).toBe('body > div#content > p');
});

Expand All @@ -38,11 +46,8 @@ sentryTest('should capture a "POOR" CLS vital with its source(s).', async ({ get

expect(eventData.measurements).toBeDefined();
expect(eventData.measurements?.cls?.value).toBeDefined();
// This test in particular seems to be flaky, such that the received value is frequently within 0.006 rather than the
// 0.005 that `toBeCloseTo()` requires. While it's true that each test is retried twice if it fails, in the flaky
// cases all three attempts always seem to come up with the exact same slightly-too-far-away number. Rather than ramp
// down `toBeCloseTo()`'s precision (which would make it accept anything between 0.30 and 0.40), we can just do the
// check manually.

// Flakey value dependent on timings -> we check for a range
expect(eventData.measurements?.cls?.value).toBeGreaterThan(0.34);
expect(eventData.measurements?.cls?.value).toBeLessThan(0.36);
expect(eventData.tags?.['cls.source.1']).toBe('body > div#content > p');
Expand Down