From 2968ba5360c19a1dfdd1af09641c485062a16f92 Mon Sep 17 00:00:00 2001 From: asonix Date: Thu, 23 May 2019 22:25:00 -0500 Subject: [PATCH] Drop tokio --- Cargo.toml | 12 +- examples/server-jobs-example/.env | 1 - examples/server-jobs-example/.gitignore | 1 - examples/server-jobs-example/Cargo.toml | 19 - .../server-jobs-example/src/bin/server.rs | 37 - .../server-jobs-example/src/bin/spawner.rs | 43 -- .../src/bin/sync_spawner.rs | 41 -- .../server-jobs-example/src/bin/worker.rs | 35 - examples/server-jobs-example/src/lib.rs | 77 -- jobs-actix/src/lib.rs | 12 +- jobs-actix/src/worker.rs | 8 +- jobs-core/src/job.rs | 2 +- jobs-core/src/processor.rs | 2 +- jobs-core/src/processor_map.rs | 6 +- jobs-server/Cargo.toml | 35 - jobs-server/LICENSE | 674 ------------------ jobs-server/src/lib.rs | 161 ----- jobs-server/src/server/mod.rs | 209 ------ jobs-server/src/server/portmap.rs | 126 ---- jobs-server/src/server/pull.rs | 187 ----- jobs-server/src/server/push.rs | 193 ----- jobs-server/src/server/stalled.rs | 78 -- jobs-server/src/spawner.rs | 130 ---- jobs-server/src/worker/config.rs | 228 ------ jobs-server/src/worker/mod.rs | 189 ----- jobs-server/src/worker/portmap.rs | 59 -- 26 files changed, 16 insertions(+), 2549 deletions(-) delete mode 100644 examples/server-jobs-example/.env delete mode 100644 examples/server-jobs-example/.gitignore delete mode 100644 examples/server-jobs-example/Cargo.toml delete mode 100644 examples/server-jobs-example/src/bin/server.rs delete mode 100644 examples/server-jobs-example/src/bin/spawner.rs delete mode 100644 examples/server-jobs-example/src/bin/sync_spawner.rs delete mode 100644 examples/server-jobs-example/src/bin/worker.rs delete mode 100644 examples/server-jobs-example/src/lib.rs delete mode 100644 jobs-server/Cargo.toml delete mode 100644 jobs-server/LICENSE delete mode 100644 jobs-server/src/lib.rs delete mode 100644 jobs-server/src/server/mod.rs delete mode 100644 jobs-server/src/server/portmap.rs delete mode 100644 jobs-server/src/server/pull.rs delete mode 100644 jobs-server/src/server/push.rs delete mode 100644 jobs-server/src/server/stalled.rs delete mode 100644 jobs-server/src/spawner.rs delete mode 100644 jobs-server/src/worker/config.rs delete mode 100644 jobs-server/src/worker/mod.rs delete mode 100644 jobs-server/src/worker/portmap.rs diff --git a/Cargo.toml b/Cargo.toml index bca5ead..bf1f45f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -13,25 +13,15 @@ edition = "2018" members = [ "jobs-actix", "jobs-core", - "jobs-server", - "examples/server-jobs-example", ] [features] -default = ["background-jobs-server", "background-jobs-server/tokio-zmq"] -no_unix = ["background-jobs-server", "background-jobs-server/futures-zmq"] -actix = ["background-jobs-actix"] +default = ["background-jobs-actix"] [dependencies.background-jobs-core] version = "0.4" path = "jobs-core" -[dependencies.background-jobs-server] -version = "0.4" -path = "jobs-server" -default-features = false -optional = true - [dependencies.background-jobs-actix] version = "0.5" path = "jobs-actix" diff --git a/examples/server-jobs-example/.env b/examples/server-jobs-example/.env deleted file mode 100644 index a6ece83..0000000 --- a/examples/server-jobs-example/.env +++ /dev/null @@ -1 +0,0 @@ -RUST_LOG=info diff --git a/examples/server-jobs-example/.gitignore b/examples/server-jobs-example/.gitignore deleted file mode 100644 index ac25cf6..0000000 --- a/examples/server-jobs-example/.gitignore +++ /dev/null @@ -1 +0,0 @@ -example-db diff --git a/examples/server-jobs-example/Cargo.toml b/examples/server-jobs-example/Cargo.toml deleted file mode 100644 index e6da61a..0000000 --- a/examples/server-jobs-example/Cargo.toml +++ /dev/null @@ -1,19 +0,0 @@ -[package] -name = "server-jobs-example" -version = "0.1.0" -authors = ["asonix "] -edition = "2018" - -[dependencies] -dotenv = "0.13" -env_logger = "0.5" -failure = "0.1" -futures = "0.1" -log = "0.4" -serde = "1.0" -serde_derive = "1.0" -tokio = "0.1" - -[dependencies.background-jobs] -version = "0.5" -path = "../.." diff --git a/examples/server-jobs-example/src/bin/server.rs b/examples/server-jobs-example/src/bin/server.rs deleted file mode 100644 index df0c7c2..0000000 --- a/examples/server-jobs-example/src/bin/server.rs +++ /dev/null @@ -1,37 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use background_jobs::ServerConfig; -use failure::Error; -use server_jobs_example::queue_set; - -fn main() -> Result<(), Error> { - dotenv::dotenv().ok(); - env_logger::init(); - - tokio::run(ServerConfig::init( - 1, - "127.0.0.1", - 5555, - queue_set(), - "example-db", - )); - - Ok(()) -} diff --git a/examples/server-jobs-example/src/bin/spawner.rs b/examples/server-jobs-example/src/bin/spawner.rs deleted file mode 100644 index b4126c9..0000000 --- a/examples/server-jobs-example/src/bin/spawner.rs +++ /dev/null @@ -1,43 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use background_jobs::SpawnerConfig; -use futures::{future::lazy, Future}; -use server_jobs_example::{MyJob, MyProcessor}; - -fn main() { - dotenv::dotenv().ok(); - env_logger::init(); - - let (_, _, jobs) = (1..50).fold((0, 1, Vec::new()), |(x, y, mut acc), _| { - acc.push(MyJob::new(x, y)); - - (y, x + y, acc) - }); - - let spawner = SpawnerConfig::new("localhost", 5555); - - tokio::run(lazy(move || { - for job in jobs { - tokio::spawn(spawner.queue::(job).map_err(|_| ())); - } - - Ok(()) - })); -} diff --git a/examples/server-jobs-example/src/bin/sync_spawner.rs b/examples/server-jobs-example/src/bin/sync_spawner.rs deleted file mode 100644 index b5682cb..0000000 --- a/examples/server-jobs-example/src/bin/sync_spawner.rs +++ /dev/null @@ -1,41 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use background_jobs::SpawnerConfig; -use failure::Error; -use server_jobs_example::{MyJob, MyProcessor}; - -fn main() -> Result<(), Error> { - dotenv::dotenv().ok(); - env_logger::init(); - - let (_, _, jobs) = (1..50).fold((0, 1, Vec::new()), |(x, y, mut acc), _| { - acc.push(MyJob::new(x, y)); - - (y, x + y, acc) - }); - - let spawner = SpawnerConfig::new("localhost", 5555); - - for job in jobs { - spawner.queue_sync::(job)?; - } - - Ok(()) -} diff --git a/examples/server-jobs-example/src/bin/worker.rs b/examples/server-jobs-example/src/bin/worker.rs deleted file mode 100644 index 435c06c..0000000 --- a/examples/server-jobs-example/src/bin/worker.rs +++ /dev/null @@ -1,35 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use background_jobs::WorkerConfig; -use failure::Error; -use server_jobs_example::{queue_map, MyProcessor}; - -fn main() -> Result<(), Error> { - dotenv::dotenv().ok(); - env_logger::init(); - - let mut worker = WorkerConfig::new((), "localhost".to_owned(), 5555, queue_map()); - - worker.register_processor(MyProcessor); - - tokio::run(worker.run()); - - Ok(()) -} diff --git a/examples/server-jobs-example/src/lib.rs b/examples/server-jobs-example/src/lib.rs deleted file mode 100644 index c03aa0a..0000000 --- a/examples/server-jobs-example/src/lib.rs +++ /dev/null @@ -1,77 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -#[macro_use] -extern crate log; -#[macro_use] -extern crate serde_derive; - -use std::collections::{BTreeMap, BTreeSet}; - -use background_jobs::{Backoff, Job, MaxRetries, Processor}; -use failure::Error; -use futures::{future::IntoFuture, Future}; - -const DEFAULT_QUEUE: &'static str = "default"; - -pub fn queue_map() -> BTreeMap { - let mut map = BTreeMap::new(); - map.insert(DEFAULT_QUEUE.to_owned(), 18); - - map -} - -pub fn queue_set() -> BTreeSet { - queue_map().keys().cloned().collect() -} - -#[derive(Clone, Debug, Deserialize, Serialize)] -pub struct MyJob { - some_usize: usize, - other_usize: usize, -} - -impl MyJob { - pub fn new(some_usize: usize, other_usize: usize) -> Self { - MyJob { - some_usize, - other_usize, - } - } -} - -impl Job for MyJob { - fn run(self, _: ()) -> Box + Send> { - info!("args: {:?}", self); - - Box::new(Ok(()).into_future()) - } -} - -#[derive(Clone, Debug)] -pub struct MyProcessor; - -impl Processor for MyProcessor { - type Job = MyJob; - - const NAME: &'static str = "MyProcessor"; - const QUEUE: &'static str = DEFAULT_QUEUE; - const MAX_RETRIES: MaxRetries = MaxRetries::Count(1); - const BACKOFF_STRATEGY: Backoff = Backoff::Exponential(2); -} diff --git a/jobs-actix/src/lib.rs b/jobs-actix/src/lib.rs index 5fb8a93..3a1afd5 100644 --- a/jobs-actix/src/lib.rs +++ b/jobs-actix/src/lib.rs @@ -28,7 +28,7 @@ impl ServerConfig { pub fn start(self) -> QueueHandle where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { let ServerConfig { server_id, db_path } = self; @@ -44,7 +44,7 @@ impl ServerConfig { pub struct WorkerConfig where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { processors: ProcessorMap, queues: BTreeMap, @@ -52,7 +52,7 @@ where impl WorkerConfig where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { pub fn new(state: S) -> Self { WorkerConfig { @@ -63,7 +63,7 @@ where pub fn register

(&mut self, processor: P) where - P: Processor + Send + Sync + 'static, + P: Processor + Send + 'static, { self.queues.insert(P::QUEUE.to_owned(), 4); self.processors.register_processor(processor); @@ -95,14 +95,14 @@ where #[derive(Clone)] pub struct QueueHandle where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { inner: Addr>>, } impl QueueHandle where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { pub fn queue

(&self, job: P::Job) -> Result<(), Error> where diff --git a/jobs-actix/src/worker.rs b/jobs-actix/src/worker.rs index baf0dde..c00a91e 100644 --- a/jobs-actix/src/worker.rs +++ b/jobs-actix/src/worker.rs @@ -25,7 +25,7 @@ impl Message for ProcessJob { pub struct LocalWorker where - State: Clone + Send + Sync + 'static, + State: Clone + Send + 'static, { id: usize, queue: String, @@ -35,7 +35,7 @@ where impl LocalWorker where - State: Clone + Send + Sync + 'static, + State: Clone + Send + 'static, { pub fn new( id: usize, @@ -54,7 +54,7 @@ where impl Actor for LocalWorker where - State: Clone + Send + Sync + 'static, + State: Clone + Send + 'static, { type Context = Context; @@ -66,7 +66,7 @@ where impl Handler for LocalWorker where - State: Clone + Send + Sync + 'static, + State: Clone + Send + 'static, { type Result = (); diff --git a/jobs-core/src/job.rs b/jobs-core/src/job.rs index 60a32c6..8c243a2 100644 --- a/jobs-core/src/job.rs +++ b/jobs-core/src/job.rs @@ -26,7 +26,7 @@ use crate::{Backoff, MaxRetries}; /// The Job trait defines parameters pertaining to an instance of background job pub trait Job: Serialize + DeserializeOwned where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { /// Users of this library must define what it means to run a job. /// diff --git a/jobs-core/src/processor.rs b/jobs-core/src/processor.rs index 0bbcc22..2ae98c6 100644 --- a/jobs-core/src/processor.rs +++ b/jobs-core/src/processor.rs @@ -83,7 +83,7 @@ use crate::{Backoff, Job, JobError, MaxRetries, NewJobInfo}; /// ``` pub trait Processor: Clone where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { type Job: Job + 'static; diff --git a/jobs-core/src/processor_map.rs b/jobs-core/src/processor_map.rs index fbf6810..e31b4b2 100644 --- a/jobs-core/src/processor_map.rs +++ b/jobs-core/src/processor_map.rs @@ -33,7 +33,7 @@ use crate::{JobError, JobInfo, Processor}; /// [`ProcessorMap`](https://docs.rs/background-jobs-core/0.4.0/background_jobs_core/struct.ProcessorMap.html) /// struct stores these `ProcessFn` types that don't expose differences in Job types. pub type ProcessFn = - Box Box + Send> + Send + Sync>; + Box Box + Send> + Send>; /// A type for storing the relationships between processor names and the processor itself /// @@ -50,7 +50,7 @@ where impl ProcessorMap where - S: Clone + Send + Sync + 'static, + S: Clone + Send + 'static, { /// Intialize a `ProcessorMap` /// @@ -72,7 +72,7 @@ where /// make sure to register all your processors up-front. pub fn register_processor

(&mut self, processor: P) where - P: Processor + Send + Sync + 'static, + P: Processor + Send + 'static, { let state = self.state.clone(); diff --git a/jobs-server/Cargo.toml b/jobs-server/Cargo.toml deleted file mode 100644 index 4e300e6..0000000 --- a/jobs-server/Cargo.toml +++ /dev/null @@ -1,35 +0,0 @@ -[package] -name = "background-jobs-server" -description = "Jobs processor server based on ZeroMQ" -version = "0.4.0" -license = "GPL-3.0" -authors = ["asonix "] -repository = "https://git.asonix.dog/asonix/background-jobs" -keywords = ["jobs", "processor"] -edition = "2018" - -[dependencies] -failure = "0.1" -futures = "0.1" -log = "0.4" -serde = "1.0" -serde_json = "1.0" -serde_derive = "1.0" -tokio = "0.1" -tokio-threadpool = "0.1" -zmq = "0.8" - -[features] -default = ["tokio-zmq"] - -[dependencies.background-jobs-core] -version = "0.4" -path = "../jobs-core" - -[dependencies.tokio-zmq] -version = "0.8" -optional = true - -[dependencies.futures-zmq] -version = "0.3" -optional = true diff --git a/jobs-server/LICENSE b/jobs-server/LICENSE deleted file mode 100644 index 94a9ed0..0000000 --- a/jobs-server/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/jobs-server/src/lib.rs b/jobs-server/src/lib.rs deleted file mode 100644 index f82787b..0000000 --- a/jobs-server/src/lib.rs +++ /dev/null @@ -1,161 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::marker::PhantomData; - -use background_jobs_core::{Backoff, Job, MaxRetries}; -use failure::Error; -use futures::{future::poll_fn, Future}; -use serde::{de::DeserializeOwned, ser::Serialize}; -use serde_derive::{Deserialize, Serialize}; -use tokio_threadpool::blocking; - -mod server; -mod spawner; -mod worker; - -pub use crate::{server::ServerConfig, spawner::SpawnerConfig, worker::WorkerConfig}; - -fn coerce(res: Result, F>) -> Result -where - F: Into, -{ - match res { - Ok(res) => res, - Err(e) => Err(e.into()), - } -} - -/// The SyncJob trait defines parameters pertaining to a synchronous instance of background job -/// -/// This trait should be implemented sparingly, but is provided so that synchronous tasks may be -/// executed. If you have the ability to implement the -/// [`Job`](https://docs.rs/background-jobs/0.4.0/background_jobs/trait.Job.html) trait directly, -/// you should. -/// -/// ### Example -/// -/// ```rust -/// use background_jobs_server::SyncJob; -/// use failure::Error; -/// use log::info; -/// use serde_derive::{Deserialize, Serialize}; -/// -/// #[derive(Clone, Deserialize, Serialize)] -/// struct MyJob { -/// count: i32, -/// } -/// -/// impl SyncJob for MyJob { -/// fn run(self, _state: ()) -> Result<(), Error> { -/// info!("Processing {}", self.count); -/// -/// // Perform some synchronous operation, like a DB action with r2d2 and diesel -/// -/// Ok(()) -/// } -/// } -/// -/// fn main() { -/// let sync_job = MyJob { count: 0 }; -/// let job = sync_job.to_job(); -/// } -/// ``` -pub trait SyncJob: Clone { - /// Users of this library must define what it means to run a job. - /// - /// This should contain all the logic needed to complete a job. If that means queuing more - /// jobs, sending an email, shelling out (don't shell out), or doing otherwise lengthy - /// processes, that logic should all be called from inside this method. - /// - /// The state passed into this job is initialized at the start of the application. The state - /// argument could be useful for containing a hook into something like r2d2, or the address of - /// an actor in an actix-based system. - fn run(self, state: S) -> Result<(), Error>; - - /// If this job should not use the default queue for its processor, this can be overridden in - /// user-code. - /// - /// Jobs will only be processed by processors that are registered, and if a queue is supplied - /// here that is not associated with a valid processor for this job, it will never be - /// processed. - fn queue(&self) -> Option<&str> { - None - } - - /// If this job should not use the default maximum retry count for its processor, this can be - /// overridden in user-code. - fn max_retries(&self) -> Option { - None - } - - /// If this job should not use the default backoff strategy for its processor, this can be - /// overridden in user-code. - fn backoff_strategy(&self) -> Option { - None - } - - /// Wrap this type in a SyncJobWrapper so it implements Job - fn to_job(self) -> SyncJobWrapper { - SyncJobWrapper { - inner: self, - phantom: PhantomData, - } - } -} - -/// A wrapper around synchronous jobs -#[derive(Clone, Deserialize, Serialize)] -pub struct SyncJobWrapper -where - J: SyncJob, -{ - inner: J, - phantom: PhantomData, -} - -impl Job for SyncJobWrapper -where - J: SyncJob + Serialize + DeserializeOwned + Send + 'static, - S: Clone + Send + Sync + 'static, -{ - fn queue(&self) -> Option<&str> { - self.inner.queue() - } - - fn max_retries(&self) -> Option { - self.inner.max_retries() - } - - fn backoff_strategy(&self) -> Option { - self.inner.backoff_strategy() - } - - fn run(self, state: S) -> Box + Send> { - let fut = poll_fn(move || { - let job = self.inner.clone(); - let state = state.clone(); - - blocking(move || job.run(state.clone())) - }) - .then(coerce); - - Box::new(fut) - } -} diff --git a/jobs-server/src/server/mod.rs b/jobs-server/src/server/mod.rs deleted file mode 100644 index b360dba..0000000 --- a/jobs-server/src/server/mod.rs +++ /dev/null @@ -1,209 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{ - collections::BTreeSet, - path::{Path, PathBuf}, - sync::Arc, -}; - -use background_jobs_core::Storage; -use failure::{Error, Fail}; -use futures::{future::poll_fn, Future}; -use log::{error, info}; -use tokio_threadpool::blocking; -use zmq::Context; - -use crate::coerce; - -mod portmap; -mod pull; -mod push; -mod stalled; - -use self::{portmap::PortMapConfig, pull::PullConfig, push::PushConfig, stalled::StalledConfig}; - -#[derive(Clone)] -pub(crate) struct Config { - server_id: usize, - ip: String, - base_port: usize, - queues: BTreeSet, - db_path: PathBuf, - context: Arc, -} - -impl Config { - fn create_server(&self) -> Box + Send> { - let db_path = self.db_path.clone(); - let base_port = self.base_port; - let queues = self.queues.clone(); - let server_id = self.server_id; - - let config = Arc::new(self.clone()); - - let fut = poll_fn(move || { - let db_path = db_path.clone(); - let base_port = base_port; - let queues = queues.clone(); - - blocking(move || { - let storage = Arc::new(Storage::init(db_path)?); - storage.requeue_staged_jobs(server_id)?; - storage.check_stalled_jobs(server_id)?; - let port_map = storage.get_port_mapping(base_port, queues, server_id)?; - - Ok((storage, port_map)) - }) - }) - .from_err::() - .then(coerce) - .and_then(move |(storage, port_map)| { - for queue in config.queues.iter() { - let port = port_map.get(queue).ok_or(MissingQueue(queue.to_owned()))?; - - let address = format!("tcp://{}:{}", config.ip, port); - - info!("Creating queue {} on address {}", queue, address); - - tokio::spawn(PushConfig::init( - server_id, - address, - queue.to_owned(), - storage.clone(), - config.clone(), - )); - } - - StalledConfig::init(server_id, storage.clone()); - - let portmap_address = format!("tcp://{}:{}", config.ip, config.base_port + 1); - info!("Creating portmap on address {}", portmap_address); - - tokio::spawn(PortMapConfig::init( - portmap_address, - port_map, - config.clone(), - )); - - let pull_address = format!("tcp://{}:{}", config.ip, config.base_port); - info!("Creating puller on address {}", pull_address); - - tokio::spawn(PullConfig::init(server_id, pull_address, storage, config)); - - Ok(()) - }) - .map_err(|e| error!("Error starting server, {}", e)); - - Box::new(fut) - } -} - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Queue is missing from map, {}", _0)] -struct MissingQueue(String); - -/// The entry point for creating a background-jobs server -/// -/// `ServerConfig` is used to spin up the infrastructure to manage queueing and storing jobs, but -/// it does not provide functionality to execute jobs. For that, you must create a -/// [`Worker`](https://docs.rs/background-jobs-server/0.4.0/background_jobs_server/struct.WorkerConfig.html) -/// that will connect to the running server. -/// -/// This type doesn't have any associated data, but is used as a proxy for starting the -/// background-jobs runtime. -/// -/// ```rust -/// use std::collections::BTreeSet; -/// use background_jobs_server::ServerConfig; -/// use failure::Error; -/// -/// fn main() -> Result<(), Error> { -/// let mut queue_set = BTreeSet::new(); -/// queue_set.insert("default".to_owned()); -/// -/// let start_server = ServerConfig::init( -/// 1, -/// "127.0.0.1", -/// 5555, -/// queue_set, -/// "example-db", -/// ); -/// -/// # let _ = start_server; -/// // Comment out the start so we don't run the full server in doctests -/// // tokio::run(start_server) -/// -/// Ok(()) -/// } -/// ``` -pub struct ServerConfig; - -impl ServerConfig { - /// Create a new background-jobs Server that binds to the provided `ip` with ports starting at - /// `base_port`. - /// - /// The smallest background-jobs server will bind to 3 ports. Each port serves a different - /// purpose: - /// - `base_port` is the port that jobs are sent to the server on - /// - `base_port` + 1 is the port that the server uses to advertise which queues are available - /// - `base_port` + n is bound for an individual queue of jobs that the server pushes to - /// workers. - /// - /// This method returns a future that, when run, spawns all of the server's required futures - /// onto tokio. Therefore, this can only be used from tokio. - pub fn init>( - server_id: usize, - ip: &str, - base_port: usize, - queues: BTreeSet, - db_path: P, - ) -> Box + Send> { - let context = Arc::new(Context::new()); - - Self::init_with_context(server_id, ip, base_port, queues, db_path, context) - } - - /// The same as `ServerConfig::init()`, but with a provided ZeroMQ Context. - /// - /// This can be useful if you have other uses of ZeroMQ in your application, and want to share - /// a context with your dependencies. - /// - /// If you're running the Server, Worker, and Spawner in the same application, you should share - /// a ZeroMQ context between them. - pub fn init_with_context>( - server_id: usize, - ip: &str, - base_port: usize, - queues: BTreeSet, - db_path: P, - context: Arc, - ) -> Box + Send> { - let config = Config { - server_id, - ip: ip.to_owned(), - base_port, - queues, - db_path: db_path.as_ref().to_owned(), - context, - }; - - config.create_server() - } -} diff --git a/jobs-server/src/server/portmap.rs b/jobs-server/src/server/portmap.rs deleted file mode 100644 index 5f5fe28..0000000 --- a/jobs-server/src/server/portmap.rs +++ /dev/null @@ -1,126 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{collections::BTreeMap, sync::Arc, time::Duration}; - -use failure::Error; -use futures::{Future, Stream}; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Multipart, Rep}; -use log::{error, info}; -use tokio::timer::Delay; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Multipart, Rep}; -use zmq::Message; - -use crate::server::Config; - -pub(crate) struct PortMapConfig { - rep: Rep, - address: String, - port_map: BTreeMap, - config: Arc, -} - -impl PortMapConfig { - pub(crate) fn init( - address: String, - port_map: BTreeMap, - config: Arc, - ) -> impl Future { - let cfg = ResetPortMapConfig { - address, - port_map, - config, - }; - - cfg.build().map_err(|e| error!("Error starting rep, {}", e)) - } - - fn run(self) -> Box + Send> { - let reset = self.reset(); - - let PortMapConfig { - rep, - address: _, - port_map, - config: _, - } = self; - - let (sink, stream) = rep.sink_stream(1).split(); - - let fut = stream - .from_err::() - .and_then(move |_| { - let s = serde_json::to_string(&port_map)?; - let m = Message::from_slice(s.as_ref())?; - - Ok(Multipart::from(m)) - }) - .forward(sink) - .map(move |_| info!("portmap rep shutting down")) - .map_err(|e| { - error!("Error sending portmap, {}", e); - - tokio::spawn(reset.rebuild()); - }); - - Box::new(fut) - } - - fn reset(&self) -> ResetPortMapConfig { - ResetPortMapConfig { - address: self.address.clone(), - port_map: self.port_map.clone(), - config: self.config.clone(), - } - } -} - -struct ResetPortMapConfig { - address: String, - port_map: BTreeMap, - config: Arc, -} - -impl ResetPortMapConfig { - fn rebuild(self) -> impl Future { - Delay::new(tokio::clock::now() + Duration::from_secs(5)) - .from_err() - .and_then(move |_| self.build()) - .map_err(|e| error!("Error restarting rep, {}", e)) - } - - fn build(self) -> impl Future { - Rep::builder(self.config.context.clone()) - .bind(&self.address) - .build() - .map(|rep| { - let config = PortMapConfig { - rep, - address: self.address, - port_map: self.port_map, - config: self.config, - }; - - tokio::spawn(config.run()); - }) - .from_err() - } -} diff --git a/jobs-server/src/server/pull.rs b/jobs-server/src/server/pull.rs deleted file mode 100644 index 78dd2af..0000000 --- a/jobs-server/src/server/pull.rs +++ /dev/null @@ -1,187 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{sync::Arc, time::Duration}; - -use background_jobs_core::{JobInfo, NewJobInfo, Storage}; -use failure::{Error, Fail}; -use futures::{future::poll_fn, Future, Stream}; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Multipart, Pull}; -use log::{error, info, trace}; -use serde_derive::Deserialize; -use tokio::timer::Delay; -use tokio_threadpool::blocking; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Multipart, Pull}; - -use crate::server::{coerce, Config}; - -#[derive(Clone, Debug, Deserialize)] -#[serde(untagged)] -enum EitherJob { - Existing(JobInfo), - New(NewJobInfo), -} - -pub(crate) struct PullConfig { - server_id: usize, - puller: Pull, - address: String, - storage: Arc, - config: Arc, -} - -impl PullConfig { - pub(crate) fn init( - server_id: usize, - address: String, - storage: Arc, - config: Arc, - ) -> impl Future { - let cfg = ResetPullConfig { - server_id, - address, - storage, - config, - }; - - cfg.build() - .map_err(|e| error!("Error starting puller, {}", e)) - } - - fn run(self) -> Box + Send> { - let config = self.reset(); - let server_id = self.server_id; - - let storage = self.storage.clone(); - - let fut = self - .puller - .stream() - .from_err() - .map(|m| { - trace!("Handling new message"); - m - }) - .and_then(parse_job) - .and_then(move |job| { - trace!("Storing job, {:?}", job); - store_job(job, storage.clone(), server_id) - }) - .for_each(|_| Ok(())) - .map(|_| info!("Puller is shutting down")) - .map_err(|e| { - error!("Error storing job, {}", e); - - tokio::spawn(config.rebuild()); - }); - - Box::new(fut) - } - - fn reset(&self) -> ResetPullConfig { - ResetPullConfig { - server_id: self.server_id, - address: self.address.clone(), - storage: self.storage.clone(), - config: self.config.clone(), - } - } -} - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Message was empty")] -pub struct EmptyMessage; - -fn parse_job(mut multipart: Multipart) -> Result { - let unparsed_msg = multipart.pop_front().ok_or(EmptyMessage)?; - - let parsed = serde_json::from_slice(&unparsed_msg)?; - - Ok(parsed) -} - -fn store_job( - job: EitherJob, - storage: Arc, - server_id: usize, -) -> impl Future { - let storage = storage.clone(); - - poll_fn(move || { - let job = job.clone(); - let storage = storage.clone(); - - blocking(move || { - let job = match job { - EitherJob::New(new_job) => storage.assign_id(new_job, server_id)?, - EitherJob::Existing(job) => job, - }; - - if job.is_pending() { - info!("Storing pending job, {}", job.id()); - } - if job.is_finished() { - info!("Finished job {}", job.id()); - } - if job.is_failed() { - info!("Job failed {}", job.id()); - } - - storage.store_job(job, server_id).map_err(Error::from) - }) - .map_err(Error::from) - }) - .then(coerce) -} - -struct ResetPullConfig { - server_id: usize, - address: String, - storage: Arc, - config: Arc, -} - -impl ResetPullConfig { - fn rebuild(self) -> impl Future { - Delay::new(tokio::clock::now() + Duration::from_secs(5)) - .from_err() - .and_then(move |_| self.build()) - .map_err(|e| error!("Error restarting puller, {}", e)) - } - - fn build(self) -> impl Future { - Pull::builder(self.config.context.clone()) - .bind(&self.address) - .build() - .map(|puller| { - let config = PullConfig { - server_id: self.server_id, - puller, - address: self.address, - storage: self.storage, - config: self.config, - }; - - tokio::spawn(config.run()); - }) - .from_err() - } -} diff --git a/jobs-server/src/server/push.rs b/jobs-server/src/server/push.rs deleted file mode 100644 index 65a58ad..0000000 --- a/jobs-server/src/server/push.rs +++ /dev/null @@ -1,193 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{sync::Arc, time::Duration}; - -use background_jobs_core::{JobInfo, Storage}; -use failure::Error; -use futures::{future::poll_fn, stream::iter_ok, Future, Stream}; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Multipart, Push}; -use log::{error, info}; -use tokio::timer::{Delay, Interval}; -use tokio_threadpool::blocking; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Multipart, Push}; -use zmq::Message; - -use crate::server::{coerce, Config}; - -pub(crate) struct PushConfig { - server_id: usize, - pusher: Push, - address: String, - queue: String, - storage: Arc, - config: Arc, -} - -impl PushConfig { - pub(crate) fn init( - server_id: usize, - address: String, - queue: String, - storage: Arc, - config: Arc, - ) -> impl Future { - let cfg = ResetPushConfig { - server_id, - address, - queue, - storage, - config, - }; - - cfg.build() - .map_err(|e| error!("Error starting pusher, {}", e)) - } - - fn run(self) -> Box + Send> { - let reset = self.reset(); - - let PushConfig { - server_id, - address: _, - pusher, - queue, - storage, - config: _, - } = self; - - let queue_2_electric_boogaloo = queue.clone(); - - let fut = Interval::new(tokio::clock::now(), Duration::from_millis(250)) - .from_err() - .and_then(move |_| dequeue_jobs(storage.clone(), queue.clone(), server_id)) - .flatten() - .forward(pusher.sink(25)) - .map(move |_| { - info!( - "Pusher for queue {} is shutting down", - queue_2_electric_boogaloo - ) - }) - .map_err(|e| { - error!("Error dequeuing job, {}", e); - - tokio::spawn(reset.rebuild()); - }); - - Box::new(fut) - } - - fn reset(&self) -> ResetPushConfig { - ResetPushConfig { - server_id: self.server_id, - address: self.address.clone(), - queue: self.queue.clone(), - storage: self.storage.clone(), - config: self.config.clone(), - } - } -} - -fn dequeue_jobs( - storage: Arc, - queue: String, - server_id: usize, -) -> impl Future, Error = Error> { - poll_fn(move || { - let storage = storage.clone(); - let queue = queue.clone(); - blocking(move || wrap_fetch_queue(storage, &queue, server_id)) - }) - .then(coerce) - .map(|jobs| iter_ok(jobs)) - .or_else(|e| { - error!("Error fetching jobs, {}", e); - Ok(iter_ok(vec![])) - }) -} - -fn wrap_fetch_queue( - storage: Arc, - queue: &str, - server_id: usize, -) -> Result, Error> { - let response = fetch_queue(storage, queue, server_id)?; - - let jobs = response - .into_iter() - .map(|job| { - serde_json::to_string(&job) - .map_err(Error::from) - .and_then(|json| Message::from_slice(json.as_ref()).map_err(Error::from)) - .map(Multipart::from) - }) - .collect::, Error>>()?; - - Ok(jobs) -} - -fn fetch_queue( - storage: Arc, - queue: &str, - server_id: usize, -) -> Result, Error> { - storage - .stage_jobs(10, queue, server_id) - .map_err(Error::from) -} - -struct ResetPushConfig { - server_id: usize, - address: String, - queue: String, - storage: Arc, - config: Arc, -} - -impl ResetPushConfig { - fn rebuild(self) -> impl Future { - Delay::new(tokio::clock::now() + Duration::from_secs(5)) - .from_err() - .and_then(move |_| self.build()) - .map_err(|e| error!("Error restarting pusher, {}", e)) - } - - fn build(self) -> impl Future { - info!("Building and spawning new server"); - Push::builder(self.config.context.clone()) - .bind(&self.address) - .build() - .map(|pusher| { - let config = PushConfig { - server_id: self.server_id, - pusher, - address: self.address, - queue: self.queue, - storage: self.storage, - config: self.config, - }; - - tokio::spawn(config.run()); - }) - .from_err() - } -} diff --git a/jobs-server/src/server/stalled.rs b/jobs-server/src/server/stalled.rs deleted file mode 100644 index c357eb3..0000000 --- a/jobs-server/src/server/stalled.rs +++ /dev/null @@ -1,78 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{sync::Arc, time::Duration}; - -use background_jobs_core::Storage; -use failure::Error; -use futures::{future::poll_fn, Future, Stream}; -use log::{error, info}; -use tokio::timer::{Delay, Interval}; -use tokio_threadpool::blocking; - -use crate::server::coerce; - -#[derive(Clone)] -pub(crate) struct StalledConfig { - server_id: usize, - storage: Arc, -} - -impl StalledConfig { - pub(crate) fn init(server_id: usize, storage: Arc) { - let cfg = StalledConfig { server_id, storage }; - - tokio::spawn(cfg.run()); - } - - fn run(self) -> Box + Send> { - let reset = self.clone(); - - let StalledConfig { server_id, storage } = self; - - let fut = Interval::new(tokio::clock::now(), Duration::from_secs(60 * 30)) - .from_err::() - .and_then(move |_| { - let storage = storage.clone(); - poll_fn(move || { - let storage = storage.clone(); - blocking(move || storage.check_stalled_jobs(server_id).map_err(Error::from)) - }) - .from_err() - }) - .then(coerce) - .for_each(|_| Ok(())) - .map(|_| info!("Stalled Job Checker is shutting down")) - .map_err(|e| { - error!("Error checking stalled jobs, {}", e); - - tokio::spawn(reset.rebuild()); - }); - - Box::new(fut) - } - - fn rebuild(self) -> impl Future { - Delay::new(tokio::clock::now() + Duration::from_secs(5)) - .from_err::() - .map(move |_| tokio::spawn(self.run())) - .map(|_| ()) - .map_err(|e| error!("Error restarting stalled job checker, {}", e)) - } -} diff --git a/jobs-server/src/spawner.rs b/jobs-server/src/spawner.rs deleted file mode 100644 index c78c563..0000000 --- a/jobs-server/src/spawner.rs +++ /dev/null @@ -1,130 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::sync::Arc; - -use background_jobs_core::Processor; -use failure::Error; -use futures::{future::IntoFuture, Future}; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Push}; -use log::{debug, trace}; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Push}; -use zmq::{Context, Message}; - -/// SpawnerConfig is the only part of this library required to actually exist in your application. -/// -/// This type is used to queue new jobs into the `background-jobs` server. -/// -/// ```rust,ignore -/// let spawner = SpawnerConfig::new("localhost", 5555); -/// -/// tokio::spawn( -/// spawner -/// .queue::(job) -/// .map_err(|_| ()), -/// ); -/// ``` -pub struct SpawnerConfig { - server: String, - ctx: Arc, -} - -impl SpawnerConfig { - /// Create a `SpawnerConfig` - /// - /// - `server_host` is the hostname or IP address of the host that the server is running on - /// - `base_port` is the same `base_port` from the server config. The spawner will only ever - /// need to communicate over `base_port` - pub fn new(server_host: &str, base_port: usize) -> Self { - let ctx = Arc::new(Context::new()); - - Self::new_with_context(server_host, base_port, ctx) - } - - /// The same as `SpawnerConfig::new()`, but with a provided ZeroMQ Context. - /// - /// This can be useful if you have other uses of ZeroMQ in your application, and want to share - /// a context with your dependencies. - /// - /// If you're running the Server, Worker, and Spawner in the same application, you should share - /// a ZeroMQ context between them. - pub fn new_with_context(server_host: &str, base_port: usize, ctx: Arc) -> Self { - SpawnerConfig { - server: format!("tcp://{}:{}", server_host, base_port), - ctx, - } - } - - /// Queue a job to be executed in the background - pub fn queue(&self, job: P::Job) -> impl Future - where - P: Processor, - S: Clone + Send + Sync + 'static, - { - let msg = P::new_job(job) - .map_err(Error::from) - .and_then(|job_info| serde_json::to_string(&job_info).map_err(Error::from)) - .and_then(|s| { - Message::from_slice(s.as_ref()) - .map(|m| m.into()) - .map_err(Error::from) - }) - .into_future(); - - debug!("Sending message to {}", self.server); - - Push::builder(self.ctx.clone()) - .connect(&self.server) - .build() - .from_err() - .join(msg) - .and_then(move |(push, msg)| { - trace!("Sending"); - push.send(msg).from_err().map(|_| trace!("sent")) - }) - } - - /// `queue_sync` is the same as Queue, except that it blocks the current thread while it is - /// sending the message to the jobs server. - /// - /// If you have a tokio-based application, you should use `queue` instead. - pub fn queue_sync(&self, job: P::Job) -> Result<(), Error> - where - P: Processor, - S: Clone + Send + Sync + 'static, - { - use zmq::PUSH; - - let job_info = P::new_job(job)?; - - let msg_string = serde_json::to_string(&job_info)?; - - let msg = Message::from_slice(msg_string.as_ref())?; - - let socket = self.ctx.socket(PUSH)?; - socket.connect(&self.server)?; - trace!("Sending"); - socket.send_msg(msg, 0)?; - trace!("Sent"); - - Ok(()) - } -} diff --git a/jobs-server/src/worker/config.rs b/jobs-server/src/worker/config.rs deleted file mode 100644 index dfa2be1..0000000 --- a/jobs-server/src/worker/config.rs +++ /dev/null @@ -1,228 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{sync::Arc, time::Duration}; - -use background_jobs_core::{JobInfo, ProcessorMap}; -use failure::{Error, Fail}; -use futures::{ - sync::mpsc::{channel, Sender}, - Future, Sink, Stream, -}; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Multipart, Pull, Push}; -use log::{error, info}; -use tokio::timer::Delay; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Multipart, Pull, Push}; -use zmq::{Context, Message}; - -pub(crate) struct Worker -where - S: Clone, -{ - pull: Pull, - push: Push, - push_address: String, - pull_address: String, - queue: String, - processors: Arc>, - context: Arc, -} - -impl Worker -where - S: Clone + Send + Sync + 'static, -{ - pub(crate) fn init( - push_address: String, - pull_address: String, - queue: String, - processors: Arc>, - context: Arc, - ) -> impl Future { - let cfg = ResetWorker { - push_address, - pull_address, - queue: queue.clone(), - processors, - context, - }; - - cfg.build() - .map_err(move |e| error!("Error starting worker for queue {}, {}", queue, e)) - } - - fn run(self) -> Box + Send> { - let reset = self.reset(); - - let Worker { - push, - pull, - push_address: _, - pull_address: _, - queue, - processors, - context: _, - } = self; - - let (tx, rx) = channel(5); - let tx2 = tx.clone(); - - tokio::spawn( - rx.map_err(|_| RecvError) - .from_err::() - .and_then(serialize_request) - .forward(push.sink(1)) - .map(|_| ()) - .or_else(|_| Ok(())), - ); - - let fut = pull - .stream() - .from_err::() - .and_then(parse_multipart) - .and_then(move |job| report_running(job, tx.clone())) - .and_then(move |job| process_job(job, &processors)) - .forward(tx2) - .map(move |_| info!("worker for queue {} is shutting down", queue)) - .map_err(|e| { - error!("Error processing job, {}", e); - - tokio::spawn(reset.rebuild()); - }); - - Box::new(fut) - } - - fn reset(&self) -> ResetWorker { - ResetWorker { - push_address: self.push_address.clone(), - pull_address: self.pull_address.clone(), - queue: self.queue.clone(), - processors: self.processors.clone(), - context: self.context.clone(), - } - } -} - -struct ResetWorker -where - S: Clone, -{ - push_address: String, - pull_address: String, - queue: String, - processors: Arc>, - context: Arc, -} - -impl ResetWorker -where - S: Clone + Send + Sync + 'static, -{ - fn rebuild(self) -> impl Future { - let queue = self.queue.clone(); - - Delay::new(tokio::clock::now() + Duration::from_secs(5)) - .from_err() - .and_then(move |_| self.build()) - .map_err(move |e| error!("Error restarting worker for queue {}, {}", queue, e)) - } - - fn build(self) -> impl Future { - Push::builder(self.context.clone()) - .connect(&self.push_address) - .build() - .join( - Pull::builder(self.context.clone()) - .connect(&self.pull_address) - .build(), - ) - .map(|(push, pull)| { - let config = Worker { - push, - pull, - push_address: self.push_address, - pull_address: self.pull_address, - queue: self.queue, - processors: self.processors, - context: self.context, - }; - - tokio::spawn(config.run()); - }) - .from_err() - } -} - -fn serialize_request(job: JobInfo) -> Result { - let request = serde_json::to_string(&job)?; - let msg = Message::from_slice(request.as_ref())?; - - Ok(msg.into()) -} - -fn parse_multipart(mut multipart: Multipart) -> Result { - let message = multipart.pop_front().ok_or(ParseError)?; - - let parsed = serde_json::from_slice(&message)?; - - Ok(parsed) -} - -fn report_running( - mut job: JobInfo, - push: Sender, -) -> impl Future { - job.set_running(); - - push.send(job.clone()) - .map(move |_| job) - .map_err(|_| NotifyError.into()) -} - -fn process_job( - job: JobInfo, - processors: &ProcessorMap, -) -> impl Future -where - S: Clone + Send + Sync + 'static, -{ - processors - .process_job(job.clone()) - .map_err(|_| ProcessError) - .from_err() -} - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Error parsing job")] -struct ParseError; - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Error processing job")] -struct ProcessError; - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Error notifying running has started")] -struct NotifyError; - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Error receiving from mpsc")] -struct RecvError; diff --git a/jobs-server/src/worker/mod.rs b/jobs-server/src/worker/mod.rs deleted file mode 100644 index aa78738..0000000 --- a/jobs-server/src/worker/mod.rs +++ /dev/null @@ -1,189 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{collections::BTreeMap, sync::Arc}; - -use background_jobs_core::{Processor, ProcessorMap}; -use failure::Fail; -use futures::Future; -use log::{error, info}; -use zmq::Context; - -mod config; -mod portmap; - -use self::{config::Worker, portmap::PortMap}; - -/// The entry point for creating a background-jobs worker. -/// -/// A worker handles the processing of jobs, but not the queueing or storing of jobs. It connects -/// to a server (crated with -/// [`ServerConfig`](https://docs.rs/background-jobs-server/0.4.0/background_jobs_server/struct.ServerConfig.html)) -/// and receives work from there. -/// -/// ```rust -/// use std::collections::BTreeMap; -/// use background_jobs_server::WorkerConfig; -/// use failure::Error; -/// -/// fn main() -> Result<(), Error> { -/// let mut queue_map = BTreeMap::new(); -/// queue_map.insert("default".to_owned(), 10); -/// -/// let mut worker = WorkerConfig::new((), "localhost".to_owned(), 5555, queue_map); -/// -/// // Register a processor -/// // worker.register_processor(MyProcessor); -/// -/// // Run the workers -/// // tokio::run(worker.run()); -/// -/// Ok(()) -/// } -/// ``` -pub struct WorkerConfig -where - S: Clone, -{ - processors: ProcessorMap, - queues: BTreeMap, - server_host: String, - base_port: usize, - context: Arc, -} - -impl WorkerConfig -where - S: Clone + Send + Sync + 'static, -{ - /// Create a new worker - /// - /// This method takes four arguments - /// - The state passed into this method will be passed to all jobs executed on this Worker. - /// The state argument could be useful for containing a hook into something like r2d2, or - /// the address of an actor in an actix-based system. - /// - `server_host` is the hostname, or IP address, of the background-jobs server. - /// - `base_port` is the same value from the `ServerConfig` initialization. It dictates the - /// port the worker uses to return jobs to the server. The worker is guaranteed to connect - /// to at least 2 other ports on the server when functioning properly, `base_port` + 1, and - /// `base_port` + n. - /// - queues is a mapping between the name of a queue, and the number of workers that should - /// be started to process jobs in that queue. - pub fn new( - state: S, - server_host: String, - base_port: usize, - queues: BTreeMap, - ) -> Self { - let context = Arc::new(Context::new()); - - Self::new_with_context(state, server_host, base_port, queues, context) - } - - /// The same as `WorkerConfig::new()`, but with a provided ZeroMQ Context. - /// - /// This can be useful if you have other uses of ZeroMQ in your application, and want to share - /// a context with your dependencies. - /// - /// If you're running the Server, Worker, and Spawner in the same application, you should share - /// a ZeroMQ context between them. - pub fn new_with_context( - state: S, - server_host: String, - base_port: usize, - queues: BTreeMap, - context: Arc, - ) -> Self { - WorkerConfig { - processors: ProcessorMap::new(state), - server_host, - base_port, - queues, - context, - } - } - - /// Register a processor with this worker - /// - /// For more information, see - /// [`Processor`](https://docs.rs/background-jobs/0.4.0/background_jobs/enum.Processor.html). - pub fn register_processor

(&mut self, processor: P) - where - P: Processor + Send + Sync + 'static, - { - self.processors.register_processor(processor); - } - - /// Start the workers - /// - /// This method returns a future that, when run, spawns all of the worker's required futures - /// onto tokio. Therefore, this can only be used from tokio. - pub fn run(self) -> Box + Send> - where - S: Send + Sync + 'static, - { - let WorkerConfig { - processors, - server_host, - base_port, - queues, - context, - } = self; - - info!("Starting workers"); - - let processors = Arc::new(processors); - - let push_address = format!("tcp://{}:{}", server_host, base_port); - let portmap_address = format!("tcp://{}:{}", server_host, base_port + 1); - - info!("push address, {}", push_address); - info!("portmap address, {}", portmap_address); - - let fut = PortMap::init(portmap_address, context.clone()) - .and_then(move |port_map| { - info!("Got port_map, {:?}", port_map); - - for (queue, num) in queues.iter() { - let port = port_map.get(queue).ok_or(MissingQueue(queue.to_owned()))?; - - let pull_address = format!("tcp://{}:{}", server_host, port); - - for _ in 0..*num { - tokio::spawn(Worker::init( - push_address.clone(), - pull_address.clone(), - queue.to_owned(), - processors.clone(), - context.clone(), - )); - } - } - - Ok(()) - }) - .map_err(|e| error!("Error starting worker, {}", e)); - - Box::new(fut) - } -} - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Could not find queue, {}", _0)] -struct MissingQueue(String); diff --git a/jobs-server/src/worker/portmap.rs b/jobs-server/src/worker/portmap.rs deleted file mode 100644 index be95726..0000000 --- a/jobs-server/src/worker/portmap.rs +++ /dev/null @@ -1,59 +0,0 @@ -/* - * This file is part of Background Jobs. - * - * Copyright © 2018 Riley Trautman - * - * Background Jobs is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Background Jobs is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with Background Jobs. If not, see . - */ - -use std::{collections::BTreeMap, sync::Arc}; - -use failure::{Error, Fail}; -use futures::Future; -#[cfg(feature = "futures-zmq")] -use futures_zmq::{prelude::*, Req}; -#[cfg(feature = "tokio-zmq")] -use tokio_zmq::{prelude::*, Req}; -use zmq::{Context, Message}; - -pub(crate) struct PortMap; - -impl PortMap { - pub(crate) fn init( - address: String, - context: Arc, - ) -> impl Future, Error = Error> { - Req::builder(context.clone()) - .connect(&address) - .build() - .from_err() - .and_then(|req| { - Message::from_slice(b"h") - .map_err(Error::from) - .map(move |msg| (req, msg.into())) - }) - .and_then(|(req, msg)| req.send(msg).and_then(|req| req.recv()).from_err()) - .and_then(|(mut multipart, _)| { - let msg = multipart.pop_front().ok_or(EmptyMessage)?; - - let map = serde_json::from_slice(&msg)?; - - Ok(map) - }) - } -} - -#[derive(Clone, Debug, Fail)] -#[fail(display = "Message was empty")] -struct EmptyMessage;