Skip to content

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

Export custom tool fixes (#253)

Rahul Johnya6179fbce231
diff --git a/backend/prompt_studio/prompt_studio_core/views.py b/backend/prompt_studio/prompt_studio_core/views.py
index 036b31e8e..b3d01dd4a 100644
--- a/backend/prompt_studio/prompt_studio_core/views.py
+++ b/backend/prompt_studio/prompt_studio_core/views.py
@@ -481,4 +481,4 @@ class PromptStudioCoreView(viewsets.ModelViewSet):
return Response(serialized_instances)
else:
- return Response(status=status.HTTP_404_NOT_FOUND)
+ return Response(status=status.HTTP_204_NO_CONTENT)
diff --git a/backend/prompt_studio/prompt_studio_registry/prompt_studio_registry_helper.py b/backend/prompt_studio/prompt_studio_registry/prompt_studio_registry_helper.py
index bb6a85c4a..00d4addb9 100644
--- a/backend/prompt_studio/prompt_studio_registry/prompt_studio_registry_helper.py
+++ b/backend/prompt_studio/prompt_studio_registry/prompt_studio_registry_helper.py
@@ -139,9 +139,20 @@ class PromptStudioRegistryHelper:
logger.info(f"PSR {obj.prompt_registry_id} was created")
else:
logger.info(f"PSR {obj.prompt_registry_id} was updated")
+
obj.shared_to_org = shared_with_org
- obj.shared_users.clear()
- obj.shared_users.add(*user_ids)
+ if not shared_with_org:
+ obj.shared_users.clear()
+ obj.shared_users.add(*user_ids)
+ # add prompt studio users
+ # for shared_user in custom_tool.shared_users:
+ obj.shared_users.add(
+ *custom_tool.shared_users.all().values_list("id", flat=True)
+ )
+ # add prompt studio owner
+ obj.shared_users.add(custom_tool.created_by)
+ else:
+ obj.shared_users.clear()
obj.save()
return obj
except IntegrityError as error:
diff --git a/backend/prompt_studio/prompt_studio_registry/serializers.py b/backend/prompt_studio/prompt_studio_registry/serializers.py
index d0ab1bdb8..803f6776f 100644
--- a/backend/prompt_studio/prompt_studio_registry/serializers.py
+++ b/backend/prompt_studio/prompt_studio_registry/serializers.py
@@ -1,3 +1,5 @@
+from typing import Any
+
from account.serializer import UserSerializer
from rest_framework import serializers
@@ -14,10 +16,21 @@ class PromptStudioRegistrySerializer(AuditSerializer):
class PromptStudioRegistryInfoSerializer(AuditSerializer):
shared_users = UserSerializer(many=True)
+ prompt_studio_users = serializers.SerializerMethodField()
class Meta:
model = PromptStudioRegistry
- fields = ("name", "shared_users", "shared_to_org")
+ fields = (
+ "name",
+ "shared_users",
+ "shared_to_org",
+ "prompt_studio_users",
+ )
+
+ def get_prompt_studio_users(self, obj: PromptStudioRegistry) -> Any:
+
+ prompt_studio_users = obj.custom_tool.shared_users
+ return UserSerializer(prompt_studio_users, many=True).data
class ExportToolRequestSerializer(serializers.Serializer):
diff --git a/frontend/src/components/custom-tools/export-tool/ExportTool.css b/frontend/src/components/custom-tools/export-tool/ExportTool.css
new file mode 100644
index 000000000..2c39ef599
--- /dev/null
+++ b/frontend/src/components/custom-tools/export-tool/ExportTool.css
@@ -0,0 +1,16 @@
+.shared-user-avatar {
+ background-color: #00a6ed;
+ margin-right: 15px;
+}
+
+.export-username {
+ font-weight: 500;
+}
+
+.export-permission-search {
+ width: 100%;
+}
+
+.export-per-radio {
+ margin: 10px 5px;
+}
diff --git a/frontend/src/components/custom-tools/export-tool/ExportTool.jsx b/frontend/src/components/custom-tools/export-tool/ExportTool.jsx
new file mode 100644
index 000000000..f5574f193
--- /dev/null
+++ b/frontend/src/components/custom-tools/export-tool/ExportTool.jsx
@@ -0,0 +1,230 @@
+import {
+ DeleteOutlined,
+ QuestionCircleOutlined,
+ UserOutlined,
+} from "@ant-design/icons";
+import {
+ Avatar,
+ List,
+ Modal,
+ Popconfirm,
+ Radio,
+ Select,
+ Typography,
+} from "antd";
+import PropTypes from "prop-types";
+import { useEffect, useState } from "react";
+import "./ExportTool.css";
+
+import { SpinnerLoader } from "../../widgets/spinner-loader/SpinnerLoader";
+
+const SHARE_ALL = "share_all";
+const SHARE_CUSTOM = "share_custom";
+
+function ExportTool({
+ open,
+ setOpen,
+ toolDetails,
+ loading,
+ allUsers,
+ onApply,
+}) {
+ const [selectedUsers, setSelectedUsers] = useState([]);
+ const [filteredUserList, setFilteredUserList] = useState([]);
+ const [sharingOption, setSharingOption] = useState(SHARE_ALL);
+
+ useEffect(() => {
+ const createdByUserId = toolDetails?.created_by?.toString();
+ if (!toolDetails?.shared_users) {
+ const filteredUsers = allUsers.filter((user) => {
+ const userId = user?.id?.toString();
+ return !selectedUsers.includes(userId) && createdByUserId !== userId;
+ });
+ setFilteredUserList(filteredUsers);
+ return;
+ }
+
+ const promptStudioUsers = toolDetails?.prompt_studio_users?.map((user) =>
+ user?.id?.toString()
+ );
+
+ const filteredUsers = allUsers.filter((user) => {
+ const userId = user?.id?.toString();
+ return (
+ !selectedUsers.includes(userId) &&
+ !promptStudioUsers.includes(userId) &&
+ createdByUserId !== userId
+ );
+ });
+ setFilteredUserList(filteredUsers);
+ setSharingOption(toolDetails.shared_to_org ? SHARE_ALL : SHARE_CUSTOM);
+ }, [toolDetails, allUsers, selectedUsers]);
+
+ useEffect(() => {
+ if (!toolDetails?.shared_users) {
+ return;
+ }
+ const createdByUserId = toolDetails?.created_by?.toString();
+ const promptStudioUsers = toolDetails?.prompt_studio_users?.map((user) =>
+ user?.id?.toString()
+ );
+ setSelectedUsers(
+ toolDetails.shared_users
+ .filter((user) => {
+ const userId = user?.id?.toString();
+ return (
+ !promptStudioUsers.includes(userId) && createdByUserId !== userId
+ );
+ })
+ .map((user) => user?.id?.toString())
+ );
+ }, []);
+
+ const handleDeleteUser = (userId) => {
+ setSelectedUsers((prevSelectedUsers) =>
+ prevSelectedUsers.filter((user) => user !== userId)
+ );
+ };
+ const filterOption = (input, option) =>
+ (option?.label ?? "").toLowerCase().includes(input.toLowerCase());
+
+ const onChange = (e) => {
+ setSharingOption(e.target.value);
+ };
+
+ const shareWithUsers = () => {
+ if (sharingOption === SHARE_ALL) {
+ return <Typography.Text>Shared with everyone</Typography.Text>;
+ }
+ return (
+ <>
+ <List
+ dataSource={selectedUsers.map((userId) => {
+ const user = allUsers.find(
+ (u) => u?.id.toString() === userId.toString()
+ );
+ return {
+ id: user?.id,
+ email: user?.email,
+ };
+ })}
+ renderItem={(item) => (
+ <List.Item
+ extra={
+ <div onClick={(event) => event.stopPropagation()} role="none">
+ <Popconfirm
+ key={`${item?.id}-delete`}
+ title="Delete the User"
+ description={`Are you sure to remove ${item?.email}?`}
+ okText="Yes"
+ cancelText="No"
+ icon={<QuestionCircleOutlined />}
+ onConfirm={(event) => handleDeleteUser(item?.id)}
+ >
+ <Typography.Text>
+ <DeleteOutlined className="action-icon-buttons" />
+ </Typography.Text>
+ </Popconfirm>
+ </div>
+ }
+ >
+ <List.Item.Meta
+ title={
+ <>
+ <Avatar
+ className="shared-user-avatar"
+ icon={<UserOutlined />}
+ />
+ <Typography.Text className="export-username">
+ {item?.email}
+ </Typography.Text>
+ </>
+ }
+ />
+ </List.Item>
+ )}
+ />
+ <Typography>
+ Exported Tools are always shared with the Prompt Studio projects owner
+ and users in addition to other users it is explicitly shared with
+ </Typography>
+ </>
+ );
+ };
+
+ return (
+ toolDetails && (
+ <Modal
+ title={"Export settings"}
+ open={open}
+ onCancel={() => setOpen(false)}
+ maskClosable={false}
+ centered
+ closable={true}
+ okText={"Apply"}
+ onOk={() =>
+ onApply(selectedUsers, toolDetails, sharingOption === SHARE_ALL)
+ }
+ className="share-permission-modal"
+ >
+ {loading ? (
+ <SpinnerLoader />
+ ) : (
+ <>
+ {allUsers.length > 1 && (
+ <Radio.Group
+ onChange={onChange}
+ value={sharingOption}
+ className="export-per-radio"
+ >
+ <Radio value={SHARE_ALL}>Share with everyone</Radio>
+ <Radio value={SHARE_CUSTOM}>Custom share</Radio>
+ </Radio.Group>
+ )}
+ {sharingOption !== SHARE_ALL && (
+ <Select
+ filterOption={filterOption}
+ showSearch
+ size={"middle"}
+ placeholder="Search"
+ className="export-permission-search"
+ onChange={(selectedUser) => {
+ const isUserSelected = selectedUsers.includes(selectedUser);
+ if (!isUserSelected) {
+ setSelectedUsers([...selectedUsers, selectedUser]);
+ }
+ }}
+ options={filteredUserList.map((user) => ({
+ label: user?.email,
+ value: user?.id,
+ }))}
+ value={null} // null value needed here so that value wont get populated in input
+ >
+ {filteredUserList.map((user) => {
+ return (
+ <Select.Option key={user?.id} value={user?.id}>
+ {user?.email}
+ </Select.Option>
+ );
+ })}
+ </Select>
+ )}
+ <Typography.Title level={5}>Shared with</Typography.Title>
+ {shareWithUsers()}
+ </>
+ )}
+ </Modal>
+ )
+ );
+}
+
+ExportTool.propTypes = {
+ open: PropTypes.bool.isRequired,
+ setOpen: PropTypes.func.isRequired,
+ toolDetails: PropTypes.object,
+ loading: PropTypes.bool,
+ allUsers: PropTypes.array,
+ onApply: PropTypes.func,
+};
+
+export { ExportTool };
diff --git a/frontend/src/components/custom-tools/header/Header.jsx b/frontend/src/components/custom-tools/header/Header.jsx
index 78372d333..259f1ede9 100644
--- a/frontend/src/components/custom-tools/header/Header.jsx
+++ b/frontend/src/components/custom-tools/header/Header.jsx
@@ -16,7 +16,7 @@ import { useAlertStore } from "../../../store/alert-store";
import { useCustomToolStore } from "../../../store/custom-tool-store";
import { useSessionStore } from "../../../store/session-store";
import { CustomButton } from "../../widgets/custom-button/CustomButton";
-import { SharePermission } from "../../widgets/share-permission/SharePermission";
+import { ExportTool } from "../export-tool/ExportTool";
let SinglePassToggleSwitch;
try {
@@ -34,8 +34,7 @@ function Header({ setOpenSettings, handleUpdateTool }) {
const navigate = useNavigate();
const handleException = useExceptionHandler();
const [userList, setUserList] = useState([]);
- const [openSharePermissionModal, setOpenSharePermissionModal] =
- useState(false);
+ const [openExportToolModal, setOpenExportToolModal] = useState(false);
const [toolDetails, setToolDetails] = useState(null);
@@ -66,7 +65,7 @@ function Header({ setOpenSettings, handleUpdateTool }) {
})
.finally(() => {
setIsExportLoading(false);
- setOpenSharePermissionModal(false);
+ setOpenExportToolModal(false);
});
};
@@ -85,17 +84,11 @@ function Header({ setOpenSettings, handleUpdateTool }) {
} else {
axiosPrivate(requestOptions)
.then((res) => {
- setOpenSharePermissionModal(true);
+ setOpenExportToolModal(true);
setToolDetails({ ...res?.data, created_by: details?.created_by });
})
.catch((err) => {
- if (err?.response?.status === 404) {
- setToolDetails(details);
- setOpenSharePermissionModal(true);
- setAlertDetails(handleException(err, "Tool not exported yet"));
- } else {
- setAlertDetails(handleException(err));
- }
+ setAlertDetails(handleException(err));
})
.finally(() => {
setIsExportLoading(false);
@@ -175,15 +168,13 @@ function Header({ setOpenSettings, handleUpdateTool }) {
</CustomButton>
</Tooltip>
</div>
- <SharePermission
+ <ExportTool
allUsers={userList}
- open={openSharePermissionModal}
- setOpen={setOpenSharePermissionModal}
+ open={openExportToolModal}
+ setOpen={setOpenExportToolModal}
onApply={handleExport}
loading={isExportLoading}
- adapter={toolDetails}
- permissionEdit={true}
- isSharableToOrg={true}
+ toolDetails={toolDetails}
/>
</div>
</div>