Dont override logger (#711)

* Update auxiliary loggers to not break main log

Update COURSE_LOGGER (and add ASSESSMENT_LOGGER) so that the
custom course and assessment formats are not applies to the
main rails log. Overriding Logger::format_message prevents certain
rails features (like log tags) from working.

* set formatter instead of overriding format_message

Since these classes don't inherit from Logger, they can't
override format_message. Use a formatter instead.

Author: cg2v

app/controllers/application_controller.rb

@@ -153,6 +153,7 @@ def set_course
       flash[:error] = e.to_s
       redirect_to(controller: :home, action: :error) && return
     end
+    ASSESSMENT_LOGGER.setCourse(@course)
   end
 
   def authorize_user_for_course
@@ -226,6 +227,7 @@ def set_assessment
     redirect_to(action: :index) && return if @cud.student? && !@assessment.released?
 
     @breadcrumbs << (view_context.current_assessment_link)
+    ASSESSMENT_LOGGER.setAssessment(@assessment)
   end
 
   # Loads the submission from the DB

app/controllers/assessment/autograde.rb

@@ -13,6 +13,7 @@ module AssessmentAutograde
   def autograde_done
     @assessment = @course.assessments.find_by(name: params[:name])
     render(nothing: true) && return unless @assessment && @assessment.has_autograder?
+    ASSESSMENT_LOGGER.setAssessment(@assessment)
 
     # there can be multiple submission with the same dave if this was a group submission
     submissions = Submission.where(dave: params[:dave]).all
@@ -524,9 +525,8 @@ def saveAutograde(submissions, feedback)
       end
     end
 
-    logger = Logger.new(Rails.root.join("courses", @course.name, @assessment.name, "log.txt"))
     submissions.each do |submission|
-      logger.add(Logger::INFO) { "#{submission.course_user_datum.email}, #{submission.version}, #{autoresult}" }
+      ASSESSMENT_LOGGER.log("#{submission.course_user_datum.email}, #{submission.version}, #{autoresult}")
     end
   end
 

app/controllers/assessment/handin.rb

@@ -191,8 +191,8 @@ def log_submit
     render(plain: "ERROR: No result!", status: :bad_request) && return unless @result
 
     # Everything looks OK, so append the autoresult to the log.txt file for this lab
-    @logger = Logger.new(Rails.root.join("courses", @course.name, @assessment.name, "log.txt"))
-    @logger.add(Logger::INFO) { "#{@user.email},0,#{@result}" }
+    ASSESSMENT_LOGGER.setAssessment(@assessment)
+    ASSESSMENT_LOGGER.log("#{@user.email},0,#{@result}")
 
     # Load up the lab.rb file
     mod_name = @assessment.name + (@course.name).gsub(/[^A-Za-z0-9]/, "")

app/models/course_logger.rb

@@ -1,28 +1,52 @@
-class Logger
-  def format_message(level, time, _progname, msg)
+class AutolabFormatter < ::Logger::Formatter
+  def call(level, time, _progname, msg)
     strTime = time.strftime("%m/%d/%y %H:%M:%S")
     "#{level} -- #{strTime} -- #{msg}\n"
   end
 end
 
-class CourseLogger
+class CustomLogger
   def initalize
-    @logger = nil
+    resetPath
   end
 
-  def setCourse(course)
+  def setLogPath(path)
     # if this can't grab the file, Autolab should still function
-    @logger = Logger.new("#{Rails.root}/courses/#{course.name}/autolab.log", "monthly")
+    @logger = Logger.new(path, "monthly")
+    @logger.formatter = AutolabFormatter.new
   rescue
-    @logger = nil
+    @logger = Rails.logger
+  end
+
+  def resetPath
+    @logger = Rails.logger
   end
 
   def log(message, severity = Logger::INFO)
-    if @logger
       @logger.add(severity) { message }
-    else
-      ActionController::Base.logger.add(severity) { message }
-    end
   end
 end
+class CourseLogger < CustomLogger
+  def setCourse(course)
+    setLogPath(Rails.root.join("courses", course.name, "autolab.log"))
+  end
+end
+
+class AssessmentLogger < CustomLogger
+  def initalize
+    @course = nil
+    @assessment = nil
+  end
+  def setCourse(course)
+    @course = course
+    @assessment = nil
+    resetPath
+  end
+  def setAssessment(assessment)
+    @assessment = assessment
+    setLogPath(Rails.root.join("courses", @course.name, @assessment.name, "log.txt"))
+  end
+end
+
 COURSE_LOGGER = CourseLogger.new
+ASSESSMENT_LOGGER = AssessmentLogger.new