[BUILD-299] Skip AnkiWeb full sync dialog when it's triggered by AnkiHub sync

[abdnh]

Related issues

https://ankihub.atlassian.net/browse/BUILD-299

Proposed changes

This PR makes it so that the AnkiWeb full sync confirmation dialog is skipped (by doing a full upload) when it's triggered by an AnkiHub sync. This is done as follows:

1. We do an AnkiWeb sync before the AnkiHub sync (in sync_with_ankihub()) if a full sync is already required. This is intended to clear a potential full sync triggered by user changes not related to AnkiHub.
2. After the AnkiWeb sync, we make note of the current schema modification time.
3. After the AnkiHub sync, we compare the current schema modification time with the one stored in the previous step. If they are not equal, we know that the AnkiHub sync triggered a schema change that will require a full AnkiWeb sync and we store the timestamp in the private config.
4. We patch Anki's aqt.sync.full_sync() to skip the confirmation dialog and do a full upload if the timestamp stored in the config is equal to the current schema modification time.

How to reproduce

1. Subscribe to an AnkiHub deck and sync it.
2. Unsubscribe from the deck from the web app then sync from the add-on.
3. Now resubscribe to the deck and sync from the add-on. You should notice the Sync button at the top of the main window is now red, indicating that a full sync is required. In this case, the full sync is triggered by note type changes done by the add-on.
4. Sync with AnkiWeb. Normally, Anki will show that dialog asking you whether to download or upload, but it shouldn't appear this time.

[codecov[bot]]

The author of this PR, abdnh, is not an activated member of this organization on Codecov. Please activate this user on Codecov to display this PR comment. Coverage data is still being uploaded to Codecov.io for purposes of overall coverage calculations. Please don't hesitate to email us at support@codecov.io with any questions.

[abdnh]

But they won't be told to do that in the two other situations that cause a schema change:

I pushed some changes to handle this. What do you think?

[RisingOrange]

@abdnh The changes look good, but I think we still need some more changes to avoid data loss.

I don't think we should skip the full sync dialog in these situations:

• uninstalling a deck (this can also happen during a sync btw: https://github.com/ankipalace/ankihub_addon/blob/3931818a8b832e707720e92c35b96a743af98ab0/ankihub/gui/operations/ankihub_sync.py#L98)
• adjusting note types of a deck

Unless we do these two things before:

• the user gets told to sync other devices with AnkiWeb first
• we do an AnkiWeb sync from the current devices

We are now doing both of these safety measures for deck installations, but not for uninstalling a deck or for adjusting note types of a deck.

I have a suggestion for this PR:

• Only skip the full sync dialog when installing new decks
• We can do this by only setting schema_to_do_full_upload_for_once in on_new_deck_subscriptions_done (if the schema is different at this point than at the beginning of the sync)

In other PRs, we could make these further changes:

• Make deck uninstallations not cause a schema change by not removing the "ankihub_id" field from note types. Removing the field is not really needed. (This will be simple change and I think it's worth doing for that reason.)
• Check if the note types will be adjusted before starting the import and ask the user to sync other devices + sync with AnkiWeb from the current device if there will be a schema change. (This is a more complicated change and I think this is less important, because users don't add/remove note type fields frequently.)

What do you think?

[abdnh]

We are now doing both of these safety measures for deck installations, but not for uninstalling a deck or for adjusting note types of a deck.

Good point! I forgot about that.

[sentry-io[bot]]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ AttributeError: 'NoneType' object has no attribute 'modified_in_python' anki.collection in save View Issue
• ‼️ AttributeError: 'SyncCollectionResponse' object has no attribute 'server_media_usn' 1322529746.gui.operations.ankihub_sync in _uplo... View Issue
• ‼️ CardTypeError: Card template ⁨2⁩ in notetype '⁨AnKingOverhaul (AnKing / AnKingMed)⁩' has a problem.
  The front... anki._backend in _run_command View Issue
• ‼️ DBError: DbError { info: "SqliteFailure(Error { code: DatabaseCorrupt, extended_code: 11 }, Some(\"databas... anki._backend in _db_command View Issue
• ‼️ AnkiHubRequestException: AnkiHub request exception: HTTPSConnectionPool(host='app.ankihub.net', port=443): Max retries exc... 1322529746.ankihub_client.ankihub_client in _se... View Issue

_{Did you find this useful? React with a 👍 or 👎}