Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 24 additions & 82 deletions pkg/ide/codeserver/codeserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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
}
Expand All @@ -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 {
Expand All @@ -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,
Expand All @@ -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
}
Expand All @@ -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 <user> -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):
// <home>/.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")
}
21 changes: 2 additions & 19 deletions pkg/ide/fleet/fleet.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down Expand Up @@ -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")
}
143 changes: 143 additions & 0 deletions pkg/ide/internal/serverutil/serverutil.go
Original file line number Diff line number Diff line change
@@ -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 <user> -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 <home>/<dirName> 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
}
Loading
Loading