test(pom): cross-page chaining of page objects

[dbrans]

Description

Introduce chaining across pages objects in order to build-out in future tests.

Prior art: https://test-automation.blog/selenium/method-chaining-page-object-model/

Related issues

Fixes:

Manual testing steps

1. Go to this page...

Screenshots/Recordings

Before

After

Pre-merge author checklist

• I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[chloeYue]

Thanks for the implementation @dbrans . I can see a lot of improvement, though I still have one comment:
We try to keep page objects and flows isolated from each other, which means we want to avoid one page returning an instance of another page or one flow/page method taking a page instance as a parameter. The reason for this is to avoid circular references and simplify the usage.
In the case of complex workflows where several pages are involved, we perform each function on the corresponding page. Then, when we move to the next page, we create an instance for this new page and start using methods for this new page. This way, users don't need to think a lot about the pages, they just need to create instances and use the methods.

[chloeYue]

I'm wondering if we really need to add this class. For the getHeaderNavbar() and getLoginPage() methods, we can create an instance of HeaderNavbar() or LoginPage() directly when we need them. For the openSettings(), we can do new HeaderNavbar(this.driver).openSettings() in tests. For the login method, I think the original loginWithBalanceValidation is more straightforward and efficient enough.
As page object model is in the adoption phase, we are trying to keep it as simple as possible to facilitate easier onboarding and usage.

[MARAIS4455]

Thanks for your help and assistance I will definitely have a proper look after work I am very novers and don't understand much about it et Kind regards Shawn

…

On Mon, 16 Sept 2024, 11:39 chloeYue, ***@***.***> wrote: Thanks for the implementation @dbrans <https://github.com/dbrans> . I can see a lot of improvement, though I still have one comment: We try to keep page objects and flows isolated from each other, which means we want to avoid one page returning an instance of another page or one flow/page method taking a page instance as a parameter. The reason for this is to avoid circular references and simplify the usage. In the case of complex workflows where several pages are involved, we perform each function on the corresponding page. Then, when we move to the next page, we create an instance for this new page and start using methods for this new page. This way, users don't need to think a lot about the pages, they just need to create instances and use the methods. — Reply to this email directly, view it on GitHub <#27155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BJ2YEZF6U5CZ7TZQMDJBR3LZW2RMZAVCNFSM6AAAAABOIDYSY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNJSGQZTMNZSGE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[SirJosh1987]

I’m so lost it’s sad, this is new and from my cell