From 44583f739af9db81751655f7391757a28e949239 Mon Sep 17 00:00:00 2001 From: Jan Date: Mon, 24 Jul 2023 13:51:34 +0200 Subject: chore: Store `game_path` and `install_type` as `GameInstall` in store (#445) We pass the `GameInstall` object to backend on most calls, yet we store the parameters individually in frontend. This PR resolves that by storing the whole object instead of individual parameters, simplifying a lot of the code that calls the backend. * chore: Store game_path and install_type as GameInstall in store * Add missed uses of old attributes * fix: Update missed attribute in DevView * fix: Update missed attribute in SettingsView * refactor: Update functions to use new object in RepairView * Initialize game_install as empty object --------- Co-authored-by: GeckoEidechse --- src-vue/src/components/LocalModCard.vue | 15 +------- src-vue/src/components/ThunderstoreModCard.vue | 15 +------- src-vue/src/plugins/modules/pull_requests.ts | 4 +- src-vue/src/plugins/store.ts | 53 ++++++++------------------ src-vue/src/views/DeveloperView.vue | 22 ++--------- src-vue/src/views/RepairView.vue | 26 ++----------- src-vue/src/views/SettingsView.vue | 4 +- 7 files changed, 31 insertions(+), 108 deletions(-) diff --git a/src-vue/src/components/LocalModCard.vue b/src-vue/src/components/LocalModCard.vue index dd3629f8..f8d0256d 100644 --- a/src-vue/src/components/LocalModCard.vue +++ b/src-vue/src/components/LocalModCard.vue @@ -30,7 +30,6 @@ import { defineComponent } from "vue"; import { invoke } from "@tauri-apps/api"; import { NorthstarMod } from "../../../src-tauri/bindings/NorthstarMod"; -import { GameInstall } from "../utils/GameInstall"; import { showErrorNotification, showNotification } from "../utils/ui"; export default defineComponent({ @@ -50,16 +49,10 @@ export default defineComponent({ async updateWhichModsEnabled(mod: NorthstarMod) { this.global_load_indicator = true; - // Setup up struct - let game_install = { - game_path: this.$store.state.game_path, - install_type: this.$store.state.install_type - } as GameInstall; - // enable/disable specific mod try { await invoke("set_mod_enabled_status", { - gameInstall: game_install, + gameInstall: this.$store.state.game_install, modName: mod.name, // Need to set it to the opposite of current state, // as current state is only updated after command is run @@ -76,11 +69,7 @@ export default defineComponent({ return true; }, async deleteMod(mod: NorthstarMod) { - let game_install = { - game_path: this.$store.state.game_path, - install_type: this.$store.state.install_type - } as GameInstall; - await invoke("delete_northstar_mod", { gameInstall: game_install, nsmodName: mod.name }) + await invoke("delete_northstar_mod", { gameInstall: this.$store.state.game_install, nsmodName: mod.name }) .then((message) => { // Just a visual indicator that it worked showNotification(this.$t('mods.local.success_deleting', { modName: mod.name })); diff --git a/src-vue/src/components/ThunderstoreModCard.vue b/src-vue/src/components/ThunderstoreModCard.vue index 2fbbac40..30ffbc68 100644 --- a/src-vue/src/components/ThunderstoreModCard.vue +++ b/src-vue/src/components/ThunderstoreModCard.vue @@ -71,7 +71,6 @@ import { ThunderstoreModVersion } from "../../../src-tauri/bindings/Thunderstore import { invoke, shell } from "@tauri-apps/api"; import { ThunderstoreModStatus } from "../utils/thunderstore/ThunderstoreModStatus"; import { NorthstarMod } from "../../../src-tauri/bindings/NorthstarMod"; -import { GameInstall } from "../utils/GameInstall"; import { NorthstarState } from "../utils/NorthstarState"; import { ElMessageBox } from "element-plus"; import { showErrorNotification, showNotification } from "../utils/ui"; @@ -217,12 +216,7 @@ export default defineComponent({ } ) .then(async () => { // Deletion confirmed - let game_install = { - game_path: this.$store.state.game_path, - install_type: this.$store.state.install_type - } as GameInstall; - - await invoke("delete_thunderstore_mod", { gameInstall: game_install, thunderstoreModString: this.latestVersion.full_name }) + await invoke("delete_thunderstore_mod", { gameInstall: this.$store.state.game_install, thunderstoreModString: this.latestVersion.full_name }) .then((message) => { showNotification(this.$t('mods.card.remove_success', { modName: mod.name }), message); }) @@ -239,11 +233,6 @@ export default defineComponent({ }, async installMod(mod: ThunderstoreMod) { - let game_install = { - game_path: this.$store.state.game_path, - install_type: this.$store.state.install_type - } as GameInstall; - // set internal state according to current installation state if (this.modStatus === ThunderstoreModStatus.OUTDATED) { this.isBeingUpdated = true; @@ -254,7 +243,7 @@ export default defineComponent({ // Capture translation method in a context, so it can be used outside Vue component context. // (see https://github.com/R2NorthstarTools/FlightCore/issues/384) (async (translate: Function) => { - await invoke("install_mod_caller", { gameInstall: game_install, thunderstoreModString: this.latestVersion.full_name }).then((message) => { + await invoke("install_mod_caller", { gameInstall: this.$store.state.game_install, thunderstoreModString: this.latestVersion.full_name }).then((message) => { showNotification(translate('mods.card.install_success', { modName: mod.name }), message); }) .catch((error) => { diff --git a/src-vue/src/plugins/modules/pull_requests.ts b/src-vue/src/plugins/modules/pull_requests.ts index 57d5fa07..3f3ba259 100644 --- a/src-vue/src/plugins/modules/pull_requests.ts +++ b/src-vue/src/plugins/modules/pull_requests.ts @@ -54,7 +54,7 @@ export const pullRequestModule = { // Send notification telling the user to wait for the process to finish const notification = showNotification(`Installing launcher PR ${pull_request.number}`, 'Please wait', 'info', 0); - await invoke("apply_launcher_pr", { pullRequest: pull_request, gameInstallPath: store.state.game_path }) + await invoke("apply_launcher_pr", { pullRequest: pull_request, gameInstallPath: store.state.game_install.game_path }) .then((message) => { console.log(message); // Show user notification if mod install completed. @@ -72,7 +72,7 @@ export const pullRequestModule = { // Send notification telling the user to wait for the process to finish const notification = showNotification(`Installing mods PR ${pull_request.number}`, 'Please wait', 'info', 0); - await invoke("apply_mods_pr", { pullRequest: pull_request, gameInstallPath: store.state.game_path }) + await invoke("apply_mods_pr", { pullRequest: pull_request, gameInstallPath: store.state.game_install.game_path }) .then((message) => { // Show user notification if mod install completed. showNotification( diff --git a/src-vue/src/plugins/store.ts b/src-vue/src/plugins/store.ts index e7dc0763..76a33b48 100644 --- a/src-vue/src/plugins/store.ts +++ b/src-vue/src/plugins/store.ts @@ -25,8 +25,7 @@ const persistentStore = new Store('flight-core-settings.json'); export interface FlightCoreStore { developer_mode: boolean, - game_path: string, - install_type: InstallType, + game_install: GameInstall, flightcore_version: string, @@ -61,8 +60,7 @@ export const store = createStore({ state(): FlightCoreStore { return { developer_mode: false, - game_path: undefined as unknown as string, - install_type: undefined as unknown as InstallType, + game_install: {} as unknown as GameInstall, flightcore_version: "", @@ -133,7 +131,7 @@ export const store = createStore({ // Verify if valid Titanfall2 install location let is_valid_titanfall2_install = await invoke("verify_install_location", { gamePath: selected }) as boolean; if (is_valid_titanfall2_install) { - state.game_path = selected; + state.game_install.game_path = selected; showNotification( i18n.global.tc('notification.game_folder.new.title'), i18n.global.tc('notification.game_folder.new.text') @@ -144,15 +142,10 @@ export const store = createStore({ catch { console.warn("Nothing to close"); } - state.install_type = InstallType.UNKNOWN; - - let game_install = { - game_path: selected, - install_type: InstallType.UNKNOWN - } as GameInstall; + state.game_install.install_type = InstallType.UNKNOWN; // Save change in persistent store - await persistentStore.set('game-install', { value: game_install }); + await persistentStore.set('game-install', { value: state.game_install }); await persistentStore.save(); // explicit save to disk // Check for Northstar install @@ -168,13 +161,8 @@ export const store = createStore({ } }, async launchGame(state: any, no_checks = false) { - let game_install = { - game_path: state.game_path, - install_type: state.install_type - } as GameInstall; - if (no_checks) { - await invoke("launch_northstar", { gameInstall: game_install, bypassChecks: no_checks }) + await invoke("launch_northstar", { gameInstall: state.game_install, bypassChecks: no_checks }) .then((message) => { console.log("Launched with bypassed checks"); console.log(message); @@ -191,7 +179,7 @@ export const store = createStore({ switch (state.northstar_state) { // Install northstar if it wasn't detected. case NorthstarState.INSTALL: - let install_northstar_result = invoke("install_northstar_caller", { gamePath: state.game_path, northstarPackageName: state.northstar_release_canal }); + let install_northstar_result = invoke("install_northstar_caller", { gamePath: state.game_install.game_path, northstarPackageName: state.northstar_release_canal }); state.northstar_state = NorthstarState.INSTALLING; await install_northstar_result.then((message) => { @@ -208,7 +196,7 @@ export const store = createStore({ // Update northstar if it is outdated. case NorthstarState.MUST_UPDATE: // Updating is the same as installing, simply overwrites the existing files - let reinstall_northstar_result = invoke("install_northstar_caller", { gamePath: state.game_path, northstarPackageName: state.northstar_release_canal }); + let reinstall_northstar_result = invoke("install_northstar_caller", { gamePath: state.game_install.game_path, northstarPackageName: state.northstar_release_canal }); state.northstar_state = NorthstarState.UPDATING; await reinstall_northstar_result.then((message) => { @@ -224,7 +212,7 @@ export const store = createStore({ // Game is ready to play. case NorthstarState.READY_TO_PLAY: - await invoke("launch_northstar", { gameInstall: game_install }) + await invoke("launch_northstar", { gameInstall: state.game_install }) .then((message) => { console.log(message); // NorthstarState.RUNNING @@ -241,12 +229,7 @@ export const store = createStore({ } }, async launchGameSteam(state: any, no_checks = false) { - let game_install = { - game_path: state.game_path, - install_type: state.install_type - } as GameInstall; - - await invoke("launch_northstar_steam", { gameInstall: game_install, bypassChecks: no_checks }) + await invoke("launch_northstar_steam", { gameInstall: state.game_install, bypassChecks: no_checks }) .then((message) => { showNotification('Success'); }) @@ -295,19 +278,14 @@ export const store = createStore({ .sort(); }, async loadInstalledMods(state: FlightCoreStore) { - let game_install = { - game_path: state.game_path, - install_type: state.install_type - } as GameInstall; - // If there's no game path, prevent looking for installed mods. - if (state.game_path === undefined) { + if (state.game_install.game_path === undefined) { console.warn('Cannot load installed mods since so game path is selected.'); return; } // Call back-end for installed mods - await invoke("get_installed_mods_and_properties", { gameInstall: game_install }) + await invoke("get_installed_mods_and_properties", { gameInstall: state.game_install }) .then((message) => { state.installed_mods = (message as NorthstarMod[]); }) @@ -425,8 +403,7 @@ async function _initializeApp(state: any) { await persistentStore.save(); // explicit save to disk // Update UI store - state.game_path = typedResult.game_path; - state.install_type = typedResult.install_type; + state.game_install = typedResult; // Check installed Northstar version if found await _get_northstar_version_number(state); @@ -482,13 +459,13 @@ function _initializeListeners(state: any) { * state, for it to be displayed in UI. */ async function _get_northstar_version_number(state: any) { - await invoke("get_northstar_version_number", { gamePath: state.game_path }) + await invoke("get_northstar_version_number", { gamePath: state.game_install.game_path }) .then((message) => { let northstar_version_number: string = message as string; state.installed_northstar_version = northstar_version_number; state.northstar_state = NorthstarState.READY_TO_PLAY; - invoke("check_is_northstar_outdated", { gamePath: state.game_path, northstarPackageName: state.northstar_release_canal }) + invoke("check_is_northstar_outdated", { gamePath: state.game_install.game_path, northstarPackageName: state.northstar_release_canal }) .then((message) => { if (message) { state.northstar_state = NorthstarState.MUST_UPDATE; diff --git a/src-vue/src/views/DeveloperView.vue b/src-vue/src/views/DeveloperView.vue index 28ab3892..e95154f1 100644 --- a/src-vue/src/views/DeveloperView.vue +++ b/src-vue/src/views/DeveloperView.vue @@ -132,7 +132,6 @@