Add team param support to the /slack/install endpoint (#853)

Author: seratch

slack_bolt/oauth/async_oauth_flow.py

@@ -194,7 +194,11 @@ async def issue_new_state(self, request: AsyncBoltRequest) -> str:
         return await self.settings.state_store.async_issue()
 
     async def build_authorize_url(self, state: str, request: AsyncBoltRequest) -> str:
-        return self.settings.authorize_url_generator.generate(state)
+        team_ids: Optional[Sequence[str]] = request.query.get("team")
+        return self.settings.authorize_url_generator.generate(
+            state=state,
+            team=team_ids[0] if team_ids is not None else None,
+        )
 
     async def build_install_page_html(self, url: str, request: AsyncBoltRequest) -> str:
         return _build_default_install_page_html(url)

slack_bolt/oauth/oauth_flow.py

@@ -192,7 +192,11 @@ def issue_new_state(self, request: BoltRequest) -> str:
         return self.settings.state_store.issue()
 
     def build_authorize_url(self, state: str, request: BoltRequest) -> str:
-        return self.settings.authorize_url_generator.generate(state)
+        team_ids: Optional[Sequence[str]] = request.query.get("team")
+        return self.settings.authorize_url_generator.generate(
+            state=state,
+            team=team_ids[0] if team_ids is not None else None,
+        )
 
     def build_install_page_html(self, url: str, request: BoltRequest) -> str:
         return _build_default_install_page_html(url)

tests/slack_bolt/oauth/test_oauth_flow.py

@@ -83,6 +83,26 @@ def test_handle_installation_no_rendering(self):
         assert "https://slack.com/oauth/v2/authorize?state=" in location_header
         assert resp.headers.get("set-cookie") is not None
 
+    def test_handle_installation_team_param(self):
+        oauth_flow = OAuthFlow(
+            settings=OAuthSettings(
+                client_id="111.222",
+                client_secret="xxx",
+                scopes=["chat:write", "commands"],
+                user_scopes=["search:read"],
+                installation_store=FileInstallationStore(),
+                install_page_rendering_enabled=False,  # disabled
+                state_store=FileOAuthStateStore(expiration_seconds=120),
+            )
+        )
+        req = BoltRequest(body="", query={"team": "T12345"})
+        resp = oauth_flow.handle_installation(req)
+        assert resp.status == 302
+        location_header = resp.headers.get("location")[0]
+        assert "https://slack.com/oauth/v2/authorize?state=" in location_header
+        assert "&team=T12345" in location_header
+        assert resp.headers.get("set-cookie") is not None
+
     def test_handle_installation_no_state_validation(self):
         oauth_flow = OAuthFlow(
             settings=OAuthSettings(

tests/slack_bolt_async/oauth/test_async_oauth_flow.py

@@ -130,6 +130,26 @@ async def test_handle_installation_no_rendering(self):
         assert "https://slack.com/oauth/v2/authorize?state=" in location_header
         assert resp.headers.get("set-cookie") is not None
 
+    @pytest.mark.asyncio
+    async def test_handle_installation_team_param(self):
+        oauth_flow = AsyncOAuthFlow(
+            settings=AsyncOAuthSettings(
+                client_id="111.222",
+                client_secret="xxx",
+                scopes=["chat:write", "commands"],
+                installation_store=FileInstallationStore(),
+                install_page_rendering_enabled=False,  # disabled
+                state_store=FileOAuthStateStore(expiration_seconds=120),
+            )
+        )
+        req = AsyncBoltRequest(body="", query={"team": "T12345"})
+        resp = await oauth_flow.handle_installation(req)
+        assert resp.status == 302
+        location_header = resp.headers.get("location")[0]
+        assert "https://slack.com/oauth/v2/authorize?state=" in location_header
+        assert "&team=T12345" in location_header
+        assert resp.headers.get("set-cookie") is not None
+
     @pytest.mark.asyncio
     async def test_handle_installation_no_state_validation(self):
         oauth_flow = AsyncOAuthFlow(