Use Rails.logger instead of Logger

Previously with Logger, there was noise added to the terminal when running
the specs. Because of this we want to use Rails.logger instead, in production
and development

Temporarily silent the Active Record logger when
upserting all the GiasSchools. This only adds noise
to the logs when running the gias_update task in production.

.env.example

@@ -6,3 +6,4 @@ PLACEMENTS_HOST=placements.localhost
 CLAIMS_HOST=claims.localhost
 GIAS_CSV_BASE_URL=https://ea-edubase-api-prod.azurewebsites.net/edubase/downloads/public
 PUBLISH_BASE_URL=https://www.publish-teacher-training-courses.service.gov.uk
+RAILS_LOG_TO_STDOUT=true

app/services/gias_csv_importer.rb

@@ -5,11 +5,11 @@ class GiasCsvImporter
   OPEN_SCHOOL = "1".freeze
   NON_ENGLISH_ESTABLISHMENTS = %w[8 10 25 24 26 27 29 30 32 37 49 56 57].freeze
 
-  attr_reader :csv_path, :logger
+  attr_reader :csv_path, :active_record_logger
 
   def initialize(csv_path)
     @csv_path = csv_path
-    @logger = Logger.new($stdout)
+    @active_record_logger = ActiveRecord::Base.logger
   end
 
   def call
@@ -37,10 +37,13 @@ def call
       end
 
     if invalid_records.any?
-      logger.info "Invalid rows - #{invalid_records.inspect}"
+      Rails.logger.info "Invalid rows - #{invalid_records.inspect}"
     end
+    turn_off_ar_logger
     GiasSchool.upsert_all(records, unique_by: :urn)
-    logger.info "Done!"
+    turn_on_ar_logger
+
+    Rails.logger.info "Done!"
   end
 
   private
@@ -53,4 +56,12 @@ def school_excluded?(school)
     school["EstablishmentStatus (code)"] != OPEN_SCHOOL ||
       NON_ENGLISH_ESTABLISHMENTS.include?(school["TypeOfEstablishment (code)"])
   end
+
+  def turn_off_ar_logger
+    ActiveRecord::Base.logger = nil
+  end
+
+  def turn_on_ar_logger
+    ActiveRecord::Base.logger = active_record_logger
+  end
 end

config/environments/development.rb

@@ -64,4 +64,10 @@
 
   # Uncomment if you wish to allow Action Cable access from any origin.
   # config.action_cable.disable_request_forgery_protection = true
+  #
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger = ActiveSupport::Logger.new($stdout)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
 end

lib/tasks/gias_update.rake

@@ -1,14 +1,13 @@
 desc "Upsert GIAS data into GiasSchool"
 task gias_update: :environment do
-  logger = Logger.new($stdout)
   today = Time.zone.today.strftime("%Y%m%d")
   gias_filename = "edubasealldata#{today}.csv"
 
-  logger.info "Downloading the new gias file for #{Time.zone.today}"
+  Rails.logger.info "Downloading the new gias file for #{Time.zone.today}"
   tempfile = Down.download("#{ENV["GIAS_CSV_BASE_URL"]}/#{gias_filename}")
-  logger.info "Done!"
+  Rails.logger.info "Done!"
 
-  logger.info "Importing data"
+  Rails.logger.info "Importing data"
   GiasCsvImporter.call(tempfile.path)
 
   tempfile.unlink

spec/services/gias_csv_importer_spec.rb

@@ -13,10 +13,9 @@
   end
 
   it "logs messages to STDOUT" do
-    expect { subject }.to output(
-      match(/Done!/).and(match(/Invalid rows - /)).and(
-        match(/Row 5 is invalid/),
-      ),
-    ).to_stdout
+    expect(Rails.logger).to receive(:info).with("Invalid rows - [\"Row 5 is invalid\"]")
+    expect(Rails.logger).to receive(:info).with("Done!")
+
+    subject
   end
 end