Better Obsidian sync #1221
Open
Better Obsidian sync #1221
Conversation
This file contains hidden or 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
- Introduced `deleteContentByType` to delete content of a specified type from the Khoj server. - Added `uploadContentBatch` to handle batch uploads of files to the Khoj content endpoint. - Updated `updateContentIndex` to utilize the new API functions for content deletion and batch uploads, improving error handling and file processing logic.
- Introduced a new setting for displaying estimated cloud storage usage based on files configured for sync. - Implemented a progress indicator and text display for the estimation process. - Added a utility function to calculate used and total storage bytes based on user plan (free or premium). - Enhanced error handling for storage estimation failures.
- Added a progress indicator and text display for the sync operation in the settings. - Modified the `updateContentIndex` function to accept an optional progress callback, allowing real-time updates on file processing. - Implemented error handling for progress updates to ensure robustness during sync operations. - Created a new progress bar for the Force Sync operation, improving user feedback during lengthy processes.
- Updated the sync progress UI to include a display for the current content type being synced (e.g., Images, PDFs, Markdowns). - Modified the `onProgress` callback in `updateContentIndex` to accept an optional `contentType` parameter for better user feedback during sync operations. - Added error handling for the `updateStorageDisplay` method to ensure robustness during setting changes. - Improved the overall user experience by providing clearer sync progress information.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
feat(obsidian): Enhance Sync Experience with Progress Bars and Bug Fixes
This pull request significantly improves the content synchronization experience for Obsidian users by fixing a critical bug and introducing new UI elements for better feedback and monitoring.
The previous implementation could fail with
403 Forbiddenerrors when syncing a large number of files due to server-side rate limiting. This update addresses that issue and provides users with clear, real-time feedback on storage usage and sync progress.Key Changes
🐛 Bug Fix: Sync Robustness (Resolves 403 Errors)
The core sync logic in
updateContentIndexhas been refactored. Instead of sending all file updates at once, the process is now chunked. Files are grouped by type (markdown, pdf, image) and uploaded in sequential batches. This respects server rate limits and ensures that large vaults can be indexed reliably without triggering403errors.✨ New Feature: Cloud Storage Usage Bar
A progress bar has been added to the settings page to display cloud storage usage.
is_activeflag returned from the/api/v1/userendpoint, eliminating fragile client-side heuristics.✨ New Feature: Real-time Sync Progress Bar
When a manual sync is triggered via the "Force Sync" button, a second progress bar now appears, providing real-time feedback on the operation.
onProgress) to cleanly communicate progress from the sync logic (utils.ts) to the UI (settings.ts) without coupling them.🔄 UX Improvement: Auto-refresh After Sync
The Cloud Storage Usage bar is now automatically refreshed upon the completion of a "Force Sync". This ensures the user immediately sees the updated storage estimation without needing to reopen the settings panel.
🛠️ DX Improvement: esbuild Development Workflow
The
esbuild.config.mjshas been enhanced to automatically copy the builtmain.jsandmanifest.jsonfiles to a specified Obsidian plugin directory during development, streamlining the testing and iteration cycle.Visuals