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 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::{quote, quote_spanned, ToTokens};
use syn::parse::Parser;
// syn::AttributeArgs does not implement syn::Parse
type AttributeArgs = syn::punctuated::Punctuated<syn::NestedMeta, syn::Token![,]>;
fn token_stream_with_error(mut tokens: TokenStream, error: syn::Error) -> TokenStream {
tokens.extend(TokenStream::from(error.into_compile_error()));
tokens
}
#[derive(Default)]
struct Configuration {
services: Option<Services>,
init_subscriber: Option<bool>,
shutdown_handler: Option<String>,
}
impl Configuration {
fn new() -> Self {
Self::default()
}
fn set_services(&mut self, services: &AttributeArgs, span: Span) -> Result<(), syn::Error> {
if self.services.is_some() {
return Err(syn::Error::new(span, "`services` set multiple times."));
}
let services = parse_services(services)?;
let mut cfg_services = Services::default();
for service in services {
if service.as_str() == "data" {
if cfg_services.data {
return Err(syn::Error::new(span, "`data` set multiple times."));
}
cfg_services.data = true;
}
if service.as_str() == "diagnostics" {
if cfg_services.diagnostics {
return Err(syn::Error::new(span, "`diagnostics` set multiple times."));
}
cfg_services.diagnostics = true;
}
if service.as_str() == "resource" {
if cfg_services.resource {
return Err(syn::Error::new(span, "`resource` set multiple times."));
}
cfg_services.resource = true;
}
if service.as_str() == "stream" {
if cfg_services.stream {
return Err(syn::Error::new(span, "`stream` set multiple times."));
}
cfg_services.stream = true;
}
}
self.services = Some(cfg_services);
Ok(())
}
fn set_init_subscriber(
&mut self,
init_subscriber: syn::Lit,
span: Span,
) -> Result<(), syn::Error> {
if self.init_subscriber.is_some() {
return Err(syn::Error::new(
span,
"`init_subscriber` set multiple times.",
));
}
let init_subscriber = parse_bool(init_subscriber, span, "init_subscriber")?;
self.init_subscriber = Some(init_subscriber);
Ok(())
}
fn set_shutdown_handler(
&mut self,
shutdown_handler: syn::Lit,
span: Span,
) -> Result<(), syn::Error> {
if self.shutdown_handler.is_some() {
return Err(syn::Error::new(
span,
"`shutdown_handler` set multiple times.",
));
}
let shutdown_handler = parse_string(shutdown_handler, span, "shutdown_handler")?;
self.shutdown_handler = Some(shutdown_handler);
Ok(())
}
fn build(self, span: Span) -> Result<FinalConfig, syn::Error> {
let services = match self.services {
None => {
let msg = "At least one service must be specified in `services`";
return Err(syn::Error::new(span, msg));
}
Some(x) => x,
};
Ok(FinalConfig {
services,
init_subscriber: self.init_subscriber.unwrap_or_default(),
shutdown_handler: self.shutdown_handler,
})
}
}
#[derive(Default)]
struct Services {
stream: bool,
data: bool,
diagnostics: bool,
resource: bool,
}
struct FinalConfig {
services: Services,
init_subscriber: bool,
shutdown_handler: Option<String>,
}
/// Config used in case of the attribute not being able to build a valid config
const DEFAULT_ERROR_CONFIG: FinalConfig = FinalConfig {
services: Services {
stream: false,
data: false,
diagnostics: false,
resource: false,
},
init_subscriber: false,
shutdown_handler: None,
};
fn build_config(input: syn::ItemFn, args: AttributeArgs) -> Result<FinalConfig, syn::Error> {
if input.sig.asyncness.is_none() {
let msg = "the `async` keyword is missing from the function declaration";
return Err(syn::Error::new_spanned(input.sig.fn_token, msg));
}
let mut config = Configuration::new();
for arg in &args {
match arg {
syn::NestedMeta::Meta(syn::Meta::NameValue(namevalue)) => {
let ident = namevalue
.path
.get_ident()
.ok_or_else(|| {
syn::Error::new_spanned(&namevalue, "Must have specified ident")
})?
.to_string()
.to_lowercase();
match ident.as_str() {
"init_subscriber" => config.set_init_subscriber(
namevalue.lit.clone(),
syn::spanned::Spanned::span(&namevalue.lit),
)?,
"shutdown_handler" => config.set_shutdown_handler(
namevalue.lit.clone(),
syn::spanned::Spanned::span(&namevalue.lit),
)?,
name => {
let msg = format!(
"Unknown attribute {} is specified; expected one of: `services`, `init_subscriber`, `shutdown_handler`",
name,
);
return Err(syn::Error::new_spanned(namevalue, msg));
}
}
}
syn::NestedMeta::Meta(syn::Meta::List(list)) => {
let ident = list
.path
.get_ident()
.ok_or_else(|| syn::Error::new_spanned(&list, "Must have specified ident"))?
.to_string()
.to_lowercase();
match ident.as_str() {
"services" => config
.set_services(&list.nested, syn::spanned::Spanned::span(&list.nested))?,
name @ "init_subscriber" | name @ "shutdown_handler" => {
let val = &list.nested;
let msg = format!(
"`{0}` attribute should be specified as `{0} = {1}`",
name,
quote! { #val },
);
return Err(syn::Error::new_spanned(list, msg));
}
name => {
let msg = format!(
"Unknown attribute {} is specified; expected one of: `services`, `init_subscriber`, `shutdown_handler`",
name,
);
return Err(syn::Error::new_spanned(list, msg));
}
}
}
other => {
return Err(syn::Error::new_spanned(
other,
"Unknown attribute inside the macro",
));
}
}
}
config.build(syn::spanned::Spanned::span(&args))
}
fn parse_string(val: syn::Lit, span: Span, field: &str) -> Result<String, syn::Error> {
match val {
syn::Lit::Str(s) => Ok(s.value()),
syn::Lit::Verbatim(s) => Ok(s.to_string()),
_ => Err(syn::Error::new(
span,
format!("Failed to parse value of `{}` as string.", field),
)),
}
}
fn parse_bool(bool: syn::Lit, span: Span, field: &str) -> Result<bool, syn::Error> {
match bool {
syn::Lit::Bool(b) => Ok(b.value),
_ => Err(syn::Error::new(
span,
format!("Failed to parse value of `{}` as bool.", field),
)),
}
}
fn parse_services(list: &AttributeArgs) -> Result<Vec<String>, syn::Error> {
list.iter()
.map(|item| match item {
syn::NestedMeta::Meta(syn::Meta::Path(path)) => {
let svc = path
.get_ident()
.ok_or_else(|| syn::Error::new_spanned(&list, "Must have specified ident"))?
.to_string()
.to_lowercase();
if !["data", "diagnostics", "resource", "stream"].contains(&svc.as_str()) {
let msg = format!(
"invalid service {}; must be one of `data`, `diagnostics`, `resource`, `stream`",
svc,
);
return Err(syn::Error::new_spanned(path, msg))
}
Ok(svc)
},
other => {
let msg = "invalid service specification: must contain one or more of `data`, `diagnostics`, `resource`, `stream`";
Err(syn::Error::new_spanned(other, msg))
}
})
.collect()
}
fn parse_knobs(input: syn::ItemFn, config: FinalConfig) -> TokenStream {
// If type mismatch occurs, the current rustc points to the last statement.
let (last_stmt_start_span, _) = {
let mut last_stmt = input
.block
.stmts
.last()
.map(ToTokens::into_token_stream)
.unwrap_or_default()
.into_iter();
// `Span` on stable Rust has a limitation that only points to the first
// token, not the whole tokens. We can work around this limitation by
// using the first/last span of the tokens like
// `syn::Error::new_spanned` does.
let start = last_stmt.next().map_or_else(Span::call_site, |t| t.span());
let end = last_stmt.last().map_or(start, |t| t.span());
(start, end)
};
let body = input.block;
let mut plugin = quote_spanned! {last_stmt_start_span=>
::grafana_plugin_sdk::backend::Plugin::new()
};
if config.services.data {
plugin = quote! { #plugin.data_service(std::clone::Clone::clone(&service)) };
}
if config.services.diagnostics {
plugin = quote! { #plugin.diagnostics_service(std::clone::Clone::clone(&service)) };
}
if config.services.resource {
plugin = quote! { #plugin.resource_service(std::clone::Clone::clone(&service)) };
}
if config.services.stream {
plugin = quote! { #plugin.stream_service(std::clone::Clone::clone(&service)) };
}
let init_subscriber = config.init_subscriber;
if init_subscriber {
plugin = quote! { #plugin.init_subscriber(#init_subscriber) };
}
if let Some(x) = config.shutdown_handler {
let shutdown_handler =
quote! { #x.parse().expect("could not parse shutdown handler as SocketAddr") };
plugin = quote! { #plugin.shutdown_handler(#shutdown_handler) };
}
let expanded = quote! {
fn main() -> Result<(), Box<dyn std::error::Error>> {
let fut = async {
let listener = ::grafana_plugin_sdk::backend::initialize().await?;
let service = #body;
#plugin
.start(listener)
.await?;
Ok::<_, Box<dyn std::error::Error>>(())
};
::grafana_plugin_sdk::async_main(fut)?;
Ok(())
}
};
TokenStream::from(expanded)
}
/**
Generates a `main` function that starts a [`Plugin`](../grafana_plugin_sdk/backend/struct.Plugin.html) with the returned service struct.
When applied to a function that returns a struct implementing one or more of the various
`Service` traits, `#[main]` will create an async runtime and a [`Plugin`](../grafana_plugin_sdk/backend/struct.Plugin.html),
then attach the desired services
The returned struct _must_ be `Clone` so that it can be used to handle multiple
services.
# Attributes
## `services`
The `services` attribute takes a list of services that the plugin should expose.
At least one service must be specified. Possible options are:
- `data` (registers a [`DataService`](../grafana_plugin_sdk/backend/trait.DataService.html) using [`Plugin::data_service`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.data_service))
- `diagnostics` (registers a [`DiagnosticsService`](../grafana_plugin_sdk/backend/trait.DiagnosticsService.html) using [`Plugin::data_service`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.diagnostics_service))
- `resource` (registers a [`ResourceService`](../grafana_plugin_sdk/backend/trait.ResourceService.html) using [`Plugin::data_service`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.resource_service))
- `stream` (registers a [`StreamService`](../grafana_plugin_sdk/backend/trait.StreamService.html) using [`Plugin::data_service`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.stream_service))
### Example:
```rust
# use std::sync::Arc;
#
# use grafana_plugin_sdk::{backend, data};
#
# #[derive(Clone)]
# struct Plugin;
#
# #[derive(Debug)]
# struct QueryError {
# source: data::Error,
# ref_id: String,
# }
#
# impl std::fmt::Display for QueryError {
# fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
# write!(f, "Error in query {}: {}", self.ref_id, self.source)
# }
# }
#
# impl std::error::Error for QueryError {}
#
# impl backend::DataQueryError for QueryError {
# fn ref_id(self) -> String {
# self.ref_id
# }
# }
#
# #[backend::async_trait]
# impl backend::DataService for Plugin {
# type QueryError = QueryError;
# type Iter = backend::BoxDataResponseIter<Self::QueryError>;
# async fn query_data(&self, request: backend::QueryDataRequest) -> Self::Iter {
# todo!()
# }
# }
#
# #[backend::async_trait]
# impl backend::DiagnosticsService for Plugin {
# type CheckHealthError = std::convert::Infallible;
#
# async fn check_health(
# &self,
# request: backend::CheckHealthRequest,
# ) -> Result<backend::CheckHealthResponse, Self::CheckHealthError> {
# todo!()
# }
#
# type CollectMetricsError = Arc<dyn std::error::Error + Send + Sync>;
#
# async fn collect_metrics(
# &self,
# request: backend::CollectMetricsRequest,
# ) -> Result<backend::CollectMetricsResponse, Self::CollectMetricsError> {
# todo!()
# }
# }
#
# #[backend::async_trait]
# impl backend::ResourceService for Plugin {
# type Error = Arc<dyn std::error::Error + Send + Sync>;
# type InitialResponse = Vec<u8>;
# type Stream = backend::BoxResourceStream<Self::Error>;
# async fn call_resource(&self, r: backend::CallResourceRequest) -> (Result<Self::InitialResponse, Self::Error>, Self::Stream) {
# todo!()
# }
# }
#
# #[backend::async_trait]
# impl backend::StreamService for Plugin {
# type JsonValue = ();
# async fn subscribe_stream(
# &self,
# request: backend::SubscribeStreamRequest,
# ) -> backend::SubscribeStreamResponse {
# todo!()
# }
# type StreamError = Arc<dyn std::error::Error>;
# type Stream = backend::BoxRunStream<Self::StreamError>;
# async fn run_stream(&self, _request: backend::RunStreamRequest) -> Self::Stream {
# todo!()
# }
# async fn publish_stream(
# &self,
# _request: backend::PublishStreamRequest,
# ) -> backend::PublishStreamResponse {
# todo!()
# }
# }
#[grafana_plugin_sdk::main(
services(data, diagnostics, resource, stream),
)]
async fn plugin() -> Plugin {
Plugin
}
```
## `init_subscriber`
The `init_subscriber` attribute indicates whether a tracing subscriber should be
initialized automatically using
[`Plugin::init_subscriber`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.init_subscriber).
Unless this is being done in the annotated plugin function, this should
generally be set to `true`.
This must be a boolean.
### Example
```
# use std::sync::Arc;
#
# use grafana_plugin_sdk::backend;
#
# #[derive(Clone)]
# struct Plugin;
#
# #[backend::async_trait]
# impl backend::ResourceService for Plugin {
# type Error = Arc<dyn std::error::Error + Send + Sync>;
# type InitialResponse = Vec<u8>;
# type Stream = backend::BoxResourceStream<Self::Error>;
# async fn call_resource(&self, r: backend::CallResourceRequest) -> (Result<Self::InitialResponse, Self::Error>, Self::Stream) {
# todo!()
# }
# }
#
#[grafana_plugin_sdk::main(
services(resource),
init_subscriber = true,
)]
async fn plugin() -> Plugin {
Plugin
}
```
## `shutdown_handler`
The `shutdown_handler` attribute indicates that a shutdown handler should be exposed using
[`Plugin::shutdown_handler`](../grafana_plugin_sdk/backend/struct.Plugin.html#method.shutdown_handler)
This must be a string which can be parsed as a [`SocketAddr`][std::net::SocketAddr] using `SocketAddr::parse`.
### Example
```
# use std::sync::Arc;
#
# use grafana_plugin_sdk::backend;
#
# #[derive(Clone)]
# struct Plugin;
#
# #[backend::async_trait]
# impl backend::ResourceService for Plugin {
# type Error = Arc<dyn std::error::Error + Send + Sync>;
# type InitialResponse = Vec<u8>;
# type Stream = backend::BoxResourceStream<Self::Error>;
# async fn call_resource(&self, r: backend::CallResourceRequest) -> (Result<Self::InitialResponse, Self::Error>, Self::Stream) {
# todo!()
# }
# }
#
#[grafana_plugin_sdk::main(
services(resource),
shutdown_handler = "127.0.0.1:10001",
)]
async fn plugin() -> Plugin {
Plugin
}
```
# Macro expansion
The following example shows what the `#[main]` macro expands to:
```rust
use std::sync::Arc;
use grafana_plugin_sdk::backend;
#[derive(Clone)]
struct Plugin;
#[backend::async_trait]
impl backend::ResourceService for Plugin {
type Error = Arc<dyn std::error::Error + Send + Sync>;
type InitialResponse = Vec<u8>;
type Stream = backend::BoxResourceStream<Self::Error>;
async fn call_resource(&self, r: backend::CallResourceRequest) -> (Result<Self::InitialResponse, Self::Error>, Self::Stream) {
todo!()
}
}
#[grafana_plugin_sdk::main(
services(resource),
init_subscriber = true,
shutdown_handler = "127.0.0.1:10001",
)]
async fn plugin() -> Plugin {
Plugin
}
```
expands to:
```rust
# use std::sync::Arc;
#
# use grafana_plugin_sdk::backend;
#
# #[derive(Clone)]
# struct Plugin;
#
# #[backend::async_trait]
# impl backend::ResourceService for Plugin {
# type Error = Arc<dyn std::error::Error + Send + Sync>;
# type InitialResponse = Vec<u8>;
# type Stream = backend::BoxResourceStream<Self::Error>;
# async fn call_resource(&self, r: backend::CallResourceRequest) -> (Result<Self::InitialResponse, Self::Error>, Self::Stream) {
# todo!()
# }
# }
#
fn main() -> Result<(), Box<dyn std::error::Error>> {
let fut = async {
let listener = ::grafana_plugin_sdk::backend::initialize().await?;
let service = Plugin;
::grafana_plugin_sdk::backend::Plugin::new()
.resource_service(service.clone())
.init_subscriber(true)
.shutdown_handler("127.0.0.1:10001".parse().expect("could not parse shutdown handler as SocketAddr"))
.start(listener)
.await?;
Ok::<_, Box<dyn std::error::Error>>(())
};
# if false {
tokio::runtime::Builder::new_multi_thread()
.thread_name("grafana-plugin-worker-thread")
.enable_all()
.build()
.expect("create tokio runtime")
.block_on(fut)?;
# }
Ok(())
}
```
*/
#[proc_macro_attribute]
pub fn main(args: TokenStream, item: TokenStream) -> TokenStream {
// If any of the steps for this macro fail, we still want to expand to an item that is as close
// to the expected output as possible. This helps out IDEs such that completions and other
// related features keep working.
let input: syn::ItemFn = match syn::parse(item.clone()) {
Ok(it) => it,
Err(e) => return token_stream_with_error(item, e),
};
let config = if input.sig.ident != "plugin" {
let msg = "the plugin function must be named 'plugin'";
Err(syn::Error::new_spanned(&input.sig.ident, msg))
} else if !input.sig.inputs.is_empty() {
let msg = "the plugin function cannot accept arguments";
Err(syn::Error::new_spanned(&input.sig.inputs, msg))
} else {
AttributeArgs::parse_terminated
.parse(args)
.and_then(|args| build_config(input.clone(), args))
};
match config {
Ok(c) => parse_knobs(input, c),
Err(e) => token_stream_with_error(parse_knobs(input, DEFAULT_ERROR_CONFIG), e),
}
}