fix: Update the pks for internal child plugins (#49)

Co-authored-by: Fabian Braun <fsbraun@gmx.de>

Author: mrbazzan

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,5 +26,5 @@ Use 'x' to check each item: [x] I have ...
 * [ ] I have opened this pull request against ``master``
 * [ ] I have added or modified the tests when changing logic
 * [ ] I have followed [the conventional commits guidelines](https://www.conventionalcommits.org/) to add meaningful information into the changelog
-* [ ] I have read the [contribution guidelines ](https://github.com/django-cms/django-cms/blob/develop/CONTRIBUTING.rst) and I have joined #workgroup-pr-review on
-[Slack](https://www.django-cms.org/slack) to find a “pr review buddy” who is going to review my pull request.
+* [ ] I have read the [contribution guidelines ](https://github.com/django-cms/django-cms/blob/develop/CONTRIBUTING.rst) and I have joined #workgroup-pr-review on 
+[Discord](https://www.django-cms.org/discord) to find a “pr review buddy” who is going to review my pull request.

djangocms_transfer/importer.py

@@ -1,8 +1,6 @@
 from cms.models import CMSPlugin
 from django.db import transaction
 
-from .utils import get_plugin_class
-
 
 @transaction.atomic
 def import_plugins(plugins, placeholder, language, root_plugin_id=None):
@@ -36,16 +34,11 @@ def import_plugins(plugins, placeholder, language, root_plugin_id=None):
         )
         source_map[archived_plugin.pk] = plugin
 
-        new_plugins.append(plugin)
-
-    for new_plugin in new_plugins:
-        plugin_class = get_plugin_class(new_plugin.plugin_type)
+        new_plugins.append((plugin, archived_plugin))
 
-        if getattr(plugin_class, "_has_do_post_copy", False):
-            # getattr is used for django CMS 3.4 compatibility
-            # apps on 3.4 wishing to leverage this callback will need
-            # to manually set the _has_do_post_copy attribute.
-            plugin_class.do_post_copy(new_plugin, source_map)
+    for new_plugin, _ in new_plugins:
+        # Replace all internal child plugins with their new ids
+        new_plugin.post_copy(new_plugin, new_plugins)
 
 
 @transaction.atomic

tests/requirements/base.txt

@@ -6,3 +6,6 @@ freezegun
 djangocms-text
 pytest
 pytest-django
+
+# for testing purposes
+djangocms-link

tests/settings.py

@@ -16,6 +16,7 @@
     "menus",
     "treebeard",
     "djangocms_text",
+    "djangocms_link",
     "djangocms_transfer",
 ]
 

tests/test_migrations.py

@@ -7,7 +7,7 @@
 
 
 class MigrationTestCase(TestCase):
-    @override_settings(MIGRATION_MODULES={}, DEFAULT_AUTO_FIELD="django.db.models.AutoField")
+    @override_settings(MIGRATION_MODULES={"djangocms_link": None}, DEFAULT_AUTO_FIELD="django.db.models.AutoField")
     def test_for_missing_migrations(self):
         output = StringIO()
         options = {

tests/transfer/abstract.py

@@ -5,17 +5,26 @@
 
 @freeze_time("2024-02-28 00:00:00")
 class FunctionalityBaseTestCase(CMSTestCase):
+
+    TEXT_BODY = "Hello World!"
+
     def setUp(self):
         self.page = self._create_page()
         self.page_content = self.page.pagecontent_set(manager="admin_manager").first()
         self.page.set_as_homepage()
 
-    def _create_plugin(self, parent=None):
+    def _create_plugin(self, plugin_type="TextPlugin", parent=None, **kwargs):
+        if plugin_type == "TextPlugin":
+            kwargs["body"] = self.TEXT_BODY
+        elif plugin_type == "LinkPlugin":
+            kwargs["name"] =  plugin_type.lower()
+            kwargs["link"] = {"external_link": "https://www.django-cms.org"}
+
         return self._add_plugin_to_page(
-            "TextPlugin",
+            plugin_type,
             "last-child",
             parent,
-            body="Hello World!",
+            **kwargs
         )
 
     def _create_page(self, **kwargs):

tests/transfer/test_import.py

@@ -1,5 +1,8 @@
 import json
 
+from cms.models import CMSPlugin
+from djangocms_text.utils import plugin_to_tag
+
 from djangocms_transfer.datastructures import (
     ArchivedPlaceholder,
     ArchivedPlugin,
@@ -16,14 +19,33 @@ def test_import(self):
         placeholder = pagecontent.get_placeholders().get(slot="content")
         plugin = self._create_plugin()
 
+        # create link plugin
+        link_plugin = self._create_plugin(plugin_type="LinkPlugin", parent=plugin)
+
+        # Add plugin to text body
+        plugin.body = f"{plugin.body} {plugin_to_tag(link_plugin)}"
+        plugin.save()
+
+        link_plugin_data = ArchivedPlugin(
+            **json.loads(export_plugin(link_plugin))[0]
+        )
         plugin_data = ArchivedPlugin(**json.loads(export_plugin(plugin))[0])
         placeholder_data = ArchivedPlaceholder(
             "content",
             [ArchivedPlugin(**data) for data in json.loads(export_placeholder(placeholder, "en"))],
         )
 
         with self.subTest("import plugins"):
-            import_plugins([plugin_data], placeholder, "en")
+            import_plugins([plugin_data, link_plugin_data], placeholder, "en")
+
+            # test import updates child plugin
+            new_plugin, new_link_plugin = map(
+                lambda plugin: plugin.get_bound_plugin(), CMSPlugin.objects.filter(pk__in=[3,4])
+            )
+            self.assertEqual(
+                new_plugin.body,
+                f"{self.TEXT_BODY} {plugin_to_tag(new_link_plugin)}"
+            )
 
         with self.subTest("import placeholder"):
             import_plugins(placeholder_data.plugins, placeholder, "en")