Added unit tests for blinded contacts, bug fixes and cleanup

Author: mpretty-cyro

include/session/config/contacts.h

@@ -251,8 +251,7 @@ LIBSESSION_EXPORT size_t contacts_size(const config_object* conf);
 /// Outputs:
 /// - `contacts_blinded_contact_list*` -- pointer to the list of blinded contact structs; the
 /// pointer belongs to the caller and must be freed when done with it.
-LIBSESSION_EXPORT contacts_blinded_contact_list* contacts_blinded_contacts(
-        const config_object* conf);
+LIBSESSION_EXPORT contacts_blinded_contact_list* contacts_blinded(const config_object* conf);
 
 /// API: contacts/contacts_get_blinded_contact
 ///
@@ -264,27 +263,68 @@ LIBSESSION_EXPORT contacts_blinded_contact_list* contacts_blinded_contacts(
 /// ```cpp
 /// BOOL contacts_get_blinded_contact(
 ///     [in]    config_object*              conf,
-///     [in]    const char*                 blinded_session_id,
+///     [in]    const char*                 blinded_id,
 ///     [in]    bool                        legacy_blinding,
 ///     [out]   contacts_blinded_contact*   blinded_contact
 /// );
 /// ```
 ///
 /// Inputs:
 /// - `conf` -- [in] Pointer to the config object
-/// - `blinded_session_id` -- [in] null terminated hex string
+/// - `blinded_id` -- [in] null terminated hex string
 /// - `legacy_blinding` -- [in] null terminated hex string
 /// - `blinded_contact` -- [out] the blinded contact info data
 ///
 /// Output:
 /// - `bool` -- Returns true if blinded contact exists
-LIBSESSION_EXPORT bool contacts_get_blinded_contact(
+LIBSESSION_EXPORT bool contacts_get_blinded(
         config_object* conf,
-        const char* blinded_session_id,
+        const char* blinded_id,
         bool legacy_blinding,
         contacts_blinded_contact* blinded_contact) LIBSESSION_WARN_UNUSED;
 
-/// API: contacts/contacts_set_blinded_contact
+/// API: contacts/contacts_get_or_construct_blinded
+///
+/// Same as the above `contacts_get_blinded()` except that when the blinded contact does not exist,
+/// this sets all the contact fields to defaults and loads it with the given blinded_id.
+///
+/// Returns true as long as it is given a valid blinded_id.  A false return is considered an error,
+/// and means the blinded_id was not a valid blinded_id.
+///
+/// This is the method that should usually be used to create or update a blinded contact, followed
+/// by setting fields in the blinded contact, and then giving it to contacts_set_blinded().
+///
+/// Declaration:
+/// ```cpp
+/// BOOL contacts_get_or_construct_blinded(
+///     [in]    config_object*              conf,
+///     [in]    const char*                 community_base_url,
+///     [in]    const char*                 community_pubkey_hex,
+///     [in]    const char*                 blinded_id,
+///     [in]    bool                        legacy_blinding,
+///     [out]   contacts_blinded_contact*   blinded_contact
+/// );
+/// ```
+///
+/// Inputs:
+/// - `conf` -- [in] Pointer to the config object
+/// - `community_base_url` -- [in] null terminated string
+/// - `community_pubkey_hex` -- [in] null terminated hex string
+/// - `blinded_id` -- [in] null terminated hex string
+/// - `legacy_blinding` -- [in] null terminated hex string
+/// - `blinded_contact` -- [out] the blinded contact info data
+///
+/// Output:
+/// - `bool` -- Returns true if contact exsts
+LIBSESSION_EXPORT bool contacts_get_or_construct_blinded(
+        config_object* conf,
+        const char* community_base_url,
+        const char* community_pubkey_hex,
+        const char* blinded_id,
+        bool legacy_blinding,
+        contacts_blinded_contact* blinded_contact) LIBSESSION_WARN_UNUSED;
+
+/// API: contacts/contacts_set_blinded
 ///
 /// Adds or updates a blinded contact from the given contact info struct.
 ///
@@ -302,19 +342,19 @@ LIBSESSION_EXPORT bool contacts_get_blinded_contact(
 ///
 /// Output:
 /// - `bool` -- Returns true if the call succeeds, false if an error occurs.
-LIBSESSION_EXPORT bool contacts_set_blinded_contact(
+LIBSESSION_EXPORT bool contacts_set_blinded(
         config_object* conf, const contacts_blinded_contact* bc);
 
-/// API: contacts/contacts_erase_blinded_contact
+/// API: contacts/contacts_erase_blinded
 ///
 /// Erases a blinded contact from the blinded contact list.  blinded_id is in hex.  Returns true if
 /// the blinded contact was found and removed, false if the blinded contact was not present.
 ///
 /// Declaration:
 /// ```cpp
-/// BOOL contacts_erase_blinded_contact(
+/// BOOL contacts_erase_blinded(
 ///     [in, out]   config_object*  conf,
-///     [in]        const char*     base_url,
+///     [in]        const char*     community_base_url,
 ///     [in]        const char*     blinded_id,
 ///     [in]        bool            legacy_blinding
 /// );
@@ -330,7 +370,10 @@ LIBSESSION_EXPORT bool contacts_set_blinded_contact(
 /// Outputs:
 /// - `bool` -- True if erasing was successful
 LIBSESSION_EXPORT bool contacts_erase_blinded_contact(
-        config_object* conf, const char* base_url, const char* blinded_id, bool legacy_blinding);
+        config_object* conf,
+        const char* community_base_url,
+        const char* blinded_id,
+        bool legacy_blinding);
 
 typedef struct contacts_iterator {
     void* _internals;

include/session/config/contacts.hpp

@@ -129,9 +129,9 @@ struct blinded_contact_info {
 
     blinded_contact_info() = default;
     explicit blinded_contact_info(
-            std::string_view base_url,
+            std::string_view community_base_url,
+            std::span<const unsigned char> community_pubkey,
             std::string_view blinded_id,
-            std::span<const unsigned char> pubkey,
             bool legacy_blinding);
 
     // Internal ctor/method for C API implementations:
@@ -427,48 +427,74 @@ class Contacts : public ConfigBase {
             std::span<const unsigned char>* get_pubkey = nullptr) const;
 
   public:
-    /// API: contacts/Contacts::blinded_contacts
+    /// API: contacts/Contacts::blinded
     ///
     /// Retrieves a list of all known blinded contacts.
     ///
     /// Inputs: None
     ///
     /// Outputs:
     /// - `std::vector<blinded_contact_info>` - Returns a list of blinded_contact_info
-    std::vector<blinded_contact_info> blinded_contacts() const;
+    std::vector<blinded_contact_info> blinded() const;
 
     /// API: contacts/Contacts::get_blinded
     ///
     /// Looks up and returns a blinded contact by blinded session ID (hex).  Returns nullopt if the
     /// blinded session ID was not found, otherwise returns a filled out `blinded_contact_info`.
     ///
     /// Inputs:
-    /// - `pubkey_hex` -- hex string of the session id
+    /// - `blinded_id_hex` -- hex string of the session id
     /// - `legacy_blinding` -- flag indicating whether the pubkey is using legacy blinding
     ///
     /// Outputs:
     /// - `std::optional<blinded_contact_info>` - Returns nullopt if blinded session ID was not
     /// found, otherwise a filled out blinded_contact_info
     std::optional<blinded_contact_info> get_blinded(
-            std::string_view pubkey_hex, bool legacy_blinding) const;
+            std::string_view blinded_id_hex, bool legacy_blinding) const;
+
+    /// API: contacts/Contacts::get_or_construct_blinded
+    ///
+    /// Similar to get_blinded(), but if the blinded ID does not exist this returns a filled-out
+    /// blinded_contact_info containing the blinded_id, community info and legacy_blinded flag (all
+    /// other fields will be empty/defaulted).  This is intended to be combined with `set_blinded`
+    /// to set-or-create a record.
+    ///
+    /// NB: calling this does *not* add the blinded id to the blinded list when called: that
+    /// requires also calling `set_blinded` with this value.
+    ///
+    /// Inputs:
+    /// - `community_base_url` -- String of the base URL for the community this blinded id
+    /// originates from
+    /// - `community_pubkey_hex` -- Hex string of the public key for the community this blinded id
+    /// originates from
+    /// - `blinded_id_hex` -- hex string of the blinded id
+    /// - `legacy_blinding` -- flag indicating whether the pubkey is using legacy blinding
+    ///
+    /// Outputs:
+    /// - `blinded_contact_info` - Returns a filled out blinded_contact_info
+    blinded_contact_info get_or_construct_blinded(
+            std::string_view community_base_url,
+            std::string_view community_pubkey_hex,
+            std::string_view blinded_id_hex,
+            bool legacy_blinding);
 
-    /// API: contacts/contacts::set_blinded_contact
+    /// API: contacts/contacts::set_blinded
     ///
     /// Sets or updates multiple blinded contact info values at once with the given info.  The usual
     /// use is to access the current info, change anything desired, then pass it back into
-    /// set_blinded_contact, e.g.:
+    /// set_blinded, e.g.:
     ///
     ///```cpp
     ///     auto c = contacts.get_blinded(pubkey, legacy_blinding);
     ///     c.name = "Session User 42";
-    ///     contacts.set_blinded_contact(c);
+    ///     contacts.set_blinded(c);
     ///```
     ///
     /// Inputs:
-    /// - `bc` -- set_blinded_contact value to set
-    bool set_blinded_contact(const blinded_contact_info& bc);
+    /// - `bc` -- set_blinded value to set
+    void set_blinded(const blinded_contact_info& bc);
 
-    /// API: contacts/contacts::erase_blinded_contact
+    /// API: contacts/contacts::erase_blinded
     ///
     /// Removes a blinded contact, if present.  Returns true if it was found and removed, false
     /// otherwise. Note that this removes all fields related to a blinded contact, even fields we do
@@ -481,7 +507,7 @@ class Contacts : public ConfigBase {
     ///
     /// Outputs:
     /// - `bool` - Returns true if contact was found and removed, false otherwise
-    bool erase_blinded_contact(
+    bool erase_blinded(
             std::string_view base_url, std::string_view blinded_id, bool legacy_blinding);
 
     struct iterator;