From 2e7b3cb7fc93b63b9adbae37f79d80a7784b322c Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 14 Sep 2026 19:09:15 -0700 Subject: [PATCH] Backend support for excluded_documents --- src/documents/serialisers.py | 12 ++++ src/documents/tests/test_api_bulk_edit.py | 67 +++++++++++++++++++++++ src/documents/views.py | 12 +++- 3 files changed, 90 insertions(+), 1 deletion(-) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 10296a392c..999a42b138 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -1647,11 +1647,23 @@ class DocumentSelectionSerializer(DocumentListSerializer): write_only=True, ) + excluded_documents = serializers.ListField( + required=False, + default=list, + write_only=True, + child=serializers.IntegerField(), + ) + def validate(self, attrs): if attrs.get("all", False): attrs.setdefault("documents", []) return attrs + if attrs["excluded_documents"]: + raise serializers.ValidationError( + "excluded_documents is only supported when all is true.", + ) + if "documents" not in attrs: raise serializers.ValidationError( "documents is required unless all is true.", diff --git a/src/documents/tests/test_api_bulk_edit.py b/src/documents/tests/test_api_bulk_edit.py index 0c13cce406..d63ad152c0 100644 --- a/src/documents/tests/test_api_bulk_edit.py +++ b/src/documents/tests/test_api_bulk_edit.py @@ -520,6 +520,30 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): self.assertEqual(args[0], [self.doc1.id]) self.assertEqual(len(kwargs), 0) + @mock.patch("documents.views.bulk_edit.delete") + def test_delete_documents_endpoint_with_excluded_documents(self, m) -> None: + self.setup_mock(m, "delete") + response = self.client.post( + "/api/documents/delete/", + json.dumps( + { + "all": True, + "excluded_documents": [ + self.doc2.id, + self.doc3.id, + self.doc4.id, + self.doc5.id, + ], + }, + ), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_200_OK) + m.assert_called_once() + args, kwargs = m.call_args + self.assertEqual(args[0], [self.doc1.id]) + self.assertEqual(len(kwargs), 0) + @mock.patch("documents.views.bulk_edit.reprocess") def test_reprocess_documents_endpoint(self, m) -> None: self.setup_mock(m, "reprocess") @@ -691,6 +715,26 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) self.assertIn(b"documents is required unless all is true", response.content) + def test_api_rejects_excluded_documents_unless_all_is_true(self) -> None: + response = self.client.post( + "/api/documents/bulk_edit/", + json.dumps( + { + "documents": [self.doc1.id], + "excluded_documents": [self.doc2.id], + "method": "set_storage_path", + "parameters": {"storage_path": self.sp1.id}, + }, + ), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) + self.assertIn( + b"excluded_documents is only supported when all is true", + response.content, + ) + @mock.patch("documents.serialisers.bulk_edit.set_storage_path") def test_api_bulk_edit_with_all_true_resolves_documents_from_filters( self, @@ -717,6 +761,29 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): self.assertEqual(args[0], [self.doc2.id]) self.assertEqual(kwargs["storage_path"], self.sp1.id) + @mock.patch("documents.serialisers.bulk_edit.set_storage_path") + def test_api_bulk_edit_with_all_true_excludes_documents(self, m) -> None: + self.setup_mock(m, "set_storage_path") + + response = self.client.post( + "/api/documents/bulk_edit/", + json.dumps( + { + "all": True, + "excluded_documents": [self.doc2.id, self.doc4.id], + "method": "set_storage_path", + "parameters": {"storage_path": self.sp1.id}, + }, + ), + content_type="application/json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + m.assert_called_once() + args, kwargs = m.call_args + self.assertCountEqual(args[0], [self.doc1.id, self.doc3.id, self.doc5.id]) + self.assertEqual(kwargs["storage_path"], self.sp1.id) + @mock.patch("documents.serialisers.bulk_edit.set_storage_path") def test_api_bulk_edit_with_all_true_resolves_owned_duplicates(self, m) -> None: self.setup_mock(m, "set_storage_path") diff --git a/src/documents/views.py b/src/documents/views.py index 7bee5b51f4..05d529a806 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -2926,6 +2926,9 @@ class DocumentSelectionMixin: ) if search_filtered_ids is not None: filtered_documents = filtered_documents.filter(pk__in=search_filtered_ids) + filtered_documents = filtered_documents.exclude( + pk__in=validated_data["excluded_documents"], + ) return list(filtered_documents.values_list("pk", flat=True)) @@ -3049,7 +3052,14 @@ class DocumentOperationPermissionMixin(PassUserMixin, DocumentSelectionMixin): parameters = { k: v for k, v in validated_data.items() - if k not in {"documents", "all", "filters", "from_webui"} + if k + not in { + "documents", + "all", + "filters", + "excluded_documents", + "from_webui", + } } user = self.request.user from_webui = validated_data.get("from_webui", False)