本地正常运行的Sarama v2.6.0在测试环境解析Kafka版本时Panic

问题场景 #

基于ibm/sarama开发Kafka消费者，本地使用sarama v2.6.0运行正常，但部署到测试环境时启动触发Panic，报错显示解析Kafka版本失败，传入的版本参数为空。

相关代码片段 #

version, err := sarama.ParseKafkaVersion(version)
if err != nil {
    boot.Logger.L.Critical(err.Error(), err)
    log.Panicf("Error parsing Kafka version: %v", err)
}

delayDuration := time.Millisecond * time.Duration(delay)
log.Printf("Delaying Kafka consumption start by %v milliseconds", delay)
time.Sleep(delayDuration)

测试环境启动日志 #

2024/03/19 16:56:36 Starting a new Sarama consumer
2024/03/19 16:56:36 ++--------------------[UP...]--------------------++
2024/03/19 16:56:36 [UP...] - New Logger Slack connection successfully open
2024/03/19 16:56:36 [UP...] - New DB connection successfully open
2024/03/19 16:56:36 [UP...] - New Cache Redis connection successfully open
2024/03/19 16:56:36 [UP...] - New Queue Server successfully open
2024/03/19 16:56:36 [UP...] - New Queue Client successfully open
asynq: pid=1366 2024/03/19 16:56:36.820414 INFO: Starting processing
panic: Error parsing Kafka version: invalid version ``
goroutine 1 [running]:
log.Panicf({0x1229727?, 0xc000044480?}, {0xc000307c28?, 0x1058ae0?, 0xc000053500?})
/snap/go/10554/src/log/log.go:439 +0x65

问题原因与解决办法 #

核心原因 #

1. 变量遮蔽问题：代码中version, err := sarama.ParseKafkaVersion(version)存在命名冲突——新声明的变量version覆盖了传入的参数version，导致实际传入解析函数的是刚声明的空字符串零值，而非预期的配置版本。
2. 环境差异掩盖问题：本地环境可能通过默认配置、隐式赋值等方式填充了版本参数，掩盖了代码的逻辑漏洞；测试环境未正确传入版本值，或直接因变量遮蔽使用空值，触发报错。

修复方案 #

1. 修正变量命名：将解析后的版本变量改名，避免与传入参数冲突，示例：

kafkaVersion, err := sarama.ParseKafkaVersion(version)
if err != nil {
    boot.Logger.L.Critical(err.Error(), err)
    log.Panicf("Error parsing Kafka version: %v", err)
}

2. 校验配置参数：检查测试环境的配置文件/环境变量，确保传入的Kafka版本是符合格式的字符串（如"2.8.0"、"3.1.0"），且不为空。
3. 添加前置校验：在解析版本前先检查参数是否为空，提前拦截错误：

if version == "" {
    log.Panicf("Kafka version parameter cannot be empty")
}
kafkaVersion, err := sarama.ParseKafkaVersion(version)
if err != nil {
    boot.Logger.L.Critical(err.Error(), err)
    log.Panicf("Error parsing Kafka version: %v", err)
}

内容的提问来源于stack exchange，提问作者nggasnik