4 Commits
0.1.3 ... 0.2.1

Author SHA1 Message Date
Fabian Stamm
8204870bf5 Rollback of int-enum for missing serde support 2026-01-09 16:05:07 +01:00
Fabian Stamm
0a81e90e1b Update versions 2026-01-09 15:59:15 +01:00
Fabian Stamm
c29dafb042 Change the context API to make Context-Ownership more flexible 2026-01-09 15:58:32 +01:00
Fabian Stamm
4c7084563f Make the generated code compatible with nodejs natives modules 2025-12-09 18:02:28 +01:00
7 changed files with 1454 additions and 723 deletions

1736
Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,11 +1,11 @@
[package] [package]
edition = "2021" edition = "2021"
name = "jrpc-cli" name = "jrpc-cli"
version = "0.1.3" version = "0.2.1"
[workspace] [workspace]
resolver = "2" resolver = "2"
members = [".", "zed", "libjrpc"] members = [".", "zed", "libjrpc", "libjrpc/templates/Rust"]
[dependencies] [dependencies]
anyhow = "1" anyhow = "1"

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "libjrpc" name = "libjrpc"
version = "0.1.0" version = "0.1.5"
edition = "2021" edition = "2021"
[features] [features]
@@ -12,5 +12,5 @@ anyhow = "1"
lazy_static = "1" lazy_static = "1"
log = "0.4" log = "0.4"
regex = "1" regex = "1"
reqwest = { version = "0.12", optional = true, features = ["blocking"] } reqwest = { version = "0.13", optional = true, features = ["blocking"] }
url = { version = "2", optional = true } url = { version = "2", optional = true }

View File

@@ -63,7 +63,7 @@ impl RustCompiler {
fn fix_keyword_name(name: &str) -> String { fn fix_keyword_name(name: &str) -> String {
if RUST_KEYWORDS.contains(&name) { if RUST_KEYWORDS.contains(&name) {
format!("{}_", name) format!("r#{}", name)
} else { } else {
name.to_string() name.to_string()
} }
@@ -146,7 +146,7 @@ impl RustCompiler {
f.a0("#[async_trait]"); f.a0("#[async_trait]");
f.a0(format!("pub trait {} {{", definition.name)); f.a0(format!("pub trait {} {{", definition.name));
f.a1("type Context: Clone + Sync + Send + 'static;"); f.a1("type Context: Sync + Send;");
for method in definition.methods.iter() { for method in definition.methods.iter() {
let mut params = method let mut params = method
.inputs .inputs
@@ -159,7 +159,7 @@ impl RustCompiler {
) )
}) })
.collect::<Vec<String>>(); .collect::<Vec<String>>();
params.push("ctx: Self::Context".to_string()); params.push("ctx: &Self::Context".to_string());
let params = params.join(", "); let params = params.join(", ");
let ret = method let ret = method
@@ -190,7 +190,7 @@ impl RustCompiler {
f.a0(""); f.a0("");
f.a0(format!( f.a0(format!(
"impl<Context: Clone + Sync + Send + 'static> {}Handler<Context> {{", "impl<Context: Sync + Send> {}Handler<Context> {{",
definition.name definition.name
)); ));
f.a1(format!( f.a1(format!(
@@ -205,7 +205,7 @@ impl RustCompiler {
f.a0("#[async_trait]"); f.a0("#[async_trait]");
f.a0(format!( f.a0(format!(
"impl<Context: Clone + Sync + Send + 'static> JRPCServerService for {}Handler<Context> {{", "impl<Context: Sync + Send> JRPCServerService for {}Handler<Context> {{",
definition.name definition.name
)); ));
f.a1("type Context = Context;"); f.a1("type Context = Context;");
@@ -218,7 +218,7 @@ impl RustCompiler {
f.a1("#[allow(non_snake_case)]"); f.a1("#[allow(non_snake_case)]");
f.a1( f.a1(
"async fn handle(&self, msg: &JRPCRequest, function: &str, ctx: Self::Context) -> Result<(bool, Value)> {", "async fn handle(&self, msg: &JRPCRequest, function: &str, ctx: &Self::Context) -> Result<(bool, Value)> {",
); );
f.a2("match function {"); f.a2("match function {");
@@ -241,6 +241,9 @@ impl RustCompiler {
f.a5( f.a5(
"let arr = msg.params.as_array().unwrap(); //TODO: Check if this can fail.", "let arr = msg.params.as_array().unwrap(); //TODO: Check if this can fail.",
); );
f.a5(format!("if arr.len() != {} {{", method.inputs.len()));
f.a6("return Err(\"Invalid number of arguments!\".into())");
f.a5("}");
} }
f.a5(format!("let res = self.implementation.{}(", method.name)); f.a5(format!("let res = self.implementation.{}(", method.name));
for (i, arg) in method.inputs.iter().enumerate() { for (i, arg) in method.inputs.iter().enumerate() {
@@ -479,10 +482,10 @@ impl Compile for RustCompiler {
f.a(1, "#[allow(non_snake_case)]"); f.a(1, "#[allow(non_snake_case)]");
if Keywords::is_keyword(&field.name) { if Keywords::is_keyword(&field.name) {
warn!( // warn!(
"[RUST] Warning: Field name '{}' is not allowed in Rust. Renaming to '{}_'", // "[RUST] Warning: Field name '{}' is not allowed in Rust. Renaming to '{}_'",
field.name, field.name // field.name, field.name
); // );
f.a(1, format!("#[serde(rename = \"{}\")]", field.name)); f.a(1, format!("#[serde(rename = \"{}\")]", field.name));
} }

View File

@@ -112,19 +112,27 @@ pub trait JRPCServerService: Send + Sync {
&self, &self,
request: &JRPCRequest, request: &JRPCRequest,
function: &str, function: &str,
ctx: Self::Context, ctx: &Self::Context,
) -> Result<(bool, Value)>; ) -> Result<(bool, Value)>;
} }
pub type JRPCServiceHandle<Context> = Arc<dyn JRPCServerService<Context = Context>>; pub type JRPCServiceHandle<Context> = Arc<dyn JRPCServerService<Context = Context>>;
#[derive(Clone)]
pub struct JRPCSession<Context> { pub struct JRPCSession<Context> {
server: JRPCServer<Context>, server: JRPCServer<Context>,
message_sender: Sender<JRPCResult>, message_sender: Sender<JRPCResult>,
} }
impl<Context: Clone + Send + Sync + 'static> JRPCSession<Context> { impl<Context> Clone for JRPCSession<Context> {
fn clone(&self) -> Self {
JRPCSession {
server: self.server.clone(),
message_sender: self.message_sender.clone(),
}
}
}
impl<Context: Send + Sync + 'static> JRPCSession<Context> {
pub fn new(server: JRPCServer<Context>, sender: Sender<JRPCResult>) -> Self { pub fn new(server: JRPCServer<Context>, sender: Sender<JRPCResult>) -> Self {
JRPCSession { JRPCSession {
server, server,
@@ -157,64 +165,69 @@ impl<Context: Clone + Send + Sync + 'static> JRPCSession<Context> {
pub fn handle_request(&self, request: JRPCRequest, ctx: Context) -> () { pub fn handle_request(&self, request: JRPCRequest, ctx: Context) -> () {
let session = self.clone(); let session = self.clone();
tokio::task::spawn(async move { tokio::task::spawn(async move {
info!("Received request: {}", request.method); let context = ctx;
trace!("Request data: {:?}", request); session.handle_request_awaiting(request, &context).await;
let method: Vec<&str> = request.method.split('.').collect(); });
if method.len() != 2 { }
warn!("Invalid method received: {}", request.method);
return;
}
let service = method[0];
let function = method[1];
let service = session.server.services.get(service); pub async fn handle_request_awaiting(&self, request: JRPCRequest, ctx: &Context) -> () {
if let Some(service) = service { info!("Received request: {}", request.method);
let result = service.handle(&request, function, ctx).await; trace!("Request data: {:?}", request);
match result { let method: Vec<&str> = request.method.split('.').collect();
Ok((is_send, result)) => { if method.len() != 2 {
if is_send && request.id.is_some() { warn!("Invalid method received: {}", request.method);
let result = session return;
.message_sender }
.send(JRPCResult { let service = method[0];
jsonrpc: "2.0".to_string(), let function = method[1];
id: request.id.unwrap(),
result: Some(result), let service = self.server.services.get(service);
error: None, if let Some(service) = service {
}) let result = service.handle(&request, function, ctx).await;
.await; match result {
if let Err(err) = result { Ok((is_send, result)) => {
warn!("Error while sending result: {}", err); if is_send && request.id.is_some() {
} let result = self
.message_sender
.send(JRPCResult {
jsonrpc: "2.0".to_string(),
id: request.id.unwrap(),
result: Some(result),
error: None,
})
.await;
if let Err(err) = result {
warn!("Error while sending result: {}", err);
} }
} }
Err(err) => {
warn!("Error while handling request: {}", err);
session
.send_error(
request,
format!("Error while handling request: {}", err),
1,
)
.await;
}
} }
} else { Err(err) => {
warn!("Service not found: {}", method[0]); warn!("Error while handling request: {}", err);
session self.send_error(request, format!("Error while handling request: {}", err), 1)
.send_error(request, "Service not found".to_string(), 1) .await;
.await; }
return;
} }
}); } else {
warn!("Service not found: {}", method[0]);
self.send_error(request, "Service not found".to_string(), 1)
.await;
}
} }
} }
#[derive(Clone)]
pub struct JRPCServer<Context> { pub struct JRPCServer<Context> {
services: HashMap<String, JRPCServiceHandle<Context>>, services: HashMap<String, JRPCServiceHandle<Context>>,
} }
impl<Context: Clone + Send + Sync + 'static> JRPCServer<Context> { impl<Context> Clone for JRPCServer<Context> {
fn clone(&self) -> Self {
JRPCServer {
services: self.services.clone(),
}
}
}
impl<Context: Send + Sync + 'static> JRPCServer<Context> {
pub fn new() -> Self { pub fn new() -> Self {
JRPCServer { JRPCServer {
services: HashMap::new(), services: HashMap::new(),

View File

@@ -2,127 +2,142 @@
import { VerificationError } from "./ts_base"; import { VerificationError } from "./ts_base";
//@template-ignore //@template-ignore
import { import {
//@template-ignore //@template-ignore
type RequestObject, type RequestObject,
//@template-ignore //@template-ignore
type ResponseObject, type ResponseObject,
//@template-ignore //@template-ignore
Logging, Logging,
//@template-ignore //@template-ignore
} from "./ts_service_base"; } from "./ts_service_base";
export type IMessageCallback = (data: any) => void; export type IMessageCallback = (data: any) => void;
export type ResponseListener = { export type ResponseListener = {
ok: (response: any) => void; ok: (response: any) => void;
err: (error: Error) => void; err: (error: Error) => void;
}; };
export class Service { export class Service {
public _name: string = null as any; public _name: string = null as any;
constructor( constructor(
protected _provider: ServiceProvider, protected _provider: ServiceProvider,
name: string, name: string,
) { ) {
this._name = name; this._name = name;
this._provider.services.set(name, this); this._provider.services.set(name, this);
} }
} }
export class ServiceProvider { export class ServiceProvider {
services = new Map<string, Service>(); services = new Map<string, Service>();
requests = new Map<string, ResponseListener | undefined>(); requests = new Map<string, ResponseListener | undefined>();
constructor(private sendPacket: IMessageCallback) {} constructor(private sendPacket: IMessageCallback) {}
onPacket(msg: RequestObject | ResponseObject) { onPacket(msg: RequestObject | ResponseObject) {
Logging.log("CLIENT: Received message:", msg); Logging.log("CLIENT: Received message:", msg);
if ("method" in msg) { if ("method" in msg) {
if (msg.id) { if (msg.id) {
Logging.log("CLIENT: Determined type is Request"); Logging.log("CLIENT: Determined type is Request");
// Request, which are not supported by client, so ignore // Request, which are not supported by client, so ignore
return; return;
} else { } else {
Logging.log("CLIENT: Determined type is Notification"); Logging.log("CLIENT: Determined type is Notification");
//Notification. Send to Notification handler //Notification. Send to Notification handler
const [srvName, fncName] = msg.method.split("."); const [srvName, fncName] = msg.method.split(".");
let service = this.services.get(srvName); let service = this.services.get(srvName);
if (!service) { if (!service) {
Logging.log( Logging.log(
"CLIENT: Did not find Service wanted by Notification!", "CLIENT: Did not find Service wanted by Notification!",
srvName, srvName,
); );
} else {
//TODO: Implement Event thingy (or so :))
}
}
} else { } else {
//TODO: Implement Event thingy (or so :)) Logging.log("CLIENT: Determined type is Response");
// Response
let resListener = this.requests.get(msg.id);
if (!resListener) return; // Ignore wrong responses
if (msg.error) {
if (
msg.error.data &&
msg.error.data.$ == "verification_error"
) {
resListener.err(
new VerificationError(
msg.error.data.type,
msg.error.data.field,
msg.error.data.value,
),
);
} else {
resListener.err(new Error(msg.error.message));
}
} else {
resListener.ok(msg.result);
}
} }
}
} else {
Logging.log("CLIENT: Determined type is Response");
// Response
let resListener = this.requests.get(msg.id);
if (!resListener) return; // Ignore wrong responses
if (msg.error) {
if (msg.error.data && msg.error.data.$ == "verification_error") {
resListener.err(
new VerificationError(
msg.error.data.type,
msg.error.data.field,
msg.error.data.value,
),
);
} else {
resListener.err(new Error(msg.error.message));
}
} else {
resListener.ok(msg.result);
}
} }
}
sendNotification(method: string, params: any[]) { sendNotification(method: string, params: any[]) {
Logging.log("CLIENT: Sending Notification", method, params); Logging.log("CLIENT: Sending Notification", method, params);
this.sendPacket({ this.sendPacket({
jsonrpc: "2.0", jsonrpc: "2.0",
method, method,
params, params,
}); });
} }
sendRequest(method: string, params: any[], res?: ResponseListener) { sendRequest(method: string, params: any[], res?: ResponseListener) {
Logging.log("CLIENT: Sending Request", method, params); Logging.log("CLIENT: Sending Request", method, params);
const id = getRandomID(16); const id = getRandomID(16);
this.requests.set(id, res); this.requests.set(id, res);
this.sendPacket({ this.sendPacket({
jsonrpc: "2.0", jsonrpc: "2.0",
method, method,
params, params,
id, id,
}); });
} }
} }
declare var require: any; declare var require: any;
export const getRandomBytes = ( export const getRandomBytes = (
typeof self !== "undefined" && (self.crypto || (self as any).msCrypto) typeof self !== "undefined" && (self.crypto || (self as any).msCrypto)
? function () { ? function () {
// Browsers // Browsers
var crypto = self.crypto || (self as any).msCrypto; var crypto = self.crypto || (self as any).msCrypto;
var QUOTA = 65536; var QUOTA = 65536;
return function (n: number) { return function (n: number) {
var a = new Uint8Array(n); var a = new Uint8Array(n);
for (var i = 0; i < n; i += QUOTA) { for (var i = 0; i < n; i += QUOTA) {
crypto.getRandomValues(a.subarray(i, i + Math.min(n - i, QUOTA))); crypto.getRandomValues(
a.subarray(i, i + Math.min(n - i, QUOTA)),
);
}
return a;
};
}
: function () {
// Node
if (typeof require !== "undefined") {
return require("crypto").randomBytes;
} else {
return (n: number) => {
let a = new Uint8Array(n);
for (let i = 0; i < n; i++) {
a[i] = Math.floor(Math.random() * 256);
}
return a;
};
}
} }
return a;
};
}
: function () {
// Node
return require("crypto").randomBytes;
}
)() as (cnt: number) => Uint8Array; )() as (cnt: number) => Uint8Array;
export const getRandomID = (length: number) => { export const getRandomID = (length: number) => {
return btoa(String.fromCharCode.apply(null, getRandomBytes(length) as any)); return btoa(String.fromCharCode.apply(null, getRandomBytes(length) as any));
}; };

View File

@@ -6,7 +6,7 @@ use std::{
#[test] #[test]
fn compare_tools() { fn compare_tools() {
let targets = vec!["js-esm"]; let targets = vec!["js-esm", "rust"];
for target in targets { for target in targets {
std::fs::remove_dir_all("./tests").unwrap(); std::fs::remove_dir_all("./tests").unwrap();
std::fs::create_dir_all("./tests").unwrap(); std::fs::create_dir_all("./tests").unwrap();
@@ -30,56 +30,56 @@ fn compare_tools() {
panic!("Failed to generate Rust code"); panic!("Failed to generate Rust code");
} }
let result2 = Command::new("node") // let result2 = Command::new("node")
.arg("JsonRPC/lib/jrpc.js") // .arg("JsonRPC/lib/jrpc.js")
.arg("compile") // .arg("compile")
.arg("--verbose") // .arg("--verbose")
.arg("examples/test.jrpc") // .arg("examples/test.jrpc")
.arg("-o") // .arg("-o")
.arg(target.to_string() + ":tests/js") // .arg(target.to_string() + ":tests/js")
.stdout(Stdio::null()) // .stdout(Stdio::null())
.stderr(Stdio::null()) // .stderr(Stdio::null())
.spawn() // .spawn()
.expect("Failed to spawn process") // .expect("Failed to spawn process")
.wait() // .wait()
.unwrap(); // .unwrap();
if !result2.success() { // if !result2.success() {
panic!("Failed to generate JavaScript code"); // panic!("Failed to generate JavaScript code");
} // }
let rust_files = walkdir::WalkDir::new("tests/rust") // let rust_files = walkdir::WalkDir::new("tests/rust")
.into_iter() // .into_iter()
.map(|e| e.unwrap()) // .map(|e| e.unwrap())
.filter(|e| e.file_type().is_file()) // .filter(|e| e.file_type().is_file())
.collect::<Vec<_>>(); // .collect::<Vec<_>>();
let js_files = walkdir::WalkDir::new("tests/js") // let js_files = walkdir::WalkDir::new("tests/js")
.into_iter() // .into_iter()
.map(|e| e.unwrap()) // .map(|e| e.unwrap())
.filter(|e| e.file_type().is_file()) // .filter(|e| e.file_type().is_file())
.collect::<Vec<_>>(); // .collect::<Vec<_>>();
if rust_files.len() != js_files.len() { // if rust_files.len() != js_files.len() {
panic!("Number of files mismatch"); // panic!("Number of files mismatch");
} // }
for (rust_file, js_file) in rust_files.iter().zip(js_files.iter()) { // for (rust_file, js_file) in rust_files.iter().zip(js_files.iter()) {
println!("Testing files {:?} {:?}", rust_file.path(), js_file.path()); // println!("Testing files {:?} {:?}", rust_file.path(), js_file.path());
let mut rust_str = String::new(); // let mut rust_str = String::new();
File::open(rust_file.path()) // File::open(rust_file.path())
.unwrap() // .unwrap()
.read_to_string(&mut rust_str) // .read_to_string(&mut rust_str)
.unwrap(); // .unwrap();
let mut js_str = String::new(); // let mut js_str = String::new();
File::open(js_file.path()) // File::open(js_file.path())
.unwrap() // .unwrap()
.read_to_string(&mut js_str) // .read_to_string(&mut js_str)
.unwrap(); // .unwrap();
if rust_str != js_str { // if rust_str != js_str {
panic!("Files are different!") // panic!("Files are different!")
} // }
} // }
} }
} }