use crate::core::backend::GeneratedFile;
use crate::core::config::ResolvedCrateConfig;
use crate::core::ir::{
ApiSurface, EntrypointKind, HandlerContractDef, RegistrationDef, RegistrationVariant, ServiceDef, TypeRef,
};
use heck::{ToSnakeCase, ToUpperCamelCase};
use std::path::PathBuf;
fn r_type_annotation(ty: &TypeRef) -> String {
match ty {
TypeRef::String | TypeRef::Char => "character".to_owned(),
TypeRef::Primitive(p) => {
use crate::core::ir::PrimitiveType;
match p {
PrimitiveType::Bool => "logical".to_owned(),
_ => "numeric".to_owned(),
}
}
TypeRef::Bytes => "raw".to_owned(),
TypeRef::Optional(_) => "NULL or other".to_owned(),
TypeRef::Vec(_) => "list".to_owned(),
TypeRef::Map(_, _) => "list".to_owned(),
TypeRef::Unit => "NULL".to_owned(),
TypeRef::Named(n) => n.clone(),
TypeRef::Json => "list".to_owned(),
TypeRef::Path => "character".to_owned(),
TypeRef::Duration => "numeric".to_owned(),
}
}
fn find_contract<'a>(api: &'a ApiSurface, trait_name: &str) -> Option<&'a HandlerContractDef> {
api.handler_contracts.iter().find(|c| c.trait_name == trait_name)
}
pub(super) fn gen_service_r(api: &ApiSurface, package_name: &str) -> String {
let mut out = String::new();
out.push_str("# Generated R interface for service API\n");
out.push_str("# DO NOT EDIT: regenerate this file via alef\n\n");
for service in &api.services {
gen_service_class(&mut out, service, api, package_name);
}
out
}
fn gen_service_class(out: &mut String, service: &ServiceDef, api: &ApiSurface, _package_name: &str) {
let class_name = &service.name;
let constructor = &service.constructor;
{
out.push_str(&format!("#' Create a new {class_name} instance\n"));
out.push_str(&format!(
"#'\n#' @description\n#' {}",
if !service.doc.is_empty() {
service.doc.trim().to_owned()
} else {
"Initialize a service instance.".to_owned()
}
));
out.push('\n');
out.push_str("#'\n");
for param in &constructor.params {
let ty_str = r_type_annotation(¶m.ty);
out.push_str(&format!("#' @param {} {} Parameter\n", param.name, ty_str));
}
out.push_str("#' @return An S3 object of class 'ServiceDef'\n");
out.push_str("#' @export\n");
let param_names: Vec<&str> = constructor.params.iter().map(|p| p.name.as_str()).collect();
let params_str = if param_names.is_empty() {
String::new()
} else {
param_names.join(" = , ").to_owned()
};
out.push_str(&format!("{class_name} <- function({params_str}) {{\n"));
out.push_str(" obj <- list(\n");
out.push_str(" .registrations = list(),\n");
for param in &constructor.params {
out.push_str(&format!(" .{} = {},\n", param.name, param.name));
}
out.push_str(" .class = \"");
out.push_str(class_name);
out.push_str("\"\n");
out.push_str(" )\n");
out.push_str(" class(obj) <- c(\"");
out.push_str(class_name);
out.push_str("\", \"list\")\n");
out.push_str(" obj\n");
out.push_str("}\n\n");
}
for method in &service.configurators {
let method_name = &method.name;
out.push_str(&format!("#' Configure service: {method_name}\n"));
out.push_str(&format!(
"#'\n#' @description\n#' {}",
if !method.doc.is_empty() {
method.doc.trim().to_owned()
} else {
"Apply a configuration.".to_owned()
}
));
out.push('\n');
out.push_str("#'\n");
out.push_str("#' @param x An S3 object of class '");
out.push_str(class_name);
out.push_str("'\n");
for param in &method.params {
let ty_str = r_type_annotation(¶m.ty);
out.push_str(&format!("#' @param {} {} Parameter\n", param.name, ty_str));
}
out.push_str("#' @return Updated S3 object (invisibly)\n");
out.push_str("#' @export\n");
out.push_str(&format!("{method_name}.{class_name} <- function(x"));
for param in &method.params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(") {\n");
for param in &method.params {
out.push_str(&format!(" x$.{} <- {}\n", param.name, param.name));
}
out.push_str(" invisible(x)\n");
out.push_str("}\n\n");
}
for reg in &service.registrations {
gen_registration_method(out, reg, service, api);
}
for ep in &service.entrypoints {
let ep_name = &ep.method;
match ep.kind {
EntrypointKind::Run => {
out.push_str("#' Run the service\n");
out.push_str(&format!(
"#'\n#' @description\n#' {}",
if !ep.doc.is_empty() {
ep.doc.trim().to_owned()
} else {
"Execute the service.".to_owned()
}
));
out.push('\n');
out.push_str("#'\n");
out.push_str("#' @param x An S3 object of class '");
out.push_str(class_name);
out.push_str("'\n");
for param in &ep.params {
let ty_str = r_type_annotation(¶m.ty);
out.push_str(&format!("#' @param {} {} Parameter\n", param.name, ty_str));
}
out.push_str("#' @return Invisibly NULL\n");
out.push_str("#' @export\n");
out.push_str(&format!("{ep_name}.{class_name} <- function(x"));
for param in &ep.params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(") {\n");
let native_fn = format!("{service_snake}_{ep_name}", service_snake = class_name.to_snake_case());
out.push_str(&format!(" .Call(`{native_fn}`, x$.registrations"));
for param in &ep.params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(")\n");
out.push_str(" invisible(NULL)\n");
out.push_str("}\n\n");
}
EntrypointKind::Finalize => {
out.push_str("#' Finalize the service\n");
out.push_str(&format!(
"#'\n#' @description\n#' {}",
if !ep.doc.is_empty() {
ep.doc.trim().to_owned()
} else {
"Finalize and return result.".to_owned()
}
));
out.push('\n');
out.push_str("#'\n");
out.push_str("#' @param x An S3 object of class '");
out.push_str(class_name);
out.push_str("'\n");
for param in &ep.params {
let ty_str = r_type_annotation(¶m.ty);
out.push_str(&format!("#' @param {} {} Parameter\n", param.name, ty_str));
}
out.push_str("#' @return Result from finalization\n");
out.push_str("#' @export\n");
out.push_str(&format!("{ep_name}.{class_name} <- function(x"));
for param in &ep.params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(") {\n");
let native_fn = format!("{service_snake}_{ep_name}", service_snake = class_name.to_snake_case());
out.push_str(&format!(" .Call(`{native_fn}`, x$.registrations"));
for param in &ep.params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(")\n");
out.push_str("}\n\n");
}
}
}
}
fn gen_registration_method(out: &mut String, reg: &RegistrationDef, service: &ServiceDef, _api: &ApiSurface) {
let method_name = ®.method;
let class_name = &service.name;
let callback_param = ®.callback_param;
out.push_str("#' Register a callback\n");
out.push_str(&format!(
"#'\n#' @description\n#' {}",
if !reg.doc.is_empty() {
reg.doc.trim().to_owned()
} else {
"Register a callback handler.".to_owned()
}
));
out.push('\n');
out.push_str("#'\n");
out.push_str("#' @param x An S3 object of class '");
out.push_str(class_name);
out.push_str("'\n");
for param in ®.metadata_params {
let ty_str = r_type_annotation(¶m.ty);
out.push_str(&format!("#' @param {} {} Metadata parameter\n", param.name, ty_str));
}
out.push_str(&format!("#' @param {} Callback function (closure)\n", callback_param));
out.push_str("#' @return Updated S3 object (invisibly)\n");
out.push_str("#' @export\n");
out.push_str(&format!("{method_name}.{class_name} <- function(x"));
for param in ®.metadata_params {
out.push_str(", ");
out.push_str(¶m.name);
}
out.push_str(&format!(", {callback_param}"));
out.push_str(") {\n");
let meta_names: Vec<&str> = reg.metadata_params.iter().map(|p| p.name.as_str()).collect();
if meta_names.is_empty() {
out.push_str(&format!(
" x$.registrations[[length(x$.registrations) + 1]] <- list(\"{method_name}\", list(), {callback_param})\n"
));
} else {
out.push_str(&format!(
" x$.registrations[[length(x$.registrations) + 1]] <- list(\"{method_name}\", list({}), {callback_param})\n",
meta_names.join(", ")
));
}
out.push_str(" invisible(x)\n");
out.push_str("}\n\n");
for variant in ®.variants {
gen_registration_variant(out, variant, reg, service, class_name, callback_param);
}
}
fn gen_registration_variant(
out: &mut String,
variant: &RegistrationVariant,
reg: &RegistrationDef,
_service: &ServiceDef,
class_name: &str,
callback_param: &str,
) {
use crate::core::ir::WrapperConstructorArg;
let variant_name = &variant.name;
let base_method = ®.method;
let wrapper_expr = if let Some(wc) = &variant.wrapper_call {
let mut call_args = vec![];
for arg in &wc.args {
match arg {
WrapperConstructorArg::Fixed { value_expr, .. } => {
call_args.push(value_expr.clone());
}
WrapperConstructorArg::Free { param } => {
call_args.push(param.name.clone());
}
}
}
Some(format!(
"{}::{}({})",
wc.wrapper_type_path,
wc.constructor_method,
call_args.join(", ")
))
} else {
None
};
let rendered = crate::backends::extendr::template_env::render(
"registration_variant.rs.jinja",
minijinja::context! {
variant_name => variant_name,
class_name => class_name,
callback_param => callback_param,
base_method => base_method,
doc => variant.doc.as_deref().unwrap_or(""),
signature_params => variant.signature_params.iter().map(|p| minijinja::context! {
name => p.name.as_str(),
ty_annotation => r_type_annotation(&p.ty),
}).collect::<Vec<_>>(),
overrides => variant.overrides.iter().map(|o| minijinja::context! {
param_name => o.param_name.as_str(),
value_expr => o.value_expr.as_str(),
}).collect::<Vec<_>>(),
wrapper_expr => wrapper_expr.as_deref().unwrap_or(""),
},
);
out.push_str(&rendered);
}
pub(super) fn gen_service_rs(api: &ApiSurface, config: &ResolvedCrateConfig) -> String {
let core_import = config.core_import_name();
let mut out = String::new();
out.push_str("#![allow(clippy::too_many_arguments)]\n\n");
out.push_str("use extendr_api::prelude::*;\n");
out.push_str("use std::sync::Arc;\n");
out.push_str("use std::future::Future;\n");
out.push_str("use std::pin::Pin;\n\n");
let referenced_contracts: Vec<&HandlerContractDef> = {
let mut names: Vec<&str> = api
.services
.iter()
.flat_map(|s| s.registrations.iter())
.map(|r| r.callback_contract.as_str())
.collect();
names.sort_unstable();
names.dedup();
names.iter().filter_map(|n| find_contract(api, n)).collect()
};
for contract in &referenced_contracts {
gen_handler_bridge(&mut out, contract, &core_import);
}
for service in &api.services {
for ep in &service.entrypoints {
gen_run_extendr_function(&mut out, service, ep, api, &core_import);
}
}
out
}
fn gen_handler_bridge(out: &mut String, contract: &HandlerContractDef, core_import: &str) {
let trait_name = &contract.trait_name;
let bridge_name = format!("Extendr{}Bridge", trait_name.to_upper_camel_case());
let dispatch_name = &contract.dispatch.name;
let req_type = contract.wire_request_type.as_deref().unwrap_or("serde_json::Value");
let resp_type = contract.wire_response_type.as_deref().unwrap_or("serde_json::Value");
let req_path = if req_type == "Value" {
"serde_json::Value".to_string()
} else {
format!("{core_import}::{req_type}")
};
let resp_path = if resp_type == "Value" {
"serde_json::Value".to_string()
} else {
format!("{core_import}::{resp_type}")
};
let extra_param: String = contract
.dispatch_extra_params
.iter()
.map(|p| format!(", {p}"))
.collect();
let wire_name = contract.wire_param_name.as_deref().unwrap_or("request");
out.push_str(&format!(
"/// Generated extendr bridge for the `{trait_name}` contract.\n\
///\n\
/// Wraps an R closure so it can be used as `Arc<dyn {trait_name}>` from Rust.\n\
/// Because R is single-threaded, this bridge runs calls synchronously,\n\
/// blocking the current thread within an async wrapper. The Tokio runtime\n\
/// (if active) is blocked; otherwise a local runtime is created per call.\n\
pub struct {bridge_name} {{\n \
closure: Robj,\n\
}}\n\n"
));
out.push_str(&format!(
"impl {bridge_name} {{\n \
/// Create a bridge from an R closure.\n \
pub fn new(closure: Robj) -> Self {{\n \
Self {{ closure }}\n \
}}\n\
}}\n\n"
));
out.push_str(&format!(
"// SAFETY: Robj is Send+Sync in extendr. R's GC protects the underlying closure.\n\
unsafe impl Send for {bridge_name} {{}}\n\
unsafe impl Sync for {bridge_name} {{}}\n\n"
));
let box_err = "Box<dyn std::error::Error + Send + Sync>";
let wire_output = format!("Result<{resp_path}, {box_err}>");
let output_type = contract
.dispatch_return_type
.clone()
.unwrap_or_else(|| wire_output.clone());
let tail = match &contract.response_adapter {
Some(adapter) => format!("{adapter}(outcome)"),
None => "outcome".to_string(),
};
out.push_str(&format!(
"impl {core_import}::{trait_name} for {bridge_name} {{\n \
fn {dispatch_name}(\n \
&self{extra_param},\n \
{wire_name}: {req_path},\n \
) -> Pin<Box<dyn Future<Output = {output_type}> + Send + '_>> {{\n \
// Create a clone of the closure for the async block (owned move).\n \
let closure = self.closure.clone();\n\n \
Box::pin(async move {{\n \
let outcome: {wire_output} = async move {{\n \
// Serialize the request to JSON\n \
let req_json = serde_json::to_string(&{wire_name})\n \
.map_err(|e| Box::new(e) as {box_err})?;\n\n \
// Call the R closure synchronously (R is single-threaded).\n \
// If a Tokio runtime is active, block on it; otherwise create a local runtime.\n \
let raw_result = if let Ok(handle) = tokio::runtime::Handle::try_current() {{\n \
// We are already in an async context; use block_in_place to free the executor.\n \
tokio::task::block_in_place(|| {{\n \
Self::call_r_closure_blocking_static(&closure, &req_json)\n \
}})\n \
}} else {{\n \
// No runtime: call directly.\n \
Self::call_r_closure_blocking_static(&closure, &req_json)\n \
}}?;\n\n \
// Deserialize the JSON result back into the wire response DTO.\n \
let response: {resp_path} = serde_json::from_str(&raw_result)\n \
.map_err(|e| Box::new(e) as {box_err})?;\n \
Ok(response)\n \
}}\n \
.await;\n\n \
{tail}\n \
}})\n \
}}\n\
}}\n\n"
));
out.push_str(&format!(
"impl {bridge_name} {{\n \
/// Call the R closure and return JSON-serialized result (static so it can be called from the async block).\n \
fn call_r_closure_blocking_static(closure: &Robj, req_json: &str) -> Result<String, {box_err}> {{\n \
// Parse JSON string into R object via extendr\n \
let req_obj = extendr_api::call!(Robj::from(req_json))?\n \
.ok_or(\"failed to parse request JSON\")?;\n\n \
// Call the closure: closure(request_obj)\n \
let result = closure.call((req_obj,))\n \
.map_err(|e| Box::new(e) as {box_err})?;\n\n \
// Serialize result to JSON\n \
let result_json = serde_json::to_string(&result)\n \
.map_err(|e| Box::new(e) as {box_err})?;\n\n \
Ok(result_json)\n \
}}\n\
}}\n\n"
));
}
fn gen_run_extendr_function(
out: &mut String,
service: &ServiceDef,
ep: &crate::core::ir::EntrypointDef,
api: &ApiSurface,
core_import: &str,
) {
let service_snake = service.name.to_snake_case();
let fn_name = format!("{service_snake}_{}", ep.method);
let owner_path = &service.rust_path;
let ep_method = &ep.method;
out.push_str(&format!(
"/// Drive `{owner_path}::{ep_method}` from R.\n\
///\n\
/// Each entry in `registrations` is a `list(method_name, metadata_list, closure)` triple.\n\
#[extendr]\n\
pub fn {fn_name}(registrations: Robj"
));
for p in &ep.params {
let rust_ty = typeref_to_rust_type(&p.ty, core_import);
out.push_str(&format!(", {}: {}", p.name, rust_ty));
}
out.push_str(") -> Result<Robj> {\n");
let ctor_call = build_ctor_call(service, owner_path, core_import);
out.push_str(&format!(" let mut owner = {ctor_call};\n\n"));
out.push_str(" // Process each registration\n");
out.push_str(" if let Some(list) = registrations.as_list() {\n");
out.push_str(" for entry in list.values() {\n");
out.push_str(" if let Some(triple) = entry.as_list() {\n");
out.push_str(" if let Some(method_name) = triple.iter().next().and_then(|x| x.as_str()) {\n");
out.push_str(" let closure = triple.iter().nth(2).ok_or(\"missing closure\")?;\n\n");
out.push_str(" match method_name {\n");
for reg in &service.registrations {
let reg_method = ®.method;
let contract_name = ®.callback_contract;
if let Some(contract) = find_contract(api, contract_name) {
let bridge_name = format!("Extendr{}Bridge", contract.trait_name.to_upper_camel_case());
out.push_str(&format!(" \"{reg_method}\" => {{\n"));
out.push_str(&format!(
" let bridge = {bridge_name}::new(closure.clone());\n"
));
out.push_str(&format!(
" let handler: Arc<dyn {core_import}::{contract_name}> = Arc::new(bridge);\n"
));
if !reg.metadata_params.is_empty() {
out.push_str(" if let Some(meta_list) = triple.iter().nth(1).and_then(|x| x.as_list()) {\n");
for (i, meta_param) in reg.metadata_params.iter().enumerate() {
let rust_ty = typeref_to_rust_type(&meta_param.ty, core_import);
out.push_str(&format!(
" let {}: {} = meta_list.iter().nth({i}).ok_or(\"missing metadata\")?.clone().try_into()?;\n",
meta_param.name, rust_ty,
));
}
let meta_args: Vec<String> = reg.metadata_params.iter().map(|p| p.name.clone()).collect();
out.push_str(&format!(
" owner.{reg_method}({}, handler);\n",
meta_args.join(", ")
));
out.push_str(" }\n");
} else {
out.push_str(&format!(" owner.{reg_method}(handler);\n"));
}
out.push_str(" }\n");
}
}
out.push_str(
" _ => return Err(Error::other(format!(\"unknown registration: {}\", method_name))),\n",
);
out.push_str(" }\n");
out.push_str(" }\n");
out.push_str(" }\n");
out.push_str(" }\n");
out.push_str(" }\n\n");
let ep_call = build_ep_call(ep, service, core_import);
out.push_str(&ep_call);
out.push_str(" Ok(Robj::from(NULL))\n");
out.push_str("}\n\n");
}
fn build_ctor_call(service: &ServiceDef, owner_path: &str, _core_import: &str) -> String {
if service.constructor.params.is_empty() {
format!("{owner_path}::{}()", service.constructor.name)
} else {
format!("{owner_path}::{}()", service.constructor.name)
}
}
fn build_ep_call(ep: &crate::core::ir::EntrypointDef, _service: &ServiceDef, _core_import: &str) -> String {
let ep_method = &ep.method;
let ep_args: Vec<String> = ep.params.iter().map(|p| p.name.clone()).collect();
let args_str = ep_args.join(", ");
if ep.is_async {
format!(
" // Run async entrypoint in blocking context\n \
let rt = tokio::runtime::Runtime::new().map_err(|e| Error::other(e.to_string()))?;\n \
rt.block_on(async {{\n \
owner.{ep_method}({args_str})\n \
.map_err(|e| Error::other(e.to_string()))?;\n \
}});\n"
)
} else {
if ep.error_type.is_some() {
format!(
" owner.{ep_method}({args_str})\n \
.map_err(|e| Error::other(e.to_string()))?;\n"
)
} else {
format!(" owner.{ep_method}({args_str});\n")
}
}
}
fn typeref_to_rust_type(ty: &TypeRef, core_import: &str) -> String {
match ty {
TypeRef::String | TypeRef::Char => "String".to_owned(),
TypeRef::Primitive(p) => {
use crate::core::ir::PrimitiveType;
match p {
PrimitiveType::Bool => "bool".to_owned(),
PrimitiveType::U8 => "u8".to_owned(),
PrimitiveType::U16 => "u16".to_owned(),
PrimitiveType::U32 => "u32".to_owned(),
PrimitiveType::U64 => "u64".to_owned(),
PrimitiveType::I8 => "i8".to_owned(),
PrimitiveType::I16 => "i16".to_owned(),
PrimitiveType::I32 => "i32".to_owned(),
PrimitiveType::I64 => "i64".to_owned(),
PrimitiveType::F32 => "f32".to_owned(),
PrimitiveType::F64 => "f64".to_owned(),
PrimitiveType::Usize => "usize".to_owned(),
PrimitiveType::Isize => "isize".to_owned(),
}
}
TypeRef::Bytes => "Vec<u8>".to_owned(),
TypeRef::Optional(inner) => format!("Option<{}>", typeref_to_rust_type(inner, core_import)),
TypeRef::Vec(inner) => format!("Vec<{}>", typeref_to_rust_type(inner, core_import)),
TypeRef::Map(k, v) => format!(
"std::collections::HashMap<{}, {}>",
typeref_to_rust_type(k, core_import),
typeref_to_rust_type(v, core_import)
),
TypeRef::Unit => "()".to_owned(),
TypeRef::Named(n) => format!("{core_import}::{n}"),
TypeRef::Json => "serde_json::Value".to_owned(),
TypeRef::Path => "std::path::PathBuf".to_owned(),
TypeRef::Duration => "std::time::Duration".to_owned(),
}
}
pub fn generate(api: &ApiSurface, config: &ResolvedCrateConfig) -> anyhow::Result<Vec<GeneratedFile>> {
if api.services.is_empty() {
return Ok(vec![]);
}
use crate::core::config::resolve_output_dir;
let output_dir = resolve_output_dir(config.output_paths.get("r"), &config.name, "crates/{name}-extendr/src/");
let package_name = config.name.replace('-', "_");
let service_rs = gen_service_rs(api, config);
let service_r = gen_service_r(api, &package_name);
let output_base = PathBuf::from(format!("packages/r/{}", package_name));
Ok(vec![
GeneratedFile {
path: PathBuf::from(&output_dir).join("service.rs"),
content: service_rs,
generated_header: true,
},
GeneratedFile {
path: output_base.join("R/service.R"),
content: service_r,
generated_header: true,
},
])
}
#[cfg(test)]
mod tests {
use super::*;
use crate::core::ir::{
EntrypointDef, EntrypointKind, HandlerContractDef, MethodDef, ParamDef, PrimitiveType, RegistrationDef,
ServiceDef, TypeRef,
};
fn make_fixture_surface() -> ApiSurface {
let constructor = MethodDef {
name: "new".to_owned(),
params: vec![],
return_type: TypeRef::Unit,
is_async: false,
is_static: true,
error_type: None,
doc: "Create a new service owner.".to_owned(),
receiver: None,
sanitized: false,
trait_source: None,
returns_ref: false,
returns_cow: false,
return_newtype_wrapper: None,
has_default_impl: false,
binding_excluded: false,
binding_exclusion_reason: None,
};
let configurator = MethodDef {
name: "with_timeout".to_owned(),
params: vec![ParamDef {
name: "timeout_ms".to_owned(),
ty: TypeRef::Primitive(PrimitiveType::U64),
optional: false,
default: None,
..ParamDef::default()
}],
return_type: TypeRef::Named("TestService".to_owned()),
is_async: false,
is_static: false,
error_type: None,
doc: "Set request timeout.".to_owned(),
receiver: Some(crate::core::ir::ReceiverKind::RefMut),
sanitized: false,
trait_source: None,
returns_ref: false,
returns_cow: false,
return_newtype_wrapper: None,
has_default_impl: false,
binding_excluded: false,
binding_exclusion_reason: None,
};
let registration = RegistrationDef {
method: "add_handler".to_owned(),
callback_param: "handler".to_owned(),
callback_contract: "RequestHandler".to_owned(),
metadata_params: vec![ParamDef {
name: "path".to_owned(),
ty: TypeRef::String,
optional: false,
default: None,
..ParamDef::default()
}],
receiver: Some(crate::core::ir::ReceiverKind::RefMut),
return_type: TypeRef::Unit,
error_type: None,
doc: "Register a request handler.".to_owned(),
variants: vec![],
};
let run_ep = EntrypointDef {
method: "run".to_owned(),
kind: EntrypointKind::Run,
is_async: true,
params: vec![],
return_type: TypeRef::Unit,
error_type: Some("ServiceError".to_owned()),
doc: "Run the service.".to_owned(),
};
let service = ServiceDef {
name: "TestService".to_owned(),
rust_path: "my_crate::TestService".to_owned(),
constructor,
configurators: vec![configurator],
registrations: vec![registration],
entrypoints: vec![run_ep],
doc: "A test service owner.".to_owned(),
cfg: None,
};
let dispatch_method = MethodDef {
name: "handle".to_owned(),
params: vec![ParamDef {
name: "request".to_owned(),
ty: TypeRef::Named("RequestData".to_owned()),
optional: false,
default: None,
..ParamDef::default()
}],
return_type: TypeRef::Named("ResponseData".to_owned()),
is_async: true,
is_static: false,
error_type: Some("HandlerError".to_owned()),
doc: "Dispatch a request.".to_owned(),
receiver: Some(crate::core::ir::ReceiverKind::Ref),
sanitized: false,
trait_source: None,
returns_ref: false,
returns_cow: false,
return_newtype_wrapper: None,
has_default_impl: false,
binding_excluded: false,
binding_exclusion_reason: None,
};
let contract = HandlerContractDef {
trait_name: "RequestHandler".to_owned(),
rust_path: "my_crate::RequestHandler".to_owned(),
dispatch: dispatch_method,
optional_methods: vec![],
wire_request_type: Some("RequestData".to_owned()),
wire_response_type: Some("ResponseData".to_owned()),
dispatch_extra_params: vec![],
wire_param_name: None,
dispatch_return_type: None,
response_adapter: None,
doc: "Async trait for handling requests.".to_owned(),
};
ApiSurface {
crate_name: "my_crate".to_owned(),
version: "0.1.0".to_owned(),
services: vec![service],
handler_contracts: vec![contract],
..ApiSurface::default()
}
}
#[test]
fn r_output_contains_constructor() {
let surface = make_fixture_surface();
let output = gen_service_r(&surface, "my_crate");
assert!(
output.contains("TestService <- function"),
"expected `TestService <- function` in output:\n{output}"
);
}
#[test]
fn r_output_contains_configurator() {
let surface = make_fixture_surface();
let output = gen_service_r(&surface, "my_crate");
assert!(
output.contains("with_timeout.TestService <- function"),
"expected `with_timeout.TestService` method:\n{output}"
);
}
#[test]
fn r_output_contains_registration() {
let surface = make_fixture_surface();
let output = gen_service_r(&surface, "my_crate");
assert!(
output.contains("add_handler.TestService <- function"),
"expected `add_handler.TestService` method:\n{output}"
);
}
#[test]
fn r_output_contains_run_entrypoint() {
let surface = make_fixture_surface();
let output = gen_service_r(&surface, "my_crate");
assert!(
output.contains("run.TestService <- function"),
"expected `run.TestService` entrypoint:\n{output}"
);
assert!(
output.contains(".Call(`test_service_run`"),
"expected native call to test_service_run:\n{output}"
);
}
#[test]
fn rust_output_contains_handler_bridge() {
let surface = make_fixture_surface();
let config = make_test_config();
let output = gen_service_rs(&surface, &config);
assert!(
output.contains("pub struct ExtendrRequestHandlerBridge"),
"expected `ExtendrRequestHandlerBridge` struct:\n{output}"
);
}
#[test]
fn rust_output_contains_bridge_impl() {
let surface = make_fixture_surface();
let config = make_test_config();
let output = gen_service_rs(&surface, &config);
assert!(
output.contains("impl my_crate::RequestHandler for ExtendrRequestHandlerBridge"),
"expected trait impl:\n{output}"
);
assert!(
output.contains("fn handle(") && output.contains("Pin<Box<dyn") && output.contains("Future<Output"),
"expected boxed-future dispatch method:\n{output}"
);
}
#[test]
fn rust_output_contains_extendr_function() {
let surface = make_fixture_surface();
let config = make_test_config();
let output = gen_service_rs(&surface, &config);
assert!(
output.contains("#[extendr]"),
"expected `#[extendr]` attribute:\n{output}"
);
assert!(
output.contains("pub fn test_service_run("),
"expected `test_service_run` function:\n{output}"
);
}
#[test]
fn rust_output_contains_registration_dispatch() {
let surface = make_fixture_surface();
let config = make_test_config();
let output = gen_service_rs(&surface, &config);
assert!(
output.contains("\"add_handler\""),
"expected `\"add_handler\"` match arm:\n{output}"
);
assert!(
output.contains("Arc<dyn my_crate::RequestHandler>"),
"expected Arc wrapping of handler:\n{output}"
);
}
#[test]
fn generate_returns_two_files_for_non_empty_services() {
let surface = make_fixture_surface();
let config = make_test_config();
let files = generate(&surface, &config).expect("generate should not fail");
assert_eq!(files.len(), 2, "expected 2 generated files, got {}", files.len());
let paths: Vec<&str> = files
.iter()
.map(|f| f.path.file_name().unwrap().to_str().unwrap())
.collect();
assert!(paths.contains(&"service.rs"), "expected service.rs in output");
assert!(paths.contains(&"service.R"), "expected service.R in output");
}
#[test]
fn generate_returns_empty_for_no_services() {
let surface = ApiSurface::default();
let config = make_test_config();
let files = generate(&surface, &config).expect("generate should not fail");
assert!(files.is_empty(), "expected no files for surface without services");
}
fn make_test_config() -> ResolvedCrateConfig {
ResolvedCrateConfig {
name: "my-crate".to_owned(),
..ResolvedCrateConfig::default()
}
}
}