3f98f228-6ecf-4120-a478-d9932b13e420

Committed 23 Oct 2025 09:19PM UTC coverage: 91.178%. Remained the same

Build # 3f98f228-6ecf-4120-a478-d9932b13e420

Build Type

push

circleci

Committed by

web-flow

Commit Message

Added tooltip to Data Sponsor Field (#2092)

Added 20px to margin to display the tooltip.

ref #2081 


<img width="1219" height="201" alt="Screenshot 2025-10-23 at 2 34 36 PM"
src="https://github.com/user-attachments/assets/d529b85c-a834-4aa3-9456-1ca89e1ec6ac"
/>

Co-authored-by: Precilla Prempeh <pprempeh@princeton.edu>
Co-authored-by: Robert-Anthony Lee-Faison <leefaisonr@users.noreply.github.com>

Run Details

2739 of 3004 relevant lines covered (91.18%)

757.2 hits per line

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

82.86

/app/models/user.rb

# frozen_string_literal: true

require "csv"
class User < ApplicationRecord
  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
  devise :rememberable, :omniauthable

  has_many :user_requests, dependent: :destroy

  paginates_per 100

  USER_REGISTRATION_LIST = Rails.root.join("data", "user_registration_list_#{Rails.env}.csv")

  attr_accessor :mediaflux_session

  def self.from_cas(access_token)
    user = User.find_by(provider: access_token.provider, uid: access_token.uid)
    if user.present? && user.given_name.nil? # fix any users that do not have the name information loaded
      user.initialize_name_values(access_token.extra)
      user.save
    end
    user
  end

  # Users that can be project sponsors
  def self.sponsor_users
    if Rails.env.development? || Rails.env.staging?
      User.where(eligible_sponsor: true).or(User.where(developer: true))
    else
      User.where(eligible_sponsor: true)
    end
  end

  # Users that can be data managers
  def self.manager_users
    if Rails.env.development? || Rails.env.staging?
      User.where(eligible_manager: true).or(User.where(developer: true))
    else
      User.where(eligible_manager: true)
    end
  end

  def clear_mediaflux_session(session)
    Rails.logger.debug("!!!!!!! Clearing Mediaflux session !!!!!!!!")
    @mediaflux_session = nil
    session[:mediaflux_session] = nil
  end

  def mediaflux_from_session(session)
    logger.debug "Session Get #{session[:mediaflux_session]} cas: #{session[:active_web_user]}  user: #{uid}"
    if session[:mediaflux_session].blank?
      logger.debug("!!!! Creating a new session !!! #{uid}")
      session[:mediaflux_session] = SystemUser.mediaflux_session
      session[:active_web_user] = false
    end
    @active_web_user = session[:active_web_user]
    @mediaflux_session = session[:mediaflux_session]
  end

  def mediaflux_login(token, session)
    logger.debug("mediaflux session created for #{uid}")
    logon_request = Mediaflux::LogonRequest.new(identity_token: token, token_type: "cas")
    if logon_request.error?
      raise "Invalid Logon #{logon_request.response_error}"
    end
    @mediaflux_session = logon_request.session_token
    @active_web_user = true
    session[:mediaflux_session] = @mediaflux_session
    session[:active_web_user] = @active_web_user
    logger.debug "Login Session #{session[:mediaflux_session]} cas: #{session[:active_web_user]}  user: #{uid}"

    User.update_user_roles(user: self)
  end

  def terminate_mediaflux_session
    return if @mediaflux_session.nil? # nothing to terminate
    logger.debug "!!!! Terminating mediaflux session"

    Mediaflux::LogoutRequest.new(session_token: @mediaflux_session).response_body
    @mediaflux_session = nil
  end

  # Initialize the name values from the CAS information.
  # Our name fields do not match their name fields, so we need to translate.
  def initialize_name_values(extra_cas_info)
    self.given_name = extra_cas_info.givenname
    self.family_name =  extra_cas_info.sn
    self.display_name = extra_cas_info.pudisplayname
  end

  # Return the display name if it exists, otherwise return the uid
  # @return [String]
  def display_name_safe
    return uid if display_name.blank?

    "#{display_name} (#{uid})"
  end

  # Is this user eligible to be a data sponsor in this environment?
  # @return [Boolean]
  def eligible_sponsor?
    return true if developer
    super
  end

  # Is this user eligible to be a data manger in this environment?
  # @return [Boolean]
  def eligible_manager?
    return true if developer
    super
  end

  def developer?
    return true if developer
    super
  end

  # Is this user eligible to be a data user in this environment?
  # @return [Boolean]
  def eligible_data_user?
    return true if developer
    return true if !eligible_sponsor? && !eligible_manager
  end

  # Is this user eligible to be a sysadmin in this environment?
  # @return [Boolean]
  def eligible_sysadmin?
    (!Rails.env.production? && (developer || sysadmin)) || (Rails.env.production? && sysadmin)
  end

  def eligible_to_create_new?
    return true if eligible_sysadmin?

    !Rails.env.production? && (eligible_sponsor? && trainer?)
  end

  # Methods serialize_into_session() and serialize_from_session() are called by Warden/Devise
  # to calculate what information will be stored in the session and to serialize an object
  # back from the session.
  #
  # By default Warden/Devise store the database ID of the record (e.g. User.id) but this causes
  # problems if we repopulate our User table and the IDs change. The implementation provided below
  # uses the User.uid field (which is unique, does not change, and it's required) as the value to
  # store in the session to prevent this issue.
  #
  # References:
  #   https://stackoverflow.com/questions/23597718/what-is-the-warden-data-in-a-rails-devise-session-composed-of/23683925#23683925
  #   https://web.archive.org/web/20211028103224/https://tadas-s.github.io/ruby-on-rails/2020/08/02/devise-serialize-into-session-trick/
  #   https://github.com/wardencommunity/warden/wiki/Setup
  def self.serialize_into_session(record)
    # The return value _must_ have at least two elements since the serialize_from_session() requires
    # two arguments (see below)
    [record.uid, ""]
  end

  def self.serialize_from_session(key, _salt, _opts = {})
    User.where(uid: key)&.first
  end

  # Fetches the most recent download jobs for the user
  def latest_downloads(limit: 10)
    @latest_downloads ||= begin
                            downloads = UserRequest.where(user_id: id).where(["completion_time > ?", 7.days.ago]).order(created_at: "DESC").limit(limit)
                            downloads.map{|download| UserRequestPresenter.new(download)}
                          end
  end

  # Updates the user's roles (sys admin, developer) depending on the information on Mediaflux.
  # This method is meant to be used only for the current logged in user since the roles depend on the Mediaflux session.
  def self.update_user_roles(user:)
    raise "User.update_user_roles called with for a user without a Mediaflux session" if user.mediaflux_session.nil?

    mediaflux_roles = mediaflux_roles(user:)
    update_developer_status(user:, mediaflux_roles:)
    update_sysadmin_status(user:, mediaflux_roles:)
  rescue => ex
    Rails.logger.error("Error updating roles for user (id: #{user.id}) status, error: #{ex.message}")
  end

  # Returns the roles in Mediaflux for the user in the session.
  # This method is meant to be used only for the current logged in user since the roles depend on the Mediaflux session.
  def self.mediaflux_roles(user:)
    raise "User.mediaflux_roles called with for a user without a Mediaflux session" if user.mediaflux_session.nil?

    request = Mediaflux::ActorSelfDescribeRequest.new(session_token: user.mediaflux_session)
    request.resolve
    request.roles
  end

  private

  def self.update_developer_status(user:, mediaflux_roles:)
    # TODO: Figure out why the role name is different in staging from production:
    #   production:   "pu-smb-group:PU:tigerdata:librarydevelopers"
    #   staging:      "pu-oit-group:PU:tigerdata:librarydevelopers"
    #   development:  "pu-lib:developer"
    #   test:         "system-administrator"
    developer_now = mediaflux_roles.include?("pu-smb-group:PU:tigerdata:librarydevelopers") ||
      mediaflux_roles.include?("pu-oit-group:PU:tigerdata:librarydevelopers") ||
      mediaflux_roles.include?("pu-lib:developer") ||
      mediaflux_roles.include?("system-administrator")
    if user.developer != developer_now
      # Only update the record in the database if there is a change
      Rails.logger.info("Updating developer role for user #{user.id} to #{developer_now}")
      user.developer = developer_now
      user.save!
    end
  end

  def self.update_sysadmin_status(user:, mediaflux_roles:)
    sysadmin_now = mediaflux_roles.include?("system-administrator")
    if user.sysadmin != sysadmin_now
      # Only update the record in the database if there is a change
      Rails.logger.info("Updating sysadmin role for user #{user.id} to #{sysadmin_now}")
      user.sysadmin = sysadmin_now
      user.save!
    end
  end
end

1	# frozen_string_literal: true
2
3	require "csv"	6✔
4	class User < ApplicationRecord	6✔
5	# Include default devise modules. Others available are:
6	# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
7	devise :rememberable, :omniauthable	6✔
8
9	has_many :user_requests, dependent: :destroy	6✔
10
11	paginates_per 100	6✔
12
13	USER_REGISTRATION_LIST = Rails.root.join("data", "user_registration_list_#{Rails.env}.csv")	6✔
14
15	attr_accessor :mediaflux_session	6✔
16
17	def self.from_cas(access_token)	6✔
18	user = User.find_by(provider: access_token.provider, uid: access_token.uid)	18✔
19	if user.present? && user.given_name.nil? # fix any users that do not have the name information loaded	18✔
20	user.initialize_name_values(access_token.extra)	14✔
21	user.save	14✔
22	end
23	user	18✔
24	end
25
26	# Users that can be project sponsors
27	def self.sponsor_users	6✔
28	if Rails.env.development? \|\| Rails.env.staging?	4✔
29	User.where(eligible_sponsor: true).or(User.where(developer: true))	2✔
30	else
31	User.where(eligible_sponsor: true)	2✔
32	end
33	end
34
35	# Users that can be data managers
36	def self.manager_users	6✔
37	if Rails.env.development? \|\| Rails.env.staging?	×
38	User.where(eligible_manager: true).or(User.where(developer: true))	×
39	else
40	User.where(eligible_manager: true)	×
41	end
42	end
43
44	def clear_mediaflux_session(session)	6✔
45	Rails.logger.debug("!!!!!!! Clearing Mediaflux session !!!!!!!!")	6✔
46	@mediaflux_session = nil	6✔
47	session[:mediaflux_session] = nil	6✔
48	end
49
50	def mediaflux_from_session(session)	6✔
51	logger.debug "Session Get #{session[:mediaflux_session]} cas: #{session[:active_web_user]} user: #{uid}"	1,051✔
52	if session[:mediaflux_session].blank?	1,051✔
53	logger.debug("!!!! Creating a new session !!! #{uid}")	544✔
54	session[:mediaflux_session] = SystemUser.mediaflux_session	544✔
55	session[:active_web_user] = false	540✔
56	end
57	@active_web_user = session[:active_web_user]	1,047✔
58	@mediaflux_session = session[:mediaflux_session]	1,047✔
59	end
60
61	def mediaflux_login(token, session)	6✔
62	logger.debug("mediaflux session created for #{uid}")	×
63	logon_request = Mediaflux::LogonRequest.new(identity_token: token, token_type: "cas")	×
64	if logon_request.error?	×
65	raise "Invalid Logon #{logon_request.response_error}"	×
66	end
67	@mediaflux_session = logon_request.session_token	×
68	@active_web_user = true	×
69	session[:mediaflux_session] = @mediaflux_session	×
70	session[:active_web_user] = @active_web_user	×
71	logger.debug "Login Session #{session[:mediaflux_session]} cas: #{session[:active_web_user]} user: #{uid}"	×
72
73	User.update_user_roles(user: self)	×
74	end
75
76	def terminate_mediaflux_session	6✔
77	return if @mediaflux_session.nil? # nothing to terminate	×
78	logger.debug "!!!! Terminating mediaflux session"	×
79
80	Mediaflux::LogoutRequest.new(session_token: @mediaflux_session).response_body	×
81	@mediaflux_session = nil	×
82	end
83
84	# Initialize the name values from the CAS information.
85	# Our name fields do not match their name fields, so we need to translate.
86	def initialize_name_values(extra_cas_info)	6✔
87	self.given_name = extra_cas_info.givenname	14✔
88	self.family_name = extra_cas_info.sn	14✔
89	self.display_name = extra_cas_info.pudisplayname	14✔
90	end
91
92	# Return the display name if it exists, otherwise return the uid
93	# @return [String]
94	def display_name_safe	6✔
95	return uid if display_name.blank?	453✔
96
97	"#{display_name} (#{uid})"	439✔
98	end
99
100	# Is this user eligible to be a data sponsor in this environment?
101	# @return [Boolean]
102	def eligible_sponsor?	6✔
103	return true if developer	122✔
104	super	120✔
105	end
106
107	# Is this user eligible to be a data manger in this environment?
108	# @return [Boolean]
109	def eligible_manager?	6✔
110	return true if developer	47✔
111	super	45✔
112	end
113
114	def developer?	6✔
115	return true if developer	21✔
116	super	19✔
117	end
118
119	# Is this user eligible to be a data user in this environment?
120	# @return [Boolean]
121	def eligible_data_user?	6✔
122	return true if developer	51✔
123	return true if !eligible_sponsor? && !eligible_manager	51✔
124	end
125
126	# Is this user eligible to be a sysadmin in this environment?
127	# @return [Boolean]
128	def eligible_sysadmin?	6✔
129	(!Rails.env.production? && (developer \|\| sysadmin)) \|\| (Rails.env.production? && sysadmin)	544✔
130	end
131
132	def eligible_to_create_new?	6✔
133	return true if eligible_sysadmin?	12✔
134
135	!Rails.env.production? && (eligible_sponsor? && trainer?)	8✔
136	end
137
138	# Methods serialize_into_session() and serialize_from_session() are called by Warden/Devise
139	# to calculate what information will be stored in the session and to serialize an object
140	# back from the session.
141	#
142	# By default Warden/Devise store the database ID of the record (e.g. User.id) but this causes
143	# problems if we repopulate our User table and the IDs change. The implementation provided below
144	# uses the User.uid field (which is unique, does not change, and it's required) as the value to
145	# store in the session to prevent this issue.
146	#
147	# References:
148	# https://stackoverflow.com/questions/23597718/what-is-the-warden-data-in-a-rails-devise-session-composed-of/23683925#23683925
149	# https://web.archive.org/web/20211028103224/https://tadas-s.github.io/ruby-on-rails/2020/08/02/devise-serialize-into-session-trick/
150	# https://github.com/wardencommunity/warden/wiki/Setup
151	def self.serialize_into_session(record)	6✔
152	# The return value _must_ have at least two elements since the serialize_from_session() requires
153	# two arguments (see below)
154	[record.uid, ""]	572✔
155	end
156
157	def self.serialize_from_session(key, _salt, _opts = {})	6✔
158	User.where(uid: key)&.first	691✔
159	end
160
161	# Fetches the most recent download jobs for the user
162	def latest_downloads(limit: 10)	6✔
163	@latest_downloads \|\|= begin	138✔
164	downloads = UserRequest.where(user_id: id).where(["completion_time > ?", 7.days.ago]).order(created_at: "DESC").limit(limit)	136✔
165	downloads.map{\|download\| UserRequestPresenter.new(download)}	140✔
166	end
167	end
168
169	# Updates the user's roles (sys admin, developer) depending on the information on Mediaflux.
170	# This method is meant to be used only for the current logged in user since the roles depend on the Mediaflux session.
171	def self.update_user_roles(user:)	6✔
172	raise "User.update_user_roles called with for a user without a Mediaflux session" if user.mediaflux_session.nil?	2✔
173
174	mediaflux_roles = mediaflux_roles(user:)	2✔
175	update_developer_status(user:, mediaflux_roles:)	2✔
176	update_sysadmin_status(user:, mediaflux_roles:)	2✔
177	rescue => ex
178	Rails.logger.error("Error updating roles for user (id: #{user.id}) status, error: #{ex.message}")	×
179	end
180
181	# Returns the roles in Mediaflux for the user in the session.
182	# This method is meant to be used only for the current logged in user since the roles depend on the Mediaflux session.
183	def self.mediaflux_roles(user:)	6✔
184	raise "User.mediaflux_roles called with for a user without a Mediaflux session" if user.mediaflux_session.nil?	138✔
185
186	request = Mediaflux::ActorSelfDescribeRequest.new(session_token: user.mediaflux_session)	136✔
187	request.resolve	136✔
188	request.roles	136✔
189	end
190
191	private	6✔
192
193	def self.update_developer_status(user:, mediaflux_roles:)	6✔
194	# TODO: Figure out why the role name is different in staging from production:
195	# production: "pu-smb-group:PU:tigerdata:librarydevelopers"
196	# staging: "pu-oit-group:PU:tigerdata:librarydevelopers"
197	# development: "pu-lib:developer"
198	# test: "system-administrator"
199	developer_now = mediaflux_roles.include?("pu-smb-group:PU:tigerdata:librarydevelopers") \|\|	2✔
200	mediaflux_roles.include?("pu-oit-group:PU:tigerdata:librarydevelopers") \|\|
201	mediaflux_roles.include?("pu-lib:developer") \|\|
202	mediaflux_roles.include?("system-administrator")
203	if user.developer != developer_now	2✔
204	# Only update the record in the database if there is a change
205	Rails.logger.info("Updating developer role for user #{user.id} to #{developer_now}")	2✔
206	user.developer = developer_now	2✔
207	user.save!	2✔
208	end
209	end
210
211	def self.update_sysadmin_status(user:, mediaflux_roles:)	6✔
212	sysadmin_now = mediaflux_roles.include?("system-administrator")	2✔
213	if user.sysadmin != sysadmin_now	2✔
214	# Only update the record in the database if there is a change
215	Rails.logger.info("Updating sysadmin role for user #{user.id} to #{sysadmin_now}")	2✔
216	user.sysadmin = sysadmin_now	2✔
217	user.save!	2✔
218	end
219	end
220	end

pulibrary / tigerdata-app / 3f98f228-6ecf-4120-a478-d9932b13e420

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