feat: CDK component install telemetry (#1384)

Author: jon-stewart

cli/cmd/component.go

@@ -21,6 +21,7 @@ package cmd
 import (
 	"fmt"
 	"os"
+	"time"
 
 	"github.com/Masterminds/semver"
 	"github.com/fatih/color"
@@ -349,7 +350,18 @@ func componentsToTable() [][]string {
 	return out
 }
 
-func runComponentsInstall(_ *cobra.Command, args []string) (err error) {
+func runComponentsInstall(cmd *cobra.Command, args []string) (err error) {
+	var (
+		componentName string                 = args[0]
+		version       string                 = versionArg
+		params        map[string]interface{} = make(map[string]interface{})
+		start         time.Time
+	)
+
+	cli.Event.Component = componentName
+	cli.Event.Feature = "install_component"
+	defer cli.SendHoneyvent()
+
 	cli.StartProgress("Loading components state...")
 	// @afiune maybe move the state to the cache and fetch if it if has expired
 	cli.LwComponents, err = lwcomponent.LoadState(cli.LwApi)
@@ -359,21 +371,45 @@ func runComponentsInstall(_ *cobra.Command, args []string) (err error) {
 		return
 	}
 
-	component, found := cli.LwComponents.GetComponent(args[0])
+	component, found := cli.LwComponents.GetComponent(componentName)
 	if !found {
-		err = errors.New("component not found. Try running 'lacework component list'")
+		err = errors.New(fmt.Sprintf("component %s not found. Try running 'lacework component list'", componentName))
 		return
 	}
 
+	cli.OutputChecklist(successIcon, fmt.Sprintf("Component %s found\n", componentName))
+
+	if version == "" {
+		version = component.LatestVersion.String()
+	}
+
+	start = time.Now()
+
 	cli.StartProgress(fmt.Sprintf("Installing component %s...", component.Name))
-	err = cli.LwComponents.Install(args[0], versionArg)
+	err = cli.LwComponents.Install(component, version)
 	cli.StopProgress()
 	if err != nil {
 		err = errors.Wrap(err, "unable to install component")
 		return
 	}
 	cli.OutputChecklist(successIcon, "Component %s installed\n", color.HiYellowString(component.Name))
-	cli.OutputChecklist(successIcon, "Signature verified\n")
+
+	params["install_duration_ms"] = time.Since(start).Milliseconds()
+
+	start = time.Now()
+
+	cli.StartProgress("Verifing component signature...")
+	err = cli.LwComponents.Verify(component, version)
+	cli.StopProgress()
+	if err != nil {
+		err = errors.Wrap(err, "verification of component signature failed")
+		return
+	}
+	cli.OutputChecklist(successIcon, "Component signature verified\n")
+
+	params["verify_duration_ms"] = time.Since(start).Milliseconds()
+
+	start = time.Now()
 
 	cli.StartProgress(fmt.Sprintf("Configuring component %s...", component.Name))
 	// component life cycle: initialize
@@ -389,6 +425,10 @@ func runComponentsInstall(_ *cobra.Command, args []string) (err error) {
 	cli.OutputChecklist(successIcon, "Component configured\n")
 	cli.OutputHuman("\nInstallation completed.\n")
 
+	params["configure_duration_ms"] = time.Since(start).Milliseconds()
+
+	cli.Event.FeatureData = params
+
 	if component.Breadcrumbs.InstallationMessage != "" {
 		cli.OutputHuman("\n")
 		cli.OutputHuman(component.Breadcrumbs.InstallationMessage)
@@ -407,13 +447,17 @@ func runComponentsUpdate(_ *cobra.Command, args []string) (err error) {
 		return
 	}
 
+	component_name := args[0]
+
 	component, found := cli.LwComponents.GetComponent(args[0])
 	if !found {
-		err = errors.New("component not found. Try running 'lacework component list'")
+		err = errors.New(fmt.Sprintf("component %s not found. Try running 'lacework component list'", component_name))
 		return
 	}
 	// @afiune end boilerplate load components
 
+	cli.OutputChecklist(successIcon, fmt.Sprintf("Component %s found\n", component_name))
+
 	updateTo := component.LatestVersion
 	if versionArg != "" {
 		parsedVersion, err := semver.NewVersion(versionArg)
@@ -434,8 +478,8 @@ func runComponentsUpdate(_ *cobra.Command, args []string) (err error) {
 		return nil
 	}
 
-	cli.StartProgress(fmt.Sprintf("Updating component %s...", component.Name))
-	err = cli.LwComponents.Install(args[0], updateTo.String())
+	cli.StartProgress(fmt.Sprintf("Updating component %s to version %s...", component.Name, &updateTo))
+	err = cli.LwComponents.Install(component, updateTo.String())
 	cli.StopProgress()
 	if err != nil {
 		err = errors.Wrap(err, "unable to update component")
@@ -444,7 +488,15 @@ func runComponentsUpdate(_ *cobra.Command, args []string) (err error) {
 	cli.OutputChecklist(successIcon, "Component %s updated to %s\n",
 		color.HiYellowString(component.Name),
 		color.HiCyanString(fmt.Sprintf("v%s", updateTo.String())))
-	cli.OutputChecklist(successIcon, "Signature verified\n")
+
+	cli.StartProgress("Verifing component signature...")
+	err = cli.LwComponents.Verify(component, updateTo.String())
+	cli.StopProgress()
+	if err != nil {
+		err = errors.Wrap(err, "verification of component signature failed")
+		return
+	}
+	cli.OutputChecklist(successIcon, "Component signature verified\n")
 
 	cli.StartProgress(fmt.Sprintf("Reconfiguring %s component...", component.Name))
 	// component life cycle: reconfigure

lwcomponent/component.go

@@ -222,30 +222,7 @@ func Dir() (string, error) {
 	return filepath.Join(cacheDir, "components"), nil
 }
 
-func (s State) Install(name string, version string) error {
-	component, found := s.GetComponent(name)
-	if !found {
-		return errors.New("component not found")
-	}
-
-	if version == "" {
-		version = component.LatestVersion.String()
-	}
-
-	// @edoardopirovano, December 2022: Temporary workaround while there are still old
-	// APIs out there. In particular, 0.2.0 is the version of the API result before
-	// https://github.com/lacework/rainbow/pull/10874 which added the capability for
-	// the API to return multiple versions. At the time of writing, that PR is merged
-	// but not fully rolled out. In the old version of the API result, we would only
-	// return the latest version, and wouldn't set the version field of its artifacts.
-	// So, if we're looking for the latest version we should set what we're looking
-	// for to the empty string. If we're looking for anything else, we can leave it
-	// set as it is: we'll fail to find it and report an error which is the right
-	// behaviour as only the latest version can be installed in this case.
-	if s.Version == "0.2.0" && version == component.LatestVersion.String() {
-		version = ""
-	}
-
+func (s State) Install(component *Component, version string) error {
 	rPath, err := component.RootPath()
 	if err != nil {
 		return err
@@ -285,6 +262,10 @@ func (s State) Install(name string, version string) error {
 		return errors.Wrap(err, "unable to download component artifact")
 	}
 
+	if err := component.WriteVersion(artifact.Version); err != nil {
+		return err
+	}
+
 	// @afiune check 1) cross-platform and 2) correct permissions
 	// if the file has permissions already, can we avoid this?
 	if component.IsExecutable() {
@@ -293,11 +274,24 @@ func (s State) Install(name string, version string) error {
 		}
 	}
 
+	return nil
+}
+
+func (s State) Verify(component *Component, version string) error {
+	artifact, found := component.ArtifactForRunningHost(version)
+	if !found {
+		return errors.Errorf(
+			"could not find an artifact for version %s on the current platform (%s/%s)",
+			version, runtime.GOOS, runtime.GOARCH,
+		)
+	}
+
 	if err := component.WriteSignature([]byte(artifact.Signature)); err != nil {
 		return err
 	}
 
-	if err := component.WriteVersion(artifact.Version); err != nil {
+	rPath, err := component.RootPath()
+	if err != nil {
 		return err
 	}