Log queries in dev reset endpoint (#3365)

Previously the dev reset endpoint wouldn't show any output and it was
hard to understand what was happening. This changes it to output the
query being performed and the time it took as a log message to give more
feedback.


![image](https://github.com/user-attachments/assets/2430f720-6b62-4fab-b81f-3c8241c116aa)

Author: misaka

app/controllers/concerns/dev_concern.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevConcern
+  extend ActiveSupport::Concern
+
+  included do
+    skip_before_action :authenticate_user!
+    skip_before_action :store_user_location!
+    skip_after_action :verify_policy_scoped
+
+    before_action :ensure_dev_env_or_dev_tools_enabled
+  end
+
+  private
+
+  def ensure_dev_env_or_dev_tools_enabled
+    unless Rails.env.local? || Flipper.enabled?(:dev_tools)
+      raise "Not in development environment"
+    end
+  end
+end

app/controllers/dev/random_consent_form_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Dev::RandomConsentFormController < ApplicationController
+  include DevConcern
+
+  def call
+    Faker::Config.locale = "en-GB"
+
+    session =
+      if params[:slug].present?
+        Session.includes(programmes: :vaccines).find_by(slug: params[:slug])
+      else
+        Session.includes(programmes: :vaccines).find(params[:session_id])
+      end
+
+    attributes =
+      if ActiveModel::Type::Boolean.new.cast(params[:parent_phone])
+        {}
+      else
+        { parent_phone: nil }
+      end
+
+    consent_form =
+      FactoryBot.create(:consent_form, :draft, session:, **attributes)
+
+    consent_form.seed_health_questions
+    consent_form.each_health_answer do |health_answer|
+      health_answer.response = "no"
+    end
+    consent_form.save!
+
+    request.session[:consent_form_id] = consent_form.id
+    redirect_to confirm_parent_interface_consent_form_path(consent_form)
+  end
+end

app/controllers/dev/reset_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Dev::ResetController < ApplicationController
+  include DevConcern
+
+  def call
+    session.delete :user_return_to
+    Rake::Task.clear
+    Rails.application.load_tasks
+
+    Organisation.with_advisory_lock("reset") do
+      Rake::Task["db:seed:replant"].invoke
+    end
+
+    redirect_to root_path
+  end
+end

app/controllers/dev/reset_organisation_controller.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Dev::ResetOrganisationController < ApplicationController
+  include ActionController::Live
+  include DevConcern
+
+  def call
+    response.headers["Content-Type"] = "text/event-stream"
+    response.headers["Cache-Control"] = "no-cache"
+
+    organisation =
+      Organisation.find_by!(ods_code: params[:organisation_ods_code])
+
+    @start_time = Time.zone.now
+
+    Organisation.with_advisory_lock("reset-organisation-#{organisation.id}") do
+      log_destroy(CohortImport.where(organisation:))
+      log_destroy(ImmunisationImport.where(organisation:))
+
+      sessions = Session.where(organisation:)
+
+      log_destroy(ClassImport.where(session: sessions))
+      log_destroy(SessionDate.where(session: sessions))
+
+      log_destroy(ConsentNotification.where(session: sessions))
+      log_destroy(SessionNotification.where(session: sessions))
+      log_destroy(VaccinationRecord.where(session: sessions))
+
+      patient_sessions = PatientSession.where(session: sessions)
+      log_destroy(GillickAssessment.where(patient_session: patient_sessions))
+      log_destroy(PreScreening.where(patient_session: patient_sessions))
+      patient_sessions.in_batches { log_destroy(it) }
+
+      log_destroy(sessions)
+
+      patients = organisation.patients
+
+      log_destroy(SchoolMove.where(patient: patients))
+      log_destroy(SchoolMove.where(organisation:))
+      log_destroy(SchoolMoveLogEntry.where(patient: patients))
+      log_destroy(AccessLogEntry.where(patient: patients))
+      log_destroy(NotifyLogEntry.where(patient: patients))
+      # In local dev we can end up with NotifyLogEntries without a patient
+      log_destroy(NotifyLogEntry.where(patient_id: nil))
+      log_destroy(VaccinationRecord.where(patient: patients))
+
+      log_destroy(ConsentForm.where(organisation:))
+      log_destroy(Consent.where(organisation:))
+      log_destroy(Triage.where(organisation:))
+
+      patients.includes(:parents).in_batches { log_destroy(it) }
+
+      batches = Batch.where(organisation:)
+      log_destroy(VaccinationRecord.where(batch: batches))
+      log_destroy(batches)
+
+      log_destroy(
+        VaccinationRecord.where(performed_ods_code: organisation.ods_code)
+      )
+
+      UnscheduledSessionsFactory.new.call
+    end
+
+    response.stream.write "Done"
+  rescue StandardError => e
+    response.stream.write "Error: #{e.message}\n"
+  ensure
+    response.stream.close
+  end
+
+  private
+
+  def log_destroy(query)
+    where_clause = query.where_clause
+    @log_time ||= Time.zone.now
+    query.destroy_all
+    response.stream.write(
+      "#{query.model.name}.where(#{where_clause.to_h}) reset: #{Time.zone.now - @log_time}s\n"
+    )
+    @log_time = Time.zone.now
+  end
+end

app/controllers/dev_controller.rb

@@ -60,11 +60,11 @@
   mount flipper_app, at: "/flipper"
 
   unless Rails.env.production?
-    get "/reset", to: "dev#reset"
+    get "/reset", to: "dev/reset#call"
     get "/reset/:organisation_ods_code",
-        to: "dev#reset_organisation",
+        to: "dev/reset_organisation#call",
         as: :reset_organisation
-    get "/random-consent-form", to: "dev#random_consent_form"
+    get "/random-consent-form(/:slug)", to: "dev/random_consent_form#call"
   end
 
   get "/csrf", to: "csrf#new"

config/routes.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+describe Dev::ResetOrganisationController do
+  before { Flipper.enable(:dev_tools) }
+  after { Flipper.disable(:dev_tools) }
+
+  describe "GET" do
+    let(:programmes) { [create(:programme, :hpv_all_vaccines)] }
+
+    let(:organisation) { create(:organisation, ods_code: "R1L", programmes:) }
+
+    let(:cohort_import) do
+      create(
+        :cohort_import,
+        csv: fixture_file_upload("spec/fixtures/cohort_import/valid.csv"),
+        organisation:
+      )
+    end
+
+    let(:immunisation_import) do
+      create(
+        :immunisation_import,
+        csv:
+          fixture_file_upload(
+            "spec/fixtures/immunisation_import/valid_hpv.csv"
+          ),
+        organisation:
+      )
+    end
+
+    before do
+      programmes.each do |programme|
+        programme.vaccines.each do |vaccine|
+          create_list(:batch, 4, organisation:, vaccine:)
+        end
+      end
+
+      create(:school, urn: "123456", organisation:) # to match cohort_import/valid.csv
+      create(:school, urn: "110158", organisation:) # to match valid_hpv.csv
+
+      cohort_import.process!
+      immunisation_import.process!
+
+      Patient.find_each do |patient|
+        create(:notify_log_entry, :email, patient:, consent_form: nil)
+
+        consent_form = create(:consent_form, session: Session.first)
+        parent =
+          patient.parents.first || create(:parent_relationship, patient:).parent
+        create(
+          :consent,
+          :given,
+          patient:,
+          parent:,
+          consent_form:,
+          programme: programmes.first
+        )
+      end
+
+      create(:school_move, :to_school, patient: Patient.first)
+    end
+
+    it "deletes associated data" do
+      expect { get :call, params: { organisation_ods_code: "r1l" } }.to(
+        change(CohortImport, :count)
+          .by(-1)
+          .and(change(ImmunisationImport, :count).by(-1))
+          .and(change(NotifyLogEntry, :count).by(-3))
+          .and(change(Parent, :count).by(-4))
+          .and(change(Patient, :count).by(-3))
+          .and(change(PatientSession, :count).by(-3))
+          .and(change(VaccinationRecord, :count).by(-11))
+      )
+    end
+  end
+end