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

Improve serde error output #982

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Conversation

konstin
Copy link
Contributor

@konstin konstin commented Oct 18, 2024

In our tests using the serde impl on Url, we found that failing URL serialization says the inverse of what it should say.

[project]
name = "foo"
version = "0.0.0"
dependencies = [
  "tqdm ==4.66.0",
]
[tool.uv.sources]
tqdm = { url = "§invalid#+#*Ä" }
error: Failed to parse: `pyproject.toml`
  Caused by: TOML parse error at line 10, column 16
   |
10 | tqdm = { url = "§invalid#+#*Ä" }
   |                ^^^^^^^^^^^^^^^^^
invalid value: string "§invalid#+#*Ä", expected relative URL without a base

It says that expected a relative URL without a base, when this was the unexpected input that caused the error. Using serde::de::Error::custom oder serde::de::Error::invalid_value improves the error message:

error: TOML parse error at line 8, column 16
  |
8 | tqdm = { url = "§invalid#+#*Ä" }
  |                ^^^^^^^^^^^^^^^^^
relative URL without a base: "§invalid#+#*Ä"

In our tests using the serde impl on `Url`, we found that failing URL serialization says the inverse of what it should say.

```toml
[project]
name = "foo"
version = "0.0.0"
dependencies = [
  "tqdm ==4.66.0",
]
[tool.uv.sources]
tqdm = { url = "§invalid#+#*Ä" }
```

```
error: Failed to parse: `pyproject.toml`
  Caused by: TOML parse error at line 10, column 16
   |
10 | tqdm = { url = "§invalid#+#*Ä" }
   |                ^^^^^^^^^^^^^^^^^
invalid value: string "§invalid#+#*Ä", expected relative URL without a base
```

It says that expected a relative URL without a base, when this was the unexpected input that caused the error. Using `serde::de::Error::custom` oder `serde::de::Error::invalid_value` improves the error message:

```
error: TOML parse error at line 8, column 16
  |
8 | tqdm = { url = "§invalid#+#*Ä" }
  |                ^^^^^^^^^^^^^^^^^
relative URL without a base: "§invalid#+#*Ä"
```
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@ebd5cfb). Learn more about missing BASE report.

Files with missing lines Patch % Lines
url/src/lib.rs 0.00% 3 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #982   +/-   ##
=======================================
  Coverage        ?   82.35%           
=======================================
  Files           ?       22           
  Lines           ?     3559           
  Branches        ?        0           
=======================================
  Hits            ?     2931           
  Misses          ?      628           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@valenting valenting added this pull request to the merge queue Oct 28, 2024
Merged via the queue into servo:main with commit 5d363cc Oct 28, 2024
14 checks passed
@konstin konstin deleted the konsti/serde-error-variant branch October 28, 2024 13:16
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Nov 5, 2024
Bumps url from 2.5.2 to 2.5.3.

Release notes
Sourced from url's releases.

v2.5.3
What's Changed

fix: enable wasip2 feature for wasm32-wasip2 target by @​brooksmtownsend in servo/rust-url#960
Fix idna tests with no_std by @​cjwatson in servo/rust-url#963
Fix debugger_visualizer test failures. by @​valenting in servo/rust-url#967
Add AsciiSet::EMPTY and boolean operators by @​joshka in servo/rust-url#969
mention why we pin unicode-width by @​Manishearth in servo/rust-url#972
refactor and add tests for percent encoding by @​joshka in servo/rust-url#977
Add a test for and fix issue #974 by @​hansl in servo/rust-url#975
no_std support for the url crate by @​domenukk in servo/rust-url#831
Normalize URL paths: convert /.//p, /..//p, and //p to p by @​theskim in servo/rust-url#943
support Hermit by @​m-mueller678 in servo/rust-url#985
fix: support wasm32-wasip2 on the stable channel by @​brooksmtownsend in servo/rust-url#983
Improve serde error output by @​konstin in servo/rust-url#982
OSS-Fuzz: Add more fuzzer by @​arthurscchan in servo/rust-url#988
Merge idna-v1x to main by @​hsivonen in servo/rust-url#990

New Contributors

@​brooksmtownsend made their first contribution in servo/rust-url#960
@​cjwatson made their first contribution in servo/rust-url#963
@​joshka made their first contribution in servo/rust-url#969
@​hansl made their first contribution in servo/rust-url#975
@​theskim made their first contribution in servo/rust-url#943
@​m-mueller678 made their first contribution in servo/rust-url#985
@​konstin made their first contribution in servo/rust-url#982
@​arthurscchan made their first contribution in servo/rust-url#988

Full Changelog: servo/[email protected]



Commits

8a683ff Merge idna-v1x to main (#990)
08a3268 OSS-Fuzz: Add more fuzzers (#988)
5d363cc Improve serde error output (#982)
30e6258 fix: support wasm32-wasip2 on stable channel (#983)
bf089c4 support hermit (#985)
b08a655 Normalize URL paths: convert /.//p, /..//p, and //p to p (#943)
ebd5cfb no_stdsupport for the url crate (#831)
7eccac9 Add a test for and fix issue #974 (#975)
710e1e7 refactor and add tests for percent encoding (#977)
6050a6e mention why we pin unicode-width (#972)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
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.

2 participants