Kavita+ UX Refactor

[majora2007]

Kavita+ has been in Kavita for a year now and many different flows have been added, but the UX can be confusing and fixing different problems can be complex.

This story aims to rework the UX and also rework how some of the flows work, like correcting bad matches, etc.

The following is WIP and more of notes until I work this story properly. I am open to comments from the community around issues with Kavita+ (not new features).

• Need the ability to "Fix" a batch match.
• Need the ability to leave a series as Match-less (by user choice). This will automatically opt it out of scrobbling.
• Need a better log of Kavita+ history (audit log) (metadata fetched, scrobble, scrobble denied, errors, etc)
• Need a way to easily understand the refresh match (or allow a single flow that can match without having to have weblinks)
• Blocked Scrobbling series UI needs to be more searchable and centrally located
• Background fetch stat page needs to be moved to Kavita+ tab and needs a MUCH improved UX and detail.
• Much better handling of failed scrobbles, change wording for "rotating key" to "Regenerate", tell time till next scrobble
• Scrobbling Issues is in Media tab when it should be in Scrobbling tab. I missed out on scrobbing for months due to not seeing my token was expired.
• Need a way to unmatch and keep in an unmatched state (check Notes, architected already)
• After buying a Kavita+ license, indicate to the user that an email will send their license key and what to do
  • Update the email template we send to indicate how to register their license with their Kavita instance
• Ability to Manage/Reset when there is no Kavita license on the instance.
• Prompt user to run initial scrobble generation now or later (via a button) after registering an AniList token
• Add a task to generate scrobble events from existing reading history
• Add a new Role to allow viewing of External Recommendations (regardless of Age Rating restrictions?)
• New screen to see users with API keys and status of them. Ability to email the user and inform them to renew their key.
  • EmailHistory to ensure we don't keep emailing users
• Manual Migration to convert old Scrobble Errors -> Matched Metadata for "Series cannot be matched for Scrobbling" as some series get scrobbled before they hit the Metadata fetch pull.
• Update new table no-data localization across app
• CreateEventsFromExistingHistoryForSeries isn't doing just one series (new code)
• Selecting a match needs some UX work
• Matched Metadata screen - Replace actionable with dedicated Match button
• Write manual migration for this "Some series couldnt be Manual match even though there's a 100% matched series under Anilist or MAL"

Stretch goals:

• Test shortening the scrobble window from 4 hours to 1 hour
• Test a UX flow to fix a match within Kavita UI so we don't need to add a weblink and go through that process
• Implement Want to Read Feature Request ([Kavita+] Download/Sync "plan to read" list from Myanimelist and add it to "want to read" and "Collections" in Kavita #3153)
• Weblink for first series in Manga library type can now fill metadata id fields for Series during scan (From testing, this isn't needed)
• Scrobbling should push SignalR events out to users to inform them (Not interested in doing this)
  • This will need a new type of event that auto-dismisses
• Switch to bulk scrobbling updates to have a better handle on rate limit
• New Account Settings for Kavita+ things:
  • Scrobbling for Account Per Provider
  • Want To Read Sync
• Basic Metadata downloading support
• Have the cover image from AniList prompted in the cover image screen at any time post match for those that have covers off

DB Migrations:

• MetadataIds should now be stored directly on Series/SeriesMetadata (and editable by user) (Not sure if this is needed anymore)

Ensure that this situation is cleared up (or easy to understand fixing):

New Gate has a bad match one time, so now no new scrobble events will trigger. It is not clear to the user or clear what to do and if it worked (I busted cache and rematched correctly, yet error is still here)

[thezak48]

Can we add the option to unmatch a series for example when kavita+ miss-matches a series when the series does not have a anilist entry

[majora2007]

@thezak48 Just want to follow up with you on your expectations. Here is my approach:

This falls under the Match/Fix Match flow.

First time you open this, Kavita will attempt to make a match. You can then put a query in (which will, in addition to your local series info), be used for the search and press search to re-search.

If you select Do Not Match, No more searches will occur and you can hit save to close it out. It will unlink any previous metadata, delete any scrobble events for that series, and opt it out from matching and scrobbling automatically.

If you come back later and unselect it, you can re-search and make the match directly (and thus generate scrobble events).