Download refactor separate callback #1545
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import { Store } from "vuex"; | ||
|
|
||
| import StatusEnum from "../model/enums/StatusEnum"; | ||
| import R2Error from "../model/errors/R2Error"; | ||
| import Profile from "../model/Profile"; | ||
| import ThunderstoreCombo from "../model/ThunderstoreCombo"; | ||
| import ConflictManagementProvider from "../providers/generic/installing/ConflictManagementProvider"; | ||
| import ProfileModList from "../r2mm/mods/ProfileModList"; | ||
| import { installModsToProfile } from "../utils/ProfileUtils"; | ||
|
|
||
| interface DownloadProgress { | ||
| assignId: number; | ||
| initialMods: string[]; | ||
| modName: string; | ||
| progress: number; | ||
| failed: boolean; | ||
| } | ||
|
|
||
| export async function downloadCompletedCallback(profile: Profile, downloadedMods: ThunderstoreCombo[], store: Store<any>) { | ||
|
There was a problem hiding this comment.
|
||
| const immutableProfile = profile.asImmutableProfile(); | ||
| await ProfileModList.requestLock(async () => { | ||
| try { | ||
| const modList = await installModsToProfile(downloadedMods, immutableProfile); | ||
| await store.dispatch('profile/updateModList', modList); | ||
|
|
||
| const err = await ConflictManagementProvider.instance.resolveConflicts(modList, profile); | ||
| if (err instanceof R2Error) { | ||
| throw err; | ||
| } | ||
| } catch (e) { | ||
| store.commit('error/handleError', R2Error.fromThrownValue(e)); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| export async function downloadProgressCallback ( | ||
|
There was a problem hiding this comment. Having this as a separate method in the vue component makes sense, as it removed duplicated code. However, I'm not so sure having it as a utility function is a good idea. The fact that this takes 11 arguments which mostly deal with managing the component's internal state means that it's not really a standalone in anyway. It's so tightly coupled with the current component, I'd argue that having it in a separate file actually makes the code harder to read. Also The Big Picture stuff argues against moving this here. |
||
| currentAssignId: number, | ||
| progress: number, | ||
| modName: string, | ||
| status: number, | ||
| err: R2Error | null, | ||
| initialMods: string[], | ||
| downloadObject: DownloadProgress | null, | ||
| setDownloadObject: Function, | ||
| setDownloadingMod: Function, | ||
| vueSetCallback: Function, | ||
| allVersions: [number, DownloadProgress][] | ||
| ) { | ||
| const assignIndex = allVersions.findIndex(([number, val]) => number === currentAssignId); | ||
| if (status === StatusEnum.FAILURE) { | ||
| if (err !== null) { | ||
| setDownloadingMod(false); | ||
| const existing = allVersions[assignIndex] | ||
| existing[1].failed = true; | ||
| vueSetCallback(assignIndex, existing[1]); | ||
| addSolutionsToError(err); | ||
| throw(err); | ||
| } | ||
| } else if (status === StatusEnum.PENDING) { | ||
| const obj = { | ||
| progress: progress, | ||
| initialMods: initialMods, | ||
| modName: modName, | ||
| assignId: currentAssignId, | ||
| failed: false, | ||
| } | ||
| if (downloadObject!.assignId === currentAssignId) { | ||
| setDownloadObject(Object.assign({}, obj)); | ||
| } | ||
| vueSetCallback(assignIndex, obj); | ||
| } | ||
| } | ||
| function addSolutionsToError(err: R2Error): void { | ||
| // Sanity check typing. | ||
| if (!(err instanceof R2Error)) { | ||
| return; | ||
| } | ||
|
|
||
| if ( | ||
| err.name.includes("Failed to download mod") || | ||
| err.name.includes("System.Net.WebException") | ||
| ) { | ||
| err.solution = "Try toggling the preferred Thunderstore CDN in the settings"; | ||
| } | ||
|
|
||
| if (err.message.includes("System.IO.PathTooLongException")) { | ||
| err.solution = 'Using "Change data folder" option in the settings to select a shorter path might solve the issue'; | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: all the other imports here use single quotes.