UN-1722 [FEAT] Add export reminder for Prompt Studio projects in use (#1547)

* UN-1722 [FEAT] Add export reminder for Prompt Studio projects in use

- Add backend API endpoint to check if project is used in deployments
- Implement frontend change tracking for prompt modifications
- Create yellow notification bar component with export action
- Track changes when editing, adding, or deleting prompts
- Clear notification after successful export
- Check usage in API Deployments, ETL/Task Pipelines, and Manual Review

This ensures users are reminded to export their Prompt Studio changes when
the project is actively being used in deployments, preventing confusion
about why changes don't take effect immediately.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: Remove trailing commas to fix Prettier/ESLint build errors

Removed 10 trailing commas from 4 files that were causing the Docker
build to fail with Prettier violations:
- DocumentParser.jsx: 3 locations (lines 86, 124, 179)
- Header.jsx: 3 locations (lines 73, 176, 277)
- ToolIde.jsx: 2 locations (lines 97, 223)
- custom-tool-store.js: 2 locations (lines 83, 106)

These changes ensure the code passes ESLint/Prettier checks during
the build process without modifying any functionality.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

* refactor: Fix CodeRabbit major issues - state carryover and useCallback pattern

Fixed two major issues identified by CodeRabbit review:

1. Fixed state carryover bug in custom-tool-store.js
   - When switching tools, deploymentUsageInfo and lastExportedAt now
     properly reset to null instead of carrying over from previous tool
   - Prevents incorrect export reminders showing for wrong projects

2. Fixed useCallback pattern issue in ToolIde.jsx
   - Replaced isCheckingUsage state in useCallback deps with useRef
   - Prevents unnecessary callback recreations and potential race conditions
   - Simplified useEffect dependencies to only depend on the callback
   - Removed unused isCheckingUsage state variable

These changes improve code quality and prevent potential bugs without
affecting functionality.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

* fix: Address all PR #1547 review comments from chandrasekharan-zipstack

This commit addresses all actionable review comments from the code reviewer:

## Backend Changes (views.py, constants.py, exceptions.py)

1. **Import Location Fix** ✅
   - Moved APIDeployment, Pipeline, and WorkflowEndpoint imports to top of file
   - Removed lazy imports from check_deployment_usage method
   - Follows Python best practices for import organization

2. **Deployment Type Enum** ✅
   - Created DeploymentType class in constants.py with deployment type constants
   - Updated check_deployment_usage to use DeploymentType constants
   - Replaced hardcoded strings: "API Deployment", "ETL Pipeline", etc.
   - Improves maintainability and prevents typos

3. **Error Handling** ✅
   - Created DeploymentUsageCheckError exception class
   - Changed check_deployment_usage to raise exception instead of returning error response
   - Provides better error handling and follows DRF exception patterns

4. **Function Naming** ✅
   - Renamed _check_tool_usage to _check_tool_usage_in_workflows
   - More explicit function name clarifies it checks workflow usage specifically
   - Updated all calls in destroy() and check_deployment_usage() methods

## Frontend Changes (ToolIde.jsx, CustomToolsHelper.js)

5. **Store State Race Condition Fix** ✅
   - Added explicit reset of hasUnsavedChanges, deploymentUsageInfo, lastExportedAt
   - Ensures fields don't carry over when switching between tools
   - Prevents incorrect export reminders showing for wrong projects

6. **Stale State Race Condition Fix** ✅
   - Added check for current hasUnsavedChanges state after API response
   - Prevents showing export reminder if user exported during in-flight check
   - Uses customToolStore.getState() to get real-time state value

## Not Addressed (Requires Discussion)

- Active filtering question: Needs product/architecture discussion
- UX enhancement for clickable links: May be future enhancement

All code quality and bug fix comments have been fully addressed.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

* fix: PR review comments

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: PR review comments

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* coderabbit fixes commit

* Fixes for export conditions

---------

Co-authored-by: Claude <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

backend/prompt_studio/prompt_studio_core_v2/constants.py

@@ -180,6 +180,15 @@ class IndexingConstants:
     RUN_ID = "run_id"
 
 
+class DeploymentType:
+    """Deployment types where Prompt Studio tools can be used."""
+
+    API_DEPLOYMENT = "API Deployment"
+    ETL_PIPELINE = "ETL Pipeline"
+    TASK_PIPELINE = "Task Pipeline"
+    HUMAN_QUALITY_REVIEW = "Human in the Loop"
+
+
 class DefaultValues:
     """Default values used throughout the prompt studio helper."""
 

backend/prompt_studio/prompt_studio_core_v2/exceptions.py

@@ -111,3 +111,8 @@ def __init__(self, detail: str | None = None, code: int | None = None):
         if code is not None:
             self.code = code
         super().__init__(detail, code)
+
+
+class DeploymentUsageCheckError(APIException):
+    status_code = 500
+    default_detail = "Failed to check deployment usage"

backend/prompt_studio/prompt_studio_core_v2/urls.py

@@ -55,6 +55,10 @@
     {"get": "export_project", "post": "import_project"}
 )
 
+prompt_studio_deployment_usage = PromptStudioCoreView.as_view(
+    {"get": "check_deployment_usage"}
+)
+
 
 urlpatterns = format_suffix_patterns(
     [
@@ -134,5 +138,10 @@
             prompt_studio_project_transfer,
             name="prompt_studio_project_transfer_import",
         ),
+        path(
+            "prompt-studio/<uuid:pk>/check_deployment_usage/",
+            prompt_studio_deployment_usage,
+            name="prompt_studio_deployment_usage",
+        ),
     ]
 )

backend/prompt_studio/prompt_studio_core_v2/views.py

@@ -5,12 +5,14 @@
 from typing import Any
 
 from account_v2.custom_exceptions import DuplicateData
+from api_v2.models import APIDeployment
 from django.db import IntegrityError
 from django.db.models import QuerySet
 from django.http import HttpRequest, HttpResponse
 from file_management.constants import FileInformationKey as FileKey
 from file_management.exceptions import FileNotFound
 from permissions.permission import IsOwner, IsOwnerOrSharedUserOrSharedToOrg
+from pipeline_v2.models import Pipeline
 from plugins import get_plugin
 from rest_framework import status, viewsets
 from rest_framework.decorators import action
@@ -21,6 +23,7 @@
 from utils.file_storage.helpers.prompt_studio_file_helper import PromptStudioFileHelper
 from utils.user_context import UserContext
 from utils.user_session import UserSessionUtils
+from workflow_manager.endpoint_v2.models import WorkflowEndpoint
 
 from prompt_studio.prompt_profile_manager_v2.constants import (
     ProfileManagerErrors,
@@ -29,6 +32,7 @@
 from prompt_studio.prompt_profile_manager_v2.models import ProfileManager
 from prompt_studio.prompt_profile_manager_v2.serializers import ProfileManagerSerializer
 from prompt_studio.prompt_studio_core_v2.constants import (
+    DeploymentType,
     FileViewTypes,
     ToolStudioErrors,
     ToolStudioPromptKeys,
@@ -37,6 +41,7 @@
     DocumentIndexingService,
 )
 from prompt_studio.prompt_studio_core_v2.exceptions import (
+    DeploymentUsageCheckError,
     IndexingAPIError,
     MaxProfilesReachedError,
     ToolDeleteError,
@@ -119,27 +124,105 @@ def perform_destroy(self, instance: CustomTool) -> None:
         organization_id = UserSessionUtils.get_organization_id(self.request)
         instance.delete(organization_id)
 
+    def _check_tool_usage_in_workflows(self, instance: CustomTool) -> tuple[bool, set]:
+        """Check if a tool is being used in any workflows.
+
+        Args:
+            instance: The CustomTool instance to check
+
+        Returns:
+            Tuple of (is_used: bool, dependent_workflows: set)
+        """
+        registry = getattr(instance, "prompt_studio_registries", None)
+        if not registry:
+            return False, set()
+
+        dependent_wfs = set(
+            ToolInstance.objects.filter(tool_id=registry.pk)
+            .values_list("workflow_id", flat=True)
+            .distinct()
+        )
+        return bool(dependent_wfs), dependent_wfs
+
+    def _get_deployment_types(self, workflow_ids: set) -> set:
+        """Get all deployment types where the tool is used.
+
+        Args:
+            workflow_ids: Set of workflow IDs to check
+
+        Returns:
+            Set of deployment type strings
+        """
+        deployment_types: set = set()
+
+        # Check API Deployments (include inactive to prevent drift)
+        if APIDeployment.objects.filter(workflow_id__in=workflow_ids).exists():
+            deployment_types.add(DeploymentType.API_DEPLOYMENT)
+
+        # Check Pipelines using mapping instead of if/elif
+        pipeline_type_mapping = {
+            Pipeline.PipelineType.ETL: DeploymentType.ETL_PIPELINE,
+            Pipeline.PipelineType.TASK: DeploymentType.TASK_PIPELINE,
+        }
+        pipelines = (
+            Pipeline.objects.filter(workflow_id__in=workflow_ids)
+            .values_list("pipeline_type", flat=True)
+            .distinct()
+        )
+        for pipeline_type in pipelines:
+            if pipeline_type in pipeline_type_mapping:
+                deployment_types.add(pipeline_type_mapping[pipeline_type])
+
+        # Check for Manual Review
+        if WorkflowEndpoint.objects.filter(
+            workflow_id__in=workflow_ids,
+            connection_type=WorkflowEndpoint.ConnectionType.MANUALREVIEW,
+        ).exists():
+            deployment_types.add(DeploymentType.HUMAN_QUALITY_REVIEW)
+
+        return deployment_types
+
+    def _format_deployment_types_message(self, deployment_types: set) -> str:
+        """Format deployment types into human-readable message.
+
+        Args:
+            deployment_types: Set of deployment type strings
+
+        Returns:
+            Formatted message string or empty string if no types
+        """
+        if not deployment_types:
+            return ""
+
+        types_list = sorted(deployment_types)
+        if len(types_list) == 1:
+            types_text = types_list[0]
+        elif len(types_list) == 2:
+            types_text = f"{types_list[0]} or {types_list[1]}"
+        else:
+            types_text = ", ".join(types_list[:-1]) + f", or {types_list[-1]}"
+
+        return (
+            f"You have made changes to this Prompt Studio project. "
+            f"This project is used in {types_text}. "
+            f"Please export it for the changes to take effect in the deployment(s)."
+        )
+
     def destroy(
         self, request: Request, *args: tuple[Any], **kwargs: dict[str, Any]
     ) -> Response:
         instance: CustomTool = self.get_object()
         # Checks if tool is exported
-        if hasattr(instance, "prompt_studio_registry"):
-            exported_tool_instances_in_use = ToolInstance.objects.filter(
-                tool_id__exact=instance.prompt_studio_registry.pk
+        is_used, dependent_wfs = self._check_tool_usage_in_workflows(instance)
+        if is_used:
+            logger.info(
+                f"Cannot destroy custom tool {instance.tool_id},"
+                f" depended by workflows {dependent_wfs}"
+            )
+            raise ToolDeleteError(
+                "Failed to delete Prompt Studio project; it's used in other workflows."
+                "Delete its usages first."
             )
-            dependent_wfs = set()
-            for tool_instance in exported_tool_instances_in_use:
-                dependent_wfs.add(tool_instance.workflow_id)
-            if len(dependent_wfs) > 0:
-                logger.info(
-                    f"Cannot destroy custom tool {instance.tool_id},"
-                    f" depended by workflows {dependent_wfs}"
-                )
-                raise ToolDeleteError(
-                    "Failed to delete tool, its used in other workflows. "
-                    "Delete its usages first"
-                )
         return super().destroy(request, *args, **kwargs)
 
     def partial_update(
@@ -569,9 +652,9 @@ def export_tool(self, request: Request, pk: Any = None) -> Response:
     def export_tool_info(self, request: Request, pk: Any = None) -> Response:
         custom_tool = self.get_object()
         serialized_instances = None
-        if hasattr(custom_tool, "prompt_studio_registry"):
+        if hasattr(custom_tool, "prompt_studio_registries"):
             serialized_instances = PromptStudioRegistryInfoSerializer(
-                custom_tool.prompt_studio_registry
+                custom_tool.prompt_studio_registries
             ).data
 
             return Response(serialized_instances)
@@ -672,3 +755,41 @@ def import_project(self, request: Request) -> Response:
                 {"error": "Failed to import project"},
                 status=status.HTTP_500_INTERNAL_SERVER_ERROR,
             )
+
+    @action(detail=True, methods=["get"])
+    def check_deployment_usage(self, request: Request, pk: Any = None) -> Response:
+        """Check if the Prompt Studio project is used in any deployments.
+
+        This endpoint checks if the exported tool from this project is being used in:
+        - API Deployments
+        - ETL Pipelines
+        - Task Pipelines
+        - Manual Review (Human Quality Review)
+
+        Returns:
+            Response: Contains is_used flag and deployment types where it's used
+        """
+        try:
+            instance: CustomTool = self.get_object()
+            is_used, workflow_ids = self._check_tool_usage_in_workflows(instance)
+
+            deployment_info: dict = {
+                "is_used": is_used,
+                "deployment_types": [],
+                "message": "",
+            }
+
+            if is_used and workflow_ids:
+                deployment_types = self._get_deployment_types(workflow_ids)
+                deployment_info["deployment_types"] = list(deployment_types)
+                deployment_info["message"] = self._format_deployment_types_message(
+                    deployment_types
+                )
+
+            return Response(deployment_info, status=status.HTTP_200_OK)
+
+        except Exception as e:
+            logger.error(f"Error checking deployment usage for tool {pk}: {e}")
+            raise DeploymentUsageCheckError(
+                detail=f"Failed to check deployment usage: {str(e)}"
+            )

frontend/src/components/custom-tools/document-parser/DocumentParser.jsx

@@ -116,6 +116,10 @@ function DocumentParser({
       }
     }
 
+    // Mark that changes have been made when any prompt field is modified
+    const { setHasUnsavedChanges } = useCustomToolStore.getState();
+    setHasUnsavedChanges(true);
+
     const index = promptsAndNotes.findIndex(
       (item) => item?.prompt_id === promptId
     );

frontend/src/components/custom-tools/export-reminder-bar/ExportReminderBar.css

@@ -0,0 +1,31 @@
+.export-reminder-bar {
+  position: sticky;
+  top: 0;
+  z-index: 100;
+  width: 100%;
+}
+
+.export-reminder-bar .ant-alert {
+  border-radius: 0;
+  border: none;
+  background-color: #fffbe6;
+  border-bottom: 1px solid #ffe58f;
+}
+
+.export-reminder-content {
+  width: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  gap: 12px;
+}
+
+.export-reminder-text {
+  flex: 1;
+  max-width: 800px;
+  text-align: left;
+}
+
+.export-reminder-button {
+  margin-left: auto;
+}

frontend/src/components/custom-tools/export-reminder-bar/ExportReminderBar.jsx

@@ -0,0 +1,43 @@
+import { ExclamationCircleOutlined } from "@ant-design/icons";
+import { Alert, Button, Space } from "antd";
+import PropTypes from "prop-types";
+import "./ExportReminderBar.css";
+
+function ExportReminderBar({ message, onExport, isExporting }) {
+  return (
+    <div className="export-reminder-bar">
+      <Alert
+        message={
+          <Space className="export-reminder-content">
+            <ExclamationCircleOutlined />
+            <span className="export-reminder-text">{message}</span>
+            <Button
+              type="primary"
+              size="small"
+              onClick={onExport}
+              loading={isExporting}
+              className="export-reminder-button"
+            >
+              Export Now
+            </Button>
+          </Space>
+        }
+        type="warning"
+        banner
+        closable={false}
+      />
+    </div>
+  );
+}
+
+ExportReminderBar.propTypes = {
+  message: PropTypes.string.isRequired,
+  onExport: PropTypes.func.isRequired,
+  isExporting: PropTypes.bool,
+};
+
+ExportReminderBar.defaultProps = {
+  isExporting: false,
+};
+
+export { ExportReminderBar };

frontend/src/components/custom-tools/header/Header.jsx

@@ -44,7 +44,8 @@ function Header({
   setOpenCloneModal,
 }) {
   const [isExportLoading, setIsExportLoading] = useState(false);
-  const { details, isPublicSource } = useCustomToolStore();
+  const { details, isPublicSource, markChangesAsExported } =
+    useCustomToolStore();
   const { sessionDetails } = useSessionStore();
   const { setAlertDetails } = useAlertStore();
   const axiosPrivate = useAxiosPrivate();
@@ -92,6 +93,8 @@ function Header({
           type: "success",
           content: "Custom tool exported successfully",
         });
+        // Clear the export reminder after successful export
+        markChangesAsExported();
       })
       .catch((err) => {
         if (err?.response?.data?.errors[0]?.code === "warning") {
@@ -117,7 +120,7 @@ function Header({
 
     handleExport(selectedUsers, toolDetail, isSharedWithEveryone, true);
     setConfirmModalVisible(false);
-  }, [lastExportParams]);
+  }, [lastExportParams, handleExport]);
 
   const handleShare = (isEdit) => {
     try {