From 2d0cc9151ca4305140605a4d75f2f00155e7e13d Mon Sep 17 00:00:00 2001 From: Vili Manninen Date: Tue, 14 Jan 2025 21:00:15 +0200 Subject: [PATCH 1/9] Simplify download logic by omitting callback --- src/components/views/DownloadModModal.vue | 1 + 1 file changed, 1 insertion(+) diff --git a/src/components/views/DownloadModModal.vue b/src/components/views/DownloadModModal.vue index be61a8c54..8d6e33a9d 100644 --- a/src/components/views/DownloadModModal.vue +++ b/src/components/views/DownloadModModal.vue @@ -144,6 +144,7 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; ); } catch (e) { this.setIsModProgressModalOpen(false); + this.$store.commit('download/updateDownload', { assignId: assignId, failed: true }); this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); return; } From 09fd3bf125aa0dbf507aed7beafc4b82b98e2528 Mon Sep 17 00:00:00 2001 From: VilppeRiskidev Date: Thu, 23 Jan 2025 16:59:15 +0200 Subject: [PATCH 2/9] Move download progress callbacks to DownloadMixin --- src/components/mixins/DownloadMixin.vue | 31 +++++++++++++++++++++ src/components/views/DownloadModModal.vue | 33 +---------------------- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/src/components/mixins/DownloadMixin.vue b/src/components/mixins/DownloadMixin.vue index 784c41a9d..76c971a69 100644 --- a/src/components/mixins/DownloadMixin.vue +++ b/src/components/mixins/DownloadMixin.vue @@ -2,12 +2,14 @@ import Vue from 'vue'; import Component from 'vue-class-component'; +import StatusEnum from "../../model/enums/StatusEnum"; import R2Error from "../../model/errors/R2Error"; import Game from "../../model/game/Game"; import Profile from "../../model/Profile"; import ThunderstoreCombo from "../../model/ThunderstoreCombo"; import ThunderstoreMod from "../../model/ThunderstoreMod"; import { installModsAndResolveConflicts } from "../../utils/ProfileUtils"; +import { Store } from "vuex"; @Component @@ -50,6 +52,35 @@ export default class DownloadMixin extends Vue { } } + downloadProgressCallback(assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { + try { + if (status === StatusEnum.FAILURE) { + this.setIsModProgressModalOpen(false); + this.$store.commit('download/updateDownload', {assignId, failed: true}); + if (err !== null) { + DownloadMixin.addSolutionsToError(err); + throw err; + } + } else if (status === StatusEnum.PENDING) { + this.$store.commit('download/updateDownload', {assignId, progress, modName}); + } + } catch (e) { + this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); + } + }; + + static downloadProgressCallback(store: Store, assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { + if (status === StatusEnum.FAILURE) { + store.commit('download/updateDownload', {assignId, failed: true}); + if (err !== null) { + DownloadMixin.addSolutionsToError(err); + throw err; + } + } else if (status === StatusEnum.PENDING) { + store.commit('download/updateDownload', {assignId, progress, modName}); + } + } + static addSolutionsToError(err: R2Error): void { // Sanity check typing. if (!(err instanceof R2Error)) { diff --git a/src/components/views/DownloadModModal.vue b/src/components/views/DownloadModModal.vue index 8d6e33a9d..73f27577f 100644 --- a/src/components/views/DownloadModModal.vue +++ b/src/components/views/DownloadModModal.vue @@ -31,7 +31,6 @@ import ModalCard from '../ModalCard.vue'; import DownloadModVersionSelectModal from "../../components/views/DownloadModVersionSelectModal.vue"; import UpdateAllInstalledModsModal from "../../components/views/UpdateAllInstalledModsModal.vue"; import DownloadMixin from "../mixins/DownloadMixin.vue"; -import StatusEnum from '../../model/enums/StatusEnum'; import R2Error from '../../model/errors/R2Error'; import ManifestV2 from '../../model/ManifestV2'; import Profile from '../../model/Profile'; @@ -75,7 +74,7 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; ignoreCache, (progress: number, modName: string, status: number, err: R2Error | null) => { try { - DownloadModModal.downloadProgressCallback(store, assignId, progress, modName, status, err); + DownloadMixin.downloadProgressCallback(store, assignId, progress, modName, status, err); } catch (e) { reject(e); } @@ -107,18 +106,6 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; }); } - static downloadProgressCallback(store: Store, assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { - if (status === StatusEnum.FAILURE) { - store.commit('download/updateDownload', {assignId, failed: true}); - if (err !== null) { - DownloadMixin.addSolutionsToError(err); - throw err; - } - } else if (status === StatusEnum.PENDING) { - store.commit('download/updateDownload', {assignId, progress, modName}); - } - } - async downloadHandler(tsMod: ThunderstoreMod, tsVersion: ThunderstoreVersion) { this.closeModal(); @@ -151,26 +138,8 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; await this.downloadCompletedCallback(downloadedMods); this.setIsModProgressModalOpen(false); }, 1); - } - downloadProgressCallback(assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { - try { - if (status === StatusEnum.FAILURE) { - this.setIsModProgressModalOpen(false); - this.$store.commit('download/updateDownload', {assignId, failed: true}); - if (err !== null) { - DownloadMixin.addSolutionsToError(err); - throw err; - } - } else if (status === StatusEnum.PENDING) { - this.$store.commit('download/updateDownload', {assignId, progress, modName}); - } - } catch (e) { - this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); - } - }; - static async installModAfterDownload(profile: Profile, mod: ThunderstoreMod, version: ThunderstoreVersion): Promise { return new Promise(async (resolve, reject) => { const manifestMod: ManifestV2 = new ManifestV2().fromThunderstoreMod(mod, version); From 7680c4b9865a740bad55ceb2112d953662231815 Mon Sep 17 00:00:00 2001 From: VilppeRiskidev Date: Mon, 27 Jan 2025 13:56:25 +0200 Subject: [PATCH 3/9] Show failed download status unambiguously in DownloadMonitor --- src/pages/DownloadMonitor.vue | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/pages/DownloadMonitor.vue b/src/pages/DownloadMonitor.vue index c30f336fa..491eb8889 100644 --- a/src/pages/DownloadMonitor.vue +++ b/src/pages/DownloadMonitor.vue @@ -19,8 +19,9 @@

{{ downloadObject.initialMods.join(", ") }}

-

Downloading: {{ downloadObject.modName }}

-

{{Math.min(Math.floor(downloadObject.progress), 100)}}% complete

+

Downloading failed

+

Downloading: {{ downloadObject.modName }}

+

{{Math.min(Math.floor(downloadObject.progress), 100)}}% complete

Date: Thu, 23 Jan 2025 14:44:53 +0200 Subject: [PATCH 4/9] Rename progress to downloadProgress --- src/components/mixins/DownloadMixin.vue | 8 ++++---- src/components/views/DownloadModModal.vue | 10 +++++----- src/store/modules/DownloadModule.ts | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/components/mixins/DownloadMixin.vue b/src/components/mixins/DownloadMixin.vue index 76c971a69..2b2c7ca18 100644 --- a/src/components/mixins/DownloadMixin.vue +++ b/src/components/mixins/DownloadMixin.vue @@ -52,7 +52,7 @@ export default class DownloadMixin extends Vue { } } - downloadProgressCallback(assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { + downloadProgressCallback(assignId: number, downloadProgress: number, modName: string, status: number, err: R2Error | null) { try { if (status === StatusEnum.FAILURE) { this.setIsModProgressModalOpen(false); @@ -62,14 +62,14 @@ export default class DownloadMixin extends Vue { throw err; } } else if (status === StatusEnum.PENDING) { - this.$store.commit('download/updateDownload', {assignId, progress, modName}); + this.$store.commit('download/updateDownload', {assignId, downloadProgress, modName}); } } catch (e) { this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); } }; - static downloadProgressCallback(store: Store, assignId: number, progress: number, modName: string, status: number, err: R2Error | null) { + static downloadProgressCallback(store: Store, assignId: number, downloadProgress: number, modName: string, status: number, err: R2Error | null) { if (status === StatusEnum.FAILURE) { store.commit('download/updateDownload', {assignId, failed: true}); if (err !== null) { @@ -77,7 +77,7 @@ export default class DownloadMixin extends Vue { throw err; } } else if (status === StatusEnum.PENDING) { - store.commit('download/updateDownload', {assignId, progress, modName}); + store.commit('download/updateDownload', {assignId, downloadProgress, modName}); } } diff --git a/src/components/views/DownloadModModal.vue b/src/components/views/DownloadModModal.vue index 73f27577f..d1a28100b 100644 --- a/src/components/views/DownloadModModal.vue +++ b/src/components/views/DownloadModModal.vue @@ -5,10 +5,10 @@

Downloading {{$store.getters['download/currentDownload'].modName}}

-

{{Math.floor($store.getters['download/currentDownload'].progress)}}% complete

+

{{Math.floor($store.getters['download/currentDownload'].downloadProgress)}}% complete

@@ -72,9 +72,9 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; profile.asImmutableProfile(), combo, ignoreCache, - (progress: number, modName: string, status: number, err: R2Error | null) => { + (downloadProgress: number, modName: string, status: number, err: R2Error | null) => { try { - DownloadMixin.downloadProgressCallback(store, assignId, progress, modName, status, err); + DownloadMixin.downloadProgressCallback(store, assignId, downloadProgress, modName, status, err); } catch (e) { reject(e); } @@ -127,7 +127,7 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; this.profile.asImmutableProfile(), tsCombo, this.ignoreCache, - (progress, modName, status, err) => { this.downloadProgressCallback(assignId, progress, modName, status, err); } + (downloadProgress, modName, status, err) => { this.downloadProgressCallback(assignId, downloadProgress, modName, status, err); } ); } catch (e) { this.setIsModProgressModalOpen(false); diff --git a/src/store/modules/DownloadModule.ts b/src/store/modules/DownloadModule.ts index 2fa0bb09a..acc78f744 100644 --- a/src/store/modules/DownloadModule.ts +++ b/src/store/modules/DownloadModule.ts @@ -7,7 +7,7 @@ interface DownloadProgress { assignId: number; initialMods: string[]; modName: string; - progress: number; + downloadProgress: number; failed: boolean; } @@ -41,7 +41,7 @@ export const DownloadModule = { assignId, initialMods, modName: '', - progress: 0, + downloadProgress: 0, failed: false, }; state.allDownloads = [...state.allDownloads, downloadObject]; @@ -52,7 +52,7 @@ export const DownloadModule = { getters: >{ activeDownloadCount(state) { const active = state.allDownloads.filter( - dl => !dl.failed && dl.progress < 100 + dl => !dl.failed && dl.downloadProgress < 100 ); return active.length; }, From 1c37df568df83228f3a1e7fd6bc081244e430550 Mon Sep 17 00:00:00 2001 From: VilppeRiskidev Date: Thu, 23 Jan 2025 15:59:51 +0200 Subject: [PATCH 5/9] Add installationProgress to the Vuex store, update the value when installing and display it on the UI --- src/components/mixins/DownloadMixin.vue | 4 ++-- .../profiles-modals/ImportProfileModal.vue | 12 ++++++---- src/components/views/DownloadModModal.vue | 13 ++++++++--- .../views/UpdateAllInstalledModsModal.vue | 2 +- src/store/modules/DownloadModule.ts | 4 +++- src/utils/ProfileUtils.ts | 23 ++++++++++++------- 6 files changed, 38 insertions(+), 20 deletions(-) diff --git a/src/components/mixins/DownloadMixin.vue b/src/components/mixins/DownloadMixin.vue index 2b2c7ca18..f4e5d3331 100644 --- a/src/components/mixins/DownloadMixin.vue +++ b/src/components/mixins/DownloadMixin.vue @@ -44,9 +44,9 @@ export default class DownloadMixin extends Vue { return this.$store.getters['profile/activeProfile']; } - async downloadCompletedCallback(downloadedMods: ThunderstoreCombo[]): Promise { + async downloadCompletedCallback(downloadedMods: ThunderstoreCombo[], assignId: number): Promise { try { - await installModsAndResolveConflicts(downloadedMods, this.profile.asImmutableProfile(), this.$store); + await installModsAndResolveConflicts(downloadedMods, this.profile.asImmutableProfile(), this.$store, assignId); } catch (e) { this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); } diff --git a/src/components/profiles-modals/ImportProfileModal.vue b/src/components/profiles-modals/ImportProfileModal.vue index 70ef23421..063b43c11 100644 --- a/src/components/profiles-modals/ImportProfileModal.vue +++ b/src/components/profiles-modals/ImportProfileModal.vue @@ -212,9 +212,7 @@ export default class ImportProfileModal extends mixins(ProfilesMixin) { async importProfile(targetProfileName: string, mods: ExportMod[], zipPath: string) { this.activeStep = 'PROFILE_IS_BEING_IMPORTED'; this.importPhaseDescription = 'Downloading mods: 0%'; - const progressCallback = (progress: number|string) => typeof progress === "number" - ? this.importPhaseDescription = `Downloading mods: ${Math.floor(progress)}%` - : this.importPhaseDescription = progress; + const progressCallback = (progressText: string) => this.importPhaseDescription = progressText; const game = this.$store.state.activeGame; const settings = this.$store.getters['settings']; const ignoreCache = settings.getContext().global.ignoreCache; @@ -222,8 +220,12 @@ export default class ImportProfileModal extends mixins(ProfilesMixin) { try { const comboList = await ProfileUtils.exportModsToCombos(mods, game); - await ThunderstoreDownloaderProvider.instance.downloadImportedMods(comboList, ignoreCache, progressCallback); - await ProfileUtils.populateImportedProfile(comboList, mods, targetProfileName, isUpdate, zipPath, progressCallback); + await ThunderstoreDownloaderProvider.instance.downloadImportedMods(comboList, ignoreCache, (progress) => { + progressCallback(`Downloading mods: ${Math.floor(progress)}%`) + }); + await ProfileUtils.populateImportedProfile(comboList, mods, targetProfileName, isUpdate, zipPath, (progress) => { + progressCallback(`Copying mods to profile: ${progress}%`) + }); } catch (e) { await this.$store.dispatch('profiles/ensureProfileExists'); this.closeModal(); diff --git a/src/components/views/DownloadModModal.vue b/src/components/views/DownloadModModal.vue index d1a28100b..7812c16a3 100644 --- a/src/components/views/DownloadModModal.vue +++ b/src/components/views/DownloadModModal.vue @@ -4,13 +4,20 @@
-

Downloading {{$store.getters['download/currentDownload'].modName}}

-

{{Math.floor($store.getters['download/currentDownload'].downloadProgress)}}% complete

+

Downloading and installing {{$store.getters['download/currentDownload'].modName}}

+

Downloading: {{Math.floor($store.getters['download/currentDownload'].downloadProgress)}}% complete

+

Installation: {{$store.getters['download/currentDownload'].installationProgress}}% complete

+

Installation: waiting for download to finish

+
@@ -135,7 +142,7 @@ import ProfileModList from '../../r2mm/mods/ProfileModList'; this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); return; } - await this.downloadCompletedCallback(downloadedMods); + await this.downloadCompletedCallback(downloadedMods, assignId); this.setIsModProgressModalOpen(false); }, 1); } diff --git a/src/components/views/UpdateAllInstalledModsModal.vue b/src/components/views/UpdateAllInstalledModsModal.vue index a1c8ddd70..1a4528779 100644 --- a/src/components/views/UpdateAllInstalledModsModal.vue +++ b/src/components/views/UpdateAllInstalledModsModal.vue @@ -65,7 +65,7 @@ export default class UpdateAllInstalledModsModal extends mixins(DownloadMixin) this.$store.commit('error/handleError', R2Error.fromThrownValue(e)); } }, async (downloadedMods) => { - await this.downloadCompletedCallback(downloadedMods); + await this.downloadCompletedCallback(downloadedMods, assignId); this.setIsModProgressModalOpen(false); }); } diff --git a/src/store/modules/DownloadModule.ts b/src/store/modules/DownloadModule.ts index acc78f744..6325402b4 100644 --- a/src/store/modules/DownloadModule.ts +++ b/src/store/modules/DownloadModule.ts @@ -8,6 +8,7 @@ interface DownloadProgress { initialMods: string[]; modName: string; downloadProgress: number; + installationProgress: number; failed: boolean; } @@ -42,6 +43,7 @@ export const DownloadModule = { initialMods, modName: '', downloadProgress: 0, + installationProgress: 0, failed: false, }; state.allDownloads = [...state.allDownloads, downloadObject]; @@ -52,7 +54,7 @@ export const DownloadModule = { getters: >{ activeDownloadCount(state) { const active = state.allDownloads.filter( - dl => !dl.failed && dl.downloadProgress < 100 + dl => !dl.failed && dl.downloadProgress < 100 && dl.installationProgress < 100 ); return active.length; }, diff --git a/src/utils/ProfileUtils.ts b/src/utils/ProfileUtils.ts index 164d5eb40..2447cb47c 100644 --- a/src/utils/ProfileUtils.ts +++ b/src/utils/ProfileUtils.ts @@ -37,7 +37,7 @@ export async function exportModsToCombos(exportMods: ExportMod[], game: Game): P async function extractConfigsToImportedProfile( file: string, profileName: string, - progressCallback: (status: string) => void + progressCallback: (status: number) => void ) { const zipEntries = await ZipProvider.instance.getEntries(file); const excludedFiles = ["export.r2x", "mods.yml"]; @@ -54,17 +54,20 @@ async function extractConfigsToImportedProfile( } const progress = Math.floor(((index + 1) / zipEntries.length) * 100); - progressCallback(`Copying configs to profile: ${progress}%`); + progressCallback(progress); } } export async function installModsAndResolveConflicts( downloadedMods: ThunderstoreCombo[], profile: ImmutableProfile, - store: Store + store: Store, + assignId: number ): Promise { await ProfileModList.requestLock(async () => { - const modList: ManifestV2[] = await installModsToProfile(downloadedMods, profile); + const modList: ManifestV2[] = await installModsToProfile(downloadedMods, profile, undefined, (installationProgress) => { + store.commit('download/updateDownload', {assignId, installationProgress}); + }); await store.dispatch('profile/updateModList', modList); throwForR2Error(await ConflictManagementProvider.instance.resolveConflicts(modList, profile)); }); @@ -79,7 +82,7 @@ export async function installModsToProfile( comboList: ThunderstoreCombo[], profile: ImmutableProfile, disabledModsOverride?: string[], - progressCallback?: (status: string) => void + progressCallback?: (status: number) => void ): Promise { const profileMods = await ProfileModList.getModList(profile); if (profileMods instanceof R2Error) { @@ -120,7 +123,7 @@ export async function installModsToProfile( if (typeof progressCallback === "function") { const progress = Math.floor(((index + 1) / comboList.length) * 100); - progressCallback(`Copying mods to profile: ${progress}%`); + progressCallback(progress); } } } catch (e) { @@ -200,8 +203,12 @@ export async function populateImportedProfile( try { const disabledMods = exportModList.filter((m) => !m.isEnabled()).map((m) => m.getName()); - await installModsToProfile(comboList, profile, disabledMods, progressCallback); - await extractConfigsToImportedProfile(zipPath, profile.getProfileName(), progressCallback); + await installModsToProfile(comboList, profile, disabledMods, (progress) => { + progressCallback(`Copying mods to profile: ${progress}%`); + }); + await extractConfigsToImportedProfile(zipPath, profile.getProfileName(), (progress) => { + progressCallback(`Copying configs to profile: ${progress}%`); + }); } catch (e) { await FileUtils.recursiveRemoveDirectoryIfExists(profile.getProfilePath()); throw e; From a7b06bd20618b9508a21f88d2762926f8cfd1c7f Mon Sep 17 00:00:00 2001 From: VilppeRiskidev Date: Thu, 23 Jan 2025 16:18:52 +0200 Subject: [PATCH 6/9] Show installation progress in the DownloadMonitor correclty --- src/pages/DownloadMonitor.vue | 46 +++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/src/pages/DownloadMonitor.vue b/src/pages/DownloadMonitor.vue index 491eb8889..52c9ffdf5 100644 --- a/src/pages/DownloadMonitor.vue +++ b/src/pages/DownloadMonitor.vue @@ -19,19 +19,39 @@

{{ downloadObject.initialMods.join(", ") }}

-

Downloading failed

-

Downloading: {{ downloadObject.modName }}

-

{{Math.min(Math.floor(downloadObject.progress), 100)}}% complete

- - + +
+

Downloading: {{ downloadObject.modName }}

+

{{Math.min(Math.floor(downloadObject.downloadProgress), 100)}}% complete

+ +
+ +
+

Installing: {{ downloadObject.modName }}

+

{{Math.min(Math.floor(downloadObject.installationProgress), 100)}}% complete

+ +
+ +
+

{{downloadObject.failed ? "Download failed" : `${Math.min(Math.floor(downloadObject.installationProgress), 100)}% complete`}}

+ +
+ +
+

Status unknown

+
From c359b2848d7838844196c97df95eacde8dbe1cfd Mon Sep 17 00:00:00 2001 From: VilppeRiskidev Date: Tue, 28 Jan 2025 14:54:40 +0200 Subject: [PATCH 7/9] Further improve installation progress tracking --- src/components/mixins/DownloadMixin.vue | 60 +++++++++++-------- .../profiles-modals/ImportProfileModal.vue | 12 ++-- src/components/views/DownloadModModal.vue | 8 +-- .../views/UpdateAllInstalledModsModal.vue | 2 +- src/pages/DownloadMonitor.vue | 43 ++++++++----- .../BetterThunderstoreDownloader.ts | 12 ++-- src/store/modules/DownloadModule.ts | 6 +- src/utils/ProfileUtils.ts | 36 +++-------- 8 files changed, 95 insertions(+), 84 deletions(-) diff --git a/src/components/mixins/DownloadMixin.vue b/src/components/mixins/DownloadMixin.vue index f4e5d3331..e0fa2cd0a 100644 --- a/src/components/mixins/DownloadMixin.vue +++ b/src/components/mixins/DownloadMixin.vue @@ -1,15 +1,18 @@