bb6442c4-eb43-430c-9683-6ffb5848882a

Committed 21 Oct 2025 08:43PM UTC coverage: 87.325% (+0.4%) from 86.877%

Build # bb6442c4-eb43-430c-9683-6ffb5848882a

Build Type

Pull #2066

circleci

Committed by

bess

Commit Message

Stop mediaflux when we stop everything else

Pull Request Pull Request #2066: Stop mediaflux when we stop everything else

Run Details

2625 of 3006 relevant lines covered (87.33%)

307.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.83

/app/jobs/file_inventory_job.rb

# frozen_string_literal: true
class FileInventoryJob < ApplicationJob
  # Create the FileInventoryRequest as soon as the job is created, not when it is performed
  before_enqueue do |job|
    project = Project.find(job.arguments.first[:project_id])
    FileInventoryRequest.create(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id, state: UserRequest::PENDING,
                                request_details: { project_title: project.title })
  end

  # This is required because the before_enqueue does not get called when perform_now is run on a job
  # We include both before_perform and before_enqueue so perform_now and perform_later will work as desired
  before_perform do |job|
    project = Project.find(job.arguments.first[:project_id])
    inventory_request = FileInventoryRequest.find_by(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id)
    if inventory_request.blank?
      FileInventoryRequest.create(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id, state: UserRequest::PENDING,
                                  request_details: { project_title: project.title })
    end
  end

  def perform(user_id:, project_id:, mediaflux_session:)
    project = Project.find(project_id)
    raise "Invalid project id #{project_id} for job #{job_id}" if project.nil?
    user = User.find(user_id)
    raise "Invalid user id #{user_id} for job #{job_id}" if user.nil?
    Rails.logger.debug inspect

    # set the mediaflux session to the one the user created, do not just utilize the system one
    user.mediaflux_from_session({ mediaflux_session: })

    # Queries Mediaflux for the file list and saves it to a CSV file.
    filename = filename_for_export
    Rails.logger.info "Exporting file list to #{filename} for project #{project_id} (session: #{mediaflux_session})"
    project.file_list_to_file(session_id: mediaflux_session, filename: filename)
    Rails.logger.info "Export file generated #{filename} for project #{project_id} (session: #{mediaflux_session})"

    # Update the job record as completed
    update_inventory_request(user_id: user.id, project: project, job_id: @job_id, filename: filename)
  rescue Mediaflux::SessionExpired => e
    # do not retry we can not continue if the session is expired
    fail_inventory_request(user_id: user.id, project: project, job_id: @job_id)
  end

  private

    def mediaflux_session
      logon_request = Mediaflux::LogonRequest.new
      logon_request.session_token
    end

    def filename_for_export
      raise "Shared location is not configured" if Rails.configuration.mediaflux["shared_files_location"].blank?
      pathname = Pathname.new(Rails.configuration.mediaflux["shared_files_location"])
      pathname.join("#{job_id}.csv").to_s
    end

    def fail_inventory_request(user_id:, project:, job_id: )
      inventory_request = FileInventoryRequest.find_by(user_id: user_id, project_id: project.id, job_id: job_id)
      request_details = { project_title: project.title, error: "Mediaflux session expired" }
      inventory_request.update(state: UserRequest::FAILED, request_details: request_details,
                                completion_time: Time.current.in_time_zone("America/New_York"))
      inventory_request
    rescue ActiveRecord::StatementInvalid
      Rails.logger.info "Export - failing inventory request details for project #{project.id} job_id: #{job_id} failed, about to retry"
      ActiveRecord::Base.connection_pool.release_connection
      retry
    end

    def update_inventory_request(user_id:, project:, job_id:, filename: )
      Rails.logger.info "Export - updating inventory request details for project #{project.id}"
      inventory_request = FileInventoryRequest.find_by(user_id: user_id, project_id: project.id, job_id: job_id)
      request_details = { output_file: filename, project_title: project.title, file_size: File.size(filename) }
      inventory_request.update(state: UserRequest::COMPLETED, request_details: request_details,
                                completion_time: Time.current.in_time_zone("America/New_York"))
      Rails.logger.info "Export - updated inventory request details for project #{project.id}"
      inventory_request
    rescue ActiveRecord::StatementInvalid
      Rails.logger.info "Export - updating inventory request details for project #{project.id} failed, about to retry"
      ActiveRecord::Base.connection_pool.release_connection
      retry
    end
end

1	# frozen_string_literal: true
2	class FileInventoryJob < ApplicationJob	2✔
3	# Create the FileInventoryRequest as soon as the job is created, not when it is performed
4	before_enqueue do \|job\|	2✔
5	project = Project.find(job.arguments.first[:project_id])	3✔
6	FileInventoryRequest.create(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id, state: UserRequest::PENDING,	3✔
7	request_details: { project_title: project.title })
8	end
9
10	# This is required because the before_enqueue does not get called when perform_now is run on a job
11	# We include both before_perform and before_enqueue so perform_now and perform_later will work as desired
12	before_perform do \|job\|	2✔
13	project = Project.find(job.arguments.first[:project_id])	15✔
14	inventory_request = FileInventoryRequest.find_by(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id)	15✔
15	if inventory_request.blank?	15✔
16	FileInventoryRequest.create(user_id: job.arguments.first[:user_id], project_id: job.arguments.first[:project_id], job_id: @job_id, state: UserRequest::PENDING,	14✔
17	request_details: { project_title: project.title })
18	end
19	end
20
21	def perform(user_id:, project_id:, mediaflux_session:)	2✔
22	project = Project.find(project_id)	15✔
23	raise "Invalid project id #{project_id} for job #{job_id}" if project.nil?	15✔
24	user = User.find(user_id)	15✔
25	raise "Invalid user id #{user_id} for job #{job_id}" if user.nil?	14✔
26	Rails.logger.debug inspect	14✔
27
28	# set the mediaflux session to the one the user created, do not just utilize the system one
29	user.mediaflux_from_session({ mediaflux_session: })	14✔
30
31	# Queries Mediaflux for the file list and saves it to a CSV file.
32	filename = filename_for_export	14✔
33	Rails.logger.info "Exporting file list to #{filename} for project #{project_id} (session: #{mediaflux_session})"	14✔
34	project.file_list_to_file(session_id: mediaflux_session, filename: filename)	14✔
35	Rails.logger.info "Export file generated #{filename} for project #{project_id} (session: #{mediaflux_session})"	12✔
36
37	# Update the job record as completed
38	update_inventory_request(user_id: user.id, project: project, job_id: @job_id, filename: filename)	12✔
39	rescue Mediaflux::SessionExpired => e
40	# do not retry we can not continue if the session is expired
41	fail_inventory_request(user_id: user.id, project: project, job_id: @job_id)	2✔
42	end
43
44	private	2✔
45
46	def mediaflux_session	2✔
47	logon_request = Mediaflux::LogonRequest.new	×
48	logon_request.session_token	×
49	end
50
51	def filename_for_export	2✔
52	raise "Shared location is not configured" if Rails.configuration.mediaflux["shared_files_location"].blank?	14✔
53	pathname = Pathname.new(Rails.configuration.mediaflux["shared_files_location"])	14✔
54	pathname.join("#{job_id}.csv").to_s	14✔
55	end
56
57	def fail_inventory_request(user_id:, project:, job_id: )	2✔
58	inventory_request = FileInventoryRequest.find_by(user_id: user_id, project_id: project.id, job_id: job_id)	3✔
59	request_details = { project_title: project.title, error: "Mediaflux session expired" }	3✔
60	inventory_request.update(state: UserRequest::FAILED, request_details: request_details,	3✔
61	completion_time: Time.current.in_time_zone("America/New_York"))
62	inventory_request	2✔
63	rescue ActiveRecord::StatementInvalid
64	Rails.logger.info "Export - failing inventory request details for project #{project.id} job_id: #{job_id} failed, about to retry"	1✔
65	ActiveRecord::Base.connection_pool.release_connection	1✔
66	retry	1✔
67	end
68
69	def update_inventory_request(user_id:, project:, job_id:, filename: )	2✔
70	Rails.logger.info "Export - updating inventory request details for project #{project.id}"	13✔
71	inventory_request = FileInventoryRequest.find_by(user_id: user_id, project_id: project.id, job_id: job_id)	13✔
72	request_details = { output_file: filename, project_title: project.title, file_size: File.size(filename) }	13✔
73	inventory_request.update(state: UserRequest::COMPLETED, request_details: request_details,	13✔
74	completion_time: Time.current.in_time_zone("America/New_York"))
75	Rails.logger.info "Export - updated inventory request details for project #{project.id}"	12✔
76	inventory_request	12✔
77	rescue ActiveRecord::StatementInvalid
78	Rails.logger.info "Export - updating inventory request details for project #{project.id} failed, about to retry"	1✔
79	ActiveRecord::Base.connection_pool.release_connection	1✔
80	retry	1✔
81	end
82	end

pulibrary / tigerdata-app / bb6442c4-eb43-430c-9683-6ffb5848882a

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous