Organize the submission provenance for a project (#2250)

ref #2187

Author: JaymeeH

app/assets/stylesheets/_project.scss

@@ -297,7 +297,18 @@ copy-project-path-label-normal {
   font-size: 1rem;
   font-style: normal;
   font-weight: 600;
-  line-height: 1.5rem;
+  margin-bottom: 1.5rem;
+  margin-right: 1.25rem;
+  line-height: 1.5rem; /* 150% */
+  width: 11.5rem;
+}
+.provenance-info {
+  font-weight: 200;
+}
+.provenance-value {
+  font-size: 1rem;
+  font-weight: 200;
+  line-height: 1.5rem; /* 150% */
 }
 
 .departments-group {
@@ -322,6 +333,12 @@ copy-project-path-label-normal {
   margin-left: 1em;
 }
 
+.lux-badge.lux-badge-grey {
+  background: #eee;
+  color: black;
+  margin: 0.15rem 0.25rem 0.25rem 0;
+}
+
 .data-users-section {
   /* frame-218 in Figma */
   display: inline-flex;

app/operations/project_create.rb

@@ -39,6 +39,12 @@ def persist_in_mediaflux(project, current_user)
         Failure debug_output
       else
         ProvenanceEvent.generate_approval_events(project: project, user: current_user, debug_output: mediaflux_request.debug_output.to_s)
+        # Save the submission provenance
+        # TODO:  Should we update the metadata_model or just the metadata hash directly?
+        project.metadata_model.submission["approved_by"] = current_user.uid
+        project.metadata_model.submission["approved_on"] = project.provenance_events.where(event_type: "Approved").first.created_at
+        project.save!
+
         Success(mediaflux_id)
       end
     # TODO:  What kind of error are we expecting here?  This will capture the session errors, but maybe we should not be doing this.

app/presenters/project_show_presenter.rb

@@ -111,6 +111,46 @@ def departments
     @project_mf[:departments] || []
   end
 
+  def submission_provenance
+    @project.metadata_json["submission"]
+  end
+
+  def requested_by
+    user_name_id = {}
+    uid = submission_provenance["requested_by"]
+    return "N/A" if uid.nil?
+
+    user = User.find_by(uid: uid)
+    user_name_id["#{user.given_name} #{user.family_name}"] = uid
+    user_name_id
+  end
+
+  def requested_on
+    date_time = {}
+    date = @project.metadata_json["submission"]["request_date_time"].to_datetime.strftime("%B %d, %Y")
+    time = @project.metadata_json["submission"]["request_date_time"].to_datetime.strftime("%I:%M %p")
+    date_time["#{date}"] = time
+    date_time
+  end
+
+  def approved_by
+    user_name_id = {}
+    uid = submission_provenance["approved_by"]
+    return "N/A" if uid.nil?
+
+    user = User.find_by(uid: uid)
+    user_name_id["#{user.given_name} #{user.family_name}"] = uid
+    user_name_id
+  end
+
+  def approved_on
+    date_time = {}
+    date = @project.metadata_json["submission"]["approved_on"].to_datetime.strftime("%B %d, %Y")
+    time = @project.metadata_json["submission"]["approved_on"].to_datetime.strftime("%I:%M %p")
+    date_time["#{date}"] = time
+    date_time
+  end
+
   def department_codes
     @dep_with_codes = {}
     departments_list = departments.nil? ? [] : departments.first.split(", ")

app/services/request_project_metadata.rb

@@ -17,8 +17,8 @@ def convert(request)
         project_directory: project_directory(request),
         storage_capacity: storage_capacity(request),
         storage_performance_expectations: { requested: "Standard", approved: "Standard" },
-        created_by: nil,
-        created_on: request[:created_at],
+        created_by: request[:requested_by],
+        created_on: request[:created_at], # This is redundant and counterintuitive. Insinuates that the project was created when the request was created.
         project_id: ProjectMetadata::DOI_NOT_MINTED,
         number_of_files: request[:number_of_files],
         hpc: request[:hpc]&.downcase == "yes",

app/views/projects/details.html.erb

@@ -66,6 +66,9 @@
                <% end %>
             </p>
          </div>
+         <svg xmlns="http://www.w3.org/2000/svg" width="1200" height="1" viewBox="0 0 1200 1" fill="none">
+            <path d="M6.36558e-08 0.5L1200 0.500105" stroke="#EEEEEE"/>
+         </svg>
       </ul>
       <ul class="details basic-details-fields">
          <div class="detail-heading">
@@ -92,6 +95,9 @@
                <% end %>
             </p>
          </div>
+         <svg xmlns="http://www.w3.org/2000/svg" width="1200" height="1" viewBox="0 0 1200 1" fill="none">
+            <path d="M6.36558e-08 0.5L1200 0.500105" stroke="#EEEEEE"/>
+         </svg>
       </ul>
       <ul class="details basic-details-fields">
          <div class="detail-heading">
@@ -135,38 +141,55 @@
             </div>
          </div>
          <ul class="sub-details basic-details-fields">
-         <% if @project.in_mediaflux? && (current_user.developer? || current_user.eligible_sysadmin?) %>
-         <div class="detail-pair">
-            <li class="detail-subheading">Mediaflux ID</li>
-            <p class="detail-value"><%= @project.mediaflux_id %></p>
-         </div>
-         <% elsif [email protected]_mediaflux? %>
-         <li class="detail-subheading">Mediaflux ID</li>
-         <p class="detail-value">This project has not been saved to Mediaflux</p>
+            <% if @project.in_mediaflux? && (current_user.developer? || current_user.eligible_sysadmin?) %>
+               <div class="detail-pair">
+                  <li class="detail-subheading mediaflux-id">Mediaflux ID</li>
+                  <p class="detail-value"><%= @project.mediaflux_id %></p>
+               </div>
+            <% elsif [email protected]_mediaflux? %>
+               <li class="detail-subheading mediaflux-id">Mediaflux ID</li>
+               <p class="detail-value">This project has not been saved to Mediaflux</p>
+            <% end %>
+
          </ul>
-   </div>
-   <% end %>
-   </ul>
-   <ul class="details basic-details-fields">
-      <div class="detail-heading">
-         <div class="heading-text" id="provenance-section">Provenance</div>
-      </div>
-      <ul class="sub-details basic-details-fields">
-         <div class="detail-sub-heading">
-            <div class="heading-text">Submission</div>
+         <svg xmlns="http://www.w3.org/2000/svg" width="1200" height="1" viewBox="0 0 1200 1" fill="none">
+            <path d="M6.36558e-08 0.5L1200 0.500105" stroke="#EEEEEE"/>
+         </svg>
+
+      <ul class="details basic-details-fields">
+         <div class="detail-heading">
+            <div class="heading-text" id="provenance-section">Provenance</div>
          </div>
-         <% @provenance_events.each do |event| %>
-         <li class="provenance">
-            <%= event.event_details %>, <%=event.created_at.to_time.in_time_zone("America/New_York").iso8601%>
-            <% if current_user.eligible_sysadmin? && event.event_type = ProvenanceEvent::DEBUG_OUTPUT_TYPE && event.event_note %>
-            <blockquote>
-               <%= event.event_note %>
-            </blockquote>
-            <% end %>
-            <% end %>
+         <ul class="sub-details basic-details-fields">
+            <div class="detail-sub-heading">Submission</div>
+            <div class="detail-pair">
+               <div class="detail-sub-heading provenance-info"> Requested by</div>
+               <div class="provenance-value"> <%=  @presenter.requested_by.keys.first %> </div>
+               <lux-badge class="lux-badge lux-badge-grey">
+                  <div class="badge-text"><%= @presenter.requested_by.values.first %></div>
+               </lux-badge>
+            </div>
+            <div class="detail-pair">
+               <div class="detail-sub-heading provenance-info"> Requested Date–Time </div>
+               <div class="provenance-value"> <%= @presenter.requested_on.keys.first %> <%= @presenter.requested_on.values.first %> </div>
+            </div>
+            <div class="detail-pair">
+               <div class="detail-sub-heading provenance-info">Approved by</div>
+               <div class="provenance-value"> <%=  @presenter.approved_by.keys.first %> </div>
+               <lux-badge class="lux-badge lux-badge-grey">
+                  <div class="badge-text"><%= @presenter.approved_by.values.first %></div>
+               </lux-badge>
+            </div>
+            <div class="detail-pair">
+               <div class="detail-sub-heading provenance-info"> Approval Date–Time</div>
+               <div class="provenance-value"> <%= @presenter.approved_on.keys.first %> <%= @presenter.approved_on.values.first %></div>
+            </div>
+         </ul>
+         <svg xmlns="http://www.w3.org/2000/svg" width="1200" height="1" viewBox="0 0 1200 1" fill="none">
+            <path d="M6.36558e-08 0.5L1200 0.500105" stroke="#EEEEEE"/>
+         </svg>
       </ul>
-   </ul>
-</div>
+   </div>
 </div>
 
 <script type="module">

spec/factories/request.rb

@@ -24,5 +24,6 @@
     departments { [{ name: "RDSS" }, { name: "RC" }] }
     description { "a random description" }
     project_folder { random_project_directory }
+    requested_by { "tigerdatatester" }
   end
 end

spec/models/project_show_presenter_spec.rb

@@ -95,4 +95,37 @@
       expect(presenter.department_codes.keys).to eq(project.metadata_model.departments)
     end
   end
+
+  describe "#submission_provenance" do
+    it "returns the hash containing the project submission and approval provenance" do
+      expect(presenter.submission_provenance).to be_a(Hash)
+      expect(presenter.submission_provenance).to eq(project.metadata_json["submission"])
+    end
+  end
+
+  describe "#requested_by" do
+    it "generates the string-serialized XML for the Project XML Document" do
+      expect(presenter.requested_by).to be_a(Hash)
+      expect(presenter.requested_by.values.first).to eq(project.metadata_json["submission"]["requested_by"])
+    end
+  end
+
+  describe "#requested_on" do
+    it "generates the string-serialized XML for the Project XML Document" do
+      expect(presenter.requested_on).to be_a(Hash)
+    end
+  end
+
+  describe "#approved_by" do
+    it "generates the string-serialized XML for the Project XML Document" do
+      expect(presenter.approved_by).to be_a(Hash)
+      expect(presenter.approved_by.values.first).to eq(project.metadata_json["submission"]["approved_by"])
+    end
+  end
+
+  describe "#approved_on" do
+    it "generates the string-serialized XML for the Project XML Document" do
+      expect(presenter.approved_on).to be_a(Hash)
+    end
+  end
 end

spec/presenters/dashboard_presenter_spec.rb

@@ -7,10 +7,10 @@
   let(:current_user) { FactoryBot.create(:sponsor_and_data_manager, uid: "tigerdatatester", mediaflux_session: SystemUser.mediaflux_session) }
   let(:other_user) { FactoryBot.create :user, uid: "kl37" }
 
-  let(:request1) { FactoryBot.create :request_project, data_manager: current_user.uid, data_sponsor: other_user.uid }
-  let(:request2) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: current_user.uid }
-  let(:request3) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: other_user.uid, user_roles: [{"uid" => current_user.uid, "read_only" => true}] }
-  let(:request4) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: other_user.uid }
+  let(:request1) { FactoryBot.create :request_project, data_manager: current_user.uid, data_sponsor: other_user.uid, requested_by: other_user.uid }
+  let(:request2) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: current_user.uid, requested_by: other_user.uid }
+  let(:request3) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: other_user.uid, user_roles: [{"uid" => current_user.uid, "read_only" => true}], requested_by: other_user.uid }
+  let(:request4) { FactoryBot.create :request_project, data_manager: other_user.uid, data_sponsor: other_user.uid, requested_by: other_user.uid }
 
   let!(:project1) { request1.approve(current_user) }
   let!(:project2) {

spec/system/project_details_spec.rb

@@ -150,11 +150,26 @@
       let(:request) { FactoryBot.create :request_project, project_title: "project 111", data_sponsor: sponsor_user.uid }
       let!(:project) { request.approve(sponsor_and_data_manager_user) }
       let(:submission_event) { FactoryBot.create(:submission_event, project: project) }
-      it "shows provenance events" do
+      let(:approval_event) { FactoryBot.create(:approval_event, project: project) }
+      it "shows submission events" do
         submission_event
         sign_in sponsor_user
         visit "/projects/#{project.id}/details"
-        expect(page).to have_content "#{submission_event.event_details}, #{submission_event.created_at.to_time.in_time_zone('America/New_York').iso8601}"
+        expect(page).to have_content("Requested by")
+        expect(page).to have_css(".provenance-value", count: 4)
+        expect(page).to have_content "Requested Date–Time"
+        expect(page).to have_content "#{submission_event.created_at.to_datetime.strftime("%B %d, %Y")}"
+        expect(page).to have_content "#{submission_event.created_at.to_datetime.strftime("%I:%M %p")}"
+      end
+      it "shows approval events" do
+        approval_event
+        sign_in sponsor_user
+        visit "/projects/#{project.id}/details"
+        expect(page).to have_content("Approved by")
+        expect(page).to have_css(".provenance-value", count: 4)
+        expect(page).to have_content "Approval Date–Time"
+        expect(page).to have_content "#{approval_event.created_at.to_datetime.strftime("%B %d, %Y")}"
+        expect(page).to have_content "#{approval_event.created_at.to_datetime.strftime("%I:%M %p")}"
       end
       it "shows the project status under the provenance section" do
         submission_event