View Folders and logs #2283

bmarty · 2024-01-24T15:03:15Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Introduce a viewfolder module, able to navigate to a folder hierarchy and to display the content of any file (ofc it works better with TXT files).
When viewing file, it possible to copy a line to the clipboard, or download or share the file.
Line numbers are displayed, as well as a basic syntactic coloration, using logcat colors.

Add a entry to the problem report screen so that user can inspect the logs that will be sent when reporting a problem.

viewfolder may be used later in the developer screen to be able to navigate to the files or cache directories.

Motivation and context

Closes #2276

Screenshots / GIFs

see recorded screenshot.

Tests

Go to the "Report a problem" screen
Click on "View logs" to open the new screen. The folder does not contain subfolder, so the navigation functionnality cannot be fully tested with the app right now. It's possible to change the rootPath to do so, but the app has to be built again.

Tested devices

Physical
Emulator
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-01-24T15:30:11Z

📱 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/MjaLZz

Add test Add test

bmarty · 2024-01-24T22:23:15Z

...S_t[f.viewfolder.impl.file_ViewFileView_null_ViewFileView-Day-0_1_null_1,NEXUS_5,1.0,en].png

Note: I have tested using a Monospace font, but the result is less nice to me.

I love the fact that we have line numbers, thanks!

Should we add a bit more padding to the left? Otherwise, I think we'll run into this quite often:

Yes, I have seen that too, but user has to scroll a lot to see it, so instead I preferred to add "Save" and "Share" actions to be able to read the file in better conditions (i.e. on a computer).
I will iterate to adapt the size depending on the total number of lines.

OK, actually, I think this is an acceptable issue to have, since the offset will appear only on a few cases:

I prefer to keep more width for the file content.

...folder/impl/src/main/kotlin/io/element/android/features/viewfolder/impl/file/ViewFileView.kt

...rageshake.impl.bugreport_BugReportView_null_BugReportView-Day-0_1_null_1,NEXUS_5,1.0,en].png

jmartinesp · 2024-01-25T08:40:12Z

...older/impl/src/main/kotlin/io/element/android/features/viewfolder/impl/file/ViewFileState.kt

+
+data class ViewFileState(
+    val name: String,
+    val lines: ImmutableList<String>,


Maybe this should be an AsyncData and the UI should have a loader? For large files, the viewer will display an 'empty file' text for 1-2s before actually displaying the file contents.

Yes, you're right, I've been a bit lazy here :). 4601e2a

jmartinesp · 2024-01-25T08:42:09Z

...folder/impl/src/main/kotlin/io/element/android/features/viewfolder/impl/file/ViewFileView.kt

+ * Ex: `01-23 13:14:50.740 25818 25818 D org.matrix.rust.sdk: elementx: SyncIndicator = Hide | RustRoomListService.kt:81`
+ */
+@Composable
+private fun String.toColor(): Color {


jmartinesp

LGTM, just a few minor nits I've already mentioned. Also, the tests need to be fixed.

…`AsyncData<List<String>>` to properly handle loading and error states.

codecov · 2024-01-25T10:04:21Z

Codecov Report

Attention: 144 lines in your changes are missing coverage. Please review.

Comparison is base (15e3ecc) 70.15% compared to head (4eb10a2) 70.03%.
Report is 5 commits behind head on develop.

Files	Patch %	Lines
.../android/features/viewfolder/impl/file/FileSave.kt	0.00%	34 Missing ⚠️
...roid/features/viewfolder/impl/file/ViewFileView.kt	69.14%	14 Missing and 15 partials ⚠️
...android/features/viewfolder/impl/file/FileShare.kt	0.00%	22 Missing ⚠️
.../features/viewfolder/impl/folder/FolderExplorer.kt	0.00%	20 Missing ⚠️
.../features/viewfolder/impl/folder/ViewFolderView.kt	68.85%	7 Missing and 12 partials ⚠️
...res/viewfolder/impl/DefaultViewFolderEntryPoint.kt	0.00%	8 Missing ⚠️
...features/viewfolder/impl/file/FileContentReader.kt	0.00%	5 Missing ⚠️
...features/viewfolder/impl/file/ViewFilePresenter.kt	85.71%	1 Missing and 2 partials ⚠️
...id/features/viewfolder/api/ViewFolderEntryPoint.kt	0.00%	2 Missing ⚠️
...ures/viewfolder/impl/folder/ViewFolderPresenter.kt	80.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2283      +/-   ##
===========================================
- Coverage    70.15%   70.03%   -0.13%     
===========================================
  Files         1335     1351      +16     
  Lines        32802    33137     +335     
  Branches      6809     6866      +57     
===========================================
+ Hits         23012    23207     +195     
- Misses        6511     6623     +112     
- Partials      3279     3307      +28

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

sonarcloud · 2024-01-25T10:18:51Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

bmarty force-pushed the feature/bma/logViewer branch 2 times, most recently from ab92e67 to 3ba6698 Compare January 24, 2024 17:36

View Folders and files

5fa396d

Add test Add test

bmarty force-pushed the feature/bma/logViewer branch from 137677b to 5fa396d Compare January 24, 2024 22:12

bmarty marked this pull request as ready for review January 24, 2024 22:19

bmarty requested a review from a team as a code owner January 24, 2024 22:19

bmarty requested review from jmartinesp and removed request for a team January 24, 2024 22:19

bmarty changed the title ~~View Folders - WIP~~ View Folders and logs Jan 24, 2024

Update screenshots

a26fbaf

bmarty commented Jan 24, 2024

View reviewed changes

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

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

jmartinesp reviewed Jan 25, 2024

View reviewed changes

...folder/impl/src/main/kotlin/io/element/android/features/viewfolder/impl/file/ViewFileView.kt Outdated Show resolved Hide resolved

bmarty added 2 commits January 25, 2024 09:32

Fix test compilation issue.

a6932c6

changelog.

a5eff37

jmartinesp reviewed Jan 25, 2024

View reviewed changes

...rageshake.impl.bugreport_BugReportView_null_BugReportView-Day-0_1_null_1,NEXUS_5,1.0,en].png Outdated Show resolved Hide resolved

jmartinesp reviewed Jan 25, 2024

View reviewed changes

jmartinesp approved these changes Jan 25, 2024

View reviewed changes

bmarty and others added 3 commits January 25, 2024 09:49

Add some Divider around the "View logs" item.

bed9fcf

Change type of ViewFileState.lines from ImmutableList<String> to …

4601e2a

…`AsyncData<List<String>>` to properly handle loading and error states.

Update screenshots

676b8ed

Fix Compose issues.

4eb10a2

bmarty merged commit 203262a into develop Jan 25, 2024
13 of 15 checks passed

bmarty deleted the feature/bma/logViewer branch January 25, 2024 13:41

bmarty mentioned this pull request Jan 26, 2024

Add a special tracing configuration for nightlies #2297

Merged

14 tasks

bmarty mentioned this pull request Jan 26, 2024

FileViewer: fix coloration issue for logs files. #2299

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

View Folders and logs #2283

View Folders and logs #2283

bmarty commented Jan 24, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

bmarty Jan 24, 2024

jmartinesp Jan 25, 2024

bmarty Jan 25, 2024

bmarty Jan 25, 2024

jmartinesp Jan 25, 2024

bmarty Jan 25, 2024

jmartinesp Jan 25, 2024

jmartinesp left a comment •

edited

Loading

codecov bot commented Jan 25, 2024 •

edited

Loading

sonarcloud bot commented Jan 25, 2024

View Folders and logs #2283

View Folders and logs #2283

Conversation

bmarty commented Jan 24, 2024 • edited Loading

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

Checklist

github-actions bot commented Jan 24, 2024 • edited Loading

bmarty Jan 24, 2024

Choose a reason for hiding this comment

jmartinesp Jan 25, 2024

Choose a reason for hiding this comment

bmarty Jan 25, 2024

Choose a reason for hiding this comment

bmarty Jan 25, 2024

Choose a reason for hiding this comment

jmartinesp Jan 25, 2024

Choose a reason for hiding this comment

bmarty Jan 25, 2024

Choose a reason for hiding this comment

jmartinesp Jan 25, 2024

Choose a reason for hiding this comment

jmartinesp left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 25, 2024 • edited Loading

Codecov Report

sonarcloud bot commented Jan 25, 2024

Quality Gate passed

bmarty commented Jan 24, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

jmartinesp left a comment •

edited

Loading

codecov bot commented Jan 25, 2024 •

edited

Loading