Skip to content

feat(cli): support opening devcontainers in vscode #17189

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.

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 9 commits into from
Apr 3, 2025
145 changes: 127 additions & 18 deletions cli/open.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func (r *RootCmd) openVSCode() *serpent.Command {
generateToken bool
testOpenError bool
appearanceConfig codersdk.AppearanceConfig
containerName string
)

client := new(codersdk.Client)
Expand Down Expand Up @@ -112,27 +113,48 @@ func (r *RootCmd) openVSCode() *serpent.Command {
if len(inv.Args) > 1 {
directory = inv.Args[1]
}
directory, err = resolveAgentAbsPath(workspaceAgent.ExpandedDirectory, directory, workspaceAgent.OperatingSystem, insideThisWorkspace)
if err != nil {
return xerrors.Errorf("resolve agent path: %w", err)
}

u := &url.URL{
Scheme: "vscode",
Host: "coder.coder-remote",
Path: "/open",
}
if containerName != "" {
containers, err := client.WorkspaceAgentListContainers(ctx, workspaceAgent.ID, map[string]string{"devcontainer.local_folder": ""})
if err != nil {
return xerrors.Errorf("list workspace agent containers: %w", err)
}

qp := url.Values{}
var foundContainer bool

qp.Add("url", client.URL.String())
qp.Add("owner", workspace.OwnerName)
qp.Add("workspace", workspace.Name)
qp.Add("agent", workspaceAgent.Name)
if directory != "" {
qp.Add("folder", directory)
for _, container := range containers.Containers {
if container.FriendlyName != containerName {
continue
}

foundContainer = true

if directory == "" {
localFolder, ok := container.Labels["devcontainer.local_folder"]
if !ok {
return xerrors.New("container missing `devcontainer.local_folder` label")
}

directory, ok = container.Volumes[localFolder]
if !ok {
return xerrors.New("container missing volume for `devcontainer.local_folder`")
}
}

break
}

if !foundContainer {
return xerrors.New("no container found")
}
}

directory, err = resolveAgentAbsPath(workspaceAgent.ExpandedDirectory, directory, workspaceAgent.OperatingSystem, insideThisWorkspace)
if err != nil {
return xerrors.Errorf("resolve agent path: %w", err)
}

var token string
// We always set the token if we believe we can open without
// printing the URI, otherwise the token must be explicitly
// requested as it will be printed in plain text.
Expand All @@ -145,10 +167,31 @@ func (r *RootCmd) openVSCode() *serpent.Command {
if err != nil {
return xerrors.Errorf("create API key: %w", err)
}
qp.Add("token", apiKey.Key)
token = apiKey.Key
}

u.RawQuery = qp.Encode()
var (
u *url.URL
qp url.Values
)
if containerName != "" {
u, qp = buildVSCodeWorkspaceDevContainerLink(
token,
client.URL.String(),
workspace,
workspaceAgent,
containerName,
directory,
)
} else {
u, qp = buildVSCodeWorkspaceLink(
token,
client.URL.String(),
workspace,
workspaceAgent,
directory,
)
}

openingPath := workspaceName
if directory != "" {
Expand Down Expand Up @@ -204,6 +247,13 @@ func (r *RootCmd) openVSCode() *serpent.Command {
),
Value: serpent.BoolOf(&generateToken),
},
{
Flag: "container",
FlagShorthand: "c",
Description: "Container name to connect to in the workspace.",
Value: serpent.StringOf(&containerName),
Hidden: true, // Hidden until this features is at least in beta.
},
{
Flag: "test.open-error",
Description: "Don't run the open command.",
Expand Down Expand Up @@ -344,6 +394,65 @@ func (r *RootCmd) openApp() *serpent.Command {
return cmd
}

func buildVSCodeWorkspaceLink(
token string,
clientURL string,
workspace codersdk.Workspace,
workspaceAgent codersdk.WorkspaceAgent,
directory string,
) (*url.URL, url.Values) {
qp := url.Values{}
qp.Add("url", clientURL)
qp.Add("owner", workspace.OwnerName)
qp.Add("workspace", workspace.Name)
qp.Add("agent", workspaceAgent.Name)

if directory != "" {
qp.Add("folder", directory)
}

if token != "" {
qp.Add("token", token)
}

return &url.URL{
Scheme: "vscode",
Host: "coder.coder-remote",
Path: "/open",
RawQuery: qp.Encode(),
}, qp
}

func buildVSCodeWorkspaceDevContainerLink(
token string,
clientURL string,
workspace codersdk.Workspace,
workspaceAgent codersdk.WorkspaceAgent,
containerName string,
containerFolder string,
) (*url.URL, url.Values) {
containerFolder = filepath.ToSlash(containerFolder)

qp := url.Values{}
qp.Add("url", clientURL)
qp.Add("owner", workspace.OwnerName)
qp.Add("workspace", workspace.Name)
qp.Add("agent", workspaceAgent.Name)
qp.Add("devContainerName", containerName)
qp.Add("devContainerFolder", containerFolder)

if token != "" {
qp.Add("token", token)
}

return &url.URL{
Scheme: "vscode",
Host: "coder.coder-remote",
Path: "/openDevContainer",
RawQuery: qp.Encode(),
}, qp
}

// waitForAgentCond uses the watch workspace API to update the agent information
// until the condition is met.
func waitForAgentCond(ctx context.Context, client *codersdk.Client, workspace codersdk.Workspace, workspaceAgent codersdk.WorkspaceAgent, cond func(codersdk.WorkspaceAgent) bool) (codersdk.Workspace, codersdk.WorkspaceAgent, error) {
Expand Down
Loading
Loading