- Notifications
You must be signed in to change notification settings - Fork907
feat(cli): add open app <workspace> <app-slug> command#17032
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
174 changes: 174 additions & 0 deletionscli/open.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -2,11 +2,14 @@ package cli | ||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
| "path" | ||
| "path/filepath" | ||
| "runtime" | ||
| "slices" | ||
| "strings" | ||
| "github.com/skratchdot/open-golang/open" | ||
| @@ -26,6 +29,7 @@ func (r *RootCmd) open() *serpent.Command { | ||
| }, | ||
| Children: []*serpent.Command{ | ||
| r.openVSCode(), | ||
| r.openApp(), | ||
| }, | ||
| } | ||
| return cmd | ||
| @@ -211,6 +215,131 @@ func (r *RootCmd) openVSCode() *serpent.Command { | ||
| return cmd | ||
| } | ||
| func (r *RootCmd) openApp() *serpent.Command { | ||
| var ( | ||
| regionArg string | ||
| testOpenError bool | ||
| ) | ||
| client := new(codersdk.Client) | ||
| cmd := &serpent.Command{ | ||
| Annotations: workspaceCommand, | ||
| Use: "app <workspace> <app slug>", | ||
| Short: "Open a workspace application.", | ||
| Middleware: serpent.Chain( | ||
| r.InitClient(client), | ||
| ), | ||
| Handler: func(inv *serpent.Invocation) error { | ||
| ctx, cancel := context.WithCancel(inv.Context()) | ||
| defer cancel() | ||
| if len(inv.Args) == 0 || len(inv.Args) > 2 { | ||
| return inv.Command.HelpHandler(inv) | ||
| } | ||
| workspaceName := inv.Args[0] | ||
| ws, agt, err := getWorkspaceAndAgent(ctx, inv, client, false, workspaceName) | ||
| if err != nil { | ||
| var sdkErr *codersdk.Error | ||
| if errors.As(err, &sdkErr) && sdkErr.StatusCode() == http.StatusNotFound { | ||
| cliui.Errorf(inv.Stderr, "Workspace %q not found!", workspaceName) | ||
| return sdkErr | ||
| } | ||
| cliui.Errorf(inv.Stderr, "Failed to get workspace and agent: %s", err) | ||
| return err | ||
| } | ||
| allAppSlugs := make([]string, len(agt.Apps)) | ||
| for i, app := range agt.Apps { | ||
| allAppSlugs[i] = app.Slug | ||
| } | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| slices.Sort(allAppSlugs) | ||
| // If a user doesn't specify an app slug, we'll just list the available | ||
| // apps and exit. | ||
| if len(inv.Args) == 1 { | ||
| cliui.Infof(inv.Stderr, "Available apps in %q: %v", workspaceName, allAppSlugs) | ||
| return nil | ||
| } | ||
| appSlug := inv.Args[1] | ||
| var foundApp codersdk.WorkspaceApp | ||
| appIdx := slices.IndexFunc(agt.Apps, func(a codersdk.WorkspaceApp) bool { | ||
| return a.Slug == appSlug | ||
| }) | ||
| if appIdx == -1 { | ||
| cliui.Errorf(inv.Stderr, "App %q not found in workspace %q!\nAvailable apps: %v", appSlug, workspaceName, allAppSlugs) | ||
| return xerrors.Errorf("app not found") | ||
| } | ||
| foundApp = agt.Apps[appIdx] | ||
| // To build the app URL, we need to know the wildcard hostname | ||
| // and path app URL for the region. | ||
| regions, err := client.Regions(ctx) | ||
| if err != nil { | ||
| return xerrors.Errorf("failed to fetch regions: %w", err) | ||
| } | ||
| var region codersdk.Region | ||
| preferredIdx := slices.IndexFunc(regions, func(r codersdk.Region) bool { | ||
| return r.Name == regionArg | ||
| }) | ||
| if preferredIdx == -1 { | ||
| allRegions := make([]string, len(regions)) | ||
| for i, r := range regions { | ||
| allRegions[i] = r.Name | ||
| } | ||
| cliui.Errorf(inv.Stderr, "Preferred region %q not found!\nAvailable regions: %v", regionArg, allRegions) | ||
| return xerrors.Errorf("region not found") | ||
| } | ||
| region = regions[preferredIdx] | ||
| baseURL, err := url.Parse(region.PathAppURL) | ||
| if err != nil { | ||
| return xerrors.Errorf("failed to parse proxy URL: %w", err) | ||
| } | ||
| baseURL.Path = "" | ||
| pathAppURL := strings.TrimPrefix(region.PathAppURL, baseURL.String()) | ||
| appURL := buildAppLinkURL(baseURL, ws, agt, foundApp, region.WildcardHostname, pathAppURL) | ||
| // Check if we're inside a workspace. Generally, we know | ||
| // that if we're inside a workspace, `open` can't be used. | ||
| insideAWorkspace := inv.Environ.Get("CODER") == "true" | ||
| if insideAWorkspace { | ||
| _, _ = fmt.Fprintf(inv.Stderr, "Please open the following URI on your local machine:\n\n") | ||
| _, _ = fmt.Fprintf(inv.Stdout, "%s\n", appURL) | ||
| return nil | ||
| } | ||
| _, _ = fmt.Fprintf(inv.Stderr, "Opening %s\n", appURL) | ||
| if !testOpenError { | ||
| err = open.Run(appURL) | ||
| } else { | ||
| err = xerrors.New("test.open-error") | ||
| } | ||
| return err | ||
| }, | ||
| } | ||
| cmd.Options = serpent.OptionSet{ | ||
| { | ||
| Flag: "region", | ||
| Env: "CODER_OPEN_APP_REGION", | ||
| Description: fmt.Sprintf("Region to use when opening the app." + | ||
| " By default, the app will be opened using the main Coder deployment (a.k.a. \"primary\")."), | ||
| Value: serpent.StringOf(®ionArg), | ||
| Default: "primary", | ||
| }, | ||
| { | ||
| Flag: "test.open-error", | ||
| Description: "Don't run the open command.", | ||
| Value: serpent.BoolOf(&testOpenError), | ||
| Hidden: true, // This is for testing! | ||
| }, | ||
| } | ||
| return cmd | ||
| } | ||
| // 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) { | ||
| @@ -337,3 +466,48 @@ func doAsync(f func()) (wait func()) { | ||
| <-done | ||
| } | ||
| } | ||
| // buildAppLinkURL returns the URL to open the app in the browser. | ||
| // It follows similar logic to the TypeScript implementation in site/src/utils/app.ts | ||
| // except that all URLs returned are absolute and based on the provided base URL. | ||
| func buildAppLinkURL(baseURL *url.URL, workspace codersdk.Workspace, agent codersdk.WorkspaceAgent, app codersdk.WorkspaceApp, appsHost, preferredPathBase string) string { | ||
| // If app is external, return the URL directly | ||
| if app.External { | ||
| return app.URL | ||
| } | ||
| var u url.URL | ||
| u.Scheme = baseURL.Scheme | ||
| u.Host = baseURL.Host | ||
| // We redirect if we don't include a trailing slash, so we always include one to avoid extra roundtrips. | ||
| u.Path = fmt.Sprintf( | ||
| "%s/@%s/%s.%s/apps/%s/", | ||
| preferredPathBase, | ||
| workspace.OwnerName, | ||
| workspace.Name, | ||
| agent.Name, | ||
| url.PathEscape(app.Slug), | ||
| ) | ||
| // The frontend leaves the returns a relative URL for the terminal, but we don't have that luxury. | ||
| if app.Command != "" { | ||
| u.Path = fmt.Sprintf( | ||
| "%s/@%s/%s.%s/terminal", | ||
| preferredPathBase, | ||
| workspace.OwnerName, | ||
| workspace.Name, | ||
| agent.Name, | ||
| ) | ||
| q := u.Query() | ||
| q.Set("command", app.Command) | ||
| u.RawQuery = q.Encode() | ||
| // encodeURIComponent replaces spaces with %20 but url.QueryEscape replaces them with +. | ||
| // We replace them with %20 to match the TypeScript implementation. | ||
| u.RawQuery = strings.ReplaceAll(u.RawQuery, "+", "%20") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: I'm not sure if this is strictly necessary? Did it for completeness' sake. | ||
| } | ||
| if appsHost != "" && app.Subdomain && app.SubdomainName != "" { | ||
| u.Host = strings.Replace(appsHost, "*", app.SubdomainName, 1) | ||
| u.Path = "/" | ||
| } | ||
| return u.String() | ||
| } | ||
114 changes: 113 additions & 1 deletioncli/open_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,14 @@ | ||
| package cli | ||
| import ( | ||
| "net/url" | ||
| "testing" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| func Test_resolveAgentAbsPath(t *testing.T) { | ||
| t.Parallel() | ||
| @@ -54,3 +62,107 @@ func Test_resolveAgentAbsPath(t *testing.T) { | ||
| }) | ||
| } | ||
| } | ||
| func Test_buildAppLinkURL(t *testing.T) { | ||
MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: I adapted the test cases from | ||
| t.Parallel() | ||
| for _, tt := range []struct { | ||
| name string | ||
| // function arguments | ||
| baseURL string | ||
| workspace codersdk.Workspace | ||
| agent codersdk.WorkspaceAgent | ||
| app codersdk.WorkspaceApp | ||
| appsHost string | ||
| preferredPathBase string | ||
| // expected results | ||
| expectedLink string | ||
| }{ | ||
| { | ||
| name: "external url", | ||
| baseURL: "https://coder.tld", | ||
| app: codersdk.WorkspaceApp{ | ||
| External: true, | ||
| URL: "https://external-url.tld", | ||
| }, | ||
| expectedLink: "https://external-url.tld", | ||
| }, | ||
| { | ||
| name: "without subdomain", | ||
| baseURL: "https://coder.tld", | ||
| workspace: codersdk.Workspace{ | ||
| Name: "Test-Workspace", | ||
| OwnerName: "username", | ||
| }, | ||
| agent: codersdk.WorkspaceAgent{ | ||
| Name: "a-workspace-agent", | ||
| }, | ||
| app: codersdk.WorkspaceApp{ | ||
| Slug: "app-slug", | ||
| Subdomain: false, | ||
| }, | ||
| preferredPathBase: "/path-base", | ||
| expectedLink: "https://coder.tld/path-base/@username/Test-Workspace.a-workspace-agent/apps/app-slug/", | ||
| }, | ||
| { | ||
| name: "with command", | ||
| baseURL: "https://coder.tld", | ||
| workspace: codersdk.Workspace{ | ||
| Name: "Test-Workspace", | ||
| OwnerName: "username", | ||
| }, | ||
| agent: codersdk.WorkspaceAgent{ | ||
| Name: "a-workspace-agent", | ||
| }, | ||
| app: codersdk.WorkspaceApp{ | ||
| Command: "ls -la", | ||
| }, | ||
| expectedLink: "https://coder.tld/@username/Test-Workspace.a-workspace-agent/terminal?command=ls%20-la", | ||
| }, | ||
| { | ||
| name: "with subdomain", | ||
| baseURL: "ftps://coder.tld", | ||
| workspace: codersdk.Workspace{ | ||
| Name: "Test-Workspace", | ||
| OwnerName: "username", | ||
| }, | ||
| agent: codersdk.WorkspaceAgent{ | ||
| Name: "a-workspace-agent", | ||
| }, | ||
| app: codersdk.WorkspaceApp{ | ||
| Subdomain: true, | ||
| SubdomainName: "hellocoder", | ||
| }, | ||
| preferredPathBase: "/path-base", | ||
| appsHost: "*.apps-host.tld", | ||
| expectedLink: "ftps://hellocoder.apps-host.tld/", | ||
| }, | ||
| { | ||
| name: "with subdomain, but not apps host", | ||
| baseURL: "https://coder.tld", | ||
| workspace: codersdk.Workspace{ | ||
| Name: "Test-Workspace", | ||
| OwnerName: "username", | ||
| }, | ||
| agent: codersdk.WorkspaceAgent{ | ||
| Name: "a-workspace-agent", | ||
| }, | ||
| app: codersdk.WorkspaceApp{ | ||
| Slug: "app-slug", | ||
| Subdomain: true, | ||
| SubdomainName: "It really doesn't matter what this is without AppsHost.", | ||
| }, | ||
| preferredPathBase: "/path-base", | ||
| expectedLink: "https://coder.tld/path-base/@username/Test-Workspace.a-workspace-agent/apps/app-slug/", | ||
| }, | ||
| } { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| baseURL, err := url.Parse(tt.baseURL) | ||
| require.NoError(t, err) | ||
| actual := buildAppLinkURL(baseURL, tt.workspace, tt.agent, tt.app, tt.appsHost, tt.preferredPathBase) | ||
| assert.Equal(t, tt.expectedLink, actual) | ||
| }) | ||
| } | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.