GoodJob 数据库迁移问题分析与解决方案

问题背景

在从 GoodJob v2.99 升级到 v3.0.2 的过程中，开发人员遇到了一个数据库迁移失败的问题。当尝试执行 rails db:migrate:reset 命令时，系统报错提示 good_jobs.retried_good_job_id 列不存在。这个错误发生在执行 20240717224232_add_active_job_id_index_and_concurrency_key_index_to_good_jobs.rb 迁移文件时。

问题分析

经过深入排查，发现问题的根源在于 GoodJob v1.99 版本中的一个迁移文件存在设计缺陷。该迁移文件在尝试更新 active_job_id 时，错误地直接引用了 GoodJob::Job 模型类，而不是使用更安全的 GoodJobJobs 表名。

具体来说，问题迁移文件中包含以下有问题的代码片段：

return unless defined? GoodJob::Job

reversible do |dir|
  dir.up do
    start_time = Time.current
    loop do
      break if GoodJob::Job.where(active_job_id: nil, finished_at: nil)
        .where("created_at < ?", start_time)
        .limit(UPDATE_BATCH_SIZE)
        .update_all("active_job_id = (serialized_params->>'job_id')::uuid")
        .zero?
    end
  end
end

这段代码的问题在于：

1. 它假设 GoodJob::Job 类已经被定义，这在全新数据库迁移时可能不成立
2. 它直接引用了模型类而不是表名，增加了迁移对应用代码的依赖
3. 当 GoodJob::Job 类被加载时，它会尝试访问 retried_good_job_id 列，而此时该列尚未被创建

解决方案

正确的迁移实现应该直接操作数据库表，而不是依赖应用层的模型类。修复后的代码应该如下：

add_index :good_jobs, [:active_job_id, :created_at], algorithm: :concurrently, name: :index_good_jobs_on_active_job_id_and_created_at
add_index :good_jobs, :concurrency_key, where: "(finished_at IS NULL)", algorithm: :concurrently, name: :index_good_jobs_on_concurrency_key_when_unfinished
add_index :good_jobs, [:cron_key, :created_at], algorithm: :concurrently, name: :index_good_jobs_on_cron_key_and_created_at

reversible do |dir|
  dir.up do
    start_time = Time.current
    loop do
      break if GoodJobJobs.where(active_job_id: nil, finished_at: nil)
        .where("created_at < ?", start_time)
        .limit(UPDATE_BATCH_SIZE)
        .update_all("active_job_id = (serialized_params->>'job_id')::uuid")
        .zero?
    end
  end
end

经验教训

这个案例为我们提供了几个重要的经验：

1. 数据库迁移的独立性：迁移文件应该尽可能独立于应用代码，直接操作数据库表而不是依赖模型类
2. 迁移顺序的重要性：在复杂的升级路径中，确保每个迁移步骤都能独立执行非常重要
3. 测试覆盖：对于数据库迁移，应该测试从全新数据库和应用已有数据库两种场景

后续处理

GoodJob 项目维护者已经发布了 v1.99.2 版本，修复了这个问题。对于遇到类似问题的用户，可以手动修改迁移文件或升级到最新版本。

总结

数据库迁移是应用升级过程中的关键环节，需要特别注意迁移文件的独立性和执行顺序。GoodJob 的这个案例展示了即使在成熟的项目中，也可能存在迁移设计上的缺陷。通过分析问题原因和修复方案，我们可以更好地理解如何编写健壮的数据库迁移脚本。