canvas_link_migrator 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814327ff4502ff2b1187f0b817659cff573bb272ee7e85ae32685297f985ce55
-  data.tar.gz: e8fa4255d9200988f052ddc9b6a4087b72709ce5443c9bbff4558279be38c4c6
+  metadata.gz: 838d1d2500ee03946b3363f19168d62181e4c40f0456cd6b27d2f6ace817c46d
+  data.tar.gz: e3686d60c231069856722e4f69e436efedd2531aa5cfc156093b2850918d7384
 SHA512:
-  metadata.gz: fc23256c7587decc42dfe9b5677f6299c7ba31cc4aa14e2bda8aca60233ba5ffdc143b205419f4d9fd101b13a52e54a2de896dbd1f038a3d25a44e7d631f54cf
-  data.tar.gz: fd8ac04adf9829f958297818be79bff39910259cb9e8bb233689b117deb22cbce21df0c875c8d756e9dfa5c4dafb1ab4b5aaba717cfb10aa1a22d8b9574b52a5
+  metadata.gz: 45520836a340a6a0f111057360299af93bfc39ac241ba31ab5f6c132dec98f75a32443fd4664e1f879f426d43b43e3ad7ee19a7b8eb89a52d2f595a856172b1e
+  data.tar.gz: 5c0fd8cdf1b2ea2c3d8a4e4e7ddf72d6ae8bae51178a9432ffbca3841c4576c18022da5f0802dc9579b37a53a68803e4e08935080dc344950faa56c93baf6f2d

data/lib/canvas_link_migrator/link_resolver.rb

@@ -18,9 +18,14 @@
 # with this program. If not, see <http://www.gnu.org/licenses/>.
 
 require "active_support/core_ext/object"
+require "rack"
 
 module CanvasLinkMigrator
   class LinkResolver
+    attr_accessor :migration_id_converter
+
+    delegate :context_path, :attachment_path_id_lookup, to: :migration_id_converter
+
     def initialize(migration_id_converter)
       @migration_id_converter = migration_id_converter
     end
@@ -35,8 +40,8 @@ module CanvasLinkMigrator
       end
     end
 
-    def context_path
-      @migration_id_converter.context_path
+    def attachment_path_id_lookup_lower
+      @attachment_path_id_lookup_lower ||= attachment_path_id_lookup&.transform_keys(&:downcase)
     end
 
     # finds the :new_value to use to replace the placeholder
@@ -63,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
@@ -150,13 +156,13 @@ module CanvasLinkMigrator
       # This is for backward-compatibility: canvas attachment filenames are escaped
       # with '+' for spaces and older exports have files with that instead of %20
       alt_rel_path = rel_path.tr("+", " ")
-      if @migration_id_converter.attachment_path_id_lookup
-        mig_id ||= @migration_id_converter.attachment_path_id_lookup[rel_path]
-        mig_id ||= @migration_id_converter.attachment_path_id_lookup[alt_rel_path]
+      if attachment_path_id_lookup
+        mig_id ||= attachment_path_id_lookup[rel_path]
+        mig_id ||= attachment_path_id_lookup[alt_rel_path]
       end
-      if !mig_id && @migration_id_converter.attachment_path_id_lookup_lower
-        mig_id ||= @migration_id_converter.attachment_path_id_lookup_lower[rel_path.downcase]
-        mig_id ||= @migration_id_converter.attachment_path_id_lookup_lower[alt_rel_path.downcase]
+      if !mig_id && attachment_path_id_lookup_lower
+        mig_id ||= attachment_path_id_lookup_lower[rel_path.downcase]
+        mig_id ||= attachment_path_id_lookup_lower[alt_rel_path.downcase]
       end
 
       # This md5 comparison is here to handle faulty cartridges with the migration_id equivalent of an empty string
@@ -182,7 +188,7 @@ module CanvasLinkMigrator
       while new_url.nil? && !rel_path_parts.empty?
         sub_path = File.join(rel_path_parts)
         if (file = find_file_in_context(sub_path))
-          new_url = "#{context_path}/files/#{file.id}"
+          new_url = "#{context_path}/files/#{file["id"]}"
           # support other params in the query string, that were exported from the
           # original path components and query string. see
           # CCHelper::file_query_string
@@ -219,13 +225,13 @@ module CanvasLinkMigrator
 
     def resolve_media_comment_data(node, rel_path)
       if (file = find_file_in_context(rel_path[/^[^?]+/])) # strip query string for this search
-        media_id = (file.media_object&.media_id || file.media_entry_id)
+        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")
-              return media_attachment_iframe_url(file.id, node["data-media-type"])
+              return media_attachment_iframe_url(file["id"], node["data-media-type"])
             else
               return media_iframe_url(media_id, node["data-media-type"])
             end

data/lib/canvas_link_migrator/resource_map_service.rb

@@ -52,9 +52,9 @@ module CanvasLinkMigrator
       migration_data["destination_hosts"]
     end
 
-    def attachment_path_id_lookup; end
-
-    def attachment_path_id_lookup_lower; end
+    def attachment_path_id_lookup
+      migration_data["attachment_path_id_lookup"]
+    end
 
     def root_folder_name
       migration_data["destination_root_folder"]
@@ -102,5 +102,9 @@ module CanvasLinkMigrator
       # we'll check both here
       convert_announcement_migration_id(migration_id) if type == "discussion_topics"
     end
+
+    def lookup_attachment_by_migration_id(migration_id)
+      resources.dig("files", migration_id, "destination")
+    end
   end
 end

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) }
 
@@ -56,62 +63,55 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
         end
       end
 
-      # it "finds an attachment by migration id" do
-      #   test_string = %{<p>This is an image: <br /><img src="%24CANVAS_OBJECT_REFERENCE%24/attachments/F" alt=":(" /></p>}
-      #   expect(@converter.convert_exported_html(test_string)).to eq([%{<p>This is an image: <br><img src="#{@path}files/6/preview" alt=":("></p>}, nil])
-      # end
-
-      # it "finds an attachment by path" do
-      #   test_string = %{<p>This is an image: <br /><img src="%24IMS_CC_FILEBASE%24/test.png" alt=":(" /></p>}
-
-      #   # if there isn't a path->migration id map it'll be a relative course file path
-      #   expect(@converter.convert_exported_html(test_string)).to eq %{<p>This is an image: <br><img src="#{@path}file_contents/course%20files/test.png" alt=":("></p>}
-
-      #   @migration.attachment_path_id_lookup = { "test.png" => att.migration_id }
-      #   expect(@converter.convert_exported_html(test_string)).to eq %{<p>This is an image: <br><img src="#{@path}files/#{att.id}/preview" alt=":("></p>}
-      # end
+      it "finds an attachment by migration id" do
+        test_string = %{<p>This is an image: <br /><img src="%24CANVAS_OBJECT_REFERENCE%24/attachments/F" alt=":(" /></p>}
+        expect(@converter.convert_exported_html(test_string)).to eq([%{<p>This is an image: <br><img src="#{@path}files/6/preview" alt=":("></p>}, nil])
+      end
 
-      # it "finds an attachment by a path with a space" do
-      #   att = make_test_att
-      #   @migration.attachment_path_id_lookup = { "subfolder/with a space/test.png" => att.migration_id }
+      it "finds an attachment by path" do
+        test_string = %{<p>This is an image: <br /><img src="%24IMS_CC_FILEBASE%24/test.png" alt=":(" /></p>}
 
-      #   test_string = %(<img src="subfolder/with%20a%20space/test.png" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview" alt="nope">)
+        # if there isn't a path->migration id map it'll be a relative course file path
+        expect(@converter.link_resolver).to receive(:attachment_path_id_lookup).exactly(4).times.and_return({})
+        html, bad_links = @converter.convert_exported_html(test_string)
+        expect(html).to eq %{<p>This is an image: <br><img src="#{@path}file_contents/course%20files/test.png" alt=":("></p>}
+        expect(bad_links[0]).to include({ link_type: :file, missing_url: "/courses/2/file_contents/course%20files/test.png" })
 
-      #   test_string = %(<img src="subfolder/with+a+space/test.png" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview" alt="nope">)
-      # end
+        expect(@converter.link_resolver).to receive(:attachment_path_id_lookup).twice.and_call_original
+        expect(@converter.convert_exported_html(test_string)).to eq([%{<p>This is an image: <br><img src="#{@path}files/5/preview" alt=":("></p>}, nil])
+      end
 
-      # it "finds an attachment even if the link has an extraneous folder" do
-      #   att = make_test_att
-      #   @migration.attachment_path_id_lookup = { "subfolder/test.png" => att.migration_id }
+      it "finds an attachment by a path with a space" do
+        test_string = %(<img src="subfolder/with%20a%20space/test.png" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/6/preview" alt="nope">), nil])
 
-      #   test_string = %(<img src="anotherfolder/subfolder/test.png" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview" alt="nope">)
-      # end
+        test_string = %(<img src="subfolder/with+a+space/test.png" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/6/preview" alt="nope">), nil])
+      end
 
-      # it "finds an attachment by path if capitalization is different" do
-      #   att = make_test_att
-      #   @migration.attachment_path_id_lookup = { "subfolder/withCapital/test.png" => "wrong!" }
-      #   @migration.attachment_path_id_lookup_lower = { "subfolder/withcapital/test.png" => att.migration_id }
+      it "finds an attachment even if the link has an extraneous folder" do
+        test_string = %(<img src="anotherfolder/subfolder/test.png" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/7/preview" alt="nope">), nil])
+      end
 
-      #   test_string = %(<img src="subfolder/WithCapital/TEST.png" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview" alt="nope">)
-      # end
+      it "finds an attachment by path if capitalization is different" do
+        expect(@converter.link_resolver).to receive(:attachment_path_id_lookup).twice.and_return({ "subfolder/withCapital/test.png" => "wrong!" })
+        expect(@converter.link_resolver).to receive(:attachment_path_id_lookup).twice.and_return({ "subfolder/withcapital/test.png" => "F" })
 
-      # it "finds an attachment with query params" do
-      #   att = make_test_att
-      #   @migration.attachment_path_id_lookup = { "test.png" => att.migration_id }
+        test_string = %(<img src="subfolder/WithCapital/TEST.png" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/6/preview" alt="nope">), nil])
+      end
 
-      #   test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?canvas_customaction=1&canvas_qs_customparam=1" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/customaction?customparam=1" alt="nope">)
+      it "finds an attachment with query params" do
+        test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?canvas_customaction=1&canvas_qs_customparam=1" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/5/customaction?customparam=1" alt="nope">), nil])
 
-      #   test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?canvas_qs_customparam2=3" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview?customparam2=3" alt="nope">)
+        test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?canvas_qs_customparam2=3" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/5/preview?customparam2=3" alt="nope">), nil])
 
-      #   test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?notarelevantparam" alt="nope" />)
-      #   expect(@converter.convert_exported_html(test_string)).to eq %(<img src="#{@path}files/#{att.id}/preview" alt="nope">)
-      # end
+        test_string = %(<img src="%24IMS_CC_FILEBASE%24/test.png?notarelevantparam" alt="nope" />)
+        expect(@converter.convert_exported_html(test_string)).to eq([%(<img src="#{@path}files/5/preview" alt="nope">), nil])
+      end
     end
 
     it "converts picture source srcsets" do

data/spec/canvas_link_migrator/link_resolver_spec.rb

@@ -81,4 +81,10 @@ describe CanvasLinkMigrator::LinkResolver do
       expect(link[:new_value]).to eq("/courses/2/assignments/12#fie")
     end
   end
+
+  describe "attachment_path_id_lookup_lower" do
+    it "shows correct lowercase paths" do
+      expect(resolver.attachment_path_id_lookup_lower).to include({ "subfolder/withcapital/test.png" => "migration_id!" })
+    end
+  end
 end

data/spec/fixtures/canvas_resource_map.json

@@ -1,4 +1,10 @@
 {
+  "attachment_path_id_lookup": {
+    "subfolder/test.png": "G",
+    "subfolder/with a space/test.png": "F",
+    "subfolder/withCapital/test.png": "migration_id!",
+    "test.png": "E"
+  },
   "contains_migration_ids": true,
   "destination_course": "2",
   "destination_hosts": [
@@ -57,6 +63,16 @@
           "id": "4",
           "media_entry_id": "m-stuff"
         }
+      },
+      "G": {
+        "destination": {
+          "id": "7",
+          "media_entry_id": "m-stuff"
+        },
+        "source": {
+          "id": "2",
+          "media_entry_id": "m-stuff"
+        }
       }
     },
     "module_items": {
@@ -92,12 +108,6 @@
       }
     }
   },
-  "file_tree": {
-    "folder 1": {
-      "id": "1",
-      "sub_folders": {}
-    }
-  },
   "source_course": "1",
   "source_host": "pineapple.edu"
-}
+}

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Mysti Lilla
 - James Logan
+- Sarah Gerard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,6 +40,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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
@@ -99,6 +114,7 @@ description:
 email:
 - mysti@instructure.com
 - james.logan@instructure.com
+- sarah.gerard@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []