From 4d40f7138fbb94bc2d985c06d828ef3d82b4434b Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sat, 17 Oct 2026 16:18:13 -0600 Subject: [PATCH] refactor(ide): share server install helpers --- pkg/ide/codeserver/codeserver.go | 106 +++---------- pkg/ide/fleet/fleet.go | 21 +-- pkg/ide/internal/serverutil/serverutil.go | 143 +++++++++++++++++ .../internal/serverutil/serverutil_test.go | 149 ++++++++++++++++++ pkg/ide/jetbrains/generic.go | 19 +-- pkg/ide/openvscode/openvscode.go | 101 +++--------- pkg/ide/vscodeweb/vscodeweb.go | 109 +++---------- 7 files changed, 366 insertions(+), 282 deletions(-) create mode 100644 pkg/ide/internal/serverutil/serverutil.go create mode 100644 pkg/ide/internal/serverutil/serverutil_test.go diff --git a/pkg/ide/codeserver/codeserver.go b/pkg/ide/codeserver/codeserver.go index a4540d81f9..df76f5f63c 100644 --- a/pkg/ide/codeserver/codeserver.go +++ b/pkg/ide/codeserver/codeserver.go @@ -14,9 +14,9 @@ import ( copy2 "github.com/devsy-org/devsy/pkg/copy" "github.com/devsy-org/devsy/pkg/extract" "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/ide/internal/serverutil" "github.com/devsy-org/devsy/pkg/ide/vscode" "github.com/devsy-org/devsy/pkg/log" - "github.com/devsy-org/devsy/pkg/util" ) // Release URL format: tag has the `v` prefix; the asset filename does not. @@ -62,6 +62,14 @@ var Options = ide.Options{ }, } +var downloadSpec = serverutil.ReleaseSpec{ + Options: Options, + Amd64Option: DownloadAmd64Option, + Arm64Option: DownloadArm64Option, + Amd64Template: downloadAmd64Template, + Arm64Template: downloadArm64Template, +} + // DefaultCodeServerPort sits next to openvscode's 10800 so a host running both // IDEs only collides under the FindAvailablePort fallback path, not by default. const DefaultCodeServerPort = 10801 @@ -126,10 +134,8 @@ func (c *CodeServer) Install() error { return err } - if c.userName != "" { - if err := copy2.ChownR(location, c.userName); err != nil { - return fmt.Errorf("chown: %w", err) - } + if err := serverutil.ChownIfNeeded(c.userName, location); err != nil { + return err } if err := c.installSettings(); err != nil { @@ -162,7 +168,7 @@ func (c *CodeServer) Start() error { return fmt.Errorf("find binary: %w", err) } - homeFolder, err := userHome(c.userName) + homeFolder, err := serverutil.UserHome(c.userName) if err != nil { return err } @@ -180,26 +186,13 @@ func (c *CodeServer) Start() error { "--disable-telemetry --disable-update-check", binaryPath, c.host+":"+c.port, userDataDir, ) - return suOrSh(c.userName, runCommand, location), nil + return serverutil.SuOrSh(c.userName, runCommand, location), nil }) } func (c *CodeServer) getReleaseURL() string { version := Options.GetValue(c.values, VersionOption) - - var url string - if runtime.GOARCH == "arm64" { - url = Options.GetValue(c.values, DownloadArm64Option) - if url == "" { - url = fmt.Sprintf(downloadArm64Template, version, version) - } - } else { - url = Options.GetValue(c.values, DownloadAmd64Option) - if url == "" { - url = fmt.Sprintf(downloadAmd64Template, version, version) - } - } - return url + return downloadSpec.URL(c.values, runtime.GOARCH, version, version) } func (c *CodeServer) installExtensions() error { @@ -212,31 +205,15 @@ func (c *CodeServer) installExtensions() error { return err } - out := log.Writer(log.LevelInfo) - defer func() { _ = out.Close() }() - binaryPath := filepath.Join(location, "bin", "code-server") - var failed []string - for _, extension := range c.extensions { - log.Info("Install extension " + extension) - runCommand := fmt.Sprintf("%s --install-extension %q", binaryPath, extension) - cmd := suOrSh(c.userName, runCommand, "") - cmd.Stdout = out - cmd.Stderr = out - if err := cmd.Run(); err != nil { - log.Errorf("failed installing extension: extension=%s, error=%v", extension, err) - failed = append(failed, extension) - } else { - log.Infof("installed extension: extension=%s", extension) - } - } - - // Escalate only on total failure - partial failures stay as logged - // warnings to match openvscode's behavior. - if len(failed) == len(c.extensions) { - return fmt.Errorf("all %d extensions failed to install: %v", len(failed), failed) - } - return nil + return serverutil.ExtensionInstall{ + UserName: c.userName, + Extensions: c.extensions, + Command: func(extension string) string { + return fmt.Sprintf("%s --install-extension %q", binaryPath, extension) + }, + FailOnTotalFailure: true, + }.Run() } // installSettings writes settings.json to code-server's user config dir, @@ -247,7 +224,7 @@ func (c *CodeServer) installSettings() error { return nil } - homeFolder, err := userHome(c.userName) + homeFolder, err := serverutil.UserHome(c.userName) if err != nil { return err } @@ -271,44 +248,9 @@ func (c *CodeServer) installSettings() error { return nil } -// suOrSh builds an *exec.Cmd that runs runCommand either as the unprivileged -// user (via `su -c`) or as the current user (via `sh -c`). All arg -// elements are constants from this package - runCommand itself is built from -// constants plus internal values, not user-controlled binary paths. -func suOrSh(userName, runCommand, workingDir string) *exec.Cmd { - var cmd *exec.Cmd - if userName != "" { - // #nosec G204 -- args are fixed constants; runCommand is internally built. - cmd = exec.Command("su", userName, "-c", runCommand) - } else { - // #nosec G204 -- args are fixed constants; runCommand is internally built. - cmd = exec.Command("sh", "-c", runCommand) - } - if workingDir != "" { - cmd.Dir = workingDir - } - return cmd -} - -func userHome(userName string) (string, error) { - if userName != "" { - return command.GetHome(userName) - } - return util.UserHomeDir() -} - // prepareCodeServerLocation returns the install dir for code-server, creating // it if needed. Layout mirrors the upstream tarball after StripLevels(1): // /.code-server/bin/code-server. func prepareCodeServerLocation(userName string) (string, error) { - homeFolder, err := userHome(userName) - if err != nil { - return "", err - } - folder := filepath.Join(homeFolder, ".code-server") - // #nosec G301 -- match openvscode-server convention for parity. - if err := os.MkdirAll(folder, 0o755); err != nil { - return "", err - } - return folder, nil + return serverutil.PrepareLocation(userName, ".code-server") } diff --git a/pkg/ide/fleet/fleet.go b/pkg/ide/fleet/fleet.go index 87edf49980..e8b85a9d88 100644 --- a/pkg/ide/fleet/fleet.go +++ b/pkg/ide/fleet/fleet.go @@ -17,9 +17,9 @@ import ( copy2 "github.com/devsy-org/devsy/pkg/copy" devsyhttp "github.com/devsy-org/devsy/pkg/http" "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/ide/internal/serverutil" "github.com/devsy-org/devsy/pkg/log" "github.com/devsy-org/devsy/pkg/scanner" - "github.com/devsy-org/devsy/pkg/util" ) const ( @@ -227,22 +227,5 @@ func (o *FleetServer) startMonitor() error { } func prepareFleetServerLocation(userName string) (string, error) { - var err error - homeFolder := "" - if userName != "" { - homeFolder, err = command.GetHome(userName) - } else { - homeFolder, err = util.UserHomeDir() - } - if err != nil { - return "", err - } - - folder := filepath.Join(homeFolder, ".fleet-server") - err = os.MkdirAll(folder, 0o755) // #nosec G301 - if err != nil { - return "", err - } - - return folder, nil + return serverutil.PrepareLocation(userName, ".fleet-server") } diff --git a/pkg/ide/internal/serverutil/serverutil.go b/pkg/ide/internal/serverutil/serverutil.go new file mode 100644 index 0000000000..c1431f02b0 --- /dev/null +++ b/pkg/ide/internal/serverutil/serverutil.go @@ -0,0 +1,143 @@ +// Package serverutil holds the install and launch helpers shared by the +// browser IDE servers under pkg/ide. +package serverutil + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + + "github.com/devsy-org/devsy/pkg/command" + "github.com/devsy-org/devsy/pkg/config" + copy2 "github.com/devsy-org/devsy/pkg/copy" + "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/log" + "github.com/devsy-org/devsy/pkg/util" +) + +// SuOrSh builds an *exec.Cmd that runs runCommand either as the unprivileged +// user (via `su -c`) or as the current user (via `sh -c`). All arg +// elements are constants from this package - runCommand itself is built from +// constants plus internal values, not user-controlled binary paths. +func SuOrSh(userName, runCommand, workingDir string) *exec.Cmd { + var cmd *exec.Cmd + if userName != "" { + // #nosec G204 -- args are fixed constants; runCommand is internally built. + cmd = exec.Command("su", userName, "-c", runCommand) + } else { + // #nosec G204 -- args are fixed constants; runCommand is internally built. + cmd = exec.Command("sh", "-c", runCommand) + } + if workingDir != "" { + cmd.Dir = workingDir + } + return cmd +} + +// UserHome returns the home directory of userName, or of the current user when +// userName is empty. +func UserHome(userName string) (string, error) { + if userName != "" { + return command.GetHome(userName) + } + return util.UserHomeDir() +} + +// PrepareLocation returns / for userName, creating it if needed. +func PrepareLocation(userName, dirName string) (string, error) { + homeFolder, err := UserHome(userName) + if err != nil { + return "", err + } + folder := filepath.Join(homeFolder, dirName) + // #nosec G301 -- match openvscode-server convention for parity. + if err := os.MkdirAll(folder, 0o755); err != nil { + return "", err + } + return folder, nil +} + +// ChownIfNeeded recursively hands location to userName. It is a no-op when +// userName is empty. +func ChownIfNeeded(userName, location string) error { + if userName == "" { + return nil + } + if err := copy2.ChownR(location, userName); err != nil { + return fmt.Errorf("chown: %w", err) + } + return nil +} + +// ReleaseSpec describes how one IDE picks its server download URL per arch. +type ReleaseSpec struct { + Options ide.Options + Amd64Option string + Arm64Option string + Amd64Template string + Arm64Template string +} + +// URL returns the value of the arch's override option when set, otherwise the +// arch's template filled with args. Any goarch other than "arm64" selects the +// amd64 settings. +func (s ReleaseSpec) URL(values map[string]config.OptionValue, goarch string, args ...any) string { + if goarch == "arm64" { + if url := s.Options.GetValue(values, s.Arm64Option); url != "" { + return url + } + return fmt.Sprintf(s.Arm64Template, args...) + } + if url := s.Options.GetValue(values, s.Amd64Option); url != "" { + return url + } + return fmt.Sprintf(s.Amd64Template, args...) +} + +// ExtensionInstall runs one CLI install per extension, logging each outcome. +type ExtensionInstall struct { + UserName string + Extensions []string + // Command returns the shell command that installs one extension. + Command func(extension string) string + // Quote formats an extension name for log lines. Nil logs names as-is. + Quote func(string) string + // FailOnTotalFailure makes Run return an error when every extension fails. + // Partial failures are always logged and tolerated. + FailOnTotalFailure bool +} + +// Run installs each extension in order. Failures are logged and collected. +func (e ExtensionInstall) Run() error { + if len(e.Extensions) == 0 { + return nil + } + quote := e.Quote + if quote == nil { + quote = func(name string) string { return name } + } + + out := log.Writer(log.LevelInfo) + defer func() { _ = out.Close() }() + + var failed []string + for _, extension := range e.Extensions { + name := quote(extension) + log.Info("Install extension " + name) + cmd := SuOrSh(e.UserName, e.Command(extension), "") + cmd.Stdout = out + cmd.Stderr = out + if err := cmd.Run(); err != nil { + log.Errorf("failed installing extension: extension=%s, error=%v", name, err) + failed = append(failed, extension) + } else { + log.Infof("installed extension: extension=%s", name) + } + } + + if e.FailOnTotalFailure && len(failed) == len(e.Extensions) { + return fmt.Errorf("all %d extensions failed to install: %v", len(failed), failed) + } + return nil +} diff --git a/pkg/ide/internal/serverutil/serverutil_test.go b/pkg/ide/internal/serverutil/serverutil_test.go new file mode 100644 index 0000000000..9f8446d155 --- /dev/null +++ b/pkg/ide/internal/serverutil/serverutil_test.go @@ -0,0 +1,149 @@ +package serverutil + +import ( + "os" + "path/filepath" + "runtime" + "testing" + + "github.com/devsy-org/devsy/pkg/config" + "github.com/devsy-org/devsy/pkg/ide" + "github.com/stretchr/testify/suite" +) + +const ( + testAmd64Option = "AMD" + testArm64Option = "ARM" + cmdTrue = "true" + cmdFalse = "false" + goosWindows = "windows" +) + +type ServerUtilSuite struct { + suite.Suite +} + +func TestServerUtilSuite(t *testing.T) { + suite.Run(t, new(ServerUtilSuite)) +} + +func (s *ServerUtilSuite) TestSuOrShWithoutUserUsesSh() { + cmd := SuOrSh("", "echo hi", "") + s.Equal([]string{"sh", "-c", "echo hi"}, cmd.Args) + s.Empty(cmd.Dir) +} + +func (s *ServerUtilSuite) TestSuOrShWithUserUsesSuAndSetsDir() { + cmd := SuOrSh("alice", "echo hi", "/tmp/work") + s.Equal([]string{"su", "alice", "-c", "echo hi"}, cmd.Args) + s.Equal("/tmp/work", cmd.Dir) +} + +func (s *ServerUtilSuite) TestReleaseSpecURLSelectsByGoarch() { + spec := ReleaseSpec{ + Options: ide.Options{ + testAmd64Option: {Name: testAmd64Option}, + testArm64Option: {Name: testArm64Option}, + }, + Amd64Option: testAmd64Option, + Arm64Option: testArm64Option, + Amd64Template: "amd-%s-%s", + Arm64Template: "arm-%s-%s", + } + + s.Equal("amd-1-2", spec.URL(nil, "amd64", "1", "2")) + s.Equal("arm-1-2", spec.URL(nil, "arm64", "1", "2")) + s.Equal("amd-1-2", spec.URL(nil, "riscv64", "1", "2")) +} + +func (s *ServerUtilSuite) TestReleaseSpecOverrideAppliesOnlyToItsArch() { + spec := ReleaseSpec{ + Options: ide.Options{ + testAmd64Option: {Name: testAmd64Option}, + testArm64Option: {Name: testArm64Option}, + }, + Amd64Option: testAmd64Option, + Arm64Option: testArm64Option, + Amd64Template: "amd-%s", + Arm64Template: "arm-%s", + } + values := map[string]config.OptionValue{ + testAmd64Option: {Value: "https://override/amd"}, + } + + s.Equal("https://override/amd", spec.URL(values, "amd64", "1")) + s.Equal("arm-1", spec.URL(values, "arm64", "1")) +} + +func (s *ServerUtilSuite) TestPrepareLocationCreatesDirUnderHome() { + home := s.T().TempDir() + s.T().Setenv("HOME", home) + s.T().Setenv("USERPROFILE", home) + + location, err := PrepareLocation("", ".example-server") + s.Require().NoError(err) + s.Equal(filepath.Join(home, ".example-server"), location) + + info, err := os.Stat(location) + s.Require().NoError(err) + s.True(info.IsDir()) +} + +func (s *ServerUtilSuite) TestChownIfNeededNoopWithoutUser() { + s.NoError(ChownIfNeeded("", filepath.Join(s.T().TempDir(), "missing"))) +} + +func (s *ServerUtilSuite) TestExtensionInstallEmptyListSkipsCommand() { + called := false + err := ExtensionInstall{ + Extensions: nil, + Command: func(string) string { + called = true + return cmdFalse + }, + FailOnTotalFailure: true, + }.Run() + s.NoError(err) + s.False(called) +} + +func (s *ServerUtilSuite) TestExtensionInstallAllFailReturnsErrorWhenRequired() { + if runtime.GOOS == goosWindows { + s.T().Skip("uses sh") + } + err := ExtensionInstall{ + Extensions: []string{"a", "b"}, + Command: func(string) string { return cmdFalse }, + FailOnTotalFailure: true, + }.Run() + s.Require().Error(err) + s.Contains(err.Error(), "all 2 extensions failed to install") +} + +func (s *ServerUtilSuite) TestExtensionInstallAllFailToleratedWhenNotRequired() { + if runtime.GOOS == goosWindows { + s.T().Skip("uses sh") + } + err := ExtensionInstall{ + Extensions: []string{"a", "b"}, + Command: func(string) string { return cmdFalse }, + }.Run() + s.NoError(err) +} + +func (s *ServerUtilSuite) TestExtensionInstallPartialFailureTolerated() { + if runtime.GOOS == goosWindows { + s.T().Skip("uses sh") + } + err := ExtensionInstall{ + Extensions: []string{"ok", "bad"}, + Command: func(name string) string { + if name == "ok" { + return cmdTrue + } + return cmdFalse + }, + FailOnTotalFailure: true, + }.Run() + s.NoError(err) +} diff --git a/pkg/ide/jetbrains/generic.go b/pkg/ide/jetbrains/generic.go index e027f7a82b..fe3eb3366f 100644 --- a/pkg/ide/jetbrains/generic.go +++ b/pkg/ide/jetbrains/generic.go @@ -18,9 +18,9 @@ import ( "github.com/devsy-org/devsy/pkg/extract" devsyhttp "github.com/devsy-org/devsy/pkg/http" "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/ide/internal/serverutil" "github.com/devsy-org/devsy/pkg/log" devsyopen "github.com/devsy-org/devsy/pkg/open" - "github.com/devsy-org/devsy/pkg/util" ) const ( @@ -115,7 +115,7 @@ func (o *GenericJetBrainsServer) GetVolume() string { func (o *GenericJetBrainsServer) Install(setupInfo *config.Result) error { log.Infof("setup backend: displayName=%s, id=%s", o.options.DisplayName, o.options.ID) - baseFolder, err := getBaseFolder(o.userName) + baseFolder, err := serverutil.UserHome(o.userName) if err != nil { return err } @@ -207,21 +207,6 @@ func (o *GenericJetBrainsServer) installPlugins( return nil } -func getBaseFolder(userName string) (string, error) { - var err error - homeFolder := "" - if userName != "" { - homeFolder, err = command.GetHome(userName) - } else { - homeFolder, err = util.UserHomeDir() - } - if err != nil { - return "", err - } - - return homeFolder, nil -} - func (o *GenericJetBrainsServer) getDirectory(baseFolder string) string { return path.Join(baseFolder, ".cache", "JetBrains", "RemoteDev", "dist", o.options.ID) } diff --git a/pkg/ide/openvscode/openvscode.go b/pkg/ide/openvscode/openvscode.go index fc5f5a4ac3..445a5f1596 100644 --- a/pkg/ide/openvscode/openvscode.go +++ b/pkg/ide/openvscode/openvscode.go @@ -14,9 +14,9 @@ import ( copy2 "github.com/devsy-org/devsy/pkg/copy" "github.com/devsy-org/devsy/pkg/extract" "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/ide/internal/serverutil" "github.com/devsy-org/devsy/pkg/ide/vscode" "github.com/devsy-org/devsy/pkg/log" - "github.com/devsy-org/devsy/pkg/util" ) const ( @@ -62,6 +62,14 @@ var Options = ide.Options{ }, } +var downloadSpec = serverutil.ReleaseSpec{ + Options: Options, + Amd64Option: DownloadAmd64Option, + Arm64Option: DownloadArm64Option, + Amd64Template: DownloadAmd64Template, + Arm64Template: DownloadArm64Template, +} + const DefaultVSCodePort = 10800 type OpenVSCodeServer struct { @@ -123,7 +131,7 @@ func (o *OpenVSCodeServer) Install() error { return err } - if err := chownIfNeeded(o.userName, location); err != nil { + if err := serverutil.ChownIfNeeded(o.userName, location); err != nil { return err } @@ -134,16 +142,6 @@ func (o *OpenVSCodeServer) Install() error { return nil } -func chownIfNeeded(userName, location string) error { - if userName == "" { - return nil - } - if err := copy2.ChownR(location, userName); err != nil { - return fmt.Errorf("chown: %w", err) - } - return nil -} - func (o *OpenVSCodeServer) Start() error { location, err := prepareOpenVSCodeServerLocation(o.userName) if err != nil { @@ -171,36 +169,13 @@ func (o *OpenVSCodeServer) Start() error { o.host, o.port, ) - args := []string{} - if o.userName != "" { - args = append(args, "su", o.userName, "-c", runCommand) - } else { - args = append(args, "sh", "-c", runCommand) - } - //nolint:gosec // G204: shell/su fixed above, runCommand built from internal binaryPath and config, not external input - cmd := exec.Command(args[0], args[1:]...) - cmd.Dir = location - return cmd, nil + return serverutil.SuOrSh(o.userName, runCommand, location), nil }) } func (o *OpenVSCodeServer) getReleaseUrl() string { - var url string version := Options.GetValue(o.values, VersionOption) - - if runtime.GOARCH == "arm64" { - url = Options.GetValue(o.values, DownloadArm64Option) - if url == "" { - url = fmt.Sprintf(DownloadArm64Template, version, version) - } - } else { - url = Options.GetValue(o.values, DownloadAmd64Option) - if url == "" { - url = fmt.Sprintf(DownloadAmd64Template, version, version) - } - } - - return url + return downloadSpec.URL(o.values, runtime.GOARCH, version, version) } func (o *OpenVSCodeServer) installExtensions() error { @@ -213,32 +188,14 @@ func (o *OpenVSCodeServer) installExtensions() error { return err } - out := log.Writer(log.LevelInfo) - defer func() { _ = out.Close() }() - binaryPath := filepath.Join(location, "bin", "openvscode-server") - for _, extension := range o.extensions { - log.Info("Install extension " + extension) - runCommand := fmt.Sprintf("%s --install-extension '%s'", binaryPath, extension) - args := []string{} - if o.userName != "" { - args = append(args, "su", o.userName, "-c", runCommand) - } else { - args = append(args, "sh", "-c", runCommand) - } - //nolint:gosec // G204: shell/su fixed above, runCommand built from internal binaryPath and config, not external input - cmd := exec.Command(args[0], args[1:]...) - cmd.Stdout = out - cmd.Stderr = out - err = cmd.Run() - if err != nil { - log.Errorf("failed installing extension: extension=%s, error=%v", extension, err) - } else { - log.Infof("installed extension: extension=%s", extension) - } - } - - return nil + return serverutil.ExtensionInstall{ + UserName: o.userName, + Extensions: o.extensions, + Command: func(extension string) string { + return fmt.Sprintf("%s --install-extension '%s'", binaryPath, extension) + }, + }.Run() } func (o *OpenVSCodeServer) installSettings() error { @@ -272,23 +229,5 @@ func (o *OpenVSCodeServer) installSettings() error { } func prepareOpenVSCodeServerLocation(userName string) (string, error) { - var err error - homeFolder := "" - if userName != "" { - homeFolder, err = command.GetHome(userName) - } else { - homeFolder, err = util.UserHomeDir() - } - if err != nil { - return "", err - } - - folder := filepath.Join(homeFolder, ".openvscode-server") - // #nosec G301 -- TODO Consider using a more secure permission setting and ownership if needed. - err = os.MkdirAll(folder, 0o755) - if err != nil { - return "", err - } - - return folder, nil + return serverutil.PrepareLocation(userName, ".openvscode-server") } diff --git a/pkg/ide/vscodeweb/vscodeweb.go b/pkg/ide/vscodeweb/vscodeweb.go index 36e1341351..def80e040b 100644 --- a/pkg/ide/vscodeweb/vscodeweb.go +++ b/pkg/ide/vscodeweb/vscodeweb.go @@ -13,9 +13,9 @@ import ( "github.com/devsy-org/devsy/pkg/config" copy2 "github.com/devsy-org/devsy/pkg/copy" "github.com/devsy-org/devsy/pkg/ide" + "github.com/devsy-org/devsy/pkg/ide/internal/serverutil" "github.com/devsy-org/devsy/pkg/ide/vscode" "github.com/devsy-org/devsy/pkg/log" - "github.com/devsy-org/devsy/pkg/util" ) // Release URL format for the standalone VS Code CLI. The CLI tarball contains a @@ -61,6 +61,14 @@ var Options = ide.Options{ }, } +var downloadSpec = serverutil.ReleaseSpec{ + Options: Options, + Amd64Option: DownloadAmd64Option, + Arm64Option: DownloadArm64Option, + Amd64Template: downloadAmd64Template, + Arm64Template: downloadArm64Template, +} + const archArm64 = "arm64" // DefaultVSCodeWebPort sits next to openvscode (10800) and code-server (10801) @@ -137,10 +145,8 @@ func (v *VSCodeWeb) Install() error { return fmt.Errorf("install settings: %w", err) } - if v.userName != "" { - if err := copy2.ChownR(location, v.userName); err != nil { - return fmt.Errorf("chown: %w", err) - } + if err := serverutil.ChownIfNeeded(v.userName, location); err != nil { + return err } return nil @@ -187,7 +193,7 @@ func (v *VSCodeWeb) Start() error { "--host %q --port %q --server-data-dir %q", binary, v.host, v.port, serverDataDir(location), ) - return suOrSh(v.userName, runCommand, location), nil + return serverutil.SuOrSh(v.userName, runCommand, location), nil }) } @@ -207,20 +213,7 @@ func (v *VSCodeWeb) isInstalled(location, releaseURL string) bool { func (v *VSCodeWeb) getReleaseURL() string { version := Options.GetValue(v.values, VersionOption) - - var url string - if runtime.GOARCH == archArm64 { - url = Options.GetValue(v.values, DownloadArm64Option) - if url == "" { - url = fmt.Sprintf(downloadArm64Template, version) - } - } else { - url = Options.GetValue(v.values, DownloadAmd64Option) - if url == "" { - url = fmt.Sprintf(downloadAmd64Template, version) - } - } - return url + return downloadSpec.URL(v.values, runtime.GOARCH, version) } func (v *VSCodeWeb) installExtensions() error { @@ -233,34 +226,19 @@ func (v *VSCodeWeb) installExtensions() error { return err } - out := log.Writer(log.LevelInfo) - defer func() { _ = out.Close() }() - binary := binaryPath(location) - var failed []string - for _, extension := range v.extensions { - log.Infof("Install extension %q", extension) - runCommand := fmt.Sprintf( - "%s serve-web --server-data-dir %q --install-extension %q", - binary, serverDataDir(location), extension, - ) - cmd := suOrSh(v.userName, runCommand, "") - cmd.Stdout = out - cmd.Stderr = out - if err := cmd.Run(); err != nil { - log.Errorf("failed installing extension: extension=%q, error=%v", extension, err) - failed = append(failed, extension) - } else { - log.Infof("installed extension: extension=%q", extension) - } - } - - // Escalate only on total failure - partial failures stay as logged - // warnings to match openvscode's behavior. - if len(failed) == len(v.extensions) { - return fmt.Errorf("all %d extensions failed to install: %v", len(failed), failed) - } - return nil + return serverutil.ExtensionInstall{ + UserName: v.userName, + Extensions: v.extensions, + Command: func(extension string) string { + return fmt.Sprintf( + "%s serve-web --server-data-dir %q --install-extension %q", + binary, serverDataDir(location), extension, + ) + }, + Quote: strconv.Quote, + FailOnTotalFailure: true, + }.Run() } // installSettings writes settings.json to serve-web's Machine config dir, which @@ -294,32 +272,6 @@ func (v *VSCodeWeb) installSettings() error { return nil } -// suOrSh builds an *exec.Cmd that runs runCommand either as the unprivileged -// user (via `su -c`) or as the current user (via `sh -c`). All arg -// elements are constants from this package - runCommand itself is built from -// constants plus internal values, not user-controlled binary paths. -func suOrSh(userName, runCommand, workingDir string) *exec.Cmd { - var cmd *exec.Cmd - if userName != "" { - // #nosec G204 -- args are fixed constants; runCommand is internally built. - cmd = exec.Command("su", userName, "-c", runCommand) - } else { - // #nosec G204 -- args are fixed constants; runCommand is internally built. - cmd = exec.Command("sh", "-c", runCommand) - } - if workingDir != "" { - cmd.Dir = workingDir - } - return cmd -} - -func userHome(userName string) (string, error) { - if userName != "" { - return command.GetHome(userName) - } - return util.UserHomeDir() -} - // binaryPath is the extracted VS Code CLI binary path. func binaryPath(location string) string { return filepath.Join(location, "code") @@ -345,14 +297,5 @@ func writeReleaseMarker(location, releaseURL string) error { // if needed. It is deliberately distinct from ~/.vscode-server (used by the // desktop VS Code remote server, whose binary is itself named code-server). func prepareVSCodeWebLocation(userName string) (string, error) { - homeFolder, err := userHome(userName) - if err != nil { - return "", err - } - folder := filepath.Join(homeFolder, ".vscode-web") - // #nosec G301 -- match openvscode-server convention for parity. - if err := os.MkdirAll(folder, 0o755); err != nil { - return "", err - } - return folder, nil + return serverutil.PrepareLocation(userName, ".vscode-web") }