Flow CLI integration module

frontend/src/targets/electron/main.ts

@@ -5,7 +5,6 @@ import { SentryMainService } from "./services/sentry-main.service";
 import { setupMenu } from "./menu";
 import { ServiceRegistry } from "./services/service-registry";
 import { FlowserBackend } from "./backend";
-import { ProjectEntity } from "@flowser/backend";
 
 fixPath();
 

go.mod

@@ -0,0 +1,7 @@
+module github.com/onflowser/flowser
+
+go 1.19
+
+require github.com/google/go-github v17.0.0+incompatible
+
+require github.com/google/go-querystring v1.1.0 // indirect

go.sum

@@ -0,0 +1,7 @@
+github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
+github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

pkg/.gitignore

@@ -0,0 +1,2 @@
+# Temp installation dir used for testing
+test-install

pkg/flowser/app.go

@@ -0,0 +1,207 @@
+package flowser
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"os/exec"
+	"path"
+	"runtime"
+	"strings"
+
+	"github.com/google/go-github/github"
+)
+
+const (
+	darwin  = "darwin"
+	windows = "windows"
+)
+
+// New create new Flowser application.
+func New() *App {
+	return &App{}
+}
+
+type App struct {
+	installDir string
+}
+
+var errorPlatformNotSupported = errors.New("OS not supported, only supporting Windows and Mac OS")
+
+// Run starts the Flowser application with provided path to the flow project.
+//
+// Project path if exists should be set to the folder containing flow.json, if no such path exists pass empty value.
+func (a *App) Run(installDir string, projectPath string) error {
+	exe, err := a.executable(installDir)
+	if err != nil {
+		return err
+	}
+
+	if projectPath != "" {
+		projectPath = fmt.Sprintf("--project-path=%s", projectPath)
+	}
+
+	return exec.
+		Command(exe, projectPath).
+		Run()
+}
+
+// Install Flowser application in the provided install directory.
+//
+// Install directory is optional, if you want to default to your system location you can provide empty value.
+func (a *App) Install(installDir string) error {
+	downloadDir, err := downloadLatestReleaseAsset()
+	if err != nil {
+		return err
+	}
+
+	defer os.Remove(downloadDir)
+	return a.unzip(downloadDir, installDir)
+}
+
+// Installed checks whether the flowser application is already installed on the system.
+func (a *App) Installed(installDir string) bool {
+	executable, err := a.executable(installDir)
+	if err != nil {
+		return false
+	}
+
+	_, err = os.Stat(executable)
+	return err == nil
+}
+
+// Remove Flowser application from provide directory.
+//
+// Install directory is optional, if you don't provide a value default will be used.
+func (a *App) Remove(installDir string) error {
+	a.installDir = installDir
+
+	dir, err := a.appDir(installDir)
+	if err != nil {
+		return err
+	}
+
+	return os.RemoveAll(dir)
+}
+
+// unzip content from source compressed file to a target directory.
+func (a *App) unzip(source string, target string) error {
+	var cmd *exec.Cmd
+	switch runtime.GOOS {
+	case darwin:
+		// Use native unzip tool as it handles the creation of required symbolic links
+		cmd = exec.Command("unzip", source, "-d", target)
+	case windows:
+		appDir, err := a.appDir(target)
+		if err != nil {
+			return err
+		}
+
+		if err := os.MkdirAll(appDir, os.ModePerm); err != nil {
+			return err
+		}
+
+		// tar utility is available from Windows build 17063 consider using other command or a custom implementation
+		// https://learn.microsoft.com/en-us/virtualization/community/team-blog/2017/20171219-tar-and-curl-come-to-windows
+		cmd = exec.Command("tar", "-xf", source, "-C", appDir)
+	default:
+		return errorPlatformNotSupported
+	}
+
+	return cmd.Run()
+}
+
+// appDir returns the location of the executable application inside the installation dir.
+func (a *App) appDir(installDir string) (string, error) {
+	return path.Join(installDir, "Flowser.App"), nil
+}
+
+// executable returns the location of application executable.
+func (a *App) executable(installDir string) (string, error) {
+	files := map[string]string{
+		darwin:  "Contents/MacOS/Flowser",
+		windows: "Flowser.exe",
+	}
+	file, ok := files[runtime.GOOS]
+	if !ok {
+		return "", errorPlatformNotSupported
+	}
+
+	appDir, err := a.appDir(installDir)
+	if err != nil {
+		return "", err
+	}
+
+	return path.Join(appDir, file), nil
+}
+
+func downloadLatestReleaseAsset() (string, error) {
+	release, err := getLatestRelease()
+
+	if err != nil {
+		return "", err
+	}
+
+	resp, err := http.Get(*release.asset.BrowserDownloadURL)
+
+	if err != nil {
+		return "", err
+	}
+
+	defer resp.Body.Close()
+
+	out, _ := os.Create(*release.asset.Name)
+	defer out.Close()
+
+	_, err = io.Copy(out, resp.Body)
+	if err != nil {
+		return "", err
+	}
+
+	return out.Name(), nil
+}
+
+type flowserRelease struct {
+	version string
+	asset   github.ReleaseAsset
+}
+
+func getLatestRelease() (*flowserRelease, error) {
+	client := github.NewClient(nil)
+	release, _, err := client.Repositories.GetLatestRelease(context.Background(), "onflowser", "flowser")
+	if err != nil {
+		return nil, err
+	}
+	latestVersion := strings.Replace(*release.TagName, "v", "", 1)
+	targetAssetName, err := getAssetName(latestVersion)
+	if err != nil {
+		return nil, err
+	}
+	for _, asset := range release.Assets {
+		if *asset.Name == targetAssetName {
+			return &flowserRelease{
+				version: latestVersion,
+				asset:   asset,
+			}, nil
+		}
+	}
+	return nil, errors.New("no asset found")
+}
+
+func getAssetName(version string) (string, error) {
+	isArm := strings.HasPrefix(runtime.GOARCH, "arm")
+	switch runtime.GOOS {
+	case darwin:
+		if isArm {
+			return fmt.Sprintf("Flowser-%s-arm64-mac.zip", version), nil
+		}
+		return fmt.Sprintf("Flowser-%s-mac.zip", version), nil
+	case windows:
+		return fmt.Sprintf("Flowser-%s-win.zip", version), nil
+	default:
+		return "", errorPlatformNotSupported
+	}
+}

pkg/flowser/app_test.go

@@ -0,0 +1,32 @@
+package flowser
+
+import (
+	"testing"
+)
+
+var app = &app{}
+
+func TestInstallAndRun(t *testing.T) {
+	installDir, err := app.Install("")
+	t.Logf("Installed to %s", installDir)
+
+	if err != nil {
+		t.Fatalf("Installed with error %s", err)
+	}
+	isInstalled, err := app.Installed()
+	if err != nil {
+		t.Fatalf("Installed with error %s", err)
+	}
+	if !isInstalled {
+		t.Fatalf("Should return isInstalled = true")
+	}
+	err = app.Run("/invalid/path")
+	if err == nil {
+		t.Fatal("Didn't return error for invalid project path")
+	}
+
+	err = app.Remove("")
+	if err != nil {
+		t.Fatalf("Failed to remove installed App: %s", err)
+	}
+}

pkg/main/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"github.com/onflowser/flowser/pkg/flowser"
+)
+
+func main() {
+	app := flowser.New()
+
+	location, err := app.Install("")
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("Flowser installed at:", location)
+}