Saving and Restoring the Web View Navigation History Across Sessions #3996

Saifuddin53 · 2024-09-13T17:23:32Z

Fixes #398

Still in development

Enhanced history restoration by managing back and forward stacks separately and loading URLs accordingly.
The integrated room database is used to fetch and restore page history asynchronously using RxJava.
Implemented a mechanism to clear and retrieve history based on database entries.

How It Works:

When the reader fragment is paused the history is stored in the room
Upon resuming the WebView/ReaderFragment, the history is fetched from the Room database and restored.
Backward and forward navigation is re-established based on the saved history.

Screenshots

Saifuddin53 · 2024-09-19T06:22:49Z

Hello @MohitMaliFtechiz @kelson42
I've implemented a history restoration approach for WebView that loads pages sequentially from the back and forward stacks (stored in our room database) when the reader fragment is resumed. This solution is functional, but I would appreciate your feedback on the implementation and suggestions for improvement.

WhatsApp.Video.2024-09-19.at.11.05.05_9d0b7924.mp4

But it has some cons.

Currently, the time taken to restore history is directly proportional to the size of the back and forward stacks. Each URL load has a delay of 500ms, which means for a history with many items, the total restoration time could be several seconds. This could negatively impact user experience, particularly if the restoration feels too slow.
Ideally, the Reader screen should be blocked with a loading indicator until the history is fully restored to avoid interruptions.
The restoration only loads the page URLs but does not retain the user’s scroll position. When the Reader is reopened, users are taken to the top of each page, losing the context of where they left off, which can be frustrating for longer content.

On the bright side, the current approach makes sure everything is restored in order, so the navigation history stays consistent.

Also, I’ve experimented with a few other approaches to reduce the restoration time, but none of them offered the same level of accuracy. It seems like there’s a trade-off between speed and ensuring the history is restored correctly.

I’d appreciate your input on how we might address these challenges and any suggestions you have for further refinement of this approach

MohitMaliFtechiz · 2024-09-19T07:25:03Z

@Saifuddin53 Thanks for your PR, and inputs. I will test and review your PR. I have fixed the detekt issue you were facing, Now, you can continue doing your work. The codeFactor is failing can you please fix it?

kelson42 · 2024-09-19T09:45:24Z

@MohitMaliDeveloper Any news?

MohitMaliFtechiz

@Saifuddin53 For the restoration timing issue, I am seeing the possible solution. In the meantime can you please make these review changes?

.idea/codeStyles/Project.xml

core/src/main/java/org/kiwix/kiwixmobile/core/dao/PageHistoryRoomDao.kt

core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/PageHistoryRoomEntity.kt

core/src/main/java/org/kiwix/kiwixmobile/core/data/DataSource.kt

core/src/main/res/values-b+be+tarask/strings.xml

core/src/main/res/values-b+be+tarask+old/strings.xml

core/src/main/java/org/kiwix/kiwixmobile/core/main/MainRepositoryActions.kt

core/src/main/java/org/kiwix/kiwixmobile/core/page/history/adapter/PageHistoryItem.kt

kelson42 · 2024-10-01T11:40:34Z

@Saifuddin53 Any news here?

Saifuddin53 · 2024-10-03T02:30:34Z

@kelson42 trying to optimize this algo.

MohitMaliFtechiz

@Saifuddin53 Please do these changes it will reduce the restoring time, and increase the overall performance and code quality.

core/src/main/java/org/kiwix/kiwixmobile/core/di/components/CoreComponent.kt

core/src/main/java/org/kiwix/kiwixmobile/core/di/modules/DatabaseModule.kt

core/src/main/java/org/kiwix/kiwixmobile/core/data/KiwixRoomDatabase.kt

core/src/main/java/org/kiwix/kiwixmobile/core/main/MainRepositoryActions.kt

core/src/main/java/org/kiwix/kiwixmobile/core/page/history/adapter/WebViewHistoryItem.kt

core/src/main/java/org/kiwix/kiwixmobile/core/main/CoreReaderFragment.kt

MohitMaliDeveloper · 2024-10-15T12:01:40Z

@Saifuddin53 What is the status on this PR? Do you need any help from me in completing the PR?

Saifuddin53 · 2024-10-16T16:37:52Z

@MohitMaliDeveloper, can you please help me with the restoration algorithm? As, when I try to load the pages using the onPageFinished callback, the pages load too quickly, or the asynchronous behavior of the WebView is not properly handled,so it sometimes skips some entries.

MohitMaliFtechiz · 2024-10-17T04:57:51Z

@Saifuddin53 I will have a look at this after completing #4040.

MohitMaliFtechiz · 2024-10-22T09:36:15Z

@Saifuddin53 The page history is restored when we open a page from a bookmark, history, etc. However, it should not restore the webView page history under these conditions(it should only restore the webView history when the application is restarted or we switch between pages). See the below video:

IssueWhileRestoringWebViewHistory.mp4

As in this condition, it should only open the page on which the user just clicked on the bookmark, history, etc.

* Improved restoration of web view history after opening a searched article. * Refactored `restoreViewStateOnValidJSON` and `restoreViewStateOnInvalidJSON` methods to save and retrieve web view history from the Room database. * Added detailed comments to methods for better understanding, including guidance for developers to check subclass implementations before making modifications. * Fixed the `static analysis` errors.

* Created a common approach for both Kiwix and custom apps to open the searched item after restoring the tabs, ensuring smooth functionality in both applications and reducing the likelihood of future errors.

* Established a unified approach for both Kiwix and custom apps to trigger findInPage after restoring tabs, ensuring consistent functionality across both applications and minimizing potential future errors.

…after opening a page from the history, bookmarks, or notes screens in custom apps.

…es screen * Resolved the issue where the main page of the ZIM file was not loading when a note was opened from the notes screen, when a different ZIM file was set in the reader. Now, when opening notes, the application correctly sets the corresponding ZIM file in the reader, ensuring the main page is displayed as expected.

MohitMaliFtechiz · 2024-12-09T10:22:00Z

@Saifuddin53 I have made all the necessary changes in the code, and now, the restoration of tabs is working fine. It would be great if you test the functionality and give your feedback.

Saifuddin53 · 2024-12-09T11:32:07Z

Hello @MohitMaliFtechiz, sir, thank you for refining the restoration functionality. I have tested the updated implementation, and it's working absolutely fantastic. The restoration process is now seamless, with significant improvements in performance, and the navigation history is consistent as well.
I'm sorry I wasn't able to contribute more to this effort, but please let me know if there’s anything else I can assist with

MohitMaliFtechiz · 2024-12-09T12:00:58Z

@Saifuddin53 Thank you for the testing and your feedback.

Saifuddin53 changed the title ~~Saving the Web View Navigation History Across Sessions~~ Saving and Restoring the Web View Navigation History Across Sessions Sep 19, 2024

MohitMaliFtechiz requested changes Sep 19, 2024

View reviewed changes

Saifuddin53 requested a review from MohitMaliFtechiz September 19, 2024 17:38

MohitMaliFtechiz requested changes Oct 9, 2024

View reviewed changes

Saifuddin53 force-pushed the Issue#398 branch from c0dba95 to 9f6b55d Compare October 18, 2024 05:41

MohitMaliFtechiz force-pushed the Issue#398 branch from 9f6b55d to d8175e5 Compare October 22, 2024 08:53

MohitMaliFtechiz force-pushed the Issue#398 branch from 3569070 to b0750a9 Compare October 25, 2024 10:57

MohitMaliFtechiz force-pushed the Issue#398 branch from c6a2769 to 3f1a73d Compare December 6, 2024 06:18

MohitMaliDeveloper and others added 13 commits December 9, 2024 13:14

Saved webbackforwardlist to room

d5848bc

Retrieving page history from room

c3d110f

Restoring the internal webbackforwardlist

a55033a

Fixed the detekt issue

3672494

Naming convention improved

5be5186

Code factor improvements

8295642

Automated changes reverted

55e6798

Automated changes reverted

d7e4627

Updated room schema

c64052d

Naming conventions improved and some reviewed changes

07208c7

Fixed detekt issue.

8002e60

Implemented new approach to save and retrieve the webView history.

5df09c6

MohitMaliDeveloper added 8 commits December 9, 2024 13:14

Fixed: Searched item was not opening in custom apps.

3a7181d

* Created a common approach for both Kiwix and custom apps to open the searched item after restoring the tabs, ensuring smooth functionality in both applications and reducing the likelihood of future errors.

Fixed: FindInPage functionality not working in Kiwix and custom apps.

af146ae

* Established a unified approach for both Kiwix and custom apps to trigger findInPage after restoring tabs, ensuring consistent functionality across both applications and minimizing potential future errors.

Improved the saving of tabs.

0141329

Fixed: Reader screen was showing twice when pressing the back button …

2240912

…after opening a page from the history, bookmarks, or notes screens in custom apps.

Removed unnecessary data saving when opening note dialog in note screen.

0f32c43

Fixed: SearchFragmentTest for custom apps was failing.

6cbd075

Fixed: Application crashes at first launch.

feda7b4

MohitMaliFtechiz force-pushed the Issue#398 branch from c26138c to feda7b4 Compare December 9, 2024 07:44

Added debug logs which will help us in debugging if any error happens.

ee90904

MohitMaliFtechiz marked this pull request as ready for review December 9, 2024 10:22

MohitMaliFtechiz requested a review from kelson42 December 9, 2024 10:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Saving and Restoring the Web View Navigation History Across Sessions #3996

Saving and Restoring the Web View Navigation History Across Sessions #3996

Saifuddin53 commented Sep 13, 2024 •

edited

Loading

Saifuddin53 commented Sep 19, 2024 •

edited

Loading

MohitMaliFtechiz commented Sep 19, 2024

kelson42 commented Sep 19, 2024

MohitMaliFtechiz left a comment

kelson42 commented Oct 1, 2024

Saifuddin53 commented Oct 3, 2024

MohitMaliFtechiz left a comment

MohitMaliDeveloper commented Oct 15, 2024

Saifuddin53 commented Oct 16, 2024 •

edited

Loading

MohitMaliFtechiz commented Oct 17, 2024

MohitMaliFtechiz commented Oct 22, 2024

MohitMaliFtechiz commented Dec 9, 2024

Saifuddin53 commented Dec 9, 2024

MohitMaliFtechiz commented Dec 9, 2024

Saving and Restoring the Web View Navigation History Across Sessions #3996

Are you sure you want to change the base?

Saving and Restoring the Web View Navigation History Across Sessions #3996

Conversation

Saifuddin53 commented Sep 13, 2024 • edited Loading

Saifuddin53 commented Sep 19, 2024 • edited Loading

MohitMaliFtechiz commented Sep 19, 2024

kelson42 commented Sep 19, 2024

MohitMaliFtechiz left a comment

Choose a reason for hiding this comment

kelson42 commented Oct 1, 2024

Saifuddin53 commented Oct 3, 2024

MohitMaliFtechiz left a comment

Choose a reason for hiding this comment

MohitMaliDeveloper commented Oct 15, 2024

Saifuddin53 commented Oct 16, 2024 • edited Loading

MohitMaliFtechiz commented Oct 17, 2024

MohitMaliFtechiz commented Oct 22, 2024

MohitMaliFtechiz commented Dec 9, 2024

Saifuddin53 commented Dec 9, 2024

MohitMaliFtechiz commented Dec 9, 2024

Saifuddin53 commented Sep 13, 2024 •

edited

Loading

Saifuddin53 commented Sep 19, 2024 •

edited

Loading

Saifuddin53 commented Oct 16, 2024 •

edited

Loading