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

[tech] Improve ignored doc-tests #783

Open
pbougue opened this issue May 20, 2021 · 0 comments
Open

[tech] Improve ignored doc-tests #783

pbougue opened this issue May 20, 2021 · 0 comments

Comments

@pbougue
Copy link
Contributor

pbougue commented May 20, 2021

After #782 (comment)
Some doc-tests are ignored, which is a shame.
The main point is that we want to avoid a heavy (compile-time) dependency for the gain (reqwest was removed for that, and deps on async frameworks are heavy).

We have 4 options on that :

  1. No http-client deps
    a. let it as-is (ignored)
    b. use file read + comment that it could be reqwest
  2. We can check https://blog.logrocket.com/the-state-of-rust-http-clients/ or https://users.rust-lang.org/t/lightweight-alternative-for-reqwest/33601/2 for lighter http clients (ureq, http_req).
    Or add reqwest (with some internal TLS support to avoid system deps?) back to check if it's OK for compile times.
    a. add dev-deps and remove ignore in tests
    b. add complete deps (and real url-read fn for convenience as it's the most common use case)

I will probably have a try on option 2.a (maybe not short-term), but if anyone wants to try some of the options listed or others, please do!

Also, any feedback from users outside Kisio Digital (ex-CanalTP) is more than welcome on the usefulness of this 🙏

@pbougue pbougue changed the title [tech] Improved ignored doc-tests [tech] Improve ignored doc-tests May 20, 2021
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

No branches or pull requests

1 participant