fix: Looks like yerpc doesn't allow me to have optional parameters

Author: Hocuri

deltachat-jsonrpc/src/api.rs

@@ -869,25 +869,31 @@ impl CommandApi {
     ///
     /// See https://securejoin.delta.chat/ for details about both protocols.
     ///
-    /// **qr**: The text of the scanned QR code. Typically, the same string as given
-    ///     to `check_qr()`.
-    ///
-    /// **source** and **uipath** are for statistics-sending,
-    /// if the user enabled it in the settings;
-    /// if you don't have statistics-sending implemented, just pass `None` here.
-    ///
     /// **returns**: The chat ID of the joined chat, the UI may redirect to the this chat.
     ///         A returned chat ID does not guarantee that the chat is protected or the belonging contact is verified.
     ///
-    async fn secure_join(
+    async fn secure_join(&self, account_id: u32, qr: String) -> Result<u32> {
+        let ctx = self.get_context(account_id).await?;
+        let chat_id = securejoin::join_securejoin(&ctx, &qr).await?;
+        Ok(chat_id.to_u32())
+    }
+
+    /// Like `secure_join()`, but allows to pass a source and a UI-path.
+    /// You only need this if your UI has an option to send statistics
+    /// to Delta Chat's developers.
+    ///
+    /// **qr**: The text of the scanned QR code. Typically, the same string as given
+    ///     to `check_qr()`.
+    /// if the user enabled it in the settings;
+    async fn secure_join_with_ux_info(
         &self,
         account_id: u32,
         qr: String,
         source: Option<u32>,
         uipath: Option<u32>,
     ) -> Result<u32> {
         let ctx = self.get_context(account_id).await?;
-        let chat_id = securejoin::join_securejoin_with_source(&ctx, &qr, source, uipath).await?;
+        let chat_id = securejoin::join_securejoin_with_ux_info(&ctx, &qr, source, uipath).await?;
         Ok(chat_id.to_u32())
     }
 

src/securejoin.rs

@@ -147,7 +147,7 @@ async fn get_self_fingerprint(context: &Context) -> Result<Fingerprint> {
 ///
 /// The function returns immediately and the handshake will run in background.
 pub async fn join_securejoin(context: &Context, qr: &str) -> Result<ChatId> {
-    join_securejoin_with_source(context, qr, None, None).await
+    join_securejoin_with_ux_info(context, qr, None, None).await
 }
 
 /// Take a scanned QR-code and do the setup-contact/join-group/invite handshake.
@@ -160,7 +160,7 @@ pub async fn join_securejoin(context: &Context, qr: &str) -> Result<ChatId> {
 /// **source** and **uipath** are for statistics-sending,
 /// if the user enabled it in the settings;
 /// if you don't have statistics-sending implemented, just pass `None` here.
-pub async fn join_securejoin_with_source(
+pub async fn join_securejoin_with_ux_info(
     context: &Context,
     qr: &str,
     source: Option<u32>,
@@ -173,7 +173,7 @@ pub async fn join_securejoin_with_source(
         err
     })?;
 
-    statistics::count_securejoin_source(context, source, uipath)
+    statistics::count_securejoin_ux_info(context, source, uipath)
         .await
         .log_err(context)
         .ok();

src/statistics.rs

@@ -579,7 +579,7 @@ async fn get_message_stats(
     Ok(message_stats)
 }
 
-pub(crate) async fn count_securejoin_source(
+pub(crate) async fn count_securejoin_ux_info(
     context: &Context,
     source: Option<u32>,
     uipath: Option<u32>,

src/statistics/statistics_tests.rs

@@ -4,7 +4,7 @@ use super::*;
 use crate::chat::{Chat, create_broadcast, create_group_chat, create_group_ex};
 use crate::mimeparser::SystemMessage;
 use crate::qr::check_qr;
-use crate::securejoin::{get_securejoin_qr, join_securejoin, join_securejoin_with_source};
+use crate::securejoin::{get_securejoin_qr, join_securejoin, join_securejoin_with_ux_info};
 use crate::test_utils::{TestContext, TestContextManager, get_chat_msg};
 use crate::tools::SystemTime;
 use pretty_assertions::assert_eq;
@@ -287,11 +287,12 @@ async fn test_statistics_securejoin_sources() -> Result<()> {
     expected.unknown += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None).await?;
+    join_securejoin_with_ux_info(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None)
+        .await?;
     expected.clipboard += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(
+    join_securejoin_with_ux_info(
         alice,
         &qr,
         Some(SecurejoinSource::ExternalLink as u32),
@@ -301,7 +302,7 @@ async fn test_statistics_securejoin_sources() -> Result<()> {
     expected.external_link += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(
+    join_securejoin_with_ux_info(
         alice,
         &qr,
         Some(SecurejoinSource::InternalLink as u32),
@@ -311,20 +312,22 @@ async fn test_statistics_securejoin_sources() -> Result<()> {
     expected.internal_link += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::ImageLoaded as u32), None)
+    join_securejoin_with_ux_info(alice, &qr, Some(SecurejoinSource::ImageLoaded as u32), None)
         .await?;
     expected.image_loaded += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Scan as u32), None).await?;
+    join_securejoin_with_ux_info(alice, &qr, Some(SecurejoinSource::Scan as u32), None).await?;
     expected.scan += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None).await?;
+    join_securejoin_with_ux_info(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None)
+        .await?;
     expected.clipboard += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None).await?;
+    join_securejoin_with_ux_info(alice, &qr, Some(SecurejoinSource::Clipboard as u32), None)
+        .await?;
     expected.clipboard += 1;
     check_statistics(alice, &expected).await;
 
@@ -367,7 +370,7 @@ async fn test_statistics_securejoin_uipaths() -> Result<()> {
     expected.other += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(
+    join_securejoin_with_ux_info(
         alice,
         &qr,
         Some(0),
@@ -377,7 +380,7 @@ async fn test_statistics_securejoin_uipaths() -> Result<()> {
     expected.new_contact += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(
+    join_securejoin_with_ux_info(
         alice,
         &qr,
         Some(0),
@@ -387,7 +390,8 @@ async fn test_statistics_securejoin_uipaths() -> Result<()> {
     expected.new_contact += 1;
     check_statistics(alice, &expected).await;
 
-    join_securejoin_with_source(alice, &qr, Some(0), Some(SecurejoinUIPath::QrIcon as u32)).await?;
+    join_securejoin_with_ux_info(alice, &qr, Some(0), Some(SecurejoinUIPath::QrIcon as u32))
+        .await?;
     expected.qr_icon += 1;
     check_statistics(alice, &expected).await;