feat: receive and store composite messages [part-1] #1888

MohamadJaara · 2023-07-16T10:13:43Z

PR Submission Checklist for internal contributors

The PR Title
- conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
- contains a reference JIRA issue number like SQPIT-764
- answers the question: If merged, this PR will: ... ³
The PR Description
- is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

kalium does not handle composite messages

Solutions

map composite messages from/to proto and store the content

composite messages have a list of items where each item can be either a Text message content (with mentions, quote, ...ect ) or a Button

I did take the assumption that there is at most one text content, since we do not support having multiple content from the same type for one messages.

i did also move the messages views to separate file since Messages.sq is getting too big for its own good

Needs releases with:

GitHub link to other pull request

Testing

Test Coverage (Optional)

I have added automated test to this contribution

How to Test

Briefly describe how this change was tested and if applicable the exact steps taken to verify that it works as expected.

Notes (Optional)

Specify here any other facts that you think are important for this issue.

Attachments (Optional)

Attachments like images, videos, etc. (drag and drop in the text box)

PR Post Submission Checklist for internal contributors (Optional)

Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References

https://sparkbox.com/foundry/semantic_commit_messages
https://github.com/wireapp/.github#usage
E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

…s/map_from_to_proto

MohamadJaara · 2023-07-16T10:17:51Z

...kotlin/com/wire/kalium/logic/sync/receiver/conversation/message/ApplicationMessageHandler.kt

+            is MessageContent.ButtonAction -> TODO()
+            is MessageContent.ButtonActionConfirmation -> TODO()


ButtonAction and ButtonActionConfirmation will be handled in a separate PR

github-actions · 2023-07-16T11:08:06Z

Unit Test Results

  331 files -   72   331 suites - 72 18s ⏱️ - 1m 19s
1 858 tests - 323 1 789 ✔️ - 294 69 💤 - 29 0 ❌ ±0

Results for commit afc616f. ± Comparison against base commit abc276b.

♻️ This comment has been updated with latest results.

MohamadJaara · 2023-07-17T07:55:44Z

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt

+    sealed interface WithUser : MessagePreviewContent {
+        val username: String?
+        data class Text(override val username: String?, val messageBody: String?) : WithUser


the idea here is composite messages preview are handled as text messages

MohamadJaara · 2023-07-17T08:07:13Z

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt

-            val senderName: String?,
+            override val username: String?,
            val isSelfUserAdded: Boolean,
            val otherUserIdList: List<UserId> // TODO add usernames
-        ) : WithUser(senderName)
+        ) : WithUser

        data class MembersRemoved(
-            val senderName: String?,
+            override val username: String?,
            val isSelfUserRemoved: Boolean,
            val otherUserIdList: List<UserId> // TODO add usernames
-        ) : WithUser(senderName)
+        ) : WithUser

        data class MembersFailedToAdd(
-            val senderName: String?,
+            override val username: String?,
            val isSelfUserRemoved: Boolean,
            val otherUserIdList: List<UserId> // TODO add usernames
-        ) : WithUser(senderName)
+        ) : WithUser

        data class MembersCreationAdded(


those had duplicated fields, senderName and userName

vitorhugods

Looks good to me, I believe just some small changes needed.

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt

persistence/src/commonMain/db_user/com/wire/kalium/persistence/content/ButtonContent.sq

persistence/src/commonMain/db_user/com/wire/kalium/persistence/Messagepreview.sq

...ence/src/commonMain/kotlin/com/wire/kalium/persistence/dao/message/MessageInsertExtension.kt

…/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]>

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageMapper.kt

logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/ProtoContentMapper.kt

...ence/src/commonMain/kotlin/com/wire/kalium/persistence/dao/message/MessageInsertExtension.kt

trOnk12 · 2023-07-19T13:41:05Z

persistence/src/commonMain/kotlin/com/wire/kalium/persistence/dao/message/MessageMapper.kt

@@ -487,6 +490,37 @@ object MessageMapper {
                restrictedAssetName.requireField("assetName")
            )

+            MessageEntity.ContentType.COMPOSITE -> {
+                // if the text body is null then the composite message had no text body


maybe a local variable stating the above instead of a comment would be better here ?

there is already a local val
val compositeText: MessageEntityContent.Text? = text?.let {

the comment just so no body add a .requireField to the text content since it is fine if it is missing

isn't that kind of obvious from not adding .requireField ? is this comment really necessary ? anyways a minor thing, do as you wish to not block it :P

trOnk12

Great job ! Nothing major from my side, but I would like to have my comments resolved before u make the final call, but I already give the approval 🍖

…s/map_from_to_proto # Conflicts: # persistence/src/commonMain/db_user/migrations/49.sqm

* feat: receive and store composite messages [part-1] (#1888) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * merge issues * address PR comments * address PR comments * detekt --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> * feat: use case to send Message Button Action [part-2] (#1896) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * sent the message only to the message original sender * detekt * Update logic/src/commonTest/kotlin/com/wire/kalium/logic/data/message/MessageMetaDataRepositoryTest.kt Co-authored-by: Alexandre Ferris <[email protected]> * PR comments --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]> * feat: handle composite action confermation message [part-3] (#1901) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * handle ButtonActionConfirmation event * add unit test * detekt * detekt * sent the message only to the message original sender * detekt --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> * feat: composite message preview [part-4] (#1908) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * handle ButtonActionConfirmation event * add unit test * detekt * detekt * sent the message only to the message original sender * detekt * feat: map composite messages preview * Update persistence/src/commonMain/kotlin/com/wire/kalium/persistence/dao/message/MessageMapper.kt Co-authored-by: Alexandre Ferris <[email protected]> --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]> * fix: composite messages are not included in the getLastMessages query [part-5] (#1909) * include composite messages to message preview * detekt * feat: display composite message preview * add test * feat: composit messages backup [part-6] (#1914) * fea: include message buttons into the backup * import buttons * merge issues * unit test * merge issues * ignore Confirmation messages that are not fom the original message sender * test * cleanup * detekt * typo * typo * PR comments * trigger CI * empty --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]> Co-authored-by: Tommaso Piazza <[email protected]>

* feat: receive and store composite messages [part-1] (#1888) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * merge issues * address PR comments * address PR comments * detekt --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> * feat: use case to send Message Button Action [part-2] (#1896) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * sent the message only to the message original sender * detekt * Update logic/src/commonTest/kotlin/com/wire/kalium/logic/data/message/MessageMetaDataRepositoryTest.kt Co-authored-by: Alexandre Ferris <[email protected]> * PR comments --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]> * feat: handle composite action confermation message [part-3] (#1901) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * handle ButtonActionConfirmation event * add unit test * detekt * detekt * sent the message only to the message original sender * detekt --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> * feat: composite message preview [part-4] (#1908) * receive composite messages * map composite to proto * detekt * detekt * db migration * db migration * sqm * map to composite entity * detekt * remove is pending state from the DB * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]> * address PR comments * detekt * remove composite message preview mapping * fix migration * feat: use case to execute composite message action * expose use case to message scope * missing param * rename use case * docs * map to proto * merge issues * address PR comments * address PR comments * detekt * handle ButtonActionConfirmation event * add unit test * detekt * detekt * sent the message only to the message original sender * detekt * feat: map composite messages preview * Update persistence/src/commonMain/kotlin/com/wire/kalium/persistence/dao/message/MessageMapper.kt Co-authored-by: Alexandre Ferris <[email protected]> --------- Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]> * fix: composite messages are not included in the getLastMessages query [part-5] (#1909) * include composite messages to message preview * detekt * feat: display composite message preview * add test * feat: composit messages backup [part-6] (#1914) * fea: include message buttons into the backup * import buttons * merge issues * unit test * merge issues * ignore Confirmation messages that are not fom the original message sender * test * cleanup * detekt * typo * typo * PR comments * feat: Get and save clients mlsPublicKeys * feat: Get and save clients mlsPublicKeys: code stly * feat: Get and save clients mlsPublicKeys: tests fix * feat: Get and save clients mlsPublicKeys: removed logs --------- Co-authored-by: Mohamad Jaara <[email protected]> Co-authored-by: Vitor Hugo Schwaab <[email protected]> Co-authored-by: Alexandre Ferris <[email protected]>

receive composite messages

326bb08

MohamadJaara added the WIP work in progress label Jul 16, 2023

github-actions bot assigned MohamadJaara Jul 16, 2023

github-actions bot added 🚨 Potential breaking changes type: feature ✨ 👕 size: XXL labels Jul 16, 2023

Merge branch 'feat/composit_messages/epic' into feat/composit_message…

6bd12d1

…s/map_from_to_proto

github-actions bot added the Fix PR Title 🤦‍♂️ label Jul 16, 2023

MohamadJaara commented Jul 16, 2023

View reviewed changes

map composite to proto

4023b3e

github-actions bot removed the Fix PR Title 🤦‍♂️ label Jul 16, 2023

MohamadJaara added 2 commits July 16, 2023 12:43

detekt

b46fc01

detekt

125315c

db migration

0bd4540

MohamadJaara commented Jul 17, 2023

View reviewed changes

MohamadJaara removed the WIP work in progress label Jul 17, 2023

MohamadJaara requested review from vitorhugods, a team, gongracr, yamilmedina, Garzas and saleniuk and removed request for a team July 17, 2023 08:02

db migration

a835427

MohamadJaara commented Jul 17, 2023

View reviewed changes

MohamadJaara added 3 commits July 17, 2023 10:35

sqm

3554d74

map to composite entity

cd2e36a

detekt

b6bc952

MohamadJaara changed the title ~~feat: recive and store composite messages~~ feat: receive and store composite messages Jul 17, 2023

vitorhugods requested changes Jul 18, 2023

View reviewed changes

MohamadJaara and others added 7 commits July 18, 2023 13:49

remove is pending state from the DB

e6ebf82

Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message…

6970d27

…/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]>

Update logic/src/commonMain/kotlin/com/wire/kalium/logic/data/message…

da4a856

…/MessageContent.kt Co-authored-by: Vitor Hugo Schwaab <[email protected]>

address PR comments

e3527ae

detekt

f477546

remove composite message preview mapping

772dadc

fix migration

0b53dca

MohamadJaara requested review from saleniuk and vitorhugods July 18, 2023 14:07

MohamadJaara changed the title ~~feat: receive and store composite messages~~ feat: receive and store composite messages [part-1] Jul 19, 2023