rasa-pro 3.12.0.dev1__py3-none-any.whl

rasa/core/channels/hangouts.py

@@ -0,0 +1,329 @@
+import copy
+import logging
+import structlog
+import google.auth.transport.requests
+import cachecontrol
+import requests
+
+from asyncio import CancelledError
+from sanic import Blueprint, response
+from sanic.request import Request
+from typing import Text, List, Dict, Any, Optional, Callable, Iterable, Awaitable, Union
+
+from google.oauth2 import id_token
+from sanic.response import HTTPResponse
+from sanic.exceptions import SanicException
+
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+
+logger = logging.getLogger(__name__)
+structlogger = structlog.get_logger()
+
+CHANNEL_NAME = "hangouts"
+CERTS_URL = (
+    "https://www.googleapis.com/service_accounts/"
+    "v1/metadata/x509/chat@system.gserviceaccount.com"
+)
+
+
+class HangoutsOutput(OutputChannel):
+    """A Hangouts communication channel."""
+
+    @classmethod
+    def name(cls) -> Text:
+        """Return channel name."""
+        return CHANNEL_NAME
+
+    def __init__(self) -> None:
+        """Starts messages as empty dictionary."""
+        self.messages: Dict[Text, Any] = {}
+
+    @staticmethod
+    def _text_card(message: Dict[Text, Any]) -> Dict:
+        card = {
+            "cards": [
+                {
+                    "sections": [
+                        {"widgets": [{"textParagraph": {"text": message["text"]}}]}
+                    ]
+                }
+            ]
+        }
+        return card
+
+    @staticmethod
+    def _image_card(image: Text) -> Dict:
+        card = {
+            "cards": [{"sections": [{"widgets": [{"image": {"imageUrl": image}}]}]}]
+        }
+        return card
+
+    @staticmethod
+    def _text_button_card(text: Text, buttons: List) -> Union[Dict, None]:
+        hangouts_buttons = []
+        for b in buttons:
+            try:
+                b_txt, b_pl = b["title"], b["payload"]
+            except KeyError:
+                logger.error(
+                    "Buttons must be a list of dicts with 'title' and 'payload' as keys"
+                )
+                return None
+
+            hangouts_buttons.append(
+                {
+                    "textButton": {
+                        "text": b_txt,
+                        "onClick": {"action": {"actionMethodName": b_pl}},
+                    }
+                }
+            )
+
+        card = {
+            "cards": [
+                {
+                    "sections": [
+                        {
+                            "widgets": [
+                                {"textParagraph": {"text": text}},
+                                {"buttons": hangouts_buttons},
+                            ]
+                        }
+                    ]
+                }
+            ]
+        }
+        return card
+
+    @staticmethod
+    def _combine_cards(c1: Dict, c2: Dict) -> Dict:
+        return {"cards": [*c1["cards"], *c2["cards"]]}
+
+    async def _persist_message(self, message: Dict) -> None:
+        """Google Hangouts only accepts single dict with single key 'text'
+        for simple text messages. All other responses must be sent as cards.
+
+        In case the bot sends multiple messages, all are transformed to either
+        cards or text output
+        """
+        # check whether current and previous message will send 'text' or 'card'
+        if self.messages.get("text"):
+            msg_state = "text"
+        elif self.messages.get("cards"):
+            msg_state = "cards"
+        else:
+            msg_state = None
+
+        if message.get("text"):
+            msg_new = "text"
+        elif message.get("cards"):
+            msg_new = "cards"
+        else:
+            raise Exception(
+                "Your message to Hangouts channel must either contain 'text' or "
+                "'cards'!"
+            )
+
+        # depending on above outcome, convert messages into same type and combine
+        if msg_new == msg_state == "text":
+            # two text messages are simply appended
+            new_text = " ".join([self.messages.get("text", ""), message["text"]])
+            new_messages = {"text": new_text}
+
+        elif msg_new == msg_state == "cards":
+            # two cards are combined into one
+            new_messages = self._combine_cards(self.messages, message)
+
+        elif msg_state == "cards" and msg_new == "text":
+            # if any message is card, turn text message into TextParagraph card
+            # and combine cards
+            text_card = self._text_card(message)
+            new_messages = self._combine_cards(self.messages, text_card)
+
+        elif msg_state == "text" and msg_new == "cards":
+            text_card = self._text_card(self.messages)
+            new_messages = self._combine_cards(text_card, message)
+
+        elif msg_new == "text":
+            new_messages = {"text": message["text"]}
+        else:
+            new_messages = message
+
+        self.messages = new_messages
+
+    async def send_text_message(
+        self, recipient_id: Text, text: Text, **kwargs: Any
+    ) -> None:
+        await self._persist_message({"text": text})
+
+    async def send_image_url(
+        self, recipient_id: Text, image: Text, **kwargs: Any
+    ) -> None:
+        await self._persist_message(self._image_card(image))
+
+    async def send_text_with_buttons(
+        self, recipient_id: Text, text: Text, buttons: List, **kwargs: Any
+    ) -> None:
+        await self._persist_message(self._text_button_card(text, buttons))
+
+    async def send_attachment(
+        self, recipient_id: Text, attachment: Text, **kwargs: Any
+    ) -> None:
+        await self.send_text_message(recipient_id, attachment)
+
+    async def send_elements(
+        self, recipient_id: Text, elements: Iterable[Dict[Text, Any]], **kwargs: Any
+    ) -> None:
+        raise NotImplementedError
+
+    async def send_custom_json(
+        self, recipient_id: Text, json_message: Dict, **kwargs: Any
+    ) -> None:
+        """Custom json payload is simply forwarded to Google Hangouts without
+        any modifications. Use this for more complex cards, which can be created
+        in actions.py.
+        """
+        await self._persist_message(json_message)
+
+
+# Google Hangouts input channel
+class HangoutsInput(InputChannel):
+    """Channel that uses Google Hangouts Chat API to communicate."""
+
+    @classmethod
+    def from_credentials(cls, credentials: Optional[Dict[Text, Any]]) -> InputChannel:
+        if credentials:
+            return cls(credentials.get("project_id"))
+
+        return cls()
+
+    def __init__(
+        self,
+        project_id: Optional[Text] = None,
+        hangouts_user_added_intent_name: Optional[Text] = "/user_added",
+        hangouts_room_added_intent_name: Optional[Text] = "/room_added",
+        hangouts_removed_intent_name: Optional[Text] = "/bot_removed",
+    ) -> None:
+        self.project_id = project_id
+        self.hangouts_user_added_intent_name = hangouts_user_added_intent_name
+        self.hangouts_room_added_intent_name = hangouts_room_added_intent_name
+        self.hangouts_user_added_intent_name = hangouts_removed_intent_name
+
+        # Google's Request obj (this is used to make HTTP requests) uses cached
+        # session to fetch Google's service certs. Certs don't change frequently,
+        # so it makes sense to cache request body, rather than getting it again
+        # every message. Actual caching depends on response headers.
+        # see: https://github.com/googleapis/google-auth-library-python/blob/main/google/oauth2/id_token.py#L15 # noqa: E501
+        cached_session = cachecontrol.CacheControl(requests.session())
+        self.google_request = google.auth.transport.requests.Request(
+            session=cached_session
+        )
+
+    @classmethod
+    def name(cls) -> Text:
+        """Returns channel name."""
+        return CHANNEL_NAME
+
+    @staticmethod
+    def _extract_sender(req: Request) -> Text:
+        if req.json["type"] == "MESSAGE":
+            return req.json["message"]["sender"]["displayName"]
+
+        return req.json["user"]["displayName"]
+
+    # noinspection PyMethodMayBeStatic
+    def _extract_message(self, req: Request) -> Text:
+        if req.json["type"] == "MESSAGE":
+            message = req.json["message"]["text"]
+
+        elif req.json["type"] == "CARD_CLICKED":
+            message = req.json["action"]["actionMethodName"]
+
+        elif req.json["type"] == "ADDED_TO_SPACE":
+            if self._extract_room(req) and self.hangouts_room_added_intent_name:
+                message = self.hangouts_room_added_intent_name
+            elif not self._extract_room(req) and self.hangouts_user_added_intent_name:
+                message = self.hangouts_user_added_intent_name
+
+        elif (
+            req.json["type"] == "REMOVED_FROM_SPACE"
+            and self.hangouts_user_added_intent_name
+        ):
+            message = self.hangouts_user_added_intent_name
+        else:
+            message = ""
+
+        return message
+
+    @staticmethod
+    def _extract_room(req: Request) -> Union[Text, None]:
+        if req.json["space"]["type"] == "ROOM":
+            return req.json["space"]["displayName"]
+
+        return None
+
+    def _extract_input_channel(self) -> Text:
+        return self.name()
+
+    def _check_token(self, bot_token: Text) -> None:
+        # see https://developers.google.com/chat/how-tos/bots-develop#verifying_bot_authenticity # noqa: E501
+        # and https://google-auth.readthedocs.io/en/latest/user-guide.html#identity-tokens # noqa: E501
+        try:
+            decoded_token = id_token.verify_token(
+                bot_token,
+                self.google_request,
+                audience=self.project_id,
+                certs_url=CERTS_URL,
+            )
+        except ValueError:
+            raise SanicException(status_code=401)
+        if decoded_token["iss"] != "chat@system.gserviceaccount.com":
+            raise SanicException(status_code=401)
+
+    def blueprint(
+        self, on_new_message: Callable[[UserMessage], Awaitable[None]]
+    ) -> Blueprint:
+        """API configuration for the channel webhook."""
+        custom_webhook = Blueprint("hangouts_webhook", __name__)
+
+        @custom_webhook.route("/", methods=["GET"])
+        async def health(request: Request) -> HTTPResponse:
+            return response.json({"status": "ok"})
+
+        @custom_webhook.route("/webhook", methods=["POST"])
+        async def receive(request: Request) -> HTTPResponse:
+            if self.project_id:
+                token = request.headers.get("Authorization", "").replace("Bearer ", "")
+                self._check_token(token)
+
+            sender_id = self._extract_sender(request)
+            room_name = self._extract_room(request)
+            text = self._extract_message(request)
+            if text is None:
+                return response.text("OK")
+            input_channel = self._extract_input_channel()
+
+            collector = HangoutsOutput()
+
+            try:
+                await on_new_message(
+                    UserMessage(
+                        text,
+                        collector,
+                        sender_id,
+                        input_channel=input_channel,
+                        metadata={"room": room_name},
+                    )
+                )
+            except CancelledError:
+                structlogger.error(
+                    "hangouts.message.blueprint.timeout", text=copy.deepcopy(text)
+                )
+            except Exception:
+                structlogger.exception(
+                    "hangouts.message.blueprint.failure", text=copy.deepcopy(text)
+                )
+
+            return response.json(collector.messages)
+
+        return custom_webhook

rasa/core/channels/inspector/.eslintrc.cjs

@@ -0,0 +1,25 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
+  ],
+  ignorePatterns: [
+    "dist",
+    ".eslintrc.cjs",
+    "jest.config.ts",
+    "tests/__mocks__/styleMock.ts",
+    "tests/__mocks__/fileMock.ts",
+    "tests/__mocks__/matchMedia.ts",
+  ],
+  parser: "@typescript-eslint/parser",
+  plugins: ["react-refresh"],
+  rules: {
+    "react-refresh/only-export-components": [
+      "warn",
+      { allowConstantExport: true },
+    ],
+  },
+};

rasa/core/channels/inspector/.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

rasa/core/channels/inspector/README.md

@@ -0,0 +1,54 @@
+# Rasa Inspector
+
+A rapid prototyping tool for enterprise developer personas working in Rasa Pro built with React + Typescript + Vite.
+
+## How to run
+
+### Prerequisites
+
+- Node JS v.16.x.x - Check how to install `node` [here](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs). Recommended using [`nvm`](https://github.com/nvm-sh/nvm).
+- `yarn` version 1.x - Check how to install `yarn` [here](https://classic.yarnpkg.com/lang/en/docs/install/).
+- a running version of `rasa-plus`
+- a running action server (optional)
+
+### Installation
+
+`cd rasa/core/channels/inspector` and then `yarn install`
+
+### Running the stack
+
+- install a local version of the rasa-pro package
+- run `yarn build:watch` in the `/inspector` folder (this will watch over the React project and re-build it when necessary)
+- run `rasa inspect`
+- head to [http://localhost:5005/webhooks/socketio/inspect.html](http://localhost:5005/webhooks/socketio/inspect.html) - The page needs to be manually refreshed at every build
+- engage with the assistant
+
+### Building the project
+
+The project can be built using the `yarn build` command. It will compile the code in the `/dist` folder.
+It is important to know that _without_ it, the page that will be served can:
+- return a 500 if the project has never been compiled before
+- show an outdated version if the project has been compiled before the changes we want to introduce
+
+## Updating the Chat Widget
+
+If updates or modifications need to be made to the chat widget, you’ll need to work within the [rasa-x](https://github.com/RasaHQ/rasa-x) repository.
+
+This is because the code within the [rasa-private](https://github.com/RasaHQ/rasa-private) repo for the chat widget is minified in the [rasa-chat.js](https://github.com/RasaHQ/rasa-private/blob/main/rasa/core/channels/inspector/assets/rasa-chat.js) file, and direct edits cannot be effectively made there.
+
+### Step-by-Step Guide
+
+1. **Make updates in [rasa-x](https://github.com/RasaHQ/rasa-x) repository:**
+   - Make the necessary code changes.
+   - Update the **npm** package version. This is done in the [src/rasa-chat/package.json](https://github.com/RasaHQ/rasa-x/blob/main/src/rasa-chat/package.json) file.
+   - Merge the changes to the lastest version branch or to the `main` branch.
+
+3. **Trigger the release GitHub action:**
+   - Navigate to the [publish-rasa-chat](https://github.com/RasaHQ/rasa-x/blob/main/.github/workflows/publish-rasa-chat.yml) GitHub action within the [rasa-x](https://github.com/RasaHQ/rasa-x) repo and initiate the workflow.
+
+4. **Monitor Deployment to npm:**
+   - After the GitHub action successfully runs, the updated package will be deployed to npm. Confirm the deployment by visiting the package page on npm at [@rasahq/rasa-chat](https://www.npmjs.com/package/@rasahq/rasa-chat/).
+
+5. **Update the [rasa-private](https://github.com/RasaHQ/rasa-private) Repository:**
+   - Download or copy the minified JavaScript from the `widget.js` file in the newly published npm package.
+   - Replace the content in the [rasa-chat.js](https://github.com/RasaHQ/rasa-private/blob/main/rasa/core/channels/inspector/assets/rasa-chat.js) file with this new code to incorporate the updates.