feat(compositions): add --interactive mode to compositions upsert

Inject a Prompter through cmdutil.Factory (defaulted to a survey-backed
prompter in factory.New) and wire an --interactive/-i flag into
`compositions upsert` that builds the composition body with the interactive
engine instead of reading JSON from a file. Adds a group-level integration
test that drives the real command tree end to end.

Author: ben-kalmus

pkg/cmd/compositions/compositions_test.go

@@ -0,0 +1,85 @@
+package compositions_test
+
+import (
+	"io"
+	"net/http"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/algolia/cli/pkg/cmd/compositions"
+	compinternal "github.com/algolia/cli/pkg/cmd/compositions/internal"
+	"github.com/algolia/cli/pkg/httpmock"
+	"github.com/algolia/cli/pkg/interactive"
+	"github.com/algolia/cli/test"
+)
+
+// wantBody is the exact composition the interactive build produces from the
+// scripted answers below. It is a valid composition: objectID is pre-populated
+// from the positional arg, name comes from the keyed Input, and behavior selects
+// the injection variant whose main source is a search source pointing at a real
+// index. description, sortingStrategy, and all the optional query parameters are
+// unanswered and therefore omitted.
+const wantBody = `{
+	"objectID": "my-comp",
+	"name": "My Composition",
+	"behavior": {
+		"injection": {
+			"main": {
+				"source": {
+					"search": {"index": "my-index"}
+				}
+			}
+		}
+	}
+}`
+
+// Drives `compositions upsert --interactive` through the real command tree with
+// a label-keyed ScriptedPrompter on the Factory. Answers are keyed by a unique
+// substring of the prompt label, so adding or reordering SDK fields does not
+// break the INPUT side: unmatched prompts fall back to safe defaults (skip).
+func TestCompositions_UpsertInteractive(t *testing.T) {
+	r := &httpmock.Registry{}
+	var captured []byte
+	r.Register(httpmock.REST("PUT", "1/compositions/my-comp"), func(req *http.Request) (*http.Response, error) {
+		captured, _ = io.ReadAll(req.Body)
+		return httpmock.StringResponse(`{"taskID":42}`)(req)
+	})
+	r.Register(httpmock.REST("GET", "1/compositions/my-comp/task/42"), httpmock.StringResponse(`{"status":"published"}`))
+
+	compinternal.PollInterval = 1 * time.Millisecond
+	compinternal.Timeout = 50 * time.Millisecond
+	t.Cleanup(func() {
+		compinternal.PollInterval = compinternal.DefaultPollInterval
+		compinternal.Timeout = compinternal.DefaultTimeout
+	})
+
+	f, out := test.NewFactory(true, r, nil, "")
+	f.Prompter = &interactive.ScriptedPrompter{
+		Inputs: map[string]string{
+			"name":  "My Composition",
+			"index": "my-index", // behavior.injection.main.source.search.index (required)
+		},
+		Confirms: map[string]bool{
+			// Trailing "?" pins this to the source pointer confirm
+			// ("...main.source?") so it does not also match the deeper
+			// "...search.params?" confirm, whose path contains ".main.source.".
+			"main.source?": true,
+		},
+		// Both unions are keyed by their leaf "(variant)" label so the deep
+		// source select does not collide with the top-level behavior select.
+		Selects: map[string]string{
+			"behavior (variant)": "CompositionInjectionBehavior",
+			"source (variant)":   "InjectionMainSearchSource",
+		},
+	}
+
+	cmd := compositions.NewCompositionsCmd(f)
+	_, err := test.Execute(cmd, "upsert my-comp --interactive", out)
+	require.NoError(t, err)
+
+	assert.JSONEq(t, wantBody, string(captured))
+	r.Verify(t)
+}

pkg/cmd/compositions/upsert/upsert.go

@@ -11,6 +11,7 @@ import (
 	compinternal "github.com/algolia/cli/pkg/cmd/compositions/internal"
 	"github.com/algolia/cli/pkg/cmdutil"
 	"github.com/algolia/cli/pkg/config"
+	"github.com/algolia/cli/pkg/interactive"
 	"github.com/algolia/cli/pkg/iostreams"
 	"github.com/algolia/cli/pkg/validators"
 )
@@ -20,8 +21,10 @@ type UpsertOptions struct {
 	Config            config.IConfig
 	IO                *iostreams.IOStreams
 	CompositionClient func() (*algoliaComposition.APIClient, error)
+	Prompter          interactive.Prompter
 	CompositionID     string
 	File              string
+	Interactive       bool
 	PrintFlags        *cmdutil.PrintFlags
 }
 
@@ -31,6 +34,7 @@ func NewUpsertCmd(f *cmdutil.Factory) *cobra.Command {
 		IO:                f.IOStreams,
 		Config:            f.Config,
 		CompositionClient: f.CompositionClient,
+		Prompter:          f.Prompter,
 		PrintFlags:        cmdutil.NewPrintFlags().WithDefaultOutput("json"),
 	}
 
@@ -47,29 +51,63 @@ func NewUpsertCmd(f *cmdutil.Factory) *cobra.Command {
 
 			# Upsert from stdin
 			$ cat body.json | algolia compositions upsert my-comp --file -
+
+			# Build a composition interactively
+			$ algolia compositions upsert my-comp --interactive
 		`),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.CompositionID = args[0]
+
+			if opts.Interactive == (opts.File != "") {
+				return cmdutil.FlagErrorf("exactly one of `--file` or `--interactive` is required")
+			}
+			if opts.Interactive && !opts.IO.CanPrompt() {
+				return cmdutil.FlagErrorf("`--interactive` requires a terminal; use `--file` instead")
+			}
+
 			return runUpsertCmd(opts)
 		},
 	}
 
 	cmd.Flags().StringVarP(&opts.File, "file", "f", "", "JSON file path (use - for stdin)")
-	_ = cmd.MarkFlagRequired("file")
+	cmd.Flags().BoolVarP(&opts.Interactive, "interactive", "i", false, "Build the composition interactively")
 
 	opts.PrintFlags.AddFlags(cmd)
 	return cmd
 }
 
-func runUpsertCmd(opts *UpsertOptions) error {
+// buildComposition produces the composition body either interactively or by
+// reading and parsing the JSON file.
+func buildComposition(opts *UpsertOptions) (algoliaComposition.Composition, error) {
+	var comp algoliaComposition.Composition
+
+	if opts.Interactive {
+		comp.ObjectID = opts.CompositionID
+		prompter := opts.Prompter
+		if prompter == nil {
+			prompter = interactive.NewSurveyPrompter(opts.IO)
+		}
+		builder := &interactive.Builder{Prompter: prompter}
+		if err := builder.Build(&comp); err != nil {
+			return comp, fmt.Errorf("building composition: %w", err)
+		}
+		return comp, nil
+	}
+
 	raw, err := cmdutil.ReadFile(opts.File, opts.IO.In)
 	if err != nil {
-		return fmt.Errorf("reading file: %w", err)
+		return comp, fmt.Errorf("reading file: %w", err)
 	}
-
-	var comp algoliaComposition.Composition
 	if err := json.Unmarshal(raw, &comp); err != nil {
-		return fmt.Errorf("parsing composition JSON: %w", err)
+		return comp, fmt.Errorf("parsing composition JSON: %w", err)
+	}
+	return comp, nil
+}
+
+func runUpsertCmd(opts *UpsertOptions) error {
+	comp, err := buildComposition(opts)
+	if err != nil {
+		return err
 	}
 
 	client, err := opts.CompositionClient()

pkg/cmd/compositions/upsert/upsert_test.go

@@ -78,7 +78,7 @@ func TestUpsertComposition_MissingFile(t *testing.T) {
 	cmd := upsert.NewUpsertCmd(f)
 	_, err := test.Execute(cmd, "my-comp", out)
 	require.Error(t, err)
-	assert.Contains(t, err.Error(), "file")
+	assert.Contains(t, err.Error(), "exactly one of `--file` or `--interactive`")
 }
 
 func TestUpsertComposition_InvalidJSON(t *testing.T) {
@@ -99,3 +99,21 @@ func TestUpsertComposition_MissingArg(t *testing.T) {
 	require.Error(t, err)
 	assert.Contains(t, err.Error(), "requires a <composition-id> argument")
 }
+
+func TestUpsertComposition_InteractiveAndFileConflict(t *testing.T) {
+	r := &httpmock.Registry{}
+	f, out := test.NewFactory(true, r, nil, "")
+	cmd := upsert.NewUpsertCmd(f)
+	_, err := test.Execute(cmd, "my-comp --interactive --file body.json", out)
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "exactly one of `--file` or `--interactive`")
+}
+
+func TestUpsertComposition_InteractiveNoTTY(t *testing.T) {
+	r := &httpmock.Registry{}
+	f, out := test.NewFactory(false, r, nil, "") // not a TTY
+	cmd := upsert.NewUpsertCmd(f)
+	_, err := test.Execute(cmd, "my-comp --interactive", out)
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "requires a terminal")
+}

pkg/cmd/factory/default.go

@@ -13,6 +13,7 @@ import (
 	"github.com/algolia/cli/api/crawler"
 	"github.com/algolia/cli/pkg/cmdutil"
 	"github.com/algolia/cli/pkg/config"
+	"github.com/algolia/cli/pkg/interactive"
 	"github.com/algolia/cli/pkg/iostreams"
 )
 
@@ -22,6 +23,7 @@ func New(appVersion string, cfg config.IConfig) *cmdutil.Factory {
 		ExecutableName: "gh",
 	}
 	f.IOStreams = ioStreams(f)
+	f.Prompter = interactive.NewSurveyPrompter(f.IOStreams)
 	f.SearchClient = searchClient(f, appVersion)
 	f.CrawlerClient = crawlerClient(f)
 	f.CompositionClient = compositionClient(f, appVersion)

pkg/cmdutil/factory.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/algolia/cli/api/crawler"
 	"github.com/algolia/cli/pkg/config"
+	"github.com/algolia/cli/pkg/interactive"
 	"github.com/algolia/cli/pkg/iostreams"
 )
 
@@ -20,6 +21,10 @@ type Factory struct {
 	CrawlerClient     func() (*crawler.Client, error)
 	CompositionClient func() (*composition.APIClient, error)
 
+	// Prompter is the interactive input source used by commands that support
+	// an --interactive mode. Defaulted to a real SurveyPrompter in factory.New;
+	// tests set it to an interactive.ScriptedPrompter.
+	Prompter       interactive.Prompter
 	ExecutableName string
 }