Correct rent_type values

lib/tasks/correct_rent_type_value.rake

@@ -0,0 +1,27 @@
+desc "Alter rent_type values for bulk uploaded lettings logs for 2024 where they were not mapped correctly"
+task correct_rent_type_value: :environment do
+  rent_type_detail_mapping = {
+    1 => 0,
+    2 => 1,
+    3 => 2,
+    4 => 3,
+    5 => 4,
+    6 => 5,
+  }
+  affected_uploads = BulkUpload.where(log_type: "lettings", year: 2024)
+  affected_uploads.each do |upload|
+    upload.logs.where.not(rent_type: nil).each do |log|
+      current_rent_type = log.rent_type
+      rent_type_at_upload = log.versions.length == 1 ? log.rent_type : log.versions.first.next.reify.rent_type
+      next unless rent_type_at_upload == current_rent_type
+
+      log.rent_type = rent_type_detail_mapping[rent_type_at_upload]
+      log.skip_update_status = true if log.status == "pending"
+      if log.save
+        Rails.logger.info("Log #{log.id} rent_type updated from #{rent_type_at_upload} to #{log.rent_type}")
+      else
+        Rails.logger.error("Log #{log.id} rent_type could not be updated from #{rent_type_at_upload} to #{log.rent_type}. Error: #{log.errors.full_messages.join(', ')}")
+      end
+    end
+  end
+end

spec/lib/tasks/correct_rent_type_value_spec.rb

@@ -0,0 +1,234 @@
+require "rails_helper"
+require "rake"
+
+RSpec.describe "correct_rent_type_value" do
+  describe ":correct_rent_type_value", type: :task do
+    subject(:task) { Rake::Task["correct_rent_type_value"] }
+
+    before do
+      Rake.application.rake_require("tasks/correct_rent_type_value")
+      Rake::Task.define_task(:environment)
+      task.reenable
+    end
+
+    context "when the rake task is run" do
+      context "and rent_type is 1" do
+        let(:bulk_upload) { create(:bulk_upload, :lettings, year: 2024) }
+        let(:bulk_upload_2023) { create(:bulk_upload, :lettings, year: 2023) }
+
+        before do
+          bulk_upload.save!
+        end
+
+        it "updates the rent_type value on a log where it was set to 1 on create" do
+          log = create(:lettings_log, :completed, rent_type: 1, bulk_upload:)
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a pending log where it was set to 1 on create" do
+          log = build(:lettings_log, :completed, rent_type: 1, bulk_upload:, status: "pending")
+          log.skip_update_status = true
+          log.save!
+          initial_updated_at = log.updated_at
+          expect(log.status).to eq("pending")
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("pending")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a deleted log where it was set to 1 on create" do
+          log = create(:lettings_log, :completed, rent_type: 1, bulk_upload:, discarded_at: Time.zone.yesterday)
+          initial_updated_at = log.updated_at
+          expect(log.status).to eq("deleted")
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("deleted")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a log where it was set to 1 on create and other fields have since changed" do
+          log = create(:lettings_log, :completed, rent_type: 1, bulk_upload:)
+          log.update!(tenancycode: "abc")
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "does not update the rent_type value on a log if it has since been changed" do
+          log = create(:lettings_log, :completed, rent_type: 1, bulk_upload:)
+          log.update!(rent_type: 0)
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+
+        it "does not update the rent_type value on a 2023 log turned 2024" do
+          log = create(:lettings_log, :completed, startdate: Time.zone.local(2023, 6, 6), rent_type: 1, bulk_upload: bulk_upload_2023)
+          log.address_line1_input = log.address_line1
+          log.postcode_full_input = log.postcode_full
+          log.nationality_all_group = 826
+          log.uprn = "10033558653"
+          log.uprn_selection = 1
+          log.startdate = Time.zone.today
+          log.save!
+
+          expect(log.status).to eq("completed")
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+
+        it "does not update and logs error if a validation triggers" do
+          log = build(:lettings_log, :completed, startdate: Time.zone.local(2021, 6, 6), rent_type: 1, bulk_upload:)
+          log.save!(validate: false)
+          initial_updated_at = log.updated_at
+
+          expect(Rails.logger).to receive(:error).with(/Log #{log.id} rent_type could not be updated from 1 to 0. Error: /)
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+      end
+
+      context "and rent_type is 2" do
+        let(:bulk_upload) { create(:bulk_upload, :lettings, year: 2024) }
+        let(:bulk_upload_2023) { create(:bulk_upload, :lettings, year: 2023) }
+
+        before do
+          bulk_upload.save!
+        end
+
+        it "updates the rent_type value on a log where it was set to 2 on create" do
+          log = create(:lettings_log, :completed, rent_type: 2, bulk_upload:)
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a pending log where it was set to 2 on create" do
+          log = build(:lettings_log, :completed, rent_type: 2, bulk_upload:, status: "pending")
+          log.skip_update_status = true
+          log.save!
+          initial_updated_at = log.updated_at
+          expect(log.status).to eq("pending")
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.status).to eq("pending")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a deleted log where it was set to 2 on create" do
+          log = create(:lettings_log, :completed, rent_type: 2, bulk_upload:, discarded_at: Time.zone.yesterday)
+          initial_updated_at = log.updated_at
+          expect(log.status).to eq("deleted")
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.status).to eq("deleted")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "updates the rent_type value on a log where it was set to 2 on create and other fields have since changed" do
+          log = create(:lettings_log, :completed, rent_type: 2, bulk_upload:)
+          log.update!(tenancycode: "abc")
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(1)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).not_to eq(initial_updated_at)
+        end
+
+        it "does not update the rent_type value on a log if it has since been changed" do
+          log = create(:lettings_log, :completed, rent_type: 2, bulk_upload:)
+          log.update!(rent_type: 0)
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(0)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+
+        it "does not update the rent_type value on a 2023 log turned 2024" do
+          log = create(:lettings_log, :completed, startdate: Time.zone.local(2023, 6, 6), rent_type: 2, bulk_upload: bulk_upload_2023)
+          log.address_line1_input = log.address_line1
+          log.postcode_full_input = log.postcode_full
+          log.nationality_all_group = 826
+          log.uprn = "10033558653"
+          log.uprn_selection = 1
+          log.startdate = Time.zone.today
+          log.save!
+
+          expect(log.status).to eq("completed")
+          initial_updated_at = log.updated_at
+
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(2)
+          expect(log.status).to eq("completed")
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+
+        it "does not update and logs error if a validation triggers" do
+          log = build(:lettings_log, :completed, startdate: Time.zone.local(2021, 6, 6), rent_type: 2, bulk_upload:)
+          log.save!(validate: false)
+          initial_updated_at = log.updated_at
+
+          expect(Rails.logger).to receive(:error).with(/Log #{log.id} rent_type could not be updated from 2 to 1. Error: /)
+          task.invoke
+          log.reload
+
+          expect(log.rent_type).to be(2)
+          expect(log.updated_at).to eq(initial_updated_at)
+        end
+      end
+    end
+  end
+end