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

pulibrary / tigerdata-app / 88c82417-71e1-4f84-8337-7bf4bd1a5618

29 Jul 2025 08:15PM UTC coverage: 75.423% (-5.2%) from 80.666%
88c82417-71e1-4f84-8337-7bf4bd1a5618

Pull #1656

circleci

hectorcorrea
Marked a bunch of tests as integration since they create projects in Mediaflux
Pull Request #1656: Added error handling to the request to project workflow

12 of 17 new or added lines in 4 files covered. (70.59%)

157 existing lines in 19 files now uncovered.

2274 of 3015 relevant lines covered (75.42%)

344.11 hits per line

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

73.91
/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
357✔
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
16✔
23
    if self.valid?
16✔
24
      if initial_metadata.project_id == ProjectMetadata::DOI_NOT_MINTED
14✔
25
        self.draft_doi(user: user)
13✔
26
        self.save!
13✔
27
        ProvenanceEvent.generate_submission_events(project: self, user: user)
13✔
28
      else
29
        self.save!
1✔
30
      end
31
      # return doi
32
      self.metadata_model.project_id
14✔
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

UNCOV
46
    self.mediaflux_id = request.mediaflux_id
×
NEW
47
    self.metadata_model.status = Project::APPROVED_STATUS
×
UNCOV
48
    self.save!
×
NEW
49
    debug_output = request.debug_output
×
50
    # create provenance events:
51
    # - one for approving the project and
52
    # - another for changing the status of the project
53
    # - another with debug information from the create project service
UNCOV
54
    ProvenanceEvent.generate_approval_events(project: self, user: current_user, debug_output: debug_output)
×
55
  end
56

57
  def reload
1✔
58
    super
7✔
59
    @metadata_model = ProjectMetadata.new_from_hash(self.metadata)
7✔
60
    self
7✔
61
  end
62

63
  def activate!(collection_id:, current_user:)
1✔
64
    response = Mediaflux::AssetMetadataRequest.new(session_token: current_user.mediaflux_session, id: collection_id)
×
65
    mediaflux_metadata = response.metadata # get the metadata of the collection from mediaflux
×
66

67
    return unless mediaflux_metadata[:collection] == true # If the collection id exists
×
68

69
    # check if the project doi in rails matches the project doi in mediaflux
70
    return unless mediaflux_metadata[:project_id] == self.metadata_model.project_id
×
71

72
    # activate a project by setting the status to 'active'
73
    self.metadata_model.status = Project::ACTIVE_STATUS
×
74

75
    # also read in the actual project directory
76
    self.metadata_model.project_directory = mediaflux_metadata[:project_directory]
×
77
    self.save!
×
78

79
    ProvenanceEvent.generate_active_events(project: self, user: current_user)
×
80
  end
81

82
  def draft_doi(user: nil)
1✔
83
    puldatacite = PULDatacite.new
14✔
84
    self.metadata_model.project_id = puldatacite.draft_doi
14✔
85
  end
86

87
  # Ideally this method should return a ProjectMetadata object (like `metadata_model` does)
88
  # but we'll keep them both while we are refactoring the code so that we don't break
89
  # everything at once since `metadata` is used everywhere.
90
  def metadata
1✔
91
    @metadata_hash = (metadata_json || {}).with_indifferent_access
520✔
92
  end
93

94
  def metadata_model
1✔
95
    @metadata_model ||= ProjectMetadata.new_from_hash(self.metadata)
4,573✔
96
  end
97

98
  def metadata_model=(new_metadata_model)
1✔
99
    @metadata_model = new_metadata_model
334✔
100
  end
101

102
  def metadata=(metadata_model)
1✔
103
    # Convert our metadata to a hash so it can be saved on our JSONB field
104
    metadata_hash = JSON.parse(metadata_model.to_json)
770✔
105
    self.metadata_json = metadata_hash
770✔
106
  end
107

108
  def title
1✔
109
    self.metadata_model.title
314✔
110
  end
111

112
  def departments
1✔
113
    unsorted = metadata_model.departments || []
161✔
114
    unsorted.sort
161✔
115
  end
116

117
  def project_directory
1✔
118
    metadata_model.project_directory || ""
198✔
119
  end
120

121
  def project_directory_parent_path
1✔
122
    # The tigerdata.project.create expectes every project to be under "tigerdata"
123
    Mediaflux::Connection.root
27✔
124
  end
125

126
  def project_directory_short
1✔
127
    project_directory
31✔
128
  end
129

130
  def status
1✔
131
    metadata_model.status
692✔
132
  end
133

134
  def pending?
1✔
135
    status == PENDING_STATUS
346✔
136
  end
137

138
  def in_mediaflux?
1✔
139
    mediaflux_id.present?
104✔
140
  end
141

142
  def self.users_projects(user)
1✔
143
    # See https://scalegrid.io/blog/using-jsonb-in-postgresql-how-to-effectively-store-index-json-data-in-postgresql/
144
    # for information on the @> operator
145
    uid = user.uid
97✔
146
    query_ro = '{"data_user_read_only":["' + uid + '"]}'
97✔
147
    query_rw = '{"data_user_read_write":["' + uid + '"]}'
97✔
148
    query = "(metadata_json @> ? :: jsonb) OR (metadata_json @> ? :: jsonb)"
97✔
149
    args = [query_ro, query_rw]
97✔
150
    if user.eligible_sponsor?
97✔
151
      query += "OR (metadata_json->>'data_sponsor' = ?)"
39✔
152
      args << uid
39✔
153
    end
154
    if user.eligible_manager?
97✔
155
      query += "OR (metadata_json->>'data_manager' = ?)"
19✔
156
      args << uid
19✔
157
    end
158
    Project.where( query, *args)
97✔
159
  end
160

161
  def self.sponsored_projects(sponsor)
1✔
162
    Project.where("metadata_json->>'data_sponsor' = ?", sponsor)
1✔
163
  end
164

165
  def self.managed_projects(manager)
1✔
166
    Project.where("metadata_json->>'data_manager' = ?", manager)
1✔
167
  end
168

169
  def self.pending_projects
1✔
170
    Project.where("mediaflux_id IS NULL")
93✔
171
  end
172

173
  def self.approved_projects
1✔
174
    Project.where("mediaflux_id IS NOT NULL")
93✔
175
  end
176

177
  def self.data_user_projects(user)
1✔
178
    # See https://scalegrid.io/blog/using-jsonb-in-postgresql-how-to-effectively-store-index-json-data-in-postgresql/
179
    # for information on the @> operator
180
    query_ro = '{"data_user_read_only":["' + user + '"]}'
1✔
181
    query_rw = '{"data_user_read_write":["' + user + '"]}'
1✔
182
    Project.where("(metadata_json @> ? :: jsonb) OR (metadata_json @> ? :: jsonb)", query_ro, query_rw)
1✔
183
  end
184

185
  def user_has_access?(user:)
1✔
186
    return true if user.eligible_sysadmin?
59✔
187
    metadata_model.data_sponsor == user.uid || metadata_model.data_manager == user.uid ||
49✔
188
    metadata_model.data_user_read_only.include?(user.uid) || metadata_model.data_user_read_write.include?(user.uid)
189
  end
190

191
  def save_in_mediaflux(user:)
1✔
UNCOV
192
    ProjectMediaflux.save(project: self, user: user)
×
193
  end
194

195
  def created_by_user
1✔
196
    User.find_by(uid: metadata_model.created_by)
12✔
197
  end
198

199
  def to_xml
1✔
200
    ProjectShowPresenter.new(self).to_xml
4✔
201
  end
202

203
  # @return [String] XML representation of the <meta> element
204
  def mediaflux_meta_xml(user:)
1✔
205
    doc = ProjectMediaflux.document(project: self, user: user)
1✔
206
    doc.xpath("/response/reply/result/asset/meta").to_s
1✔
207
  end
208

209
  def mediaflux_metadata(session_id:)
1✔
210
    @mediaflux_metadata ||= begin
134✔
211
      accum_req = Mediaflux::AssetMetadataRequest.new(session_token: session_id, id: mediaflux_id)
42✔
212
      accum_req.metadata
42✔
213
    end
214
    @mediaflux_metadata
134✔
215
  end
216

217
  def asset_count(session_id:)
1✔
218
    values = mediaflux_metadata(session_id:)
15✔
219
    values.fetch(:total_file_count, 0)
15✔
220
  end
221

222
  def self.default_storage_unit
1✔
223
    "KB"
30✔
224
  end
225

226
  def self.default_storage_usage
1✔
227
    "0 #{default_storage_unit}"
29✔
228
  end
229

230
  def storage_usage(session_id:)
1✔
231
    values = mediaflux_metadata(session_id:)
28✔
232
    values.fetch(:quota_used, self.class.default_storage_usage) # if the storage is empty use the default
28✔
233
  end
234

235
  def storage_usage_raw(session_id:)
1✔
236
    values = mediaflux_metadata(session_id:)
×
237
    values.fetch(:quota_used_raw, 0) # if the storage raw is empty use zero
×
238
  end
239

240
  def self.default_storage_capacity
1✔
241
    "0 GB"
28✔
242
  end
243

244
  def storage_capacity(session_id:)
1✔
245
    values = mediaflux_metadata(session_id:)
28✔
246
    quota_value = values.fetch(:quota_allocation, '') #if quota does not exist, set value to an empty string
28✔
247
    if quota_value.blank?
28✔
248
      return self.class.default_storage_capacity
28✔
249
    else
250
      return quota_value
×
251
    end
252
  end
253

254
  def storage_capacity_raw(session_id:)
1✔
255
    values = mediaflux_metadata(session_id:)
61✔
256
    quota_value = values.fetch(:quota_allocation_raw, 0) #if quota does not exist, set value to 0
61✔
257
    quota_value
61✔
258
  end
259

260
  # Fetches the first n files
261
  def file_list(session_id:, size: 10)
1✔
262
    return { files: [] } if mediaflux_id.nil?
15✔
263

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

267
    iterator_req = Mediaflux::IteratorRequest.new(session_token: session_id, iterator: iterator_id, size: size)
4✔
268
    results = iterator_req.result
4✔
269

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

275
    results
4✔
276
  end
277

278
  # Fetches the entire file list to a file
279
  def file_list_to_file(session_id:, filename:)
1✔
280
    return { files: [] } if mediaflux_id.nil?
1✔
281

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

UNCOV
285
    start_time = Time.zone.now
×
UNCOV
286
    prefix = "file_list_to_file #{session_id[0..7]} #{self.metadata_model.project_id}"
×
UNCOV
287
    log_elapsed(start_time, prefix, "STARTED")
×
288

UNCOV
289
    File.open(filename, "w") do |file|
×
UNCOV
290
      page_number = 0
×
291
      # file header
UNCOV
292
      file.write("ID, PATH, NAME, COLLECTION?, LAST_MODIFIED, SIZE\r\n")
×
UNCOV
293
      loop do
×
UNCOV
294
        iterator_start_time = Time.zone.now
×
UNCOV
295
        page_number += 1
×
UNCOV
296
        iterator_req = Mediaflux::IteratorRequest.new(session_token: session_id, iterator: iterator_id, size: 1000)
×
UNCOV
297
        iterator_resp = iterator_req.result
×
UNCOV
298
        log_elapsed(iterator_start_time, prefix, "FETCHED page #{page_number} from iterator")
×
UNCOV
299
        lines = files_from_iterator(iterator_resp)
×
UNCOV
300
        file.write(lines.join("\r\n") + "\r\n")
×
UNCOV
301
        break if iterator_resp[:complete] || iterator_req.error?
×
302
      end
UNCOV
303
      log_elapsed(start_time, prefix, "ENDED")
×
304
    end
305

306
    # Destroy _after_ fetching the results from iterator_req
307
    # This call is technically not necessary since Mediaflux automatically deletes the iterator
308
    # once we have ran through it and by now we have. But it does not hurt either.
UNCOV
309
    Mediaflux::IteratorDestroyRequest.new(session_token: session_id, iterator: iterator_id).resolve
×
310
  end
311

312

313
  private
1✔
314

315
    def files_from_iterator(iterator_resp)
1✔
UNCOV
316
      lines = []
×
UNCOV
317
      iterator_resp[:files].each do |asset|
×
318
        lines << "#{asset.id}, #{asset.path_only}, #{asset.name}, #{asset.collection}, #{asset.last_modified}, #{asset.size}"
×
319
      end
UNCOV
320
      lines
×
321
    end
322

323
    def project_directory_pathname
1✔
324
      # allow the directory to be modified by changes in the metadata_json
325
      @project_directory_pathname = nil if @original_directory.present? && @original_directory != metadata_model.project_directory
×
326

327
      @project_directory_pathname ||= begin
×
328
        @original_directory = metadata_model.project_directory
×
329
        Pathname.new(@original_directory)
×
330
      end
331
    end
332

333
    # Ensure that the project directory is a valid path
334
    def safe_directory(directory)
1✔
335
      Project.safe_directory(directory)
×
336
    end
337

338
    def log_elapsed(start_time, prefix, message)
1✔
UNCOV
339
      elapsed_time = Time.zone.now - start_time
×
UNCOV
340
      timing_info = "#{format('%.2f', elapsed_time)} s"
×
UNCOV
341
      Rails.logger.info "#{prefix}: #{message}, #{timing_info}"
×
342
    end
343
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