feat: add a new hook PreUninstall

This is called before the SDK is uninstalled. If the plugin needs to perform some operations before uninstalling, it can implement this hook function. For example, cleaning up the cache, deleting configuration files, etc. fix #208
version-fox · Apr 22, 2024 · adf1767 · adf1767
1 parent 08ab162
commit adf1767
Show file tree

Hide file tree

Showing 8 changed files with 132 additions and 8 deletions.
diff --git a/docs/plugins/create/howto.md b/docs/plugins/create/howto.md
@@ -44,6 +44,7 @@ The full list of hooks callable from vfox.
 | [hooks/post_install.lua](#postinstall)          | ❌            | Execute additional operations after install, such as compiling source code, etc |
 | [hooks/pre_use.lua](#preuse)                    | ❌            | An opportunity to change the version before using it                            |
 | [hooks/parse_legacy_file.lua](#parselegacyfile) | ❌            | Custom parser for legacy version files                                          |
+| [hooks/pre_uninstall.lua](#preuninstall)        | ❌            | Perform some operations before uninstalling targeted version                    |
 
 ## Required hook functions
 
@@ -237,6 +238,26 @@ function PLUGIN:ParseLegacyFile(ctx)
 end
 ```
 
+### PreUninstall <Badge type="tip" text=">= 0.4.0" vertical="middle" />
+
+This is called before the SDK is uninstalled. If the plugin needs to perform some operations before
+uninstalling, it can implement this hook function. For example, cleaning up the cache, deleting configuration files, etc.
+
+**Location**: `hooks/pre_uninstall.lua`
+```lua 
+function PLUGIN:PreUninstall(ctx)
+    local mainSdkInfo = ctx.main
+    local mainPath = mainSdkInfo.path
+    local mversion = mainSdkInfo.version
+    local mname = mainSdkInfo.name
+    --- Other SDK information, the `addition` field returned in PreInstall, obtained by name
+    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local path = sdkInfo.path
+    local version = sdkInfo.version
+    local name = sdkInfo.name
+end
+```
+
 ## Test Plugin
 
 Currently, VersionFox plugin testing is straightforward. You only need to place the plugin file in the

diff --git a/docs/zh-hans/plugins/create/howto.md b/docs/zh-hans/plugins/create/howto.md
@@ -44,6 +44,7 @@
 | [hooks/post_install.lua](#postinstall)          | ❌      | 执行额外的操作, 如编译源码等      |
 | [hooks/pre_use.lua](#preuse)                    | ❌      | 在切换版本之前, 提供修改版本的机会   |
 | [hooks/parse_legacy_file.lua](#parselegacyfile) | ❌      | 自定义解析遗留文件            |
+| [hooks/pre_uninstall.lua](#preuninstall)        | ❌      | 删除之前进行额外操作           |
 
 ## 必须实现的钩子函数
 
@@ -114,8 +115,10 @@ end
 **位置**: `hooks/env_keys.lua`
 ```lua
 function PLUGIN:EnvKeys(ctx)
-    --- this variable is same as ctx.sdkInfo['plugin-name'].path
-    local mainPath = ctx.path
+    local mainSdkInfo = ctx.main
+    local mainPath = mainSdkInfo.path
+    local mversion = mainSdkInfo.version
+    local mname = mainSdkInfo.name
     local sdkInfo = ctx.sdkInfo['sdk-name']
     local path = sdkInfo.path
     local version = sdkInfo.version
@@ -225,6 +228,24 @@ function PLUGIN:ParseLegacyFile(ctx)
 end
 ```
 
+### PreUninstall <Badge type="tip" text=">= 0.4.0" vertical="middle" />
+
+在卸载 SDK 之前执行的钩子函数。如果插件需要在卸载之前执行一些操作，可以实现这个钩子函数。例如清理缓存、删除配置文件等。
+
+**位置**: `hooks/pre_uninstall.lua`
+```lua 
+function PLUGIN:PreUninstall(ctx)
+    local mainSdkInfo = ctx.main
+    local mainPath = mainSdkInfo.path
+    local mversion = mainSdkInfo.version
+    local mname = mainSdkInfo.name
+    --- 其他 SDK 信息, PreInstall中返回的`addition`字段, 通过name获取
+    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local path = sdkInfo.path
+    local version = sdkInfo.version
+    local name = sdkInfo.name
+end
+```
 
 ## 测试插件
 

diff --git a/internal/interfaces.go b/internal/interfaces.go
@@ -165,6 +165,11 @@ type ParseLegacyFileResult struct {
 	Version string `luai:"version"`
 }
 
+type PreUninstallHookCtx struct {
+	Main    *Info            `luai:"main"`
+	SdkInfo map[string]*Info `luai:"sdkInfo"`
+}
+
 type LuaPluginInfo struct {
 	Name              string   `luai:"name"`
 	Version           string   `luai:"version"`

diff --git a/internal/plugin.go b/internal/plugin.go
@@ -378,6 +378,36 @@ func (l *LuaPlugin) ParseLegacyFile(path string, installedVersions func() []Vers
 
 }
 
+// PreUninstall executes the PreUninstall hook function.
+func (l *LuaPlugin) PreUninstall(p *Package) error {
+	if !l.HasFunction("PreUninstall") {
+		logger.Debug("plugin does not have PreUninstall function")
+		return nil
+	}
+
+	L := l.vm.Instance
+
+	ctx := &PreUninstallHookCtx{
+		Main:    p.Main,
+		SdkInfo: make(map[string]*Info),
+	}
+	logger.Debugf("PreUninstallHookCtx: %+v \n", ctx)
+
+	for _, v := range p.Additions {
+		ctx.SdkInfo[v.Name] = v
+	}
+
+	ctxTable, err := luai.Marshal(L, ctx)
+	if err != nil {
+		return err
+	}
+
+	if err = l.CallFunction("PreUninstall", ctxTable); err != nil {
+		return err
+	}
+	return nil
+}
+
 func (l *LuaPlugin) CallFunction(funcName string, args ...lua.LValue) error {
 	logger.Debugf("CallFunction: %s\n", funcName)
 	if err := l.vm.CallFunction(l.pluginObj.RawGetString(funcName), append([]lua.LValue{l.pluginObj}, args...)...); err != nil {

diff --git a/internal/plugin_test.go b/internal/plugin_test.go
@@ -325,4 +325,31 @@ func testHookFunc(t *testing.T, factory func() (*LuaPlugin, error)) {
 		}
 
 	})
+
+	t.Run("PreUninstall", func(t *testing.T) {
+		plugin, err := factory()
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		err = plugin.PreUninstall(&Package{
+			Main: &Info{
+				Name:    "java",
+				Version: "1.0.0",
+				Path:    "/path/to/java",
+				Note:    "xxxx",
+			},
+			Additions: []*Info{
+				{
+					Name:    "sdk-name",
+					Version: "9.0.0",
+					Path:    "/path/to/sdk",
+					Note:    "xxxx",
+				},
+			},
+		})
+		if err != nil {
+			t.Fatal(err)
+		}
+	})
 }
diff --git a/internal/sdk.go b/internal/sdk.go
@@ -192,7 +192,7 @@ func (b *Sdk) preInstallSdk(info *Info, sdkDestPath string) (string, error) {
 	}
 }
 
-func (b *Sdk) Uninstall(version Version) error {
+func (b *Sdk) Uninstall(version Version) (err error) {
 	label := b.label(version)
 	if !b.CheckExists(version) {
 		return fmt.Errorf("%s is not installed", pterm.Red(label))
@@ -201,12 +201,21 @@ func (b *Sdk) Uninstall(version Version) error {
 		b.clearEnvConfig(version)
 	}
 	path := b.VersionPath(version)
-	err := os.RemoveAll(path)
+	sdkPackage, err := b.GetLocalSdkPackage(version)
 	if err != nil {
-		return err
+		return
+	}
+	// Give the plugin a chance before actually uninstalling targeted version.
+	err = b.Plugin.PreUninstall(sdkPackage)
+	if err != nil {
+		return
+	}
+	err = os.RemoveAll(path)
+	if err != nil {
+		return
 	}
 	pterm.Printf("Uninstalled %s successfully!\n", label)
-	return nil
+	return
 }
 
 func (b *Sdk) Available(args []string) ([]*Package, error) {

diff --git a/internal/testdata/plugins/java_with_main/main.lua b/internal/testdata/plugins/java_with_main/main.lua
@@ -188,3 +188,15 @@ function PLUGIN:ParseLegacyFile(ctx)
     end
 
 end
+
+function PLUGIN:PreUninstall(ctx)
+    printTable(ctx)
+    local mainSdkInfo = ctx.main
+    local mpath = mainSdkInfo.path
+    local mversion = mainSdkInfo.version
+    local mname = mainSdkInfo.name
+    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local path = sdkInfo.path
+    local version = sdkInfo.version
+    local name = sdkInfo.name
+end
diff --git a/internal/testdata/plugins/java_with_metadata/hooks/pre_uninstall.lua b/internal/testdata/plugins/java_with_metadata/hooks/pre_uninstall.lua
@@ -2,7 +2,7 @@
 
 
 function PLUGIN:PreUninstall(ctx)
-    local mainPath = ctx.path
+    printTable(ctx)
     local mainSdkInfo = ctx.main
     local mpath = mainSdkInfo.path
     local mversion = mainSdkInfo.version
@@ -11,5 +11,4 @@ function PLUGIN:PreUninstall(ctx)
     local path = sdkInfo.path
     local version = sdkInfo.version
     local name = sdkInfo.name
-
 end