change terraform download warning to debug log

hugodutka · hugodutka · commit 1f038aa412d4 · 2025-02-19T13:34:45.000Z
diff --git a/provisioner/terraform/install.go b/provisioner/terraform/install.go
@@ -64,13 +64,24 @@ func Install(ctx context.Context, log slog.Logger, dir string, wantVersion *vers
 		Version:    TerraformVersion,
 	}
 	installer.SetLogger(slog.Stdlib(ctx, log, slog.LevelDebug))
-	log.Debug(
-		ctx,
-		"installing terraform",
-		slog.F("prev_version", hasVersionStr),
-		slog.F("dir", dir),
-		slog.F("version", TerraformVersion),
-	)
+
+	logInstallCtx, logInstallCancel := context.WithCancel(ctx)
+	go func() {
+		// If the installation is taking too long, log a notice.
+		select {
+		case <-time.After(10 * time.Second):
+			log.Info(
+				logInstallCtx,
+				"installing terraform",
+				slog.F("prev_version", hasVersionStr),
+				slog.F("dir", dir),
+				slog.F("version", TerraformVersion),
+			)
+		case <-logInstallCtx.Done():
+			return
+		}
+	}()
+	defer logInstallCancel()
 
 	path, err := installer.Install(ctx)
 	if err != nil {
diff --git a/provisioner/terraform/serve.go b/provisioner/terraform/serve.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"path/filepath"
 	"sync"
+	"sync/atomic"
 	"time"
 
 	"github.com/cli/safeexec"
@@ -41,6 +42,8 @@ type ServeOptions struct {
 	ExitTimeout time.Duration
 }
 
+var loggedVersion atomic.Bool
+
 func absoluteBinaryPath(ctx context.Context, logger slog.Logger) (string, error) {
 	binaryPath, err := safeexec.LookPath("terraform")
 	if err != nil {
@@ -63,10 +66,14 @@ func absoluteBinaryPath(ctx context.Context, logger slog.Logger) (string, error)
 		return "", xerrors.Errorf("Terraform binary get version failed: %w", err)
 	}
 
-	logger.Info(ctx, "detected terraform version",
-		slog.F("installed_version", installedVersion.String()),
-		slog.F("min_version", minTerraformVersion.String()),
-		slog.F("max_version", maxTerraformVersion.String()))
+	// When running in-memory provisioners, each one reaches this point.
+	// It's not useful to print this to the user multiple times, so we ensure to log it once.
+	if !loggedVersion.Swap(true) {
+		logger.Info(ctx, "detected terraform version",
+			slog.F("installed_version", installedVersion.String()),
+			slog.F("min_version", minTerraformVersion.String()),
+			slog.F("max_version", maxTerraformVersion.String()))
+	}
 
 	if installedVersion.LessThan(minTerraformVersion) {
 		logger.Warn(ctx, "installed terraform version too old, will download known good version to cache")
@@ -97,9 +104,6 @@ func Serve(ctx context.Context, options *ServeOptions) error {
 				return xerrors.Errorf("absolute binary context canceled: %w", err)
 			}
 
-			options.Logger.Warn(ctx, "no usable terraform binary found, downloading to cache dir",
-				slog.F("terraform_version", TerraformVersion.String()),
-				slog.F("cache_dir", options.CachePath))
 			binPath, err := Install(ctx, options.Logger, options.CachePath, TerraformVersion)
 			if err != nil {
 				return xerrors.Errorf("install terraform: %w", err)
