Skip to content
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.

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

Fix terminal command now return actual result from Selenium #4155

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dikwickley
Copy link
Contributor

@dikwickley dikwickley commented Mar 26, 2024

Fixes: #3899

Fixes: dikwickley/gsoc24#1

Solved this issue by keeping a special flag for terminal commands. Instead of returning WebElement, if there was an error thrown by Selenium that is passed.

Example Test:

describe('github.org Demo', function () {
  before((browser) => {
    browser.navigateTo('https://www.ecosia.org/settings');
  });

  it('Demo test ecosia.org', async function (browser) {
    // browser.element('.cookie-consent__actions').getLastElementChild().click();
    const saveButton = browser.element('.settings-form__buttons > .base-button--variant-solid-green');
    const res = await saveButton.click();

    console.log(res);
  });

  after((browser) => browser.end());
});

output:
Screenshot 2024-03-27 at 3 47 58 AM

Thanks in advance for your contribution. Please follow the below steps in submitting a pull request, as it will help us with reviewing it quicker.

  • Before marking your PR for review, please test and verify your changes by making appropriate modifications to any of the Nightwatch example tests (present in examples/tests directory of the project) and running them. ecosia.js and duckDuckGo.js are good examples to work with.
  • Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
  • If you're fixing a bug also create an issue if one doesn't exist yet;
  • If it's a new feature explain why do you think it's necessary. Please check with the maintainers beforehand to make sure it is something that we will accept. Usually we only accept new features if we feel that they will benefit the entire community;
  • Please avoid sending PRs which contain drastic or low level changes. If you are certain that the changes are needed, please discuss them beforehand and indicate what the impact will be;
  • If your change is based on existing functionality please consider refactoring first. Pull requests that duplicate code will most likely be ignored;
  • Do not include changes that are not related to the issue at hand;
  • Follow the same coding style with regards to spaces, semicolons, variable naming etc.;
  • Always add unit tests - PRs without tests are most of the times ignored.

Copy link

Status

  • ❌ No modified files found in the types directory.
    Please make sure to include types for any changes you have made. Thank you!.

@dikwickley
Copy link
Contributor Author

@garg3133 can you review this? thanks.

Copy link
Member

@garg3133 garg3133 left a comment

Choose a reason for hiding this comment

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

The error we get here should ideally be similar to what we get when using the old API commands likebrowser.click().

@@ -23,5 +23,5 @@
* @returns {ScopedWebElement}
*/
module.exports.command = function() {
return this.runQueuedCommand('clickElement');
return this.runQueuedCommand('clickElement', {isTerminal: true});
Copy link
Member

Choose a reason for hiding this comment

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

@dikwickley For this, we don't need to introduce any new flag because all terminal commands call this.runQueuedCommand() method so we can use that to make our changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, it seems it was redundant. Also I updated the return object to match with what we get from the old API commands (something in lines of)

{ error:..., message:....., stack:....}
Screenshot 2024-05-19 at 6 06 40 PM

@dikwickley dikwickley requested a review from garg3133 May 19, 2024 12:38
@dikwickley dikwickley force-pushed the issue/3899-actual-error-on-terminal-command branch from e381fd6 to 46a24ce Compare October 15, 2024 17:13
@dikwickley dikwickley force-pushed the issue/3899-actual-error-on-terminal-command branch from 46a24ce to 0c45852 Compare October 15, 2024 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants