Merge pull request #111 from gat786/feat/set-title

feat: allowing user to set title along with the start command

Author: iximiuz

api/plays.go

@@ -364,6 +364,16 @@ func (c *Client) ListPlays(ctx context.Context, listPlaysQueryParams ListPlaysQu
 	return plays, c.GetInto(ctx, "/plays", query, nil, &plays)
 }
 
+func (c *Client) SetPlayTitle(ctx context.Context, id string, title string) (*Play, error) {
+	body, err := toJSONBody(map[string]any{"action": "set_title", "title": title})
+	if err != nil {
+		return nil, err
+	}
+
+	var p Play
+	return &p, c.PostInto(ctx, "/plays/"+id+"/actions", nil, nil, body, &p)
+}
+
 func (c *Client) StopPlay(ctx context.Context, id string) (*Play, error) {
 	body, err := toJSONBody(map[string]any{"action": "stop"})
 	if err != nil {

cmd/playground/start.go

@@ -26,6 +26,7 @@ type startOptions struct {
 	playground string
 	machine    string
 	user       string
+	title      string
 
 	file string
 	open bool
@@ -110,6 +111,12 @@ func newStartCommand(cli labcli.CLI) *cobra.Command {
 		"",
 		`SSH user (default: the machine's default login user)`,
 	)
+	flags.StringVar(
+		&opts.title,
+		"title",
+		"",
+		`Title string which once set can be used to restart, stop and ssh into`,
+	)
 	flags.BoolVarP(
 		&opts.open,
 		"open",
@@ -252,6 +259,17 @@ func runStartPlayground(ctx context.Context, cli labcli.CLI, opts *startOptions)
 
 	cli.PrintAux("New %s playground started with ID %s\n", opts.playground, play.ID)
 
+	// set a title, this should be a non-failure causing request by default
+	if opts.title != "" {
+		var playResponse *api.Play
+		playResponse, err = cli.Client().SetPlayTitle(ctx, play.ID, opts.title)
+		if err != nil {
+			cli.PrintAux(fmt.Sprintf("Unable to set title: %s, exception: %s\n", opts.title, err.Error()))
+		} else {
+			cli.PrintAux(fmt.Sprintf("Title set: %s\n", playResponse.Title))
+		}
+	}
+
 	if opts.open {
 		browser.OpenWithFallbackMessage(cli, play.PageURL)
 	}