canvas_link_migrator 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989d0e7044ece5d052b909fa121de7f205906c733908a8dcf4a26d619cf67caf
-  data.tar.gz: a065d7f5ad6ad400cbd7cf448f5d42c5b69d400d9123837d2517950059d4a70e
+  metadata.gz: b03a701351cd4f8484cd257bdbbb3e4437ada4d39988d97230e48093e6a8c2a9
+  data.tar.gz: 2fadff9dc0f3a7c0d07ef2d7e79bd20f2e8c9ee14ccf71e4951c89417aa35659
 SHA512:
-  metadata.gz: 50b673e7a91c0f345455c0ef0027b9e05a84c973f35d75f5659d336dfb70a3385d04d3360bead41b16a5101e3f8ee5e054f881cab88ac3f7c3ec0d5387cb7c6c
-  data.tar.gz: 8519365222facd8c05af020e7c6734db5c61e386cfd1fd0097f1a0815924c2c622929c217bfa4772d37fcd3acadd118019672cd9958ad76951512acd4bd8c4ba
+  metadata.gz: 12d6e3e37c9d8115ce1e47712b0f6192a9d4d6617ec038d8d1b94eb3ec27996f4062d60c75b0b1f26b25675be1738a3dbe121fdc5707c182ca78751f7b47010d
+  data.tar.gz: e9fb1a26ea2aa9b9a24e799f407a05792b26c5743cd919e221e32309d20c49e603a51ec967bf28de51aba60954842793196024d74cae26f232ded871bb55725e

data/lib/canvas_link_migrator/link_parser.rb

@@ -19,6 +19,7 @@
 
 require "nokogiri"
 require "digest"
+require "addressable"
 
 module CanvasLinkMigrator
   class LinkParser
@@ -181,6 +182,12 @@ module CanvasLinkMigrator
 
     # 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
+
       if url =~ /wiki_page_migration_id=(.*)/
         unresolved(:wiki_page, migration_id: $1)
       elsif url =~ /discussion_topic_migration_id=(.*)/
@@ -191,7 +198,8 @@ module CanvasLinkMigrator
         unresolved(:file_ref,
                    migration_id: $1,
                    rest: $2,
-                   in_media_iframe: attr == "src" && ["iframe", "source"].include?(node.name) && node["data-media-id"])
+                   in_media_iframe: attr == "src" && ["iframe", "source"].include?(node.name) && node["data-media-id"],
+                   media_attachment: media_attachment)
       elsif url =~ %r{(?:\$CANVAS_OBJECT_REFERENCE\$|\$WIKI_REFERENCE\$)/([^/]*)/([^?]*)(\?.*)?}
         if KNOWN_REFERENCE_TYPES.include?($1)
           unresolved(:object, type: $1, migration_id: $2, query: $3)
@@ -207,7 +215,7 @@ module CanvasLinkMigrator
         rel_path = URI::DEFAULT_PARSER.unescape($1)
         if (attr == "href" && node["class"]&.include?("instructure_inline_media_comment")) ||
            (attr == "src" && ["iframe", "source"].include?(node.name) && node["data-media-id"])
-          unresolved(:media_object, rel_path: rel_path)
+          unresolved(:media_object, rel_path: rel_path, media_attachment: media_attachment)
         else
           unresolved(:file, rel_path: rel_path)
         end

data/lib/canvas_link_migrator/link_resolver.rb

@@ -68,7 +68,8 @@ module CanvasLinkMigrator
         type = "pages" if type == "wiki"
         if type == "pages"
           query = resolve_module_item_query(nil, link[:query])
-          link[:new_value] = "#{context_path}/pages/#{migration_id}#{query}"
+          linked_wiki_url = @migration_id_converter.convert_wiki_page_migration_id_to_slug(migration_id) || migration_id
+          link[:new_value] = "#{context_path}/pages/#{linked_wiki_url}#{query}"
         elsif type == "attachments"
           att_id = @migration_id_converter.convert_attachment_migration_id(migration_id)
           if att_id
@@ -91,7 +92,7 @@ module CanvasLinkMigrator
         # see LinkParser for details
         rel_path = link[:rel_path]
         node = Nokogiri::HTML5.fragment(link[:old_value]).children.first
-        new_url = resolve_media_comment_data(node, rel_path)
+        new_url = resolve_media_comment_data(node, rel_path, link[:media_attachment])
         new_url ||= resolve_relative_file_url(rel_path)
 
         unless new_url
@@ -121,12 +122,15 @@ module CanvasLinkMigrator
           # context prepended to the URL. This prevents
           # redirects to non cross-origin friendly urls
           # during a file fetch
-          if rest.include?("icon_maker_icon=1")
-            link[:new_value] = "/files/#{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
+          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
         end
       else
         raise "unrecognized link_type (#{link[:link_type]}) in unresolved link"
@@ -222,14 +226,13 @@ module CanvasLinkMigrator
       url
     end
 
-    def resolve_media_comment_data(node, rel_path)
+    def resolve_media_comment_data(node, rel_path, media_attachment)
       if (file = find_file_in_context(rel_path[/^[^?]+/])) # strip query string for this search
         media_id = file.try(:media_object)&.media_id || file["media_entry_id"]
         if media_id && media_id != "maybe"
           if ["iframe", "source"].include?(node.name)
             node["data-media-id"] = media_id
-            if node["data-is-media-attachment"]
-              node.delete("data-is-media-attachment")
+            if media_attachment
               return media_attachment_iframe_url(file["id"], node["data-media-type"])
             else
               return media_iframe_url(media_id, node["data-media-type"])

data/spec/canvas_link_migrator/imported_html_converter_spec.rb

@@ -37,6 +37,13 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
       expect(bad_links).to be_nil
     end
 
+    it "converts a wiki reference with migration id" do
+      test_string = %(<a href="%24WIKI_REFERENCE%24/pages/A?query=blah">Test Wiki Page</a>)
+      html, bad_links = @converter.convert_exported_html(test_string)
+      expect(html).to eq %(<a href="#{@path}pages/slug-a?query=blah">Test Wiki Page</a>)
+      expect(bad_links).to be_nil
+    end
+
     context "when course attachments exist" do
       subject { @converter.convert_exported_html(test_string) }
 
@@ -214,22 +221,22 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
     end
 
     it "converts source tags to RCE media attachment iframes" do
-      test_string = %(<video style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-stuff"><source src="$CANVAS_OBJECT_REFERENCE$/media_attachments_iframe/E?type=video" data-media-id="m-stuff" data-media-type="video"></video>)
-      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-stuff" src="/media_attachments_iframe/5?type=video"></iframe>)
+      test_string = %(<video style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-stuff"><source src="$IMS-CC-FILEBASE$/subfolder/with a space/yodawg.mov?canvas_=1&canvas_qs_type=video&canvas_qs_amp=&canvas_qs_embedded=true&media_attachment=true" data-media-id="m-stuff" data-media-type="video"></video>)
+      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-yodawg" src="/media_attachments_iframe/9?type=video"></iframe>)
       expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
 
-      test_string = %(<audio  style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-stuff"><source src="$CANVAS_OBJECT_REFERENCE$/media_attachments_iframe/E?type=audio" data-media-id="m-stuff" data-media-type="audio"></video>)
-      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-stuff" src="/media_attachments_iframe/5?type=audio"></iframe>)
+      test_string = %(<audio style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-stuff"><source src="$IMS-CC-FILEBASE$/lolcat.mp3?canvas_=1&canvas_qs_type=audio&canvas_qs_amp=&canvas_qs_embedded=true&media_attachment=true" data-media-id="m-stuff" data-media-type="audio"></video>)
+      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-lolcat" src="/media_attachments_iframe/8?type=audio"></iframe>)
       expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
     end
 
-    it "converts source tags to RCE media attachment iframes when link is untranslated" do
-      test_string = %(<video style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-stuff"><source src="/media_attachments_iframe/5?type=video" data-media-id="m-stuff" data-media-type="video"></video>)
-      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-stuff" src="/media_attachments_iframe/5?type=video"></iframe>)
+    it "converts course copy style media attachmet iframe links" do
+      test_string = %(<video style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-yodawg"><source src="$CANVAS_COURSE_REFERENCE$/file_ref/I?media_attachment=true&type=video" data-media-id="m-yodawg" data-media-type="video"></video>)
+      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="video" allowfullscreen="allowfullscreen" allow="fullscreen" data-media-id="m-yodawg" src="/media_attachments_iframe/9?type=video"></iframe>)
       expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
 
-      test_string = %(<audio  style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-stuff"><source src="/media_attachments_iframe/5?type=audio" data-media-id="m-stuff" data-media-type="audio"></video>)
-      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-stuff" src="/media_attachments_iframe/5?type=audio"></iframe>)
+      test_string = %(<audio style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-lolcat"><source src="$CANVAS_COURSE_REFERENCE$/file_ref/H?media_attachment=true&type=audio" data-media-id="m-lolcat" data-media-type="audio"></audio>)
+      converted_string = %(<iframe style="width: 400px; height: 225px; display: inline-block;" title="this is a media comment" data-media-type="audio" data-media-id="m-lolcat" src="/media_attachments_iframe/8?type=audio"></iframe>)
       expect(@converter.convert_exported_html(test_string)).to eq([converted_string, nil])
     end
 

data/spec/canvas_link_migrator/link_resolver_spec.rb

@@ -75,7 +75,7 @@ describe CanvasLinkMigrator::LinkResolver do
       expect(link[:new_value]).to eq("/courses/2/modules/36?foo=bar")
     end
 
-    it "converters other links" do
+    it "converts other links" do
       link = { link_type: :object, type: "assignments", migration_id: "I", query: "#fie" }
       resolver.resolve_link!(link)
       expect(link[:new_value]).to eq("/courses/2/assignments/12#fie")

data/spec/fixtures/canvas_resource_map.json

@@ -2,7 +2,9 @@
   "attachment_path_id_lookup": {
     "subfolder/test.png": "G",
     "subfolder/with a space/test.png": "F",
+    "subfolder/with a space/yodawg.mov": "I",
     "subfolder/withCapital/test.png": "migration_id!",
+    "lolcat.mp3": "H",
     "test.png": "E"
   },
   "contains_migration_ids": true,
@@ -66,12 +68,30 @@
       },
       "G": {
         "destination": {
-          "id": "7",
-          "media_entry_id": "m-stuff"
+          "id": "7"
         },
         "source": {
-          "id": "2",
-          "media_entry_id": "m-stuff"
+          "id": "2"
+        }
+      },
+      "H": {
+        "destination": {
+          "id": "8",
+          "media_entry_id": "m-lolcat"
+        },
+        "source": {
+          "id": "3",
+          "media_entry_id": "m-lolcat"
+        }
+      },
+      "I": {
+        "destination": {
+          "id": "9",
+          "media_entry_id": "m-yodawg"
+        },
+        "source": {
+          "id": "4",
+          "media_entry_id": "m-yodawg"
         }
       }
     },

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mysti Lilla
 - James Logan
+- Sarah Gerard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +128,7 @@ description:
 email:
 - mysti@instructure.com
 - james.logan@instructure.com
+- sarah.gerard@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []