[Rich text editor] Integrate rich text editor library #1172

jonnyandrew · 2023-08-29T13:02:40Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Replace the text input with the Matrix rich text editor.

Note that markdown formatting is no longer respected as the editor is now in WYSIWYG mode, in preparation for UI formatting buttons. Markdown characters such as *, ., - are now interpreted as literal text and not as markdown syntax.

Motivation and context

This editor supports WYSIWYG editing and lays the foundation for further text formatting functionality.

Screenshots / GIFs

N/A, no change.

Tests

Compose a message in the editor.
Note that markdown formatting is no longer respected.

Tested devices

Physical
Emulator
OS version(s): Android 13

Checklist

Changes have been tested on an Android device or Android emulator with API 23
UI change has been tested on both light and dark themes
Accessibility has been taken into account. See https://github.com/vector-im/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
Pull request is based on the develop branch
Pull request includes a new file under ./changelog.d. See https://github.com/vector-im/element-x-android/blob/develop/CONTRIBUTING.md#changelog
Pull request includes screenshots or videos if containing UI changes
Pull request includes a sign off
You've made a self review of your PR

github-actions · 2023-08-29T13:49:31Z

📱 Scan the QR code below to install the build (arm64 only) for this PR.

If you can't scan the QR code you can install the build via this link: https://i.diawi.com/6Yav4A

codecov · 2023-08-31T14:32:20Z

Codecov Report

Patch coverage: 74.56% and project coverage change: -0.04% ⚠️

Comparison is base (33dd0b2) 57.71% compared to head (74d28ee) 57.67%.
Report is 2 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1172      +/-   ##
===========================================
- Coverage    57.71%   57.67%   -0.04%     
===========================================
  Files         1078     1081       +3     
  Lines        28038    28028      -10     
  Branches      5777     5779       +2     
===========================================
- Hits         16181    16166      -15     
- Misses        9330     9339       +9     
+ Partials      2527     2523       -4

Files Changed	Coverage Δ
...impl/messagecomposer/RichTextEditorStateFactory.kt	`0.00% <0.00%> (ø)`
...meline/model/event/TimelineItemTextBasedContent.kt	`0.00% <0.00%> (ø)`
...nt/android/libraries/matrix/api/room/MatrixRoom.kt	`33.33% <ø> (ø)`
...droid/libraries/matrix/impl/room/RustMatrixRoom.kt	`0.00% <0.00%> (ø)`
...roid/libraries/textcomposer/MessageComposerMode.kt	`95.00% <ø> (ø)`
...ndroid/features/messages/impl/MessagesPresenter.kt	`81.81% <25.00%> (-1.01%)`	⬇️
...ssages/impl/messagecomposer/MessageComposerView.kt	`48.38% <60.00%> (-4.74%)`	⬇️
...pl/messagecomposer/MessageComposerStateProvider.kt	`90.00% <66.66%> (-5.24%)`	⬇️
...ent/android/libraries/textcomposer/TextComposer.kt	`84.05% <90.47%> (ø)`
...s/impl/messagecomposer/MessageComposerPresenter.kt	`90.32% <93.75%> (-0.07%)`	⬇️
... and 12 more

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tests/testutils/src/main/kotlin/io/element/android/tests/testutils/ReceiveTurbine.kt

...napshots/images/ui_S_t[l.textcomposer_null_TextComposerSimple-D-0_1_null,NEXUS_5,1.0,en].png

jonnyandrew · 2023-09-01T09:00:30Z

...kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerPresenter.kt

            isFullScreen = isFullScreen.value,
            hasFocus = hasFocus.value,
            mode = messageComposerContext.composerMode,
            showAttachmentSourcePicker = showAttachmentSourcePicker,
            canShareLocation = canShareLocation.value,
            canCreatePoll = canCreatePoll.value,
            attachmentsState = attachmentsState.value,
-            eventSink = ::handleEvents
+            eventSink = { handleEvents(it) }


Workaround for a Kotlin reflection error when toString() is called in test assertion failures... Related: #1206

libraries/textcomposer/impl/src/main/res/values/localazy.xml

jonnyandrew · 2023-09-01T14:07:28Z

I've marked as ready for review but note that I haven't gotten to the bottom of the test flakiness. However, I suspect the flakiness is unrelated to this change as it is mainly occurring in :features:createroom, features:leaveroom and :features:invitelist modules.

Edit: test flakiness addressed in #1226 and 7ae036e

Fixes issue where screenshot tests are terminated due to lack of CI resources. See actions/runner-images#7188 (comment)

jonnyandrew · 2023-09-06T13:24:13Z

@bmarty FYI this PR is ready for review - the CI test suite is now passing (after both #1226 and 7ae036e). The remaining failures are due to a reduction in total project test coverage (as this change is primarily UI) and an unrelated issue with Sonar.

bmarty

I have done some test and:

typing and sending message
editing a message
replying to a message

are all working as expected.

changelog.d/1172.feature

...in/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerModule.kt

libraries/textcomposer/impl/src/main/res/values-cs/translations.xml

...t/snapshots/images/ui_S_t[f.messages.impl_null_MessagesViewDark_0_null_0,NEXUS_5,1.0,en].png

...napshots/images/ui_S_t[l.textcomposer_null_TextComposerSimple-D-0_1_null,NEXUS_5,1.0,en].png

...composer/impl/src/main/kotlin/io/element/android/libraries/textcomposer/TextComposerState.kt

… jonny/integrate-rte

ElementBot · 2023-09-07T12:51:09Z

	Warnings
⚠️	gradle/libs.versions.toml#L13 - A newer version of androidx.core:core-ktx than 1.10.1 is available: 1.12.0
⚠️	gradle/libs.versions.toml#L18 - A newer version of androidx.lifecycle:lifecycle-runtime-ktx than 2.6.1 is available: 2.6.2
⚠️	gradle/libs.versions.toml#L96 - A newer version of androidx.compose.material3:material3 than 1.2.0-alpha06 is available: 1.2.0-alpha07

Generated by 🚫 dangerJS against 74d28ee

… jonny/integrate-rte

…android into jonny/integrate-rte

sonarqubecloud · 2023-09-07T13:56:36Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

bmarty

Thanks for the update!

jonnyandrew · 2023-09-07T15:20:46Z

Merging without maestro tests passing as it seems to be a separate issue related to the login flow tests

jonnyandrew · 2023-09-19T11:02:39Z

@RokeJulianLockhart since this PR we have reintroduced markdown support. You can now go to advanced settings and turn the rich text editor off to enable markdown.

Has been changed in #1172 but in general method references should always preferred to lambdas in composable functions (because they have higher stability guarantees).

Has been changed in #1172 but in general method references should always be preferred to lambdas in composable functions (because they have higher stability guarantees).

estux · 2024-12-10T11:58:35Z

@RokeJulianLockhart since this PR we have reintroduced markdown support. You can now go to advanced settings and turn the rich text editor off to enable markdown.

As of today I cannot see this option on Advanced Settings and all the text is just plain text (not rendering Markdown text from web client). Markdown is an added value compared to other messengers as it helps working better and distinguish messages in the timeline.

RokeJulianLockhart · 2024-12-10T17:38:04Z

#1172 (comment)

@estux, it works for me:

estux · 2024-12-10T22:36:11Z

#1172 (comment)

@estux, it works for me:

If you try with titles it doesn't @RokeJulianLockhart and also doesn't render well messages sent by Element Web (newlines and spaces sometimes not respected)

RokeJulianLockhart · 2024-12-10T23:06:26Z

#1172 (comment)

@estux, correct!

However, that is the purview of a separate issue – a lack of comprehensive Markdown support. I recommend that you file one, if no duplicate exists.

jonnyandrew mentioned this pull request Aug 29, 2023

[Story] RTE Rich text mode on EX element-hq/element-meta#1937

Closed

6 tasks

jonnyandrew force-pushed the jonny/integrate-rte branch 5 times, most recently from edc0018 to a597272 Compare August 31, 2023 13:24

jonnyandrew force-pushed the jonny/integrate-rte branch 3 times, most recently from 7bb14ef to 66ca091 Compare September 1, 2023 08:15

jonnyandrew commented Sep 1, 2023

View reviewed changes

libraries/textcomposer/impl/src/main/res/values/localazy.xml Outdated Show resolved Hide resolved

jonnyandrew marked this pull request as ready for review September 1, 2023 14:06

jonnyandrew requested a review from a team as a code owner September 1, 2023 14:06

jonnyandrew requested review from bmarty and removed request for a team September 1, 2023 14:06

jonnyandrew added 2 commits September 6, 2023 11:14

Integrate rich text editor

36741d3

Add changelog

e5f5332

jonnyandrew force-pushed the jonny/integrate-rte branch from c0c67be to e5f5332 Compare September 6, 2023 10:15

ElementBot and others added 2 commits September 6, 2023 10:33

Update screenshots

730d81a

Increase swapfile size in test CI

7ae036e

Fixes issue where screenshot tests are terminated due to lack of CI resources. See actions/runner-images#7188 (comment)

bmarty reviewed Sep 6, 2023

View reviewed changes

jonnyandrew mentioned this pull request Sep 7, 2023

[Android] Add fake mode for compose state for testing matrix-org/matrix-rich-text-editor#796

Merged

jonnyandrew added 4 commits September 7, 2023 13:16

Refactor to simplify and remove state abstraction

8aa6924

Improve changelog entry

abac1c8

Remove unnecessary dagger module

7d3f3f2

Fix localazy config

e0f2c51

jonnyandrew added 2 commits September 7, 2023 13:17

Fix previews

5d68788

Merge branch 'develop' of github.com:vector-im/element-x-android into…

7f1fa51

… jonny/integrate-rte

Update screenshots

4bc0737

jonnyandrew requested a review from bmarty September 7, 2023 13:31

jonnyandrew added 3 commits September 7, 2023 14:36

Merge branch 'develop' of github.com:vector-im/element-x-android into…

5c56fc4

… jonny/integrate-rte

Fix lint issues

5016c93

Merge branch 'jonny/integrate-rte' of github.com:vector-im/element-x-…

74d28ee

…android into jonny/integrate-rte

bmarty approved these changes Sep 7, 2023

View reviewed changes

jonnyandrew merged commit f214493 into develop Sep 7, 2023

jonnyandrew deleted the jonny/integrate-rte branch September 7, 2023 15:21

rom4nik mentioned this pull request Sep 8, 2023

Punctuation marks are prefixed with backslashes in message body #1260

Closed

jonnyandrew restored the jonny/integrate-rte branch September 8, 2023 11:58

jonnyandrew deleted the jonny/integrate-rte branch September 8, 2023 11:59

This comment was marked as resolved.

Sign in to view

julioromano mentioned this pull request Sep 25, 2023

Use eventSink method reference in TimelinePresenter.kt #1428

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rich text editor] Integrate rich text editor library #1172

[Rich text editor] Integrate rich text editor library #1172

jonnyandrew commented Aug 29, 2023 •

edited

Loading

github-actions bot commented Aug 29, 2023 •

edited

Loading

codecov bot commented Aug 31, 2023 •

edited

Loading

jonnyandrew Sep 1, 2023

jonnyandrew commented Sep 1, 2023 •

edited

Loading

jonnyandrew commented Sep 6, 2023

bmarty left a comment

ElementBot commented Sep 7, 2023 •

edited

Loading

sonarqubecloud bot commented Sep 7, 2023

bmarty left a comment

jonnyandrew commented Sep 7, 2023

This comment was marked as resolved.

jonnyandrew commented Sep 19, 2023

estux commented Dec 10, 2024 •

edited

Loading

RokeJulianLockhart commented Dec 10, 2024

estux commented Dec 10, 2024

RokeJulianLockhart commented Dec 10, 2024 •

edited

Loading

[Rich text editor] Integrate rich text editor library #1172

[Rich text editor] Integrate rich text editor library #1172

Conversation

jonnyandrew commented Aug 29, 2023 • edited Loading

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

Checklist

github-actions bot commented Aug 29, 2023 • edited Loading

codecov bot commented Aug 31, 2023 • edited Loading

Codecov Report

jonnyandrew Sep 1, 2023

Choose a reason for hiding this comment

jonnyandrew commented Sep 1, 2023 • edited Loading

jonnyandrew commented Sep 6, 2023

bmarty left a comment

Choose a reason for hiding this comment

ElementBot commented Sep 7, 2023 • edited Loading

sonarqubecloud bot commented Sep 7, 2023

bmarty left a comment

Choose a reason for hiding this comment

jonnyandrew commented Sep 7, 2023

This comment was marked as resolved.

jonnyandrew commented Sep 19, 2023

estux commented Dec 10, 2024 • edited Loading

RokeJulianLockhart commented Dec 10, 2024

estux commented Dec 10, 2024

RokeJulianLockhart commented Dec 10, 2024 • edited Loading

jonnyandrew commented Aug 29, 2023 •

edited

Loading

github-actions bot commented Aug 29, 2023 •

edited

Loading

codecov bot commented Aug 31, 2023 •

edited

Loading

jonnyandrew commented Sep 1, 2023 •

edited

Loading

ElementBot commented Sep 7, 2023 •

edited

Loading

estux commented Dec 10, 2024 •

edited

Loading

RokeJulianLockhart commented Dec 10, 2024 •

edited

Loading