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 #4223: Restrict suppressNotFoundErrors to NoSuchElementError #4294

Merged

Conversation

Vaibhavsahu2810
Copy link
Contributor

@Vaibhavsahu2810 Vaibhavsahu2810 commented Nov 8, 2024

Description

This pull request addresses issue #4223. The suppressNotFoundErrors property in the new Element API previously suppressed all errors encountered by the WebDriver, including errors like InvalidSelectorError. This behavior was unintended, as suppressNotFoundErrors should ideally only suppress NoSuchElementError.

Changes Made

Updated scoped-element.js to catch and handle NoSuchElementError specifically when suppressNotFoundErrors is enabled.
Modified the logic to allow other errors, like InvalidSelectorError, to propagate as expected.

Steps to Reproduce the Issue

Use an invalid selector in a test command:
await browser.element.find({
selector: '@something',
suppressNotFoundErrors: true
});
Observe that InvalidSelectorError is no longer suppressed and propagates as intended.

Proof of Work

Terminal Output
The attached screenshot shows the updated terminal output, where an InvalidSelectorError is correctly thrown when an invalid selector is provided.
Screenshot 2024-11-09 at 1 04 26 AM

Unit Test
A unit test was added to ecosia.js to validate this behavior. The test checks that an invalid selector throws InvalidSelectorError instead of suppressing it.
Screenshot 2024-11-09 at 1 04 50 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.

  • [x ] 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.
  • [ x] Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
  • [x ] If you're fixing a bug also create an issue if one doesn't exist yet;
  • [x ] 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;
  • [x ] 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;
  • [x ] 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.

@CLAassistant
Copy link

CLAassistant commented Nov 8, 2024

CLA assistant check
All committers have signed the CLA.

@garg3133
Copy link
Member

Once this is fixed, the next step would be to provide more information along with the error so that the user can easily figure out where this error is coming from. In its current state, the error itself does not tell anything about its origin and which command/selector went wrong.

image

@Vaibhavsahu2810
Copy link
Contributor Author

@garg3133 is this okay now, I have made all the changes that are needed
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.

@Vaibhavsahu2810 Yes, it does look good now.

lib/api/web-element/scoped-element.js Outdated Show resolved Hide resolved
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!.

@garg3133 garg3133 merged commit 2f9fcf8 into nightwatchjs:main Nov 27, 2024
17 checks passed
@garg3133
Copy link
Member

Merged after adding a few tests, thanks @Vaibhavsahu2810!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants