Feat: RPC acknowledgements, add role after project details are sent (#1015)

* feat: Add feature flags and rpc ack messages

* test: acks enabled/disabled

* test: fix tests for new RPC timings / features

* fix: Add role after project details received

* Update src/local-peers.js

Co-authored-by: Andrew Chou <[email protected]>

* Update src/local-peers.js

Co-authored-by: Andrew Chou <[email protected]>

* core: Cleanup per PR review

* core: deffered -> deferred

---------

Co-authored-by: Mauve Signweaver <[email protected]>
Co-authored-by: Andrew Chou <[email protected]>

Author: 3 people

proto/rpc.proto

@@ -39,6 +39,27 @@ message DeviceInfo {
     tablet = 2;
     desktop = 3;
   }
+  enum RPCFeatures {
+    features_unspecified = 0;
+    ack = 1;
+  }
   string name = 1;
   optional DeviceType deviceType = 2;
+  repeated RPCFeatures features = 3;
+}
+
+message InviteAck {
+  bytes inviteId = 1;
+}
+
+message InviteCancelAck {
+  bytes inviteId = 1;
+}
+
+message InviteResponseAck {
+  bytes inviteId = 1;
 }
+
+message ProjectJoinDetailsAck {
+  bytes inviteId = 1;
+}

src/generated/rpc.d.ts

@@ -33,6 +33,7 @@ export interface ProjectJoinDetails {
 export interface DeviceInfo {
     name: string;
     deviceType?: DeviceInfo_DeviceType | undefined;
+    features: DeviceInfo_RPCFeatures[];
 }
 export declare const DeviceInfo_DeviceType: {
     readonly device_type_unspecified: "device_type_unspecified";
@@ -44,6 +45,26 @@ export declare const DeviceInfo_DeviceType: {
 export type DeviceInfo_DeviceType = typeof DeviceInfo_DeviceType[keyof typeof DeviceInfo_DeviceType];
 export declare function deviceInfo_DeviceTypeFromJSON(object: any): DeviceInfo_DeviceType;
 export declare function deviceInfo_DeviceTypeToNumber(object: DeviceInfo_DeviceType): number;
+export declare const DeviceInfo_RPCFeatures: {
+    readonly features_unspecified: "features_unspecified";
+    readonly ack: "ack";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type DeviceInfo_RPCFeatures = typeof DeviceInfo_RPCFeatures[keyof typeof DeviceInfo_RPCFeatures];
+export declare function deviceInfo_RPCFeaturesFromJSON(object: any): DeviceInfo_RPCFeatures;
+export declare function deviceInfo_RPCFeaturesToNumber(object: DeviceInfo_RPCFeatures): number;
+export interface InviteAck {
+    inviteId: Buffer;
+}
+export interface InviteCancelAck {
+    inviteId: Buffer;
+}
+export interface InviteResponseAck {
+    inviteId: Buffer;
+}
+export interface ProjectJoinDetailsAck {
+    inviteId: Buffer;
+}
 export declare const Invite: {
     encode(message: Invite, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): Invite;
@@ -74,6 +95,30 @@ export declare const DeviceInfo: {
     create<I extends Exact<DeepPartial<DeviceInfo>, I>>(base?: I): DeviceInfo;
     fromPartial<I extends Exact<DeepPartial<DeviceInfo>, I>>(object: I): DeviceInfo;
 };
+export declare const InviteAck: {
+    encode(message: InviteAck, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): InviteAck;
+    create<I extends Exact<DeepPartial<InviteAck>, I>>(base?: I): InviteAck;
+    fromPartial<I extends Exact<DeepPartial<InviteAck>, I>>(object: I): InviteAck;
+};
+export declare const InviteCancelAck: {
+    encode(message: InviteCancelAck, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): InviteCancelAck;
+    create<I extends Exact<DeepPartial<InviteCancelAck>, I>>(base?: I): InviteCancelAck;
+    fromPartial<I extends Exact<DeepPartial<InviteCancelAck>, I>>(object: I): InviteCancelAck;
+};
+export declare const InviteResponseAck: {
+    encode(message: InviteResponseAck, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): InviteResponseAck;
+    create<I extends Exact<DeepPartial<InviteResponseAck>, I>>(base?: I): InviteResponseAck;
+    fromPartial<I extends Exact<DeepPartial<InviteResponseAck>, I>>(object: I): InviteResponseAck;
+};
+export declare const ProjectJoinDetailsAck: {
+    encode(message: ProjectJoinDetailsAck, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ProjectJoinDetailsAck;
+    create<I extends Exact<DeepPartial<ProjectJoinDetailsAck>, I>>(base?: I): ProjectJoinDetailsAck;
+    fromPartial<I extends Exact<DeepPartial<ProjectJoinDetailsAck>, I>>(object: I): ProjectJoinDetailsAck;
+};
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;

src/generated/rpc.js

@@ -85,6 +85,36 @@ export function deviceInfo_DeviceTypeToNumber(object) {
             return -1;
     }
 }
+export var DeviceInfo_RPCFeatures = {
+    features_unspecified: "features_unspecified",
+    ack: "ack",
+    UNRECOGNIZED: "UNRECOGNIZED",
+};
+export function deviceInfo_RPCFeaturesFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "features_unspecified":
+            return DeviceInfo_RPCFeatures.features_unspecified;
+        case 1:
+        case "ack":
+            return DeviceInfo_RPCFeatures.ack;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return DeviceInfo_RPCFeatures.UNRECOGNIZED;
+    }
+}
+export function deviceInfo_RPCFeaturesToNumber(object) {
+    switch (object) {
+        case DeviceInfo_RPCFeatures.features_unspecified:
+            return 0;
+        case DeviceInfo_RPCFeatures.ack:
+            return 1;
+        case DeviceInfo_RPCFeatures.UNRECOGNIZED:
+        default:
+            return -1;
+    }
+}
 function createBaseInvite() {
     return { inviteId: Buffer.alloc(0), projectInviteId: Buffer.alloc(0), projectName: "", invitorName: "" };
 }
@@ -336,7 +366,7 @@ export var ProjectJoinDetails = {
     },
 };
 function createBaseDeviceInfo() {
-    return { name: "" };
+    return { name: "", features: [] };
 }
 export var DeviceInfo = {
     encode: function (message, writer) {
@@ -347,6 +377,12 @@ export var DeviceInfo = {
         if (message.deviceType !== undefined) {
             writer.uint32(16).int32(deviceInfo_DeviceTypeToNumber(message.deviceType));
         }
+        writer.uint32(26).fork();
+        for (var _i = 0, _a = message.features; _i < _a.length; _i++) {
+            var v = _a[_i];
+            writer.int32(deviceInfo_RPCFeaturesToNumber(v));
+        }
+        writer.ldelim();
         return writer;
     },
     decode: function (input, length) {
@@ -368,6 +404,19 @@ export var DeviceInfo = {
                     }
                     message.deviceType = deviceInfo_DeviceTypeFromJSON(reader.int32());
                     continue;
+                case 3:
+                    if (tag === 24) {
+                        message.features.push(deviceInfo_RPCFeaturesFromJSON(reader.int32()));
+                        continue;
+                    }
+                    if (tag === 26) {
+                        var end2 = reader.uint32() + reader.pos;
+                        while (reader.pos < end2) {
+                            message.features.push(deviceInfo_RPCFeaturesFromJSON(reader.int32()));
+                        }
+                        continue;
+                    }
+                    break;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -380,10 +429,179 @@ export var DeviceInfo = {
         return DeviceInfo.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial: function (object) {
-        var _a, _b;
+        var _a, _b, _c;
         var message = createBaseDeviceInfo();
         message.name = (_a = object.name) !== null && _a !== void 0 ? _a : "";
         message.deviceType = (_b = object.deviceType) !== null && _b !== void 0 ? _b : undefined;
+        message.features = ((_c = object.features) === null || _c === void 0 ? void 0 : _c.map(function (e) { return e; })) || [];
+        return message;
+    },
+};
+function createBaseInviteAck() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var InviteAck = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseInviteAck();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return InviteAck.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseInviteAck();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
+        return message;
+    },
+};
+function createBaseInviteCancelAck() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var InviteCancelAck = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseInviteCancelAck();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return InviteCancelAck.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseInviteCancelAck();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
+        return message;
+    },
+};
+function createBaseInviteResponseAck() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var InviteResponseAck = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseInviteResponseAck();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return InviteResponseAck.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseInviteResponseAck();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
+        return message;
+    },
+};
+function createBaseProjectJoinDetailsAck() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var ProjectJoinDetailsAck = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseProjectJoinDetailsAck();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return ProjectJoinDetailsAck.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseProjectJoinDetailsAck();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
         return message;
     },
 };