Sidekiq中ERB模板错误回溯信息优化实践

背景介绍

在使用Sidekiq Pro时，开发者可能会遇到一个常见问题：当ERB模板中发生错误时，错误回溯信息(backtrace)中无法显示具体的模板文件名，而只显示(erb)这样的模糊信息。这给错误排查带来了不小的困扰。

问题现象

当ERB模板中出现错误时，典型的错误回溯信息如下：

NoMethodError: undefined method `utc' for nil (NoMethodError)
  from (erb):31:in `block in _erb'
  from (erb):22:in `each'
  from (erb):22:in `_erb'
  from erb.rb:429:in `eval'

可以看到，回溯信息中只显示了(erb)而没有具体的模板文件名，这使得开发者难以快速定位问题所在的模板文件。

问题根源

这个问题的根本原因在于Ruby的ERB模板引擎默认不会将模板文件名信息包含在生成的代码中。当ERB模板被编译为Ruby代码时，如果没有显式设置位置信息，回溯中就只会显示(erb)。

解决方案

在Sidekiq的Web界面处理代码中，可以通过修改ERB模板的初始化方式来改善这个问题。具体做法是在创建ERB实例后，显式设置其位置信息：

erb_filename = "#{views}/#{content}.erb"
template = ERB.new(File.read(erb_filename))
template.location = [erb_filename, 1]  # 设置模板文件名和起始行号

这样设置后，当模板中发生错误时，回溯信息将包含具体的模板文件名，大大提高了调试效率。

技术细节

1. ERB模板编译过程：Ruby的ERB模板在运行时会被编译为Ruby代码，然后通过eval执行。默认情况下，这段生成的代码没有关联到原始模板文件。

2. location属性：ERB类提供了location属性，可以用来设置模板的源文件信息。这个属性接受一个数组，第一个元素是文件名，第二个是起始行号。

3. 行号准确性：虽然设置了起始行号为1，但实际错误行号可能不会完全准确。这是因为ERB编译过程中会进行代码转换，行号映射不是完全一致的。

实践建议

1. 统一处理：建议在Sidekiq的Web视图渲染部分统一添加模板位置信息设置，确保所有ERB模板都能获得良好的错误回溯。

2. 开发环境增强：可以考虑在开发环境中进一步增强错误信息，比如在错误页面直接显示相关模板片段。

3. 日志记录：对于生产环境，确保错误日志能够完整记录包含模板文件名的回溯信息。

总结

通过简单地为ERB模板设置location属性，可以显著改善Sidekiq中Web界面错误信息的可读性。这个小技巧不仅适用于Sidekiq，也可以应用于任何使用ERB模板的Ruby项目中，是提升开发效率的一个实用方法。