method to get busy webxdcs

CHANGELOG.md

@@ -28,6 +28,9 @@
 - order contact lists by "last seen";
   this affects `dc_get_chat_contacts()`, `dc_get_contacts()` and `dc_get_blocked_contacts()` #3562
 - add `internet_access` flag to `dc_msg_get_webxdc_info()` #3516
+- `DC_EVENT_WEBXDC_INSTANCE_DELETED` is emitted when a message containing a webxdc gets deleted #3105
+- `DC_EVENT_WEBXDC_BUSY_UPDATING` is emitted when a new update has to be sent by an webxdc #3320
+- `DC_EVENT_WEBXDC_UP_TO_DATE` is emitted when a webxdc has sent all updates #3320
 
 ### Fixes
 - do not emit notifications for blocked chats #3557

deltachat-ffi/deltachat.h

@@ -5724,8 +5724,30 @@ void dc_event_unref(dc_event_t* event);
  * @param data1 (int) msg_id
  * @param data2 (int) status_update_serial - must not be used by UI implementations.
  */
-#define DC_EVENT_WEBXDC_STATUS_UPDATE                2120
+#define DC_EVENT_WEBXDC_STATUS_UPDATE             2120
 
+/**
+ * Message deleted which contained a webxdc instance.
+ *
+ * @param data1 (int) msg_id
+ */
+#define DC_EVENT_WEBXDC_INSTANCE_DELETED          2121
+
+
+/**
+ * Webxdc has some updates that need to be sent
+ *
+ * @param data1 (int) msg_id
+ */
+#define DC_EVENT_WEBXDC_BUSY_UPDATING             2122
+
+
+/**
+ * Webxdc has finished sending updates
+ *
+ * @param data1 (int) msg_id
+ */
+#define DC_EVENT_WEBXDC_UP_TO_DATE                2123
 
 /**
  * @}

deltachat-ffi/src/lib.rs

@@ -504,6 +504,9 @@ pub unsafe extern "C" fn dc_event_get_id(event: *mut dc_event_t) -> libc::c_int
         EventType::ConnectivityChanged => 2100,
         EventType::SelfavatarChanged => 2110,
         EventType::WebxdcStatusUpdate { .. } => 2120,
+        EventType::WebxdcInstanceDeleted { .. } => 2121,
+        EventType::WebxdcBusyUpdating { .. } => 2022,
+        EventType::WebxdcUpToDate { .. } => 2023,
     }
 }
 
@@ -550,6 +553,9 @@ pub unsafe extern "C" fn dc_event_get_data1_int(event: *mut dc_event_t) -> libc:
             contact_id.to_u32() as libc::c_int
         }
         EventType::WebxdcStatusUpdate { msg_id, .. } => msg_id.to_u32() as libc::c_int,
+        EventType::WebxdcInstanceDeleted { msg_id, .. } => msg_id.to_u32() as libc::c_int,
+        EventType::WebxdcBusyUpdating { msg_id } => msg_id.to_u32() as libc::c_int,
+        EventType::WebxdcUpToDate { msg_id } => msg_id.to_u32() as libc::c_int,
     }
 }
 
@@ -581,6 +587,9 @@ pub unsafe extern "C" fn dc_event_get_data2_int(event: *mut dc_event_t) -> libc:
         | EventType::ImexFileWritten(_)
         | EventType::MsgsNoticed(_)
         | EventType::ConnectivityChanged
+        | EventType::WebxdcInstanceDeleted { .. }
+        | EventType::WebxdcBusyUpdating { .. }
+        | EventType::WebxdcUpToDate { .. }
         | EventType::SelfavatarChanged => 0,
         EventType::ChatModified(_) => 0,
         EventType::MsgsChanged { msg_id, .. }
@@ -637,6 +646,9 @@ pub unsafe extern "C" fn dc_event_get_data2_str(event: *mut dc_event_t) -> *mut
         | EventType::ConnectivityChanged
         | EventType::SelfavatarChanged
         | EventType::WebxdcStatusUpdate { .. }
+        | EventType::WebxdcInstanceDeleted { .. }
+        | EventType::WebxdcBusyUpdating { .. }
+        | EventType::WebxdcUpToDate { .. }
         | EventType::ChatEphemeralTimerModified { .. } => ptr::null_mut(),
         EventType::ConfigureProgress { comment, .. } => {
             if let Some(comment) = comment {

deltachat-jsonrpc/src/api/events.rs

@@ -60,6 +60,9 @@ pub fn event_to_json_rpc_notification(event: Event) -> Value {
             msg_id,
             status_update_serial,
         } => (json!(msg_id), json!(status_update_serial)),
+        EventType::WebxdcInstanceDeleted { msg_id } => (json!(msg_id), Value::Null),
+        EventType::WebxdcBusyUpdating { msg_id } => (json!(msg_id), Value::Null),
+        EventType::WebxdcUpToDate { msg_id } => (json!(msg_id), Value::Null),
     };
 
     let id: EventTypeName = event.typ.into();
@@ -102,6 +105,9 @@ pub enum EventTypeName {
     ConnectivityChanged,
     SelfavatarChanged,
     WebxdcStatusUpdate,
+    WebxdcInstanceDeleted,
+    WebxdcBusyUpdating,
+    WebxdcUpToDate,
 }
 
 impl From<EventType> for EventTypeName {
@@ -137,6 +143,9 @@ impl From<EventType> for EventTypeName {
             EventType::ConnectivityChanged => ConnectivityChanged,
             EventType::SelfavatarChanged => SelfavatarChanged,
             EventType::WebxdcStatusUpdate { .. } => WebxdcStatusUpdate,
+            EventType::WebxdcInstanceDeleted { .. } => WebxdcInstanceDeleted,
+            EventType::WebxdcBusyUpdating { .. } => WebxdcBusyUpdating,
+            EventType::WebxdcUpToDate { .. } => WebxdcUpToDate,
         }
     }
 }

deltachat-jsonrpc/typescript/generated/events.ts

@@ -1,3 +1,3 @@
 // AUTO-GENERATED by typescript-type-def
 
-export type EventTypeName=("Info"|"SmtpConnected"|"ImapConnected"|"SmtpMessageSent"|"ImapMessageDeleted"|"ImapMessageMoved"|"NewBlobFile"|"DeletedBlobFile"|"Warning"|"Error"|"ErrorSelfNotInGroup"|"MsgsChanged"|"IncomingMsg"|"MsgsNoticed"|"MsgDelivered"|"MsgFailed"|"MsgRead"|"ChatModified"|"ChatEphemeralTimerModified"|"ContactsChanged"|"LocationChanged"|"ConfigureProgress"|"ImexProgress"|"ImexFileWritten"|"SecurejoinInviterProgress"|"SecurejoinJoinerProgress"|"ConnectivityChanged"|"SelfavatarChanged"|"WebxdcStatusUpdate");
+export type EventTypeName=("Info"|"SmtpConnected"|"ImapConnected"|"SmtpMessageSent"|"ImapMessageDeleted"|"ImapMessageMoved"|"NewBlobFile"|"DeletedBlobFile"|"Warning"|"Error"|"ErrorSelfNotInGroup"|"MsgsChanged"|"IncomingMsg"|"MsgsNoticed"|"MsgDelivered"|"MsgFailed"|"MsgRead"|"ChatModified"|"ChatEphemeralTimerModified"|"ContactsChanged"|"LocationChanged"|"ConfigureProgress"|"ImexProgress"|"ImexFileWritten"|"SecurejoinInviterProgress"|"SecurejoinJoinerProgress"|"ConnectivityChanged"|"SelfavatarChanged"|"WebxdcStatusUpdate"|"WebXdInstanceDeleted");

deltachat-jsonrpc/typescript/generated/types.ts

@@ -65,7 +65,6 @@ export type Viewtype=("Unknown"|
 "Webxdc");
 export type I32=number;
 export type U64=number;
-export type Message={"id":U32;"chatId":U32;"fromId":U32;"quotedText":(string|null);"quotedMessageId":(U32|null);"text":(string|null);"hasLocation":boolean;"hasHtml":boolean;"viewType":Viewtype;"state":U32;"timestamp":I64;"sortTimestamp":I64;"receivedTimestamp":I64;"hasDeviatingTimestamp":boolean;"subject":string;"showPadlock":boolean;"isSetupmessage":boolean;"isInfo":boolean;"isForwarded":boolean;"duration":I32;"dimensionsHeight":I32;"dimensionsWidth":I32;"videochatType":(U32|null);"videochatUrl":(string|null);"overrideSenderName":(string|null);"sender":Contact;"setupCodeBegin":(string|null);"file":(string|null);"fileMime":(string|null);"fileBytes":U64;"fileName":(string|null);};
 export type WebxdcMessageInfo={
 /**
  * The name of the app.
@@ -103,4 +102,5 @@ export type WebxdcMessageInfo={
  * True if full internet access should be granted to the app.
  */
 "internetAccess":boolean;};
+export type Message={"id":U32;"chatId":U32;"fromId":U32;"quotedText":(string|null);"quotedMessageId":(U32|null);"text":(string|null);"hasLocation":boolean;"hasHtml":boolean;"viewType":Viewtype;"state":U32;"timestamp":I64;"sortTimestamp":I64;"receivedTimestamp":I64;"hasDeviatingTimestamp":boolean;"subject":string;"showPadlock":boolean;"isSetupmessage":boolean;"isInfo":boolean;"isForwarded":boolean;"duration":I32;"dimensionsHeight":I32;"dimensionsWidth":I32;"videochatType":(U32|null);"videochatUrl":(string|null);"overrideSenderName":(string|null);"sender":Contact;"setupCodeBegin":(string|null);"file":(string|null);"fileMime":(string|null);"fileBytes":U64;"fileName":(string|null);"webxdcInfo":(WebxdcMessageInfo|null);};
 export type __AllTyps=[string,boolean,Record<string,string>,U32,U32,null,(U32)[],U32,null,(U32|null),(Account)[],U32,Account,U32,string,(ProviderInfo|null),U32,boolean,U32,Record<string,string>,U32,string,(string|null),null,U32,Record<string,(string|null)>,null,U32,string,null,U32,string,Qr,U32,string,(string|null),U32,(string)[],Record<string,(string|null)>,U32,null,U32,null,U32,(U32)[],U32,U32,Usize,U32,string,U32,U32,string,null,U32,(U32|null),(string|null),(U32|null),(ChatListEntry)[],U32,(ChatListEntry)[],Record<U32,ChatListItemFetchResult>,U32,U32,FullChat,U32,U32,null,U32,U32,null,U32,U32,null,U32,U32,string,U32,(U32|null),[string,string],U32,U32,null,U32,U32,U32,null,U32,U32,U32,null,U32,string,string,U32,U32,U32,U32,(U32)[],U32,U32,Message,U32,(U32)[],Record<U32,Message>,U32,(U32)[],null,U32,U32,string,U32,U32,Contact,U32,string,(string|null),U32,U32,U32,U32,U32,U32,null,U32,U32,null,U32,(Contact)[],U32,U32,(string|null),(U32)[],U32,U32,(string|null),(Contact)[],U32,(U32)[],Record<U32,Contact>,U32,(U32|null),Viewtype,(Viewtype|null),(Viewtype|null),(U32)[],U32,U32,string,string,null,U32,U32,U32,string,U32,U32,WebxdcMessageInfo,U32,string,U32,U32];

src/events.rs

@@ -302,4 +302,17 @@ pub enum EventType {
         msg_id: MsgId,
         status_update_serial: StatusUpdateSerial,
     },
+
+    /// Inform that a message containing a webxdc instance has been deleted
+    WebxdcInstanceDeleted {
+        msg_id: MsgId,
+    },
+
+    WebxdcBusyUpdating {
+        msg_id: MsgId,
+    },
+
+    WebxdcUpToDate {
+        msg_id: MsgId,
+    },
 }

src/message.rs

@@ -1236,6 +1236,11 @@ pub async fn delete_msgs(context: &Context, msg_ids: &[MsgId]) -> Result<()> {
             .trash(context)
             .await
             .with_context(|| format!("Unable to trash message {}", msg_id))?;
+
+        if msg.viewtype == Viewtype::Webxdc {
+            context.emit_event(EventType::WebxdcInstanceDeleted { msg_id: *msg_id });
+        }
+
         context
             .sql
             .execute(

src/scheduler.rs

@@ -332,7 +332,7 @@ async fn smtp_loop(ctx: Context, started: Sender<()>, smtp_handlers: SmtpConnect
                 if !duration_until_can_send.is_zero() {
                     info!(
                         ctx,
-                        "smtp got rate limited, waiting for {} until can send again",
+                        "smtp got rate limited, delaying next try by {}",
                         duration_to_str(duration_until_can_send)
                     );
                     tokio::time::timeout(duration_until_can_send, async {

src/smtp.rs

@@ -22,6 +22,7 @@ use crate::mimefactory::MimeFactory;
 use crate::oauth2::get_oauth2_access_token;
 use crate::provider::Socket;
 use crate::sql;
+use crate::webxdc::get_busy_webxdc_instances;
 use crate::{context::Context, scheduler::connectivity::ConnectivityStore};
 
 /// SMTP write and read timeout in seconds.
@@ -499,7 +500,15 @@ async fn send_mdns(context: &Context, connection: &mut Smtp) -> Result<()> {
 pub(crate) async fn send_smtp_messages(context: &Context, connection: &mut Smtp) -> Result<()> {
     let ratelimited = if context.ratelimit.read().await.can_send() {
         // add status updates and sync messages to end of sending queue
+
+        let update_needed = get_busy_webxdc_instances(&context.sql).await?;
         context.flush_status_updates().await?;
+        let update_needed_after_sending = get_busy_webxdc_instances(&context.sql).await?;
+
+        for msg_id in update_needed.difference(&update_needed_after_sending) {
+            context.emit_event(EventType::WebxdcUpToDate { msg_id: *msg_id })
+        }
+
         context.send_sync_msg().await?;
         false
     } else {

src/sql.rs

@@ -7,6 +7,7 @@ use std::path::PathBuf;
 use std::time::Duration;
 
 use anyhow::{bail, Context as _, Result};
+use rusqlite::types::FromSql;
 use rusqlite::{config::DbConfig, Connection, OpenFlags};
 use tokio::sync::RwLock;
 
@@ -363,6 +364,25 @@ impl Sql {
         })
     }
 
+    /// Returns unique values of a `column` in `table`
+    pub async fn distinct<T: FromSql + Default>(
+        &self,
+        table: &str,
+        column: &str,
+    ) -> Result<Vec<T>> {
+        let conn = self.get_conn().await?;
+        let rows: Result<Vec<T>> = tokio::task::block_in_place(move || {
+            let mut stmt = conn.prepare(&format!("SELECT DISTINCT {column} FROM {table}"))?;
+            let rows = stmt
+                .query([])?
+                .mapped(|r| r.get(0))
+                .map(|a| a.unwrap_or_default())
+                .collect();
+            Ok(rows)
+        });
+        rows
+    }
+
     /// Prepares and executes the statement and maps a function over the resulting rows.
     /// Then executes the second function over the returned iterator and returns the
     /// result of that function.

src/webxdc.rs

@@ -1,5 +1,6 @@
 //! # Handle webxdc messages.
 
+use std::collections::HashSet;
 use std::convert::TryFrom;
 use std::path::Path;
 
@@ -20,6 +21,7 @@ use crate::mimeparser::SystemMessage;
 use crate::param::Param;
 use crate::param::Params;
 use crate::scheduler::InterruptInfo;
+use crate::sql::Sql;
 use crate::tools::{create_smeared_timestamp, get_abs_path};
 use crate::{chat, EventType};
 
@@ -377,6 +379,10 @@ impl Context {
             )
             .await?;
 
+        self.emit_event(EventType::WebxdcBusyUpdating {
+            msg_id: instance.id,
+        });
+
         if send_now {
             self.sql.insert(
                 "INSERT INTO smtp_status_updates (msg_id, first_serial, last_serial, descr) VALUES(?, ?, ?, ?)
@@ -390,7 +396,6 @@ impl Context {
     }
 
     /// Pops one record of queued webxdc status updates.
-    /// This function exists to make the sqlite statement testable.
     async fn pop_smtp_status_update(
         &self,
     ) -> Result<Option<(MsgId, StatusUpdateSerial, StatusUpdateSerial, String)>> {
@@ -744,6 +749,15 @@ impl Message {
     }
 }
 
+/// Returns a hashset of all webxdc instaces which still have updates to send
+pub(crate) async fn get_busy_webxdc_instances(sql: &Sql) -> Result<HashSet<MsgId>> {
+    Ok(sql
+        .distinct("smtp_status_updates", "msg_id")
+        .await?
+        .into_iter()
+        .collect())
+}
+
 #[cfg(test)]
 mod tests {
     use crate::chat::{
@@ -753,6 +767,7 @@ mod tests {
     use crate::chatlist::Chatlist;
     use crate::config::Config;
     use crate::contact::Contact;
+    use crate::message;
     use crate::receive_imf::{receive_imf, receive_imf_inner};
     use crate::test_utils::TestContext;
 
@@ -2377,4 +2392,17 @@ sth_for_the = "future""#
         );
         Ok(())
     }
+
+    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+    async fn test_webxdc_delete_event() -> Result<()> {
+        let alice = TestContext::new_alice().await;
+        let chat_id = create_group_chat(&alice, ProtectionStatus::Unprotected, "foo").await?;
+        let instance = send_webxdc_instance(&alice, chat_id).await?;
+        message::delete_msgs(&alice, &[instance.id]).await?;
+        alice
+            .evtracker
+            .get_matching(|evt| matches!(evt, EventType::WebxdcInstanceDeleted { .. }))
+            .await;
+        Ok(())
+    }
 }