fix: ensure submission history uses archive and moves

- use archive folder when unit archived
- move submission history to archive folder when unit archived
- move submission history on task abbr change
- move submission history on username change
- delete submission history on task delete

Author: macite

app/helpers/file_helper.rb

@@ -658,13 +658,39 @@ def latest_submission_timestamp_entry_in_dir(path)
     sorted_timestamp_entries_in_dir(path)[0]
   end
 
+  def root_submission_history_dir(archived: false)
+    file_server = if archived
+                    archive_root
+                  else
+                    student_work_root
+                  end
+
+    "#{file_server}/submission_history/" # trust the server config and passed in type for paths
+  end
+
+  def unit_submission_history_dir(unit, archived: true)
+    dst = if (unit.archived && archived) || (archived == :force)
+            "#{archive_root}/"
+          else
+            "#{student_work_root}/"
+          end
+
+    dst << sanitized_path('submission_history', "#{unit.code}-#{unit.id}")
+  end
+
+  def project_submission_history_dir(project, username: nil, archived: true)
+    username = project.student.username.to_s if username.nil?
+    dst = unit_submission_history_dir(project.unit, archived: archived)
+
+    File.join(dst, sanitized_path(username))
+  end
+
   def task_submission_identifier_path(type, task)
-    file_server = Doubtfire::Application.config.student_work_dir
-    "#{file_server}/submission_history/#{sanitized_path("#{task.project.unit.code}-#{task.project.unit.id}", task.project.student.username.to_s, type.to_s, task.id.to_s)}"
+    "#{project_submission_history_dir(task.project)}/#{sanitized_path(type.to_s, task.id.to_s)}"
   end
 
   def task_submission_identifier_path_with_timestamp(type, task, timestamp)
-    "#{task_submission_identifier_path(type, task)}/#{timestamp.to_s}"
+    "#{task_submission_identifier_path(type, task)}/#{sanitized_path(timestamp.to_s)}"
   end
 
   # Apply line wrapping to a given file, returns true when line wrapping is necessary.
@@ -747,6 +773,9 @@ def line_wrap(path, width: 160)
   module_function :process_audio
   module_function :sorted_timestamp_entries_in_dir
   module_function :latest_submission_timestamp_entry_in_dir
+  module_function :root_submission_history_dir
+  module_function :unit_submission_history_dir
+  module_function :project_submission_history_dir
   module_function :task_submission_identifier_path
   module_function :task_submission_identifier_path_with_timestamp
   module_function :known_extension?

app/models/unit.rb

@@ -2576,21 +2576,34 @@ def move_files_to_archive
       FileUtils.mv(original_work_path, archive_work_path)
     end
 
+    # Move portfolios
     archive_portfolio_path = FileHelper.unit_portfolio_dir(self, create: false, archived: :force)
     original_portfolio_path = FileHelper.unit_portfolio_dir(self, create: false, archived: false)
 
     if File.exist?(original_portfolio_path) && ! File.exist?(archive_portfolio_path)
       FileUtils.mv(original_portfolio_path, archive_portfolio_path)
     end
+
+    # Move submission history
+    archive_submission_history_path = FileHelper.unit_submission_history_dir(self, archived: :force)
+    original_submission_history_path = FileHelper.unit_submission_history_dir(self, archived: false)
+
+    if File.exist?(original_submission_history_path) && ! File.exist?(archive_submission_history_path)
+      FileUtils.mkdir_p(FileHelper.root_submission_history_dir(archived: true))
+      FileUtils.mv(original_submission_history_path, archive_submission_history_path)
+    end
   end
 
   private
 
   def delete_associated_files
     unit_path = FileHelper.unit_dir(self, create: false)
     unit_portfolio_path = FileHelper.unit_portfolio_dir(self, create: false)
+    submission_history_path = FileHelper.unit_submission_history_dir(self)
+
     FileUtils.rm_rf unit_path
     FileUtils.rm_rf unit_portfolio_path
+    FileUtils.rm_rf submission_history_path
 
     FileUtils.cd FileHelper.student_work_dir
   end

app/models/user.rb

@@ -428,6 +428,12 @@ def move_files_on_username_change
       project.tasks.where('portfolio_evidence IS NOT NULL').update_all("portfolio_evidence = REPLACE(portfolio_evidence, '#{FileHelper.sanitized_path(old_username)}', '#{FileHelper.sanitized_path(username)}')")
       # rubocop:enable Rails/SkipsModelValidations
 
+      # Now move submission history files
+      old_path = FileHelper.project_submission_history_dir(project, username: old_username)
+      new_path = FileHelper.project_submission_history_dir(project, username: username)
+
+      FileUtils.mv(old_path, new_path) if File.exist?(old_path)
+
       # Now move the portfolio folder
       old_path = FileHelper.student_portfolio_dir(project.unit, old_username, create: false)
       new_path = FileHelper.student_portfolio_dir(project.unit, username, create: false)

test/models/unit_model_test.rb

@@ -836,9 +836,15 @@ def test_archive_unit
     DatabasePopulator.generate_portfolio(p)
     old_portfolio_path = p.portfolio_path
 
+    old_submission_history_path = FileHelper.task_submission_identifier_path_with_timestamp(:done, task, '123/45')
+    FileUtils.mkdir_p(old_submission_history_path)
+    FileUtils.touch(File.join(old_submission_history_path, 'output.txt'))
+
     assert File.exist?(old_path)
     assert File.exist?(task_pdf)
     assert File.exist?(old_portfolio_path)
+    assert File.exist?(old_submission_history_path)
+    assert File.exist?(File.join(old_submission_history_path, 'output.txt'))
 
     unit.move_files_to_archive
     unit.archived = true
@@ -853,6 +859,9 @@ def test_archive_unit
     assert File.exist?(task.final_pdf_path), "New task file does not exist"
     assert_not File.exist?(old_portfolio_path), "Old portfolio file still exists - #{old_portfolio_path}"
     assert File.exist?(p.portfolio_path), "New portfolio file does not exist"
+    assert_not File.exist?(old_submission_history_path), "Old submission history still exists - #{old_submission_history_path}"
+    assert File.exist?(FileHelper.task_submission_identifier_path(:done, task))
+    assert File.exist?(File.join(FileHelper.task_submission_identifier_path_with_timestamp(:done, task, '123_45'), 'output.txt'))
 
     assert File.exist?(task.final_pdf_path), "Portfolio evidence file does not exist - #{task.final_pdf_path}"
 
@@ -862,17 +871,23 @@ def test_archive_unit
 
     # File exists after rename
     assert File.exist?(task.final_pdf_path), "Portfolio evidence file does not exist - #{task.final_pdf_path}"
+    assert File.exist?(FileHelper.task_submission_identifier_path(:done, task))
+    assert File.exist?(File.join(FileHelper.task_submission_identifier_path_with_timestamp(:done, task, '123_45'), 'output.txt'))
 
     p.student.update(username: 'NEW_USERNAME')
     task.reload
     assert File.exist?(task.final_pdf_path), "Portfolio evidence file does not exist after username change - #{task.final_pdf_path}"
     assert File.exist?(p.portfolio_path), "New portfolio file does not exist"
+    assert File.exist?(FileHelper.task_submission_identifier_path(:done, task))
+    assert File.exist?(File.join(FileHelper.task_submission_identifier_path_with_timestamp(:done, task, '123_45'), 'output.txt'))
 
     unit.destroy!
 
     assert_not File.exist?(td.task_sheet), "New file exists after delete - #{td.task_sheet}"
     assert_not File.exist?(task.final_pdf_path), "New task file exists after delete - #{task.final_pdf_path}"
     assert_not File.exist?(p.portfolio_path), "New portfolio exists after delete - #{p.portfolio_path}"
+    assert_not File.exist?(FileHelper.task_submission_identifier_path(:done, task))
+    assert_not File.exist?(File.join(FileHelper.task_submission_identifier_path_with_timestamp(:done, task, '123_45'), 'output.txt'))
   ensure
     Doubtfire::Application.config.archive_units = false
   end