docs(backup): add documentation and samples [WPB-10575] #3269
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
echoes-hq
bot
added
the
echoes: product-roadmap/feature
vitorhugods
force-pushed
the
docs/backup/add-documentation
branch
from
475f209 to
ffb45ab
Compare
vitorhugods
changed the title
Test Results3 506 tests 3 398 ✅ 5m 51s ⏱️ Results for commit 25258d9. ♻️ This comment has been updated with latest results. |
Datadog ReportBranch report: ✅ 0 Failed, 3398 Passed, 108 Skipped, 59.1s Total Time |
Introduced examples showcasing `MPBackupImporter` and `MPBackupExporter` usage for different platforms. Updated documentation, README, and build configurations to support multiplatform samples, including JS and non-JS targets.
vitorhugods
force-pushed
the
docs/backup/add-documentation
branch
from
ffb45ab to
25258d9
Compare
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## epic/multiplatform-backup #3269 +/- ##
============================================================
Coverage ? 53.89%
============================================================
Files ? 1303
Lines ? 37404
Branches ? 3770
============================================================
Hits ? 20159
Misses ? 15835
Partials ? 1410 Continue to review full report in Codecov by Sentry.
|
MohamadJaara
approved these changes
Feb 5, 2025
Garzas
approved these changes
Feb 6, 2025
6 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 7, 2025
* chore: create backup module (#3117) This commit introduces a new cross-platform backup module to the project with support for iOS, Web, and Android. Additionally, it enables JavaScript multiplatform support in existing `kalium/network-model` and `kalium/data` projects. * chore: create backup protobuf models (#3116) * feat: add initial crossplatform backup serialization [WPB-10575] (#3121) * feat: support other message types [WPB-10575] (#3122) Co-authored-by: Yamil Medina <[email protected]> * refactor(backup): make visibility modifier mandatory (#3153) * chore(backup): add encrypted stream [WPB-10575] (#3154) * chore(backup): read and write the backup header (#3159) * feat(backup): support export and import of backups on Web, iOS and Android [WPB-10575] (#3228) * refactor(backup): enhance error handling and test coverage (#3248) Refactored the backup import process to improve error handling by introducing more granular failure types and modularized the logic for decrypting and unzipping archives. Added comprehensive test coverage, including tests for edge cases in decryption, parsing, and unzipping. * chore(backup): improve backup export error handling and result encapsulation (#3257) Introduced `BackupExportResult` and `ExportResult` to encapsulate and represent export operation outcomes, including success and specific failure types (`IOError`, `ZipError`). Refactored relevant methods to use these types, added coroutine support annotations, and implemented error handling for zipping and I/O operations. Added unit tests to ensure correct error handling behavior. * feat(backup): support file peeking [WPB-10575] (#3261) Introduced `peekBackup` and related methods to retrieve backup metadata such as version, encryption status, and original creator. Also added unit tests to validate behavior for various cases, including unsupported versions and mismatched user IDs. * feat(backup): paginate different types of content (#3268) Consolidated handling of paginated backup data into the new `BackupPage` concept to improve clarity and support pagination for users, conversations, and messages during import. Added tests to validate the refactored `BackupImportPager`. * docs(backup): add multiplatform sample implementations and documentation (#3269) Introduced examples showcasing `MPBackupImporter` and `MPBackupExporter` usage for different platforms. Updated documentation, README, and build configurations to support multiplatform samples, including JS and non-JS targets. --------- Co-authored-by: Yamil Medina <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Submission Checklist for internal contributors
The PR Title
SQPIT-764The PR Description
What's new in this PR?
Add a bit more documentation about backup, with links to samples and the currently supported data structure.
Note
The links will work once this is merged to develop and Kalium's documentation is rebuilt by CI. But for now, take these screenshots from a local build:
Dependencies
This PR requires the following PR to be merged:
PR Post Merge Checklist for internal contributors
References
feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.