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

Add actionable error message for TimeoutError in hooks. #4053

Conversation

dikwickley
Copy link
Contributor

@dikwickley dikwickley commented Feb 26, 2024

fixes: #4031
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.

  • 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.

@dikwickley
Copy link
Contributor Author

dikwickley commented Feb 26, 2024

output:
this will only show the help message in case of hooks as the error message is added when callback is created in _basehook.

@garg3133 this is ready for review

image

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!.

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.

Looks good!

lib/testsuite/hooks/_basehook.js Outdated Show resolved Hide resolved
@garg3133
Copy link
Member

One suggestion: While writing the commit messages, try to use the imperative style of writing: https://git.kernel.org/pub/scm/git/git.git/tree/Documentation/SubmittingPatches?h=v2.36.1#n181

Co-authored-by: Priyansh Garg <priyanshgarg30@gmail.com>
@dikwickley
Copy link
Contributor Author

One suggestion: While writing the commit messages, try to use the imperative style of writing: https://git.kernel.org/pub/scm/git/git.git/tree/Documentation/SubmittingPatches?h=v2.36.1#n181

Thanks @garg3133 will keep that in mind for future commits.

@garg3133 garg3133 changed the title added a help message in case when async hook timesout. Add actionable error message for TimeoutError in hooks. Feb 26, 2024
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.

@AutomatedTester This is ready to be merged.

@gravityvi gravityvi merged commit ae23267 into nightwatchjs:main Feb 26, 2024
17 checks passed
@garg3133
Copy link
Member

Congrats @dikwickley on your first PR merge in the project 🎉

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.

Add actionable message in async hook timeout error.
3 participants