Function findWorkspaceAndAgentByHostname

cli/ssh.go:892–928

findWorkspaceAndAgentByHostname parses the hostname from the commandline and finds the workspace and agent it corresponds to, taking into account any name prefixes or suffixes configured (e.g. myworkspace.coder, or vscode-coder--myusername--myworkspace).

(
	ctx context.Context, inv *serpent.Invocation, client *codersdk.Client,
	hostname string, config codersdk.SSHConfigResponse, disableAutostart bool,
)

// corresponds to, taking into account any name prefixes or suffixes configured (e.g. myworkspace.coder, or
// vscode-coder--myusername--myworkspace).
func findWorkspaceAndAgentByHostname(
	ctx context.Context, inv *serpent.Invocation, client *codersdk.Client,
	hostname string, config codersdk.SSHConfigResponse, disableAutostart bool,
) (
	codersdk.Workspace, codersdk.WorkspaceAgent, error,
) {
	// for suffixes, we don't explicitly get the . and must add it. This is to ensure that the suffix is always
	// interpreted as a dotted label in DNS names, not just any string suffix. That is, a suffix of 'coder' will
	// match a hostname like 'en.coder', but not 'encoder'.
	qualifiedSuffix := "." + config.HostnameSuffix

	switch {
	case config.HostnamePrefix != "" && strings.HasPrefix(hostname, config.HostnamePrefix):
		hostname = strings.TrimPrefix(hostname, config.HostnamePrefix)
	case config.HostnameSuffix != "" && strings.HasSuffix(hostname, qualifiedSuffix):
		hostname = strings.TrimSuffix(hostname, qualifiedSuffix)
	}
	hostname = normalizeWorkspaceInput(hostname)

	ws, agent, otherAgents, err := GetWorkspaceAndAgent(ctx, inv, client, !disableAutostart, hostname)
	if err != nil && strings.Contains(err.Error(), "multiple agents found") {
		var errorMsg strings.Builder
		_, _ = errorMsg.WriteString(fmt.Sprintf("%s\nTry running:\n", err.Error()))
		for _, agent := range otherAgents {
			switch {
			case config.HostnameSuffix != "":
				_, _ = errorMsg.WriteString(fmt.Sprintf("	%s\n", cliui.Code(fmt.Sprintf("$ ssh %s.%s.%s.%s", agent.Name, ws.Name, ws.OwnerName, config.HostnameSuffix))))
			case config.HostnamePrefix != "":
				_, _ = errorMsg.WriteString(fmt.Sprintf("	%s\n", cliui.Code(fmt.Sprintf("$ ssh %s%s.%s.%s", config.HostnamePrefix, agent.Name, ws.Name, ws.OwnerName))))
			default:
				_, _ = errorMsg.WriteString(fmt.Sprintf("	%s\n", cliui.Code(fmt.Sprintf("$ ssh %s.%s.%s", agent.Name, ws.Name, ws.OwnerName))))
			}
		}
		return ws, agent, xerrors.New(errorMsg.String())
	}
	return ws, agent, err
}

// watchAndClose ensures closer is called if the context is canceled or
// the workspace reaches the stopped state.