Add return value for api functions

Jack251970 · Jack251970 · commit ce6c2cb1b205 · 2025-07-01T09:05:21.000+08:00
diff --git a/Flow.Launcher.Core/Plugin/PluginInstaller.cs b/Flow.Launcher.Core/Plugin/PluginInstaller.cs
@@ -74,7 +74,10 @@ await DownloadFileAsync(
                 throw new FileNotFoundException($"Plugin {newPlugin.ID} zip file not found at {filePath}", filePath);
             }
 
-            API.InstallPlugin(newPlugin, filePath);
+            if (!API.InstallPlugin(newPlugin, filePath))
+            {
+                return;
+            }
 
             if (!newPlugin.IsFromLocalInstallPath)
             {
@@ -167,7 +170,10 @@ public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldP
 
         try
         {
-            await API.UninstallPluginAsync(oldPlugin, removePluginSettings);
+            if (!await API.UninstallPluginAsync(oldPlugin, removePluginSettings))
+            {
+                return;
+            }
         }
         catch (Exception e)
         {
@@ -223,7 +229,10 @@ await DownloadFileAsync(
                 return;
             }
 
-            await API.UpdatePluginAsync(oldPlugin, newPlugin, filePath);
+            if (!await API.UpdatePluginAsync(oldPlugin, newPlugin, filePath))
+            {
+                return;
+            }
         }
         catch (Exception e)
         {
diff --git a/Flow.Launcher.Core/Plugin/PluginManager.cs b/Flow.Launcher.Core/Plugin/PluginManager.cs
@@ -540,22 +540,24 @@ public static bool PluginModified(string id)
             return _modifiedPlugins.Contains(id);
         }
 
-        public static async Task UpdatePluginAsync(PluginMetadata existingVersion, UserPlugin newVersion, string zipFilePath)
+        public static async Task<bool> UpdatePluginAsync(PluginMetadata existingVersion, UserPlugin newVersion, string zipFilePath)
         {
             var installSuccess = InstallPlugin(newVersion, zipFilePath, checkModified:false);
-            if (!installSuccess) return;
-            await UninstallPluginAsync(existingVersion, removePluginFromSettings:false, removePluginSettings:false, checkModified: false);
+            if (!installSuccess) return false;
+            var uninstallSuccess = await UninstallPluginAsync(existingVersion, removePluginFromSettings:false, removePluginSettings:false, checkModified: false);
+            if (!uninstallSuccess) return false;
             _modifiedPlugins.Add(existingVersion.ID);
+            return true;
         }
 
-        public static void InstallPlugin(UserPlugin plugin, string zipFilePath)
+        public static bool InstallPlugin(UserPlugin plugin, string zipFilePath)
         {
-            InstallPlugin(plugin, zipFilePath, checkModified: true);
+            return InstallPlugin(plugin, zipFilePath, checkModified: true);
         }
 
-        public static async Task UninstallPluginAsync(PluginMetadata plugin, bool removePluginFromSettings = true, bool removePluginSettings = false)
+        public static async Task<bool> UninstallPluginAsync(PluginMetadata plugin, bool removePluginFromSettings = true, bool removePluginSettings = false)
         {
-            await UninstallPluginAsync(plugin, removePluginFromSettings, removePluginSettings, true);
+            return await UninstallPluginAsync(plugin, removePluginFromSettings, removePluginSettings, true);
         }
 
         #endregion
diff --git a/Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs b/Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs
@@ -547,8 +547,10 @@ public interface IPublicAPI
         /// <param name="zipFilePath">
         /// Path to the zip file containing the plugin. It will be unzipped to the temporary directory, removed and installed.
         /// </param>
-        /// <returns></returns>
-        public Task UpdatePluginAsync(PluginMetadata pluginMetadata, UserPlugin plugin, string zipFilePath);
+        /// <returns>
+        /// True if the plugin is updated successfully, false otherwise.
+        /// </returns>
+        public Task<bool> UpdatePluginAsync(PluginMetadata pluginMetadata, UserPlugin plugin, string zipFilePath);
 
         /// <summary>
         /// Install a plugin. By default will remove the zip file if installation is from url,
@@ -558,7 +560,10 @@ public interface IPublicAPI
         /// <param name="zipFilePath">
         /// Path to the zip file containing the plugin. It will be unzipped to the temporary directory, removed and installed.
         /// </param>
-        public void InstallPlugin(UserPlugin plugin, string zipFilePath);
+        /// <returns>
+        /// True if the plugin is installed successfully, false otherwise.
+        /// </returns>
+        public bool InstallPlugin(UserPlugin plugin, string zipFilePath);
 
         /// <summary>
         /// Uninstall a plugin
@@ -567,8 +572,10 @@ public interface IPublicAPI
         /// <param name="removePluginSettings">
         /// Plugin has their own settings. If this is set to true, the plugin settings will be removed.
         /// </param>
-        /// <returns></returns>
-        public Task UninstallPluginAsync(PluginMetadata pluginMetadata, bool removePluginSettings = false);
+        /// <returns>
+        /// True if the plugin is updated successfully, false otherwise.
+        /// </returns>
+        public Task<bool> UninstallPluginAsync(PluginMetadata pluginMetadata, bool removePluginSettings = false);
 
         /// <summary>
         /// Log debug message of the time taken to execute a method
diff --git a/Flow.Launcher/PublicAPIInstance.cs b/Flow.Launcher/PublicAPIInstance.cs
@@ -566,13 +566,13 @@ public Task<bool> UpdatePluginManifestAsync(bool usePrimaryUrlOnly = false, Canc
 
         public bool PluginModified(string id) => PluginManager.PluginModified(id);
 
-        public Task UpdatePluginAsync(PluginMetadata pluginMetadata, UserPlugin plugin, string zipFilePath) =>
+        public Task<bool> UpdatePluginAsync(PluginMetadata pluginMetadata, UserPlugin plugin, string zipFilePath) =>
             PluginManager.UpdatePluginAsync(pluginMetadata, plugin, zipFilePath);
 
-        public void InstallPlugin(UserPlugin plugin, string zipFilePath) =>
+        public bool InstallPlugin(UserPlugin plugin, string zipFilePath) =>
             PluginManager.InstallPlugin(plugin, zipFilePath);
 
-        public Task UninstallPluginAsync(PluginMetadata pluginMetadata, bool removePluginSettings = false) =>
+        public Task<bool> UninstallPluginAsync(PluginMetadata pluginMetadata, bool removePluginSettings = false) =>
             PluginManager.UninstallPluginAsync(pluginMetadata, removePluginSettings);
 
         public long StopwatchLogDebug(string className, string message, Action action, [CallerMemberName] string methodName = "") =>
diff --git a/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs b/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs
@@ -352,8 +352,11 @@ await DownloadFileAsync(
                                     }
                                     else
                                     {
-                                        await Context.API.UpdatePluginAsync(x.PluginExistingMetadata, x.PluginNewUserPlugin,
-                                            downloadToFilePath);
+                                        if (!await Context.API.UpdatePluginAsync(x.PluginExistingMetadata, x.PluginNewUserPlugin,
+                                            downloadToFilePath))
+                                        {
+                                            return;
+                                        }
 
                                         if (Settings.AutoRestartAfterChanging)
                                         {
@@ -456,8 +459,9 @@ await DownloadFileAsync(
                                 if (cts.IsCancellationRequested)
                                     return;
                                 else
-                                    await Context.API.UpdatePluginAsync(plugin.PluginExistingMetadata, plugin.PluginNewUserPlugin,
-                                        downloadToFilePath);
+                                    if (!await Context.API.UpdatePluginAsync(plugin.PluginExistingMetadata, plugin.PluginNewUserPlugin,
+                                        downloadToFilePath))
+                                       return;
                             }
                             catch (Exception ex)
                             {
@@ -686,7 +690,8 @@ private void Install(UserPlugin plugin, string downloadedFilePath)
 
             try
             {
-                Context.API.InstallPlugin(plugin, downloadedFilePath);
+                if (!Context.API.InstallPlugin(plugin, downloadedFilePath))
+                    return;
 
                 if (!plugin.IsFromLocalInstallPath)
                     File.Delete(downloadedFilePath);
@@ -779,7 +784,10 @@ private async Task UninstallAsync(PluginMetadata plugin)
                     Context.API.GetTranslation("plugin_pluginsmanager_keep_plugin_settings_subtitle"),
                     Context.API.GetTranslation("plugin_pluginsmanager_keep_plugin_settings_title"),
                     button: MessageBoxButton.YesNo) == MessageBoxResult.No;
-                await Context.API.UninstallPluginAsync(plugin, removePluginSettings);
+                if (!await Context.API.UninstallPluginAsync(plugin, removePluginSettings))
+                {
+                    return;
+                }
             }
             catch (ArgumentException e)
             {

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,10 @@ await DownloadFileAsync(`
`74`	`74`	`throw new FileNotFoundException($"Plugin {newPlugin.ID} zip file not found at {filePath}", filePath);`
`75`	`75`	`}`
`76`	`76`
`77`		`- API.InstallPlugin(newPlugin, filePath);`
	`77`	`+ if (!API.InstallPlugin(newPlugin, filePath))`
	`78`	`+ {`
	`79`	`+ return;`
	`80`	`+ }`
`78`	`81`
`79`	`82`	`if (!newPlugin.IsFromLocalInstallPath)`
`80`	`83`	`{`
`@@ -167,7 +170,10 @@ public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldP`
`167`	`170`
`168`	`171`	`try`
`169`	`172`	`{`
`170`		`- await API.UninstallPluginAsync(oldPlugin, removePluginSettings);`
	`173`	`+ if (!await API.UninstallPluginAsync(oldPlugin, removePluginSettings))`
	`174`	`+ {`
	`175`	`+ return;`
	`176`	`+ }`
`171`	`177`	`}`
`172`	`178`	`catch (Exception e)`
`173`	`179`	`{`
`@@ -223,7 +229,10 @@ await DownloadFileAsync(`
`223`	`229`	`return;`
`224`	`230`	`}`
`225`	`231`
`226`		`- await API.UpdatePluginAsync(oldPlugin, newPlugin, filePath);`
	`232`	`+ if (!await API.UpdatePluginAsync(oldPlugin, newPlugin, filePath))`
	`233`	`+ {`
	`234`	`+ return;`
	`235`	`+ }`
`227`	`236`	`}`
`228`	`237`	`catch (Exception e)`
`229`	`238`	`{`
Original file line number	Diff line number	Diff line change
`@@ -540,22 +540,24 @@ public static bool PluginModified(string id)`
`540`	`540`	`return _modifiedPlugins.Contains(id);`
`541`	`541`	`}`
`542`	`542`
`543`		`- public static async Task UpdatePluginAsync(PluginMetadata existingVersion, UserPlugin newVersion, string zipFilePath)`
	`543`	`+ public static async Task<bool> UpdatePluginAsync(PluginMetadata existingVersion, UserPlugin newVersion, string zipFilePath)`
`544`	`544`	`{`
`545`	`545`	`var installSuccess = InstallPlugin(newVersion, zipFilePath, checkModified:false);`
`546`		`- if (!installSuccess) return;`
`547`		`- await UninstallPluginAsync(existingVersion, removePluginFromSettings:false, removePluginSettings:false, checkModified: false);`
	`546`	`+ if (!installSuccess) return false;`
	`547`	`+ var uninstallSuccess = await UninstallPluginAsync(existingVersion, removePluginFromSettings:false, removePluginSettings:false, checkModified: false);`
	`548`	`+ if (!uninstallSuccess) return false;`
`548`	`549`	`_modifiedPlugins.Add(existingVersion.ID);`
	`550`	`+ return true;`
`549`	`551`	`}`
`550`	`552`
`551`		`- public static void InstallPlugin(UserPlugin plugin, string zipFilePath)`
	`553`	`+ public static bool InstallPlugin(UserPlugin plugin, string zipFilePath)`
`552`	`554`	`{`
`553`		`- InstallPlugin(plugin, zipFilePath, checkModified: true);`
	`555`	`+ return InstallPlugin(plugin, zipFilePath, checkModified: true);`
`554`	`556`	`}`
`555`	`557`
`556`		`- public static async Task UninstallPluginAsync(PluginMetadata plugin, bool removePluginFromSettings = true, bool removePluginSettings = false)`
	`558`	`+ public static async Task<bool> UninstallPluginAsync(PluginMetadata plugin, bool removePluginFromSettings = true, bool removePluginSettings = false)`
`557`	`559`	`{`
`558`		`- await UninstallPluginAsync(plugin, removePluginFromSettings, removePluginSettings, true);`
	`560`	`+ return await UninstallPluginAsync(plugin, removePluginFromSettings, removePluginSettings, true);`
`559`	`561`	`}`
`560`	`562`
`561`	`563`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -352,8 +352,11 @@ await DownloadFileAsync(`
`352`	`352`	`}`
`353`	`353`	`else`
`354`	`354`	`{`
`355`		`- await Context.API.UpdatePluginAsync(x.PluginExistingMetadata, x.PluginNewUserPlugin,`
`356`		`- downloadToFilePath);`
	`355`	`+ if (!await Context.API.UpdatePluginAsync(x.PluginExistingMetadata, x.PluginNewUserPlugin,`
	`356`	`+ downloadToFilePath))`
	`357`	`+ {`
	`358`	`+ return;`
	`359`	`+ }`
`357`	`360`
`358`	`361`	`if (Settings.AutoRestartAfterChanging)`
`359`	`362`	`{`
`@@ -456,8 +459,9 @@ await DownloadFileAsync(`
`456`	`459`	`if (cts.IsCancellationRequested)`
`457`	`460`	`return;`
`458`	`461`	`else`
`459`		`- await Context.API.UpdatePluginAsync(plugin.PluginExistingMetadata, plugin.PluginNewUserPlugin,`
`460`		`- downloadToFilePath);`
	`462`	`+ if (!await Context.API.UpdatePluginAsync(plugin.PluginExistingMetadata, plugin.PluginNewUserPlugin,`
	`463`	`+ downloadToFilePath))`
	`464`	`+ return;`
`461`	`465`	`}`
`462`	`466`	`catch (Exception ex)`
`463`	`467`	`{`
`@@ -686,7 +690,8 @@ private void Install(UserPlugin plugin, string downloadedFilePath)`
`686`	`690`
`687`	`691`	`try`
`688`	`692`	`{`
`689`		`- Context.API.InstallPlugin(plugin, downloadedFilePath);`
	`693`	`+ if (!Context.API.InstallPlugin(plugin, downloadedFilePath))`
	`694`	`+ return;`
`690`	`695`
`691`	`696`	`if (!plugin.IsFromLocalInstallPath)`
`692`	`697`	`File.Delete(downloadedFilePath);`
`@@ -779,7 +784,10 @@ private async Task UninstallAsync(PluginMetadata plugin)`
`779`	`784`	`Context.API.GetTranslation("plugin_pluginsmanager_keep_plugin_settings_subtitle"),`
`780`	`785`	`Context.API.GetTranslation("plugin_pluginsmanager_keep_plugin_settings_title"),`
`781`	`786`	`button: MessageBoxButton.YesNo) == MessageBoxResult.No;`
`782`		`- await Context.API.UninstallPluginAsync(plugin, removePluginSettings);`
	`787`	`+ if (!await Context.API.UninstallPluginAsync(plugin, removePluginSettings))`
	`788`	`+ {`
	`789`	`+ return;`
	`790`	`+ }`
`783`	`791`	`}`
`784`	`792`	`catch (ArgumentException e)`
`785`	`793`	`{`