react-hooks-testing-library icon indicating copy to clipboard operation
react-hooks-testing-library copied to clipboard

Fix #648: Add `setDefaultWaitOptions` function

Open michens opened this issue 4 years ago • 8 comments

What:

Fix for #648. Add setDefaultWaitOptions function

Why:

It simplifies configuration in environments where the defaults may not be optimal

How:

  • Created a function to override default time options
  • Added tests to ensure behavior mimics that of the per-call options
  • Re-exported at various levels to match existing patterns and ensure availability regardless of importing at the top level or for a specific renderer

Checklist:

  • [X] Documentation updated
  • [X] Tests
  • [X] Ready to be merged
  • [X] Added myself to contributors table

Had issues with docz. Needed to remove repo field from package.json and update glob pattern for files in doczrc.js to build updated documentation. These changes are not included as they presumably do not apply to the pipeline here

michens avatar Jul 26 '21 23:07 michens

Codecov Report

Merging #658 (90d0fe0) into main (a54eeb3) will not change coverage. The diff coverage is 100.00%.

:exclamation: Current head 90d0fe0 differs from pull request most recent head 62fa16d. Consider uploading reports for the commit 62fa16d to get more accurate results Impacted file tree graph

@@            Coverage Diff            @@
##              main      #658   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines          235       236    +1     
  Branches        33        33           
=========================================
+ Hits           235       236    +1     
Impacted Files Coverage Δ
src/core/index.ts 100.00% <ø> (ø)
src/dom/pure.ts 100.00% <ø> (ø)
src/native/pure.ts 100.00% <ø> (ø)
src/server/pure.ts 100.00% <ø> (ø)
src/core/asyncUtils.ts 100.00% <100.00%> (ø)
src/pure.ts 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a54eeb3...62fa16d. Read the comment docs.

codecov[bot] avatar Jul 27 '21 09:07 codecov[bot]

Thanks @orokanasaru for putting this together. Your comments about docz running on the PR pipeline made me wonder because I thought we had Netlify deploy preview running on All PR branches... Turns out that our Netlify config was never updated when we switched from master to main for our production branch and we haven't had any doc updates running since May! So thanks for highlighting that as well.

Unfortunately you're correct about the build issue for docz which appears to be an open issue for them. I'm reluctant to release a new feature without the accompanying documentation and I'm more reluctant to remove the repo field from the package.json to fix it, so I'm still looking for a way around this to get this in.

Honestly, this is not the first time docz has just randomly broken on us and I've been considering migrating the docs to something else for a while now. This may be the final trigger for it (we'll see how my investigation tonight into working around it goes).

I'll give the changes a review now anyway.

mpeyper avatar Jul 27 '21 10:07 mpeyper

I am also interested into a better workaround for that repo.browsetemplate.replace issue in docz.

silviuaavram avatar Jul 29 '21 07:07 silviuaavram

@silviuaavram sorry, I don't have any good news. I'm currently porting our docs over to docusaurus 🤷‍♂️

mpeyper avatar Jul 29 '21 07:07 mpeyper

Cool :). While doing this you could probably work around as I did now, https://github.com/doczjs/docz/issues/1635#issuecomment-888953896. Let me know if this works for you!

silviuaavram avatar Jul 29 '21 09:07 silviuaavram

Hi @orokanasaru, just checking in to see where you're at with this. Is it still something you want to pursue?

mpeyper avatar Aug 31 '21 11:08 mpeyper

@mpeyper, you said you did not want to release until you resolved the documentation issues. If that is no longer a blocker, I can return to finish this up

michens avatar Sep 01 '21 19:09 michens

@orokanasaru yeah, for sure.

What are your thoughts on the thread about resetting the values?

mpeyper avatar Sep 01 '21 20:09 mpeyper