feat: memberStatus instead of a bunch of bools for libsession state

Author: Bilb

src/groups/meta_group_wrapper.hpp

@@ -23,17 +23,28 @@ struct toJs_impl<member> {
         obj["profilePicture"] = toJs(env, info.profile_picture);
         obj["removedStatus"] = toJs(env, info.removed_status);
 
-        // invites
-        obj["inviteNotSent"] = toJs(env, info.invite_not_sent());
-        obj["invitePending"] = toJs(env, info.invite_pending());
-        obj["inviteAccepted"] = toJs(env, info.invite_status == 0);
-        obj["inviteFailed"] = toJs(env, info.invite_failed());
-
-        // promotions
-        obj["promotionNotSent"] = toJs(env, info.promotion_not_sent());
-        obj["promotionPending"] = toJs(env, info.promotion_pending());
-        obj["promotionFailed"] = toJs(env, info.promotion_failed());
-        obj["promoted"] = toJs(env, info.promoted());
+        // promoted() is true as soon as the member is scheduled to be promoted
+        // Note: this should be part of `libsession-util`, not `libsession-util-nodejs`
+        if (info.promoted() && !info.promotion_pending()) {
+            obj["memberStatus"] = toJs(env, "PROMOTION_ACCEPTED");
+        } else if (info.promotion_pending()) {
+            obj["memberStatus"] = toJs(env, "PROMOTION_SENT");
+        } else if (info.promotion_failed()) {
+            obj["memberStatus"] = toJs(env, "PROMOTION_FAILED");
+        } else if (info.admin) {
+            obj["memberStatus"] = toJs(env, "PROMOTION_NOT_SENT");
+        } else if (info.invite_status == 0) {
+            obj["memberStatus"] = toJs(env, "INVITE_ACCEPTED");
+        } else if (info.invite_pending()) {
+            obj["memberStatus"] = toJs(env, "INVITE_SENT");
+        } else if (info.invite_failed()) {
+            obj["memberStatus"] = toJs(env, "INVITE_FAILED");
+        } else {
+            // this is probably a bad idea to have a catch-all else, but we have to when we consider
+            // upgrades of libsession-util
+            obj["memberStatus"] = toJs(env, "INVITE_NOT_SENT");
+        }
+        obj["nominatedAdmin"] = toJs(env, info.admin);
 
         // removed status
         obj["isRemoved"] = toJs(env, info.is_removed());

src/user_groups_config.cpp

@@ -70,6 +70,7 @@ struct toJs_impl<group_info> {
         obj["authData"] = toJs(env, info.auth_data);
         obj["invitePending"] = toJs(env, info.invited);
         obj["kicked"] = toJs(env, info.kicked());
+        obj["destroyed"] = toJs(env, info.isDestroyed());
 
         return obj;
     }
@@ -103,6 +104,9 @@ void UserGroupsWrapper::Init(Napi::Env env, Napi::Object exports) {
                     InstanceMethod("getGroup", &UserGroupsWrapper::getGroup),
                     InstanceMethod("getAllGroups", &UserGroupsWrapper::getAllGroups),
                     InstanceMethod("setGroup", &UserGroupsWrapper::setGroup),
+                    InstanceMethod("markGroupKicked", &UserGroupsWrapper::markGroupKicked),
+                    InstanceMethod("markGroupInvited", &UserGroupsWrapper::markGroupInvited),
+                    InstanceMethod("markGroupDestroyed", &UserGroupsWrapper::markGroupDestroyed),
                     InstanceMethod("eraseGroup", &UserGroupsWrapper::eraseGroup),
 
             });
@@ -316,13 +320,6 @@ Napi::Value UserGroupsWrapper::setGroup(const Napi::CallbackInfo& info) {
             group_info.invited = *invited;
         }
 
-        if (auto kicked =
-                    maybeNonemptyBoolean(obj.Get("kicked"), "UserGroupsWrapper::setGroup kicked")) {
-            if (*kicked) {
-                group_info.setKicked();
-            }
-        }
-
         if (auto secretKey = maybeNonemptyBuffer(
                     obj.Get("secretKey"), "UserGroupsWrapper::setGroup secretKey")) {
             group_info.secretkey = *secretKey;
@@ -343,6 +340,45 @@ Napi::Value UserGroupsWrapper::setGroup(const Napi::CallbackInfo& info) {
     });
 }
 
+Napi::Value UserGroupsWrapper::markGroupKicked(const Napi::CallbackInfo& info) {
+    return wrapResult(info, [&] {
+        auto groupPk = getStringArgs<1>(info);
+
+        auto group = config.get_group(groupPk);
+        if (group) {
+            group->markKicked();
+            config.set(*group);
+        }
+        return config.get_or_construct_group(groupPk);
+    });
+}
+
+Napi::Value UserGroupsWrapper::markGroupInvited(const Napi::CallbackInfo& info) {
+    return wrapResult(info, [&] {
+        auto groupPk = getStringArgs<1>(info);
+
+        auto group = config.get_group(groupPk);
+        if (group) {
+            group->markInvited();
+            config.set(*group);
+        }
+        return config.get_or_construct_group(groupPk);
+    });
+}
+
+Napi::Value UserGroupsWrapper::markGroupDestroyed(const Napi::CallbackInfo& info) {
+    return wrapResult(info, [&] {
+        auto groupPk = getStringArgs<1>(info);
+
+        auto group = config.get_group(groupPk);
+        if (group) {
+            group->markDestroyed();
+            config.set(*group);
+        }
+        return config.get_or_construct_group(groupPk);
+    });
+}
+
 Napi::Value UserGroupsWrapper::eraseGroup(const Napi::CallbackInfo& info) {
     return wrapResult(info, [&] { return config.erase_group(getStringArgs<1>(info)); });
 }

src/user_groups_config.hpp

@@ -34,6 +34,9 @@ class UserGroupsWrapper : public ConfigBaseImpl, public Napi::ObjectWrap<UserGro
     Napi::Value getGroup(const Napi::CallbackInfo& info);
     Napi::Value getAllGroups(const Napi::CallbackInfo& info);
     Napi::Value setGroup(const Napi::CallbackInfo& info);
+    Napi::Value markGroupKicked(const Napi::CallbackInfo& info);
+    Napi::Value markGroupInvited(const Napi::CallbackInfo& info);
+    Napi::Value markGroupDestroyed(const Napi::CallbackInfo& info);
     Napi::Value eraseGroup(const Napi::CallbackInfo& info);
 };
 

types/groups/groupmembers.d.ts

@@ -12,26 +12,27 @@ declare module 'libsession_util_nodejs' {
     profilePicture: ProfilePicture | null;
   };
 
-  export type GroupMemberGet = GroupMemberShared & {
-    /**  Default state, before we try sending the invite */
-    inviteNotSent: boolean;
-    /** We did send the invite to the user */
-    invitePending: boolean;
-    /** The invite was accepted by the user */
-    inviteAccepted: boolean;
-
-    /** We failed to send the invite to the user */
-    inviteFailed: boolean;
-
-    /** Default state, before we try sending the promotion */
-    promotionNotSent: boolean;
-    /** We did send the promotion, not accepted yet */
-    promotionPending: boolean;
-    /** We tried to send the promotion but failed */
-    promotionFailed: boolean;
-    /** The user is already an admin *or* has a pending promotion */
-    promoted: boolean;
+  type MemberStateGroupV2 =
+    | 'INVITE_NOT_SENT' // as soon as we've scheduled that guy to be invited, but before we've tried sending the invite message
+    | 'INVITE_FAILED'
+    | 'INVITE_SENT'
+    | 'INVITE_ACCEPTED' // regular member
+    | 'PROMOTION_NOT_SENT' // as soon as we've scheduled that guy to be an admin, but before we've tried sending the promotion message
+    | 'PROMOTION_FAILED'
+    | 'PROMOTION_SENT'
+    | 'PROMOTION_ACCEPTED'; // regular admin
 
+  export type GroupMemberGet = GroupMemberShared & {
+    memberStatus: MemberStateGroupV2;
+    /**
+     * True if the member is scheduled to get the keys (.admin field of libsession).
+     * This is equivalent of memberStatus being one of:
+     *  - PROMOTION_NOT_SENT
+     *  - PROMOTION_FAILED
+     *  - PROMOTION_SENT
+     *  - PROMOTION_ACCEPTED
+     */
+    nominatedAdmin: boolean;
     /** True if the user should be removed from the group */
     isRemoved: boolean;
     /** True if the user and his messages should be removed from the group */

types/user/usergroups.d.ts

@@ -46,15 +46,16 @@ declare module 'libsession_util_nodejs' {
     authData: Uint8ArrayLen100 | null; // len 100
     name: string | null;
     invitePending: boolean; // tracks `db.approved`. libsession allows this field for all groups (including communities, but we don't need it for more)
-    kicked: boolean; // Note: setting this to true will erase authData and admin secretKey, permanently
+    kicked: boolean; // Note: if the group was `destroyed` this will be false, but `destroyed` will be true
+    destroyed: boolean;
   };
 
   /**
-   * We can set anything on a UserGroup and can omit fields by explicitely setting them to null.
-   * The only one which cannot be omited is the pubkeyHex
+   * We can set anything on a UserGroup and can omit fields by explicitly setting them to null.
+   * The only one which cannot be omitted is the pubkeyHex
    */
   type UserGroupsSet = Pick<UserGroupsGet, 'pubkeyHex'> &
-    AllFieldsNullable<Omit<UserGroupsGet, 'pubkeyHex'>>;
+    AllFieldsNullable<Omit<UserGroupsGet, 'pubkeyHex' | 'kicked' | 'destroyed'>>;
 
   type UserGroupsWrapper = BaseConfigWrapper & {
     init: (secretKey: Uint8Array, dump: Uint8Array | null) => void;
@@ -90,6 +91,9 @@ declare module 'libsession_util_nodejs' {
     getGroup: (pubkeyHex: GroupPubkeyType) => UserGroupsGet | null;
     getAllGroups: () => Array<UserGroupsGet>;
     setGroup: (info: UserGroupsSet) => UserGroupsGet;
+    markGroupKicked: (pubkeyHex: GroupPubkeyType) => UserGroupsGet;
+    markGroupInvited: (pubkeyHex: GroupPubkeyType) => UserGroupsGet;
+    markGroupDestroyed: (pubkeyHex: GroupPubkeyType) => UserGroupsGet;
     eraseGroup: (pubkeyHex: GroupPubkeyType) => boolean;
   };
 
@@ -115,6 +119,9 @@ declare module 'libsession_util_nodejs' {
     public getGroup: UserGroupsWrapper['getGroup'];
     public getAllGroups: UserGroupsWrapper['getAllGroups'];
     public setGroup: UserGroupsWrapper['setGroup'];
+    public markGroupKicked: UserGroupsWrapper['markGroupKicked'];
+    public markGroupInvited: UserGroupsWrapper['markGroupInvited'];
+    public markGroupDestroyed: UserGroupsWrapper['markGroupDestroyed'];
     public eraseGroup: UserGroupsWrapper['eraseGroup'];
   }
 
@@ -134,5 +141,8 @@ declare module 'libsession_util_nodejs' {
     | MakeActionCall<UserGroupsWrapper, 'getGroup'>
     | MakeActionCall<UserGroupsWrapper, 'getAllGroups'>
     | MakeActionCall<UserGroupsWrapper, 'setGroup'>
+    | MakeActionCall<UserGroupsWrapper, 'markGroupKicked'>
+    | MakeActionCall<UserGroupsWrapper, 'markGroupInvited'>
+    | MakeActionCall<UserGroupsWrapper, 'markGroupDestroyed'>
     | MakeActionCall<UserGroupsWrapper, 'eraseGroup'>;
 }