Use thiserror for credential provider errors #12424

arlosi · 2023-07-31T18:13:04Z

What does this PR try to resolve?

Errors from credential providers currently must a single string. This leads to a lot of .map_err(|e|cargo_credential::Error::Other(e.to_string()), which loses the source() of these errors.

This changes the cargo_credential::Error to use thiserror and adds a custom serialization for std::error::Error that preserves the source error chain across serialization / deserialization.

A unit test is added to verify serialization / deserialization.

rustbot · 2023-07-31T18:13:08Z

r? @epage

(rustbot has picked a reviewer for you, use r? to override)

credential/cargo-credential/Cargo.toml

credential/cargo-credential/src/error.rs

credential/cargo-credential/src/lib.rs

epage · 2023-07-31T18:39:56Z

credential/cargo-credential/src/error.rs

+/// `UrlNotSupported` and `NotFound` errors both cause Cargo
+/// to attempt another provider, if one is available. The other 
+/// variants are fatal.


By making it easier to use, a part of me worries that we are making it harder to correctly report the right error variant.

The way I've handled this in the error codes for my CLI is to have a sloppy error type for the implementation of each function call in main and then have a more constrained error type with explicit conversions used by main. This does require the structure of the code to align well with the error variants.

Thanks. I'm definitely open to feedback on improving this.

Since it will be implemented by external crates, it's hard to know up front what all the variants should be. In the original implementation, I tried to anticipate the common ones and add variants, but in this change I decided to reduce the number of variants and have an Other case.

I'm not quite sure what you're suggesting here. Removing some of the From impls that convert to Other and requiring explicit conversions?

I'm not quite sure what you're suggesting here. Removing some of the From impls that convert to Other and requiring explicit conversions?

Not quite a suggestion but effectively yes. Phrased differently: "I'm looking for input on whether we should reduce From impls to encourage explicit conversions so people are more likely to specify the correct error semantics".

I made changes to remove the From impls for serde::Error and io::Error and added more error contexts.

To be clear, I wasn't saying it had to be done but was wanting to make sure we made a conscious decision. If this is what you feel is best great. If not, feel free to say so.

epage

Thanks! Overall, I appreciate how much this cleans up the code

epage · 2023-07-31T21:56:59Z

credential/cargo-credential/src/error.rs

+    /// A new variant was added to this enum since Cargo was built
+    #[error("unknown error kind; try updating Cargo?")]
+    #[serde(other)]
+    Unknown,
 }


nit: was this meant to be part of the next commit?

epage · 2023-07-31T21:57:03Z

credential/cargo-credential/src/error.rs

+    #[test]
+    pub fn unknown_kind() {
+        let json = r#"{
+            "kind": "unexpected-kind",
+            "unexpected-content": "test"
+          }"#;
+        let e: Error = serde_json::from_str(&json).unwrap();
+        assert!(matches!(e, Error::Unknown));
+    }


nit: was this meant to be part of the next commit?

epage · 2023-07-31T22:00:35Z

Overall, I'm fine with it as-is and leave it to arlosi if any of the remaining points are changed.

@bors r=arlosi

bors · 2023-07-31T22:00:36Z

📌 Commit 70b584e has been approved by arlosi

It is now in the queue for this repository.

bors · 2023-07-31T22:00:44Z

⌛ Testing commit 70b584e with merge 29a6f2f...

epage · 2023-07-31T22:01:04Z

@bors cancel

I got the command wrong. Feel free to r= me

bors · 2023-07-31T22:59:13Z

☀️ Test successful - checks-actions
Approved by: arlosi
Pushing 29a6f2f to master...

Update cargo 8 commits in c91a693e7977e33a1064b63a5daf5fb689f01651..6dc1deaddf62c7748c9097c7ea88e9ec77ff1a1a 2023-07-31 00:26:46 +0000 to 2023-08-02 00:23:54 +0000 - `#[allow(internal_features)]` in RUSTC_BOOTSTRAP test (rust-lang/cargo#12429) - ci: rewrite bump check and respect semver (rust-lang/cargo#12395) - fix(update): Tweak CLI behavior (rust-lang/cargo#12428) - chore(deps): update compatible (rust-lang/cargo#12426) - Display crate version on timings graph (rust-lang/cargo#12420) - chore(deps): update alpine docker tag to v3.18 (rust-lang/cargo#12427) - Use thiserror for credential provider errors (rust-lang/cargo#12424) - Clarify in `--help` that `cargo test --all-targets` excludes doctests (rust-lang/cargo#12422) r? `@ghost`

Update cargo 8 commits in c91a693e7977e33a1064b63a5daf5fb689f01651..6dc1deaddf62c7748c9097c7ea88e9ec77ff1a1a 2023-07-31 00:26:46 +0000 to 2023-08-02 00:23:54 +0000 - `#[allow(internal_features)]` in RUSTC_BOOTSTRAP test (rust-lang/cargo#12429) - ci: rewrite bump check and respect semver (rust-lang/cargo#12395) - fix(update): Tweak CLI behavior (rust-lang/cargo#12428) - chore(deps): update compatible (rust-lang/cargo#12426) - Display crate version on timings graph (rust-lang/cargo#12420) - chore(deps): update alpine docker tag to v3.18 (rust-lang/cargo#12427) - Use thiserror for credential provider errors (rust-lang/cargo#12424) - Clarify in `--help` that `cargo test --all-targets` excludes doctests (rust-lang/cargo#12422) r? ``@ghost``

Update cargo 10 commits in c91a693e7977e33a1064b63a5daf5fb689f01651..020651c52257052d28f6fd83fbecf5cfa1ed516c 2023-07-31 00:26:46 +0000 to 2023-08-02 16:00:37 +0000 - Update rustix to 0.38.6 (rust-lang/cargo#12436) - replace `master` branch by default branch in documentation (rust-lang/cargo#12435) - `#[allow(internal_features)]` in RUSTC_BOOTSTRAP test (rust-lang/cargo#12429) - ci: rewrite bump check and respect semver (rust-lang/cargo#12395) - fix(update): Tweak CLI behavior (rust-lang/cargo#12428) - chore(deps): update compatible (rust-lang/cargo#12426) - Display crate version on timings graph (rust-lang/cargo#12420) - chore(deps): update alpine docker tag to v3.18 (rust-lang/cargo#12427) - Use thiserror for credential provider errors (rust-lang/cargo#12424) - Clarify in `--help` that `cargo test --all-targets` excludes doctests (rust-lang/cargo#12422) r? `@ghost`

rustbot assigned epage Jul 31, 2023

rustbot added A-registry-authentication Area: registry authentication and authorization (authn authz) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 31, 2023

arlosi commented Jul 31, 2023

View reviewed changes

credential/cargo-credential/Cargo.toml Show resolved Hide resolved

epage reviewed Jul 31, 2023

View reviewed changes

credential/cargo-credential/src/error.rs Show resolved Hide resolved

epage reviewed Jul 31, 2023

View reviewed changes

credential/cargo-credential/src/error.rs Outdated Show resolved Hide resolved

epage reviewed Jul 31, 2023

View reviewed changes

credential/cargo-credential/src/lib.rs Show resolved Hide resolved

epage reviewed Jul 31, 2023

View reviewed changes

arlosi added 2 commits July 31, 2023 13:44

Add serde(default) to cargo-credential RegistryInfo headers

5321146

Use thiserror for credential provider errors

a81d558

arlosi force-pushed the credential-thiserror branch from 7fdf273 to a81d558 Compare July 31, 2023 18:56

arlosi added 2 commits July 31, 2023 16:10

Remove from impls

7918c7f

Add serde(other) to credential protocol enums for future proofing

70b584e

epage reviewed Jul 31, 2023

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 31, 2023

bors merged commit 29a6f2f into rust-lang:master Jul 31, 2023
20 checks passed

weihanglo mentioned this pull request Aug 2, 2023

Update cargo rust-lang/rust#114364

Merged

ehuss added this to the 1.73.0 milestone Aug 22, 2023

ehuss mentioned this pull request Sep 7, 2023

Tracking Issue for credential-process RFC 2730 #8933

Closed

16 tasks

weihanglo mentioned this pull request Nov 27, 2023

refactor: use custom error instead of anyhow #13050

Merged

weihanglo mentioned this pull request Dec 19, 2023

refactor: custom error types for cargo-util-schemas #13186

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use thiserror for credential provider errors #12424

Use thiserror for credential provider errors #12424

arlosi commented Jul 31, 2023

rustbot commented Jul 31, 2023

epage Jul 31, 2023

arlosi Jul 31, 2023

epage Jul 31, 2023

arlosi Jul 31, 2023

epage Jul 31, 2023

epage left a comment

epage Jul 31, 2023

epage Jul 31, 2023

epage commented Jul 31, 2023

bors commented Jul 31, 2023

bors commented Jul 31, 2023

epage commented Jul 31, 2023

bors commented Jul 31, 2023

Use thiserror for credential provider errors #12424

Use thiserror for credential provider errors #12424

Conversation

arlosi commented Jul 31, 2023

What does this PR try to resolve?

rustbot commented Jul 31, 2023

epage Jul 31, 2023

Choose a reason for hiding this comment

arlosi Jul 31, 2023

Choose a reason for hiding this comment

epage Jul 31, 2023

Choose a reason for hiding this comment

arlosi Jul 31, 2023

Choose a reason for hiding this comment

epage Jul 31, 2023

Choose a reason for hiding this comment

epage left a comment

Choose a reason for hiding this comment

epage Jul 31, 2023

Choose a reason for hiding this comment

epage Jul 31, 2023

Choose a reason for hiding this comment

epage commented Jul 31, 2023

bors commented Jul 31, 2023

bors commented Jul 31, 2023

epage commented Jul 31, 2023

bors commented Jul 31, 2023