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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
use proc_macro::TokenStream;
use proc_macro_error::{emit_error, proc_macro_error};
use quote::{quote, ToTokens};
use syn::{
parse_macro_input, parse_quote, spanned::Spanned, Attribute, FnArg, Ident, ItemFn, Pat, Path,
ReturnType, Signature, Stmt, Type,
};
#[proc_macro_error]
#[proc_macro_attribute]
pub fn main(_attr: TokenStream, item: TokenStream) -> TokenStream {
let mut fn_decl = parse_macro_input!(item as ItemFn);
let wrapper = Wrapper::from_item_fn(&mut fn_decl);
let expanded = quote! {
#wrapper
fn __binder(
service: Box<dyn shuttle_service::Service>,
addr: std::net::SocketAddr,
runtime: &shuttle_service::Runtime,
) -> shuttle_service::ServeHandle {
runtime.spawn(async move { service.bind(addr).await })
}
#fn_decl
#[no_mangle]
pub extern "C" fn _create_service() -> *mut shuttle_service::Bootstrapper {
let builder: shuttle_service::StateBuilder<Box<dyn shuttle_service::Service>> =
|factory, runtime, logger| Box::pin(__shuttle_wrapper(factory, runtime, logger));
let bootstrapper = shuttle_service::Bootstrapper::new(
builder,
__binder,
shuttle_service::Runtime::new().unwrap(),
);
let boxed = Box::new(bootstrapper);
Box::into_raw(boxed)
}
};
expanded.into()
}
struct Wrapper {
fn_ident: Ident,
fn_inputs: Vec<Input>,
}
#[derive(Debug, PartialEq)]
struct Input {
ident: Ident,
builder: Path,
}
impl Wrapper {
fn from_item_fn(item_fn: &mut ItemFn) -> Self {
let inputs: Vec<_> = item_fn
.sig
.inputs
.iter_mut()
.filter_map(|input| match input {
FnArg::Receiver(_) => None,
FnArg::Typed(typed) => Some(typed),
})
.filter_map(|typed| match typed.pat.as_ref() {
Pat::Ident(ident) => Some((ident, typed.attrs.drain(..).collect())),
_ => None,
})
.filter_map(|(pat_ident, attrs)| {
match attribute_to_path(attrs) {
Ok(builder) => Some(Input {
ident: pat_ident.ident.clone(),
builder,
}),
Err(err) => {
emit_error!(pat_ident, err; hint = pat_ident.span() => "Try adding a config like `#[shared::Postgres]`");
None
}
}
})
.collect();
check_return_type(&item_fn.sig);
Self {
fn_ident: item_fn.sig.ident.clone(),
fn_inputs: inputs,
}
}
}
fn check_return_type(signature: &Signature) {
match &signature.output {
ReturnType::Default => emit_error!(
signature,
"shuttle_service::main functions need to return a service";
hint = "See the docs for services with first class support";
doc = "https://docs.rs/shuttle-service/latest/shuttle_service/attr.main.html#shuttle-supported-services"
),
ReturnType::Type(_, r#type) => match r#type.as_ref() {
Type::Path(_) => {}
_ => emit_error!(
r#type,
"shuttle_service::main functions need to return a first class service or 'Result<impl Service, shuttle_service::Error>";
hint = "See the docs for services with first class support";
doc = "https://docs.rs/shuttle-service/latest/shuttle_service/attr.main.html#shuttle-supported-services"
),
},
}
}
fn attribute_to_path(attrs: Vec<Attribute>) -> Result<Path, String> {
if attrs.is_empty() {
return Err("resource needs an attribute configuration".to_string());
}
let builder = attrs[0].path.clone();
Ok(builder)
}
impl ToTokens for Wrapper {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
let fn_ident = &self.fn_ident;
let fn_inputs: Vec<_> = self.fn_inputs.iter().map(|i| i.ident.clone()).collect();
let fn_inputs_builder: Vec<_> = self.fn_inputs.iter().map(|i| i.builder.clone()).collect();
let factory_ident: Ident = if self.fn_inputs.is_empty() {
parse_quote!(_factory)
} else {
parse_quote!(factory)
};
let extra_imports: Option<Stmt> = if self.fn_inputs.is_empty() {
None
} else {
Some(parse_quote!(
use shuttle_service::ResourceBuilder;
))
};
let wrapper = quote! {
async fn __shuttle_wrapper(
#factory_ident: &mut dyn shuttle_service::Factory,
runtime: &shuttle_service::Runtime,
logger: Box<dyn shuttle_service::log::Log>,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
#extra_imports
runtime.spawn_blocking(move || {
shuttle_service::log::set_boxed_logger(logger)
.map(|()| shuttle_service::log::set_max_level(shuttle_service::log::LevelFilter::Info))
.expect("logger set should succeed");
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?;
#(let #fn_inputs = shuttle_service::#fn_inputs_builder::new().build(#factory_ident, runtime).await?;)*
runtime.spawn(async {
#fn_ident(#(#fn_inputs),*)
.await
.map(|ok| Box::new(ok) as Box<dyn shuttle_service::Service>)
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?
}
};
wrapper.to_tokens(tokens);
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use quote::quote;
use syn::{parse_quote, Ident};
use crate::{Input, Wrapper};
#[test]
fn from_with_return() {
let mut input = parse_quote!(
async fn complex() -> ShuttleAxum {}
);
let actual = Wrapper::from_item_fn(&mut input);
let expected_ident: Ident = parse_quote!(complex);
assert_eq!(actual.fn_ident, expected_ident);
assert_eq!(actual.fn_inputs, Vec::<Input>::new());
}
#[test]
fn output_with_return() {
let input = Wrapper {
fn_ident: parse_quote!(complex),
fn_inputs: Vec::new(),
};
let actual = quote!(#input);
let expected = quote! {
async fn __shuttle_wrapper(
_factory: &mut dyn shuttle_service::Factory,
runtime: &shuttle_service::Runtime,
logger: Box<dyn shuttle_service::log::Log>,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
runtime.spawn_blocking(move || {
shuttle_service::log::set_boxed_logger(logger)
.map(|()| shuttle_service::log::set_max_level(shuttle_service::log::LevelFilter::Info))
.expect("logger set should succeed");
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?;
runtime.spawn(async {
complex()
.await
.map(|ok| Box::new(ok) as Box<dyn shuttle_service::Service>)
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?
}
};
assert_eq!(actual.to_string(), expected.to_string());
}
#[test]
fn from_with_inputs() {
let mut input = parse_quote!(
async fn complex(#[shared::Postgres] pool: PgPool) -> ShuttleTide {}
);
let actual = Wrapper::from_item_fn(&mut input);
let expected_ident: Ident = parse_quote!(complex);
let expected_inputs: Vec<Input> = vec![Input {
ident: parse_quote!(pool),
builder: parse_quote!(shared::Postgres),
}];
assert_eq!(actual.fn_ident, expected_ident);
assert_eq!(actual.fn_inputs, expected_inputs);
if let syn::FnArg::Typed(param) = input.sig.inputs.first().unwrap() {
assert!(
param.attrs.is_empty(),
"some attributes were not removed: {:?}",
param.attrs
);
} else {
panic!("expected first input to be typed")
}
}
#[test]
fn output_with_inputs() {
let input = Wrapper {
fn_ident: parse_quote!(complex),
fn_inputs: vec![
Input {
ident: parse_quote!(pool),
builder: parse_quote!(shared::Postgres),
},
Input {
ident: parse_quote!(redis),
builder: parse_quote!(shared::Redis),
},
],
};
let actual = quote!(#input);
let expected = quote! {
async fn __shuttle_wrapper(
factory: &mut dyn shuttle_service::Factory,
runtime: &shuttle_service::Runtime,
logger: Box<dyn shuttle_service::log::Log>,
) -> Result<Box<dyn shuttle_service::Service>, shuttle_service::Error> {
use shuttle_service::ResourceBuilder;
runtime.spawn_blocking(move || {
shuttle_service::log::set_boxed_logger(logger)
.map(|()| shuttle_service::log::set_max_level(shuttle_service::log::LevelFilter::Info))
.expect("logger set should succeed");
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?;
let pool = shuttle_service::shared::Postgres::new().build(factory, runtime).await?;
let redis = shuttle_service::shared::Redis::new().build(factory, runtime).await?;
runtime.spawn(async {
complex(pool, redis)
.await
.map(|ok| Box::new(ok) as Box<dyn shuttle_service::Service>)
})
.await
.map_err(|e| {
if e.is_panic() {
let mes = e
.into_panic()
.downcast_ref::<&str>()
.map(|x| x.to_string())
.unwrap_or_else(|| "<no panic message>".to_string());
shuttle_service::Error::BuildPanic(mes)
} else {
shuttle_service::Error::Custom(shuttle_service::error::CustomError::new(e))
}
})?
}
};
assert_eq!(actual.to_string(), expected.to_string());
}
#[test]
fn ui() {
let t = trybuild::TestCases::new();
t.compile_fail("tests/ui/*.rs");
}
}