MMT-2313: Make crude lossiness report available in web browser from MMT

.gitignore

@@ -57,3 +57,7 @@ nohup.out
 
 #backup files
 *~
+
+#ignore package
+package-lock.json
+package.json

Gemfile

@@ -73,12 +73,14 @@ gem 'aasm'
 
 gem 'browser'
 
+gem 'nokogiri-diff', '~> 0.2.0' # for comparing xml documents
+
 # collections metadata preview
 # run this command to work from a local copy of the gem's repo
 # bundle config local.cmr_metadata_preview /path/to/local/git/repository
 # make sure to delete the local config when done making changes to merge into master
 # bundle config --delete local.cmr_metadata_preview
-gem 'cmr_metadata_preview', git: 'https://git.earthdata.nasa.gov/scm/cmr/cmr_metadata_preview.git', ref: 'fff65949cc6'
+gem 'cmr_metadata_preview', git: 'https://git.earthdata.nasa.gov/scm/cmr/cmr_metadata_preview.git', ref: '1f6ffd54d65'
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console

Gemfile.lock

@@ -1,9 +1,9 @@
 GIT
   remote: https://git.earthdata.nasa.gov/scm/cmr/cmr_metadata_preview.git
-  revision: fff65949cc62d397b0675e9fe46e962b8cf43228
-  ref: fff65949cc6
+  revision: 1f6ffd54d6570f9f920078a84fd51750db3c21ab
+  ref: 1f6ffd54d65
   specs:
-    cmr_metadata_preview (0.2.2)
+    cmr_metadata_preview (0.2.3)
       georuby
       rails (~> 5.2.0)
       sprockets (< 4.0)
@@ -195,6 +195,9 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
+    nokogiri-diff (0.2.0)
+      nokogiri (~> 1.5)
+      tdiff (~> 0.3, >= 0.3.2)
     parallel (1.19.1)
     parser (2.7.1.2)
       ast (~> 2.4.0)
@@ -297,6 +300,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
+    tdiff (0.3.4)
     thor (1.0.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
@@ -365,6 +369,7 @@ DEPENDENCIES
   mini_racer
   momentjs-rails
   multi_xml
+  nokogiri-diff (~> 0.2.0)
   pg
   pundit
   rack_session_access

app/assets/javascripts/change_current_provider.coffee

@@ -74,6 +74,16 @@ $(document).ready ->
         "Managing this service's collection associations"
       when 'edit-tool'
         'Editing this tool'
+      when 'clone-tool'
+        'Cloning this tool'
+      when 'delete-tool'
+        'Deleting this tool'
+      when 'reinstate-tool'
+        action = 'revert'
+        'Reinstating this tool'
+      when 'revert-tool'
+        action = 'revert'
+        'Reverting this tool'
 
     $link.data('type', action)
     $modal.find('span.provider').text(provider)

app/concerns/cmr_collections_helper.rb

@@ -6,7 +6,7 @@ def get_revisions(concept_id, revision_id)
     # try again because CMR might be a little slow to index if it is a newly published revision
     attempts = 0
     while attempts < 20
-      revisions_response = cmr_client.get_collections({ concept_id: concept_id, all_revisions: true, include_granule_counts: true }, token)
+      revisions_response = cmr_client.get_collections({ concept_id: concept_id, all_revisions: true, include_granule_counts: true, sort_key: '-revision_date' }, token)
       revisions = if revisions_response.success?
                     revisions_response.body.fetch('items', [])
                   else

app/controllers/collections_controller.rb

@@ -2,6 +2,7 @@ class CollectionsController < ManageCollectionsController
   include ManageMetadataHelper
   include CMRCollectionsHelper
   include CollectionsHelper
+  include LossReportHelper
 
   before_action :set_collection
   before_action :ensure_correct_collection_provider, only: [:edit, :clone, :revert, :destroy]
@@ -115,6 +116,35 @@ def create_update_proposal
     redirect_to collection_draft_proposal_path(proposal)
   end
 
+  def loss_report
+    # When a user wants to use MMT to edit metadata that currently exists in a non-UMM form,
+    # it's important that they're able to see if any data loss occurs in the translation to umm.
+    # This method is needed to reference the appropriate helper and view for the lossiness report.
+    # If translated_collections contains an :error field, the error message will appear. 
+
+    # this checks the 'hide_items' url parameter that is can be manually added. Its primary use is for developers
+    # that need to debug using the text_output
+    if params[:hide_items].nil? || params[:hide_items].downcase == 'true'
+      hide_items = true
+    elsif params[:hide_items].downcase == 'false'
+      hide_items = false
+    else
+      translated_collections = { error: 'Unknown value for the hide_items parameter. The format should be: ".../loss_report.text?hide_items=true" or ".../loss_report.text?hide_items=false"' }
+    end
+
+    translated_collections ||= prepare_translated_collections
+
+    respond_to do |format|
+      if translated_collections[:error]
+        format.text { render plain: translated_collections[:error] }
+        format.json { render json: JSON.pretty_generate(translated_collections) }
+      else
+        format.text { render plain: loss_report_output(translated_collections: translated_collections, hide_items: hide_items, display: 'text') }
+        format.json { render json: JSON.pretty_generate(loss_report_output(translated_collections: translated_collections, hide_items: hide_items, display: 'json')) }
+      end
+    end
+  end
+
   private
 
   def ensure_correct_collection_provider
@@ -127,6 +157,25 @@ def ensure_correct_collection_provider
     render :show
   end
 
+  def prepare_translated_collections
+    original_collection_native_xml = cmr_client.get_concept(params[:id],token, {})
+    return { error: 'Failed to retrieve collection from CMR' } unless original_collection_native_xml.success?
+
+    content_type = original_collection_native_xml.headers.fetch('content-type').split(';')[0]
+    return { error: 'This collection is already in UMM format so there is no loss report' } if content_type.include?('application/vnd.nasa.cmr.umm+json')
+
+    translated_collection_native_xml = cmr_client.translate_collection(JSON.pretty_generate(@collection), "application/#{Rails.configuration.umm_c_version}; charset=utf-8", content_type,  skip_validation=true)
+    return { error: 'Failed to translate collection from UMM back to native format' } unless translated_collection_native_xml.success?
+
+    return {
+      original_collection_native_xml: original_collection_native_xml.body,
+      translated_collection_native_xml: translated_collection_native_xml.body,
+      original_collection_native_hash: Hash.from_xml(original_collection_native_xml.body),
+      translated_collection_native_hash: Hash.from_xml(translated_collection_native_xml.body),
+      native_format: content_type
+    }
+  end
+
   def set_collection
     @concept_id = params[:id]
     @revision_id = params[:revision_id]
@@ -149,7 +198,7 @@ def set_collection
         @download_xml_options.each do |download_option|
           # gsub here is needed because of the iso-smap and application/iso:smap+xml format options
           if native_format.gsub(':','').include?(download_option[:format].gsub('-', ''))
-            download_option[:title].concat(' (Native)') 
+            download_option[:title].concat(' (Native)')
             @download_xml_options.delete(download_option)
             @download_xml_options.unshift(download_option)
             break
@@ -201,7 +250,7 @@ def proposal_mode_enabled?
       super
     end
   end
-  
+
   def select_revision
     selected = @revisions.select {|r| r.fetch('meta')['revision-id'] && r.fetch('meta')['deleted'] == false &&  r.fetch('meta')['revision-id'].to_i < @revision_id.to_i}.first
     selected.blank? ?  nil : selected.fetch('meta')['revision-id']

app/controllers/manage_metadata_controller.rb

@@ -110,7 +110,7 @@ def set_variable_information
     # if the variable is not found, try again because CMR might be a little slow to index if it is a newly published record
     attempts = 0
     while attempts < 20
-      variables_search_response = cmr_client.get_variables(concept_id: @concept_id, all_revisions: true)
+      variables_search_response = cmr_client.get_variables(concept_id: @concept_id, all_revisions: true, sort_key: '-revision_date')
 
       variable_data = if variables_search_response.success?
                         variables_search_response.body.fetch('items', [])
@@ -163,7 +163,7 @@ def set_service_information
     # if the service is not found, try again because CMR might be a little slow to index if it is a newly published record
     attempts = 0
     while attempts < 20
-      services_search_response = cmr_client.get_services(concept_id: @concept_id, all_revisions: true)
+      services_search_response = cmr_client.get_services(concept_id: @concept_id, all_revisions: true, sort_key: '-revision_date')
 
       service_data = if services_search_response.success?
                        services_search_response.body.fetch('items', [])
@@ -218,7 +218,7 @@ def set_tool_information
     # if the tool is not found, try again because CMR might be a little slow to index if it is a newly published record
     attempts = 0
     while attempts < 20
-      tools_search_response = cmr_client.get_tools(concept_id: @concept_id, all_revisions: true)
+      tools_search_response = cmr_client.get_tools(concept_id: @concept_id, all_revisions: true, sort_key: '-revision_date')
 
       tool_data = if tools_search_response.success?
                     tools_search_response.body.fetch('items', [])

app/controllers/tools_controller.rb

@@ -2,10 +2,10 @@
 class ToolsController < BasePublishedRecordController
   include ManageMetadataHelper
 
-  before_action :set_tool, only: [:show, :edit] #, :clone, :destroy, :revisions, :revert, :download_json]
-  before_action :set_schema, only: [:show, :edit] #, :clone, :destroy]
+  before_action :set_tool, only: [:show, :edit, :clone, :destroy, :revisions, :revert, :download_json]
+  before_action :set_schema, only: [:show, :edit, :clone, :destroy]
   before_action :ensure_supported_version, only: [:show, :edit]
-  before_action :ensure_correct_provider, only: [:edit] #, :clone, :destroy]
+  before_action :ensure_correct_provider, only: [:edit, :clone, :destroy]
   before_action :set_preview, only: [:show]
 
   # If clone is not defined like this performing the clone action leads to a `action not found error`