π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
fix(api): avoid re-crawling issue link on update when url is unchanged (#9763)
Mohd Quamar Tyagicd98fab654bc
diff --git a/apps/api/plane/api/views/issue.py b/apps/api/plane/api/views/issue.pyindex da9edc66d6..462a249bb7 100644--- a/apps/api/plane/api/views/issue.py+++ b/apps/api/plane/api/views/issue.py@@ -1307,10 +1307,13 @@ class IssueLinkDetailAPIEndpoint(BaseAPIView):issue_link = IssueLink.objects.get(workspace__slug=slug, project_id=project_id, issue_id=issue_id, pk=pk)requested_data = json.dumps(request.data, cls=DjangoJSONEncoder)current_instance = json.dumps(IssueLinkSerializer(issue_link).data, cls=DjangoJSONEncoder)+ previous_url = issue_link.urlserializer = IssueLinkSerializer(issue_link, data=request.data, partial=True)if serializer.is_valid():serializer.save()- crawl_work_item_link_title.delay(serializer.data.get("id"), serializer.data.get("url"))+ updated_url = serializer.data.get("url")+ if updated_url and updated_url != previous_url:+ crawl_work_item_link_title.delay(serializer.data.get("id"), updated_url)issue_activity.delay(type="link.activity.updated",requested_data=requested_data,diff --git a/apps/api/plane/app/views/issue/link.py b/apps/api/plane/app/views/issue/link.pyindex 5490212302..94b6d25872 100644--- a/apps/api/plane/app/views/issue/link.py+++ b/apps/api/plane/app/views/issue/link.py@@ -73,10 +73,14 @@ class IssueLinkViewSet(BaseViewSet):requested_data = json.dumps(request.data, cls=DjangoJSONEncoder)current_instance = json.dumps(IssueLinkSerializer(issue_link).data, cls=DjangoJSONEncoder)+ previous_url = issue_link.url+serializer = IssueLinkSerializer(issue_link, data=request.data, partial=True)if serializer.is_valid():serializer.save()- crawl_work_item_link_title.delay(serializer.data.get("id"), serializer.data.get("url"))+ updated_url = serializer.data.get("url")+ if updated_url and updated_url != previous_url:+ crawl_work_item_link_title.delay(serializer.data.get("id"), updated_url)issue_activity.delay(type="link.activity.updated",diff --git a/apps/api/plane/tests/unit/views/test_issue_link.py b/apps/api/plane/tests/unit/views/test_issue_link.pynew file mode 100644index 0000000000..00646cc290--- /dev/null+++ b/apps/api/plane/tests/unit/views/test_issue_link.py@@ -0,0 +1,212 @@+# Copyright (c) 2023-present Plane Software, Inc. and contributors+# SPDX-License-Identifier: AGPL-3.0-only+# See the LICENSE file for details.++"""+Unit regression tests for IssueLinkViewSet.partial_update.++Verifies that crawl_work_item_link_title is only scheduled when the URL+actually changes, preventing overwriting custom link metadata and unnecessary crawls.+See: https://github.com/makeplane/plane/issues/9674+"""++import uuid+from unittest.mock import MagicMock, patch++import pytest+from rest_framework import status+from rest_framework.parsers import JSONParser+from rest_framework.request import Request+from rest_framework.test import APIRequestFactory++from plane.app.views.issue.link import IssueLinkViewSet+from plane.api.views.issue import IssueLinkDetailAPIEndpoint+++class TestIssueLinkPartialUpdate:+ @pytest.fixture(autouse=True)+ def setup_view(self):+ self.factory = APIRequestFactory()+ self.view = IssueLinkViewSet()+ self.workspace_slug = "test-workspace"+ self.project_id = str(uuid.uuid4())+ self.issue_id = str(uuid.uuid4())+ self.link_id = str(uuid.uuid4())+ self.user_id = str(uuid.uuid4())++ def _create_mock_request(self, data):+ wsgi_request = self.factory.patch("/api/test/", data=data, format="json")+ request = Request(wsgi_request, parsers=[JSONParser()])+ request.user = MagicMock()+ request.user.id = self.user_id+ return request++ @patch("plane.app.views.issue.link.base_host", return_value="https://app.plane.so")+ @patch("plane.app.views.issue.link.issue_activity")+ @patch("plane.app.views.issue.link.crawl_work_item_link_title")+ @patch("plane.app.views.issue.link.IssueLinkSerializer")+ @patch("plane.app.views.issue.link.IssueLink.objects.get")+ def test_partial_update_does_not_recrawl_when_url_unchanged(+ self, mock_get_link, mock_serializer_cls, mock_crawl, mock_activity, mock_base_host+ ):+ """Updating link title or metadata without changing url must NOT trigger crawler."""+ initial_url = "https://github.com/makeplane/plane"+ mock_instance = MagicMock()+ mock_instance.id = self.link_id+ mock_instance.url = initial_url+ mock_get_link.return_value = mock_instance++ # Mock serializer behavior+ mock_serializer_instance = MagicMock()+ mock_serializer_instance.is_valid.return_value = True+ mock_serializer_instance.data = {+ "id": self.link_id,+ "title": "Custom Renamed Title",+ "url": initial_url,+ "metadata": {"custom": "data"},+ }+ mock_serializer_cls.return_value = mock_serializer_instance++ # Mock get_queryset for self.get_queryset().get(id=...)+ mock_queryset = MagicMock()+ mock_queryset.get.return_value = mock_instance+ self.view.get_queryset = MagicMock(return_value=mock_queryset)++ request = self._create_mock_request({"title": "Custom Renamed Title"})+ response = self.view.partial_update(+ request,+ slug=self.workspace_slug,+ project_id=self.project_id,+ issue_id=self.issue_id,+ pk=self.link_id,+ )++ assert response.status_code == status.HTTP_200_OK+ mock_crawl.delay.assert_not_called()+ mock_activity.delay.assert_called_once()++ @patch("plane.app.views.issue.link.base_host", return_value="https://app.plane.so")+ @patch("plane.app.views.issue.link.issue_activity")+ @patch("plane.app.views.issue.link.crawl_work_item_link_title")+ @patch("plane.app.views.issue.link.IssueLinkSerializer")+ @patch("plane.app.views.issue.link.IssueLink.objects.get")+ def test_partial_update_triggers_crawl_when_url_changed(+ self, mock_get_link, mock_serializer_cls, mock_crawl, mock_activity, mock_base_host+ ):+ """Updating url to a new value MUST trigger crawl_work_item_link_title."""+ initial_url = "https://github.com/makeplane/plane"+ new_url = "https://github.com/makeplane/plane/pull/123"++ mock_instance = MagicMock()+ mock_instance.id = self.link_id+ mock_instance.url = initial_url+ mock_get_link.return_value = mock_instance++ mock_serializer_instance = MagicMock()+ mock_serializer_instance.is_valid.return_value = True+ mock_serializer_instance.data = {+ "id": self.link_id,+ "title": "Old Title",+ "url": new_url,+ "metadata": {},+ }+ mock_serializer_cls.return_value = mock_serializer_instance++ mock_queryset = MagicMock()+ mock_queryset.get.return_value = mock_instance+ self.view.get_queryset = MagicMock(return_value=mock_queryset)++ request = self._create_mock_request({"url": new_url})+ response = self.view.partial_update(+ request,+ slug=self.workspace_slug,+ project_id=self.project_id,+ issue_id=self.issue_id,+ pk=self.link_id,+ )++ assert response.status_code == status.HTTP_200_OK+ mock_crawl.delay.assert_called_once_with(self.link_id, new_url)+ mock_activity.delay.assert_called_once()+++class TestIssueLinkDetailPatch:+ @pytest.fixture(autouse=True)+ def setup_view(self):+ self.factory = APIRequestFactory()+ self.view = IssueLinkDetailAPIEndpoint()+ self.workspace_slug = "test-workspace"+ self.project_id = str(uuid.uuid4())+ self.issue_id = str(uuid.uuid4())+ self.link_id = str(uuid.uuid4())+ self.user_id = str(uuid.uuid4())++ def _create_mock_request(self, data):+ wsgi_request = self.factory.patch("/api/test/", data=data, format="json")+ request = Request(wsgi_request, parsers=[JSONParser()])+ request.user = MagicMock()+ request.user.id = self.user_id+ return request++ @patch("plane.api.views.issue.issue_activity")+ @patch("plane.api.views.issue.crawl_work_item_link_title")+ @patch("plane.api.views.issue.IssueLinkSerializer")+ @patch("plane.api.views.issue.IssueLink.objects.get")+ def test_patch_does_not_recrawl_when_url_unchanged(+ self, mock_get_link, mock_serializer_cls, mock_crawl, mock_activity+ ):+ initial_url = "https://github.com/makeplane/plane"+ mock_instance = MagicMock()+ mock_instance.id = self.link_id+ mock_instance.url = initial_url+ mock_get_link.return_value = mock_instance++ mock_serializer_instance = MagicMock()+ mock_serializer_instance.is_valid.return_value = True+ mock_serializer_instance.data = {"id": self.link_id, "url": initial_url}+ mock_serializer_cls.return_value = mock_serializer_instance++ response = self.view.patch(+ self._create_mock_request({"title": "Custom Renamed Title"}),+ slug=self.workspace_slug,+ project_id=self.project_id,+ issue_id=self.issue_id,+ pk=self.link_id,+ )++ assert response.status_code == status.HTTP_200_OK+ mock_crawl.delay.assert_not_called()+ mock_activity.delay.assert_called_once()++ @patch("plane.api.views.issue.issue_activity")+ @patch("plane.api.views.issue.crawl_work_item_link_title")+ @patch("plane.api.views.issue.IssueLinkSerializer")+ @patch("plane.api.views.issue.IssueLink.objects.get")+ def test_patch_triggers_crawl_when_url_changed(+ self, mock_get_link, mock_serializer_cls, mock_crawl, mock_activity+ ):+ initial_url = "https://github.com/makeplane/plane"+ new_url = "https://github.com/makeplane/plane/pull/123"+ mock_instance = MagicMock()+ mock_instance.id = self.link_id+ mock_instance.url = initial_url+ mock_get_link.return_value = mock_instance++ mock_serializer_instance = MagicMock()+ mock_serializer_instance.is_valid.return_value = True+ mock_serializer_instance.data = {"id": self.link_id, "url": new_url}+ mock_serializer_cls.return_value = mock_serializer_instance++ response = self.view.patch(+ self._create_mock_request({"url": new_url}),+ slug=self.workspace_slug,+ project_id=self.project_id,+ issue_id=self.issue_id,+ pk=self.link_id,+ )++ assert response.status_code == status.HTTP_200_OK+ mock_crawl.delay.assert_called_once_with(self.link_id, new_url)+ mock_activity.delay.assert_called_once()