refact(updater): expose a clenaer API

Author: dido18

cmd/releaser/main.go

@@ -32,7 +32,7 @@ func main() {
 	inputPath := flag.Arg(0)
 	version := flag.Arg(1)
 
-	manifest, err := releaser.CreateRelease(inputPath, platform, version, outputDir)
+	manifest, err := releaser.CreateRelease(inputPath, platform, releaser.Version(version), outputDir)
 	if err != nil {
 		log.Fatalf("could not create release: %v", err)
 	}

releaser/http_client.go

@@ -60,8 +60,8 @@ func (c *Client) addHeaders(req *http.Request) {
 	}
 }
 
-// GetManifest fetches and decodes the manifest for the given platform.
-func (c *Client) GetManifest(plat Platform) (Manifest, error) {
+// GetLatestVersion fetches and decodes the manifest for the given platform.
+func (c *Client) GetLatestVersion(plat Platform) (Manifest, error) {
 	manifestURL := c.BaseURL.JoinPath(c.CmdName, plat.String()+".json").String()
 	req, err := http.NewRequest("GET", manifestURL, nil)
 	if err != nil {
@@ -89,8 +89,8 @@ func (c *Client) GetManifest(plat Platform) (Manifest, error) {
 }
 
 // FetchZip fetches the zip for the given version and platform.
-func (c *Client) FetchZip(version string, plat Platform) (io.ReadCloser, error) {
-	zipURL := c.BaseURL.JoinPath(c.CmdName, version, plat.String()+".zip").String()
+func (c *Client) FetchZip(version Version, plat Platform) (io.ReadCloser, error) {
+	zipURL := c.BaseURL.JoinPath(c.CmdName, version.String(), plat.String()+".zip").String()
 	req, err := http.NewRequest("GET", zipURL, nil)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create request: %w", err)

releaser/releaser.go

@@ -11,17 +11,27 @@ import (
 )
 
 type Manifest struct {
-	Version string `json:"version"`
-	Sha256  []byte `json:"sha256"`
+	Version Version `json:"version"`
+	Sha256  []byte  `json:"sha256"`
 }
 
-func CreateRelease(inputPath string, platform Platform, version, outputDir string) (Manifest, error) {
+type Version string
+
+func (v Version) String() string {
+	return string(v)
+}
+
+func (v Version) Equals(other Version) bool {
+	return v.String() == other.String()
+}
+
+func CreateRelease(inputPath string, platform Platform, version Version, outputDir string) (Manifest, error) {
 	if err := os.MkdirAll(outputDir, 0755); err != nil {
 		return Manifest{}, fmt.Errorf("could not create output dir: %s. %w", outputDir, err)
 	}
 	// Prepare output paths
 	jsonPath := filepath.Join(outputDir, platform.String()+".json")
-	versionDir := filepath.Join(outputDir, version)
+	versionDir := filepath.Join(outputDir, version.String())
 	zipPath := filepath.Join(versionDir, platform.String()+".zip")
 
 	if err := os.MkdirAll(versionDir, 0755); err != nil {

releaser/releaser_test.go

@@ -22,7 +22,7 @@ func TestCreateReleaseFile(t *testing.T) {
 	content := []byte("hello world")
 	require.NoError(t, os.WriteFile(dummyFile, content, 0600))
 
-	version := "1.2.3"
+	version := Version("1.2.3")
 	manifest, err := CreateRelease(dummyFile, NewPlatform("linux", "amd64"), version, outputDir)
 	require.NoError(t, err)
 
@@ -37,7 +37,7 @@ func TestCreateReleaseFile(t *testing.T) {
 	//      linux-amd64.zip
 	//   linux-amd64.json
 	//
-	zipPath := filepath.Join(outputDir, version, "linux-amd64.zip")
+	zipPath := filepath.Join(outputDir, version.String(), "linux-amd64.zip")
 	zf, err := zip.OpenReader(zipPath)
 	require.NoError(t, err, "could not open zip file %s", zipPath)
 	defer zf.Close()
@@ -100,7 +100,7 @@ func TestCreateReleaseFolder(t *testing.T) {
 	require.NoError(t, os.WriteFile(fileA, contentA, 0600))
 	require.NoError(t, os.WriteFile(fileB, contentB, 0600))
 
-	version := "2.0.0"
+	version := Version("2.0.0")
 	manifest, err := CreateRelease(inputDir, NewPlatform("linux", "amd64"), version, outputDir)
 	require.NoError(t, err)
 
@@ -109,7 +109,7 @@ func TestCreateReleaseFolder(t *testing.T) {
 	require.Len(t, manifest.Sha256, 32)
 
 	// Check that the zip file exists and contains all files
-	zipPath := filepath.Join(outputDir, version, "linux-amd64.zip")
+	zipPath := filepath.Join(outputDir, version.String(), "linux-amd64.zip")
 	zf, err := zip.OpenReader(zipPath)
 	require.NoError(t, err, "could not open zip file %s", zipPath)
 	defer zf.Close()
@@ -149,3 +149,46 @@ func TestCreateReleaseFolder(t *testing.T) {
 	require.Equal(t, version, m.Version)
 	require.Len(t, m.Sha256, 32)
 }
+
+func TestVersion(t *testing.T) {
+	tests := []struct {
+		name     string
+		v1       Version
+		v2       Version
+		expected bool
+	}{
+		{
+			name:     "Equal versions",
+			v1:       Version("1.0.0"),
+			v2:       Version("1.0.0"),
+			expected: true,
+		},
+		{
+			name:     "Different versions",
+			v1:       Version("1.0.0"),
+			v2:       Version("2.0.0"),
+			expected: false,
+		},
+		{
+			name:     "Empty versions",
+			v1:       Version(""),
+			v2:       Version(""),
+			expected: true,
+		},
+		{
+			name:     "One empty version",
+			v1:       Version("1.0.0"),
+			v2:       Version(""),
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := tt.v1 == tt.v2
+			if result != tt.expected {
+				t.Errorf("Version.Equals() = %v, expected %v", result, tt.expected)
+			}
+		})
+	}
+}

updater/.gitignore

@@ -0,0 +1 @@
+test-*

updater/updater_darwin.go renamed to updater/apply_darwin.go

@@ -17,7 +17,7 @@ import (
 	"github.com/codeclysm/extract/v4"
 )
 
-func checkForUpdates(targetPath string, current Version, client *releaser.Client) (string, error) {
+func apply(targetPath string, current releaser.Version, client *releaser.Client, upgradeConfirmCb UpgradeConfirmCB) (string, error) {
 	currentAppPath := paths.New(targetPath).Parent().Parent().Parent()
 	if currentAppPath.Ext() != ".app" {
 		return "", fmt.Errorf("could not find app root in %s", targetPath)
@@ -31,15 +31,20 @@ func checkForUpdates(targetPath string, current Version, client *releaser.Client
 	// Fetch information about updates
 	plat := releaser.NewPlatform(runtime.GOOS, runtime.GOARCH)
 	slog.Info("Checking for updates", "platform", plat)
-	manifest, err := client.GetManifest(plat)
+	manifest, err := client.GetLatestVersion(plat)
 	if err != nil {
 		return "", err
 	}
-	if manifest.Version == current.String() {
+	if manifest.Version == current {
 		// No updates available, bye bye
 		return "", nil
 	}
 
+	if upgradeConfirmCb != nil && !upgradeConfirmCb(current, manifest.Version) {
+		slog.Info("Update not confirmed by user, exiting without applying update")
+		return "", nil
+	}
+
 	// Download the update.
 	slog.Info("Downloading update", "version", manifest.Version, "platform", plat)
 	download, err := client.FetchZip(manifest.Version, plat)

updater/updater_default.go renamed to updater/apply_default.go

@@ -19,25 +19,26 @@ import (
 	"github.com/codeclysm/extract/v4"
 )
 
-// checkForUpdates checks for updates for the current executable.
-// It downloads the update, verifies it, unzips it, and replaces the current executable.
-// It returns the path to the updated executable or an error if something goes wrong.
-
-func checkForUpdates(targetPath string, current Version, client *releaser.Client) (string, error) {
+func apply(targetPath string, current releaser.Version, client *releaser.Client, upgradeConfirmCb UpgradeConfirmCB) (string, error) {
 	currentPath := paths.New(targetPath)
 	currentDir := currentPath.Parent()
 
 	plat := releaser.NewPlatform(runtime.GOOS, runtime.GOARCH)
 	slog.Info("Checking for updates", "platform", plat)
-	manifest, err := client.GetManifest(plat)
+	manifest, err := client.GetLatestVersion(plat)
 	if err != nil {
 		return "", err
 	}
-	if manifest.Version == current.String() {
+	if manifest.Version == current {
 		// No updates available, bye bye
 		return "", nil
 	}
 
+	if upgradeConfirmCb != nil && !upgradeConfirmCb(current, manifest.Version) {
+		slog.Info("Update not confirmed by user, exiting without applying update")
+		return "", nil
+	}
+
 	// Download the update
 	slog.Info("Downloading update", "version", manifest.Version, "platform", plat)
 	download, err := client.FetchZip(manifest.Version, plat)

updater/updater_default_test.go renamed to updater/apply_default_test.go

@@ -15,12 +15,12 @@ import (
 	"github.com/arduino/go-updater/releaser"
 )
 
-func TestPerformUpdate(t *testing.T) {
+func TestApply(t *testing.T) {
 	tmpExec := CreateTmpExecutable(t, "successfulUpdate", []byte{0xDE, 0xAD, 0xBE, 0xEF})
 	defer tmpExec.cleanup()
 	client := CreateRelease(t, "2.0.0", []byte{0x01, 0x02, 0x03, 0x04, 0x05, 0x06})
 
-	restartPath, err := checkForUpdates(tmpExec.targetPath, Version("1.0.0"), client)
+	restartPath, err := apply(tmpExec.targetPath, releaser.Version("1.0.0"), client, DefaultUpgradeConfirmCb)
 	require.NoError(t, err)
 	require.NotEmpty(t, restartPath)
 
@@ -29,21 +29,21 @@ func TestPerformUpdate(t *testing.T) {
 	require.Equal(t, []byte{0x01, 0x02, 0x03, 0x04, 0x05, 0x06}, data, "Updated binary content does not match expected content")
 }
 
-func TestNoUpdateRequired(t *testing.T) {
+func TestApplyWithNoUpdate(t *testing.T) {
 	tmpExec := CreateTmpExecutable(t, "noUpdate", []byte{0xDE, 0xAD, 0xBE, 0xEF})
 	defer tmpExec.cleanup()
 	client := CreateRelease(t, "1.0.0", []byte{0x01, 0x02, 0x03, 0x04, 0x05, 0x06})
 
-	result, err := checkForUpdates(tmpExec.targetPath, Version("1.0.0"), client)
+	result, err := apply(tmpExec.targetPath, releaser.Version("1.0.0"), client, DefaultUpgradeConfirmCb)
 	require.NoError(t, err)
 	require.Equal(t, "", result)
 }
 
-func TestCleanUpOldFiles(t *testing.T) {
+func TestApplyWillCleanUpFiles(t *testing.T) {
 	tmpExec := CreateTmpExecutable(t, "cleanUp", []byte{0xDE, 0xAD, 0xBE, 0xEF})
 	client := CreateRelease(t, "3.0.0", []byte{0x01, 0x02, 0x03, 0x04, 0x05, 0x06})
 
-	result, err := checkForUpdates(tmpExec.targetPath, Version("1.0.0"), client)
+	result, err := apply(tmpExec.targetPath, releaser.Version("1.0.0"), client, DefaultUpgradeConfirmCb)
 	require.NoError(t, err)
 	require.Equal(t, tmpExec.targetPath, result)
 
@@ -66,6 +66,7 @@ type TmpExecutable struct {
 }
 
 func CreateTmpExecutable(t *testing.T, binaryName string, content []byte) TmpExecutable {
+	// prefix the binary name with "test-" to put the folders in the .gitignore
 	tmpDir := filepath.Join(".", "test-"+binaryName)
 	err := os.MkdirAll(tmpDir, 0755)
 	require.NoError(t, err)
@@ -85,7 +86,7 @@ func CreateTmpExecutable(t *testing.T, binaryName string, content []byte) TmpExe
 	}
 }
 
-func CreateRelease(t *testing.T, version Version, content []byte) *releaser.Client {
+func CreateRelease(t *testing.T, version releaser.Version, content []byte) *releaser.Client {
 	tmpDir := t.TempDir()
 
 	inputDir := filepath.Join(tmpDir, "input")
@@ -96,7 +97,7 @@ func CreateRelease(t *testing.T, version Version, content []byte) *releaser.Clie
 
 	outputDir := filepath.Join(tmpDir, "output")
 
-	_, err := releaser.CreateRelease(inputDir, releaser.NewPlatform("linux", "amd64"), version.String(), outputDir)
+	_, err := releaser.CreateRelease(inputDir, releaser.NewPlatform("linux", "amd64"), version, outputDir)
 	require.NoError(t, err)
 
 	// check zip file exists and json manifest is created
@@ -140,6 +141,20 @@ func CreateRelease(t *testing.T, version Version, content []byte) *releaser.Clie
 	return client
 }
 
+func CreateReleaseWithHTTPErrorResponse(t *testing.T, statusCode int) *releaser.Client {
+	return &releaser.Client{
+		BaseURL: &url.URL{Scheme: "http", Host: "example.com"},
+		CmdName: "testcmd",
+		HTTPClient: &mockHTTPClient{doFunc: func(req *http.Request) (*http.Response, error) {
+			resp := &http.Response{
+				StatusCode: statusCode,
+				Body:       io.NopCloser(bytes.NewBufferString("")),
+			}
+			return resp, nil
+		}},
+	}
+}
+
 // mockHTTPClient implements releaser.HTTPDoer for testing.
 type mockHTTPClient struct {
 	doFunc func(req *http.Request) (*http.Response, error)

updater/updater.go

@@ -7,25 +7,28 @@ import (
 	"github.com/arduino/go-updater/releaser"
 )
 
-type Version string
+// UpgradeConfirmCB is a function that is called when an update is ready to be applied.
+type UpgradeConfirmCB func(current, target releaser.Version) bool
 
-func (v Version) String() string {
-	return string(v)
-}
-
-// Start checks if an update has to be downloaded and if so returns the path to the
-// binary to be executed to perform the update.
-// If the update is not available, it returns an empty string and no error.
-// If the update is available, it returns the path to the binary to be executed.
-// If there is an error, it returns the error.
-func CheckForUpdates(targetPath string, current Version, client *releaser.Client) (string, error) {
-	return checkForUpdates(targetPath, current, client)
-}
+var DefaultUpgradeConfirmCb = func(current, target releaser.Version) bool { return true }
 
-func Restart(executable string) error {
-	err := execApp(executable)
+// CheckForUpdates checks for updates and applies it if available.
+// If the upgradeCb is not nil, it will prompt the user for confirmation before applying the update.
+// If an update is applied, it will restart the application with the new version.
+// If no update is available, it will return nil.
+// If an error occurs during the update process, it will return the error.
+func CheckForUpdates(targetPath string, current releaser.Version, client *releaser.Client, upgradeCb UpgradeConfirmCB) error {
+	restartPath, err := apply(targetPath, current, client, upgradeCb)
 	if err != nil {
-		return fmt.Errorf("could not exec app: %w", err)
+		return err
+	}
+
+	if restartPath == "" {
+		return nil // No update available
+	}
+
+	if err := execApp(restartPath); err != nil {
+		return fmt.Errorf("update applied, but failed to restart application: %w", err)
 	}
 	// TODO: allow to define custom "exit" code to be used in the wail app runtime.quit()
 	os.Exit(0)