From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox 4/4] proxmox-api-macro: add 'streaming' option
Date: Fri, 8 Apr 2022 11:56:03 +0200 [thread overview]
Message-ID: <20220408095606.2767234-5-d.csapak@proxmox.com> (raw)
In-Reply-To: <20220408095606.2767234-1-d.csapak@proxmox.com>
to generate the `Streaming` variants of the ApiHandler
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
proxmox-api-macro/src/api/method.rs | 127 +++++++++++++++++++---------
proxmox-api-macro/tests/api1.rs | 16 ++++
2 files changed, 104 insertions(+), 39 deletions(-)
diff --git a/proxmox-api-macro/src/api/method.rs b/proxmox-api-macro/src/api/method.rs
index f82cc53..1db6124 100644
--- a/proxmox-api-macro/src/api/method.rs
+++ b/proxmox-api-macro/src/api/method.rs
@@ -169,6 +169,12 @@ pub fn handle_method(mut attribs: JSONObject, mut func: syn::ItemFn) -> Result<T
.transpose()?
.unwrap_or(false);
+ let streaming: bool = attribs
+ .remove("streaming")
+ .map(TryFrom::try_from)
+ .transpose()?
+ .unwrap_or(false);
+
if !attribs.is_empty() {
error!(
attribs.span(),
@@ -195,6 +201,7 @@ pub fn handle_method(mut attribs: JSONObject, mut func: syn::ItemFn) -> Result<T
&mut func,
&mut wrapper_ts,
&mut default_consts,
+ streaming,
)?;
// input schema is done, let's give the method body a chance to extract default parameters:
@@ -217,10 +224,11 @@ pub fn handle_method(mut attribs: JSONObject, mut func: syn::ItemFn) -> Result<T
returns_schema_setter = quote! { .returns(#inner) };
}
- let api_handler = if is_async {
- quote! { ::proxmox_router::ApiHandler::Async(&#api_func_name) }
- } else {
- quote! { ::proxmox_router::ApiHandler::Sync(&#api_func_name) }
+ let api_handler = match (streaming, is_async) {
+ (true, true) => quote! { ::proxmox_router::ApiHandler::StreamingAsync(&#api_func_name) },
+ (true, false) => quote! { ::proxmox_router::ApiHandler::StreamingSync(&#api_func_name) },
+ (false, true) => quote! { ::proxmox_router::ApiHandler::Async(&#api_func_name) },
+ (false, false) => quote! { ::proxmox_router::ApiHandler::Sync(&#api_func_name) },
};
Ok(quote_spanned! { func.sig.span() =>
@@ -279,6 +287,7 @@ fn handle_function_signature(
func: &mut syn::ItemFn,
wrapper_ts: &mut TokenStream,
default_consts: &mut TokenStream,
+ streaming: bool,
) -> Result<Ident, Error> {
let sig = &func.sig;
let is_async = sig.asyncness.is_some();
@@ -414,6 +423,7 @@ fn handle_function_signature(
wrapper_ts,
default_consts,
is_async,
+ streaming,
)
}
@@ -471,6 +481,7 @@ fn create_wrapper_function(
wrapper_ts: &mut TokenStream,
default_consts: &mut TokenStream,
is_async: bool,
+ streaming: bool,
) -> Result<Ident, Error> {
let api_func_name = Ident::new(
&format!("api_function_{}", &func.sig.ident),
@@ -512,45 +523,83 @@ fn create_wrapper_function(
_ => Some(quote!(?)),
};
- let body = quote! {
- if let ::serde_json::Value::Object(ref mut input_map) = &mut input_params {
- #body
- Ok(::serde_json::to_value(#func_name(#args) #await_keyword #question_mark)?)
- } else {
- ::anyhow::bail!("api function wrapper called with a non-object json value");
- }
- };
-
- if is_async {
- wrapper_ts.extend(quote! {
- fn #api_func_name<'a>(
- mut input_params: ::serde_json::Value,
- api_method_param: &'static ::proxmox_router::ApiMethod,
- rpc_env_param: &'a mut dyn ::proxmox_router::RpcEnvironment,
- ) -> ::proxmox_router::ApiFuture<'a> {
- //async fn func<'a>(
- // mut input_params: ::serde_json::Value,
- // api_method_param: &'static ::proxmox_router::ApiMethod,
- // rpc_env_param: &'a mut dyn ::proxmox_router::RpcEnvironment,
- //) -> ::std::result::Result<::serde_json::Value, ::anyhow::Error> {
- // #body
- //}
- //::std::boxed::Box::pin(async move {
- // func(input_params, api_method_param, rpc_env_param).await
- //})
- ::std::boxed::Box::pin(async move { #body })
+ let body = if streaming {
+ quote! {
+ if let ::serde_json::Value::Object(ref mut input_map) = &mut input_params {
+ #body
+ let res = #func_name(#args) #await_keyword #question_mark;
+ let res: ::std::boxed::Box<dyn ::proxmox_router::SerializableReturn + Send> = ::std::boxed::Box::new(res);
+ Ok(res)
+ } else {
+ ::anyhow::bail!("api function wrapper called with a non-object json value");
}
- });
+ }
} else {
- wrapper_ts.extend(quote! {
- fn #api_func_name(
- mut input_params: ::serde_json::Value,
- api_method_param: &::proxmox_router::ApiMethod,
- rpc_env_param: &mut dyn ::proxmox_router::RpcEnvironment,
- ) -> ::std::result::Result<::serde_json::Value, ::anyhow::Error> {
+ quote! {
+ if let ::serde_json::Value::Object(ref mut input_map) = &mut input_params {
#body
+ Ok(::serde_json::to_value(#func_name(#args) #await_keyword #question_mark)?)
+ } else {
+ ::anyhow::bail!("api function wrapper called with a non-object json value");
}
- });
+ }
+ };
+
+ match (streaming, is_async) {
+ (true, true) => {
+ wrapper_ts.extend(quote! {
+ fn #api_func_name<'a>(
+ mut input_params: ::serde_json::Value,
+ api_method_param: &'static ::proxmox_router::ApiMethod,
+ rpc_env_param: &'a mut dyn ::proxmox_router::RpcEnvironment,
+ ) -> ::proxmox_router::StreamingApiFuture<'a> {
+ ::std::boxed::Box::pin(async move { #body })
+ }
+ });
+ }
+ (true, false) => {
+ wrapper_ts.extend(quote! {
+ fn #api_func_name(
+ mut input_params: ::serde_json::Value,
+ api_method_param: &::proxmox_router::ApiMethod,
+ rpc_env_param: &mut dyn ::proxmox_router::RpcEnvironment,
+ ) -> ::std::result::Result<::std::boxed::Box<dyn ::proxmox_router::SerializableReturn + Send>, ::anyhow::Error> {
+ #body
+ }
+ });
+ }
+ (false, true) => {
+ wrapper_ts.extend(quote! {
+ fn #api_func_name<'a>(
+ mut input_params: ::serde_json::Value,
+ api_method_param: &'static ::proxmox_router::ApiMethod,
+ rpc_env_param: &'a mut dyn ::proxmox_router::RpcEnvironment,
+ ) -> ::proxmox_router::ApiFuture<'a> {
+ //async fn func<'a>(
+ // mut input_params: ::serde_json::Value,
+ // api_method_param: &'static ::proxmox_router::ApiMethod,
+ // rpc_env_param: &'a mut dyn ::proxmox_router::RpcEnvironment,
+ //) -> ::std::result::Result<::serde_json::Value, ::anyhow::Error> {
+ // #body
+ //}
+ //::std::boxed::Box::pin(async move {
+ // func(input_params, api_method_param, rpc_env_param).await
+ //})
+ ::std::boxed::Box::pin(async move { #body })
+ }
+ });
+ }
+ (false, false) => {
+ wrapper_ts.extend(quote! {
+ fn #api_func_name(
+ mut input_params: ::serde_json::Value,
+ api_method_param: &::proxmox_router::ApiMethod,
+ rpc_env_param: &mut dyn ::proxmox_router::RpcEnvironment,
+ ) -> ::std::result::Result<::serde_json::Value, ::anyhow::Error> {
+ #body
+ }
+ });
+ }
}
Ok(api_func_name)
diff --git a/proxmox-api-macro/tests/api1.rs b/proxmox-api-macro/tests/api1.rs
index fd9a338..ef60370 100644
--- a/proxmox-api-macro/tests/api1.rs
+++ b/proxmox-api-macro/tests/api1.rs
@@ -235,6 +235,22 @@ pub fn basic_function() -> Result<(), Error> {
Ok(())
}
+#[api(
+ streaming: true,
+)]
+/// streaming async call
+pub async fn streaming_async_call() -> Result<(), Error> {
+ Ok(())
+}
+
+#[api(
+ streaming: true,
+)]
+/// streaming sync call
+pub fn streaming_sync_call() -> Result<(), Error> {
+ Ok(())
+}
+
#[api(
input: {
properties: {
--
2.30.2
next prev parent reply other threads:[~2022-04-08 9:56 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-08 9:55 [pbs-devel] [PATCH proxmox/proxmox-backup] implement streaming serialization for api calls Dominik Csapak
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox 1/4] proxmox-async: add SenderWriter helper Dominik Csapak
2022-04-12 12:29 ` [pbs-devel] applied-series: " Wolfgang Bumiller
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox 2/4] promxox-router: add SerializableReturn Trait Dominik Csapak
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox 3/4] proxmox-router: add new ApiHandler variants for streaming serialization Dominik Csapak
2022-04-08 9:56 ` Dominik Csapak [this message]
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox-backup 1/3] proxmox-rest-server: OutputFormatter: add new format_data_streaming method Dominik Csapak
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox-backup 2/3] adapt to the new ApiHandler variants Dominik Csapak
2022-04-08 9:56 ` [pbs-devel] [PATCH proxmox-backup 3/3] api: admin/datastore: enable streaming for some api calls Dominik Csapak
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220408095606.2767234-5-d.csapak@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal