• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

pulibrary / tigerdata-app / 5cde93f4-daa3-4f98-bc15-0daddc4f2a00

30 Jul 2025 06:39PM UTC coverage: 74.099% (-1.5%) from 75.625%
5cde93f4-daa3-4f98-bc15-0daddc4f2a00

Pull #1657

circleci

web-flow
Merge branch 'main' into i1632-save-data-users
Pull Request #1657: Add data users to a project after it is created in mediaflux

0 of 62 new or added lines in 3 files covered. (0.0%)

1 existing line in 1 file now uncovered.

2240 of 3023 relevant lines covered (74.1%)

309.56 hits per line

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

71.2
/app/models/project.rb
1
# frozen_string_literal: true
2
class Project < ApplicationRecord
1✔
3

4
  class ProjectCreateError < StandardError; end
1✔
5

6
  validates_with ProjectValidator
1✔
7
  has_many :provenance_events, dependent: :destroy
1✔
8
  before_save do |project|
1✔
9
    # Ensure that the metadata JSONB postgres field is persisted properly
10
    project.metadata = project.metadata_model
331✔
11
  end
12

13
  # Valid project status described in ADR 7
14
  # See `architecture-decisions/0007-valid-project-statuses.md`
15
  PENDING_STATUS = "pending"
1✔
16
  APPROVED_STATUS = "approved"
1✔
17
  ACTIVE_STATUS = "active"
1✔
18

19
  delegate :to_json, to: :metadata_json # field in the database
1✔
20

21
  def create!(initial_metadata:, user:)
1✔
22
    self.metadata_model = initial_metadata
4✔
23
    if self.valid?
4✔
24
      if initial_metadata.project_id == ProjectMetadata::DOI_NOT_MINTED
3✔
25
        self.draft_doi(user: user)
2✔
26
        self.save!
2✔
27
        ProvenanceEvent.generate_submission_events(project: self, user: user)
2✔
28
      else
29
        self.save!
1✔
30
      end
31
      # return doi
32
      self.metadata_model.project_id
3✔
33
    else
34
      nil
35
    end
36
  end
37

38
  def approve!(current_user:)
1✔
39
    request = Mediaflux::ProjectCreateServiceRequest.new(session_token: current_user.mediaflux_session, project: self)
1✔
40
    request.resolve
1✔
41

42
    if request.mediaflux_id.to_i == 0
1✔
43
      raise ProjectCreateError.new("Error saving project #{self.id} to Mediaflux: #{request.response_error}. Debug output: #{request.debug_output}")
1✔
44
    end
45

46
    self.mediaflux_id = request.mediaflux_id
×
47
    self.metadata_model.status = Project::APPROVED_STATUS
×
48
    self.save!
×
49

NEW
50
    debug_output = if request.mediaflux_id == 0
×
NEW
51
                     "Error saving project #{self.id} to Mediaflux: #{request.response_error}. Debug output: #{request.debug_output}"
×
52
                   else
NEW
53
                     "#{request.debug_output}"
×
54
                   end
NEW
55
    Rails.logger.error debug_output
×
56

NEW
57
    add_users_request = Mediaflux::ProjectUserAddRequest.new(session_token: current_user.mediaflux_session, project: self)
×
NEW
58
    add_users_request.resolve
×
59

NEW
60
    user_debug = "#{add_users_request.debug_output}"
×
NEW
61
    Rails.logger.error "Project #{self.id} users have been added to MediaFlux: #{user_debug}"
×
62

63
    # create provenance events:
64
    # - one for approving the project and
65
    # - another for changing the status of the project
66
    # - another with debug information from the create project service
67
    ProvenanceEvent.generate_approval_events(project: self, user: current_user, debug_output: debug_output)
×
68
  end
69

70
  def reload
1✔
71
    super
7✔
72
    @metadata_model = ProjectMetadata.new_from_hash(self.metadata)
7✔
73
    self
7✔
74
  end
75

76
  def activate!(collection_id:, current_user:)
1✔
77
    response = Mediaflux::AssetMetadataRequest.new(session_token: current_user.mediaflux_session, id: collection_id)
×
78
    mediaflux_metadata = response.metadata # get the metadata of the collection from mediaflux
×
79

80
    return unless mediaflux_metadata[:collection] == true # If the collection id exists
×
81

82
    # check if the project doi in rails matches the project doi in mediaflux
83
    return unless mediaflux_metadata[:project_id] == self.metadata_model.project_id
×
84

85
    # activate a project by setting the status to 'active'
86
    self.metadata_model.status = Project::ACTIVE_STATUS
×
87

88
    # also read in the actual project directory
89
    self.metadata_model.project_directory = mediaflux_metadata[:project_directory]
×
90
    self.save!
×
91

92
    ProvenanceEvent.generate_active_events(project: self, user: current_user)
×
93
  end
94

95
  def draft_doi(user: nil)
1✔
96
    puldatacite = PULDatacite.new
3✔
97
    self.metadata_model.project_id = puldatacite.draft_doi
3✔
98
  end
99

100
  # Ideally this method should return a ProjectMetadata object (like `metadata_model` does)
101
  # but we'll keep them both while we are refactoring the code so that we don't break
102
  # everything at once since `metadata` is used everywhere.
103
  def metadata
1✔
104
    @metadata_hash = (metadata_json || {}).with_indifferent_access
430✔
105
  end
106

107
  def metadata_model
1✔
108
    @metadata_model ||= ProjectMetadata.new_from_hash(self.metadata)
3,855✔
109
  end
110

111
  def metadata_model=(new_metadata_model)
1✔
112
    @metadata_model = new_metadata_model
311✔
113
  end
114

115
  def metadata=(metadata_model)
1✔
116
    # Convert our metadata to a hash so it can be saved on our JSONB field
117
    metadata_hash = JSON.parse(metadata_model.to_json)
706✔
118
    self.metadata_json = metadata_hash
706✔
119
  end
120

121
  def title
1✔
122
    self.metadata_model.title
263✔
123
  end
124

125
  def departments
1✔
126
    unsorted = metadata_model.departments || []
77✔
127
    unsorted.sort
77✔
128
  end
129

130
  def project_directory
1✔
131
    metadata_model.project_directory || ""
173✔
132
  end
133

134
  def project_directory_parent_path
1✔
135
    # The tigerdata.project.create expectes every project to be under "tigerdata"
136
    Mediaflux::Connection.root
11✔
137
  end
138

139
  def project_directory_short
1✔
140
    project_directory
15✔
141
  end
142

143
  def status
1✔
144
    metadata_model.status
555✔
145
  end
146

147
  def pending?
1✔
148
    status == PENDING_STATUS
269✔
149
  end
150

151
  def in_mediaflux?
1✔
152
    mediaflux_id.present?
61✔
153
  end
154

155
  def self.users_projects(user)
1✔
156
    # See https://scalegrid.io/blog/using-jsonb-in-postgresql-how-to-effectively-store-index-json-data-in-postgresql/
157
    # for information on the @> operator
158
    uid = user.uid
61✔
159
    query_ro = '{"data_user_read_only":["' + uid + '"]}'
61✔
160
    query_rw = '{"data_user_read_write":["' + uid + '"]}'
61✔
161
    query = "(metadata_json @> ? :: jsonb) OR (metadata_json @> ? :: jsonb)"
61✔
162
    args = [query_ro, query_rw]
61✔
163
    if user.eligible_sponsor?
61✔
164
      query += "OR (metadata_json->>'data_sponsor' = ?)"
16✔
165
      args << uid
16✔
166
    end
167
    if user.eligible_manager?
61✔
168
      query += "OR (metadata_json->>'data_manager' = ?)"
12✔
169
      args << uid
12✔
170
    end
171
    Project.where( query, *args)
61✔
172
  end
173

174
  def self.sponsored_projects(sponsor)
1✔
175
    Project.where("metadata_json->>'data_sponsor' = ?", sponsor)
1✔
176
  end
177

178
  def self.managed_projects(manager)
1✔
179
    Project.where("metadata_json->>'data_manager' = ?", manager)
1✔
180
  end
181

182
  def self.pending_projects
1✔
183
    Project.where("mediaflux_id IS NULL")
57✔
184
  end
185

186
  def self.approved_projects
1✔
187
    Project.where("mediaflux_id IS NOT NULL")
57✔
188
  end
189

190
  def self.data_user_projects(user)
1✔
191
    # See https://scalegrid.io/blog/using-jsonb-in-postgresql-how-to-effectively-store-index-json-data-in-postgresql/
192
    # for information on the @> operator
193
    query_ro = '{"data_user_read_only":["' + user + '"]}'
1✔
194
    query_rw = '{"data_user_read_write":["' + user + '"]}'
1✔
195
    Project.where("(metadata_json @> ? :: jsonb) OR (metadata_json @> ? :: jsonb)", query_ro, query_rw)
1✔
196
  end
197

198
  def user_has_access?(user:)
1✔
199
    return true if user.eligible_sysadmin?
46✔
200
    metadata_model.data_sponsor == user.uid || metadata_model.data_manager == user.uid ||
36✔
201
    metadata_model.data_user_read_only.include?(user.uid) || metadata_model.data_user_read_write.include?(user.uid)
202
  end
203

204
  def save_in_mediaflux(user:)
1✔
205
    ProjectMediaflux.save(project: self, user: user)
×
206
  end
207

208
  def created_by_user
1✔
209
    User.find_by(uid: metadata_model.created_by)
12✔
210
  end
211

212
  def to_xml
1✔
213
    ProjectShowPresenter.new(self).to_xml
4✔
214
  end
215

216
  # @return [String] XML representation of the <meta> element
217
  def mediaflux_meta_xml(user:)
1✔
218
    doc = ProjectMediaflux.document(project: self, user: user)
1✔
219
    doc.xpath("/response/reply/result/asset/meta").to_s
1✔
220
  end
221

222
  def mediaflux_metadata(session_id:)
1✔
223
    @mediaflux_metadata ||= begin
109✔
224
      accum_req = Mediaflux::AssetMetadataRequest.new(session_token: session_id, id: mediaflux_id)
29✔
225
      accum_req.metadata
29✔
226
    end
227
    @mediaflux_metadata
109✔
228
  end
229

230
  def asset_count(session_id:)
1✔
231
    values = mediaflux_metadata(session_id:)
11✔
232
    values.fetch(:total_file_count, 0)
11✔
233
  end
234

235
  def self.default_storage_unit
1✔
236
    "KB"
26✔
237
  end
238

239
  def self.default_storage_usage
1✔
240
    "0 #{default_storage_unit}"
25✔
241
  end
242

243
  def storage_usage(session_id:)
1✔
244
    values = mediaflux_metadata(session_id:)
24✔
245
    values.fetch(:quota_used, self.class.default_storage_usage) # if the storage is empty use the default
24✔
246
  end
247

248
  def storage_usage_raw(session_id:)
1✔
249
    values = mediaflux_metadata(session_id:)
×
250
    values.fetch(:quota_used_raw, 0) # if the storage raw is empty use zero
×
251
  end
252

253
  def self.default_storage_capacity
1✔
254
    "0 GB"
24✔
255
  end
256

257
  def storage_capacity(session_id:)
1✔
258
    values = mediaflux_metadata(session_id:)
24✔
259
    quota_value = values.fetch(:quota_allocation, '') #if quota does not exist, set value to an empty string
24✔
260
    if quota_value.blank?
24✔
261
      return self.class.default_storage_capacity
24✔
262
    else
263
      return quota_value
×
264
    end
265
  end
266

267
  def storage_capacity_raw(session_id:)
1✔
268
    values = mediaflux_metadata(session_id:)
48✔
269
    quota_value = values.fetch(:quota_allocation_raw, 0) #if quota does not exist, set value to 0
48✔
270
    quota_value
48✔
271
  end
272

273
  # Fetches the first n files
274
  def file_list(session_id:, size: 10)
1✔
275
    return { files: [] } if mediaflux_id.nil?
11✔
276

277
    query_req = Mediaflux::QueryRequest.new(session_token: session_id, collection: mediaflux_id, deep_search: true, aql_query: "type!='application/arc-asset-collection'")
4✔
278
    iterator_id = query_req.result
4✔
279

280
    iterator_req = Mediaflux::IteratorRequest.new(session_token: session_id, iterator: iterator_id, size: size)
4✔
281
    results = iterator_req.result
4✔
282

283
    # Destroy _after_ fetching the first set of results from iterator_req.
284
    # This call is required since it possible that we have read less assets than
285
    # what the collection has but we are done with the iterator.
286
    Mediaflux::IteratorDestroyRequest.new(session_token: session_id, iterator: iterator_id).resolve
4✔
287

288
    results
4✔
289
  end
290

291
  # Fetches the entire file list to a file
292
  def file_list_to_file(session_id:, filename:)
1✔
293
    return { files: [] } if mediaflux_id.nil?
1✔
294

295
    query_req = Mediaflux::QueryRequest.new(session_token: session_id, collection: mediaflux_id, deep_search: true,  aql_query: "type!='application/arc-asset-collection'")
×
296
    iterator_id = query_req.result
×
297

298
    start_time = Time.zone.now
×
299
    prefix = "file_list_to_file #{session_id[0..7]} #{self.metadata_model.project_id}"
×
300
    log_elapsed(start_time, prefix, "STARTED")
×
301

302
    File.open(filename, "w") do |file|
×
303
      page_number = 0
×
304
      # file header
305
      file.write("ID, PATH, NAME, COLLECTION?, LAST_MODIFIED, SIZE\r\n")
×
306
      loop do
×
307
        iterator_start_time = Time.zone.now
×
308
        page_number += 1
×
309
        iterator_req = Mediaflux::IteratorRequest.new(session_token: session_id, iterator: iterator_id, size: 1000)
×
310
        iterator_resp = iterator_req.result
×
311
        log_elapsed(iterator_start_time, prefix, "FETCHED page #{page_number} from iterator")
×
312
        lines = files_from_iterator(iterator_resp)
×
313
        file.write(lines.join("\r\n") + "\r\n")
×
314
        break if iterator_resp[:complete] || iterator_req.error?
×
315
      end
316
      log_elapsed(start_time, prefix, "ENDED")
×
317
    end
318

319
    # Destroy _after_ fetching the results from iterator_req
320
    # This call is technically not necessary since Mediaflux automatically deletes the iterator
321
    # once we have ran through it and by now we have. But it does not hurt either.
322
    Mediaflux::IteratorDestroyRequest.new(session_token: session_id, iterator: iterator_id).resolve
×
323
  end
324

325

326
  private
1✔
327

328
    def files_from_iterator(iterator_resp)
1✔
329
      lines = []
×
330
      iterator_resp[:files].each do |asset|
×
331
        lines << "#{asset.id}, #{asset.path_only}, #{asset.name}, #{asset.collection}, #{asset.last_modified}, #{asset.size}"
×
332
      end
333
      lines
×
334
    end
335

336
    def project_directory_pathname
1✔
337
      # allow the directory to be modified by changes in the metadata_json
338
      @project_directory_pathname = nil if @original_directory.present? && @original_directory != metadata_model.project_directory
×
339

340
      @project_directory_pathname ||= begin
×
341
        @original_directory = metadata_model.project_directory
×
342
        Pathname.new(@original_directory)
×
343
      end
344
    end
345

346
    # Ensure that the project directory is a valid path
347
    def safe_directory(directory)
1✔
348
      Project.safe_directory(directory)
×
349
    end
350

351
    def log_elapsed(start_time, prefix, message)
1✔
352
      elapsed_time = Time.zone.now - start_time
×
353
      timing_info = "#{format('%.2f', elapsed_time)} s"
×
354
      Rails.logger.info "#{prefix}: #{message}, #{timing_info}"
×
355
    end
356
end
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc