ab8221e2-dd92-4795-bab6-c1b95de430d1

Committed 06 Oct 2025 08:07PM UTC coverage: 90.802%. First build

Build # ab8221e2-dd92-4795-bab6-c1b95de430d1

Build Type

Pull #1965

circleci

Committed by

carolyncole

Commit Message

Allow a serch parameter to be passed to the projects controller
also clean up some unused methods and code that no longer makes sense in the request/project context

Pull Request Pull Request #1965: Allow a search parameter to be passed to the projects controller

Run Details

15 of 17 new or added lines in 1 file covered. (88.24%)

2695 of 2968 relevant lines covered (90.8%)

358.47 hits per line

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

89.26

/app/controllers/projects_controller.rb

# frozen_string_literal: true
class ProjectsController < ApplicationController

  before_action :set_breadcrumbs
  before_action :authenticate_user!

  def details
    return if project.blank?

    add_breadcrumb(project.title, project_path)
    add_breadcrumb("Details")

    @departments = project.departments.join(", ")
    @project_metadata = project.metadata_model

    @data_sponsor = User.find_by(uid: @project_metadata.data_sponsor)
    @data_manager = User.find_by(uid: @project_metadata.data_manager)

    read_only_uids = @project_metadata.ro_users
    data_read_only_users = read_only_uids.map { |uid| ReadOnlyUser.find_by(uid:) }.reject(&:blank?)

    read_write_uids = @project_metadata.rw_users
    data_read_write_users = read_write_uids.map { |uid| User.find_by(uid:) }.reject(&:blank?)

    unsorted_data_users = data_read_only_users + data_read_write_users
    sorted_data_users = unsorted_data_users.sort_by { |u| u.family_name || u.uid }
    @data_users = sorted_data_users.uniq { |u| u.uid }
    user_model_names = @data_users.map(&:display_name_safe)
    @data_user_names = user_model_names.join(", ")

    @provenance_events = project.provenance_events.where.not(event_type: ProvenanceEvent::STATUS_UPDATE_EVENT_TYPE)

    @project_eligible_to_edit = true if project.status == Project::APPROVED_STATUS && eligible_editor?

    @project_metadata = @project.metadata
    @project_id = @project_metadata[:project_id] || {}
    @storage_capacity = @project_metadata[:storage_capacity]
    @size = @storage_capacity[:size]
    @unit = @storage_capacity[:unit]

    @requested_size = @size[:requested]
    @requested_unit = @unit[:requested]

    @approved_size = @size[:approved]
    @approved_unit = @unit[:approved]

    @storage_expectations = @project_metadata[:storage_performance_expectations]
    @requested_storage_expectations = @storage_expectations[:requested]
    @approved_storage_expectations = @storage_expectations[:approved]

    @project_purpose = @project_metadata[:project_purpose]
    @number_of_files = @project_metadata[:number_of_files]
    @hpc = @project_metadata[:hpc]
    @smb = @project_metadata[:smb_request]
    @globus = @project_metadata[:globus_request]

    @project_session = "details"

    respond_to do |format|
      format.html do
        @project = ProjectShowPresenter.new(project)
      end
      format.json do
        render json: project.to_json
      end
      format.xml do
        render xml: project.to_xml
      end
    end
  end

  def index
    if current_user.eligible_sysadmin?
      search_projects
    else
      flash[:alert] = I18n.t(:access_denied)
      redirect_to dashboard_path
    end
  end

  def show

    return if project.blank?
    add_breadcrumb(project.title, project_path)
    add_breadcrumb("Contents")

    @latest_completed_download = current_user.user_requests.where(project_id: @project.id, state: "completed").order(:completion_time).last
    @storage_usage = project.storage_usage(session_id: current_user.mediaflux_session)
    @storage_capacity = project.storage_capacity(session_id: current_user.mediaflux_session)

    @num_files = project.asset_count(session_id: current_user.mediaflux_session)

    @file_list = project.file_list(session_id: current_user.mediaflux_session, size: 100)
    @files = @file_list[:files]
    @files.sort_by!(&:path)
    @project = ProjectShowPresenter.new(project)

    @project_session = "content"
    respond_to do |format|
      format.html { render }
      format.xml { render xml: @project.to_xml }
    end
  end

  # GET "projects/:id/:id-mf"
  #
  # This action is used to render the mediaflux metadata for a project.
  def show_mediaflux
    project_id = params[:id]
    project = Project.find(project_id)
    respond_to do |format|
      format.xml do
        render xml: project.mediaflux_meta_xml(user: current_user)
      end
    end
  rescue => ex
    Rails.logger.error "Error getting MediaFlux XML for project #{project_id}, user #{current_user.uid}: #{ex.message}"
    flash[:alert] = "Error fetching Mediaflux XML for this project"
    redirect_to project_path(project_id)
  end

  def list_contents
    return if project.blank?

    project_job_service.list_contents_job(user: current_user)

    json_response = {
      message: "File list for \"#{project.title}\" is being generated in the background. A link to the downloadable file list will be available in the \"Recent Activity\" section of your dashboard when it is available. You may safely navigate away from this page or close this tab."
    }
    render json: json_response
  rescue => ex
    message = "Error producing document list (project id: #{project&.id}): #{ex.message}"
    Rails.logger.error(message)
    Honeybadger.notify(message)
    render json: { message: "Document list could not be generated." }
  end

  def file_list_download
    job_id = params[:job_id]
    user_request = FileInventoryRequest.where(job_id:job_id).first
    if user_request.nil?
      # TODO: handle error
      redirect_to "/"
    else
      filename = user_request.output_file
      send_data File.read(filename), type: "text/plain", filename: "filelist.csv", disposition: "attachment"
    end
  end

  private

    def project_job_service
      @project_job_service ||= ProjectJobService.new(project:)
    end


    def build_new_project
      @project ||= Project.new
    end

    def project
      @project ||= begin
        project = Project.find(params[:id])
        if project.user_has_access?(user: current_user)
          project
        else
          flash[:alert] = I18n.t(:access_denied)
          redirect_to dashboard_path
          nil
        end
      end
    end

    def eligible_editor?
      return true if current_user.eligible_sponsor? or current_user.eligible_manager?
    end

    def set_breadcrumbs
      add_breadcrumb("Dashboard",dashboard_path)
    end

    def search_projects
      @title_query = params[:title_query]
      if @title_query.blank?
        @projects = Project.all
        flash[:notice] = nil
      else
        result =  ProjectSearch.new.call(search_string: @title_query, requestor: current_user)
        if result.success?
          flash[:notice] = nil
          @projects = result.value!
        else
          @projects = []
          flash[:notice] = "Error reaching projects for #{@title_query}.  Error: #{result.failure}"
        end
      end
    end
end

1	# frozen_string_literal: true
2	class ProjectsController < ApplicationController	1✔
3
4	before_action :set_breadcrumbs	1✔
5	before_action :authenticate_user!	1✔
6
7	def details	1✔
8	return if project.blank?	16✔
9
10	add_breadcrumb(project.title, project_path)	15✔
11	add_breadcrumb("Details")	15✔
12
13	@departments = project.departments.join(", ")	15✔
14	@project_metadata = project.metadata_model	15✔
15
16	@data_sponsor = User.find_by(uid: @project_metadata.data_sponsor)	15✔
17	@data_manager = User.find_by(uid: @project_metadata.data_manager)	15✔
18
19	read_only_uids = @project_metadata.ro_users	15✔
20	data_read_only_users = read_only_uids.map { \|uid\| ReadOnlyUser.find_by(uid:) }.reject(&:blank?)	20✔
21
22	read_write_uids = @project_metadata.rw_users	15✔
23	data_read_write_users = read_write_uids.map { \|uid\| User.find_by(uid:) }.reject(&:blank?)	20✔
24
25	unsorted_data_users = data_read_only_users + data_read_write_users	15✔
26	sorted_data_users = unsorted_data_users.sort_by { \|u\| u.family_name \|\| u.uid }	25✔
27	@data_users = sorted_data_users.uniq { \|u\| u.uid }	25✔
28	user_model_names = @data_users.map(&:display_name_safe)	15✔
29	@data_user_names = user_model_names.join(", ")	15✔
30
31	@provenance_events = project.provenance_events.where.not(event_type: ProvenanceEvent::STATUS_UPDATE_EVENT_TYPE)	15✔
32
33	@project_eligible_to_edit = true if project.status == Project::APPROVED_STATUS && eligible_editor?	15✔
34
35	@project_metadata = @project.metadata	15✔
36	@project_id = @project_metadata[:project_id] \|\| {}	15✔
37	@storage_capacity = @project_metadata[:storage_capacity]	15✔
38	@size = @storage_capacity[:size]	15✔
39	@unit = @storage_capacity[:unit]	15✔
40
41	@requested_size = @size[:requested]	15✔
42	@requested_unit = @unit[:requested]	15✔
43
44	@approved_size = @size[:approved]	15✔
45	@approved_unit = @unit[:approved]	15✔
46
47	@storage_expectations = @project_metadata[:storage_performance_expectations]	15✔
48	@requested_storage_expectations = @storage_expectations[:requested]	15✔
49	@approved_storage_expectations = @storage_expectations[:approved]	15✔
50
51	@project_purpose = @project_metadata[:project_purpose]	15✔
52	@number_of_files = @project_metadata[:number_of_files]	15✔
53	@hpc = @project_metadata[:hpc]	15✔
54	@smb = @project_metadata[:smb_request]	15✔
55	@globus = @project_metadata[:globus_request]	15✔
56
57	@project_session = "details"	15✔
58
59	respond_to do \|format\|	15✔
60	format.html do	15✔
61	@project = ProjectShowPresenter.new(project)	12✔
62	end
63	format.json do	15✔
64	render json: project.to_json	2✔
65	end
66	format.xml do	15✔
67	render xml: project.to_xml	1✔
68	end
69	end
70	end
71
72	def index	1✔
73	if current_user.eligible_sysadmin?	8✔
74	search_projects	4✔
75	else
76	flash[:alert] = I18n.t(:access_denied)	4✔
77	redirect_to dashboard_path	4✔
78	end
79	end
80
81	def show	1✔
82
83	return if project.blank?	38✔
84	add_breadcrumb(project.title, project_path)	34✔
85	add_breadcrumb("Contents")	34✔
86
87	@latest_completed_download = current_user.user_requests.where(project_id: @project.id, state: "completed").order(:completion_time).last	34✔
88	@storage_usage = project.storage_usage(session_id: current_user.mediaflux_session)	34✔
89	@storage_capacity = project.storage_capacity(session_id: current_user.mediaflux_session)	30✔
90
91	@num_files = project.asset_count(session_id: current_user.mediaflux_session)	30✔
92
93	@file_list = project.file_list(session_id: current_user.mediaflux_session, size: 100)	30✔
94	@files = @file_list[:files]	30✔
95	@files.sort_by!(&:path)	30✔
96	@project = ProjectShowPresenter.new(project)	30✔
97
98	@project_session = "content"	30✔
99	respond_to do \|format\|	30✔
100	format.html { render }	54✔
101	format.xml { render xml: @project.to_xml }	36✔
102	end
103	end
104
105	# GET "projects/:id/:id-mf"
106	#
107	# This action is used to render the mediaflux metadata for a project.
108	def show_mediaflux	1✔
109	project_id = params[:id]	4✔
110	project = Project.find(project_id)	4✔
111	respond_to do \|format\|	3✔
112	format.xml do	3✔
113	render xml: project.mediaflux_meta_xml(user: current_user)	3✔
114	end
115	end
116	rescue => ex
117	Rails.logger.error "Error getting MediaFlux XML for project #{project_id}, user #{current_user.uid}: #{ex.message}"	1✔
118	flash[:alert] = "Error fetching Mediaflux XML for this project"	1✔
119	redirect_to project_path(project_id)	1✔
120	end
121
122	def list_contents	1✔
123	return if project.blank?	4✔
124
125	project_job_service.list_contents_job(user: current_user)	3✔
126
127	json_response = {
128	message: "File list for \"#{project.title}\" is being generated in the background. A link to the downloadable file list will be available in the \"Recent Activity\" section of your dashboard when it is available. You may safely navigate away from this page or close this tab."	3✔
129	}
130	render json: json_response	3✔
131	rescue => ex
132	message = "Error producing document list (project id: #{project&.id}): #{ex.message}"	×
133	Rails.logger.error(message)	×
134	Honeybadger.notify(message)	×
135	render json: { message: "Document list could not be generated." }	×
136	end
137
138	def file_list_download	1✔
139	job_id = params[:job_id]	×
140	user_request = FileInventoryRequest.where(job_id:job_id).first	×
141	if user_request.nil?	×
142	# TODO: handle error
143	redirect_to "/"	×
144	else
145	filename = user_request.output_file	×
146	send_data File.read(filename), type: "text/plain", filename: "filelist.csv", disposition: "attachment"	×
147	end
148	end
149
150	private	1✔
151
152	def project_job_service	1✔
153	@project_job_service \|\|= ProjectJobService.new(project:)	3✔
154	end
155
156
157	def build_new_project	1✔
158	@project \|\|= Project.new	×
159	end
160
161	def project	1✔
162	@project \|\|= begin	342✔
163	project = Project.find(params[:id])	56✔
164	if project.user_has_access?(user: current_user)	56✔
165	project	50✔
166	else
167	flash[:alert] = I18n.t(:access_denied)	6✔
168	redirect_to dashboard_path	6✔
169	nil	6✔
170	end
171	end
172	end
173
174	def eligible_editor?	1✔
175	return true if current_user.eligible_sponsor? or current_user.eligible_manager?	10✔
176	end
177
178	def set_breadcrumbs	1✔
179	add_breadcrumb("Dashboard",dashboard_path)	76✔
180	end
181
182	def search_projects	1✔
183	@title_query = params[:title_query]	4✔
184	if @title_query.blank?	4✔
185	@projects = Project.all	2✔
186	flash[:notice] = nil	2✔
187	else
188	result = ProjectSearch.new.call(search_string: @title_query, requestor: current_user)	2✔
189	if result.success?	2✔
190	flash[:notice] = nil	2✔
191	@projects = result.value!	2✔
192	else
NEW 193	@projects = []	×
NEW 194	flash[:notice] = "Error reaching projects for #{@title_query}. Error: #{result.failure}"	×
195	end
196	end
197	end
198	end

pulibrary / tigerdata-app / ab8221e2-dd92-4795-bab6-c1b95de430d1

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