Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

UN-3598 [FIX] Block deleting an adapter still used by a workflow tool instance (#2084)

Chandrasekharan M49ef65a1b8a5
diff --git a/backend/adapter_processor_v2/tests/test_adapter_in_use.py b/backend/adapter_processor_v2/tests/test_adapter_in_use.py
new file mode 100644
index 000000000..0bae3f200
--- /dev/null
+++ b/backend/adapter_processor_v2/tests/test_adapter_in_use.py
@@ -0,0 +1,78 @@
+"""Adapter delete guard (UN-3598).
+
+An adapter referenced by a workflow tool instance's ``metadata`` is held as
+a plain JSON value, not an FK — the DB can't PROTECT it, so the view must
+block the delete explicitly. These tests exercise that scan logic with the
+ORM query mocked, so no test database is required.
+"""
+
+from __future__ import annotations
+
+import os
+from types import SimpleNamespace
+from unittest.mock import MagicMock, patch
+
+import django
+from django.apps import apps
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings.test")
+if not apps.ready:
+ django.setup()
+
+from adapter_processor_v2.views import AdapterInstanceViewSet # noqa: E402
+
+ADAPTER_ID = "11111111-1111-1111-1111-111111111111"
+
+
+def _adapter(adapter_id: str = ADAPTER_ID, name: str = "my-llm") -> SimpleNamespace:
+ return SimpleNamespace(id=adapter_id, adapter_name=name, organization="org-1")
+
+
+def _patch_metadatas(metadatas: list):
+ """Stub ``ToolInstance.objects.filter(...).values_list(...)`` -> metadatas."""
+ qs = MagicMock()
+ qs.values_list.return_value = metadatas
+ manager = MagicMock()
+ manager.filter.return_value = qs
+ return patch("adapter_processor_v2.views.ToolInstance.objects", manager)
+
+
+def test_blocks_when_adapter_id_in_metadata():
+ ad = _adapter()
+ with _patch_metadatas([{"llmAdapterId": ADAPTER_ID, "chunkSize": 1024}]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is True
+
+
+def test_blocks_when_adapter_name_in_metadata_pre_migration():
+ # Before lazy migration, metadata holds the adapter NAME, not the id.
+ ad = _adapter(name="prod-gpt4")
+ with _patch_metadatas([{"llm": "prod-gpt4"}]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is True
+
+
+def test_allows_when_unreferenced():
+ ad = _adapter()
+ with _patch_metadatas([{"llm": "some-other-adapter"}, {}]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is False
+
+
+def test_ignores_empty_and_non_string_metadata_values():
+ ad = _adapter()
+ with _patch_metadatas([None, {}, {"chunkSize": 1024, "flag": True}]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is False
+
+
+def test_blocks_when_adapter_id_nested_in_metadata():
+ ad = _adapter()
+ with _patch_metadatas([{"tool_settings": {"llmAdapterId": ADAPTER_ID}}]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is True
+
+
+def test_handles_non_dict_metadata_without_error():
+ # JSONField has no schema constraint, so corrupted/historical rows may hold
+ # a list or scalar; the scan must not raise on them.
+ ad = _adapter()
+ with _patch_metadatas([[ADAPTER_ID], "some-string", 42]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is True
+ with _patch_metadatas([["other"], "unrelated", 42]):
+ assert AdapterInstanceViewSet._adapter_used_in_tool_instance(ad) is False
diff --git a/backend/adapter_processor_v2/views.py b/backend/adapter_processor_v2/views.py
index fa346fd43..4cfee77d0 100644
--- a/backend/adapter_processor_v2/views.py
+++ b/backend/adapter_processor_v2/views.py
@@ -22,6 +22,7 @@ from rest_framework.serializers import ModelSerializer
from rest_framework.versioning import URLPathVersioning
from rest_framework.viewsets import GenericViewSet, ModelViewSet
from tenant_account_v2.organization_member_service import OrganizationMemberService
+from tool_instance_v2.models import ToolInstance
from utils.filtering import FilterHelper
from adapter_processor_v2.adapter_processor import AdapterProcessor
@@ -244,6 +245,33 @@ class AdapterInstanceViewSet(ResourceShareManagementMixin, ModelViewSet):
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
+ @staticmethod
+ def _adapter_used_in_tool_instance(adapter: AdapterInstance) -> bool:
+ """True if any workflow tool instance in the adapter's org references
+ it via metadata. These refs are JSON values (post lazy-migration the
+ adapter id; before it, the adapter name), so no FK protects them.
+ """
+ needles = {str(adapter.id), adapter.adapter_name}
+
+ # metadata is free-form JSON: walk every nested value so a reference
+ # nested in a sub-object isn't missed, and tolerate non-dict payloads
+ # (list/scalar/None) that would otherwise blow up on .values().
+ def contains_ref(value: Any) -> bool:
+ if isinstance(value, str):
+ return value in needles
+ if isinstance(value, dict):
+ return any(contains_ref(v) for v in value.values())
+ if isinstance(value, list):
+ return any(contains_ref(v) for v in value)
+ return False
+
+ # Linear scan over the org's tool instances — acceptable for an
+ # infrequent, interactive delete.
+ metadatas = ToolInstance.objects.filter(
+ workflow__organization=adapter.organization
+ ).values_list("metadata", flat=True)
+ return any(contains_ref(metadata) for metadata in metadatas)
+
def destroy(
self, request: Request, *args: tuple[Any], **kwargs: dict[str, Any]
) -> Response:
@@ -281,6 +309,16 @@ class AdapterInstanceViewSet(ResourceShareManagementMixin, ModelViewSet):
# We can go head and remove adapter here
logger.info("User default adpater doesnt not exist")
+ # Adapter refs inside ToolInstance.metadata are JSON values, not FKs,
+ # so the DB can't PROTECT them — block here to avoid leaving dangling
+ # references. (FK uses are caught by ProtectedError below.)
+ if self._adapter_used_in_tool_instance(adapter_instance):
+ logger.error(
+ f"Cannot delete adapter {adapter_instance.adapter_id}"
+ " — referenced by a workflow tool instance"
+ )
+ raise DeleteAdapterInUseError(adapter_name=adapter_instance.adapter_name)
+
try:
super().perform_destroy(adapter_instance)
except ProtectedError: