Added Interaction to get the value of a certain token #19

frazarshad · 2024-03-05T17:32:21Z

Motivation and context

This PR:

adds interaction to add newly found tokens (required to add multiple tokens to the wallet)
adds interaction to get the amount of a token that is in the wallet
fix for change wallet interaction (added a wait because the page redirects after the wallet is selected)
misc playwright fixes

rabi-siddique · 2024-03-06T03:44:30Z

commands/keplr.js

@@ -273,6 +272,7 @@ const keplr = {
  },

  async switchWallet({ walletName }) {
+    const originalURL = (await playwright.keplrWindow()).url();
    await module.exports.switchToKeplrIfNotActive();


keplrWindow is not async

rabi-siddique · 2024-03-06T03:49:53Z

commands/keplr.js

@@ -273,6 +272,7 @@ const keplr = {
  },

  async switchWallet({ walletName }) {
+    const originalURL = (await playwright.keplrWindow()).url();


I am all in for sending params through an object. But if this method is going to have a single param, in that case, I feel it's best to pass it without an object to ensure clarity and consistency with other methods.

Also, we should use objects for sending params in importWallet flow. There we have multiple params and it sometimes becomes tedious to maintain order while passing params.

params can eventually grow in the future, better we add this now then later when changing this might become an issue

rabi-siddique · 2024-03-06T03:51:27Z

commands/keplr.js

+    await playwright.waitAndClick(
+      homePageElements.selectAllTokensCheck,
+      await playwright.keplrWindow(),
+      { number: -1, force: true },


keplrWindow is not async. :D

rabi-siddique · 2024-03-06T03:51:56Z

commands/keplr.js

+    await playwright.waitAndClickByText(
+      homePageElements.addChainsButton,
+      await playwright.keplrWindow(),
+      true,


keplrWindow is not async

rabi-siddique · 2024-03-06T03:52:23Z

commands/keplr.js

    await playwright.switchToCypressWindow();

    return true;
  },
+
+  async getTokenAmount({ tokenName }) {
+    module.exports.switchToKeplrIfNotActive();


Same suggestion as above for using objects for passing params.

rabi-siddique · 2024-03-06T04:09:47Z

commands/keplr.js

+
+  async addNewTokensFound() {
+    module.exports.switchToKeplrIfNotActive();
+    await module.exports.goToHome();


switchToKeplrIfNotActive is async

rabi-siddique · 2024-03-06T04:34:33Z

pages/keplr/home-page.js

+const tokenParentSelector = '../../../..';
+const selectAllTokensCheck = 'input[type="checkbox"]:enabled';
+const newTokensFound = 'new token(s) found';
+const addChainsButton = 'Add Chains';


I was seeing Keplr but didn't find any text saying new token(s) found on Home URL
Can you guide me on testing this workflow?

test is added on this. you can get an idea from there how the flow occurs

rabi-siddique · 2024-03-06T04:42:09Z

commands/playwright-keplr.js

+  async waitForURLLoad(url, page = keplrWindow) {
+    await page.waitForURL(url);
+    await module.exports.waitUntilStable(page);
+  },


Why do we need this method?

mentioned as point no.3 in the descripiton. whenever we press the change wallet button, it redirects to the page it was previously on. this function is being used there to wait for that redirect

rabi-siddique · 2024-03-06T04:43:08Z

commands/keplr.js

+    await playwright.waitForURLLoad(originalURL);
+    await playwright.switchToCypressWindow();
+
+    return true;


Why is there a need to store the URL at the start and navigate to it once we're about to finish execution?

The switchWallet test cases are running fine if I comment the first line to get the original URL and waitForURLLoad call.

how does it wait for a URL to load if I don't pass any URL?

rabi-siddique · 2024-03-06T04:53:17Z

commands/keplr.js

+    const innerTexts = await parentElement.allInnerTexts();
+    const textArray = innerTexts[0].split('\n');
+    const tokenValue = Number(textArray[3]);
+


Should we add some fallback logic in case the token we're trying to find does not exist?

i think this is fine, since it should crash if the expected token is not found.
but any suggestions?

rabi-siddique

LGTM

* Remove leftover TODOs * Remove text based locators * Add `Known problems with MetaMask` section * Remove Promise wrap from `cy.setupMetamask()` (Synthetixio#927) * Fix localized Chrome's extension id (Synthetixio#928) * Fix localized Chrome's extension id * Improve id handling --------- Co-authored-by: Piotr Frankowski <[email protected]> * Lint * Feature/revoke permission to all (Synthetixio#932) * Fix typo in Permission word * Add permission revoking actions * Add tests for permission revoking actions * Regenerate synpress commands file * Add `switchNetwork` option to `acceptAccess` function * Add new release section to README * Use `goerli` for testing (Synthetixio#1082) * Use `goerli` for testing * Trigger tests * Add `shouldWaitForPopupClosure` option to approvals and txs (Synthetixio#1081) * feature: intial setup for integration of keplr * chore: use Error object for throwing an error related to invalid extension name * Adding Keplr Interaction for Importing Wallet using Private Key (#2) * feature: adding keplr interaction for creating an account using private key * feature: keplr interaction for importing an existing wallet and creating a new wallet * fix: fixed implementation of waitAndClickByText to perform exact matching --------- Co-authored-by: Fraz Arshad <[email protected]> * Disconnect Wallet Interaction (#7) * chore: removing call to acceptAccess function * feature: adding intereaction for disconnecting with wallet * remve the default arg * Added Interaction to handle rejection of wallet connection (#8) * feat: added code to handle reject wallet access * feat: added test case for reject wallet access + modified test structure * Include code for Offer up Dapp (#10) * feat(ci): Included ui/ and contract/ from offer-up-dapp (with changes) * refactor: moved ui/ and contract/ to tools/ folder * Updates to CI/CD to use Agoric chain and Offer up DApp (#4) * feat(ci): Included ui/ and contract/ from offer-up-dapp (with changes) * feat(ci): Updated CI to use agoric chain + offer up dapp * fix(ci): updated scripts in package.json * refactor(ci): Moved ui/ and contract/ to tools/ * refactor: moved json-server-db.json to tools folder * Single Screen Interaction, Approve Button Fix and Code Cleanup (#9) * chore: organize code in playwright.keplr.js and remove not used states * chore: resolve merge conflicts with dev branch * chore: using a consistent and more intention revealing name for a helper function * chore: adding a test case for validating the switchToExtensionWindow function * chore: change selector for Approve button on connecting with wallet UI * chore: addressing PR comments * Interaction for transaction rejection (#12) * feat: added logic for transaction rejection * feat: added test for transaction rejection * fix: typo in test name * chore:remove call to switchToKeplrWindow in metamask.js (#16) * Abstracting Calls to Switching Extension in Keplr Helper Methods (#13) * chore: abstracting calls to switching to keplr window in keplr helper functions * chore: removing unnecessary awaits with sync function * Enable setup of the keplr extension in the beforeAll hook for cypress (#14) * fix: added code to handle setup of keplr wallet beforehand * chore: lint fixes * Add command to switch to another wallet (#18) * feat: interaction to switch wallet * chore: fixes for await async * Getting Wallet Address (#17) * feat: initial working setup for retrieving wallet address * chore:code cleanup * feat: interaction to switch wallet * chore: simplifying switching screens in import wallet flow * chore format code with prettier * chore: moving get wallet address test case in the main context * chore: fixes for await async * chore: address PR comments --------- Co-authored-by: Fraz Arshad <[email protected]> * Added Interaction to get the value of a certain token (#19) * feat: added command to get tokens * chore: await/async fixes * Updates to CI/CD flow (#20) * ci: new docker ci file for keplr * ci: using docker workflow instead of debug workflow temporarily * ci: updated config to have not retires in ci * Adding Selecting Chain Interaction And Flow Improvements (#21) * chore: changing the flow of test cases; starting by creating a new wallet rather than importing * feature: adding behavior in import wallet flow to select a chain when importing/creating wallet * feature: adding helper methods to click elements in a reliable way * chore: using helper methods inside keplr.js * chore: handling edge case for grabbing token values when values are large numbers containing commas * chore: updating selector for getting wallet address and adding test cases to validate the behavior * chore: addressing PR comments * chore: addressing PR comments * chore: replacing Agoric local with Agoric localhost * feat: included settings to setup npm (#22) * refactor: changed args for setupWallet (#24) * Added automatic linting to the repository (#23) * style:changing settings for linting * style: fixes to lint + styling throughout repo * Enabled CI Pipeline for NPM deployment (#25) * feat: release workflow enabled * feat: added CI cache folders to .npmignore * chore: revert back to master after testing --------- Co-authored-by: duckception <[email protected]> Co-authored-by: Peter F <[email protected]> Co-authored-by: Piotr Frankowski <[email protected]> Co-authored-by: Rafał Majchrzak <[email protected]> Co-authored-by: rabi-siddique <[email protected]> Co-authored-by: Rabi Siddique <[email protected]>

* Remove leftover TODOs * Remove text based locators * Add `Known problems with MetaMask` section * Remove Promise wrap from `cy.setupMetamask()` (Synthetixio#927) * Fix localized Chrome's extension id (Synthetixio#928) * Fix localized Chrome's extension id * Improve id handling --------- Co-authored-by: Piotr Frankowski <[email protected]> * Lint * Feature/revoke permission to all (Synthetixio#932) * Fix typo in Permission word * Add permission revoking actions * Add tests for permission revoking actions * Regenerate synpress commands file * Add `switchNetwork` option to `acceptAccess` function * Add new release section to README * Use `goerli` for testing (Synthetixio#1082) * Use `goerli` for testing * Trigger tests * Add `shouldWaitForPopupClosure` option to approvals and txs (Synthetixio#1081) * feature: intial setup for integration of keplr * chore: use Error object for throwing an error related to invalid extension name * Adding Keplr Interaction for Importing Wallet using Private Key (#2) * feature: adding keplr interaction for creating an account using private key * feature: keplr interaction for importing an existing wallet and creating a new wallet * fix: fixed implementation of waitAndClickByText to perform exact matching --------- Co-authored-by: Fraz Arshad <[email protected]> * Disconnect Wallet Interaction (#7) * chore: removing call to acceptAccess function * feature: adding intereaction for disconnecting with wallet * remve the default arg * Added Interaction to handle rejection of wallet connection (#8) * feat: added code to handle reject wallet access * feat: added test case for reject wallet access + modified test structure * Include code for Offer up Dapp (#10) * feat(ci): Included ui/ and contract/ from offer-up-dapp (with changes) * refactor: moved ui/ and contract/ to tools/ folder * Updates to CI/CD to use Agoric chain and Offer up DApp (#4) * feat(ci): Included ui/ and contract/ from offer-up-dapp (with changes) * feat(ci): Updated CI to use agoric chain + offer up dapp * fix(ci): updated scripts in package.json * refactor(ci): Moved ui/ and contract/ to tools/ * refactor: moved json-server-db.json to tools folder * Single Screen Interaction, Approve Button Fix and Code Cleanup (#9) * chore: organize code in playwright.keplr.js and remove not used states * chore: resolve merge conflicts with dev branch * chore: using a consistent and more intention revealing name for a helper function * chore: adding a test case for validating the switchToExtensionWindow function * chore: change selector for Approve button on connecting with wallet UI * chore: addressing PR comments * Interaction for transaction rejection (#12) * feat: added logic for transaction rejection * feat: added test for transaction rejection * fix: typo in test name * chore:remove call to switchToKeplrWindow in metamask.js (#16) * Abstracting Calls to Switching Extension in Keplr Helper Methods (#13) * chore: abstracting calls to switching to keplr window in keplr helper functions * chore: removing unnecessary awaits with sync function * Enable setup of the keplr extension in the beforeAll hook for cypress (#14) * fix: added code to handle setup of keplr wallet beforehand * chore: lint fixes * Add command to switch to another wallet (#18) * feat: interaction to switch wallet * chore: fixes for await async * Getting Wallet Address (#17) * feat: initial working setup for retrieving wallet address * chore:code cleanup * feat: interaction to switch wallet * chore: simplifying switching screens in import wallet flow * chore format code with prettier * chore: moving get wallet address test case in the main context * chore: fixes for await async * chore: address PR comments --------- Co-authored-by: Fraz Arshad <[email protected]> * Added Interaction to get the value of a certain token (#19) * feat: added command to get tokens * chore: await/async fixes * Updates to CI/CD flow (#20) * ci: new docker ci file for keplr * ci: using docker workflow instead of debug workflow temporarily * ci: updated config to have not retires in ci * Adding Selecting Chain Interaction And Flow Improvements (#21) * chore: changing the flow of test cases; starting by creating a new wallet rather than importing * feature: adding behavior in import wallet flow to select a chain when importing/creating wallet * feature: adding helper methods to click elements in a reliable way * chore: using helper methods inside keplr.js * chore: handling edge case for grabbing token values when values are large numbers containing commas * chore: updating selector for getting wallet address and adding test cases to validate the behavior * chore: addressing PR comments * chore: addressing PR comments * chore: replacing Agoric local with Agoric localhost * feat: included settings to setup npm (#22) * refactor: changed args for setupWallet (#24) * Added automatic linting to the repository (#23) * style:changing settings for linting * style: fixes to lint + styling throughout repo * Enabled CI Pipeline for NPM deployment (#25) * feat: release workflow enabled * feat: added CI cache folders to .npmignore * chore: revert back to master after testing * Fix for switching between keplr windows with same url (#27) * fix: checking added for window instance * test: test added for edge case * fix: added click after timeout to resolve flakiness (#28) * Updated README.md (#29) * docs: updated README.md * docs: added env section to readme * docs: 24 words memonics --------- Co-authored-by: duckception <[email protected]> Co-authored-by: Peter F <[email protected]> Co-authored-by: Piotr Frankowski <[email protected]> Co-authored-by: Rafał Majchrzak <[email protected]> Co-authored-by: rabi-siddique <[email protected]> Co-authored-by: Rabi Siddique <[email protected]>

feat: added command to get tokens

31e13e7

frazarshad requested a review from rabi-siddique March 5, 2024 17:32

frazarshad self-assigned this Mar 5, 2024

rabi-siddique reviewed Mar 6, 2024

View reviewed changes

chore: await/async fixes

a76baae

frazarshad merged commit d49d84e into dev Mar 6, 2024
1 of 2 checks passed

frazarshad deleted the feat/get-token-value branch March 6, 2024 06:29

rabi-siddique reviewed Mar 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Interaction to get the value of a certain token #19

Added Interaction to get the value of a certain token #19

frazarshad commented Mar 5, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

frazarshad Mar 6, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

frazarshad Mar 6, 2024

rabi-siddique Mar 6, 2024

frazarshad Mar 6, 2024

rabi-siddique Mar 6, 2024

rabi-siddique Mar 6, 2024

frazarshad Mar 6, 2024

rabi-siddique Mar 6, 2024

frazarshad Mar 6, 2024

rabi-siddique left a comment

Added Interaction to get the value of a certain token #19

Added Interaction to get the value of a certain token #19

Conversation

frazarshad commented Mar 5, 2024

Motivation and context

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rabi-siddique left a comment

Choose a reason for hiding this comment