Show more informative error message when VFS hydration fails. Displaya popup and put an error into activity list. More detailed logs.

[allexzander]

For #6132

[github-actions]

⚠️ clang-tidy found issue(s) with the introduced code (1/1)

[codecov]

Codecov Report

Merging #6140 (727cd79) into master (8b0d6dc) will increase coverage by 0.19%.
Report is 2 commits behind head on master.
The diff coverage is 88.88%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6140      +/-   ##
==========================================
+ Coverage   60.55%   60.74%   +0.19%     
==========================================
  Files         145      145              
  Lines       18814    18829      +15     
==========================================
+ Hits        11393    11438      +45     
+ Misses       7421     7391      -30     

Files	Coverage Δ
src/common/vfs.h	52.38% <ø> (ø)
src/libsync/vfs/cfapi/hydrationjob.h	0.00% <ø> (ø)
src/libsync/vfs/cfapi/vfs_cfapi.cpp	84.52% <100.00%> (+0.11%)	⬆️
src/libsync/vfs/cfapi/hydrationjob.cpp	53.65% <87.50%> (+2.09%)	⬆️

... and 8 files with indirect coverage changes

[allexzander]

@jancborchardt @nimishavijay
We need a way to provide error details when VFS files download files due to server error but it is not visible to the user what caused it.
I came up with an idea to show a popup and add an activity to the list.
Any ideas on how to improve it? Or is it OK this way already?

[nimishavijay]

If I see this error are there any steps I can take to fix it? (change some settings, check network connection, etc). We can simplify the error message to something like

Error downloading [filename]
[Filename] could not be downloaded. Please [action] and try again.

                              [Cancel button] [Try again button]

[allexzander]

If I see this error are there any steps I can take to fix it? (change some settings, check network connection, etc). We can simplify the error message to something like

Error downloading [filename]
[Filename] could not be downloaded. Please [action] and try again.

                              [Cancel button] [Try again button]

@nimishavijay No, the whole reason for this popup is for user to make a screenshot and let developers know about the exact issue. The problem is, when user has an issue with VFS like the one on the screenshot, it is a server side problem but it is being treated by a desktop client but from user’s perspective. Then user creates a bug report and quite often forgets to attach logs. Then in 24 hours logs are rotated and we can no longer tell what happened, which error came from server. Then it is impossible to investigate in case of random errors on the server. And we are receiving such a ticket but with just a screenshot and no logs or something. With this pop up we will see on a screenshot if this was a server issue (only then popup will show up) and then ask server engineers to investigate. Otherwise we already have a system popup from Windows VFS but it does not provide any details to what happened and if it was a server issue or not.

[nimishavijay]

Ah okay understood, in that case we could show it under a "More details" section. Showing a technical error up front would be confusing to non-technical users, who are the majority. We could do something like this:

Error downloading [filename]
[Filename] could not be downloaded.
> More details

[Cancel button] [Try again button]

On clicking "More details" the detailed info with the error code will be shown

In the tray menu also could we show a [More info] button which then exposes the error codes? So something like Error downloading file [More details] and clicking on "More details" would show the error message below. What do you think? :)

[allexzander]

Ah okay understood, in that case we could show it under a "More details" section. Showing a technical error up front would be confusing to non-technical users, who are the majority. We could do something like this:

Error downloading [filename]
[Filename] could not be downloaded.
> More details

[Cancel button] [Try again button]

On clicking "More details" the detailed info with the error code will be shown

In the tray menu also could we show a [More info] button which then exposes the error codes? So something like Error downloading file [More details] and clicking on "More details" would show the error message below. What do you think? :)
@nimishavijay Retry and Cancel buttons are impossible to add in this dialog, as this is not something we can control. The Retry and Cancel is possible via OS in another dialog that gets displayed by Windows but with no control of what is displayed in it.

I've now changed the custom dialog to show the "> More details" button, kindly check if it is enough.

As for activity item with button, I've removed this from activity list completely, as adding a button requires quite some changes in activity list system and it is not required for this PR.

[nimishavijay]

Nice! Looks good :)

[nextcloud-desktop-bot]

AppImage file: nextcloud-PR-6140-727cd797ffed0309669cd4f3a7e5fd17bcab3be7-x86_64.AppImage

To test this change/fix you can simply download above AppImage file and test it.

Please make sure to quit your existing Nextcloud app and backup your data.

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
8 Code Smells

3.8% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[allexzander]

/backport to stable-3.10