feat(deltachat-rpc-server): add --openrpc option

Author: link2xt

Cargo.lock

@@ -22,7 +22,7 @@ log = "0.4"
 async-channel = { version = "1.8.0" }
 futures = { version = "0.3.28" }
 serde_json = "1.0.99"
-yerpc = { version = "0.5.1", features = ["anyhow_expose", "openrpc"] }
+yerpc = { version = "0.5.2", features = ["anyhow_expose", "openrpc"] }
 typescript-type-def = { version = "0.5.5", features = ["json_value"] }
 tokio = { version = "1.29.1" }
 sanitize-filename = "0.4"

deltachat-jsonrpc/Cargo.toml

@@ -142,11 +142,7 @@ impl CommandApi {
     }
 }
 
-#[rpc(
-    all_positional,
-    ts_outdir = "typescript/generated",
-    openrpc_outdir = "openrpc"
-)]
+#[rpc(all_positional, ts_outdir = "typescript/generated")]
 impl CommandApi {
     /// Test function.
     async fn sleep(&self, delay: f64) {

deltachat-jsonrpc/src/api/mod.rs

@@ -1,4 +1,6 @@
 import asyncio
+import json
+import subprocess
 from unittest.mock import MagicMock
 
 import pytest
@@ -355,3 +357,12 @@ async def test_import_export(acfactory, tmp_path) -> None:
     files = list(tmp_path.glob("*.tar"))
     alice2 = await acfactory.get_unconfigured_account()
     await alice2.import_backup(files[0])
+
+
+@pytest.test()
+def test_openrpc_command_line() -> None:
+    """Test that "deltachat-rpc-server --openrpc" command returns an OpenRPC specification."""
+    out = subprocess.run(["deltachat-rpc-server", "--openrpc"], capture_output=True).stdout
+    openrpc = json.loads(out)
+    assert "openrpc" in openrpc
+    assert "methods" in openrpc

deltachat-rpc-client/tests/test_something.py

@@ -21,7 +21,7 @@ serde_json = "1.0.99"
 serde = { version = "1.0", features = ["derive"] }
 tokio = { version = "1.29.1", features = ["io-std"] }
 tokio-util = "0.7.8"
-yerpc = { version = "0.5.1", features = ["anyhow_expose"] }
+yerpc = { version = "0.5.2", features = ["anyhow_expose", "openrpc"] }
 
 [features]
 default = ["vendored"]

deltachat-rpc-server/Cargo.toml

@@ -32,3 +32,6 @@ languages other than Rust, for example:
 
 1. Python: https://github.com/deltachat/deltachat-core-rust/tree/master/deltachat-rpc-client/
 2. Go: https://github.com/deltachat/deltachat-rpc-client-go/
+
+Run `deltachat-rpc-server --version` to check the version of the server.
+Run `deltachat-rpc-server --openrpc` to get [OpenRPC](https://open-rpc.org/) specification of the provided JSON-RPC API.

deltachat-rpc-server/README.md

@@ -10,6 +10,7 @@ use deltachat::constants::DC_VERSION_STR;
 use deltachat_jsonrpc::api::{Accounts, CommandApi};
 use futures_lite::stream::StreamExt;
 use tokio::io::{self, AsyncBufReadExt, BufReader};
+use yerpc::RpcServer as _;
 
 #[cfg(target_family = "unix")]
 use tokio::signal::unix as signal_unix;
@@ -39,6 +40,12 @@ async fn main_impl() -> Result<()> {
             }
             eprintln!("{}", &*DC_VERSION_STR);
             return Ok(());
+        } else if first_arg.to_str() == Some("--openrpc") {
+            if let Some(arg) = args.next() {
+                return Err(anyhow!("Unrecognized argument {:?}", arg));
+            }
+            println!("{}", CommandApi::openrpc_specification()?);
+            return Ok(());
         } else {
             return Err(anyhow!("Unrecognized option {:?}", first_arg));
         }