Use Bubbletea TUI library (#2923)

This replaces the TUI library used in elastic-package with "github.com/charmbracelet/bubbletea".

The previously used library has more limited functionality, and is also currently unmaintained. Switching to bubbletea will support some upcoming improvements to elastic-package, which will involve more user interaction, and will benefit from the improved UI elements that are available with bubbletea. This adds a tui package which contains the TUI components, and converts the existing users of survey to use the tui package.

Author: mjwolf

cmd/create_data_stream.go

@@ -10,14 +10,12 @@ import (
 	"maps"
 	"slices"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/Masterminds/semver/v3"
-
 	"github.com/spf13/cobra"
 
 	"github.com/elastic/elastic-package/internal/packages"
 	"github.com/elastic/elastic-package/internal/packages/archetype"
-	"github.com/elastic/elastic-package/internal/surveyext"
+	"github.com/elastic/elastic-package/internal/tui"
 )
 
 var semver3_2_0 = semver.MustParse("3.2.0")
@@ -64,39 +62,33 @@ func createDataStreamCommandAction(cmd *cobra.Command, args []string) error {
 	qs := getInitialSurveyQuestionsForVersion(sv)
 
 	var answers newDataStreamAnswers
-	err = survey.Ask(qs, &answers)
+	err = tui.Ask(qs, &answers)
 	if err != nil {
 		return fmt.Errorf("prompt failed: %w", err)
 	}
 
 	if answers.Type == "metrics" {
-		qs := []*survey.Question{
+		qs := []*tui.Question{
 			{
-				Name: "syntheticAndTimeSeries",
-				Prompt: &survey.Confirm{
-					Message: "Enable time series and synthetic source?",
-					Default: true,
-				},
-				Validate: survey.Required,
+				Name:     "syntheticAndTimeSeries",
+				Prompt:   tui.NewConfirm("Enable time series and synthetic source?", true),
+				Validate: tui.Required,
 			},
 		}
-		err = survey.Ask(qs, &answers)
+		err = tui.Ask(qs, &answers)
 		if err != nil {
 			return fmt.Errorf("prompt failed: %w", err)
 		}
 
 		if !answers.SyntheticAndTimeSeries {
-			qs := []*survey.Question{
+			qs := []*tui.Question{
 				{
-					Name: "synthetic",
-					Prompt: &survey.Confirm{
-						Message: "Enable synthetic source?",
-						Default: true,
-					},
-					Validate: survey.Required,
+					Name:     "synthetic",
+					Prompt:   tui.NewConfirm("Enable synthetic source?", true),
+					Validate: tui.Required,
 				},
 			}
-			err = survey.Ask(qs, &answers)
+			err = tui.Ask(qs, &answers)
 			if err != nil {
 				return fmt.Errorf("prompt failed: %w", err)
 			}
@@ -124,24 +116,23 @@ func createDataStreamCommandAction(cmd *cobra.Command, args []string) error {
 			"udp":                "UDP",
 			"winlog":             "WinLogBeat",
 		}
-		qs := []*survey.Question{
+		multiSelect := tui.NewMultiSelect("Select input types which will be used in this data stream. See https://www.elastic.co/docs/reference/fleet/elastic-agent-inputs-list for description of the inputs", slices.Sorted(maps.Keys(inputsMap)), []string{})
+		multiSelect.SetPageSize(50)
+		multiSelect.SetDescription(func(value string, index int) string {
+			val, ok := inputsMap[value]
+			if ok {
+				return val
+			}
+			return ""
+		})
+
+		qs := []*tui.Question{
 			{
-				Name: "inputs",
-				Prompt: &survey.MultiSelect{
-					Message:  "Select input types which will be used in this data stream. See https://www.elastic.co/docs/reference/fleet/elastic-agent-inputs-list for description of the inputs",
-					Options:  slices.Sorted(maps.Keys(inputsMap)),
-					PageSize: 50,
-					Description: func(value string, index int) string {
-						val, ok := inputsMap[value]
-						if ok {
-							return val
-						}
-						return ""
-					},
-				},
+				Name:   "inputs",
+				Prompt: multiSelect,
 			},
 		}
-		err = survey.Ask(qs, &answers)
+		err = tui.Ask(qs, &answers)
 		if err != nil {
 			return fmt.Errorf("prompt failed: %w", err)
 		}
@@ -206,44 +197,31 @@ func createDataStreamDescriptorFromAnswers(answers newDataStreamAnswers, package
 	}
 }
 
-func getInitialSurveyQuestionsForVersion(specVersion *semver.Version) []*survey.Question {
-	validator := surveyext.Validator{Cwd: "."}
-	qs := []*survey.Question{
+func getInitialSurveyQuestionsForVersion(specVersion *semver.Version) []*tui.Question {
+	validator := tui.Validator{Cwd: "."}
+	qs := []*tui.Question{
 		{
-			Name: "name",
-			Prompt: &survey.Input{
-				Message: "Data stream name:",
-				Default: "new_data_stream",
-			},
-			Validate: survey.ComposeValidators(survey.Required, validator.DataStreamDoesNotExist, validator.DataStreamName),
+			Name:     "name",
+			Prompt:   tui.NewInput("Data stream name", "new_data_stream"),
+			Validate: tui.ComposeValidators(tui.Required, validator.DataStreamDoesNotExist, validator.DataStreamName),
 		},
 		{
-			Name: "title",
-			Prompt: &survey.Input{
-				Message: "Data stream title:",
-				Default: "New Data Stream",
-			},
-			Validate: survey.Required,
+			Name:     "title",
+			Prompt:   tui.NewInput("Data stream title", "New Data Stream"),
+			Validate: tui.Required,
 		},
 		{
-			Name: "type",
-			Prompt: &survey.Select{
-				Message: "Type:",
-				Options: []string{"logs", "metrics"},
-				Default: "logs",
-			},
-			Validate: survey.Required,
+			Name:     "type",
+			Prompt:   tui.NewSelect("Type", []string{"logs", "metrics"}, "logs"),
+			Validate: tui.Required,
 		},
 	}
 
 	if !specVersion.LessThan(semver3_2_0) {
-		qs = append(qs, &survey.Question{
-			Name: "subobjects",
-			Prompt: &survey.Confirm{
-				Message: "Enable creation of subobjects for fields with dots in their names?",
-				Default: false,
-			},
-			Validate: survey.Required,
+		qs = append(qs, &tui.Question{
+			Name:     "subobjects",
+			Prompt:   tui.NewConfirm("Enable creation of subobjects for fields with dots in their names?", false),
+			Validate: tui.Required,
 		})
 	}
 

cmd/create_data_stream_test.go

@@ -7,10 +7,11 @@ package cmd
 import (
 	"testing"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/Masterminds/semver/v3"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/elastic/elastic-package/internal/tui"
 )
 
 func TestGetSurveyQuestionsForVersion_BelowSemver3_2_0(t *testing.T) {
@@ -20,11 +21,11 @@ func TestGetSurveyQuestionsForVersion_BelowSemver3_2_0(t *testing.T) {
 	require.Len(t, questions, 3, "should return 3 questions for spec version < 3.2.0")
 
 	assert.Equal(t, "name", questions[0].Name)
-	assert.IsType(t, &survey.Input{}, questions[0].Prompt)
+	assert.IsType(t, &tui.Input{}, questions[0].Prompt)
 	assert.Equal(t, "title", questions[1].Name)
-	assert.IsType(t, &survey.Input{}, questions[1].Prompt)
+	assert.IsType(t, &tui.Input{}, questions[1].Prompt)
 	assert.Equal(t, "type", questions[2].Name)
-	assert.IsType(t, &survey.Select{}, questions[2].Prompt)
+	assert.IsType(t, &tui.Select{}, questions[2].Prompt)
 }
 
 func TestGetSurveyQuestionsForVersion_EqualSemver3_2_0(t *testing.T) {
@@ -34,7 +35,7 @@ func TestGetSurveyQuestionsForVersion_EqualSemver3_2_0(t *testing.T) {
 	require.Len(t, questions, 4, "should return 4 questions for spec version >= 3.2.0")
 
 	assert.Equal(t, "subobjects", questions[3].Name)
-	assert.IsType(t, &survey.Confirm{}, questions[3].Prompt)
+	assert.IsType(t, &tui.Confirm{}, questions[3].Prompt)
 }
 
 func TestGetSurveyQuestionsForVersion_AboveSemver3_2_0(t *testing.T) {
@@ -44,7 +45,7 @@ func TestGetSurveyQuestionsForVersion_AboveSemver3_2_0(t *testing.T) {
 	require.Len(t, questions, 4, "should return 4 questions for spec version > 3.2.0")
 
 	assert.Equal(t, "subobjects", questions[3].Name)
-	assert.IsType(t, &survey.Confirm{}, questions[3].Prompt)
+	assert.IsType(t, &tui.Confirm{}, questions[3].Prompt)
 }
 
 func TestCreateDataStreamDescriptorFromAnswers_SubobjectsFalseForSpecVersionBelow3_2_0(t *testing.T) {