From 0a82bf98fa59e3f2b0e30da8ede77ab3ea7c3cb9 Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 10:28:41 +1100 Subject: [PATCH 1/8] Add displayName and avatar pointer to ConfigurationMessage --- js/models/conversations.d.ts | 1 + preload.js | 6 +- protos/SignalService.proto | 3 + ts/session/constants.ts | 1 + .../outgoing/content/ConfigurationMessage.ts | 26 +++++++- ts/session/utils/Messages.ts | 18 ++++++ ts/session/utils/syncUtils.ts | 61 +++++++++---------- .../messages/ConfigurationMessage_test.ts | 38 ++++++++++++ .../receiving/ConfigurationMessage_test.ts | 3 +- ts/test/session/unit/utils/Messages_test.ts | 1 + 10 files changed, 120 insertions(+), 38 deletions(-) diff --git a/js/models/conversations.d.ts b/js/models/conversations.d.ts index 88d27f5d3..9f0decf13 100644 --- a/js/models/conversations.d.ts +++ b/js/models/conversations.d.ts @@ -22,6 +22,7 @@ interface ConversationAttributes { is_medium_group?: boolean; type: string; lastMessage?: string; + avatarPointer?: string; } export interface ConversationModel diff --git a/preload.js b/preload.js index eab5aa735..7db7de11c 100644 --- a/preload.js +++ b/preload.js @@ -494,7 +494,7 @@ const { window.BlockedNumberController = BlockedNumberController; window.deleteAccount = async reason => { - const syncedMessageSent = async () => { + const deleteEverything = async () => { window.log.info( 'configuration message sent successfully. Deleting everything' ); @@ -512,14 +512,14 @@ window.deleteAccount = async reason => { await window.libsession.Utils.SyncUtils.forceSyncConfigurationNowIfNeeded( true ); - await syncedMessageSent(); + await deleteEverything(); } catch (error) { window.log.error( 'Something went wrong deleting all data:', error && error.stack ? error.stack : error ); try { - await syncedMessageSent(); + await deleteEverything(); } catch (e) { window.log.error(e); } diff --git a/protos/SignalService.proto b/protos/SignalService.proto index 4ad25d0a9..a63ecccbe 100644 --- a/protos/SignalService.proto +++ b/protos/SignalService.proto @@ -219,6 +219,9 @@ message ConfigurationMessage { repeated ClosedGroup closedGroups = 1; repeated string openGroups = 2; + optional string displayName = 3; + optional string profilePicture = 4; + optional bytes profileKey = 5; } message ReceiptMessage { diff --git a/ts/session/constants.ts b/ts/session/constants.ts index 8b0dfae2d..25f873a8c 100644 --- a/ts/session/constants.ts +++ b/ts/session/constants.ts @@ -5,6 +5,7 @@ export const TTL_DEFAULT = { TYPING_MESSAGE: 20 * SECONDS, REGULAR_MESSAGE: 2 * DAYS, ENCRYPTION_PAIR_GROUP: 4 * DAYS, + CONFIGURATION_MESSAGE: 4 * DAYS, }; // User Interface diff --git a/ts/session/messages/outgoing/content/ConfigurationMessage.ts b/ts/session/messages/outgoing/content/ConfigurationMessage.ts index a71f24af9..699b77ece 100644 --- a/ts/session/messages/outgoing/content/ConfigurationMessage.ts +++ b/ts/session/messages/outgoing/content/ConfigurationMessage.ts @@ -11,16 +11,25 @@ import { PubKey } from '../../../types'; interface ConfigurationMessageParams extends MessageParams { activeClosedGroups: Array; activeOpenGroups: Array; + displayName: string; + profilePicture?: string; + profileKey?: Uint8Array; } export class ConfigurationMessage extends ContentMessage { public readonly activeClosedGroups: Array; public readonly activeOpenGroups: Array; + public readonly displayName: string; + public readonly profilePicture?: string; + public readonly profileKey?: Uint8Array; constructor(params: ConfigurationMessageParams) { super({ timestamp: params.timestamp, identifier: params.identifier }); this.activeClosedGroups = params.activeClosedGroups; this.activeOpenGroups = params.activeOpenGroups; + this.displayName = params.displayName; + this.profilePicture = params.profilePicture; + this.profileKey = params.profileKey; if (!this.activeClosedGroups) { throw new Error('closed group must be set'); @@ -29,10 +38,22 @@ export class ConfigurationMessage extends ContentMessage { if (!this.activeOpenGroups) { throw new Error('open group must be set'); } + + if (!this.displayName || !this.displayName?.length) { + throw new Error('displayName must be set'); + } + + if (this.profilePicture && typeof this.profilePicture !== 'string') { + throw new Error('profilePicture set but not an Uin8Array'); + } + + if (this.profileKey && !(this.profileKey instanceof Uint8Array)) { + throw new Error('profileKey set but not an Uin8Array'); + } } public ttl(): number { - return Constants.TTL_DEFAULT.TYPING_MESSAGE; + return Constants.TTL_DEFAULT.CONFIGURATION_MESSAGE; } public contentProto(): SignalService.Content { @@ -45,6 +66,9 @@ export class ConfigurationMessage extends ContentMessage { return new SignalService.ConfigurationMessage({ closedGroups: this.mapClosedGroupsObjectToProto(this.activeClosedGroups), openGroups: this.activeOpenGroups, + displayName: this.displayName, + profilePicture: this.profilePicture, + profileKey: this.profileKey, }); } diff --git a/ts/session/utils/Messages.ts b/ts/session/utils/Messages.ts index 97d7787c0..cbc0d19fe 100644 --- a/ts/session/utils/Messages.ts +++ b/ts/session/utils/Messages.ts @@ -69,6 +69,7 @@ export const getCurrentConfigurationMessage = async ( convos: Array ) => { const ourPubKey = (await UserUtils.getOurNumber()).key; + const ourConvo = convos.find(convo => convo.id === ourPubKey); const openGroupsIds = convos .filter(c => !!c.get('active_at') && c.isPublic() && !c.get('left')) .map(c => c.id.substring((c.id as string).lastIndexOf('@') + 1)) as Array< @@ -107,10 +108,27 @@ export const getCurrentConfigurationMessage = async ( const onlyValidClosedGroup = closedGroups.filter(m => m !== null) as Array< ConfigurationMessageClosedGroup >; + + if (!ourConvo) { + window.log.error( + 'Could not find our convo while building a configuration message.' + ); + } + const profileKeyFromStorage = window.storage.get('profileKey'); + const profileKey = profileKeyFromStorage + ? new Uint8Array(profileKeyFromStorage) + : undefined; + + const profilePicture = ourConvo?.get('avatarPointer') || undefined; + const displayName = ourConvo?.getLokiProfile()?.displayName || undefined; + return new ConfigurationMessage({ identifier: uuid(), timestamp: Date.now(), activeOpenGroups: openGroupsIds, activeClosedGroups: onlyValidClosedGroup, + displayName, + profilePicture, + profileKey, }); }; diff --git a/ts/session/utils/syncUtils.ts b/ts/session/utils/syncUtils.ts index dc0a62b2e..15c5723db 100644 --- a/ts/session/utils/syncUtils.ts +++ b/ts/session/utils/syncUtils.ts @@ -42,39 +42,34 @@ export const syncConfigurationIfNeeded = async () => { export const forceSyncConfigurationNowIfNeeded = async ( waitForMessageSent = false -) => { - const allConvos = ConversationController.getInstance().getConversations(); - const configMessage = await getCurrentConfigurationMessage(allConvos); - window.log.info('forceSyncConfigurationNowIfNeeded with', configMessage); +) => + new Promise(resolve => { + const allConvos = ConversationController.getInstance().getConversations(); - const waitForMessageSentEvent = new Promise(resolve => { - const ourResolver = (message: any) => { - if (message.identifier === configMessage.identifier) { - getMessageQueue().events.off('sendSuccess', ourResolver); - getMessageQueue().events.off('sendFail', ourResolver); - resolve(true); + void getCurrentConfigurationMessage(allConvos).then(configMessage => { + window.log.info('forceSyncConfigurationNowIfNeeded with', configMessage); + + try { + // this just adds the message to the sending queue. + // if waitForMessageSent is set, we need to effectively wait until then + // tslint:disable-next-line: no-void-expression + const callback = waitForMessageSent + ? () => { + resolve(true); + } + : undefined; + void getMessageQueue().sendSyncMessage(configMessage, callback as any); + // either we resolve from the callback if we need to wait for it, + // or we don't want to wait, we resolve it here. + if (!waitForMessageSent) { + resolve(true); + } + } catch (e) { + window.log.warn( + 'Caught an error while sending our ConfigurationMessage:', + e + ); + resolve(false); } - }; - getMessageQueue().events.on('sendSuccess', ourResolver); - getMessageQueue().events.on('sendFail', ourResolver); + }); }); - - try { - // this just adds the message to the sending queue. - // if waitForMessageSent is set, we need to effectively wait until then - await Promise.all([ - getMessageQueue().sendSyncMessage(configMessage), - waitForMessageSentEvent, - ]); - } catch (e) { - window.log.warn( - 'Caught an error while sending our ConfigurationMessage:', - e - ); - } - if (!waitForMessageSent) { - return; - } - - return waitForMessageSentEvent; -}; diff --git a/ts/test/session/unit/messages/ConfigurationMessage_test.ts b/ts/test/session/unit/messages/ConfigurationMessage_test.ts index 04555f9c6..6dc406cb4 100644 --- a/ts/test/session/unit/messages/ConfigurationMessage_test.ts +++ b/ts/test/session/unit/messages/ConfigurationMessage_test.ts @@ -7,6 +7,7 @@ import { } from '../../../../session/messages/outgoing/content/ConfigurationMessage'; import { TestUtils } from '../../../test-utils'; +// tslint:disable-next-line: max-func-body-length describe('ConfigurationMessage', () => { it('throw if closed group is not set', () => { const activeClosedGroups = null as any; @@ -14,6 +15,7 @@ describe('ConfigurationMessage', () => { activeClosedGroups, activeOpenGroups: [], timestamp: Date.now(), + displayName: 'displayName', }; expect(() => new ConfigurationMessage(params)).to.throw( 'closed group must be set' @@ -26,12 +28,48 @@ describe('ConfigurationMessage', () => { activeClosedGroups: [], activeOpenGroups, timestamp: Date.now(), + displayName: 'displayName', }; expect(() => new ConfigurationMessage(params)).to.throw( 'open group must be set' ); }); + it('throw if display name is not set', () => { + const params = { + activeClosedGroups: [], + activeOpenGroups: [], + timestamp: Date.now(), + displayName: undefined as any, + }; + expect(() => new ConfigurationMessage(params)).to.throw( + 'displayName must be set' + ); + }); + + it('throw if display name is set but empty', () => { + const params = { + activeClosedGroups: [], + activeOpenGroups: [], + timestamp: Date.now(), + displayName: undefined as any, + }; + expect(() => new ConfigurationMessage(params)).to.throw( + 'displayName must be set' + ); + }); + + it('ttl is 4 days', () => { + const params = { + activeClosedGroups: [], + activeOpenGroups: [], + timestamp: Date.now(), + displayName: 'displayName', + }; + const configMessage = new ConfigurationMessage(params); + expect(configMessage.ttl()).to.be.equal(4 * 24 * 60 * 60 * 1000); + }); + describe('ConfigurationMessageClosedGroup', () => { it('throw if closed group has no encryptionkeypair', () => { const member = TestUtils.generateFakePubKey().key; diff --git a/ts/test/session/unit/receiving/ConfigurationMessage_test.ts b/ts/test/session/unit/receiving/ConfigurationMessage_test.ts index 0589ff1fc..4426856a8 100644 --- a/ts/test/session/unit/receiving/ConfigurationMessage_test.ts +++ b/ts/test/session/unit/receiving/ConfigurationMessage_test.ts @@ -34,7 +34,8 @@ describe('ConfigurationMessage_receiving', () => { activeOpenGroups: [], activeClosedGroups: [], timestamp: Date.now(), - identifier: 'whatever', + identifier: 'identifier', + displayName: 'displayName', }); }); diff --git a/ts/test/session/unit/utils/Messages_test.ts b/ts/test/session/unit/utils/Messages_test.ts index 8ca9837cb..41d93d03f 100644 --- a/ts/test/session/unit/utils/Messages_test.ts +++ b/ts/test/session/unit/utils/Messages_test.ts @@ -215,6 +215,7 @@ describe('Message Utils', () => { timestamp: Date.now(), activeOpenGroups: [], activeClosedGroups: [], + displayName: 'displayName', }); const rawMessage = await MessageUtils.toRawMessage(device, msg); expect(rawMessage.encryption).to.equal(EncryptionType.Fallback); From a61f5e681400f575ab291ab97d4a75b991beb7e6 Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 12:50:23 +1100 Subject: [PATCH 2/8] add contacts to ConfigurationMessage --- js/models/conversations.d.ts | 1 + js/models/messages.js | 17 ++-- protos/SignalService.proto | 8 ++ .../outgoing/content/ConfigurationMessage.ts | 66 ++++++++++++++ ts/session/utils/Messages.ts | 21 +++++ .../messages/ConfigurationMessage_test.ts | 86 +++++++++++++++++++ .../receiving/ConfigurationMessage_test.ts | 1 + ts/test/session/unit/utils/Messages_test.ts | 1 + 8 files changed, 195 insertions(+), 6 deletions(-) diff --git a/js/models/conversations.d.ts b/js/models/conversations.d.ts index 9f0decf13..340e3db36 100644 --- a/js/models/conversations.d.ts +++ b/js/models/conversations.d.ts @@ -23,6 +23,7 @@ interface ConversationAttributes { type: string; lastMessage?: string; avatarPointer?: string; + profileKey?: Uint8Array; } export interface ConversationModel diff --git a/js/models/messages.js b/js/models/messages.js index e8611b208..15a2c19f2 100644 --- a/js/models/messages.js +++ b/js/models/messages.js @@ -1297,12 +1297,17 @@ (dataMessage.body && dataMessage.body.length) || dataMessage.attachments.length ) { - const syncMessage = libsession.Messages.Outgoing.ChatMessage.buildSyncMessage( - dataMessage, - this.getConversation().id, - sentTimestamp - ); - await libsession.getMessageQueue().sendSyncMessage(syncMessage); + // try catch not to be kept + try { + const syncMessage = libsession.Messages.Outgoing.ChatMessage.buildSyncMessage( + dataMessage, + this.getConversation().id, + sentTimestamp + ); + await libsession.getMessageQueue().sendSyncMessage(syncMessage); + } catch (e) { + window.log.warn(e); + } } // - copy all fields from dataMessage and create a new ChatMessage diff --git a/protos/SignalService.proto b/protos/SignalService.proto index a63ecccbe..513097cce 100644 --- a/protos/SignalService.proto +++ b/protos/SignalService.proto @@ -217,11 +217,19 @@ message ConfigurationMessage { repeated bytes admins = 5; } + message Contact { + optional bytes publicKey = 1; + optional string name = 2; + optional string profilePicture = 3; + optional bytes profileKey = 4; + } + repeated ClosedGroup closedGroups = 1; repeated string openGroups = 2; optional string displayName = 3; optional string profilePicture = 4; optional bytes profileKey = 5; + repeated Contact contacts = 6; } message ReceiptMessage { diff --git a/ts/session/messages/outgoing/content/ConfigurationMessage.ts b/ts/session/messages/outgoing/content/ConfigurationMessage.ts index 699b77ece..fd3201698 100644 --- a/ts/session/messages/outgoing/content/ConfigurationMessage.ts +++ b/ts/session/messages/outgoing/content/ConfigurationMessage.ts @@ -14,6 +14,7 @@ interface ConfigurationMessageParams extends MessageParams { displayName: string; profilePicture?: string; profileKey?: Uint8Array; + contacts: Array; } export class ConfigurationMessage extends ContentMessage { @@ -22,6 +23,7 @@ export class ConfigurationMessage extends ContentMessage { public readonly displayName: string; public readonly profilePicture?: string; public readonly profileKey?: Uint8Array; + public readonly contacts: Array; constructor(params: ConfigurationMessageParams) { super({ timestamp: params.timestamp, identifier: params.identifier }); @@ -30,6 +32,7 @@ export class ConfigurationMessage extends ContentMessage { this.displayName = params.displayName; this.profilePicture = params.profilePicture; this.profileKey = params.profileKey; + this.contacts = params.contacts; if (!this.activeClosedGroups) { throw new Error('closed group must be set'); @@ -50,6 +53,10 @@ export class ConfigurationMessage extends ContentMessage { if (this.profileKey && !(this.profileKey instanceof Uint8Array)) { throw new Error('profileKey set but not an Uin8Array'); } + + if (!this.contacts) { + throw new Error('contacts must be set'); + } } public ttl(): number { @@ -69,6 +76,7 @@ export class ConfigurationMessage extends ContentMessage { displayName: this.displayName, profilePicture: this.profilePicture, profileKey: this.profileKey, + contacts: this.mapContactsObjectToProto(this.contacts), }); } @@ -79,6 +87,64 @@ export class ConfigurationMessage extends ContentMessage { new ConfigurationMessageClosedGroup(m).toProto() ); } + + private mapContactsObjectToProto( + contacts: Array + ): Array { + return (contacts || []).map(m => + new ConfigurationMessageContact(m).toProto() + ); + } +} + +export class ConfigurationMessageContact { + public publicKey: string; + public displayName: string; + public profilePictureURL?: string; + public profileKey?: Uint8Array; + + public constructor({ + publicKey, + displayName, + profilePictureURL, + profileKey, + }: { + publicKey: string; + displayName: string; + profilePictureURL?: string; + profileKey?: Uint8Array; + }) { + this.publicKey = publicKey; + this.displayName = displayName; + this.profilePictureURL = profilePictureURL; + this.profileKey = profileKey; + + // will throw if public key is invalid + PubKey.cast(publicKey); + + if (this.displayName?.length === 0) { + throw new Error('displayName must be set or undefined'); + } + + if ( + this.profilePictureURL !== undefined && + this.profilePictureURL?.length === 0 + ) { + throw new Error('profilePictureURL must either undefined or not empty'); + } + if (this.profileKey !== undefined && this.profileKey?.length === 0) { + throw new Error('profileKey must either undefined or not empty'); + } + } + + public toProto(): SignalService.ConfigurationMessage.Contact { + return new SignalService.ConfigurationMessage.Contact({ + publicKey: fromHexToArray(this.publicKey), + name: this.displayName, + profilePicture: this.profilePictureURL, + profileKey: this.profileKey, + }); + } } export class ConfigurationMessageClosedGroup { diff --git a/ts/session/utils/Messages.ts b/ts/session/utils/Messages.ts index cbc0d19fe..4c2110aa3 100644 --- a/ts/session/utils/Messages.ts +++ b/ts/session/utils/Messages.ts @@ -10,6 +10,7 @@ import { ConversationModel } from '../../../js/models/conversations'; import { ConfigurationMessage, ConfigurationMessageClosedGroup, + ConfigurationMessageContact, } from '../messages/outgoing/content/ConfigurationMessage'; import uuid from 'uuid'; import { getLatestClosedGroupEncryptionKeyPair } from '../../../js/modules/data'; @@ -70,11 +71,15 @@ export const getCurrentConfigurationMessage = async ( ) => { const ourPubKey = (await UserUtils.getOurNumber()).key; const ourConvo = convos.find(convo => convo.id === ourPubKey); + + // Filter open groups const openGroupsIds = convos .filter(c => !!c.get('active_at') && c.isPublic() && !c.get('left')) .map(c => c.id.substring((c.id as string).lastIndexOf('@') + 1)) as Array< string >; + + // Filter Closed/Medium groups const closedGroupModels = convos.filter( c => !!c.get('active_at') && @@ -109,6 +114,21 @@ export const getCurrentConfigurationMessage = async ( ConfigurationMessageClosedGroup >; + // Filter contacts + const contactsModels = convos.filter( + c => !!c.get('active_at') && c.isPrivate() && !c.isBlocked() + ); + + const contacts = contactsModels.map(c => { + const groupPubKey = c.get('id'); + return new ConfigurationMessageContact({ + publicKey: groupPubKey, + displayName: c.get('name'), + profilePictureURL: c.get('avatarPointer'), + profileKey: c.get('profileKey'), + }); + }); + if (!ourConvo) { window.log.error( 'Could not find our convo while building a configuration message.' @@ -130,5 +150,6 @@ export const getCurrentConfigurationMessage = async ( displayName, profilePicture, profileKey, + contacts, }); }; diff --git a/ts/test/session/unit/messages/ConfigurationMessage_test.ts b/ts/test/session/unit/messages/ConfigurationMessage_test.ts index 6dc406cb4..b937f7cd2 100644 --- a/ts/test/session/unit/messages/ConfigurationMessage_test.ts +++ b/ts/test/session/unit/messages/ConfigurationMessage_test.ts @@ -4,6 +4,7 @@ import { ECKeyPair } from '../../../../receiver/keypairs'; import { ConfigurationMessage, ConfigurationMessageClosedGroup, + ConfigurationMessageContact, } from '../../../../session/messages/outgoing/content/ConfigurationMessage'; import { TestUtils } from '../../../test-utils'; @@ -16,6 +17,7 @@ describe('ConfigurationMessage', () => { activeOpenGroups: [], timestamp: Date.now(), displayName: 'displayName', + contacts: [], }; expect(() => new ConfigurationMessage(params)).to.throw( 'closed group must be set' @@ -29,6 +31,7 @@ describe('ConfigurationMessage', () => { activeOpenGroups, timestamp: Date.now(), displayName: 'displayName', + contacts: [], }; expect(() => new ConfigurationMessage(params)).to.throw( 'open group must be set' @@ -41,6 +44,7 @@ describe('ConfigurationMessage', () => { activeOpenGroups: [], timestamp: Date.now(), displayName: undefined as any, + contacts: [], }; expect(() => new ConfigurationMessage(params)).to.throw( 'displayName must be set' @@ -53,6 +57,7 @@ describe('ConfigurationMessage', () => { activeOpenGroups: [], timestamp: Date.now(), displayName: undefined as any, + contacts: [], }; expect(() => new ConfigurationMessage(params)).to.throw( 'displayName must be set' @@ -65,6 +70,7 @@ describe('ConfigurationMessage', () => { activeOpenGroups: [], timestamp: Date.now(), displayName: 'displayName', + contacts: [], }; const configMessage = new ConfigurationMessage(params); expect(configMessage.ttl()).to.be.equal(4 * 24 * 60 * 60 * 1000); @@ -175,4 +181,84 @@ describe('ConfigurationMessage', () => { ); }); }); + + describe('ConfigurationMessageContact', () => { + it('throws if contacts is not set', () => { + const params = { + activeClosedGroups: [], + activeOpenGroups: [], + timestamp: Date.now(), + displayName: 'displayName', + contacts: undefined as any, + }; + expect(() => new ConfigurationMessage(params)).to.throw( + 'contacts must be set' + ); + }); + it('throw if some admins are not members', () => { + const member = TestUtils.generateFakePubKey().key; + const admin = TestUtils.generateFakePubKey().key; + const params = { + publicKey: TestUtils.generateFakePubKey().key, + name: 'groupname', + members: [member], + admins: [admin], + encryptionKeyPair: TestUtils.generateFakeECKeyPair(), + }; + + expect(() => new ConfigurationMessageClosedGroup(params)).to.throw( + 'some admins are not members' + ); + }); + + it('throw if the contact has not a valid pubkey', () => { + const params = { + publicKey: '05', + displayName: 'contactDisplayName', + }; + + expect(() => new ConfigurationMessageContact(params)).to.throw(); + + const params2 = { + publicKey: undefined as any, + displayName: 'contactDisplayName', + }; + + expect(() => new ConfigurationMessageContact(params2)).to.throw(); + }); + + it('throw if the contact has an empty disploy name', () => { + // a display name cannot be empty. It should be undefined rather than empty + const params2 = { + publicKey: TestUtils.generateFakePubKey().key, + displayName: '', + }; + + expect(() => new ConfigurationMessageContact(params2)).to.throw(); + }); + + it('throw if the contact has a profileAvatar set but empty', () => { + const params = { + publicKey: TestUtils.generateFakePubKey().key, + displayName: 'contactDisplayName', + profilePictureURL: '', + }; + + expect(() => new ConfigurationMessageContact(params)).to.throw( + 'profilePictureURL must either undefined or not empty' + ); + }); + + it('throw if the contact has a profileKey set but empty', () => { + const params = { + publicKey: TestUtils.generateFakePubKey().key, + displayName: 'contactDisplayName', + profileKey: new Uint8Array(), + }; + + expect(() => new ConfigurationMessageContact(params)).to.throw( + 'profileKey must either undefined or not empty' + ); + }); + }); }); diff --git a/ts/test/session/unit/receiving/ConfigurationMessage_test.ts b/ts/test/session/unit/receiving/ConfigurationMessage_test.ts index 4426856a8..0c3bcc725 100644 --- a/ts/test/session/unit/receiving/ConfigurationMessage_test.ts +++ b/ts/test/session/unit/receiving/ConfigurationMessage_test.ts @@ -36,6 +36,7 @@ describe('ConfigurationMessage_receiving', () => { timestamp: Date.now(), identifier: 'identifier', displayName: 'displayName', + contacts: [], }); }); diff --git a/ts/test/session/unit/utils/Messages_test.ts b/ts/test/session/unit/utils/Messages_test.ts index 41d93d03f..d0abb22e7 100644 --- a/ts/test/session/unit/utils/Messages_test.ts +++ b/ts/test/session/unit/utils/Messages_test.ts @@ -216,6 +216,7 @@ describe('Message Utils', () => { activeOpenGroups: [], activeClosedGroups: [], displayName: 'displayName', + contacts: [], }); const rawMessage = await MessageUtils.toRawMessage(device, msg); expect(rawMessage.encryption).to.equal(EncryptionType.Fallback); From 3f59ce1692cb6fc66d3babca28b91756348a1879 Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Mon, 22 Feb 2021 09:58:29 +1100 Subject: [PATCH 3/8] fix updates of message on message syncing --- js/models/messages.js | 1 + .../outgoing/content/data/ChatMessage.ts | 23 +++++++++++-------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/js/models/messages.js b/js/models/messages.js index 15a2c19f2..bb61ab18d 100644 --- a/js/models/messages.js +++ b/js/models/messages.js @@ -1300,6 +1300,7 @@ // try catch not to be kept try { const syncMessage = libsession.Messages.Outgoing.ChatMessage.buildSyncMessage( + this.id, dataMessage, this.getConversation().id, sentTimestamp diff --git a/ts/session/messages/outgoing/content/data/ChatMessage.ts b/ts/session/messages/outgoing/content/data/ChatMessage.ts index 2a661c2ed..fcd5ad6f4 100644 --- a/ts/session/messages/outgoing/content/data/ChatMessage.ts +++ b/ts/session/messages/outgoing/content/data/ChatMessage.ts @@ -91,18 +91,15 @@ export class ChatMessage extends DataMessage { } public static buildSyncMessage( - dataMessage: SignalService.IDataMessage, + identifier: string, + dataMessage: SignalService.DataMessage, syncTarget: string, sentTimestamp: number ) { - // the dataMessage.profileKey is of type ByteBuffer. We need to make it a Uint8Array - const lokiProfile: any = { - profileKey: new Uint8Array( - (dataMessage.profileKey as any).toArrayBuffer() - ), - }; - - if ((dataMessage as any)?.$type?.name !== 'DataMessage') { + if ( + (dataMessage as any).constructor.name !== 'DataMessage' && + !(dataMessage instanceof DataMessage) + ) { throw new Error( 'Tried to build a sync message from something else than a DataMessage' ); @@ -111,6 +108,13 @@ export class ChatMessage extends DataMessage { if (!sentTimestamp || !isNumber(sentTimestamp)) { throw new Error('Tried to build a sync message without a sentTimestamp'); } + // the dataMessage.profileKey is of type ByteBuffer. We need to make it a Uint8Array + const lokiProfile: any = {}; + if (dataMessage.profileKey?.length) { + lokiProfile.profileKey = new Uint8Array( + (dataMessage.profileKey as any).toArrayBuffer() + ); + } if (dataMessage.profile) { if (dataMessage.profile?.displayName) { @@ -138,6 +142,7 @@ export class ChatMessage extends DataMessage { const preview = (dataMessage.preview as Array) || []; return new ChatMessage({ + identifier, timestamp, attachments, body, From 1a405fdf43ec4881d74601e759d2940707f61d6d Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 13:06:45 +1100 Subject: [PATCH 4/8] do not notify PN server when we sync a message to our device --- js/models/messages.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/js/models/messages.js b/js/models/messages.js index bb61ab18d..c6ac62c14 100644 --- a/js/models/messages.js +++ b/js/models/messages.js @@ -1061,8 +1061,7 @@ (dataMessage.body || (dataMessage.attachments && dataMessage.attachments.length)) ); - const shouldNotifyPushServer = - hasBodyOrAttachments && isSessionOrClosedMessage; + const shouldNotifyPushServer = hasBodyOrAttachments && !isOurDevice; if (shouldNotifyPushServer) { // notify the push notification server if needed From 92901d9462479036650b94db1cd63dfd93ef2dcf Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 13:08:40 +1100 Subject: [PATCH 5/8] bump to v1.4.10 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 313f597d8..f5de4d199 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "session-desktop", "productName": "Session", "description": "Private messaging from your desktop", - "version": "1.4.9", + "version": "1.4.10", "license": "GPL-3.0", "author": { "name": "Loki Project", From e0c2cf8e9add5deb65544460f0b39a241c64ef64 Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 14:23:09 +1100 Subject: [PATCH 6/8] Force configuration message on avatar or display name update --- js/background.js | 10 ++++++++-- .../outgoing/content/ConfigurationMessage.ts | 8 ++------ ts/session/utils/Messages.ts | 11 +++++++---- .../unit/messages/ConfigurationMessage_test.ts | 12 ++++++++++-- 4 files changed, 27 insertions(+), 14 deletions(-) diff --git a/js/background.js b/js/background.js index 4a614f831..a4112e1a5 100644 --- a/js/background.js +++ b/js/background.js @@ -615,7 +615,10 @@ displayName: newName, avatar: newAvatarPath, }); - conversation.commit(); + await conversation.commit(); + await window.libsession.Utils.SyncUtils.forceSyncConfigurationNowIfNeeded( + true + ); } catch (error) { window.log.error( 'showEditProfileDialog Error ensuring that image is properly sized:', @@ -627,9 +630,12 @@ conversation.setLokiProfile({ displayName: newName, }); + await conversation.commit(); + await window.libsession.Utils.SyncUtils.forceSyncConfigurationNowIfNeeded( + true + ); } - conversation.commit(); // inform all your registered public servers // could put load on all the servers // if they just keep changing their names without sending messages diff --git a/ts/session/messages/outgoing/content/ConfigurationMessage.ts b/ts/session/messages/outgoing/content/ConfigurationMessage.ts index fd3201698..a34a50ea6 100644 --- a/ts/session/messages/outgoing/content/ConfigurationMessage.ts +++ b/ts/session/messages/outgoing/content/ConfigurationMessage.ts @@ -83,17 +83,13 @@ export class ConfigurationMessage extends ContentMessage { private mapClosedGroupsObjectToProto( closedGroups: Array ): Array { - return (closedGroups || []).map(m => - new ConfigurationMessageClosedGroup(m).toProto() - ); + return (closedGroups || []).map(m => m.toProto()); } private mapContactsObjectToProto( contacts: Array ): Array { - return (contacts || []).map(m => - new ConfigurationMessageContact(m).toProto() - ); + return (contacts || []).map(m => m.toProto()); } } diff --git a/ts/session/utils/Messages.ts b/ts/session/utils/Messages.ts index 4c2110aa3..1957fea66 100644 --- a/ts/session/utils/Messages.ts +++ b/ts/session/utils/Messages.ts @@ -116,14 +116,17 @@ export const getCurrentConfigurationMessage = async ( // Filter contacts const contactsModels = convos.filter( - c => !!c.get('active_at') && c.isPrivate() && !c.isBlocked() + c => + !!c.get('active_at') && + c.getLokiProfile()?.displayName && + c.isPrivate() && + !c.isBlocked() ); const contacts = contactsModels.map(c => { - const groupPubKey = c.get('id'); return new ConfigurationMessageContact({ - publicKey: groupPubKey, - displayName: c.get('name'), + publicKey: c.id, + displayName: c.getLokiProfile()?.displayName, profilePictureURL: c.get('avatarPointer'), profileKey: c.get('profileKey'), }); diff --git a/ts/test/session/unit/messages/ConfigurationMessage_test.ts b/ts/test/session/unit/messages/ConfigurationMessage_test.ts index b937f7cd2..ff4635761 100644 --- a/ts/test/session/unit/messages/ConfigurationMessage_test.ts +++ b/ts/test/session/unit/messages/ConfigurationMessage_test.ts @@ -227,8 +227,16 @@ describe('ConfigurationMessage', () => { expect(() => new ConfigurationMessageContact(params2)).to.throw(); }); - it('throw if the contact has an empty disploy name', () => { - // a display name cannot be empty. It should be undefined rather than empty + it('throw if the contact has an empty display name', () => { + // a display name cannot be empty nor undefined + + const params = { + publicKey: TestUtils.generateFakePubKey().key, + displayName: undefined as any, + }; + + expect(() => new ConfigurationMessageContact(params2)).to.throw(); + const params2 = { publicKey: TestUtils.generateFakePubKey().key, displayName: '', From 215cffdd751f72a234cee3bd5a988b991ac5b0cd Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 14:46:46 +1100 Subject: [PATCH 7/8] address reviews --- js/background.js | 1 + ts/session/utils/Messages.ts | 102 +----------------------------- ts/session/utils/syncUtils.ts | 114 ++++++++++++++++++++++++++++++++-- 3 files changed, 110 insertions(+), 107 deletions(-) diff --git a/js/background.js b/js/background.js index a4112e1a5..b040c8276 100644 --- a/js/background.js +++ b/js/background.js @@ -630,6 +630,7 @@ conversation.setLokiProfile({ displayName: newName, }); + // might be good to not trigger a sync if the name did not change await conversation.commit(); await window.libsession.Utils.SyncUtils.forceSyncConfigurationNowIfNeeded( true diff --git a/ts/session/utils/Messages.ts b/ts/session/utils/Messages.ts index 1957fea66..cd1051727 100644 --- a/ts/session/utils/Messages.ts +++ b/ts/session/utils/Messages.ts @@ -6,16 +6,7 @@ import { import { EncryptionType, PubKey } from '../types'; import { ClosedGroupMessage } from '../messages/outgoing/content/data/group/ClosedGroupMessage'; import { ClosedGroupNewMessage } from '../messages/outgoing/content/data/group/ClosedGroupNewMessage'; -import { ConversationModel } from '../../../js/models/conversations'; -import { - ConfigurationMessage, - ConfigurationMessageClosedGroup, - ConfigurationMessageContact, -} from '../messages/outgoing/content/ConfigurationMessage'; -import uuid from 'uuid'; -import { getLatestClosedGroupEncryptionKeyPair } from '../../../js/modules/data'; -import { UserUtils } from '.'; -import { ECKeyPair } from '../../receiver/keypairs'; + import _ from 'lodash'; import { ClosedGroupEncryptionPairReplyMessage } from '../messages/outgoing/content/data/group/ClosedGroupEncryptionPairReplyMessage'; @@ -65,94 +56,3 @@ export async function toRawMessage( return rawMessage; } - -export const getCurrentConfigurationMessage = async ( - convos: Array -) => { - const ourPubKey = (await UserUtils.getOurNumber()).key; - const ourConvo = convos.find(convo => convo.id === ourPubKey); - - // Filter open groups - const openGroupsIds = convos - .filter(c => !!c.get('active_at') && c.isPublic() && !c.get('left')) - .map(c => c.id.substring((c.id as string).lastIndexOf('@') + 1)) as Array< - string - >; - - // Filter Closed/Medium groups - const closedGroupModels = convos.filter( - c => - !!c.get('active_at') && - c.isMediumGroup() && - c.get('members').includes(ourPubKey) && - !c.get('left') && - !c.get('isKickedFromGroup') && - !c.isBlocked() - ); - - const closedGroups = await Promise.all( - closedGroupModels.map(async c => { - const groupPubKey = c.get('id'); - const fetchEncryptionKeyPair = await getLatestClosedGroupEncryptionKeyPair( - groupPubKey - ); - if (!fetchEncryptionKeyPair) { - return null; - } - - return new ConfigurationMessageClosedGroup({ - publicKey: groupPubKey, - name: c.get('name'), - members: c.get('members') || [], - admins: c.get('groupAdmins') || [], - encryptionKeyPair: ECKeyPair.fromHexKeyPair(fetchEncryptionKeyPair), - }); - }) - ); - - const onlyValidClosedGroup = closedGroups.filter(m => m !== null) as Array< - ConfigurationMessageClosedGroup - >; - - // Filter contacts - const contactsModels = convos.filter( - c => - !!c.get('active_at') && - c.getLokiProfile()?.displayName && - c.isPrivate() && - !c.isBlocked() - ); - - const contacts = contactsModels.map(c => { - return new ConfigurationMessageContact({ - publicKey: c.id, - displayName: c.getLokiProfile()?.displayName, - profilePictureURL: c.get('avatarPointer'), - profileKey: c.get('profileKey'), - }); - }); - - if (!ourConvo) { - window.log.error( - 'Could not find our convo while building a configuration message.' - ); - } - const profileKeyFromStorage = window.storage.get('profileKey'); - const profileKey = profileKeyFromStorage - ? new Uint8Array(profileKeyFromStorage) - : undefined; - - const profilePicture = ourConvo?.get('avatarPointer') || undefined; - const displayName = ourConvo?.getLokiProfile()?.displayName || undefined; - - return new ConfigurationMessage({ - identifier: uuid(), - timestamp: Date.now(), - activeOpenGroups: openGroupsIds, - activeClosedGroups: onlyValidClosedGroup, - displayName, - profilePicture, - profileKey, - contacts, - }); -}; diff --git a/ts/session/utils/syncUtils.ts b/ts/session/utils/syncUtils.ts index 15c5723db..5438dc86c 100644 --- a/ts/session/utils/syncUtils.ts +++ b/ts/session/utils/syncUtils.ts @@ -1,9 +1,20 @@ -import { createOrUpdateItem, getItemById } from '../../../js/modules/data'; +import { + createOrUpdateItem, + getItemById, + getLatestClosedGroupEncryptionKeyPair, +} from '../../../js/modules/data'; import { getMessageQueue } from '..'; import { ConversationController } from '../conversations'; -import { getCurrentConfigurationMessage } from './Messages'; -import { RawMessage } from '../types'; import { DAYS } from './Number'; +import uuid from 'uuid'; +import { UserUtils } from '.'; +import { ConversationModel } from '../../../js/models/conversations'; +import { ECKeyPair } from '../../receiver/keypairs'; +import { + ConfigurationMessage, + ConfigurationMessageClosedGroup, + ConfigurationMessageContact, +} from '../messages/outgoing/content/ConfigurationMessage'; const ITEM_ID_LAST_SYNC_TIMESTAMP = 'lastSyncedTimestamp'; @@ -47,7 +58,7 @@ export const forceSyncConfigurationNowIfNeeded = async ( const allConvos = ConversationController.getInstance().getConversations(); void getCurrentConfigurationMessage(allConvos).then(configMessage => { - window.log.info('forceSyncConfigurationNowIfNeeded with', configMessage); + // console.warn('forceSyncConfigurationNowIfNeeded with', configMessage); try { // this just adds the message to the sending queue. @@ -55,8 +66,8 @@ export const forceSyncConfigurationNowIfNeeded = async ( // tslint:disable-next-line: no-void-expression const callback = waitForMessageSent ? () => { - resolve(true); - } + resolve(true); + } : undefined; void getMessageQueue().sendSyncMessage(configMessage, callback as any); // either we resolve from the callback if we need to wait for it, @@ -73,3 +84,94 @@ export const forceSyncConfigurationNowIfNeeded = async ( } }); }); + +export const getCurrentConfigurationMessage = async ( + convos: Array +) => { + const ourPubKey = (await UserUtils.getOurNumber()).key; + const ourConvo = convos.find(convo => convo.id === ourPubKey); + + // Filter open groups + const openGroupsIds = convos + .filter(c => !!c.get('active_at') && c.isPublic() && !c.get('left')) + .map(c => c.id.substring((c.id as string).lastIndexOf('@') + 1)) as Array< + string + >; + + // Filter Closed/Medium groups + const closedGroupModels = convos.filter( + c => + !!c.get('active_at') && + c.isMediumGroup() && + c.get('members').includes(ourPubKey) && + !c.get('left') && + !c.get('isKickedFromGroup') && + !c.isBlocked() + ); + + const closedGroups = await Promise.all( + closedGroupModels.map(async c => { + const groupPubKey = c.get('id'); + const fetchEncryptionKeyPair = await getLatestClosedGroupEncryptionKeyPair( + groupPubKey + ); + if (!fetchEncryptionKeyPair) { + return null; + } + + return new ConfigurationMessageClosedGroup({ + publicKey: groupPubKey, + name: c.get('name'), + members: c.get('members') || [], + admins: c.get('groupAdmins') || [], + encryptionKeyPair: ECKeyPair.fromHexKeyPair(fetchEncryptionKeyPair), + }); + }) + ); + + const onlyValidClosedGroup = closedGroups.filter(m => m !== null) as Array< + ConfigurationMessageClosedGroup + >; + + // Filter contacts + const contactsModels = convos.filter( + c => + !!c.get('active_at') && + c.getLokiProfile()?.displayName && + c.isPrivate() && + !c.isBlocked() + ); + + const contacts = contactsModels.map(c => { + return new ConfigurationMessageContact({ + publicKey: c.id, + displayName: c.getLokiProfile()?.displayName, + profilePictureURL: c.get('avatarPointer'), + profileKey: c.get('profileKey'), + }); + }); + + if (!ourConvo) { + window.log.error( + 'Could not find our convo while building a configuration message.' + ); + } + const profileKeyFromStorage = window.storage.get('profileKey'); + const profileKey = profileKeyFromStorage + ? new Uint8Array(profileKeyFromStorage) + : undefined; + + const profilePicture = ourConvo?.get('avatarPointer') || undefined; + const displayName = ourConvo?.getLokiProfile()?.displayName || undefined; + + return new ConfigurationMessage({ + identifier: uuid(), + timestamp: Date.now(), + activeOpenGroups: openGroupsIds, + activeClosedGroups: onlyValidClosedGroup, + displayName, + profilePicture, + profileKey, + contacts, + }); +}; From 08c41004a2ef4f21e96ae7ca59d1edb3da5fe1f8 Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 25 Feb 2021 15:16:23 +1100 Subject: [PATCH 8/8] do not send expire timer to member added on closed group --- ts/session/group/index.ts | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/ts/session/group/index.ts b/ts/session/group/index.ts index d5cc8de88..9bfff075d 100644 --- a/ts/session/group/index.ts +++ b/ts/session/group/index.ts @@ -442,27 +442,27 @@ async function sendAddedMembers( }); // if an expire timer is set, we have to send it to the joining members - let expirationTimerMessage: ExpirationTimerUpdateMessage | undefined; - if (expireTimer && expireTimer > 0) { - const expireUpdate = { - timestamp: Date.now(), - expireTimer, - groupId: groupId, - }; - - expirationTimerMessage = new ExpirationTimerUpdateMessage(expireUpdate); - } + // let expirationTimerMessage: ExpirationTimerUpdateMessage | undefined; + // if (expireTimer && expireTimer > 0) { + // const expireUpdate = { + // timestamp: Date.now(), + // expireTimer, + // groupId: groupId, + // }; + + // expirationTimerMessage = new ExpirationTimerUpdateMessage(expireUpdate); + // } const promises = addedMembers.map(async m => { await ConversationController.getInstance().getOrCreateAndWait(m, 'private'); const memberPubKey = PubKey.cast(m); await getMessageQueue().sendToPubKey(memberPubKey, newClosedGroupUpdate); - if (expirationTimerMessage) { - await getMessageQueue().sendToPubKey( - memberPubKey, - expirationTimerMessage - ); - } + // if (expirationTimerMessage) { + // await getMessageQueue().sendToPubKey( + // memberPubKey, + // expirationTimerMessage + // ); + // } }); await Promise.all(promises); }