deblan-mirror/abraunegg-onedrive
deblan-mirror/abraunegg-onedrive
1
0
Fork 0
mirror of https://github.com/abraunegg/onedrive synced 2026-03-14 14:35:46 +01:00
Code Issues Projects Releases Wiki Activity

Improve --resync warning prompt for clarity and safer operation (#3562)

Browse source 
This update refines the --resync user warning prompt to provide clearer,
more accurate guidance on the behaviour and risks associated with performing a
resynchronisation operation.

Key improvements include:

Explicitly explaining that --resync deletes the client’s local state
database and rebuilds it entirely from the current OneDrive contents.

Accurately describing possible outcomes, including overwrite scenarios,
conflict-driven renames or duplications, increased upload/download activity,
and potential Microsoft Graph API throttling (HTTP 429).

Removing incorrect implications that local-only files may be deleted during
--resync (they will instead be uploaded, unless destructive cleanup modes
are explicitly used).

Strengthening safety guidance by recommending:

Maintaining a current backup of the sync_dir

Running the same command with --dry-run before executing a real --resync

Enabling use_recycle_bin so locally triggered online deletions are preserved

Improved formatting and readability for terminal output.

This change enhances user understanding, reduces the likelihood of accidental
data loss, and aligns runtime messaging with the client’s actual synchronisation
logic and documented behaviour.
This commit is contained in:
abraunegg 2025-12-12 12:47:29 +11:00 • committed by GitHub
commit 19b050fa79
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 147 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/actions/spelling/allow.txt vendored
View file

@ -56,6 +56,7 @@ blargh
bools
bpozdena
brp
Btrfs
btw
buflen
bugzilla
@ -418,6 +419,7 @@ redhat
relocs
relro
repology
restic
restorecon
retu
revents
@ -433,6 +435,7 @@ rpmlib
rpmuncompress
Rproj
rrodrigueznt
rsnapshot
rsv
rtud
rul

3
docs/application-config-options.md
View file

@ -803,6 +803,9 @@ _**CLI Option Use:**_ `--resync`
> * sync_business_shared_items
> * Creating, Modifying or Deleting the 'sync_list' file
> [!IMPORTANT]
> The increased activity against the Microsoft Graph API when using this option may trigger HTTP 429 (throttling) responses during the synchronisation process.
### resync_auth
_**Description:**_ This configuration option controls the approval of performing a 'resync' which can be beneficial in automated environments.

5
docs/client-architecture.md
View file

@ -376,11 +376,6 @@ Waiting for all internal threads to complete before exiting application
#### Evidence of Conflict Handling
```
...
The usage of --resync will delete your local 'onedrive' client state, thus no record of your current 'sync status' will exist.
This has the potential to overwrite local versions of files with perhaps older versions of documents downloaded from OneDrive, resulting in local data loss.
If in doubt, backup your local data before using --resync
Are you sure you wish to proceed with --resync? [Y/N] y
Deleting the saved application sync status ...

157
docs/usage.md
View file

@ -649,7 +649,6 @@ Only essential information is shown — suitable for standard usage without addi
Enables general status and progress information. Use:
```text
onedrive --sync --verbose
```
or its short form:
```text
@ -1027,36 +1026,136 @@ The following are supported for pattern matching and exclusion rules:
> This will tell the application to sync any file that it finds in your 'sync_dir' root by default, negating the need to constantly update your 'sync_list' file.
### Performing a --resync
If you alter any of the subsequent configuration items, you will be required to execute a `--resync` to make sure your client is syncing your data with the updated configuration:
* check_nosync
* drive_id
* sync_dir
* skip_file
* skip_dir
* skip_dotfiles
* skip_size
* skip_symlinks
* sync_business_shared_items
* Creating, Modifying or Deleting the 'sync_list' file
Additionally, you might opt for a `--resync` if you think it's necessary to ensure your data remains in sync. If you're using this switch simply because you're unsure of the sync status, you can check the actual sync status using `--display-sync-status`.
When you use `--resync`, you'll encounter the following warning and advice:
```text
Using --resync will delete your local 'onedrive' client state, so there won't be a record of your current 'sync status.'
This may potentially overwrite local versions of files with older versions downloaded from OneDrive, leading to local data loss.
If in doubt, back up your local data before using --resync.
Are you sure you want to proceed with --resync? [Y/N]
```
To proceed with `--resync`, you must type 'y' or 'Y' to allow the application to continue.
> [!CAUTION]
> It's highly recommended to use `--resync` only if the application prompts you to do so. Don't blindly set the application to start with `--resync` as your default option.
A `--resync` operation instructs the client to delete its local state database and fully rebuild it from the current online OneDrive contents. This is a powerful recovery and re-alignment action that should be used **sparingly** and **with care**.
> [!IMPORTANT]
> In certain automated environments (assuming you know what you're doing due to automation), to avoid the 'proceed with acknowledgement' requirement, add `--resync-auth` to automatically acknowledge the prompt.
> **Do not use --resync as part of normal or routine operation.**
>
> A `--resync` is **not** a “refresh” or “force sync” button. It is a destructive recovery action that discards the client’s local sync history and forces a rebuild based solely on the current online OneDrive state.
>
> Habitually using `--resync` has several negative impacts:
> * It removes the historical sync context the client uses to safely resolve conflicts.
> * It can cause unnecessary uploads, downloads, and renames.
> * It increases the chance of triggering rate-limiting (HTTP 429 responses) from the Microsoft Graph API.
> * It can mask underlying configuration or permission issues that should be properly diagnosed instead.
>
> If you are unsure whether the client is in sync, do not run `--resync`. Instead, use:
>```
> onedrive --display-sync-status
>```
> Only use `--resync` when the client explicitly requests it or when a documented configuration change requires it.
#### When a --resync is required
You **must** perform a `--resync` after modifying any of the following configuration items:
* `check_nosync`
* `drive_id`
* `sync_dir`
* `skip_file`
* `skip_dir`
* `skip_dotfiles`
* `skip_size`
* `skip_symlinks`
* `sync_business_shared_items`
* Creating, modifying, or deleting the `sync_list` file
You may also use `--resync` if you believe the local state has become inconsistent with online OneDrive state. However, if you only want to check the current sync status, run:
```text
onedrive --display-sync-status
```
This shows whether you are up-to-date without requiring a resynchronisation.
#### What happens when you use `--resync`
When invoking `--resync`, the client displays one of the following prompts depending on the client version.
#### v2.5.9 and below
```text
The usage of --resync will delete your local 'onedrive' client state, thus no record of your current 'sync status' will exist.
This has the potential to overwrite local versions of files with perhaps older versions of documents downloaded from OneDrive, resulting in local data loss.
If in doubt, backup your local data before using --resync
Are you sure you wish to proceed with --resync? [Y/N]
```
#### v2.5.10 and above
```text
WARNING: You have asked the client to perform a --resync operation.
This operation will delete the client’s local state database and rebuild it entirely from the current online OneDrive state.
Because the previous sync state will no longer be available, the following may occur:
* Local files that also exist in OneDrive may have local changes overwritten by the cloud version if a conflict cannot be safely resolved.
* Local files may be renamed or duplicated locally as part of conflict resolution and data-preservation handling.
* The initial synchronisation pass may involve a large number of file uploads and downloads.
* The increased activity against the Microsoft Graph API may trigger HTTP 429 (throttling) responses during the synchronisation process.
For safest operation:
* Ensure you have a current backup of your sync_dir.
* Run this command first with --dry-run to confirm all planned actions.
* Enable 'use_recycle_bin' so that online deletion events from OneDrive are moved to your system Trash rather than deleted from your local disk.
If in doubt, stop now and back up your local data before continuing.
Are you sure you wish to proceed with --resync? [Y/N]
```
You must press `Y` or `y` to continue with `--resync` action. Any other entry will exit the application.
#### Understanding the --resync risks and behaviour
A `--resync` **does not delete local-only files**. When a file exists locally but not in OneDrive, and is not excluded via a `sync_list` rule, it is treated as **new local content** and will be uploaded during the resynchronisation process.
Local deletion of such files when using `--resync` only occurs when using the explicit local data destructive modes such as:
```text
--download-only --cleanup-local-files
```
The risks associated with `--resync` stem entirely from the loss of the local historic state:
* The client no longer knows which side previously held the authoritative version of your data.
* Conflict handling still protects data using safe-backup mechanisms, but may result in renamed or duplicated files.
* Upload and download volumes may spike significantly.
* Increased calls to the Microsoft Graph API may result in temporary throttling (HTTP 429 responses).
This makes it essential that users **verify actions with `--dry-run`** and **maintain proper backups**.
#### Best-practice guidance when using --resync
1. Always back up your data. This client is **not** a backup system. Ensure your `sync_dir` is protected with real backup tooling such as:
- rsnapshot
- borg
- restic
- Timeshift
- ZFS or Btrfs snapshots
2. Use `--dry-run` before a real `--resync`
Allows you to preview all intended changes without modifying your filesystem.
3. Enable the Recycle Bin feature
Set `use_recycle_bin = "true"` in your application configuration. When enabled:
- Online deletions received from OneDrive via the Graph API are moved to the FreeDesktop.org-compliant system Trash rather than being permanently deleted from your disk.
4. Avoid using `--resync` unnecessarily
Only use it:
- When the client explicitly requests it, or
- When you’ve confirmed, via logs or sync status, that the local state has become invalid
> [!CAUTION]
> Avoid configuring `--resync` as a default startup option.
#### Automated environments
If you **fully understand the implications** and are operating in a scripted or automated environment, you may bypass the confirmation prompt by adding:
```bash
--resync-auth
```
This should **only** be used when automation requires non-interactive operation and robust backups are in place.
### Performing a --force-sync without a --resync or changing your configuration
In some cases and situations, you may have configured the application to skip certain files and folders using 'skip_file' and 'skip_dir' configuration. You then may have a requirement to actually sync one of these items, but do not wish to modify your configuration, nor perform an entire `--resync` twice.

21
src/config.d
View file

@ -1803,10 +1803,23 @@ class ApplicationConfig {
// --resync warning message
addLogEntry("", ["consoleOnly"]); // new line, console only
addLogEntry("The usage of --resync will delete your local 'onedrive' client state, thus no record of your current 'sync status' will exist.", ["consoleOnly"]);
addLogEntry("This has the potential to overwrite local versions of files with perhaps older versions of documents downloaded from OneDrive, resulting in local data loss.", ["consoleOnly"]);
addLogEntry("If in doubt, backup your local data before using --resync", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]); // new line, console only
addLogEntry("WARNING: You have asked the client to perform a --resync operation.", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]);
addLogEntry(" This operation will delete the client’s local state database and rebuild it entirely from the current online OneDrive state.", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]);
addLogEntry(" Because the previous sync state will no longer be available, the following may occur:", ["consoleOnly"]);
addLogEntry(" * Local files that also exist in OneDrive may have local changes overwritten by the cloud version if a conflict cannot be safely resolved.", ["consoleOnly"]);
addLogEntry(" * Local files may be renamed or duplicated locally as part of conflict resolution and data-preservation handling.", ["consoleOnly"]);
addLogEntry(" * The initial synchronisation pass may involve a large number of file uploads and downloads.", ["consoleOnly"]);
addLogEntry(" * The increased activity against the Microsoft Graph API may trigger HTTP 429 (throttling) responses during the synchronisation process.", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]);
addLogEntry(" For safest operation:", ["consoleOnly"]);
addLogEntry(" * Ensure you have a current backup of your sync_dir.", ["consoleOnly"]);
addLogEntry(" * Run this command first with --dry-run to confirm all planned actions.", ["consoleOnly"]);
addLogEntry(" * Enable 'use_recycle_bin' so that online deletion events from OneDrive are moved to your system Trash rather than deleted from your local disk.", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]);
addLogEntry("If in doubt, stop now and back up your local data before continuing.", ["consoleOnly"]);
addLogEntry("", ["consoleOnly"]);
addLogEntry("Are you sure you wish to proceed with --resync? [Y/N] ", ["consoleOnlyNoNewLine"]);
try {