Job builder

Cargo.toml

@@ -33,6 +33,7 @@ fnv = "1.0.5"
 native-tls = { version = "0.2", optional = true }
 clap = { version = "3.1.0", optional = true }
 thiserror = "1.0.30"
+derive_builder = "0.12.0"
 
 [dev-dependencies]
 mockstream = "0.0.3"

src/bin/loadtest.rs

@@ -70,12 +70,26 @@ fn main() {
                 for idx in 0..jobs {
                     if idx % 2 == 0 {
                         // push
-                        let mut job = Job::new(
-                            "SomeJob",
-                            vec![serde_json::Value::from(1), "string".into(), 3.into()],
-                        );
-                        job.priority = Some(rng.gen_range(1..10));
-                        job.queue = QUEUES.choose(&mut rng).unwrap().to_string();
+                        let job = match idx % 4 {
+                            // Solely to demo how 'JobBuilder' works in userland
+                            0 => JobBuilder::default()
+                                .kind("SomeJob")
+                                .args(vec![serde_json::Value::from(1), "string".into(), 3.into()])
+                                .priority(Some(rng.gen_range(1..10)))
+                                .queue(QUEUES.choose(&mut rng).unwrap().to_string())
+                                .build()
+                                .unwrap(),
+                            _ => {
+                                let mut job = Job::new(
+                                    "SomeJob",
+                                    vec![serde_json::Value::from(1), "string".into(), 3.into()],
+                                );
+                                job.priority = Some(rng.gen_range(1..10));
+                                job.queue = QUEUES.choose(&mut rng).unwrap().to_string();
+                                job
+                            }
+                        };
+
                         p.enqueue(job)?;
                         if pushed.fetch_add(1, atomic::Ordering::SeqCst) >= jobs {
                             return Ok(idx);

src/error.rs

@@ -12,6 +12,9 @@
 //! [`Protocol`] describes lower-level errors relating to communication
 //! with the faktory server. Typically, [`Protocol`] errors are the result
 //! of the server sending a response this client did not expect.
+//!
+//! [`Client`] describes errors that occur even before submitting a job to the server, e.g.
+//! errors when building a 'Job' (missing required fields, invalid values).
 
 use thiserror::Error;
 
@@ -22,7 +25,11 @@ pub enum Error {
     /// The connection to the server, or one of its prerequisites, failed.
     #[error("connection")]
     Connect(#[from] Connect),
-
+    /// Client-side errors.
+    ///
+    /// These are errors arising even before submitting a job to the server, e.g. malformed job.
+    #[error("client")]
+    Client(#[from] Client),
     /// Underlying I/O layer errors.
     ///
     /// These are overwhelmingly network communication errors on the socket connection to the server.
@@ -82,6 +89,18 @@ pub enum Connect {
     ParseUrl(#[source] url::ParseError),
 }
 
+/// Errors happening client side
+#[derive(Debug, Error)]
+#[non_exhaustive]
+pub enum Client {
+    /// The 'Job' is malformed.
+    #[error("job is malformed: {desc}")]
+    MalformedJob {
+        /// Details on what is missing or incorrect about the 'Job'
+        desc: String,
+    },
+}
+
 /// The set of observable application-level errors when interacting with a Faktory server.
 #[derive(Debug, Error)]
 #[non_exhaustive]

src/lib.rs

@@ -73,5 +73,5 @@ pub use tls::TlsStream;
 pub use crate::consumer::{Consumer, ConsumerBuilder};
 pub use crate::error::Error;
 pub use crate::producer::Producer;
-pub use crate::proto::Job;
 pub use crate::proto::Reconnect;
+pub use crate::proto::{Job, JobBuilder};

src/proto/mod.rs

@@ -11,7 +11,9 @@ pub(crate) const EXPECTED_PROTOCOL_VERSION: usize = 2;
 mod single;
 
 // commands that users can issue
-pub use self::single::{Ack, Fail, Heartbeat, Info, Job, Push, QueueAction, QueueControl};
+pub use self::single::{
+    Ack, Fail, Heartbeat, Info, Job, JobBuilder, Push, QueueAction, QueueControl,
+};
 
 // responses that users can see
 pub use self::single::Hi;