Add ASGI adapter (#780)

WilliamBergamin · web-flow · commit 300fe7c1981d · 2022-12-08T11:57:30.000+09:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -78,3 +78,7 @@ jobs:
           # Falcon supports Python 3.11 since its v3.1.1
           pip install "falcon>=3.1.1,<4"
           pytest tests/adapter_tests_async/
+      - name: Run tests for HTTP Mode adapters (Asgi)
+        run: |
+          # Requires async test dependencies
+          pytest tests/adapter_tests/asgi/
diff --git a/examples/asgi/app.py b/examples/asgi/app.py
@@ -0,0 +1,19 @@
+from slack_bolt import App
+from slack_bolt.adapter.asgi import SlackRequestHandler
+
+app = App()
+
+
+@app.event("app_mention")
+def handle_app_mentions(body, say, logger):
+    logger.info(body)
+    say("What's up?")
+
+
+api = SlackRequestHandler(app)
+
+# pip install -r requirements.txt
+# export SLACK_SIGNING_SECRET=***
+# export SLACK_BOT_TOKEN=xoxb-***
+# uvicorn app:api --reload --port 3000 --log-level debug
+# ngrok http 3000
diff --git a/examples/asgi/async_app.py b/examples/asgi/async_app.py
@@ -0,0 +1,19 @@
+from slack_bolt.async_app import AsyncApp
+from slack_bolt.adapter.asgi.async_handler import AsyncSlackRequestHandler
+
+app = AsyncApp()
+
+
+@app.event("app_mention")
+async def handle_app_mentions(body, say, logger):
+    logger.info(body)
+    await say("What's up?")
+
+
+api = AsyncSlackRequestHandler(app)
+
+# pip install -r requirements.txt
+# export SLACK_SIGNING_SECRET=***
+# export SLACK_BOT_TOKEN=xoxb-***
+# uvicorn async_app:api --reload --port 3000 --log-level debug
+# ngrok http 3000
diff --git a/examples/asgi/async_oauth_app.py b/examples/asgi/async_oauth_app.py
@@ -0,0 +1,22 @@
+from slack_bolt.async_app import AsyncApp
+from slack_bolt.adapter.asgi.async_handler import AsyncSlackRequestHandler
+
+app = AsyncApp()
+
+
+@app.event("app_mention")
+async def handle_app_mentions(body, say, logger):
+    logger.info(body)
+    await say("What's up?")
+
+api = AsyncSlackRequestHandler(app)
+
+# pip install -r requirements.txt
+
+# # -- OAuth flow -- #
+# export SLACK_SIGNING_SECRET=***
+# export SLACK_CLIENT_ID=111.111
+# export SLACK_CLIENT_SECRET=***
+# export SLACK_SCOPES=app_mentions:read,channels:history,im:history,chat:write
+
+# uvicorn async_oauth_app:api --reload --port 3000 --log-level debug
diff --git a/examples/asgi/oauth_app.py b/examples/asgi/oauth_app.py
@@ -0,0 +1,23 @@
+from slack_bolt import App
+from slack_bolt.adapter.asgi import SlackRequestHandler
+
+app = App()
+
+
+@app.event("app_mention")
+def handle_app_mentions(body, say, logger):
+    logger.info(body)
+    say("What's up?")
+
+
+api = SlackRequestHandler(app)
+
+# pip install -r requirements.txt
+
+# # -- OAuth flow -- #
+# export SLACK_SIGNING_SECRET=***
+# export SLACK_CLIENT_ID=111.111
+# export SLACK_CLIENT_SECRET=***
+# export SLACK_SCOPES=app_mentions:read,channels:history,im:history,chat:write
+
+# uvicorn oauth_app:api --reload --port 3000 --log-level debug
diff --git a/examples/asgi/requirements.txt b/examples/asgi/requirements.txt
@@ -0,0 +1,2 @@
+uvicorn<1
+aiohttp>=3,<4
diff --git a/examples/docker/asgi/Dockerfile b/examples/docker/asgi/Dockerfile
@@ -0,0 +1,18 @@
+#
+# docker build . -t your-repo/hello-bolt
+#
+FROM python:3.11-alpine3.17 as builder
+COPY requirements.txt /build/
+WORKDIR /build/
+RUN pip install -U pip && pip install -r requirements.txt
+
+FROM python:3.11-alpine3.17 as app
+WORKDIR /app/
+COPY --from=builder /usr/local/bin/ /usr/local/bin/
+COPY --from=builder /usr/local/lib/ /usr/local/lib/
+COPY main.py /app/
+ENTRYPOINT uvicorn main:asgi_app --port $PORT --workers 1
+
+#
+# docker run -e SLACK_SIGNING_SECRET=$SLACK_SIGNING_SECRET -e SLACK_BOT_TOKEN=$SLACK_BOT_TOKEN -e PORT=3000 -p 3000:3000 -it your-repo/hello-bolt
+#
diff --git a/examples/docker/asgi/main.py b/examples/docker/asgi/main.py
@@ -0,0 +1,15 @@
+import logging
+from slack_bolt import App
+from slack_bolt.adapter.asgi import SlackRequestHandler
+
+logging.basicConfig(level=logging.DEBUG)
+app = App()
+
+
+@app.event("app_mention")
+def handle_app_mentions(body, say, logger):
+    logger.info(body)
+    say("What's up?")
+
+
+asgi_app = SlackRequestHandler(app)
diff --git a/examples/docker/asgi/requirements.txt b/examples/docker/asgi/requirements.txt
@@ -0,0 +1,2 @@
+slack_bolt
+uvicorn<1
diff --git a/slack_bolt/adapter/asgi/__init__.py b/slack_bolt/adapter/asgi/__init__.py
@@ -0,0 +1,3 @@
+from .builtin import SlackRequestHandler
+
+__all__ = ["SlackRequestHandler"]
diff --git a/slack_bolt/adapter/asgi/aiohttp/__init__.py b/slack_bolt/adapter/asgi/aiohttp/__init__.py
@@ -0,0 +1,53 @@
+from slack_bolt.oauth.async_oauth_flow import AsyncOAuthFlow
+
+from slack_bolt.adapter.asgi.http_request import AsgiHttpRequest
+from slack_bolt.adapter.asgi.builtin import SlackRequestHandler
+
+from slack_bolt.async_app import AsyncApp
+
+from slack_bolt.async_app import AsyncBoltRequest
+from slack_bolt.response import BoltResponse
+
+
+class AsyncSlackRequestHandler(SlackRequestHandler):
+    app: AsyncApp
+
+    def __init__(self, app: AsyncApp, path: str = "/slack/events"):
+        """Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+        This can be used for production deployment.
+
+        With the default settings, `http://localhost:3000/slack/events`
+        Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+            # Python
+            app = AsyncApp()
+            api = SlackRequestHandler(app)
+
+            # bash
+            export SLACK_SIGNING_SECRET=***
+            export SLACK_BOT_TOKEN=xoxb-***
+            uvicorn app:api --port 3000 --log-level debug
+
+        Args:
+            app: Your bolt application
+            path: The path to handle request from Slack (Default: `/slack/events`)
+        """
+        self.path = path
+        self.app = app
+
+    async def dispatch(self, request: AsgiHttpRequest) -> BoltResponse:
+        return await self.app.async_dispatch(
+            AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
+
+    async def handle_installation(self, request: AsgiHttpRequest) -> BoltResponse:
+        oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
+        return await oauth_flow.handle_installation(
+            AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
+
+    async def handle_callback(self, request: AsgiHttpRequest) -> BoltResponse:
+        oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
+        return await oauth_flow.handle_callback(
+            AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
diff --git a/slack_bolt/adapter/asgi/async_handler.py b/slack_bolt/adapter/asgi/async_handler.py
@@ -0,0 +1,3 @@
+from .aiohttp import AsyncSlackRequestHandler
+
+__all__ = ["AsyncSlackRequestHandler"]
diff --git a/slack_bolt/adapter/asgi/base_handler.py b/slack_bolt/adapter/asgi/base_handler.py
@@ -0,0 +1,71 @@
+from typing import Callable, Dict
+
+from .http_request import AsgiHttpRequest
+from .http_response import AsgiHttpResponse
+from .utils import scope_type
+
+from slack_bolt import App
+
+from slack_bolt.response import BoltResponse
+
+"""
+This handler implements the ASGI standard found here https://asgi.readthedocs.io/en/latest/specs/index.html
+"""
+
+
+class BaseSlackRequestHandler:
+    app: App  # type: ignore
+    path: str
+
+    async def dispatch(self, request: AsgiHttpRequest) -> BoltResponse:
+        """Dispatches a request to the Bolt App"""
+        raise NotImplementedError
+
+    async def handle_installation(self, request: AsgiHttpRequest) -> BoltResponse:
+        """Handles installation of the OAuthFlow"""
+        raise NotImplementedError
+
+    async def handle_callback(self, request: AsgiHttpRequest) -> BoltResponse:
+        """Handles the callback of the OAuthFlow"""
+        raise NotImplementedError
+
+    async def _get_http_response(self, method: str, path: str, request: AsgiHttpRequest) -> AsgiHttpResponse:
+        if method == "GET":
+            if self.app.oauth_flow is not None:
+                if path == self.app.oauth_flow.install_path:
+                    bolt_response: BoltResponse = await self.handle_installation(request)
+                    return AsgiHttpResponse(
+                        status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body
+                    )
+                if path == self.app.oauth_flow.redirect_uri_path:
+                    bolt_response: BoltResponse = await self.handle_callback(request)
+                    return AsgiHttpResponse(
+                        status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body
+                    )
+        if method == "POST" and path == self.path:
+            bolt_response: BoltResponse = await self.dispatch(request)
+            return AsgiHttpResponse(status=bolt_response.status, headers=bolt_response.headers, body=bolt_response.body)
+        return AsgiHttpResponse(status=404, headers={"content-type": ["text/plain;charset=utf-8"]}, body="Not Found")
+
+    async def _handle_lifespan(self, receive: Callable) -> Dict[str, str]:
+        while True:
+            lifespan = await receive()
+            if lifespan["type"] == "lifespan.startup":
+                """Do something before startup"""
+                return {"type": "lifespan.startup.complete"}
+            if lifespan["type"] == "lifespan.shutdown":
+                """Do something before shutdown"""
+                return {"type": "lifespan.shutdown.complete"}
+
+    async def __call__(self, scope: scope_type, receive: Callable, send: Callable) -> None:
+        if scope["type"] == "http":
+            response: AsgiHttpResponse = await self._get_http_response(
+                scope["method"], scope["path"], AsgiHttpRequest(scope, receive)
+            )
+            await send(response.get_response_start())
+            await send(response.get_response_body())
+            return
+        if scope["type"] == "lifespan":
+            await send(await self._handle_lifespan(receive))
+            return
+        raise TypeError(f"Unsupported scope type: {scope['type']}")
diff --git a/slack_bolt/adapter/asgi/builtin/__init__.py b/slack_bolt/adapter/asgi/builtin/__init__.py
@@ -0,0 +1,51 @@
+from slack_bolt.oauth.oauth_flow import OAuthFlow
+from slack_bolt.adapter.asgi.http_request import AsgiHttpRequest
+
+from slack_bolt import App
+
+from slack_bolt.request import BoltRequest
+from slack_bolt.response import BoltResponse
+
+from slack_bolt.adapter.asgi.base_handler import BaseSlackRequestHandler
+
+
+class SlackRequestHandler(BaseSlackRequestHandler):
+    def __init__(self, app: App, path: str = "/slack/events"):  # type: ignore
+        """Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+        This can be used for production deployment.
+
+        With the default settings, `http://localhost:3000/slack/events`
+        Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+            # Python
+            app = App()
+            api = SlackRequestHandler(app)
+
+            # bash
+            export SLACK_SIGNING_SECRET=***
+            export SLACK_BOT_TOKEN=xoxb-***
+            uvicorn app:api --port 3000 --log-level debug
+
+        Args:
+            app: Your bolt application
+            path: The path to handle request from Slack (Default: `/slack/events`)
+        """
+        self.path = path
+        self.app = app
+
+    async def dispatch(self, request: AsgiHttpRequest) -> BoltResponse:
+        return self.app.dispatch(
+            BoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
+
+    async def handle_installation(self, request: AsgiHttpRequest) -> BoltResponse:
+        oauth_flow: OAuthFlow = self.app.oauth_flow
+        return oauth_flow.handle_installation(
+            BoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
+
+    async def handle_callback(self, request: AsgiHttpRequest) -> BoltResponse:
+        oauth_flow: OAuthFlow = self.app.oauth_flow
+        return oauth_flow.handle_callback(
+            BoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
+        )
diff --git a/slack_bolt/adapter/asgi/http_request.py b/slack_bolt/adapter/asgi/http_request.py
@@ -0,0 +1,28 @@
+from typing import Callable, Dict, Union
+
+from .utils import scope_type, ENCODING
+
+
+class AsgiHttpRequest:
+    __slots__ = ("receive", "query_string", "raw_headers")
+
+    def __init__(self, scope: scope_type, receive: Callable):
+        self.receive = receive
+        self.query_string = str(scope["query_string"], ENCODING)
+        self.raw_headers = scope["headers"]
+
+    def get_headers(self) -> Dict[str, str]:
+        return {str(header[0], ENCODING): str(header[1], (ENCODING)) for header in self.raw_headers}
+
+    async def get_raw_body(self) -> str:
+        chunks = bytearray()
+        while True:
+            chunk: Dict[str, Union[str, bytes]] = await self.receive()
+
+            if chunk["type"] != "http.request":
+                raise Exception("Body chunks could not be received from asgi server")
+
+            chunks.extend(chunk.get("body", b""))
+            if not chunk.get("more_body", False):
+                break
+        return bytes(chunks).decode(ENCODING)
diff --git a/slack_bolt/adapter/asgi/http_response.py b/slack_bolt/adapter/asgi/http_response.py
@@ -0,0 +1,29 @@
+from typing import Iterable, Sequence, Tuple, Dict, Union, List
+
+from .utils import ENCODING
+
+
+class AsgiHttpResponse:
+    __slots__ = ("status", "raw_headers", "body")
+
+    def __init__(self, status: int, headers: Dict[str, Sequence[str]] = {}, body: str = ""):
+        self.status: int = status
+        self.raw_headers: List[Tuple[bytes, bytes]] = [
+            (bytes(key, ENCODING), bytes(value[0], ENCODING)) for key, value in headers.items()
+        ]
+        self.raw_headers.append((b"content-length", bytes(str(len(body)), ENCODING)))
+        self.body: bytes = bytes(body, ENCODING)
+
+    def get_response_start(self) -> Dict[str, Union[str, int, Iterable[Tuple[bytes, bytes]]]]:
+        return {
+            "type": "http.response.start",
+            "status": self.status,
+            "headers": self.raw_headers,
+        }
+
+    def get_response_body(self) -> Dict[str, Union[str, bytes, bool]]:
+        return {
+            "type": "http.response.body",
+            "body": self.body,
+            "more_body": False,
+        }
diff --git a/slack_bolt/adapter/asgi/utils.py b/slack_bolt/adapter/asgi/utils.py
@@ -0,0 +1,7 @@
+from typing import Iterable, Tuple, Union, Dict
+
+ENCODING = "utf-8"  # should always be utf-8
+
+scope_value_type = Union[str, bytes, Iterable[Tuple[bytes, bytes]]]
+
+scope_type = Dict[str, scope_value_type]
diff --git a/slack_bolt/request/internals.py b/slack_bolt/request/internals.py
diff --git a/tests/adapter_tests/asgi/__init__.py b/tests/adapter_tests/asgi/__init__.py
diff --git a/tests/adapter_tests/asgi/test_asgi_http.py b/tests/adapter_tests/asgi/test_asgi_http.py
diff --git a/tests/adapter_tests/asgi/test_asgi_lifespan.py b/tests/adapter_tests/asgi/test_asgi_lifespan.py
diff --git a/tests/adapter_tests_async/test_async_asgi.py b/tests/adapter_tests_async/test_async_asgi.py
diff --git a/tests/mock_asgi_server.py b/tests/mock_asgi_server.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .builtin import SlackRequestHandler`
	`2`	`+`
	`3`	`+__all__ = ["SlackRequestHandler"]`