[Snapshot testing - Part 3] Shared lending platform

[meissadia]

Closes #1062
Closes #1090

Changes

This PR builds off of #1072, so includes all of those commits, but is separate to emphasize this PR's focus on adding snapshots to the shared-lending-platform tests. Once #1072 is reviewed and merged, this PR should be much easier to review.

• Add snapshot checks to E2E Shared Lending Platform tests

How to test this PR

1. yarn test:e2e:snapshot
2. Run shared-filing-platform tests

Screenshots

[billhimmelsbach]

Looking great and thanks for remembering to add the documentation to the readme.

I did notice the flakiness you mentioned when it comes to the footer: just like you said the gray on black with the link dots cause the most issues.

My thought on it: could we have one assertion for the unauthenticated landing page that does the image diff on the full page and the footer, then mask the footer with a mask for the rest of the tests since the footer is static?

You could add a bool that's like isFlakyRegionIgnored or just isFooterIgnored to your takeSnapshot function that defaults to true. Then for your one test on the unauthenticated landing page that includes the full page and footer, you could set isFlakyRegionIgnored=false. Then for the rest of the tests, isFlakyRegionIgnored could default to true, and a mask could be applied to another class like .snapshot-ignore-flaky or you could just pick out the footer class that already exists and mask that.

I think it would cut down a lot on the flakiness hopefully, since then we won't be testing the footer over and over. 🤞

[meissadia]

I've got a draft to mask the Footer on most pages but will wait until we merge #1072 to cut down on merge conflicts.

[billhimmelsbach]

There is the option in playwright just to take a screenshot of an element, so you could just take a screenshot of the footer if you wanted to. I'm not sure though if that would make the test more/less flaky @meissadia, but might be worth testing?

[meissadia]

@billhimmelsbach To avoid blocking this PR as we head into the holidays, I've created a follow-up ticket to explore the Footer flakiness.

[Snapshot] Reduce flakiness of Footer snapshot tests

[billhimmelsbach]

Great! Thanks for ticketing that.