feat: mls migration #15247

PatrykBuniX · 2023-05-26T12:59:09Z

Feature branch for MLS migration feature, for more details see subpages of https://wearezeta.atlassian.net/wiki/spaces/CORE/pages/746488003/Proteus+to+MLS+Migration

codecov · 2023-05-26T13:07:16Z

Codecov Report

Merging #15247 (e2b536b) into dev (f4daa27) will increase coverage by 0.03%.
Report is 19 commits behind head on dev.
The diff coverage is 44.39%.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev   #15247      +/-   ##
==========================================
+ Coverage   45.18%   45.21%   +0.03%     
==========================================
  Files         708      718      +10     
  Lines       23354    23537     +183     
  Branches     5330     5355      +25     
==========================================
+ Hits        10553    10643      +90     
- Misses      11451    11538      +87     
- Partials     1350     1356       +6

* feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types

* feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions

* feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * feat: periodically check migration config [FS-1893] (#15117) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions * feat: join unestablished mixed conversations * test: join unestablished mixed conversations * feat: periodically check migration config [FS-1893] (#15117) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: start migration of proteus conversations [FS-1888] (#15198) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions * chore: improve logs in add users method * chore: bump core

* feat: wipe mls group if user is removed / leave mls-capable conversation * feat: add users to mls group when conversation is mixed * feat: restart periodic key material timers on app reload * test: adding users to mls/mixed/proteus group * test: add users to mls group * runfix: joining mls capable conversations * test: remove / leave conversation * runfix: add users to mixed conversation * runfix: show unestablished mixed conversations * refactor: test * refactor: apply cr suggestion * refactor: add MLSCapableConversation type

…ommit

* feat: periodically check migration config [FS-1893] (#15117) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: start migration of proteus conversations [FS-1888] (#15198) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions * feat: automatically join mixed conversations [FS-1897] (#15248) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * feat: periodically check migration config [FS-1893] (#15117) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions * feat: join unestablished mixed conversations * test: join unestablished mixed conversations * feat: periodically check migration config [FS-1893] (#15117) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: start migration of proteus conversations [FS-1888] (#15198) * feat: base for initialisation and finalisation methods * feat: check if migration time has arrived after mls is supported * refactor: improve init migration api * refactor: rename func * refactor: move initialisation and finalisation to separate modules * runfix: start migration flow in background after app was initialised * feat: filter unestablished mls conversations out * feat: filter out only mls conversations that are unestablished * refactor: move mls migration logger to separate file * feat: update conversation locally * chore: remove migration init code (follow-up pr) * refactor: resolve core and api client in module * feat: read feature config from teamstate * chore: update core * runfix: check fresh migration config when timer elapses * chore: update comment * refactor: use reduce for grouping conversations by protocol * refactor: simplify removal key check * feat: update core with new migration config types * refactor: improve types * feat: initialise migration of proteus conversations * feat: create mls group after switching to mixed and add other clients * runfix: send messages with mls if conversation is actually mls (not if group id exists) * chore: bump core * refactor: don't replace conversation's reference * feat: insert system message after conversation protocol update * refactor: improve reaction to protocol update event * refactor: move protocol update logic to conversation repository * feat: save conversation state to db after updating protocol * feat: update conversation protocol-related fields after protocol was updated * refactor: move adding users of conversation to separate module * refactor: move establishing group for mixed conversation to separate module * chore: update comments * runfix: don't try to to add users to mls group if mixed conv is empty * test: adding all conversation members to mls group * test: try establishing mls group for mixed conversation * chore: remove comment * test: conversation repo updateConversationProtocol * test: initialise migration of proteus conversations * refactor: CR suggestions * chore: improve logs in add users method * chore: bump core * runfix: filter duplicated system messages (#15264) * feat: maintain mls group list during migration [WPB-1115] (#15318) * feat: wipe mls group if user is removed / leave mls-capable conversation * feat: add users to mls group when conversation is mixed * feat: restart periodic key material timers on app reload * test: adding users to mls/mixed/proteus group * test: add users to mls group * runfix: joining mls capable conversations * test: remove / leave conversation * runfix: add users to mixed conversation * runfix: show unestablished mixed conversations * refactor: test * refactor: apply cr suggestion * refactor: add MLSCapableConversation type * test: fix test * chore: bump core with draft-20 corecrypto * chore: bump core * feat: debug util to update migration feature team settings config * feat: add qa debug util for displaying epoch info * refactor: reuse existing functionality of joining mls conv with ext commit * runfix: welcome message not being sent in self conversation anymore * feat: add supportedProtocols field on user entity * chore: bump core to beta

src/script/components/MessagesList/Message/ProtocolUpdateMessage/ProtocolUpdateMessage.tsx

atomrc · 2023-11-27T08:47:38Z

src/script/components/MessagesList/Message/SystemMessage/SystemMessageBase.tsx

+          {message.caption && (
+            <span className="system-message-caption ellipsis" dangerouslySetInnerHTML={{__html: message.caption}} />
+          )}


out of scope: This is probably not for this PR, but in the future, we should try to move this caption for the entity to the react component layer and render it a pure React node (not innerHTML)

Noted, will think about that 👌

atomrc · 2023-11-27T08:49:35Z

src/script/conversation/ConversationRepository.ts

+  /**
+   * Get all the group conversations owned by self user's team from the local state.
+   */
+  public readonly getAllSelfTeamOwnedGroupConversations = (): Conversation[] => {


suggestion: the name seems a little long. How about a small simplification?

Suggested change

public readonly getAllSelfTeamOwnedGroupConversations = (): Conversation[] => {

public readonly getAllTeamGroupConversations = (): Conversation[] => {

src/script/conversation/ConversationRepository.ts

atomrc · 2023-11-27T08:54:36Z

src/script/conversation/ConversationRepository.ts

+      case ClientEvent.CONVERSATION.JOINED_AFTER_MLS_MIGRATION_FINALISATION:
+      case ClientEvent.CONVERSATION.MLS_MIGRATION_FINALISATION_ONGOING_CALL:


suggestion: I feel the FINALISATION here is kind of redundant. WDYT?

Suggested change

case ClientEvent.CONVERSATION.JOINED_AFTER_MLS_MIGRATION_FINALISATION:

case ClientEvent.CONVERSATION.MLS_MIGRATION_FINALISATION_ONGOING_CALL:

case ClientEvent.CONVERSATION.JOINED_AFTER_MLS_MIGRATION:

case ClientEvent.CONVERSATION.MLS_MIGRATION_ONGOING_CALL:

Makes sense 👍

atomrc · 2023-11-27T08:56:15Z

src/script/conversation/MessageRepository.ts

+    const sendOptions: Parameters<typeof conversationService.send>[0] = isMLSConversation(conversation)
      ? {
-          groupId,
+          groupId: conversation.groupId,


atomrc · 2023-11-27T08:59:57Z

src/script/storage/StorageSchemata.ts

+            .table(StorageSchemata.OBJECT_STORE.CONVERSATIONS)
+            .toCollection()
+            .modify((conversation: ConversationRecord) => {
+              conversation.initial_protocol = conversation.protocol;


good catch 👌

atomrc

LGTM.

Quick word of advice: in general we should name files/directory as nouns, not actions.
Instead of finaliseMigration it should be migrationFinalizer.

PatrykBuniX added the blocked: do-not-merge label May 26, 2023

PatrykBuniX force-pushed the feat/mls-migration branch from 2eff161 to a8a237e Compare May 26, 2023 13:00

otto-the-bot added type: feature / request ✨ 👕 size: XXL labels May 26, 2023

PatrykBuniX force-pushed the feat/mls-migration branch 5 times, most recently from ccb3f91 to bef3ad3 Compare June 6, 2023 07:02

PatrykBuniX force-pushed the feat/mls-migration branch 2 times, most recently from a5d7d1e to 76fd401 Compare June 9, 2023 14:48

PatrykBuniX force-pushed the feat/mls-migration branch 4 times, most recently from c232748 to b94f079 Compare June 19, 2023 09:18

PatrykBuniX force-pushed the feat/mls-migration branch 2 times, most recently from b7fed06 to 75dfe1b Compare June 27, 2023 06:00

PatrykBuniX added 12 commits June 28, 2023 09:57

runfix: filter duplicated system messages (#15264)

5be19cd

test: fix test

769e619

feat: debug util to update migration feature team settings config

d07713a

refactor: reuse existing functionality of joining mls conv with ext c…

5c91683

…ommit

runfix: welcome message not being sent in self conversation anymore

fe25f99

chore: bump core

0540e41

runfix: wipe mls capable conversation

4fd7658

PatrykBuniX added 7 commits November 10, 2023 16:16

Merge branch 'dev' into feat/mls-migration

6228ff5

Merge branch 'dev' into feat/mls-migration

7699018

Merge branch 'dev' into feat/mls-migration

e0ee879

Merge branch 'dev' into feat/mls-migration

e8278a7

feat: inject system message ongoing call on migration finalisation

b7917f7

test: inject migration finalisation when call is ongoing

2ae102c

runfix: insert system message only for active call

b7d8014

otto-the-bot added the comp: calling label Nov 15, 2023

PatrykBuniX added 6 commits November 17, 2023 11:10

Merge branch 'dev' into feat/mls-migration

fba7fd4

runfix: initial protocol optional

c198f20

Merge branch 'dev' into feat/mls-migration

0b6ddb7

Merge branch 'dev' into feat/mls-migration

e53fcfb

runfix: remove mls migration feature flag

2b2dfe5

refactor: join after finalisation deps

0208ef5

PatrykBuniX removed the blocked: do-not-merge label Nov 22, 2023

PatrykBuniX marked this pull request as ready for review November 22, 2023 12:12

PatrykBuniX requested review from otto-the-bot and a team as code owners November 22, 2023 12:12

atomrc suggested changes Nov 27, 2023

View reviewed changes

atomrc reviewed Nov 27, 2023

View reviewed changes

src/script/conversation/ConversationRepository.ts Outdated Show resolved Hide resolved

przemvs reviewed Nov 27, 2023

View reviewed changes

src/script/conversation/ConversationRepository.ts Outdated Show resolved Hide resolved

atomrc reviewed Nov 27, 2023

View reviewed changes

refactor: improve naming - cr suggestions

c5ddabc

atomrc approved these changes Nov 27, 2023

View reviewed changes

refactor: rename files

e2b536b

PatrykBuniX merged commit b0c4cee into dev Nov 27, 2023
13 checks passed

PatrykBuniX deleted the feat/mls-migration branch November 27, 2023 11:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: mls migration #15247

feat: mls migration #15247

PatrykBuniX commented May 26, 2023 •

edited

Loading

codecov bot commented May 26, 2023 •

edited

Loading

atomrc Nov 27, 2023

PatrykBuniX Nov 27, 2023

atomrc Nov 27, 2023

atomrc Nov 27, 2023

PatrykBuniX Nov 27, 2023

atomrc Nov 27, 2023

atomrc Nov 27, 2023

atomrc left a comment

	public readonly getAllSelfTeamOwnedGroupConversations = (): Conversation[] => {
	public readonly getAllTeamGroupConversations = (): Conversation[] => {

		case ClientEvent.CONVERSATION.JOINED_AFTER_MLS_MIGRATION_FINALISATION:
		case ClientEvent.CONVERSATION.MLS_MIGRATION_FINALISATION_ONGOING_CALL:

feat: mls migration #15247

feat: mls migration #15247

Conversation

PatrykBuniX commented May 26, 2023 • edited Loading

codecov bot commented May 26, 2023 • edited Loading

Codecov Report

atomrc Nov 27, 2023

Choose a reason for hiding this comment

PatrykBuniX Nov 27, 2023

Choose a reason for hiding this comment

atomrc Nov 27, 2023

Choose a reason for hiding this comment

atomrc Nov 27, 2023

Choose a reason for hiding this comment

PatrykBuniX Nov 27, 2023

Choose a reason for hiding this comment

atomrc Nov 27, 2023

Choose a reason for hiding this comment

atomrc Nov 27, 2023

Choose a reason for hiding this comment

atomrc left a comment

Choose a reason for hiding this comment

PatrykBuniX commented May 26, 2023 •

edited

Loading

codecov bot commented May 26, 2023 •

edited

Loading