Merge pull request #1152 from wakatime/develop

Release v1.110.0

Author: gandarez

.golangci.yml

@@ -18,6 +18,7 @@ linters:
     - revive
     - testpackage
     - unconvert
+    - usetesting
     - usestdlibvars
     - whitespace
     - wsl
@@ -54,6 +55,9 @@ linters-settings:
       - name: unused-receiver
       - name: var-declaration
       - name: var-naming
+  usetesting:
+    os-setenv: true
+    os-temp-dir: true
 issues:
   exclude-use-default: false
   exclude-dirs:

cmd/api/api.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"fmt"
+	"runtime/debug"
 	"strings"
 
 	paramscmd "github.com/wakatime/wakatime-cli/cmd/params"
@@ -85,8 +86,8 @@ func newClient(ctx context.Context, params paramscmd.API, opts ...api.Option) (*
 
 func timezone() (name string, err error) {
 	defer func() {
-		if e := recover(); e != nil {
-			err = fmt.Errorf("panicked when detecting timezone: %s", e)
+		if r := recover(); r != nil {
+			err = fmt.Errorf("panicked: failed to get timezone: %v. Stack: %s", r, string(debug.Stack()))
 		}
 	}()
 

cmd/logfile/logfile.go

@@ -48,7 +48,7 @@ func LoadParams(ctx context.Context, v *viper.Viper) (Params, error) {
 	if logFile != "" {
 		p, err := homedir.Expand(logFile)
 		if err != nil {
-			return Params{}, fmt.Errorf("failed expanding log file: %s", err)
+			return Params{}, fmt.Errorf("failed to expand log file: %s", err)
 		}
 
 		params.File = p
@@ -58,7 +58,7 @@ func LoadParams(ctx context.Context, v *viper.Viper) (Params, error) {
 
 	folder, err := ini.WakaResourcesDir(ctx)
 	if err != nil {
-		return Params{}, fmt.Errorf("failed getting resource directory: %s", err)
+		return Params{}, fmt.Errorf("failed to get resource directory: %s", err)
 	}
 
 	params.File = filepath.Join(folder, defaultFile)

cmd/logfile/logfile_test.go

@@ -132,10 +132,7 @@ func TestLoadParams(t *testing.T) {
 			v.Set("settings.debug", test.ViperDebug)
 			v.Set("verbose", test.ViperDebugConfig)
 
-			err := os.Setenv("WAKATIME_HOME", test.EnvVar)
-			require.NoError(t, err)
-
-			defer os.Unsetenv("WAKATIME_HOME")
+			t.Setenv("WAKATIME_HOME", test.EnvVar)
 
 			params, err := logfile.LoadParams(ctx, v)
 			require.NoError(t, err)

cmd/params/params.go

@@ -11,6 +11,7 @@ import (
 	"os"
 	"os/exec"
 	"regexp"
+	"runtime/debug"
 	"strconv"
 	"strings"
 	"sync"
@@ -732,7 +733,7 @@ func LoadStatusBarParams(v *viper.Viper) (StatusBar, error) {
 func safeTimeParse(format string, s string) (parsed time.Time, err error) {
 	defer func() {
 		if r := recover(); r != nil {
-			err = fmt.Errorf("time.Parse panic: %v", r)
+			err = fmt.Errorf("panicked: failed to time.Parse: %v. Stack: %s", r, string(debug.Stack()))
 		}
 	}()
 

cmd/params/params_test.go

@@ -2093,10 +2093,7 @@ func TestLoadParams_ApiKey_FromVault_Err_Darwin(t *testing.T) {
 func TestLoadAPIParams_APIKeyFromEnv(t *testing.T) {
 	v := viper.New()
 
-	err := os.Setenv("WAKATIME_API_KEY", "00000000-0000-4000-8000-000000000000")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("WAKATIME_API_KEY")
+	t.Setenv("WAKATIME_API_KEY", "00000000-0000-4000-8000-000000000000")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2107,12 +2104,9 @@ func TestLoadAPIParams_APIKeyFromEnv(t *testing.T) {
 func TestLoadAPIParams_APIKeyFromEnvInvalid(t *testing.T) {
 	v := viper.New()
 
-	err := os.Setenv("WAKATIME_API_KEY", "00000000-0000-4000-0000-000000000000")
-	require.NoError(t, err)
+	t.Setenv("WAKATIME_API_KEY", "00000000-0000-4000-0000-000000000000")
 
-	defer os.Unsetenv("WAKATIME_API_KEY")
-
-	_, err = cmdparams.LoadAPIParams(context.Background(), v)
+	_, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.Error(t, err)
 
 	var errauth api.ErrAuth
@@ -2125,10 +2119,7 @@ func TestLoadAPIParams_APIKeyFromEnv_ConfigTakesPrecedence(t *testing.T) {
 	v := viper.New()
 	v.Set("settings.api_key", "00000000-0000-4000-8000-000000000000")
 
-	err := os.Setenv("WAKATIME_API_KEY", "10000000-0000-4000-8000-000000000000")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("WAKATIME_API_KEY")
+	t.Setenv("WAKATIME_API_KEY", "10000000-0000-4000-8000-000000000000")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2370,10 +2361,7 @@ func TestLoadAPIParams_ProxyURL_UserDefinedTakesPrecedenceOverEnvironment(t *tes
 	v.Set("key", "00000000-0000-4000-8000-000000000000")
 	v.Set("proxy", "https://john:[email protected]:8888")
 
-	err := os.Setenv("HTTPS_PROXY", "https://papa:[email protected]:9000")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("HTTPS_PROXY")
+	t.Setenv("HTTPS_PROXY", "https://papa:[email protected]:9000")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2396,10 +2384,7 @@ func TestLoadAPIParams_ProxyURL_FromEnvironment(t *testing.T) {
 	v := viper.New()
 	v.Set("key", "00000000-0000-4000-8000-000000000000")
 
-	err := os.Setenv("HTTPS_PROXY", "https://john:[email protected]:8888")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("HTTPS_PROXY")
+	t.Setenv("HTTPS_PROXY", "https://john:[email protected]:8888")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2411,10 +2396,7 @@ func TestLoadAPIParams_ProxyURL_NoProxyFromEnvironment(t *testing.T) {
 	v := viper.New()
 	v.Set("key", "00000000-0000-4000-8000-000000000000")
 
-	err := os.Setenv("NO_PROXY", "https://some.org,https://api.wakatime.com")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("NO_PROXY")
+	t.Setenv("NO_PROXY", "https://some.org,https://api.wakatime.com")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2470,10 +2452,7 @@ func TestLoadAPIParams_Hostname_FlagTakesPrecedence(t *testing.T) {
 	v.Set("hostname", "my-machine")
 	v.Set("settings.hostname", "ignored")
 
-	err := os.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("GITPOD_WORKSPACE_ID")
+	t.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2497,10 +2476,7 @@ func TestLoadAPIParams_Hostname_ConfigTakesPrecedence(t *testing.T) {
 	v.Set("key", "00000000-0000-4000-8000-000000000000")
 	v.Set("settings.hostname", "my-machine")
 
-	err := os.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("GITPOD_WORKSPACE_ID")
+	t.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)
@@ -2512,10 +2488,7 @@ func TestLoadAPIParams_Hostname_FromGitpodEnv(t *testing.T) {
 	v := viper.New()
 	v.Set("key", "00000000-0000-4000-8000-000000000000")
 
-	err := os.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
-	require.NoError(t, err)
-
-	defer os.Unsetenv("GITPOD_WORKSPACE_ID")
+	t.Setenv("GITPOD_WORKSPACE_ID", "gitpod")
 
 	params, err := cmdparams.LoadAPIParams(context.Background(), v)
 	require.NoError(t, err)

cmd/run.go

@@ -38,7 +38,6 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"go.uber.org/zap/zapcore"
-	iniv1 "gopkg.in/ini.v1"
 	"gopkg.in/natefinch/lumberjack.v2"
 )
 
@@ -53,17 +52,10 @@ type diagnostics struct {
 func RunE(cmd *cobra.Command, v *viper.Viper) error {
 	ctx := context.Background()
 
-	// force setup logging otherwise log goes to std out
-	logger, err := SetupLogging(ctx, v)
-	if err != nil {
-		// log to std out as logger is not setup yet
-		stdlog.Fatalf("failed to setup logging: %s", err)
-	}
-
-	// save logger to context
-	ctx = log.ToContext(ctx, logger)
+	// extract logger from context despite it's not fully initialized yet
+	logger := log.Extract(ctx)
 
-	err = parseConfigFiles(ctx, v)
+	err := parseConfigFiles(ctx, v)
 	if err != nil {
 		logger.Errorf("failed to parse config files: %s", err)
 
@@ -74,12 +66,15 @@ func RunE(cmd *cobra.Command, v *viper.Viper) error {
 		}
 	}
 
-	// setup logging again to use config file settings if available
 	logger, err = SetupLogging(ctx, v)
 	if err != nil {
-		logger.Fatalf("failed to setup logging: %s", err)
+		// log to std out and exit, as logger instance failed to setup
+		stdlog.Fatalf("failed to setup logging: %s", err)
 	}
 
+	// save logger to context
+	ctx = log.ToContext(ctx, logger)
+
 	// register all custom lexers
 	if err := lexer.RegisterAll(); err != nil {
 		logger.Fatalf("failed to register custom lexers: %s", err)
@@ -183,30 +178,24 @@ func RunE(cmd *cobra.Command, v *viper.Viper) error {
 }
 
 func parseConfigFiles(ctx context.Context, v *viper.Viper) error {
+	logger := log.Extract(ctx)
+
 	var configFiles = []struct {
-		fn    func(context.Context, *viper.Viper) (string, error)
-		vp    *viper.Viper
-		merge bool
+		filePathFn func(context.Context, *viper.Viper) (string, error)
 	}{
 		{
-			fn: ini.FilePath,
-			vp: v,
+			filePathFn: ini.FilePath,
 		},
 		{
-			fn: ini.ImportFilePath,
-			vp: v,
+			filePathFn: ini.ImportFilePath,
 		},
 		{
-			fn:    ini.InternalFilePath,
-			vp:    viper.NewWithOptions(viper.IniLoadOptions(iniv1.LoadOptions{SkipUnrecognizableLines: true})),
-			merge: true,
+			filePathFn: ini.InternalFilePath,
 		},
 	}
 
-	logger := log.Extract(ctx)
-
 	for _, c := range configFiles {
-		configFile, err := c.fn(ctx, v)
+		configFile, err := c.filePathFn(ctx, v)
 		if err != nil {
 			return fmt.Errorf("error getting config file path: %s", err)
 		}
@@ -221,16 +210,9 @@ func parseConfigFiles(ctx context.Context, v *viper.Viper) error {
 			continue
 		}
 
-		if err := ini.ReadInConfig(c.vp, configFile); err != nil {
+		if err := ini.ReadInConfig(v, configFile); err != nil {
 			return fmt.Errorf("failed to load configuration file: %s", err)
 		}
-
-		if c.merge {
-			err = v.MergeConfigMap(c.vp.AllSettings())
-			if err != nil {
-				logger.Warnf("failed to merge configuration file: %s", err)
-			}
-		}
 	}
 
 	return nil
@@ -251,10 +233,11 @@ func SetupLogging(ctx context.Context, v *viper.Viper) (*log.Logger, error) {
 		if _, err := os.Stat(dir); os.IsNotExist(err) {
 			err := os.MkdirAll(dir, 0750)
 			if err != nil {
-				return nil, fmt.Errorf("error creating log file directory: %s", err)
+				return nil, fmt.Errorf("failed to create log file directory %q: %s", dir, err)
 			}
 		}
 
+		// rotate log files
 		destOutput = &lumberjack.Logger{
 			Filename:   params.File,
 			MaxSize:    log.MaxLogFileSize,
@@ -269,8 +252,6 @@ func SetupLogging(ctx context.Context, v *viper.Viper) (*log.Logger, error) {
 		log.WithMetrics(params.Metrics),
 	)
 
-	log.SetJww(params.Verbose, destOutput)
-
 	return logger, nil
 }
 
@@ -306,13 +287,13 @@ func runCmd(ctx context.Context, v *viper.Viper, verbose bool, sendDiagsOnErrors
 
 	// catch panics
 	defer func() {
-		if err := recover(); err != nil {
-			logger.Errorf("panicked: %v. Stack: %s", err, string(debug.Stack()))
+		if r := recover(); r != nil {
+			logger.Errorf("panicked: %v. Stack: %s", r, string(debug.Stack()))
 
 			resetLogs()
 
 			diags := diagnostics{
-				OriginalError: err,
+				OriginalError: r,
 				Panicked:      true,
 				Stack:         string(debug.Stack()),
 			}

cmd/run_internal_test.go

@@ -417,6 +417,31 @@ func TestParseConfigFiles(t *testing.T) {
 		v.GetString("internal.backoff_at"))
 }
 
+func TestParseConfigFiles_MissingAPIKey(t *testing.T) {
+	v := viper.New()
+	v.Set("config", "testdata/.wakatime-empty.cfg")
+	v.Set("internal-config", "testdata/.wakatime-internal.cfg")
+
+	err := parseConfigFiles(context.Background(), v)
+
+	assert.NoError(t, err)
+}
+
+func TestParseConfigFiles_APIKey_FlagTakesPrecedence(t *testing.T) {
+	v := viper.New()
+	v.Set("key", "00000000-0000-4000-8000-000000000000")
+	v.Set("config", "testdata/.wakatime-empty.cfg")
+	v.Set("settings.import_cfg", "")
+	v.Set("internal-config", "testdata/.wakatime-internal.cfg")
+
+	err := parseConfigFiles(context.Background(), v)
+	require.NoError(t, err)
+
+	assert.Equal(t,
+		"00000000-0000-4000-8000-000000000000",
+		v.GetString("key"))
+}
+
 func jsonEscape(t *testing.T, i string) string {
 	b, err := json.Marshal(i)
 	require.NoError(t, err)

cmd/testdata/.wakatime-empty.cfg

@@ -0,0 +1 @@
+[settings]

go.mod

@@ -17,13 +17,12 @@ require (
 	github.com/pkg/sftp v1.13.7
 	github.com/slongfield/pyfmt v0.0.0-20220222012616-ea85ff4c361f
 	github.com/spf13/cobra v1.8.1
-	github.com/spf13/jwalterweatherman v1.1.0
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0
 	go.etcd.io/bbolt v1.3.11
 	go.uber.org/zap v1.27.0
 	golang.org/x/crypto v0.31.0
-	golang.org/x/net v0.32.0
+	golang.org/x/net v0.33.0
 	golang.org/x/text v0.21.0
 	gopkg.in/ini.v1 v1.67.0
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1
@@ -52,7 +51,7 @@ require (
 	github.com/sergi/go-diff v1.3.1 // indirect
 	github.com/sourcegraph/conc v0.3.0 // indirect
 	github.com/spf13/afero v1.11.0 // indirect
-	github.com/spf13/cast v1.7.0 // indirect
+	github.com/spf13/cast v1.7.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
 	github.com/yookoala/realpath v1.0.0 // indirect