Unify mod list update functionality under Vuex #1597
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
The "background" update originally referred to the periodic updates, i.e. not the update that happens on splash screen and shows the progress to user. The Vuex state is now shared between the background updates and user triggered manual updates that show a lightweight status reporting, so the naming was bit misleading.
As the number of callsites increases, it makes more sense to have the method for downloading the latest mod list, storing it into IndexedDB and loading packages to Vuex inside Vuex, so each component doesn't need to extend the UtilityMixin just to access it. For TSMM this also allows injecting telemetry gathering to the method inside Vuex, and not needing to due it awkwardly in App.vue.
If new mod list was downloaded and stored to IndexDB successfully, but loading the mods to Vuex failed, user would end up in situation where the mod list is empty but it wouldn't be updated until a new version was available in the API. To prevent this, we now always attempt to load the mod list in to Vuex if the the mod list stored there is empty.
The Vuex method now handles preventing multiple simultaneous update calls. It also provides a simple status message for the update process to be shown in the UI when the update process is triggered by the user.
ebkr
reviewed
Jan 5, 2025
| modsLastUpdated: undefined | ||
| modsLastUpdated: undefined, | ||
| /*** Error shown on UI after mod list refresh fails */ | ||
| thunderstoreModListUpdateError: '', |
There was a problem hiding this comment.
I think it'd be worth changing this to be an undefined/Error object. We can do more with the Error itself such as present a modal than we can with just the error message.
Comment on lines
+149
to
+150
| if (typeof error === 'string') { | ||
| state.thunderstoreModListUpdateError = error; |
There was a problem hiding this comment.
Correct me if I'm wrong but this block should never be hit.
We invoke this in one place, and that's part of a try/catch block. We should always hit the instanceof Error case.
| try { | ||
| packageListIndex = await dispatch('fetchPackageListIndex'); | ||
| } catch { | ||
| // "Retry failed after 5 attempts" isn't very helpful error message. |
There was a problem hiding this comment.
Noted and agreed, worth removing the comment now as it doesn't benefit the codebase
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.
No description provided.