fix: Fix the issue with ineffective --build.full_bin command line argument (#748)

sdfwds4 · xiantang · web-flow · commit 0448782ff1cf · 2025-03-05T23:36:15.000+08:00
* Update config.go

* Update flag_test.go

* fix: handle preprocess correctly in command line arguments

* fix: update withArgs documentation to reflect its private status

---------

Co-authored-by: xiantang &lt;zhujingdi1998@gmail.com&gt;
diff --git a/main.go b/main.go
@@ -89,12 +89,11 @@ func main() {
 	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP)
 
 	var err error
-	cfg, err := runner.InitConfig(cfgPath)
+	cfg, err := runner.InitConfig(cfgPath, cmdArgs)
 	if err != nil {
 		log.Fatal(err)
 		return
 	}
-	cfg.WithArgs(cmdArgs)
 	if !cfg.Log.Silent {
 		printSplash()
 	}
diff --git a/runner/config.go b/runner/config.go
@@ -109,7 +109,7 @@ func (t sliceTransformer) Transformer(typ reflect.Type) func(dst, src reflect.Va
 }
 
 // InitConfig initializes the configuration.
-func InitConfig(path string) (cfg *Config, err error) {
+func InitConfig(path string, cmdArgs map[string]TomlInfo) (cfg *Config, err error) {
 	if path == "" {
 		cfg, err = defaultPathConfig()
 		if err != nil {
@@ -135,7 +135,7 @@ func InitConfig(path string) (cfg *Config, err error) {
 		return nil, err
 	}
 
-	err = ret.preprocess()
+	err = ret.preprocess(cmdArgs)
 	return ret, err
 }
 
@@ -278,8 +278,12 @@ func readConfigOrDefault(path string) (*Config, error) {
 	return cfg, nil
 }
 
-func (c *Config) preprocess() error {
+func (c *Config) preprocess(args map[string]TomlInfo) error {
 	var err error
+
+	if args != nil {
+		c.withArgs(args)
+	}
 	cwd := os.Getenv(airWd)
 	if cwd != "" {
 		if err = os.Chdir(cwd); err != nil {
@@ -384,8 +388,8 @@ func (c *Config) rel(path string) string {
 	return s
 }
 
-// WithArgs returns a new config with the given arguments added to the configuration.
-func (c *Config) WithArgs(args map[string]TomlInfo) {
+// withArgs returns a new config with the given arguments added to the configuration.
+func (c *Config) withArgs(args map[string]TomlInfo) {
 	for _, value := range args {
 		// Ignore values that match the default configuration.
 		// This ensures user-specified configurations are not overwritten by default values.
@@ -394,4 +398,5 @@ func (c *Config) WithArgs(args map[string]TomlInfo) {
 			setValue2Struct(v, value.fieldPath, *value.Value)
 		}
 	}
+
 }
diff --git a/runner/config_test.go b/runner/config_test.go
@@ -43,7 +43,7 @@ func TestBinCmdPath(t *testing.T) {
 	var err error
 
 	c := getWindowsConfig()
-	err = c.preprocess()
+	err = c.preprocess(nil)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -118,7 +118,7 @@ func TestReadConfByName(t *testing.T) {
 func TestConfPreprocess(t *testing.T) {
 	t.Setenv(airWd, "_testdata/toml")
 	df := defaultConfig()
-	err := df.preprocess()
+	err := df.preprocess(nil)
 	if err != nil {
 		t.Fatalf("preprocess error %v", err)
 	}
@@ -143,7 +143,7 @@ func TestConfigWithRuntimeArgs(t *testing.T) {
 
 	t.Run("when using bin", func(t *testing.T) {
 		df := defaultConfig()
-		if err := df.preprocess(); err != nil {
+		if err := df.preprocess(nil); err != nil {
 			t.Fatalf("preprocess error %v", err)
 		}
 
@@ -155,7 +155,7 @@ func TestConfigWithRuntimeArgs(t *testing.T) {
 	t.Run("when using full_bin", func(t *testing.T) {
 		df := defaultConfig()
 		df.Build.FullBin = "./tmp/main"
-		if err := df.preprocess(); err != nil {
+		if err := df.preprocess(nil); err != nil {
 			t.Fatalf("preprocess error %v", err)
 		}
 
diff --git a/runner/engine.go b/runner/engine.go
@@ -71,9 +71,9 @@ func NewEngineWithConfig(cfg *Config, debugMode bool) (*Engine, error) {
 }
 
 // NewEngine ...
-func NewEngine(cfgPath string, debugMode bool) (*Engine, error) {
+func NewEngine(cfgPath string, args map[string]TomlInfo, debugMode bool) (*Engine, error) {
 	var err error
-	cfg, err := InitConfig(cfgPath)
+	cfg, err := InitConfig(cfgPath, args)
 	if err != nil {
 		return nil, err
 	}
diff --git a/runner/engine_test.go b/runner/engine_test.go
@@ -21,7 +21,7 @@ import (
 
 func TestNewEngine(t *testing.T) {
 	_ = os.Unsetenv(airWd)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -38,7 +38,7 @@ func TestNewEngine(t *testing.T) {
 
 func TestCheckRunEnv(t *testing.T) {
 	_ = os.Unsetenv(airWd)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -49,7 +49,7 @@ func TestCheckRunEnv(t *testing.T) {
 }
 
 func TestWatching(t *testing.T) {
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -65,12 +65,12 @@ func TestWatching(t *testing.T) {
 }
 
 func TestRegexes(t *testing.T) {
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
 	engine.config.Build.ExcludeRegex = []string{"foo\\.html$", "bar", "_test\\.go"}
-	err = engine.config.preprocess()
+	err = engine.config.preprocess(nil)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -123,7 +123,7 @@ func TestRunCommand(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -146,7 +146,7 @@ func TestRunPreCmd(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -171,7 +171,7 @@ func TestRunPostCmd(t *testing.T) {
 	// change dir to tmpDir
 	chdir(t, tmpDir)
 
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -190,7 +190,7 @@ func TestRunPostCmd(t *testing.T) {
 }
 
 func TestRunBin(t *testing.T) {
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -221,7 +221,7 @@ func TestRebuild(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	engine.config.Build.ExcludeUnchanged = true
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
@@ -310,14 +310,14 @@ func TestCtrlCWhenHaveKillDelay(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
 	engine.config.Build.KillDelay = c.Build.KillDelay
 	engine.config.Build.Delay = 2000
 	engine.config.Build.SendInterrupt = true
-	if err := engine.config.preprocess(); err != nil {
+	if err := engine.config.preprocess(nil); err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
 
@@ -353,7 +353,7 @@ func TestCtrlCWhenREngineIsRunning(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -386,7 +386,7 @@ func TestCtrlCWithFailedBin(t *testing.T) {
 	go func() {
 		dir := initWithQuickExitGoCode(t)
 		chdir(t, dir)
-		engine, err := NewEngine("", true)
+		engine, err := NewEngine("", nil, true)
 		assert.NoError(t, err)
 		engine.config.Build.Bin = "<WRONGCOMAMND>"
 		sigs := make(chan os.Signal, 1)
@@ -419,7 +419,7 @@ func TestFixCloseOfChannelAfterCtrlC(t *testing.T) {
 	// fix https://github.com/air-verse/air/issues/294
 	dir := initWithBuildFailedCode(t)
 	chdir(t, dir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -464,7 +464,7 @@ func TestFixCloseOfChannelAfterTwoFailedBuild(t *testing.T) {
 	dir := initWithBuildFailedCode(t)
 	// change dir to tmpDir
 	chdir(t, dir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -530,7 +530,7 @@ func TestRun(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -716,7 +716,7 @@ func TestRebuildWhenRunCmdUsingDLV(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -725,7 +725,7 @@ func TestRebuildWhenRunCmdUsingDLV(t *testing.T) {
 	dlvPort, f := GetPort()
 	f()
 	engine.config.Build.FullBin = fmt.Sprintf("dlv exec --accept-multiclient --log --headless --continue --listen :%d --api-version 2 ./tmp/main", dlvPort)
-	_ = engine.config.preprocess()
+	_ = engine.config.preprocess(nil)
 	go func() {
 		engine.Run()
 	}()
@@ -818,7 +818,7 @@ include_file = ["test/not_a_test.go"]
 	if err := os.WriteFile(dftTOML, []byte(config), 0o644); err != nil {
 		t.Fatal(err)
 	}
-	engine, err := NewEngine(".air.toml", true)
+	engine, err := NewEngine(".air.toml", nil, true)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -881,7 +881,7 @@ func Test(t *testing.T) {
 	}
 
 	time.Sleep(time.Second * 2)
-	engine, err := NewEngine(".air.toml", false)
+	engine, err := NewEngine(".air.toml", nil, false)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -917,7 +917,7 @@ func TestCreateNewDir(t *testing.T) {
 	tmpDir := initTestEnv(t, port)
 	// change dir to tmpDir
 	chdir(t, tmpDir)
-	engine, err := NewEngine("", true)
+	engine, err := NewEngine("", nil, true)
 	if err != nil {
 		t.Fatalf("Should not be fail: %s.", err)
 	}
@@ -967,7 +967,7 @@ include_file = ["main.sh"]
 		t.Fatal(err)
 	}
 
-	engine, err := NewEngine(dftTOML, false)
+	engine, err := NewEngine(dftTOML, nil, false)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -1026,7 +1026,7 @@ include_file = ["main.sh"]
 		t.Fatal(err)
 	}
 
-	engine, err := NewEngine(dftTOML, false)
+	engine, err := NewEngine(dftTOML, nil, false)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -1110,7 +1110,7 @@ func TestEngineExit(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			e, err := NewEngine("", true)
+			e, err := NewEngine("", nil, true)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/runner/flag_test.go b/runner/flag_test.go
@@ -118,6 +118,27 @@ func TestConfigRuntimeArgs(t *testing.T) {
 				assert.NotEqual(t, []string{}, conf.Build.ExcludeDir)
 			},
 		},
+		{
+			name: "check full_bin",
+			args: []string{"--build.full_bin", "APP_ENV=dev APP_USER=air ./tmp/main"},
+			check: func(t *testing.T, conf *Config) {
+				assert.Equal(t, "APP_ENV=dev APP_USER=air ./tmp/main", conf.Build.Bin)
+			},
+		},
+
+		{
+			name: "check exclude_regex patterns compiled",
+			args: []string{"--build.exclude_regex", "test_pattern\\.go"},
+			check: func(t *testing.T, conf *Config) {
+				assert.Equal(t, []string{"test_pattern\\.go"}, conf.Build.ExcludeRegex)
+				patterns, err := conf.Build.RegexCompiled()
+				require.NoError(t, err)
+				require.NotNil(t, patterns)
+				require.Len(t, patterns, 1)
+				assert.True(t, patterns[0].MatchString("test_pattern.go"), "regex should match test_pattern.go")
+				assert.False(t, patterns[0].MatchString("other_file.go"), "regex shouldn't match other_file.go")
+			},
+		},
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
@@ -126,12 +147,11 @@ func TestConfigRuntimeArgs(t *testing.T) {
 			flag := flag.NewFlagSet(t.Name(), flag.ExitOnError)
 			cmdArgs := ParseConfigFlag(flag)
 			_ = flag.Parse(tc.args)
-			cfg, err := InitConfig("")
+			cfg, err := InitConfig("", cmdArgs)
 			if err != nil {
 				log.Fatal(err)
 				return
 			}
-			cfg.WithArgs(cmdArgs)
 			tc.check(t, cfg)
 		})
 	}

Original file line number	Diff line number	Diff line change
`@@ -89,12 +89,11 @@ func main() {`
`89`	`89`	`signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP)`
`90`	`90`
`91`	`91`	`var err error`
`92`		`- cfg, err := runner.InitConfig(cfgPath)`
	`92`	`+ cfg, err := runner.InitConfig(cfgPath, cmdArgs)`
`93`	`93`	`if err != nil {`
`94`	`94`	`log.Fatal(err)`
`95`	`95`	`return`
`96`	`96`	`}`
`97`		`- cfg.WithArgs(cmdArgs)`
`98`	`97`	`if !cfg.Log.Silent {`
`99`	`98`	`printSplash()`
`100`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ func (t sliceTransformer) Transformer(typ reflect.Type) func(dst, src reflect.Va`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`// InitConfig initializes the configuration.`
`112`		`-func InitConfig(path string) (cfg *Config, err error) {`
	`112`	`+func InitConfig(path string, cmdArgs map[string]TomlInfo) (cfg *Config, err error) {`
`113`	`113`	`if path == "" {`
`114`	`114`	`cfg, err = defaultPathConfig()`
`115`	`115`	`if err != nil {`
`@@ -135,7 +135,7 @@ func InitConfig(path string) (cfg *Config, err error) {`
`135`	`135`	`return nil, err`
`136`	`136`	`}`
`137`	`137`
`138`		`- err = ret.preprocess()`
	`138`	`+ err = ret.preprocess(cmdArgs)`
`139`	`139`	`return ret, err`
`140`	`140`	`}`
`141`	`141`
`@@ -278,8 +278,12 @@ func readConfigOrDefault(path string) (*Config, error) {`
`278`	`278`	`return cfg, nil`
`279`	`279`	`}`
`280`	`280`
`281`		`-func (c *Config) preprocess() error {`
	`281`	`+func (c *Config) preprocess(args map[string]TomlInfo) error {`
`282`	`282`	`var err error`
	`283`	`+`
	`284`	`+ if args != nil {`
	`285`	`+ c.withArgs(args)`
	`286`	`+ }`
`283`	`287`	`cwd := os.Getenv(airWd)`
`284`	`288`	`if cwd != "" {`
`285`	`289`	`if err = os.Chdir(cwd); err != nil {`
`@@ -384,8 +388,8 @@ func (c *Config) rel(path string) string {`
`384`	`388`	`return s`
`385`	`389`	`}`
`386`	`390`
`387`		`-// WithArgs returns a new config with the given arguments added to the configuration.`
`388`		`-func (c *Config) WithArgs(args map[string]TomlInfo) {`
	`391`	`+// withArgs returns a new config with the given arguments added to the configuration.`
	`392`	`+func (c *Config) withArgs(args map[string]TomlInfo) {`
`389`	`393`	`for _, value := range args {`
`390`	`394`	`// Ignore values that match the default configuration.`
`391`	`395`	`// This ensures user-specified configurations are not overwritten by default values.`
`@@ -394,4 +398,5 @@ func (c *Config) WithArgs(args map[string]TomlInfo) {`
`394`	`398`	`setValue2Struct(v, value.fieldPath, *value.Value)`
`395`	`399`	`}`
`396`	`400`	`}`
	`401`	`+`
`397`	`402`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,9 +71,9 @@ func NewEngineWithConfig(cfg Config, debugMode bool) (Engine, error) {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`// NewEngine ...`
`74`		`-func NewEngine(cfgPath string, debugMode bool) (*Engine, error) {`
	`74`	`+func NewEngine(cfgPath string, args map[string]TomlInfo, debugMode bool) (*Engine, error) {`
`75`	`75`	`var err error`
`76`		`- cfg, err := InitConfig(cfgPath)`
	`76`	`+ cfg, err := InitConfig(cfgPath, args)`
`77`	`77`	`if err != nil {`
`78`	`78`	`return nil, err`
`79`	`79`	`}`