chore: remove unnecessary binding of root cmd flags (keploy#1715)

Signed-off-by: gouravkrosx <[email protected]>
Yaxhveer · Mar 20, 2024 · fd210aa · fd210aa
1 parent 895f699
commit fd210aa
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/cli/provider/cmd.go b/cli/provider/cmd.go
@@ -209,26 +209,29 @@ func (c *CmdConfigurator) AddFlags(cmd *cobra.Command, cfg *config.Config) error
 			utils.LogError(c.logger, err, errMsg)
 			return errors.New(errMsg)
 		}
-		err := viper.BindPFlag("debug", cmd.PersistentFlags().Lookup("debug"))
-		if err != nil {
-			errMsg := "failed to bind flag to config"
-			utils.LogError(c.logger, err, errMsg)
-			return errors.New(errMsg)
-		}
 	default:
 		return errors.New("unknown command name")
 	}
 	return nil
 }
 
-func (c CmdConfigurator) ValidateFlags(ctx context.Context, cmd *cobra.Command, cfg *config.Config) error {
+func (c *CmdConfigurator) ValidateFlags(ctx context.Context, cmd *cobra.Command, cfg *config.Config) error {
+	// used to bind common flags for commands like record, test. For eg: PATH, PORT, COMMAND etc.
 	err := viper.BindPFlags(cmd.Flags())
-	utils.BindFlagsToViper(c.logger, cmd, "")
 	if err != nil {
 		errMsg := "failed to bind flags to config"
 		utils.LogError(c.logger, err, errMsg)
 		return errors.New(errMsg)
 	}
+
+	//used to bind flags specific to the command for eg: testsets, delay, recordTimer etc. (nested flags)
+	err = utils.BindFlagsToViper(c.logger, cmd, "")
+	if err != nil {
+		errMsg := "failed to bind cmd specific flags to viper"
+		utils.LogError(c.logger, err, errMsg)
+		return errors.New(errMsg)
+	}
+
 	if cmd.Name() == "test" || cmd.Name() == "record" {
 		configPath, err := cmd.Flags().GetString("configPath")
 		if err != nil {

diff --git a/cli/provider/service.go b/cli/provider/service.go
@@ -41,15 +41,15 @@ func NewServiceProvider(logger *zap.Logger, configDb *configdb.ConfigDb) *Servic
 }
 
 func (n *ServiceProvider) GetTelemetryService(ctx context.Context, config config.Config) (*telemetry.Telemetry, error) {
-	installtionID, err := n.configDb.GetInstallationID(ctx)
+	installationID, err := n.configDb.GetInstallationID(ctx)
 	if err != nil {
 		return nil, errors.New("failed to get installation id")
 	}
 	return telemetry.NewTelemetry(n.logger, telemetry.Options{
 		Enabled:        !config.DisableTele,
 		Version:        utils.Version,
 		GlobalMap:      map[string]interface{}{},
-		InstallationID: installtionID,
+		InstallationID: installationID,
 	},
 	), nil
 }

diff --git a/utils/utils.go b/utils/utils.go
@@ -28,7 +28,8 @@ import (
 
 var WarningSign = "\U000026A0"
 
-func BindFlagsToViper(logger *zap.Logger, cmd *cobra.Command, viperKeyPrefix string) {
+func BindFlagsToViper(logger *zap.Logger, cmd *cobra.Command, viperKeyPrefix string) error {
+	var bindErr error
 	cmd.Flags().VisitAll(func(flag *pflag.Flag) {
 		// Construct the Viper key and the env variable name
 		if viperKeyPrefix == "" {
@@ -43,14 +44,17 @@ func BindFlagsToViper(logger *zap.Logger, cmd *cobra.Command, viperKeyPrefix str
 		err := viper.BindPFlag(viperKey, flag)
 		if err != nil {
 			LogError(logger, err, "failed to bind flag to config")
+			bindErr = err
 		}
 
 		// Tell Viper to also read this flag's value from the corresponding env variable
 		err = viper.BindEnv(viperKey, envVarName)
 		if err != nil {
 			LogError(logger, err, "failed to bind environment variables to config")
+			bindErr = err
 		}
 	})
+	return bindErr
 }
 
 //func ModifyToSentryLogger(ctx context.Context, logger *zap.Logger, client *sentry.Client, configDb *configdb.ConfigDb) *zap.Logger {