Replacing the fetch library with Android's DownloadManager. #3935

MohitMaliFtechiz · 2024-07-11T12:32:35Z

Moved the downloading functionality to Android's Download Manager.
Implemented the custom notification to show the download progress with pause/resume functionality since the default notification of DownloadManager does not have the pause/resume buttons.
Created the room database for managing the downloads state.
Removed the fetch library and all the code related to fetch to make it compatible with Android 14.

codecov · 2024-08-02T05:42:25Z

Codecov Report

Attention: Patch coverage is 71.23098% with 208 lines in your changes missing coverage. Please review.

Project coverage is 53.69%. Comparing base (eff8321) to head (d34dd37).

Files	Patch %	Lines
...wnloader/downloadManager/DownloadManagerMonitor.kt	78.43%	46 Missing and 12 partials ⚠️
...loader/downloadManager/DownloadManagerRequester.kt	32.75%	36 Missing and 3 partials ⚠️
...der/downloadManager/DownloadNotificationManager.kt	75.38%	23 Missing and 9 partials ⚠️
...wixmobile/core/downloader/downloadManager/Error.kt	50.00%	20 Missing ⚠️
...ixmobile/core/downloader/downloadManager/Status.kt	50.00%	12 Missing ⚠️
...er/DownloadNotificationActionsBroadcastReceiver.kt	33.33%	8 Missing ⚠️
.../org/kiwix/kiwixmobile/core/dao/DownloadRoomDao.kt	81.08%	0 Missing and 7 partials ⚠️
...e/nav/destination/library/OnlineLibraryFragment.kt	14.28%	6 Missing ⚠️
...imManager/libraryView/adapter/LibraryViewHolder.kt	66.66%	2 Missing and 3 partials ⚠️
...x/kiwixmobile/core/extensions/ContextExtensions.kt	44.44%	4 Missing and 1 partial ⚠️
... and 7 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3935      +/-   ##
============================================
+ Coverage     53.09%   53.69%   +0.59%     
- Complexity     1417     1482      +65     
============================================
  Files           304      309       +5     
  Lines         11908    12271     +363     
  Branches       1588     1617      +29     
============================================
+ Hits           6323     6589     +266     
- Misses         4554     4628      +74     
- Partials       1031     1054      +23

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

kelson42 · 2024-08-11T11:55:24Z

@MohitMaliFtechiz Whatbis the status here is this ready to merge/review? Don' forget to update the README.

MohitMaliFtechiz · 2024-08-12T09:19:30Z

@kelson42 Yes this PR is ready for review, I have updated the README file as well.

…ad completes or cancelled

… code to use the room database instead of objectbox database with fetch.

…ause/resume functionality

…the IN_PROGRESS showing in notification when downloading is in_progress state

… compatiable with Android 14. Also, Fixed the clicking is not working in notification

* Improved the updating status functionality. * Cancelling the notification if any running and download is completed. * Fixed TestModelFunctions build failure.

…er the zim file downloaded

…ecause two zim files can have the same title

* Removed unnecessary code.

* Improved variable naming and placed them in appropriate locations.

…no downloads are ongoing. * This change ensures that the observable is only active when necessary, reducing unnecessary resource usage and avoiding redundant requests to the DownloadManager.

* Fixed the Downloading for Authentication URL.

…ssfully downloading. * Improved the "DownloadTest".

…wnloads when the download is in a Queued state.

…aused state, as the pause state could occur if DownloadManager is waiting for WiFi. * Fixed the user behavior when attempting to download the ZIM file only on WiFi, and added a proper message explaining why the download is paused.

* For Android 11 and above, we now download ZIM files to the app-specific directory because the download manager does not allow downloads to custom paths. Therefore, ZIM files are now downloaded inside the app-specific directory for these versions. * Removed the folder selection dialog from the application for selecting the SD card in non-Play Store variants on Android 11 and Android 12. * For Android 10 and below, ZIM files are now downloading to the public directory on the SD card. This ensures that the files are not lost when the application is uninstalled, as they are stored in a public directory similar to internal storage on these versions. * Also improved the showing pause reason on download screen when downloadManager is paused due to "PAUSED_WAITING_TO_RETRY" error so that user can know about the downloading state.

…load failed. In such cases, the pause/resume functionality does not work, so we have disabled the button to prevent unexpected behavior.

* When there is no available connection that the user started the download with, the pause/resume button is disabled to prevent attempts to resume or pause the download, which would not work in this state. * If the user attempts to resume the download but it does not resume due to some issue, the code will automatically try to resume the download. This ensures a smooth user experience. * Proper pause reasons are displayed to the user, keeping them informed about the current state of the download. * If a download fails for any reason, the pause/resume button is disabled. At this point, the pause/resume functionality is unnecessary and would not work, so the button is disabled to avoid confusion. * To ensure clarity and understanding, we have added necessary comments on the method and conditions.

…ionality of the function

* Also, now we are not using fetch library anymore so we have removed this from our credits files. * Removed the unused code from detekt_baseline.xml file.

…nloadManager's storage configuration.

MohitMaliFtechiz self-assigned this Jul 11, 2024

MohitMaliFtechiz marked this pull request as draft July 11, 2024 12:32

MohitMaliFtechiz removed their assignment Jul 11, 2024

MohitMaliFtechiz mentioned this pull request Jul 12, 2024

User complains that ongoing downloads are lost during app update #3919

Closed

MohitMaliFtechiz force-pushed the Fixes#3141 branch 2 times, most recently from 38c7816 to 1318a42 Compare July 23, 2024 10:19

MohitMaliFtechiz force-pushed the Fixes#3141 branch 2 times, most recently from 16c4a62 to f833aed Compare July 29, 2024 10:16

MohitMaliFtechiz mentioned this pull request Jul 30, 2024

"Pause", not "pause" #3967

Closed

MohitMaliFtechiz force-pushed the Fixes#3141 branch from 98d209b to 9077670 Compare August 2, 2024 05:03

MohitMaliFtechiz force-pushed the Fixes#3141 branch 2 times, most recently from dad5762 to 4ac5ece Compare August 8, 2024 11:56

MohitMaliFtechiz marked this pull request as ready for review August 12, 2024 09:18

kelson42 self-requested a review August 12, 2024 11:34

MohitMaliDeveloper added 13 commits August 12, 2024 17:14

Replacing the fetch library with Android's DownloadManager.

5104c49

Updating the current download item on OnlineLibraryScreen if a downlo…

2616fa8

…ad completes or cancelled

Introduced Room database for managing the downloads. * Refactored the…

cebbbab

… code to use the room database instead of objectbox database with fetch.

Showing progress, eta time on download screen.

d672622

Implemented the pause/resume functionality for downloads.

7e79f28

Improved the eta time calculation.

d394bb6

Not showing the eta time when download is paused

ef2f505

Added custom notification for showing the downloading progress with p…

ce27525

…ause/resume functionality

Removed the default notification of download manager

d6a8ee9

Properly showing the notification for different downloads. Corrected …

30cf3c6

…the IN_PROGRESS showing in notification when downloading is in_progress state

Calcelling notification when user canceled the downloads

6eab724

Improved the cancelling of downloads

8405c7c

Added RECEIVER_NOT_EXPORTED to all broadcasts to make the application…

28472c0

… compatiable with Android 14. Also, Fixed the clicking is not working in notification

MohitMaliDeveloper and others added 25 commits August 12, 2024 17:14

Fixed some detekt and lint issues

9b09130

Fixed remaining detekt and lint issues

fa4f289

Improved the moving books functionality after download.

a859da3

* Improved the updating status functionality. * Cancelling the notification if any running and download is completed. * Fixed TestModelFunctions build failure.

Fixed: zim file was not opening when clicking on the notification aft…

6a16745

…er the zim file downloaded

Improved the file opening while clicking the download notification, b…

f640dd1

…ecause two zim files can have the same title

Implemented the retry download functionality.

9a2acea

* Removed unnecessary code.

Fixed: Notification "pause" text and notification icons.

d398c47

* Improved variable naming and placed them in appropriate locations.

Improved download monitoring efficiency by disposing observable when …

71db5fc

…no downloads are ongoing. * This change ensures that the observable is only active when necessary, reducing unnecessary resource usage and avoiding redundant requests to the DownloadManager.

Fixed downloading progress is not showing after starting the download.

4fb53ed

Fixed retry download is not working in some conditions

b2d2c5c

Fixing pause/resume functionlaity is not working on android 10 and above

5830381

Fixed the resume is not working properly.

cb8829e

Fixed unit coverage

775fab1

Removed the fetch library and its code from project.

88d828e

* Fixed the Downloading for Authentication URL.

Fixed sometimes downloads remain on the "Download Screen" after succe…

623d65e

…ssfully downloading. * Improved the "DownloadTest".

Enabled the controls in the notification for pausing/canceling the do…

68b091e

…wnloads when the download is in a Queued state.

Fixed the issue where the Pause/Resume button was enabled when a down…

a41899b

…load failed. In such cases, the pause/resume functionality does not work, so we have disabled the button to prevent unexpected behavior.

Fixing the pause/resume functionality

64c80ac

Removed the unnecessary variables and logs from code

6b60a8c

minor improvements on shouldEnablePauseResumeButton

1df1cab

refactor shouldEnablePauseResumeButtonForPauseReason to clarify funct…

a267ae8

…ionality of the function

Removed the fetch library from README file.

c9b4311

* Also, now we are not using fetch library anymore so we have removed this from our credits files. * Removed the unused code from detekt_baseline.xml file.

MohitMaliFtechiz force-pushed the Fixes#3141 branch from b51079d to c9b4311 Compare August 12, 2024 11:49

Improved the migration of storage for existing users according to Dow…

d34dd37

…nloadManager's storage configuration.

kelson42 merged commit 78e6349 into main Aug 12, 2024
10 checks passed

kelson42 deleted the Fixes#3141 branch August 12, 2024 16:08

MohitMaliFtechiz mentioned this pull request Aug 14, 2024

Download notification disappearing #3882

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replacing the fetch library with Android's DownloadManager. #3935

Replacing the fetch library with Android's DownloadManager. #3935

MohitMaliFtechiz commented Jul 11, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

kelson42 commented Aug 11, 2024 •

edited

Loading

MohitMaliFtechiz commented Aug 12, 2024

Replacing the fetch library with Android's DownloadManager. #3935

Replacing the fetch library with Android's DownloadManager. #3935

Conversation

MohitMaliFtechiz commented Jul 11, 2024 • edited Loading

codecov bot commented Aug 2, 2024 • edited Loading

Codecov Report

kelson42 commented Aug 11, 2024 • edited Loading

MohitMaliFtechiz commented Aug 12, 2024

MohitMaliFtechiz commented Jul 11, 2024 •

edited

Loading

codecov bot commented Aug 2, 2024 •

edited

Loading

kelson42 commented Aug 11, 2024 •

edited

Loading