1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
use std::marker::PhantomData;
use futures::Stream;
use tower::{
layer::util::{Identity, Stack},
Layer, Service, ServiceBuilder,
};
use crate::{
error::Error,
layers::extensions::Data,
mq::MessageQueue,
request::Request,
service_fn::service_fn,
service_fn::ServiceFn,
storage::Storage,
worker::{Ready, Worker, WorkerId},
Backend,
};
/// Allows building a [`Worker`].
/// Usually the output is [`Worker<Ready>`]
pub struct WorkerBuilder<Req, Source, Middleware, Serv> {
id: WorkerId,
request: PhantomData<Req>,
layer: ServiceBuilder<Middleware>,
source: Source,
service: PhantomData<Serv>,
}
impl<Req, Source, Middleware, Serv> std::fmt::Debug
for WorkerBuilder<Req, Source, Middleware, Serv>
{
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("WorkerBuilder")
.field("id", &self.id)
.field("job", &std::any::type_name::<Req>())
.field("layer", &std::any::type_name::<Middleware>())
.field("source", &std::any::type_name::<Source>())
.finish()
}
}
impl<Serv> WorkerBuilder<(), (), Identity, Serv> {
/// Build a new [`WorkerBuilder`] instance with a name for the worker to build
pub fn new<T: AsRef<str>>(name: T) -> WorkerBuilder<(), (), Identity, Serv> {
let job: PhantomData<()> = PhantomData;
WorkerBuilder {
request: job,
layer: ServiceBuilder::new(),
source: (),
id: WorkerId::new(name),
service: PhantomData,
}
}
}
impl<J, S, M, Serv> WorkerBuilder<J, S, M, Serv> {
/// Consume a stream directly
pub fn stream<NS: Stream<Item = Result<Option<Request<NJ>>, Error>> + Send + 'static, NJ>(
self,
stream: NS,
) -> WorkerBuilder<NJ, NS, M, Serv> {
WorkerBuilder {
request: PhantomData,
layer: self.layer,
source: stream,
id: self.id,
service: self.service,
}
}
/// Set the source to a [Storage]
pub fn with_storage<NS: Storage<Job = NJ>, NJ>(
self,
storage: NS,
) -> WorkerBuilder<NJ, NS, M, Serv> {
WorkerBuilder {
request: PhantomData,
layer: self.layer,
source: storage,
id: self.id,
service: self.service,
}
}
/// Set the source to a [MessageQueue]
pub fn with_mq<NS: MessageQueue<NJ>, NJ>(
self,
message_queue: NS,
) -> WorkerBuilder<NJ, NS, M, Serv> {
WorkerBuilder {
request: PhantomData,
layer: self.layer,
source: message_queue,
id: self.id,
service: self.service,
}
}
/// Set the source to a generic backend that implements only [Backend]
pub fn source<NS: Backend<Request<NJ>>, NJ>(
self,
backend: NS,
) -> WorkerBuilder<NJ, NS, M, Serv> {
WorkerBuilder {
request: PhantomData,
layer: self.layer,
source: backend,
id: self.id,
service: self.service,
}
}
}
impl<Request, Stream, M, Serv> WorkerBuilder<Request, Stream, M, Serv> {
/// Allows of decorating the service that consumes jobs.
/// Allows adding multiple [`tower`] middleware
pub fn chain<NewLayer>(
self,
f: impl Fn(ServiceBuilder<M>) -> ServiceBuilder<NewLayer>,
) -> WorkerBuilder<Request, Stream, NewLayer, Serv> {
let middleware = f(self.layer);
WorkerBuilder {
request: self.request,
layer: middleware,
id: self.id,
source: self.source,
service: self.service,
}
}
/// Allows adding a single layer [tower] middleware
pub fn layer<U>(self, layer: U) -> WorkerBuilder<Request, Stream, Stack<U, M>, Serv>
where
M: Layer<U>,
{
WorkerBuilder {
request: self.request,
source: self.source,
layer: self.layer.layer(layer),
id: self.id,
service: self.service,
}
}
/// Adds data to the context
/// This will be shared by all requests
pub fn data<D>(self, data: D) -> WorkerBuilder<Request, Stream, Stack<Data<D>, M>, Serv>
where
M: Layer<Data<D>>,
{
WorkerBuilder {
request: self.request,
source: self.source,
layer: self.layer.layer(Data::new(data)),
id: self.id,
service: self.service,
}
}
}
impl<Req: Send + 'static + Sync, P: Backend<Request<Req>> + 'static, M: 'static, S>
WorkerFactory<Req, S> for WorkerBuilder<Req, P, M, S>
where
S: Service<Request<Req>> + Send + 'static + Clone + Sync,
S::Future: Send,
S::Response: 'static,
P::Layer: Layer<S>,
M: Layer<<P::Layer as Layer<S>>::Service>,
{
type Source = P;
type Service = M::Service;
/// Build a worker, given a tower service
fn build(self, service: S) -> Worker<Ready<Self::Service, P>> {
let worker_id = self.id;
let common_layer = self.source.common_layer(worker_id.clone());
let poller = self.source;
let middleware = self.layer.layer(common_layer);
let service = middleware.service(service);
Worker::new(worker_id, Ready::new(service, poller))
}
}
/// Helper trait for building new Workers from [`WorkerBuilder`]
pub trait WorkerFactory<J, S> {
/// The request source for the worker
type Source;
/// The service that the worker will run jobs against
type Service;
/// Builds a [`WorkerFactory`] using a [`tower`] service
/// that can be used to generate a new [`Worker`] using the `build` method
/// # Arguments
///
/// * `service` - A tower service
///
/// # Examples
///
fn build(self, service: S) -> Worker<Ready<Self::Service, Self::Source>>;
}
/// Helper trait for building new Workers from [`WorkerBuilder`]
pub trait WorkerFactoryFn<J, F, K> {
/// The request source for the [`Worker`]
type Source;
/// The service that the worker will run jobs against
type Service;
/// Builds a [`WorkerFactoryFn`] using [`ServiceFn`]
/// that can be used to generate new [`Worker`] using the `build_fn` method
/// # Arguments
///
/// * `f` - A functional service.
///
/// # Examples
///
/// A function can take many forms to allow flexibility
/// - An async function with a single argument of the item being processed
/// - An async function with an argument of the item being processed plus up-to 16 arguments that are extracted from the request [`Data`]
///
/// A function can return:
/// - Unit
/// - primitive
/// - Result<T, E: Error>
/// - impl IntoResponse
///
/// ```rust
/// #[derive(Debug)]
/// struct Email;
/// #[derive(Debug)]
/// struct PgPool;
/// # struct PgError;
///
/// async fn send_email(email: Email) {
/// // Implementation of the job function
/// // ...
/// }
///
/// async fn send_email(email: Email, data: Data<PgPool>) -> Result<(), PgError> {
/// // Implementation of the job function?
/// // ...
/// Ok(())
/// }
/// ```
///
fn build_fn(self, f: F) -> Worker<Ready<Self::Service, Self::Source>>;
}
impl<J, W, F, K> WorkerFactoryFn<J, F, K> for W
where
W: WorkerFactory<J, ServiceFn<F, K>>,
{
type Source = W::Source;
type Service = W::Service;
fn build_fn(self, f: F) -> Worker<Ready<Self::Service, Self::Source>> {
self.build(service_fn(f))
}
}