api!: Contact::get_color: Ensure that own key exists before returning self-color (#7374)

Otherwise gray is returned and we don't want any UIs displaying it. Keypair generation is done in
`get_color()` instead of `get_by_id_optional()` to avoid breaking Core tests on key import.

Author: iequidoo

deltachat-ffi/src/lib.rs

@@ -4240,7 +4240,16 @@ pub unsafe extern "C" fn dc_contact_get_color(contact: *mut dc_contact_t) -> u32
         return 0;
     }
     let ffi_contact = &*contact;
-    ffi_contact.contact.get_color()
+    let ctx = &*ffi_contact.context;
+    block_on(async move {
+        ffi_contact
+            .contact
+            .get_color(ctx)
+            .await
+            .context("Contact::get_color()")
+            .log_err(ctx)
+            .unwrap_or(0)
+    })
 }
 
 #[no_mangle]

deltachat-jsonrpc/src/api/types/account.rs

@@ -32,7 +32,10 @@ impl Account {
             let addr = ctx.get_config(Config::Addr).await?;
             let profile_image = ctx.get_config(Config::Selfavatar).await?;
             let color = color_int_to_hex_string(
-                Contact::get_by_id(ctx, ContactId::SELF).await?.get_color(),
+                Contact::get_by_id(ctx, ContactId::SELF)
+                    .await?
+                    .get_color(ctx)
+                    .await?,
             );
             let private_tag = ctx.get_config(Config::PrivateTag).await?;
             Ok(Account::Configured {

deltachat-jsonrpc/src/api/types/contact.rs

@@ -90,7 +90,7 @@ impl ContactObject {
 
         Ok(ContactObject {
             address: contact.get_addr().to_owned(),
-            color: color_int_to_hex_string(contact.get_color()),
+            color: color_int_to_hex_string(contact.get_color(context).await?),
             auth_name: contact.get_authname().to_owned(),
             status: contact.get_status().to_owned(),
             display_name: contact.get_display_name().to_owned(),

deltachat-jsonrpc/src/api/types/message.rs

@@ -160,7 +160,9 @@ impl MessageObject {
                         message_id: quote.get_id().to_u32(),
                         chat_id: quote.get_chat_id().to_u32(),
                         author_display_name: quote_author.get_display_name().to_owned(),
-                        author_display_color: color_int_to_hex_string(quote_author.get_color()),
+                        author_display_color: color_int_to_hex_string(
+                            quote_author.get_color(context).await?,
+                        ),
                         override_sender_name: quote.get_override_sender_name(),
                         image: if quote.get_viewtype() == Viewtype::Image
                             || quote.get_viewtype() == Viewtype::Gif
@@ -565,7 +567,7 @@ impl MessageSearchResult {
             id: msg_id.to_u32(),
             author_profile_image: profile_image,
             author_name,
-            author_color: color_int_to_hex_string(sender.get_color()),
+            author_color: color_int_to_hex_string(sender.get_color(context).await?),
             author_id: sender.id.to_u32(),
             chat_id: chat.id.to_u32(),
             chat_name: chat.get_name().to_owned(),

src/chat.rs

@@ -1578,7 +1578,7 @@ impl Chat {
             let contacts = get_chat_contacts(context, self.id).await?;
             if let Some(contact_id) = contacts.first() {
                 if let Ok(contact) = Contact::get_by_id(context, *contact_id).await {
-                    color = contact.get_color();
+                    color = contact.get_color(context).await?;
                 }
             }
         } else if !self.grpid.is_empty() {

src/contact.rs

@@ -1574,9 +1574,14 @@ impl Contact {
     }
 
     /// Returns a color for the contact.
-    /// See [`self::get_color`].
-    pub fn get_color(&self) -> u32 {
-        get_color(self.id == ContactId::SELF, &self.addr, &self.fingerprint())
+    /// For self-contact this generates own keypair if it doesn't exist yet.
+    /// See also [`self::get_color`].
+    pub async fn get_color(&self, context: &Context) -> Result<u32> {
+        let mut fpr = self.fingerprint();
+        if fpr.is_none() && self.id == ContactId::SELF {
+            fpr = Some(load_self_public_key(context).await?.dc_fingerprint());
+        }
+        Ok(get_color(self.id == ContactId::SELF, &self.addr, &fpr))
     }
 
     /// Gets the contact's status.

src/contact/contact_tests.rs

@@ -759,32 +759,51 @@ async fn test_lookup_id_by_addr() {
 async fn test_contact_get_color() -> Result<()> {
     let t = TestContext::new().await;
     let contact_id = Contact::create(&t, "name", "[email protected]").await?;
-    let color1 = Contact::get_by_id(&t, contact_id).await?.get_color();
+    let color1 = Contact::get_by_id(&t, contact_id)
+        .await?
+        .get_color(&t)
+        .await?;
     assert_eq!(color1, 0x4844e2);
 
     let t = TestContext::new().await;
     let contact_id = Contact::create(&t, "prename name", "[email protected]").await?;
-    let color2 = Contact::get_by_id(&t, contact_id).await?.get_color();
+    let color2 = Contact::get_by_id(&t, contact_id)
+        .await?
+        .get_color(&t)
+        .await?;
     assert_eq!(color2, color1);
 
     let t = TestContext::new().await;
     let contact_id = Contact::create(&t, "Name", "[email protected]").await?;
-    let color3 = Contact::get_by_id(&t, contact_id).await?.get_color();
+    let color3 = Contact::get_by_id(&t, contact_id)
+        .await?
+        .get_color(&t)
+        .await?;
     assert_eq!(color3, color1);
     Ok(())
 }
 
 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
-async fn test_self_color_vs_key() -> Result<()> {
+async fn test_self_color() -> Result<()> {
     let mut tcm = TestContextManager::new();
     let t = &tcm.unconfigured().await;
     t.configure_addr("[email protected]").await;
     assert!(t.is_configured().await?);
-    let color = Contact::get_by_id(t, ContactId::SELF).await?.get_color();
-    assert_eq!(color, 0x808080);
+    let color = Contact::get_by_id(t, ContactId::SELF)
+        .await?
+        .get_color(t)
+        .await?;
+    assert_ne!(color, 0x808080);
     get_securejoin_qr(t, None).await?;
-    let color1 = Contact::get_by_id(t, ContactId::SELF).await?.get_color();
-    assert_ne!(color1, color);
+    let color1 = Contact::get_by_id(t, ContactId::SELF)
+        .await?
+        .get_color(t)
+        .await?;
+    assert_eq!(color1, color);
+
+    let bob = &tcm.bob().await;
+    let contact = bob.add_or_lookup_contact(t).await;
+    assert_eq!(contact.get_color(bob).await?, color);
     Ok(())
 }
 

src/qr_code_generator.rs

@@ -171,7 +171,7 @@ async fn self_info(context: &Context) -> Result<(Option<Vec<u8>>, String, String
         None => contact.get_addr().to_string(),
     };
     let addr = contact.get_addr().to_string();
-    let color = color_int_to_hex_string(contact.get_color());
+    let color = color_int_to_hex_string(contact.get_color(context).await?);
     Ok((avatar, displayname, addr, color))
 }
 

src/webxdc/maps_integration.rs

@@ -112,7 +112,7 @@ pub(crate) async fn intercept_get_updates(
                 hash_map::Entry::Vacant(e) => {
                     let contact = Contact::get_by_id(context, location.contact_id).await?;
                     let name = contact.get_display_name().to_string();
-                    let color = color_int_to_hex_string(contact.get_color());
+                    let color = color_int_to_hex_string(contact.get_color(context).await?);
                     e.insert((name, color)).clone()
                 }
                 hash_map::Entry::Occupied(e) => e.get().clone(),