Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(agent): add devcontainer autostart support #17076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Mar 27, 2025
Merged

feat(agent): add devcontainer autostart support #17076

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
63a2ec1
wip: feat(agent): add devcontainer autostart support
mafredri Mar 24, 2025
d7480cb
docs
mafredri Mar 24, 2025
9bfdfaf
expand
mafredri Mar 25, 2025
304b1a1
devcontainer scripts and timings
mafredri Mar 25, 2025
e1048b1
use name, print warning
mafredri Mar 25, 2025
d85e9a2
refactor
mafredri Mar 25, 2025
7954f8d
tmpl
mafredri Mar 25, 2025
234fc25
test
mafredri Mar 26, 2025
2d93ee3
add integration test
mafredri Mar 26, 2025
9aca1c8
unfoo
mafredri Mar 26, 2025
9c1bf01
add agentscripts test for execute option
mafredri Mar 26, 2025
ef089be
safe assign
mafredri Mar 26, 2025
55c5c46
improve logger, fix config path realtive to workspace folder
mafredri Mar 26, 2025
4676898
Update agent/agentcontainers/devcontainer.go
mafredri Mar 27, 2025
f797b41
skip path separator tests on windows
mafredri Mar 27, 2025
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
Prev Previous commit
Next Next commit
expand
  • Loading branch information
@mafredri
mafredri committed Mar 25, 2025
commit 9bfdfaf81dc46020fb152b13032d9fcb12b88000
43 changes: 30 additions & 13 deletions agent/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,7 +1075,7 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
//
// An example is VS Code Remote, which must know the directory
// before initializing a connection.
manifest.Directory, err = expandDirectory(manifest.Directory)
manifest.Directory, err = expandPathToAbs(manifest.Directory)
if err != nil {
return xerrors.Errorf("expand directory: %w", err)
}
Expand Down Expand Up @@ -1119,13 +1119,18 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
// scripts have completed.
var postStartScripts []codersdk.WorkspaceAgentScript
for _, dc := range manifest.Devcontainers {
dc = expandDevcontainerPaths(a.logger, dc)
// TODO(mafredri): Verify `@devcontainers/cli` presence.
// TODO(mafredri): Verify workspace folder exists.
// TODO(mafredri): If set, verify config path exists.
postStartScripts = append(postStartScripts, agentcontainers.DevcontainerStartupScript(dc))
}

err = a.scriptRunner.Init(manifest.Scripts, aAPI.ScriptCompleted, agentscripts.WithPostStartScripts(postStartScripts...))
err = a.scriptRunner.Init(
manifest.Scripts,
aAPI.ScriptCompleted,
agentscripts.WithPostStartScripts(postStartScripts...),
)
if err != nil {
return xerrors.Errorf("init script runner: %w", err)
}
Expand Down Expand Up @@ -1864,30 +1869,42 @@ func userHomeDir() (string, error) {
return u.HomeDir, nil
}

// expandDirectory converts a directory path to an absolute path.
// It primarily resolves the home directory and any environment
// variables that may be set
func expandDirectory(dir string) (string, error) {
if dir == "" {
// expandPathToAbs converts a path to an absolute path. It primarily resolves
// the home directory and any environment variables that may be set.
func expandPathToAbs(path string) (string, error) {
if path == "" {
return "", nil
}
if dir[0] == '~' {
if path[0] == '~' {
home, err := userHomeDir()
if err != nil {
return "", err
}
dir = filepath.Join(home, dir[1:])
path = filepath.Join(home, path[1:])
}
dir = os.ExpandEnv(dir)
path = os.ExpandEnv(path)

if !filepath.IsAbs(dir) {
if !filepath.IsAbs(path) {
home, err := userHomeDir()
if err != nil {
return "", err
}
dir = filepath.Join(home, dir)
path = filepath.Join(home, path)
}
return path, nil
}

func expandDevcontainerPaths(logger slog.Logger, dc codersdk.WorkspaceAgentDevcontainer) codersdk.WorkspaceAgentDevcontainer {
var err error
if dc.WorkspaceFolder, err = expandPathToAbs(dc.WorkspaceFolder); err != nil {
logger.Warn(context.Background(), "expand devcontainer workspace folder failed", slog.Error(err))
}
if dc.ConfigPath != "" {
if dc.ConfigPath, err = expandPathToAbs(dc.ConfigPath); err != nil {
logger.Warn(context.Background(), "expand devcontainer config path failed", slog.Error(err))
}
}
return dir, nil
return dc
}

// EnvAgentSubsystem is the environment variable used to denote the
Expand Down