Flag manually remediated work versions/files (#1880)

ajkiessl · web-flow · commit 026fe56e9d2f · 2026-02-13T14:58:17.000-05:00
* Changed auto_remediated_version fields to just remediated_version to be more general since we could havea uto remediation or manual remediation.  We still have job_uuids and auto remediation timestamps to differentiate the two.  Also, adds rake task to flag work versions and file resources that have already been manually remediated

* Adds checkbox to publish form for admins to toggle remediated version on and off.  Adds a method to work version to mirror this selection to remediatable linked files

* Translate text in view

* Removed some more 'auto_remediated' references.  Fixed some tests

* refactored some things and fixed some tests

* Change db migration to ensure remediated_version in work_versions is never null and defaulted to false

* Tests and moved mirror call to a better location

* This is actually the best spot for the mirror method

* Bugfix

* Fix tests

* Filter down to pdfs in flagging script.  Adds tests

* Adds tests for publishing work version as admin/non-admin and logic around updating remediated_version in work version and file resource

* Adds tests for publishing work version as admin/non-admin and logic around updating remediated_version in work version and file resource

* fixed test
diff --git a/.gitignore b/.gitignore
@@ -22,6 +22,7 @@ public/uploads-test
 
 /public/assets
 .byebug_history
+.config/
 
 # Ignore master key for decrypting credentials and more.
 /config/master.key
diff --git a/app/controllers/dashboard/form/publish_controller.rb b/app/controllers/dashboard/form/publish_controller.rb
@@ -53,6 +53,7 @@ def update
           if @resource.mint_doi_requested
             deposit_pathway.allows_mint_doi_request? ? MintDoiAsync.call(@resource.work) : flash[:error] = t('dashboard.form.publish.doi.error')
           end
+          @resource.mirror_remediated_version_to_files! if validation_context.nil?
         end
       end
 
@@ -135,6 +136,7 @@ def work_version_params
               :sensitive_info_agreement,
               :accessibility_remediation_requested,
               :mint_doi_requested,
+              :remediated_version,
               keyword: [],
               contributor: [],
               publisher: [],
diff --git a/app/forms/work_deposit_pathway.rb b/app/forms/work_deposit_pathway.rb
@@ -138,6 +138,7 @@ class WorkVersionFormBase
         accessibility_agreement
         sensitive_info_agreement
         contributor
+        remediated_version
       }.freeze
 
       def initialize(work_version)
@@ -260,6 +261,9 @@ def validate_creator_names
 
     class PublishFormBase < WorkVersionFormBase
       include WorkVersionDetails
+
+      delegate :mirror_remediated_version_to_files!,
+               to: :work_version
     end
 
     module General
@@ -618,7 +622,7 @@ def form_partial
         end
       end
 
-      class PublishForm < WorkVersionFormBase
+      class PublishForm < PublishFormBase
         REQUIRE_FIELDS.each { |f| validates f.to_sym, presence: true }
 
         def self.form_fields
diff --git a/app/models/file_resource.rb b/app/models/file_resource.rb
@@ -33,7 +33,7 @@ class FileResource < ApplicationRecord
   }
 
   scope :can_remediate, -> {
-    is_pdf.where('auto_remediated_version IS NULL OR auto_remediated_version = ?', false)
+    is_pdf.where('remediated_version IS NULL OR remediated_version = ?', false)
   }
 
   scope :needs_accessibility_check, -> {
@@ -104,7 +104,7 @@ def image?
   end
 
   def can_remediate?
-    file.mime_type == PDF_MIME_TYPE && !auto_remediated_version
+    file.mime_type == PDF_MIME_TYPE && !remediated_version
   end
 
   def latest_remediation_work_version_candidate
@@ -114,8 +114,8 @@ def latest_remediation_work_version_candidate
       .last
   end
 
-  def first_auto_remediated_work_version_after(version)
-    work_versions.where('work_versions.id > ? AND auto_remediated_version = ?', version.id, true)
+  def first_remediated_work_version_after(version)
+    work_versions.where('work_versions.id > ? AND remediated_version = ?', version.id, true)
       .order(:id)
       .first
   end
diff --git a/app/models/work_version.rb b/app/models/work_version.rb
@@ -398,7 +398,13 @@ def has_large_pdf_file_resource?
   end
 
   def has_remaining_auto_remediation_jobs?
-    file_resources.exists?(['remediation_job_uuid IS NOT NULL AND auto_remediated_version = ?', false])
+    file_resources.exists?(['remediation_job_uuid IS NOT NULL AND remediated_version = ?', false])
+  end
+
+  def mirror_remediated_version_to_files!
+    file_resources.is_pdf.find_each do |file_resource|
+      file_resource.update!(remediated_version: remediated_version)
+    end
   end
 
   delegate :deposited_at,
diff --git a/app/services/pdf_remediation/auto_remediate_service.rb b/app/services/pdf_remediation/auto_remediate_service.rb
@@ -24,7 +24,7 @@ def able_to_auto_remediate?
 
     work_version.latest_published_version? &&
       work_version.auto_remediation_started_at.nil? &&
-      !work_version.auto_remediated_version &&
+      !work_version.remediated_version &&
       download_can_remediate &&
       !admin &&
       !work_version.work.under_manual_review
diff --git a/app/services/pdf_remediation/build_auto_remediated_work_version.rb b/app/services/pdf_remediation/build_auto_remediated_work_version.rb
@@ -11,16 +11,16 @@ def self.call(file_resource, remediated_file_url)
     # In the rare case a new work version is published after the remediation
     # job started, we stop the creation of a new remediated version here.
     unless wv_being_remediated.latest_published_version?
-      file_resource.first_auto_remediated_work_version_after(wv_being_remediated)&.destroy!
+      file_resource.first_remediated_work_version_after(wv_being_remediated)&.destroy!
       raise NotNewestReleaseError, 'A newer published version exists.  A remediated version will not be created.'
     end
 
     PaperTrail.request(whodunnit: ExternalApp.pdf_accessibility_api.to_global_id.to_s) do
       ActiveRecord::Base.transaction do
-        built_work_version = file_resource.first_auto_remediated_work_version_after(wv_being_remediated) ||
+        built_work_version = file_resource.first_remediated_work_version_after(wv_being_remediated) ||
           begin
             v = BuildNewWorkVersion.call(wv_being_remediated)
-            v.update({ auto_remediated_version: true,
+            v.update({ remediated_version: true,
                        external_app: ExternalApp.pdf_accessibility_api })
             v
           end
@@ -46,7 +46,7 @@ def self.call(file_resource, remediated_file_url)
   private_class_method def self.build_file_resource(work_version, replacement_tempfile, original_filename)
     new_resource = work_version.file_resources.create!(
       file: replacement_tempfile,
-      auto_remediated_version: true
+      remediated_version: true
     )
 
     new_resource.file_data['metadata']['filename'] = "ACCESSIBLE_VERSION_#{original_filename}"
diff --git a/app/views/dashboard/form/publish/_fields.html.erb b/app/views/dashboard/form/publish/_fields.html.erb
@@ -46,3 +46,7 @@
     <% end %>
   </div>
 <% end %>
+
+<% if current_user.admin? %>
+  <%= render 'remediated_version', form: form %>
+<% end %>
diff --git a/app/views/dashboard/form/publish/_remediated_version.html.erb b/app/views/dashboard/form/publish/_remediated_version.html.erb
@@ -0,0 +1,16 @@
+<div class="form-wrapper">
+  <div class="mb-3 mt-5">
+    <div class="keyline keyline--left mb-3">
+      <h4><%= t 'dashboard.form.publish.remediated_version.header' %></h4>
+    </div>
+  </div>
+
+  <div class="form-check">
+    <%= form.check_box :remediated_version,
+                       class: 'form-check-input' %>
+
+    <%= form.label :remediated_version, class: 'form-check-label' do %>
+      <%= t 'dashboard.form.publish.remediated_version.label' %>
+    <% end %>
+  </div>
+</div>
diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -600,6 +600,9 @@ en:
         auto_doi:
           header: DOI
           message: Upon publication, a DOI will be minted for the work.
+        remediated_version:
+          header: Remediated Version
+          label: This version is a remediated (accessible) version
       members:
         heading: Works
         badge: Work 
diff --git a/db/migrate/20260210130000_rename_auto_remediated_version_to_remediated_version.rb b/db/migrate/20260210130000_rename_auto_remediated_version_to_remediated_version.rb
@@ -0,0 +1,17 @@
+class RenameAutoRemediatedVersionToRemediatedVersion < ActiveRecord::Migration[7.2]
+  def up
+    rename_column :file_resources, :auto_remediated_version, :remediated_version
+    rename_column :work_versions, :auto_remediated_version, :remediated_version
+
+    change_column_default :work_versions, :remediated_version, from: nil, to: false
+    change_column_null :work_versions, :remediated_version, false, false
+  end
+
+  def down
+    change_column_null :work_versions, :remediated_version, true
+    change_column_default :work_versions, :remediated_version, from: false, to: nil
+
+    rename_column :work_versions, :remediated_version, :auto_remediated_version
+    rename_column :file_resources, :remediated_version, :auto_remediated_version
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.2].define(version: 2025_10_30_184453) do
+ActiveRecord::Schema[7.2].define(version: 2026_02_10_130000) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_stat_statements"
   enable_extension "plpgsql"
@@ -154,7 +154,7 @@
     t.datetime "deposited_at", precision: nil
     t.uuid "uuid", default: -> { "uuid_generate_v4()" }
     t.string "remediation_job_uuid"
-    t.boolean "auto_remediated_version", default: false, null: false
+    t.boolean "remediated_version", default: false, null: false
     t.datetime "auto_remediation_failed_at"
   end
 
@@ -272,11 +272,11 @@
     t.datetime "withdrawn_at", precision: nil
     t.datetime "removed_at", precision: nil
     t.boolean "draft_curation_requested"
-    t.datetime "sent_for_curation_at", precision: nil
     t.boolean "imported_metadata_from_rmd"
+    t.datetime "sent_for_curation_at", precision: nil
     t.boolean "mint_doi_requested"
     t.boolean "accessibility_remediation_requested"
-    t.boolean "auto_remediated_version"
+    t.boolean "remediated_version", default: false, null: false
     t.datetime "auto_remediation_started_at"
     t.index ["external_app_id"], name: "index_work_versions_on_external_app_id"
     t.index ["work_id", "version_number"], name: "index_work_versions_on_work_id_and_version_number", unique: true
diff --git a/lib/tasks/flag_existing_remediated_files_and_work_versions.rake b/lib/tasks/flag_existing_remediated_files_and_work_versions.rake
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+namespace :pdf_remediation do
+  desc 'Flag existing remediated WorkVersions that have AccessibleCopy_ filename prefix'
+  task flag_existing_remediated_files_and_work_versions: :environment do
+    scope = FileResource.is_pdf.where("file_data->'metadata'->>'filename' LIKE ?", 'AccessibleCopy_%')
+
+    puts "Found #{scope.count} FileResource records with AccessibleCopy_ filename prefix"
+
+    scope.find_each do |file_resource|
+      file_resource.update(remediated_version: true)
+
+      latest_work_version = file_resource.work_versions.order(:version_number).last ||
+        file_resource.work_versions.order(:created_at).last
+
+      latest_work_version.update(remediated_version: true)
+
+      puts "Flagged WorkVersion ##{latest_work_version.id} and FileResource ##{file_resource.id} as remediated_version"
+    end
+  end
+end
diff --git a/spec/features/dashboard/work_version_form_spec.rb b/spec/features/dashboard/work_version_form_spec.rb
@@ -1461,6 +1461,8 @@ def mock_solr_indexing_job
       fill_in 'work_version_title', with: different_metadata[:title]
       FeatureHelpers::DashboardForm.fill_in_work_details(different_metadata)
       FeatureHelpers::DashboardForm.fill_in_publishing_details(metadata)
+      # Non-admins do not see the remediated version checkbox
+      expect(page).to have_no_field('work_version_remediated_version', type: 'checkbox', visible: :all)
       FeatureHelpers::DashboardForm.publish
 
       #
@@ -1657,6 +1659,10 @@ def mock_solr_indexing_job
       FeatureHelpers::DashboardForm.fill_in_publishing_details_published(
         different_metadata.merge(rights: incorrect_rights)
       )
+
+      # This checkbox only shows for admins
+      check I18n.t('dashboard.form.publish.remediated_version.label')
+
       FeatureHelpers::DashboardForm.finish
       expect(SolrIndexingJob).to have_received(:perform_later).once
 
diff --git a/spec/forms/work_deposit_pathways/data_and_code/publish_form_spec.rb b/spec/forms/work_deposit_pathways/data_and_code/publish_form_spec.rb
@@ -26,7 +26,8 @@
         'source' => 'test source',
         'version_name' => '1.0.0',
         'rights' => 'https://creativecommons.org/licenses/by/4.0/',
-        'contributor' => 'test contributor'
+        'contributor' => 'test contributor',
+        'remediated_version' => false
       }
     )
   }
@@ -121,6 +122,7 @@
         accessibility_agreement
         sensitive_info_agreement
         contributor
+        remediated_version
       }
 
       expect(described_class.form_fields).to be_frozen
@@ -144,7 +146,8 @@
           source: ['test source'],
           version_name: '1.0.0',
           rights: 'https://creativecommons.org/licenses/by/4.0/',
-          contributor: ['test contributor']
+          contributor: ['test contributor'],
+          remediated_version: false
         }
       )
     end
diff --git a/spec/forms/work_deposit_pathways/grad_culminating_experiences/publish_form_spec.rb b/spec/forms/work_deposit_pathways/grad_culminating_experiences/publish_form_spec.rb
@@ -20,7 +20,8 @@
         'related_url' => 'test related_url',
         'language' => 'test language',
         'rights' => 'https://creativecommons.org/licenses/by/4.0/',
-        'contributor' => 'test contributor'
+        'contributor' => 'test contributor',
+        'remediated_version' => false
       }
     )
   }
@@ -39,6 +40,7 @@
   it { is_expected.to delegate_method(:aasm).to(:work_version) }
   it { is_expected.to delegate_method(:update_column).to(:work_version) }
   it { is_expected.to delegate_method(:set_thumbnail_selection).to(:work_version) }
+  it { is_expected.to delegate_method(:mirror_remediated_version_to_files!).to(:work_version) }
 
   describe '#aasm_state=' do
     before { allow(wv).to receive(:aasm_state=) }
@@ -103,6 +105,7 @@
         psu_community_agreement
         accessibility_agreement
         sensitive_info_agreement
+        remediated_version
       }
 
       expect(described_class.form_fields).to be_frozen
@@ -122,7 +125,8 @@
           related_url: ['test related_url'],
           language: ['test language'],
           rights: 'https://creativecommons.org/licenses/by/4.0/',
-          contributor: ['test contributor']
+          contributor: ['test contributor'],
+          remediated_version: false
         }
       )
     end
diff --git a/spec/forms/work_deposit_pathways/instrument/publish_form_spec.rb b/spec/forms/work_deposit_pathways/instrument/publish_form_spec.rb
@@ -23,7 +23,8 @@
       decommission_date: '2024',
       related_identifier: 'test related id',
       instrument_resource_type: 'test resource type',
-      funding_reference: 'test funding ref'
+      funding_reference: 'test funding ref',
+      remediated_version: false
     )
   }
 
@@ -41,7 +42,7 @@
   it { is_expected.to delegate_method(:aasm).to(:work_version) }
   it { is_expected.to delegate_method(:update_column).to(:work_version) }
   it { is_expected.to delegate_method(:set_thumbnail_selection).to(:work_version) }
-
+  it { is_expected.to delegate_method(:mirror_remediated_version_to_files!).to(:work_version) }
   it { is_expected.to validate_presence_of(:owner) }
   it { is_expected.to validate_presence_of(:manufacturer) }
 
@@ -106,6 +107,7 @@
         accessibility_agreement
         sensitive_info_agreement
         rights
+        remediated_version
       }
 
       expect(described_class.form_fields).to be_frozen
@@ -128,7 +130,8 @@
           decommission_date: '2024',
           related_identifier: 'test related id',
           instrument_resource_type: 'test resource type',
-          funding_reference: 'test funding ref'
+          funding_reference: 'test funding ref',
+          remediated_version: false
         }
       )
     end
diff --git a/spec/lib/tasks/pdf_remediation_spec.rb b/spec/lib/tasks/pdf_remediation_spec.rb
diff --git a/spec/models/file_resource_spec.rb b/spec/models/file_resource_spec.rb
diff --git a/spec/models/work_spec.rb b/spec/models/work_spec.rb
diff --git a/spec/models/work_version_spec.rb b/spec/models/work_version_spec.rb
diff --git a/spec/request/dashboard/form/publish_controller_spec.rb b/spec/request/dashboard/form/publish_controller_spec.rb
diff --git a/spec/services/pdf_remediation/auto_remediate_service_spec.rb b/spec/services/pdf_remediation/auto_remediate_service_spec.rb
diff --git a/spec/services/pdf_remediation/build_auto_remediated_work_version_spec.rb b/spec/services/pdf_remediation/build_auto_remediated_work_version_spec.rb
