feat: logging enhancements (#257)

jahvon · web-flow · commit c903ffbfe658 · 2025-07-07T11:21:52.000-04:00
diff --git a/.execs/test.flow b/.execs/test.flow
@@ -139,3 +139,15 @@ executables:
           envKey: "COUNT"
           type: "int"
           default: "1"
+
+  - verb: test
+    name: colored-output
+    visibility: internal
+    description: Test executable to demonstrate colored output in the terminal.
+    exec:
+      dir: //
+      cmd: |
+        echo -e "\033[32mThis is green text\033[0m"
+        echo -e "\033[31mThis is red text\033[0m"
+        echo -e "\033[34mThis is blue text\033[0m"
+        echo -e "\033[33mThis is yellow text\033[0m"
diff --git a/cmd/internal/exec.go b/cmd/internal/exec.go
@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/gen2brain/beeep"
+	tuikitIO "github.com/jahvon/tuikit/io"
 	"github.com/jahvon/tuikit/views"
 	"github.com/spf13/cobra"
 
@@ -55,6 +56,10 @@ func RegisterExecCmd(ctx *context.Context, rootCmd *cobra.Command) {
 			return execIDs, cobra.ShellCompDirectiveNoFileComp
 		},
 		PreRun: func(cmd *cobra.Command, args []string) {
+			logMode := flags.ValueFor[string](ctx, cmd, *flags.LogModeFlag, false)
+			if err := tuikitIO.LogMode(logMode).Validate(); err != nil {
+				ctx.Logger.FatalErr(err)
+			}
 			execPreRun(ctx, cmd, args)
 		},
 		Run: func(cmd *cobra.Command, args []string) {
@@ -64,6 +69,7 @@ func RegisterExecCmd(ctx *context.Context, rootCmd *cobra.Command) {
 		},
 	}
 	RegisterFlag(ctx, subCmd, *flags.ParameterValueFlag)
+	RegisterFlag(ctx, subCmd, *flags.LogModeFlag)
 	rootCmd.AddCommand(subCmd)
 }
 
@@ -81,6 +87,11 @@ func execPreRun(_ *context.Context, _ *cobra.Command, _ []string) {
 //nolint:funlen,gocognit
 func execFunc(ctx *context.Context, cmd *cobra.Command, verb executable.Verb, args []string) {
 	logger := ctx.Logger
+	logMode := flags.ValueFor[string](ctx, cmd, *flags.LogModeFlag, false)
+	if logMode != "" {
+		logger.SetMode(tuikitIO.LogMode(logMode))
+	}
+
 	if err := verb.Validate(); err != nil {
 		logger.FatalErr(err)
 	}
diff --git a/cmd/internal/flags/types.go b/cmd/internal/flags/types.go
@@ -23,6 +23,14 @@ var LogLevel = &Metadata{
 	Required:  false,
 }
 
+var LogModeFlag = &Metadata{
+	Name:      "log-mode",
+	Shorthand: "m",
+	Usage:     "Log mode (text, logfmt, json, hidden)",
+	Default:   "logfmt",
+	Required:  false,
+}
+
 var SyncCacheFlag = &Metadata{
 	Name:     "sync",
 	Usage:    "Sync flow cache and workspaces",
diff --git a/docs/cli/flow_exec.md b/docs/cli/flow_exec.md
@@ -51,6 +51,7 @@ flow exec EXECUTABLE_ID [args...] [flags]
 
 ```
   -h, --help                help for exec
+  -m, --log-mode string     Log mode (text, logfmt, json, hidden) (default "logfmt")
   -p, --param stringArray   Set a parameter value by env key. (i.e. KEY=value) Use multiple times to set multiple parameters.This will override any existing parameter values defined for the executable.
 ```
 
diff --git a/go.mod b/go.mod
@@ -12,7 +12,7 @@ require (
 	github.com/gen2brain/beeep v0.11.1
 	github.com/jahvon/glamour v0.8.1-patch3
 	github.com/jahvon/open-golang v0.0.0-20240522004812-68511c3bc9ef
-	github.com/jahvon/tuikit v0.1.2
+	github.com/jahvon/tuikit v0.1.4
 	github.com/jahvon/vault v0.1.1
 	github.com/mattn/go-runewidth v0.0.16
 	github.com/onsi/ginkgo/v2 v2.23.4
diff --git a/go.sum b/go.sum
@@ -115,8 +115,8 @@ github.com/jahvon/glamour v0.8.1-patch3 h1:LfyMACZavV8yxK4UsPENNQQOqafWuq4ZdLuEA
 github.com/jahvon/glamour v0.8.1-patch3/go.mod h1:30MVJwG3rcEHrN277NrA4DKzndSL9lBtEmpcfOygwCQ=
 github.com/jahvon/open-golang v0.0.0-20240522004812-68511c3bc9ef h1:4PS/MNVT6Rsv15x5Rtwaw971e6kFvNUAf9nvUsZ5hcc=
 github.com/jahvon/open-golang v0.0.0-20240522004812-68511c3bc9ef/go.mod h1:dUmuT5CN6osIeLSRtTPJOf0Yz+qAbcyU6omnCzI+ZfQ=
-github.com/jahvon/tuikit v0.1.2 h1:BGN942W8S89d+hkKxMsUUB50+63T1VgkBamsKwzXpLc=
-github.com/jahvon/tuikit v0.1.2/go.mod h1:Bi6zph90IAONRweA/9eUKjVNaxCstxhwubnhFOthEFs=
+github.com/jahvon/tuikit v0.1.4 h1:hdIMwyZRYYVeEkzI2cPDnMcy1RKdTTpQG/nvIJ2K2bc=
+github.com/jahvon/tuikit v0.1.4/go.mod h1:s9fRhgO1IlMLzkY/KGikBrqGm41Fn0QOQNHLwQvrDbE=
 github.com/jahvon/vault v0.1.1 h1:qzfRh/+yoRR44MhfmiVyMIXAalKPNN+DRgeTQ1frC9A=
 github.com/jahvon/vault v0.1.1/go.mod h1:1StJR/E0WSXPKsgMs1t68N0g3gjIOwSo97Zsb56Ll28=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
diff --git a/internal/io/vault/view.go b/internal/io/vault/view.go
@@ -82,7 +82,7 @@ func (vc *vaultCollection) Plural() string {
 }
 
 func (vc *vaultCollection) Items() []*types.EntityInfo {
-	items := make([]*types.EntityInfo, 0, len(vc.Vaults))
+	items := make([]*types.EntityInfo, len(vc.Vaults))
 	for i, v := range vc.Vaults {
 		items[i] = &types.EntityInfo{
 			Header:    v.Name,
diff --git a/internal/runner/parallel/parallel.go b/internal/runner/parallel/parallel.go
@@ -123,7 +123,7 @@ func handleExec(
 
 		switch {
 		case exec.Exec != nil:
-			fields := map[string]interface{}{"step": exec.ID()}
+			fields := map[string]interface{}{"step": exec.Ref().String()}
 			exec.Exec.SetLogFields(fields)
 			if parallelSpec.Dir != "" && exec.Exec.Dir == "" {
 				exec.Exec.Dir = parallelSpec.Dir
diff --git a/internal/runner/serial/serial.go b/internal/runner/serial/serial.go
@@ -118,7 +118,7 @@ func handleExec(
 
 		switch {
 		case exec.Exec != nil:
-			fields := map[string]interface{}{"step": exec.ID()}
+			fields := map[string]interface{}{"step": exec.Ref().String()}
 			exec.Exec.SetLogFields(fields)
 			if serialSpec.Dir != "" && exec.Exec.Dir == "" {
 				exec.Exec.Dir = serialSpec.Dir
diff --git a/internal/services/run/run.go b/internal/services/run/run.go
@@ -8,13 +8,24 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/jahvon/tuikit/io"
 	"mvdan.cc/sh/v3/expand"
 	"mvdan.cc/sh/v3/interp"
 	"mvdan.cc/sh/v3/syntax"
-
-	"github.com/jahvon/tuikit/io"
 )
 
+func init() {
+	if _, exists := os.LookupEnv("TERM"); !exists {
+		_ = os.Setenv("TERM", "xterm-256color")
+	}
+	if _, exists := os.LookupEnv("FORCE_COLOR"); !exists {
+		_ = os.Setenv("FORCE_COLOR", "1")
+	}
+	if _, exists := os.LookupEnv("CLICOLOR_FORCE"); !exists {
+		_ = os.Setenv("CLICOLOR_FORCE", "1")
+	}
+}
+
 // RunCmd executes a command in the current shell in a specific directory.
 func RunCmd(
 	commandStr, dir string,
diff --git a/internal/services/run/run_test.go b/internal/services/run/run_test.go
@@ -52,7 +52,8 @@ var _ = Describe("Run", func() {
 				logger.EXPECT().LogMode().DoAndReturn(func() tuikitIO.LogMode {
 					return tuikitIO.Text
 				}).AnyTimes()
-				logger.EXPECT().Println("foo").Times(1)
+				logger.EXPECT().Print("foo").Times(1)
+				logger.EXPECT().Print("\n").Times(1)
 				err := run.RunCmd("echo \"foo\"", "", nil, tuikitIO.Text, logger, os.Stdin, nil)
 				Expect(err).NotTo(HaveOccurred())
 			})
@@ -126,7 +127,8 @@ var _ = Describe("Run", func() {
 			logger.EXPECT().LogMode().DoAndReturn(func() tuikitIO.LogMode {
 				return tuikitIO.Text
 			}).AnyTimes()
-			logger.EXPECT().Println("foo").Times(1)
+			logger.EXPECT().Print("foo").Times(1)
+			logger.EXPECT().Print("\n").Times(1)
 			filename := filepath.Base(testfile.Name())
 			filedir := filepath.Dir(testfile.Name())
 			err := run.RunFile(filename, filedir, nil, tuikitIO.Logfmt, logger, os.Stdin, nil)
diff --git a/internal/utils/executables/executables.go b/internal/utils/executables/executables.go
@@ -19,25 +19,25 @@ func ExecutableForRef(ctx *context.Context, ref executable.Ref) (*executable.Exe
 
 	if exec.Exec != nil {
 		fields := map[string]interface{}{
-			"executable": exec.ID(),
+			"executable": exec.Ref().String(),
 		}
 		exec.Exec.SetLogFields(fields)
 	}
 
 	return exec, nil
 }
 
-func ExecutableForCmd(parent *executable.Executable, cmd string, id int) *executable.Executable {
+func ExecutableForCmd(parent *executable.Executable, cmd string, _ int) *executable.Executable {
 	vis := executable.ExecutableVisibility(common.VisibilityInternal)
 	exec := &executable.Executable{
-		Verb:       "exec",
-		Name:       fmt.Sprintf("%s-cmd-%d", parent.Name, id),
+		Verb:       parent.Verb,
+		Name:       parent.Name,
 		Visibility: &vis,
 		Exec: &executable.ExecExecutableType{
 			Cmd: cmd,
 		},
 	}
-	fields := map[string]interface{}{"executable": exec.ID()}
+	fields := map[string]interface{}{"executable": exec.Ref().String()}
 	exec.Exec.SetLogFields(fields)
 	exec.SetContext(parent.Workspace(), parent.WorkspacePath(), parent.Namespace(), parent.FlowFilePath())
 	return exec
diff --git a/internal/utils/utils.go b/internal/utils/utils.go
@@ -164,3 +164,12 @@ func IsZeroValue(v interface{}) bool {
 	}
 	return reflect.DeepEqual(v, reflect.Zero(reflect.TypeOf(v)).Interface())
 }
+
+//nolint:lll
+const ansi = "[\u001B\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PRZcf-ntqry=><~]))"
+
+var re = regexp.MustCompile(ansi)
+
+func StripAnsi(str string) string {
+	return re.ReplaceAllString(str, "")
+}
diff --git a/tests/secret_cmds_e2e_test.go b/tests/secret_cmds_e2e_test.go
@@ -10,6 +10,7 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
+	internalUtils "github.com/jahvon/flow/internal/utils"
 	"github.com/jahvon/flow/tests/utils"
 )
 
@@ -44,7 +45,7 @@ var _ = Describe("vault/secrets e2e", Ordered, func() {
 			Expect(lines).ToNot(BeEmpty())
 			parts := strings.Split(strings.TrimSpace(lines[0]), ":")
 			Expect(parts).To(HaveLen(2))
-			encryptionKey := strings.TrimSpace(parts[1])
+			encryptionKey := strings.TrimSpace(internalUtils.StripAnsi(parts[1]))
 			Expect(os.Setenv(keyEnv, encryptionKey)).To(Succeed())
 		})
 
diff --git a/tests/utils/context.go b/tests/utils/context.go
@@ -2,9 +2,9 @@ package utils
 
 import (
 	stdCtx "context"
+	"fmt"
 	"os"
 	"path/filepath"
-	"runtime"
 	"strings"
 
 	tuikitIO "github.com/jahvon/tuikit/io"
@@ -49,13 +49,9 @@ func NewContext(ctx stdCtx.Context, t ginkgo.FullGinkgoTInterface) *Context {
 		tuikitIO.WithOutput(stdOut),
 		tuikitIO.WithTheme(io.Theme("")),
 		tuikitIO.WithMode(tuikitIO.Text),
-		tuikitIO.WithExitFunc(func() {
-			_, file, line, ok := runtime.Caller(3)
-			if ok {
-				t.Fatalf("logger exit called from %s:%d", file, line)
-			} else {
-				t.Fatalf("logger exit called")
-			}
+		tuikitIO.WithExitFunc(func(msg string, args ...any) {
+			msg = fmt.Sprintf(msg, args...)
+			t.Fatalf("logger exit called - %s", msg)
 		}),
 	)
 	ctxx, configDir, cacheDir := newTestContext(ctx, t, logger, stdIn, stdOut)
@@ -123,13 +119,9 @@ func ResetTestContext(ctx *Context, t ginkgo.FullGinkgoTInterface) {
 		tuikitIO.WithOutput(stdOut),
 		tuikitIO.WithTheme(io.Theme("")),
 		tuikitIO.WithMode(tuikitIO.Text),
-		tuikitIO.WithExitFunc(func() {
-			_, file, line, ok := runtime.Caller(3)
-			if ok {
-				t.Fatalf("logger exit called from %s:%d", file, line)
-			} else {
-				t.Fatalf("logger exit called")
-			}
+		tuikitIO.WithExitFunc(func(msg string, args ...any) {
+			msg = fmt.Sprintf(msg, args...)
+			t.Fatalf("logger exit called - %s", msg)
 		}),
 	)
 	ctx.Logger = logger

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func (vc *vaultCollection) Plural() string {`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`func (vc vaultCollection) Items() []types.EntityInfo {`
`85`		`- items := make([]*types.EntityInfo, 0, len(vc.Vaults))`
	`85`	`+ items := make([]*types.EntityInfo, len(vc.Vaults))`
`86`	`86`	`for i, v := range vc.Vaults {`
`87`	`87`	`items[i] = &types.EntityInfo{`
`88`	`88`	`Header: v.Name,`