Skip to content

Commit

Permalink
Add logging to file and exception handling
Browse files Browse the repository at this point in the history
- Logging allows us to gather a list of documents that cannot be found
- Failure to find is typically because the path/slug has changed.
  • Loading branch information
ellohez committed Nov 21, 2024
1 parent 40d9f35 commit df8c83c
Showing 1 changed file with 32 additions and 14 deletions.
46 changes: 32 additions & 14 deletions lib/tasks/access_and_permissions.rake
Original file line number Diff line number Diff line change
@@ -1,34 +1,52 @@
require "csv"

namespace :permissions do
desc "Add an organisation to an document's access permissions list"
task :add_organisation_access, %i[document_content_id org_content_id] => :environment do |_, args|
desc "Add an organisation to a document's access permissions list"
task :add_organisation_access, %i[document_content_id org_content_id log_file] => :environment do |_, args|
document = Artefact.find_by(id: args[:document_content_id])

if document.nil?
puts "Document not found, no permissions changed."
elsif document.latest_edition.owning_org_content_ids.include? args[:org_content_id]
puts "Organisation already has permission to access this document"
message = "Document ID #{args[:document_content_id]} not found, no permissions changed."
elsif document.latest_edition.owning_org_content_ids.include?(args[:org_content_id])
message = "Organisation already has permission to access the document with ID - #{document.id}"
else
Edition.where(panopticon_id: document.id).each do |edition|
edition.owning_org_content_ids << args[:org_content_id]
edition.save!(validate: false)
end
document.save_as_task!("PermissionsAddition")
puts "Access permission successfully assigned"
message = "Access permission successfully assigned to document with ID - #{document.id}"
end
args[:log_file] ? args[:log_file].puts(message) : puts(message)
rescue StandardError => e
error_message = "An error occurred while processing document ID #{args[:document_content_id]}: #{e.message}"
args[:log_file] ? args[:log_file].puts(error_message) : puts(error_message)
end

desc "Bulk process access permissions from CSV of URLs - See doc"
task :bulk_process_access_flags, %i[csv_filename organisation_id] => :environment do |_, args|
CSV.foreach(args[:csv_filename], headers: true) do |row|
path = row[1]
path.slice! "https://www.gov.uk/"
document = Artefact.find_by(slug: path)
log_file = File.new("/tmp/permissions_rake_log.txt", "w")

begin
CSV.foreach(args[:csv_filename], headers: true) do |row|
path = row[1]
path&.slice!("https://www.gov.uk/")
document = Artefact.find_by(slug: path)

next if document.nil?
if document.nil?
log_file.puts "Document with slug '#{path}' not found. Skipping..."
next
end

Rake::Task["permissions:add_organisation_access"].reenable # I prefer to do this first but can be done after if cleaner
Rake::Task["permissions:add_organisation_access"].invoke(document.id, args[:organisation_id])
Rake::Task["permissions:add_organisation_access"].reenable
Rake::Task["permissions:add_organisation_access"].invoke(document.id, args[:organisation_id], log_file)
rescue Mongoid::Errors::DocumentNotFound => e
log_file.puts "--- Document not found error ---"
log_file.puts e.detailed_message
log_file.puts "------"
end
ensure
log_file.close
end
end
end
end

Check failure on line 52 in lib/tasks/access_and_permissions.rake

View workflow job for this annotation

GitHub Actions / Lint Ruby / Run RuboCop

Layout/TrailingEmptyLines: Final newline missing. (https://rubystyle.guide#newline-eof)

0 comments on commit df8c83c

Please sign in to comment.