Open user profile and room with event from permalink #2776

bmarty · 2024-04-30T16:01:28Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Partially handle #2648 , since it will only work for Android 11 and before. Extra steps are required to make it work on Android 12 and higher. This is handled by https://github.com/element-hq/element.io-website/pull/275.

I have extracted some classes from the roomdetail module in order to be able to render a user profile screen (i.e. without having any room available). So extracting stuff to avoid copy pasting.

To be able to use host like *.element.io, I had to remove the declaration call.element.io from the Manifest about ElementCallActivity. All intent are now handled by the MainActivity, which will eventually start the ElementCallActivity.

Motivation and context

External permalink handling.

Screenshots / GIFs

Tests

matrix.to links

Open a matrix.to link from another app installed on the phone (Gmail, etc.) and observe that EXA is opening it and is routing the user to the expected screen.
Can also be tested using command line with:

adb shell am start -a android.intent.action.VIEW -d 'https://matrix.to/#/@benoitx:matrix.org'

NOTE Use and Android emulator with Android 11 or lower, else the link will be opened by the browser. When opened in the browser, the user can select Element and then get a link to open the permalink in the Element mobile application ("Continue" button below):

It should work on Android 12 and higher.

Edit Actually on mobile, matrix.to website is using a custom scheme (element), so I will add the support for it too:

I have added the support here: 181742b, and it's working when triggering with adb, but for some reason, nothing happen when I click on the matrix.to website on open it here:

element.io links

Test for instance with

adb shell am start -a android.intent.action.VIEW -c android.intent.category.BROWSABLE \
   -d "https://app.element.io/#/room/!cuqHozLHNBgupgLMKN:matrix.org/%24LZDOueY3R8OD2ZYf8FLKtu95aF7imLBC3F5TIUj-4cc"

Note: will work on Android 12 and higher only when the element.io website will be deployed.

Tested devices

Physical
Emulator (Android 10)
OS version(s):

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/element-hq/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/element-hq/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 · 2024-05-01T08:39:24Z

📱 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/3MAPh2

codecov · 2024-05-01T08:54:07Z

Codecov Report

Attention: Patch coverage is 64.70588% with 60 lines in your changes are missing coverage. Please review.

Project coverage is 73.41%. Comparing base (682fd45) to head (baf3877).

Files	Patch %	Lines
...atures/userprofile/shared/UserProfileNodeHelper.kt	0.00%	11 Missing ⚠️
...nt/android/features/call/ui/ElementCallActivity.kt	0.00%	9 Missing ⚠️
...s/userprofile/impl/DefaultUserProfileEntryPoint.kt	0.00%	8 Missing ⚠️
...s/userprofile/shared/blockuser/BlockUserSection.kt	33.33%	5 Missing and 3 partials ⚠️
...c/main/kotlin/io/element/android/x/MainActivity.kt	0.00%	6 Missing ⚠️
...impl/members/details/RoomMemberDetailsPresenter.kt	78.57%	1 Missing and 2 partials ⚠️
...ures/userprofile/impl/root/UserProfilePresenter.kt	92.85%	1 Missing and 2 partials ⚠️
...s/userprofile/shared/blockuser/BlockUserDialogs.kt	57.14%	0 Missing and 3 partials ⚠️
...io/element/android/appnav/intent/IntentResolver.kt	77.77%	0 Missing and 2 partials ⚠️
.../features/userprofile/impl/di/UserProfileModule.kt	0.00%	2 Missing ⚠️
... and 4 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2776      +/-   ##
===========================================
- Coverage    73.45%   73.41%   -0.05%     
===========================================
  Files         1517     1523       +6     
  Lines        36431    36528      +97     
  Branches      7013     7038      +25     
===========================================
+ Hits         26760    26816      +56     
- Misses        6006     6043      +37     
- Partials      3665     3669       +4

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

bmarty · 2024-05-02T17:02:49Z

...le/shared/src/main/kotlin/io/element/android/features/userprofile/shared/UserProfileState.kt

    val userName: String?,
    val avatarUrl: String?,
    val isBlocked: AsyncData<Boolean>,
    val startDmActionState: AsyncAction<RoomId>,
    val displayConfirmationDialog: ConfirmationDialog?,
    val isCurrentUser: Boolean,
-    val eventSink: (RoomMemberDetailsEvents) -> Unit
+    val eventSink: (UserProfileEvents) -> Unit


Room member detail and User profile now have the same actions and rendering, so the state is common, but at some point we may want to add extra data here, like a RoomId?, and extra action like Jump to Read Receipt, only if a room is there.

jmartinesp · 2024-05-03T08:34:08Z

I just tested it and the matrix.to, element.io and call.element. links are intercepted as expected on Android < 12.

call.element. and element.io links work on Android 12+.

However, on Android 12+ after the matrix.to website is loaded and I tap on the open action, it does nothing. Could it be because it's using the element: scheme and we only registered the elementx: one instead for EX?

jmartinesp

I have some comments, nothing major. I'll review the code again once the new changes arrive. Thanks!

jmartinesp · 2024-05-03T08:55:46Z

appnav/src/main/kotlin/io/element/android/appnav/RootFlowNode.kt

        }
    }

+    private suspend fun navigateTo(permalinkData: PermalinkData) {
+        Timber.d("Navigating to $permalinkData")
+        attachSession(null)


I know it's not new, but this duplicate attachSession is quite confusing until you look at the underlying returned types. Maybe we should think about renaming them in the future.

Yes, that's not clear, you're right (and it's due to the new intermediate LoggedInAppScopeFlowNode).
I have made it clearer in fb59776 hopefully.

Are those commits uploaded? GH doesn't seem to auto-detect them and I can't find them in the commit list view.

jmartinesp · 2024-05-03T08:59:07Z

appnav/src/test/kotlin/io/element/android/appnav/intent/IntentResolverTest.kt

Should we add some more tests for permalinks here?

Yes, good point, added in f48cc81.

jmartinesp · 2024-05-03T09:00:18Z

features/call/src/main/kotlin/io/element/android/features/call/ui/ElementCallActivity.kt

@@ -63,6 +66,26 @@ class ElementCallActivity : NodeComponentActivity(), CallScreenNavigator {
            }
            context.startActivity(intent)
        }
+
+        /**
+         * Eventually start the ElementCallActivity, and return true if it's the case.


This is a bit vague. Maybe 'Start the ElementCallActivity' if the intent contains a valid URL, return true` if it's the case'?

Yes, thanks fa4ad4a.

...kotlin/io/element/android/features/roomdetails/impl/members/details/RoomMemberDetailsNode.kt

ElementBot · 2024-05-03T09:59:01Z

	Warnings
⚠️	features/roomdetails/impl/src/main/res/values-cs/translations.xml#L64 - For locale "cs" (Czech) the following quantity should also be defined: `many` (e.g. "10.0 dne")
⚠️	features/roomdetails/impl/src/main/res/values-ro/translations.xml#L30 - For locale "ro" (Romanian) the following quantity should also be defined: `few` (e.g. "2 zile")
⚠️	features/roomdetails/impl/src/main/res/values-sk/translations.xml#L64 - For locale "sk" (Slovak) the following quantity should also be defined: `many` (e.g. "10.0 dňa")
⚠️	libraries/ui-strings/src/main/res/values-cs/translations.xml#L4 - For locale "cs" (Czech) the following quantity should also be defined: `many` (e.g. "10.0 dne")
⚠️	libraries/ui-strings/src/main/res/values-cs/translations.xml#L22 - For locale "cs" (Czech) the following quantity should also be defined: `many` (e.g. "10.0 dne")
⚠️	libraries/ui-strings/src/main/res/values-cs/translations.xml#L152 - For locale "cs" (Czech) the following quantity should also be defined: `many` (e.g. "10.0 dne")
⚠️	libraries/ui-strings/src/main/res/values-cs/translations.xml#L176 - For locale "cs" (Czech) the following quantity should also be defined: `many` (e.g. "10.0 dne")

Generated by 🚫 dangerJS against baf3877

bmarty · 2024-05-03T10:00:35Z

However, on Android 12+ after the matrix.to website is loaded and I tap on the open action, it does nothing. Could it be because it's using the element: scheme and we only registered the elementx: one instead for EX?

Fixed in 181742b, and it's working when triggering with adb, but for some reason, nothing happen when I click on the matrix.to website on open it here:

Actually hide the attachment of LoggedInAppScopeFlowNode.

jmartinesp · 2024-05-03T10:13:42Z

However, on Android 12+ after the matrix.to website is loaded and I tap on the open action, it does nothing. Could it be because it's using the element: scheme and we only registered the elementx: one instead for EX?

Fixed in 181742b, and it's working when triggering with adb, but for some reason, nothing happen when I click on the matrix.to website on open it here:

Same here. The intent-filter for the element scheme doesn't seem to be triggered.

jmartinesp · 2024-05-03T10:29:52Z

@bmarty I got it to work with:

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />

    <data android:scheme="element" />
    <data android:host="user" />
    <data android:host="room" />
</intent-filter>

bmarty · 2024-05-03T10:41:44Z

OK, everything is fine, I think I have handled all your remark @jmartinesp (and thanks for the fix about matrix.to website link).

Let me know if there is anything else!

jmartinesp

Thanks for all the changes! LGTM!

sonarcloud · 2024-05-03T10:49:47Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

bmarty force-pushed the feature/bma/externalLinks branch from f5374d5 to d460711 Compare April 30, 2024 16:09

bmarty added the Record-Screenshots Runs the 'Record Screenshots' CI job and adds a commit with any new screenshots found. label May 1, 2024

github-actions bot removed the Record-Screenshots Runs the 'Record Screenshots' CI job and adds a commit with any new screenshots found. label May 1, 2024

bmarty and others added 4 commits May 2, 2024 12:25

Open user profile and room with event from permalink

0476bd9

Update screenshots

b055452

Let MainActivity manage Element Call https links.

0fb89bd

Add documentation and small script to test external deep links.

181742b

bmarty force-pushed the feature/bma/externalLinks branch from b2112b3 to 181742b Compare May 2, 2024 16:50

bmarty marked this pull request as ready for review May 2, 2024 16:53

bmarty requested a review from a team as a code owner May 2, 2024 16:53

bmarty requested review from jmartinesp and removed request for a team May 2, 2024 16:53

bmarty commented May 2, 2024

View reviewed changes

Format

4dfec7a

jmartinesp reviewed May 3, 2024

View reviewed changes

Add support for link generated by matrix.to website.

1bcfa60

Small rework for code clarity.

fb59776

Actually hide the attachment of LoggedInAppScopeFlowNode.

bmarty added 3 commits May 3, 2024 12:16

Improve documentation

fa4ad4a

Sort imports.

0036fa7

changelog

50b77a3

bmarty added 2 commits May 3, 2024 12:37

Add tests on IntentResolver about external permalink.

f48cc81

Fix link from matrix.to websote not working.

baf3877

jmartinesp approved these changes May 3, 2024

View reviewed changes

bmarty added the Run-Maestro Starts a Maestro Cloud session to run integration tests label May 3, 2024

github-actions bot removed the Run-Maestro Starts a Maestro Cloud session to run integration tests label May 3, 2024

bmarty merged commit e9c262e into develop May 3, 2024
17 of 19 checks passed

bmarty deleted the feature/bma/externalLinks branch May 3, 2024 12:03

bmarty mentioned this pull request May 6, 2024

Feature/bma/external permalink fix #2798

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open user profile and room with event from permalink #2776

Open user profile and room with event from permalink #2776

bmarty commented Apr 30, 2024 •

edited

github-actions bot commented May 1, 2024 •

edited

codecov bot commented May 1, 2024 •

edited

bmarty May 2, 2024

jmartinesp commented May 3, 2024

jmartinesp left a comment

jmartinesp May 3, 2024

bmarty May 3, 2024 •

edited

jmartinesp May 3, 2024

jmartinesp May 3, 2024

bmarty May 3, 2024 •

edited

jmartinesp May 3, 2024

bmarty May 3, 2024 •

edited

ElementBot commented May 3, 2024 •

edited

bmarty commented May 3, 2024

jmartinesp commented May 3, 2024

jmartinesp commented May 3, 2024

bmarty commented May 3, 2024

jmartinesp left a comment

sonarcloud bot commented May 3, 2024

Open user profile and room with event from permalink #2776

Open user profile and room with event from permalink #2776

Conversation

bmarty commented Apr 30, 2024 • edited

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

matrix.to links

element.io links

Tested devices

Checklist

github-actions bot commented May 1, 2024 • edited

codecov bot commented May 1, 2024 • edited

Codecov Report

bmarty May 2, 2024

Choose a reason for hiding this comment

jmartinesp commented May 3, 2024

jmartinesp left a comment

Choose a reason for hiding this comment

jmartinesp May 3, 2024

Choose a reason for hiding this comment

bmarty May 3, 2024 • edited

Choose a reason for hiding this comment

jmartinesp May 3, 2024

Choose a reason for hiding this comment

jmartinesp May 3, 2024

Choose a reason for hiding this comment

bmarty May 3, 2024 • edited

Choose a reason for hiding this comment

jmartinesp May 3, 2024

Choose a reason for hiding this comment

bmarty May 3, 2024 • edited

Choose a reason for hiding this comment

ElementBot commented May 3, 2024 • edited

bmarty commented May 3, 2024

jmartinesp commented May 3, 2024

jmartinesp commented May 3, 2024

bmarty commented May 3, 2024

jmartinesp left a comment

Choose a reason for hiding this comment

sonarcloud bot commented May 3, 2024

Quality Gate passed

bmarty commented Apr 30, 2024 •

edited

github-actions bot commented May 1, 2024 •

edited

codecov bot commented May 1, 2024 •

edited

bmarty May 3, 2024 •

edited

bmarty May 3, 2024 •

edited

bmarty May 3, 2024 •

edited

ElementBot commented May 3, 2024 •

edited