From 9ca4173ad1a9a2a6e85f930bfc838809d6e63616 Mon Sep 17 00:00:00 2001
From: Vili Manninen <vili.manninen@riskidev.fi>
Date: Tue, 14 Jan 2025 21:00:15 +0200
Subject: [PATCH] Simplify download logic by omitting callback

---
 src/components/mixins/DownloadMixin.vue       |   4 +
 src/components/views/DownloadModModal.vue     | 142 +++++++++++-------
 .../views/DownloadModVersionSelectModal.vue   |   1 -
 .../views/UpdateAllInstalledModsModal.vue     |   6 +-
 .../ThunderstoreDownloaderProvider.ts         |  21 ++-
 .../BetterThunderstoreDownloader.ts           |  97 ++++++------
 6 files changed, 150 insertions(+), 121 deletions(-)

diff --git a/src/components/mixins/DownloadMixin.vue b/src/components/mixins/DownloadMixin.vue
index a4e5b721e..784c41a9d 100644
--- a/src/components/mixins/DownloadMixin.vue
+++ b/src/components/mixins/DownloadMixin.vue
@@ -21,6 +21,10 @@ export default class DownloadMixin extends Vue {
         this.$store.commit("closeDownloadModModal");
     }
 
+    setIsModProgressModalOpen(open: boolean): void {
+        this.$store.commit('download/setIsModProgressModalOpen', open);
+    }
+
     get isOpen(): boolean {
         return this.$store.state.modals.isDownloadModModalOpen;
     }
diff --git a/src/components/views/DownloadModModal.vue b/src/components/views/DownloadModModal.vue
index 7b17d809d..be61a8c54 100644
--- a/src/components/views/DownloadModModal.vue
+++ b/src/components/views/DownloadModModal.vue
@@ -1,7 +1,7 @@
 <template>
     <div>
         <div id='downloadProgressModal' :class="['modal', {'is-active':$store.state.download.isModProgressModalOpen}]" v-if="$store.getters['download/currentDownload'] !== null">
-            <div class="modal-background" @click="$store.commit('download/setIsModProgressModalOpen', false);"></div>
+            <div class="modal-background" @click="setIsModProgressModalOpen(false);"></div>
             <div class='modal-content'>
                 <div class='notification is-info'>
                     <h3 class='title'>Downloading {{$store.getters['download/currentDownload'].modName}}</h3>
@@ -13,7 +13,7 @@
                     />
                 </div>
             </div>
-            <button class="modal-close is-large" aria-label="close" @click="$store.commit('download/setIsModProgressModalOpen', false);"></button>
+            <button class="modal-close is-large" aria-label="close" @click="setIsModProgressModalOpen(false);"></button>
         </div>
         <DownloadModVersionSelectModal @download-mod="downloadHandler" />
         <UpdateAllInstalledModsModal />
@@ -60,54 +60,65 @@ import ProfileModList from '../../r2mm/mods/ProfileModList';
             store: Store<any>
         ): Promise<void> {
             return new Promise(async (resolve, reject) => {
-                const tsMod = combo.getMod();
-                const tsVersion = combo.getVersion();
 
                 const assignId = await store.dispatch(
                     'download/addDownload',
-                    [`${tsMod.getName()} (${tsVersion.getVersionNumber().toString()})`]
+                    [`${combo.getMod().getName()} (${combo.getVersion().getVersionNumber().toString()})`]
                 );
 
-                setTimeout(() => {
-                    ThunderstoreDownloaderProvider.instance.download(profile.asImmutableProfile(), tsMod, tsVersion, ignoreCache, (progress: number, modName: string, status: number, err: R2Error | null) => {
-                        try {
-                            if (status === StatusEnum.FAILURE) {
-                                store.commit('download/updateDownload', {assignId, failed: true});
-                                if (err !== null) {
-                                    DownloadMixin.addSolutionsToError(err);
-                                    return reject(err);
-                                }
-                            } else if (status === StatusEnum.PENDING) {
-                                store.commit('download/updateDownload', {assignId, progress, modName});
-                            }
-                        } catch (e) {
-                            return reject(e);
-                        }
-                    }, async (downloadedMods: ThunderstoreCombo[]) => {
-                        ProfileModList.requestLock(async () => {
-                            for (const combo of downloadedMods) {
+                setTimeout(async () => {
+                    let downloadedMods: ThunderstoreCombo[] = [];
+                    try {
+                        downloadedMods = await ThunderstoreDownloaderProvider.instance.download(
+                            profile.asImmutableProfile(),
+                            combo,
+                            ignoreCache,
+                            (progress: number, modName: string, status: number, err: R2Error | null) => {
                                 try {
-                                    await DownloadModModal.installModAfterDownload(profile, combo.getMod(), combo.getVersion());
+                                    DownloadModModal.downloadProgressCallback(store, assignId, progress, modName, status, err);
                                 } catch (e) {
-                                    return reject(
-                                        R2Error.fromThrownValue(e, `Failed to install mod [${combo.getMod().getFullName()}]`)
-                                    );
+                                    reject(e);
                                 }
                             }
-                            const modList = await ProfileModList.getModList(profile.asImmutableProfile());
-                            if (!(modList instanceof R2Error)) {
-                                const err = await ConflictManagementProvider.instance.resolveConflicts(modList, profile.asImmutableProfile());
-                                if (err instanceof R2Error) {
-                                    return reject(err);
-                                }
+                        );
+                    } catch (e) {
+                        return reject(e);
+                    }
+                    await ProfileModList.requestLock(async () => {
+                        for (const combo of downloadedMods) {
+                            try {
+                                await DownloadModModal.installModAfterDownload(profile, combo.getMod(), combo.getVersion());
+                            } catch (e) {
+                                return reject(
+                                    R2Error.fromThrownValue(e, `Failed to install mod [${combo.getMod().getFullName()}]`)
+                                );
                             }
-                            return resolve();
-                        });
+                        }
+                        const modList = await ProfileModList.getModList(profile.asImmutableProfile());
+                        if (!(modList instanceof R2Error)) {
+                            const err = await ConflictManagementProvider.instance.resolveConflicts(modList, profile.asImmutableProfile());
+                            if (err instanceof R2Error) {
+                                return reject(err);
+                            }
+                        }
+                        return resolve();
                     });
                 }, 1);
             });
         }
 
+        static downloadProgressCallback(store: Store<any>, 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();
 
@@ -116,30 +127,49 @@ import ProfileModList from '../../r2mm/mods/ProfileModList';
                 [`${tsMod.getName()} (${tsVersion.getVersionNumber().toString()})`]
             );
 
-            this.$store.commit('download/setIsModProgressModalOpen', true);
-            setTimeout(() => {
-                ThunderstoreDownloaderProvider.instance.download(this.profile.asImmutableProfile(), tsMod, tsVersion, this.ignoreCache, (progress: number, modName: string, status: number, err: R2Error | null) => {
-                    try {
-                        if (status === StatusEnum.FAILURE) {
-                            this.$store.commit('download/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));
-                    }
-                }, async (downloadedMods) => {
-                    await this.downloadCompletedCallback(downloadedMods);
-                    this.$store.commit('download/setIsModProgressModalOpen', false);
-                });
+            this.setIsModProgressModalOpen(true);
+
+            const tsCombo = new ThunderstoreCombo();
+            tsCombo.setMod(tsMod);
+            tsCombo.setVersion(tsVersion);
+
+            setTimeout(async () => {
+                let downloadedMods: ThunderstoreCombo[] = [];
+                try {
+                    downloadedMods = await ThunderstoreDownloaderProvider.instance.download(
+                        this.profile.asImmutableProfile(),
+                        tsCombo,
+                        this.ignoreCache,
+                        (progress, modName, status, err) => { this.downloadProgressCallback(assignId, progress, modName, status, err); }
+                    );
+                } catch (e) {
+                    this.setIsModProgressModalOpen(false);
+                    this.$store.commit('error/handleError', R2Error.fromThrownValue(e));
+                    return;
+                }
+                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<R2Error | void> {
             return new Promise(async (resolve, reject) => {
                 const manifestMod: ManifestV2 = new ManifestV2().fromThunderstoreMod(mod, version);
diff --git a/src/components/views/DownloadModVersionSelectModal.vue b/src/components/views/DownloadModVersionSelectModal.vue
index 35b8e5120..a6cd82542 100644
--- a/src/components/views/DownloadModVersionSelectModal.vue
+++ b/src/components/views/DownloadModVersionSelectModal.vue
@@ -60,7 +60,6 @@ import ModalCard from "../ModalCard.vue";
 import DownloadMixin from "../../components/mixins/DownloadMixin.vue";
 import R2Error from "../../model/errors/R2Error";
 import ManifestV2 from "../../model/ManifestV2";
-import ThunderstoreMod from "../../model/ThunderstoreMod";
 import ThunderstoreVersion from "../../model/ThunderstoreVersion";
 import { MOD_LOADER_VARIANTS } from "../../r2mm/installing/profile_installers/ModLoaderVariantRecord";
 import * as PackageDb from "../../r2mm/manager/PackageDexieStore";
diff --git a/src/components/views/UpdateAllInstalledModsModal.vue b/src/components/views/UpdateAllInstalledModsModal.vue
index d65cbc368..a1c8ddd70 100644
--- a/src/components/views/UpdateAllInstalledModsModal.vue
+++ b/src/components/views/UpdateAllInstalledModsModal.vue
@@ -48,11 +48,11 @@ export default class UpdateAllInstalledModsModal extends mixins(DownloadMixin)
             modsWithUpdates.map(value => `${value.getMod().getName()} (${value.getVersion().getVersionNumber().toString()})`)
         );
 
-        this.$store.commit('download/setIsModProgressModalOpen', true);
+        this.setIsModProgressModalOpen(true);
         ThunderstoreDownloaderProvider.instance.downloadLatestOfAll(modsWithUpdates, this.ignoreCache, (progress: number, modName: string, status: number, err: R2Error | null) => {
             try {
                 if (status === StatusEnum.FAILURE) {
-                    this.$store.commit('download/setIsModProgressModalOpen', false);
+                    this.setIsModProgressModalOpen(false);
                     this.$store.commit('download/updateDownload', {assignId, failed: true});
                     if (err !== null) {
                         DownloadMixin.addSolutionsToError(err);
@@ -66,7 +66,7 @@ export default class UpdateAllInstalledModsModal extends mixins(DownloadMixin)
             }
         }, async (downloadedMods) => {
             await this.downloadCompletedCallback(downloadedMods);
-            this.$store.commit('download/setIsModProgressModalOpen', false);
+            this.setIsModProgressModalOpen(false);
         });
     }
 }
diff --git a/src/providers/ror2/downloading/ThunderstoreDownloaderProvider.ts b/src/providers/ror2/downloading/ThunderstoreDownloaderProvider.ts
index 1b44a060c..45f0f8bd7 100644
--- a/src/providers/ror2/downloading/ThunderstoreDownloaderProvider.ts
+++ b/src/providers/ror2/downloading/ThunderstoreDownloaderProvider.ts
@@ -1,6 +1,5 @@
 import ProviderUtils from '../../generic/ProviderUtils';
 import ThunderstoreVersion from '../../../model/ThunderstoreVersion';
-import ThunderstoreMod from '../../../model/ThunderstoreMod';
 import ThunderstoreCombo from '../../../model/ThunderstoreCombo';
 import R2Error from '../../../model/errors/R2Error';
 import { ImmutableProfile } from '../../../model/Profile';
@@ -49,17 +48,17 @@ export default abstract class ThunderstoreDownloaderProvider {
     /**
      * A top-level method to download the latest version of a mod including its dependencies.
      *
-     * @param profile           The profile the mod is downloaded for (needed to prevent dependencies from updating existing mods).
-     * @param mod               The mod to be downloaded.
-     * @param modVersion        The version of the mod to download.
-     * @param ignoreCache       Download mod even if it already exists in the cache.
-     * @param callback          Callback to show the current state of the downloads.
-     * @param completedCallback Callback to perform final actions against. Only called if {@param callback} has not returned a failed status.
+     * @param profile                   The profile the mod is downloaded for (needed to prevent dependencies from updating existing mods).
+     * @param combo                     The combo to be downloaded.
+     * @param ignoreCache               Download mod even if it already exists in the cache.
+     * @param totalProgressCallback     Callback to show the combined state of all the downloads.
      */
-    public abstract download(profile: ImmutableProfile, mod: ThunderstoreMod, modVersion: ThunderstoreVersion,
-                    ignoreCache: boolean,
-                    callback: (progress: number, modName: string, status: number, err: R2Error | null) => void,
-                    completedCallback: (modList: ThunderstoreCombo[]) => void): void;
+    public abstract download(
+        profile: ImmutableProfile,
+        combo: ThunderstoreCombo,
+        ignoreCache: boolean,
+        totalProgressCallback: (progress: number, modName: string, status: number, err: R2Error | null) => void
+    ): Promise<ThunderstoreCombo[]>;
 
     /**
      * A top-level method to download exact versions of exported mods.
diff --git a/src/r2mm/downloading/BetterThunderstoreDownloader.ts b/src/r2mm/downloading/BetterThunderstoreDownloader.ts
index c67484ca5..ebf0230ff 100644
--- a/src/r2mm/downloading/BetterThunderstoreDownloader.ts
+++ b/src/r2mm/downloading/BetterThunderstoreDownloader.ts
@@ -1,8 +1,7 @@
-import ManifestV2 from "src/model/ManifestV2";
 import ThunderstoreVersion from '../../model/ThunderstoreVersion';
-import ThunderstoreMod from '../../model/ThunderstoreMod';
 import StatusEnum from '../../model/enums/StatusEnum';
 import axios, { AxiosResponse } from 'axios';
+import ManifestV2 from "../../model/ManifestV2";
 import ThunderstoreCombo from '../../model/ThunderstoreCombo';
 import ZipExtract from '../installing/ZipExtract';
 import R2Error from '../../model/errors/R2Error';
@@ -83,71 +82,69 @@ export default class BetterThunderstoreDownloader extends ThunderstoreDownloader
         });
     }
 
-    public async download(profile: ImmutableProfile, mod: ThunderstoreMod, modVersion: ThunderstoreVersion,
-                           ignoreCache: boolean,
-                           callback: (progress: number, modName: string, status: number, err: R2Error | null) => void,
-                           completedCallback: (modList: ThunderstoreCombo[]) => void) {
+    public async download(
+        profile: ImmutableProfile,
+        combo: ThunderstoreCombo,
+        ignoreCache: boolean,
+        totalProgressCallback: (progress: number, modName: string, status: number, err: R2Error | null) => void
+    ): Promise<ThunderstoreCombo[]> {
 
         const modList = await ProfileModList.getModList(profile);
         if (modList instanceof R2Error) {
-            return callback(0, mod.getName(), StatusEnum.FAILURE, modList);
+            totalProgressCallback(0, combo.getMod().getName(), StatusEnum.FAILURE, modList);
+            throw modList;
         }
 
-        let dependencies: ThunderstoreCombo[] = [];
-        await this.buildDependencySet(modVersion, dependencies, DependencySetBuilderMode.USE_EXACT_VERSION);
-        this.sortDependencyOrder(dependencies);
-        const combo = new ThunderstoreCombo();
-        combo.setMod(mod);
-        combo.setVersion(modVersion);
-
-        dependencies = await this.determineDependencyVersions(dependencies, combo, modVersion, modList);
-        let downloadableDependencySize = this.calculateInitialDownloadSize(dependencies);
+        const dependencies = await this.getDependenciesWithCorrectVersions(combo, modList);
+        const allModsToDownload = [...dependencies, combo];
 
         let downloadCount = 0;
-        await this.downloadAndSave(combo, ignoreCache, async (progress: number, status: number, err: R2Error | null) => {
+        const singleModProgressCallback = (progress: number, status: number, err: R2Error | null) => {
             if (status === StatusEnum.FAILURE) {
-                callback(0, mod.getName(), status, err);
-            } else if (status === StatusEnum.PENDING) {
-                callback(this.generateProgressPercentage(progress, downloadCount, downloadableDependencySize + 1), mod.getName(), status, err);
+                throw err;
+            }
+
+            let totalProgress: number;
+            if (status === StatusEnum.PENDING) {
+                totalProgress = this.generateProgressPercentage(progress, downloadCount, allModsToDownload.length);
             } else if (status === StatusEnum.SUCCESS) {
+                totalProgress = this.generateProgressPercentage(100, downloadCount, allModsToDownload.length);
                 downloadCount += 1;
-                // If no dependencies, end here.
-                if (dependencies.length === 0) {
-                    callback(100, mod.getName(), StatusEnum.PENDING, err);
-                    completedCallback([combo]);
-                    return;
-                }
+            } else {
+                console.error(`Ignore unknown status code "${status}"`);
+                return;
+            }
+            totalProgressCallback(totalProgress, combo.getMod().getName(), status, err);
+        }
 
-                // If dependencies, queue and download.
-                await this.queueDownloadDependencies(dependencies.entries(), ignoreCache, (progress: number, modName: string, status: number, err: R2Error | null) => {
-                    if (status === StatusEnum.FAILURE) {
-                        callback(0, modName, status, err);
-                    } else if (status === StatusEnum.PENDING) {
-                        callback(this.generateProgressPercentage(progress, downloadCount, downloadableDependencySize + 1), modName, status, err);
-                    } else if (status === StatusEnum.SUCCESS) {
-                        callback(this.generateProgressPercentage(progress, downloadCount, downloadableDependencySize + 1), modName, StatusEnum.PENDING, err);
-                        downloadCount += 1;
-                        if (downloadCount >= dependencies.length + 1) {
-                            callback(100, modName, StatusEnum.PENDING, err);
-                            completedCallback([...dependencies, combo]);
-                        }
-                    }
-                });
+        for (const combo of allModsToDownload) {
+            if (!ignoreCache && await this.isVersionAlreadyDownloaded(combo)) {
+                totalProgressCallback(100, combo.getMod().getName(), StatusEnum.SUCCESS, null);
+                continue;
             }
-        })
+
+            try {
+                const response = await this._downloadCombo(combo, singleModProgressCallback);
+                await this._saveDownloadResponse(response, combo, singleModProgressCallback);
+            } catch(e) {
+                throw R2Error.fromThrownValue(e, `Failed to download mod ${combo.getVersion().getFullName()}`);
+            }
+        }
+        return allModsToDownload;
     }
 
     // If combo is a modpack, use the modpack's dependency versions. If it isn't, get the latest versions.
-    public async determineDependencyVersions(dependencies: ThunderstoreCombo[], combo: ThunderstoreCombo, modVersion: ThunderstoreVersion, modList: ManifestV2[]) {
-        let isModpack = combo.getMod().getCategories().find(value => value === "Modpacks") !== undefined;
-        if (isModpack) {
-            return dependencies;
-        }
-        dependencies = [];
-        await this.buildDependencySet(modVersion, dependencies, DependencySetBuilderMode.USE_LATEST_VERSION);
+    private async getDependenciesWithCorrectVersions(combo: ThunderstoreCombo, modList: ManifestV2[]) {
+        const dependencies: ThunderstoreCombo[] = [];
+        const isModpack = combo.getMod().getCategories().some(value => value === "Modpacks");
+        const versionMode = isModpack ? DependencySetBuilderMode.USE_EXACT_VERSION : DependencySetBuilderMode.USE_LATEST_VERSION;
+
+        await this.buildDependencySet(combo.getVersion(), dependencies, versionMode);
         this.sortDependencyOrder(dependencies);
         // #270: Remove already-installed dependencies to prevent updating.
-        return dependencies.filter(dep => modList.find(installed => installed.getName() === dep.getMod().getFullName()) === undefined);
+        return dependencies.filter((dep) => {
+            return !(modList.some(installed => installed.getName() === dep.getMod().getFullName()));
+        });
     }
 
     public async downloadImportedMods(