canvas_link_migrator 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b03a701351cd4f8484cd257bdbbb3e4437ada4d39988d97230e48093e6a8c2a9
-  data.tar.gz: 2fadff9dc0f3a7c0d07ef2d7e79bd20f2e8c9ee14ccf71e4951c89417aa35659
+  metadata.gz: 6c077949f9cef706c71bff4537a9df6a3e53cb5306dadab87fb0281c79754a16
+  data.tar.gz: d1f6d129570271a82b293f6422b00cb1b6533233713adaf1479fd5d7efda47cb
 SHA512:
-  metadata.gz: 12d6e3e37c9d8115ce1e47712b0f6192a9d4d6617ec038d8d1b94eb3ec27996f4062d60c75b0b1f26b25675be1738a3dbe121fdc5707c182ca78751f7b47010d
-  data.tar.gz: e9fb1a26ea2aa9b9a24e799f407a05792b26c5743cd919e221e32309d20c49e603a51ec967bf28de51aba60954842793196024d74cae26f232ded871bb55725e
+  metadata.gz: b07d22a498fbb5188874aa67a6702be9ee349ed2be2efb5c4f42050d45b7914afb0edeae7d2f2127dae44531631f371cb1d8df62923133f8a88b96bcbe8f997f
+  data.tar.gz: f1c6fa682fc28072571d3841d4418e14bc1240b453618ec19be98df2d09ab8a217c3638310bc0383e1a63f32ade812008f69a3198ad436167dd12f5ffc672673

data/lib/canvas_link_migrator/link_parser.rb

@@ -166,6 +166,10 @@ module CanvasLinkMigrator
         else
           result[:old_value] = node[attr]
           result[:placeholder] = placeholder(result[:old_value])
+          # replace the inner html of an anchor tag if it matches the href
+          if node.name == "a" && attr == "href" && node["href"] == node.inner_html.delete("\n").strip
+            node.inner_html = result[:placeholder]
+          end
           node[attr] = result[:placeholder]
         end
         add_unresolved_link(result, item_type, mig_id, field)
@@ -177,16 +181,18 @@ module CanvasLinkMigrator
     end
 
     def resolved(new_url = nil)
-      { resolved: true, new_url: new_url }
+      { resolved: true, new_url: new_url}
     end
 
     # returns a hash with resolution status and data to hold onto if unresolved
     def parse_url(url, node, attr)
-      url = Addressable::URI.parse(url)
-      query_values = url.query_values || {}
-      media_attachment = query_values.delete("media_attachment") == "true"
-      url.query_values = query_values.present? ? query_values : nil
-      url = url.to_s
+      parsed_url = Addressable::URI.parse(url)
+      query_values = parsed_url.query_values
+      media_attachment = query_values.try(:delete, "media_attachment") == "true"
+      if media_attachment
+        parsed_url.query_values = query_values.presence || nil
+        url = Addressable::URI.unencode(parsed_url)
+      end
 
       if url =~ /wiki_page_migration_id=(.*)/
         unresolved(:wiki_page, migration_id: $1)

data/lib/canvas_link_migrator/link_resolver.rb

@@ -122,15 +122,14 @@ module CanvasLinkMigrator
           # context prepended to the URL. This prevents
           # redirects to non cross-origin friendly urls
           # during a file fetch
-          link[:new_value] = if rest.include?("icon_maker_icon=1")
-                               "/files/#{file_id}#{rest}"
-                             elsif link[:in_media_iframe] && link[:media_attachment]
-                               "/media_attachments_iframe/#{file_id}#{rest}"
-                             elsif link[:in_media_iframe]
-                               "/media_objects_iframe?mediahref=#{link[:new_value]}"
-                             else
-                               "#{context_path}/files/#{file_id}#{rest}"
-                             end
+          if rest.include?("icon_maker_icon=1")
+            link[:new_value] = "/files/#{file_id}#{rest}"
+          elsif link[:in_media_iframe] && link[:media_attachment]
+            link[:new_value] = "/media_attachments_iframe/#{file_id}#{rest}"
+          else
+            link[:new_value] = "#{context_path}/files/#{file_id}#{rest}"
+            link[:new_value] = "/media_objects_iframe?mediahref=#{link[:new_value]}" if link[:in_media_iframe]
+          end
         end
       else
         raise "unrecognized link_type (#{link[:link_type]}) in unresolved link"

data/spec/canvas_link_migrator/imported_html_converter_spec.rb

@@ -240,6 +240,12 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
       expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
     end
 
+    it "converts mediahref iframes" do
+      test_string = %(<iframe data-media-type="video" src="/media_objects_iframe?mediahref=$CANVAS_COURSE_REFERENCE$/file_ref/I/download" data-media-id="m-yodawg"></iframe>)
+      converted_string = %(<iframe data-media-type="video" src="/media_objects_iframe?mediahref=/courses/2/files/9/download" data-media-id="m-yodawg"></iframe>)
+      expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
+    end
+
     it "leaves source tags without data-media-id alone" do
       test_string = %(<video style="width: 400px; height: 225px; display: inline-block;" title="this is a non-canvas video" allowfullscreen="allowfullscreen" allow="fullscreen"><source src="http://www.example.com/video.mov"></video>)
       expect(@converter.convert_exported_html(test_string)).to eq([test_string, nil])

data/spec/canvas_link_migrator/link_parser_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+#
+# Copyright (C) 2023 - present Instructure, Inc.
+#
+# This file is part of Canvas.
+#
+# Canvas is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along
+# with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "spec_helper"
+
+describe CanvasLinkMigrator::LinkParser do
+  def parser
+    migration_query_service_mock = double()
+    allow(migration_query_service_mock).to receive(:supports_embedded_images).and_return(true)
+    allow(migration_query_service_mock).to receive(:fix_relative_urls?).and_return(true)
+    CanvasLinkMigrator::LinkParser.new(migration_query_service_mock)
+  end
+
+  describe "convert_link" do
+    it "converts inner html of anchor tags when appropriate" do
+      doc = Nokogiri::HTML5.fragment("<a href=\"$WIKI_REFERENCE$/pages/1\">$WIKI_REFERENCE$/pages/1</a>")
+      parser.convert_link(doc.at_css('a'), "href","wiki_page", "migrationid", "")
+      expect(doc.at_css('a')['href']).to include("LINK.PLACEHOLDER")
+      expect(doc.at_css('a').inner_html).to include("LINK.PLACEHOLDER")
+    end
+
+    it "doesn't convert inner html of anchor tags if unnecessary" do
+      doc = Nokogiri::HTML5.fragment("<a href=\"$WIKI_REFERENCE$/pages/1\">$WIKI_REFERENCE$/pages/5</a>")
+      parser.convert_link(doc.at_css('a'), "href","wiki_page", "migrationid", "")
+      expect(doc.at_css('a')['href']).to include("LINK.PLACEHOLDER")
+      expect(doc.at_css('a').inner_html).not_to include("LINK.PLACEHOLDER")
+    end
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Mysti Lilla
 - James Logan
 - Sarah Gerard
+- Math Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,6 +130,7 @@ email:
 - mysti@instructure.com
 - james.logan@instructure.com
 - sarah.gerard@instructure.com
+- luis.oliveira@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -141,6 +143,7 @@ files:
 - lib/canvas_link_migrator/resource_map_service.rb
 - lib/canvas_link_migrator/version.rb
 - spec/canvas_link_migrator/imported_html_converter_spec.rb
+- spec/canvas_link_migrator/link_parser_spec.rb
 - spec/canvas_link_migrator/link_resolver_spec.rb
 - spec/canvas_link_migrator_spec.rb
 - spec/fixtures/canvas_resource_map.json