Transition to `std::error::Error`; minor cleanup by jssblck · Pull Request #28 · jonhoo/faktory-rs

jssblck · 2022-04-19T01:43:39Z

Closes #8
Closes #27

This is a breaking change.

Removes failure, and in its place implements errors as standard enums compatible with std::error::Error, powered by thiserror.
Also includes some minor cleanup and reorganization:

The top-level crate now exposes faktory::error::ProtocolError, which is the old FaktoryError type, and faktory::error::Error, which is all possible errors returned by the crate (one of which is faktory::error::ProtocolError).
Errors under producer and consumer now return the top-level faktory::error::Error type (this solves Use error type instead of using catch all failure::Error in Producer::con #8).
I also made Job.failure into pub, instead of pub(crate); I did this because clippy was complaining that it's unused. If you disagree happy to change it back.
I made a couple other minor edits based on clippy recommendations.

This change is

codecov · 2022-04-19T01:46:43Z

Codecov Report

Merging #28 (9cbbced) into master (a3524c8) will decrease coverage by 2.15%.
The diff coverage is 64.81%.

@@            Coverage Diff             @@
##           master      #28      +/-   ##
==========================================
- Coverage   85.09%   82.93%   -2.16%     
==========================================
  Files          12       12              
  Lines         966      932      -34     
==========================================
- Hits          822      773      -49     
- Misses        144      159      +15

Impacted Files	Coverage Δ
src/consumer/mod.rs	`69.04% <0.00%> (-0.84%)`	⬇️
src/error.rs	`63.63% <0.00%> (+9.09%)`	⬆️
src/producer/mod.rs	`76.19% <ø> (-4.77%)`	⬇️
src/proto/single/mod.rs	`80.00% <0.00%> (-5.72%)`	⬇️
src/tls.rs	`0.00% <0.00%> (ø)`
tests/consumer.rs	`100.00% <ø> (ø)`
tests/mock/mod.rs	`100.00% <ø> (+6.81%)`	⬆️
tests/real.rs	`100.00% <ø> (ø)`
src/proto/mod.rs	`68.14% <16.66%> (-1.39%)`	⬇️
src/proto/single/resp.rs	`80.27% <58.82%> (-14.38%)`	⬇️
... and 11 more

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 a3524c8...9cbbced. Read the comment docs.

This makes imports for clients using this library more clear.

jssblck · 2022-04-19T02:01:28Z

The codecov regression is due to the fact that we now have more explicit errors instead of sticking them in a catch-all type; I don't think this is an actual coverage regression. For that reason I'd like to request we overlook this, but if you disagree let me know and I can look for ways to explicitly test the new explicit error cases.

jonhoo

Thanks for taking this on! These are a great set of changes. I've left some mostly minor notes inline. And yes, happy to overlook the coverage change.

src/error.rs

src/proto/mod.rs

src/proto/single/cmd.rs

src/proto/single/mod.rs

src/proto/single/resp.rs

jssblck · 2022-04-24T18:33:28Z

@jonhoo thanks for the great review! I think I addressed everything 😄

jssblck · 2022-04-25T16:59:31Z

src/proto/single/mod.rs

+    /// Data about this job's most recent failure.
+    pub fn failure(&self) -> &Option<Failure> {
+        &self.failure
+    }


I think this is the minimal set of changes I wanted to include in this PR, and only did when forced to by clippy, so Failure is still unusable. I'm happy to commit to coming back in another PR to make Failure useful, or put it into this one if preferred.

Let's do that in a separate PR then, thanks 👍

jonhoo

We're very nearly there!

src/proto/mod.rs

jonhoo · 2022-04-30T17:22:24Z

src/proto/single/mod.rs

+    /// Data about this job's most recent failure.
+    pub fn failure(&self) -> &Option<Failure> {
+        &self.failure
+    }


Let's do that in a separate PR then, thanks 👍

src/proto/single/resp.rs

src/error.rs

src/proto/single/cmd.rs

src/proto/single/resp.rs

src/proto/single/cmd.rs

jonhoo

Just a few minor nits left and then we're there 🎉

jonhoo · 2022-05-14T18:10:37Z

Thanks for sticking with this! I'll release it as a .beta initially, and then in a week or two we can promote to a full release — how does that sound?

jonhoo · 2022-05-14T18:14:17Z

Released as 0.12.0-beta.1 🎉

jssblck · 2022-05-17T17:15:11Z

Thanks for sticking with this! I'll release it as a .beta initially, and then in a week or two we can promote to a full release — how does that sound?

Sounds great!

jonhoo · 2022-05-28T17:34:50Z

Published 0.12.0-beta.1 as 0.12.0!

jssblck added 2 commits April 18, 2022 18:29

Transition to proper errors; minor cleanup

b9d0ae9

Minor cleanup

782d734

jssblck added 3 commits April 18, 2022 18:51

Fix native-tls oversight.

610002a

Oh, and make faktory::Error nonexhaustive

f8d8a92

Protocol -> ProtocolError

4673dbe

This makes imports for clients using this library more clear.

jssblck mentioned this pull request Apr 19, 2022

Open to replacing failure with thiserror? #27

Closed

jonhoo requested changes Apr 24, 2022

View reviewed changes

jssblck added 4 commits April 24, 2022 11:24

PR comments

0752135

Add #[non_exhaustive] to Connect

a8501c9

Revert change to Job.failure visibility

34fb942

Minor import cleanup

12d11b1

jssblck requested a review from jonhoo April 24, 2022 18:33

Make Job.failure getter so clippy is happy

65082b9

jssblck commented Apr 25, 2022

View reviewed changes

jonhoo requested changes Apr 30, 2022

View reviewed changes

jssblck added 7 commits May 1, 2022 07:38

use crate::error::{self, Error}

fcc671f

Code format comment

8e2e0a7

I/O

d3711c7

DeserializePayload: #[from] -> #[source]

b563ed7

DeserializePayload -> Serialization

1a9ff9d

TlsStram: #[from] -> #[source]

541292e

Missed IO -> I/O

c6f2bbe

jssblck commented May 1, 2022

View reviewed changes

src/proto/single/cmd.rs Outdated Show resolved Hide resolved

Self-review cleanup

f3869a2

jssblck requested a review from jonhoo May 1, 2022 15:12

jonhoo reviewed May 7, 2022

View reviewed changes

src/proto/single/resp.rs Outdated Show resolved Hide resolved

src/proto/single/cmd.rs Outdated Show resolved Hide resolved

jonhoo requested changes May 7, 2022

View reviewed changes

jssblck added 2 commits May 10, 2022 14:22

Fix overzealous find and replace 😭

feb9dfd

PR comments

9cbbced

jssblck requested a review from jonhoo May 10, 2022 21:29

jonhoo approved these changes May 14, 2022

View reviewed changes

jonhoo merged commit 25883da into jonhoo:master May 14, 2022

Conversation

jssblck commented Apr 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jssblck commented Apr 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonhoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jssblck commented Apr 24, 2022

Uh oh!

jssblck Apr 25, 2022

Choose a reason for hiding this comment

Uh oh!

jonhoo Apr 30, 2022

Choose a reason for hiding this comment

Uh oh!

jonhoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jonhoo Apr 30, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonhoo left a comment

Choose a reason for hiding this comment

Uh oh!

jonhoo commented May 14, 2022

Uh oh!

jonhoo commented May 14, 2022

Uh oh!

jssblck commented May 17, 2022

Uh oh!

jonhoo commented May 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

jssblck commented Apr 19, 2022 •

edited

Loading

codecov bot commented Apr 19, 2022 •

edited

Loading

jssblck commented Apr 19, 2022 •

edited

Loading