rasa-pro 3.11.5__py3-none-any.whl → 3.12.0__py3-none-any.whl

rasa/core/channels/inspector/src/App.tsx

@@ -13,6 +13,7 @@ import { DialogueStack } from "./components/DialogueStack";
 import { DialougeInformation } from "./components/DialogueInformation";
 import { LoadingSpinner } from "./components/LoadingSpinner";
 import { DiagramFlow } from "./components/DiagramFlow";
+import { RecruitmentPanel } from "./components/RecruitmentPanel";
 import { formatSlots } from "./helpers/formatters";
 import { Slot, Stack, Event, Flow, SelectedStack, Tracker } from "./types";
 import {
@@ -35,6 +36,9 @@ export function App() {
   const [stack, setStack] = useState<Stack[]>([]);
   const [frame, setFrame] = useState<SelectedStack | undefined>(undefined);
 
+  // State to control the visibility of the RecruitmentPanel
+  const [showRecruitmentPanel, setShowRecruitmentPanel] = useState(true);
+
   // we only show the transcript if we are not on the socket io channel
   // on the socketio channel, we show the chat component instead
   const shouldShowTranscript = !window.location.href.includes("socketio");
@@ -165,7 +169,9 @@ export function App() {
     height: "100%",
     overflow: "hidden",
     gridTemplateColumns: "1fr",
-    gridTemplateRows: "max-content minmax(10rem, 17.5rem) minmax(10rem, auto)",
+    gridTemplateRows: showRecruitmentPanel
+      ? "max-content max-content minmax(10rem, auto)"
+      : "max-content minmax(10rem, 17.5rem) minmax(10rem, auto)",
     gridRowGap: rasaSpace[1],
   };
 
@@ -177,13 +183,20 @@ export function App() {
     });
   };
 
+  const handleCloseRecruitmentPanel = () => {
+    setShowRecruitmentPanel(false);
+  };
+
   if (!rasaChatSessionId && !window.location.href.includes("socketio")) return <LoadingSpinner />;
 
   return (
     <Grid sx={gridSx}>
       <GridItem overflow="hidden">
         <Grid sx={leftColumnSx}>
-          <Welcome sx={boxSx} />
+          <Welcome sx={boxSx} isRecruitmentVisible={showRecruitmentPanel} />
+          {showRecruitmentPanel && (
+            <RecruitmentPanel onClose={handleCloseRecruitmentPanel} />
+          )}
           <DialogueStack
             sx={boxSx}
             stack={stack}

rasa/core/channels/inspector/src/components/RasaLogo.tsx

@@ -30,3 +30,34 @@ export const RasaLogo = (props: BoxProps) => {
     </Box>
   );
 };
+
+export const RasaLogoDark = (props: BoxProps) => {
+  return (
+    <Box
+      as="svg"
+      {...props}
+      xmlns="http://www.w3.org/2000/svg"
+      width="41"
+      height="51"
+      fill="none"
+      viewBox="0 0 41 51"
+    >
+      <path
+        fill="#7622D2"
+        fillRule="evenodd"
+        d="M34.041 10.59V7.508H21.385v12.847h3.037v-3.867h6.582v3.854h3.037v-9.763.013zm-3.037 2.827h-6.582V10.59h6.582v2.826zM19.36 29.74V35.52H6.956v-3.083h9.366V30.64H6.956v-7.965H19.36v3.083H9.994v1.798h9.366v2.184zM34.041 25.75v-3.084H21.385v12.847h3.037v-3.867h6.582V35.5h3.037v-9.764.013zm-3.037 2.826h-6.582v-2.827h6.582v2.827z"
+        clipRule="evenodd"
+      ></path>
+      <path
+        fill="#7622D2"
+        d="M36.826 4.689v33.578h-5.248v5.724l-9.487-5.318-.744-.417H4.179V4.69h32.654-.007zm3.298-3.34H.881v40.258h19.618l14.368 8.054v-8.054h5.25V1.349h.007z"
+      ></path>
+      <path
+        fill="#7622D2"
+        fillRule="evenodd"
+        d="M15.287 15.464l3.888-1.436.185-.074V7.515H6.956v.257l-.028 12.59h3.038V17.43l2.278-.838 3.417 3.77h3.752l-4.126-4.897zM9.97 14.15v-3.55h6.351V11.8l-6.351 2.348z"
+        clipRule="evenodd"
+      ></path>
+    </Box>
+  );
+};

rasa/core/channels/inspector/src/components/RecruitmentPanel.tsx

@@ -0,0 +1,68 @@
+// RecruitmentPanel.tsx
+import {
+    Box,
+    Flex,
+    Heading,
+    IconButton,
+    Text,
+    Button,
+} from "@chakra-ui/react";
+import { CloseIcon } from "@chakra-ui/icons";
+import { useOurTheme } from "../theme";
+
+interface RecruitmentPanelProps {
+    onClose: () => void;
+}
+
+export const RecruitmentPanel: React.FC<RecruitmentPanelProps> = ({ onClose }) => {
+    const { rasaRadii } = useOurTheme();
+
+    const textColor = "white";
+    const iconColor = "white";
+
+    const boxSx = {
+        borderRadius: rasaRadii.normal,
+        padding: "1rem",
+        bgGradient: "linear(to-b, #4E61E1, #7622D2)",
+        color: textColor,
+    };
+
+    return (
+        <Box sx={boxSx}>
+            <Flex justify="space-between" align="center">
+                <Flex align="center">
+                    <Heading as="h3" size="lg" fontWeight="bold" color={textColor}>
+                        Help us Improve Rasa Pro!
+                    </Heading>
+                </Flex>
+                <IconButton
+                    aria-label="Close"
+                    icon={<CloseIcon color={iconColor} />}
+                    size="sm"
+                    onClick={onClose}
+                    bg="transparent"
+                    _hover={{ bg: "rgba(255, 255, 255, 0.2)" }}
+                />
+            </Flex>
+            <Flex align="center" mt="0.5rem" justify="space-between">
+                <Text fontSize="sm" color={textColor}>
+                    We're looking for users to share their feedback.
+                </Text>
+                <Button
+                    as="a"
+                    href="https://calendly.com/alvaro-rasa/rasa-pro-installation"
+                    target="_blank"
+                    rel="noopener noreferrer"
+                    color="#7622D2"
+                    bg="white"
+                    fontWeight="bold"
+                    ml="1rem"
+                    size="sm"
+                    _hover={{ bg: "whiteAlpha.800" }}
+                >
+                    Sign up
+                </Button>
+            </Flex>
+        </Box>
+    );
+};

rasa/core/channels/inspector/src/components/Welcome.tsx

@@ -5,33 +5,35 @@ import {
   Heading,
   Link,
   Text,
-  useColorModeValue,
 } from "@chakra-ui/react";
-import { RasaLogo } from "./RasaLogo";
+import { RasaLogo, RasaLogoDark } from "./RasaLogo";
 import { useOurTheme } from "../theme";
 
-export const Welcome = ({ sx, ...props }: FlexProps) => {
+interface WelcomeProps extends FlexProps {
+  isRecruitmentVisible?: boolean;
+}
+
+export const Welcome = ({ sx, isRecruitmentVisible, ...props }: WelcomeProps) => {
   const { rasaSpace } = useOurTheme();
 
   const containerSx = {
     ...sx,
-    color: useColorModeValue("neutral.50", "neutral.50"),
-    bgGradient: "linear(to-b, #4E61E1, #7622D2)",
+    color: isRecruitmentVisible ? "black" : "neutral.50",
+    bg: isRecruitmentVisible ? "white" : undefined,
+    bgGradient: isRecruitmentVisible ? undefined : "linear(to-b, #4E61E1, #7622D2)",
   };
 
   const linkSx = {
     flexGrow: 0,
-    color: useColorModeValue("neutral.50", "neutral.50"),
+    color: isRecruitmentVisible ? "#0000EE" : "neutral.50",
+    textDecoration: "underline",
     _hover: {
-      color: useColorModeValue("neutral.400", "neutral.400"),
+      color: isRecruitmentVisible 
+        ? "link.visited" 
+        : "neutral.400",
     },
   };
 
-  const logoSx = {
-    flexShrink:0,
-    marginLeft: "auto"
-  };
-
   return (
     <Flex sx={containerSx} {...props}>
       <Box>
@@ -48,7 +50,11 @@ export const Welcome = ({ sx, ...props }: FlexProps) => {
           ml={rasaSpace[0.25]}
         >Browse the docs</Link>
       </Box>
-      <RasaLogo sx={logoSx}/>
+      {isRecruitmentVisible ? (
+        <RasaLogoDark sx={{ flexShrink: 0, marginLeft: "auto" }}/>
+      ) : (
+        <RasaLogo sx={{ flexShrink: 0, marginLeft: "auto" }}/>
+      )}
     </Flex>
   );
 };

rasa/core/channels/inspector/yarn.lock

@@ -531,6 +531,11 @@
   dependencies:
     "@chakra-ui/shared-utils" "2.0.5"
 
+"@chakra-ui/icons@^2.2.4":
+  version "2.2.4"
+  resolved "https://registry.yarnpkg.com/@chakra-ui/icons/-/icons-2.2.4.tgz#fc3f59a7e377d6e4efdbe8ee0a3aec7f29a4ab32"
+  integrity sha512-l5QdBgwrAg3Sc2BRqtNkJpfuLw/pWRDwwT58J6c4PqQT6wzXxyNa8Q0PForu1ltB5qEiFb1kxr/F/HO1EwNa6g==
+
 "@chakra-ui/image@2.1.0":
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/@chakra-ui/image/-/image-2.1.0.tgz#6c205f1ca148e3bf58345b0b5d4eb3d959eb9f87"

rasa/core/channels/mattermost.py

@@ -1,15 +1,15 @@
 import json
-
 import logging
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Text
+
 import requests
 from requests import Response
 from sanic import Blueprint, response
 from sanic.request import Request
-from typing import Text, Dict, Any, List, Callable, Awaitable, Optional
-
-from rasa.core.channels.channel import UserMessage, OutputChannel, InputChannel
 from sanic.response import HTTPResponse
 
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+
 logger = logging.getLogger(__name__)
 
 

rasa/core/channels/rasa_chat.py

@@ -1,17 +1,17 @@
 import json
-from typing import Text, Optional, Dict, Any
+import logging
+from typing import Any, Dict, Optional, Text
 
 import aiohttp
-import logging
-from sanic.exceptions import SanicException
 import jwt
 import jwt.exceptions
+from sanic.exceptions import SanicException
+from sanic.request import Request
 
 import rasa.core.channels.channel
 from rasa.core.channels.channel import InputChannel
 from rasa.core.channels.rest import RestInput
 from rasa.core.constants import DEFAULT_REQUEST_TIMEOUT
-from sanic.request import Request
 
 logger = logging.getLogger(__name__)
 

rasa/core/channels/rest.py

@@ -3,32 +3,31 @@ import copy
 import inspect
 import json
 import logging
+from asyncio import CancelledError, Queue
 from functools import partial
-
-import structlog
-from asyncio import Queue, CancelledError
-from sanic import Blueprint, response
-from sanic.request import Request
 from typing import (
-    Text,
-    Dict,
     Any,
-    Optional,
-    Callable,
     Awaitable,
+    Callable,
+    Dict,
     NoReturn,
+    Optional,
+    Text,
     Union,
 )
-from sanic.response import HTTPResponse, ResponseStream, BaseHTTPResponse
+
+import structlog
+from sanic import Blueprint, response
+from sanic.request import Request
+from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream
 
 import rasa.utils.endpoints
 from rasa.core.channels.channel import (
-    InputChannel,
     CollectingOutputChannel,
+    InputChannel,
     UserMessage,
 )
 
-
 logger = logging.getLogger(__name__)
 structlogger = structlog.get_logger()
 

rasa/core/channels/rocketchat.py

@@ -1,11 +1,12 @@
 import logging
+from typing import Any, Awaitable, Callable, Dict, Iterable, List, Optional, Text
+
 from sanic import Blueprint, response
 from sanic.request import Request
-from typing import Text, Dict, Any, List, Iterable, Optional, Callable, Awaitable
-
-from rasa.core.channels.channel import UserMessage, OutputChannel, InputChannel
 from sanic.response import HTTPResponse
 
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+
 logger = logging.getLogger(__name__)
 
 

rasa/core/channels/slack.py

@@ -1,22 +1,23 @@
 import asyncio
 import hashlib
 import hmac
-from http import HTTPStatus
 import json
 import logging
 import re
 import time
+from http import HTTPStatus
 from typing import Any, Awaitable, Callable, Dict, List, Optional, Set, Text
 
-from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
-from rasa.shared.constants import DOCS_URL_CONNECTORS_SLACK
-from rasa.shared.exceptions import InvalidConfigException
-import rasa.shared.utils.io
 from sanic import Blueprint, response
 from sanic.request import Request
 from sanic.response import HTTPResponse
 from slack_sdk.web.async_client import AsyncWebClient
 
+import rasa.shared.utils.io
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+from rasa.shared.constants import DOCS_URL_CONNECTORS_SLACK
+from rasa.shared.exceptions import InvalidConfigException
+
 logger = logging.getLogger(__name__)
 
 

rasa/core/channels/socketio.py

@@ -1,17 +1,18 @@
 import inspect
+import json
 import logging
 import uuid
-import json
 from typing import Any, Awaitable, Callable, Dict, Iterable, List, Optional, Text
 
-import rasa.core.channels.channel
-from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
-import rasa.shared.utils.io
-from sanic import Blueprint, response, Sanic
+from sanic import Blueprint, Sanic, response
 from sanic.request import Request
 from sanic.response import HTTPResponse
 from socketio import AsyncServer
 
+import rasa.core.channels.channel
+import rasa.shared.utils.io
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+
 logger = logging.getLogger(__name__)
 
 
@@ -54,31 +55,9 @@ class SocketIOOutput(OutputChannel):
         super().__init__()
         self.sio = sio
         self.bot_message_evt = bot_message_evt
-        self.last_event_timestamp = (
-            -1
-        )  # Initialize with -1 to send all events on first message
-
-    def _get_new_events(self) -> List[Dict[Text, Any]]:
-        """Get events that are newer than the last sent event."""
-        events = self.tracker_state.get("events", []) if self.tracker_state else []
-        new_events = [
-            event for event in events if event["timestamp"] > self.last_event_timestamp
-        ]
-        if new_events:
-            self.last_event_timestamp = new_events[-1]["timestamp"]
-        return new_events
 
     async def _send_message(self, socket_id: Text, response: Any) -> None:
         """Sends a message to the recipient using the bot event."""
-        # send tracker state (contains stack, slots and more)
-        await self.sio.emit("tracker_state", self.tracker_state, room=socket_id)
-
-        # send new events
-        new_events = self._get_new_events()
-        if new_events:
-            await self.sio.emit("rasa_events", new_events, room=socket_id)
-
-        # send bot response
         await self.sio.emit(self.bot_message_evt, response, room=socket_id)
 
     async def send_text_message(
@@ -214,7 +193,7 @@ class SocketIOInput(InputChannel):
 
     def blueprint(
         self, on_new_message: Callable[[UserMessage], Awaitable[Any]]
-    ) -> Blueprint:
+    ) -> SocketBlueprint:
         """Defines a Sanic blueprint."""
         # Workaround so that socketio works with requests from other origins.
         # https://github.com/miguelgrinberg/python-socketio/issues/205#issuecomment-493769183
@@ -289,6 +268,7 @@ class SocketIOInput(InputChannel):
             metadata = data.get(self.metadata_key, {})
             if isinstance(metadata, Text):
                 metadata = json.loads(metadata)
+
             message = UserMessage(
                 data.get("message", ""),
                 output_channel,

rasa/core/channels/studio_chat.py

@@ -0,0 +1,212 @@
+import asyncio
+import json
+from functools import partial
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Awaitable,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Text,
+)
+
+import structlog
+from sanic import Sanic
+
+from rasa.core.channels.socketio import SocketBlueprint, SocketIOInput
+from rasa.hooks import hookimpl
+from rasa.plugin import plugin_manager
+from rasa.shared.core.constants import ACTION_LISTEN_NAME
+from rasa.shared.core.events import ActionExecuted
+from rasa.shared.core.trackers import EventVerbosity
+
+if TYPE_CHECKING:
+    from rasa.core.channels.channel import UserMessage
+    from rasa.shared.core.trackers import DialogueStateTracker
+
+
+structlogger = structlog.get_logger()
+
+
+def tracker_as_dump(tracker: "DialogueStateTracker") -> str:
+    """Create a dump of the tracker state."""
+    from rasa.shared.core.trackers import get_trackers_for_conversation_sessions
+
+    multiple_tracker_sessions = get_trackers_for_conversation_sessions(tracker)
+
+    if 0 <= len(multiple_tracker_sessions) <= 1:
+        last_tracker = tracker
+    else:
+        last_tracker = multiple_tracker_sessions[-1]
+
+    state = last_tracker.current_state(EventVerbosity.AFTER_RESTART)
+    return json.dumps(state)
+
+
+def does_need_action_prediction(tracker: "DialogueStateTracker") -> bool:
+    """Check if the tracker needs an action prediction."""
+    return (
+        len(tracker.events) == 0
+        or not isinstance(tracker.events[-1], ActionExecuted)
+        or tracker.events[-1].action_name != ACTION_LISTEN_NAME
+    )
+
+
+class StudioTrackerUpdatePlugin:
+    """Plugin for publishing tracker updates a socketio channel."""
+
+    def __init__(self, socket_channel: "StudioChatInput") -> None:
+        self.socket_channel = socket_channel
+        self.tasks: List[asyncio.Task] = []
+
+    def _cancel_tasks(self) -> None:
+        """Cancel all remaining tasks."""
+        for task in self.tasks:
+            task.cancel()
+        self.tasks = []
+
+    def _cleanup_tasks(self) -> None:
+        """Remove tasks that have already completed."""
+        self.tasks = [task for task in self.tasks if not task.done()]
+
+    @hookimpl  # type: ignore[misc]
+    def after_new_user_message(self, tracker: "DialogueStateTracker") -> None:
+        """Triggers a tracker update notification after a new user message."""
+        self.handle_tracker_update(tracker)
+
+    @hookimpl  # type: ignore[misc]
+    def after_action_executed(self, tracker: "DialogueStateTracker") -> None:
+        """Triggers a tracker update notification after an action is executed."""
+        self.handle_tracker_update(tracker)
+
+    def handle_tracker_update(self, tracker: "DialogueStateTracker") -> None:
+        """Handles a tracker update when triggered by a hook."""
+        structlogger.info("studio_chat.after_tracker_update", tracker=tracker)
+        # directly create a dump to avoid the tracker getting modified by another
+        # function before it gets published (since the publishing is scheduled
+        # as an async task)
+        tracker_dump = tracker_as_dump(tracker)
+        task = asyncio.create_task(
+            self.socket_channel.publish_tracker_update(tracker.sender_id, tracker_dump)
+        )
+        self.tasks.append(task)
+        self._cleanup_tasks()
+
+    @hookimpl  # type: ignore[misc]
+    def after_server_stop(self) -> None:
+        """Cancels all remaining tasks when the server stops."""
+        self._cancel_tasks()
+
+
+class StudioChatInput(SocketIOInput):
+    """Input channel for the communication between Rasa Studio and Rasa Pro."""
+
+    @classmethod
+    def name(cls) -> Text:
+        return "studio_chat"
+
+    def __init__(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        """Creates a ``SocketIOInput`` object."""
+        from rasa.core.agent import Agent
+
+        super().__init__(*args, **kwargs)
+        self.agent: Optional[Agent] = None
+
+        self._register_tracker_update_hook()
+
+    def _register_tracker_update_hook(self) -> None:
+        plugin_manager().register(StudioTrackerUpdatePlugin(self))
+
+    async def on_tracker_updated(self, tracker: "DialogueStateTracker") -> None:
+        """Triggers a tracker update notification after a change to the tracker."""
+        await self.publish_tracker_update(tracker.sender_id, tracker_as_dump(tracker))
+
+    async def publish_tracker_update(self, sender_id: str, tracker_dump: Dict) -> None:
+        """Publishes a tracker update notification to the websocket."""
+        if not self.sio:
+            structlogger.error("studio_chat.on_tracker_updated.sio_not_initialized")
+            return
+        await self.sio.emit("tracker", tracker_dump, room=sender_id)
+
+    async def on_message_proxy(
+        self,
+        on_new_message: Callable[["UserMessage"], Awaitable[Any]],
+        message: "UserMessage",
+    ) -> None:
+        """Proxies the on_new_message call to the underlying channel.
+
+        Triggers a tracker update notification after processing the message.
+        """
+        await on_new_message(message)
+
+        if not self.agent:
+            structlogger.error("studio_chat.on_message_proxy.agent_not_initialized")
+            return
+
+        tracker = await self.agent.tracker_store.retrieve(message.sender_id)
+        if tracker is None:
+            structlogger.error("studio_chat.on_message_proxy.tracker_not_found")
+            return
+
+        await self.on_tracker_updated(tracker)
+
+    async def handle_tracker_update(self, sid: str, data: Dict) -> None:
+        from rasa.shared.core.trackers import DialogueStateTracker
+
+        structlogger.debug(
+            "studio_chat.sio.handle_tracker_update",
+            sid=sid,
+            sender_id=data["sender_id"],
+        )
+        if self.agent is None:
+            structlogger.error("studio_chat.sio.agent_not_initialized")
+            return None
+
+        if not (domain := self.agent.domain):
+            structlogger.error("studio_chat.sio.domain_not_initialized")
+            return None
+
+        async with self.agent.lock_store.lock(data["sender_id"]):
+            tracker = DialogueStateTracker.from_dict(
+                data["sender_id"], data["events"], domain.slots
+            )
+
+            # will override an existing tracker with the same id!
+            await self.agent.tracker_store.save(tracker)
+
+            processor = self.agent.processor
+            if processor and does_need_action_prediction(tracker):
+                output_channel = self.get_output_channel()
+
+                await processor._run_prediction_loop(output_channel, tracker)
+                await processor.run_anonymization_pipeline(tracker)
+                await self.agent.tracker_store.save(tracker)
+
+        await self.on_tracker_updated(tracker)
+
+    def blueprint(
+        self, on_new_message: Callable[["UserMessage"], Awaitable[Any]]
+    ) -> SocketBlueprint:
+        socket_blueprint = super().blueprint(
+            partial(self.on_message_proxy, on_new_message)
+        )
+
+        if not self.sio:
+            structlogger.error("studio_chat.blueprint.sio_not_initialized")
+            return socket_blueprint
+
+        @socket_blueprint.listener("after_server_start")  # type: ignore[misc]
+        async def after_server_start(app: Sanic, _: asyncio.AbstractEventLoop) -> None:
+            self.agent = app.ctx.agent
+
+        @self.sio.on("update_tracker", namespace=self.namespace)
+        async def on_update_tracker(sid: Text, data: Dict) -> None:
+            await self.handle_tracker_update(sid, data)
+
+        return socket_blueprint