Skip to content

Commit feef4cf

Browse files
eavanvalkenburgCopilot
eavanvalkenburg
and
Copilot
committed
feat(hosting-activity-protocol): rename Bot Framework channel to ActivityProtocolChannel
The existing Bot-Framework-via-Azure-Bot-Service channel was previously shipped under the name ``hosting-teams`` / ``TeamsChannel``. That name is misleading for what the channel actually does -- it speaks the Bot Framework Activity Protocol against Azure Bot Service, which fans out across MS Teams, Slack, Webex, Telegram-via-Bot-Service, etc., and does not provide any Teams-specific affordances. This PR renames the package atomically and frees the ``hosting-teams`` name for a future Teams-native channel built on ``microsoft-teams-apps`` (PR-5b, spec req #28). Renames (all in one commit): - Package: ``agent-framework-hosting-teams`` -> ``agent-framework-hosting-activity-protocol`` - Module: ``agent_framework_hosting_teams`` -> ``agent_framework_hosting_activity_protocol`` - Channel class: ``TeamsChannel`` -> ``ActivityProtocolChannel`` - Helper: ``teams_isolation_key`` -> ``activity_protocol_isolation_key`` (isolation key prefix ``teams:`` -> ``activity:``) - Channel name: ``"teams"`` -> ``"activity"``; default mount path ``/teams`` -> ``/activity`` - Internal helper: ``_parse_teams_activity`` -> ``_parse_activity`` - Worker task name + a couple of error strings updated for consistency Updates README.md and the module docstring to call out: - this is the channel-neutral Activity Protocol channel, - it surfaces what every Bot-Service-connected channel has in common (text in / text out), - a forthcoming ``agent-framework-hosting-teams`` package will layer Teams-specific affordances (adaptive cards, message extensions, dialogs, SSO, ...) on the same Bot Service transport. Workspace: registers ``agent-framework-hosting-activity-protocol`` in ``python/pyproject.toml`` and adds the matching pyright ``executionEnvironments`` entry. Behavior is unchanged. Pyright + mypy clean, 11 tests pass. Co-authored-by: Copilot <[email protected]>
1 parent 4c317eb commit feef4cf

9 files changed

Lines changed: 953 additions & 0 deletions

File tree

‎python/packages/hosting-activity-protocol/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) Microsoft Corporation.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE

‎python/packages/hosting-activity-protocol/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# agent-framework-hosting-activity-protocol
2+
3+
Bot Framework **Activity Protocol** channel for
4+
[agent-framework-hosting](../hosting). Connects to **Azure Bot Service** so
5+
the same agent can be reached from Microsoft Teams, Slack, Webex,
6+
Telegram-via-bot-channel, and any other channel Azure Bot Service
7+
supports — without having to learn each channel's native protocol.
8+
9+
> Looking for a deeper Microsoft Teams integration with adaptive cards,
10+
> message extensions, dialogs, SSO, etc? See the companion
11+
> [`agent-framework-hosting-teams`](../hosting-teams) package, which is
12+
> built on `microsoft-teams-apps` and exposes Teams-specific affordances
13+
> on top of (still) Azure Bot Service.
14+
15+
Handles inbound `message` activities, outbound replies, mid-stream
16+
`updateActivity` edits, typing indicators, and both client-secret and
17+
certificate credential modes for the outbound Bot Framework token.
18+
19+
## Usage
20+
21+
```python
22+
from agent_framework_hosting import AgentFrameworkHost
23+
from agent_framework_hosting_activity_protocol import ActivityProtocolChannel
24+
25+
host = AgentFrameworkHost(
26+
target=my_agent,
27+
channels=[
28+
ActivityProtocolChannel(
29+
app_id="<entra app id>",
30+
client_secret="<entra client secret>",
31+
tenant_id="botframework.com", # or your tenant id
32+
)
33+
],
34+
)
35+
host.serve()
36+
```
37+
38+
For tenants that disallow client secrets, supply `certificate_path=` (and
39+
optionally `certificate_password=`) instead. See the docstring at the top of
40+
`_channel.py` for the openssl one-liner that generates a usable PEM.
41+
42+
In dev mode (no credentials), the channel skips outbound auth so the Bot
43+
Framework Emulator can hit the endpoint without setup.

‎python/packages/hosting-activity-protocol/agent_framework_hosting_activity_protocol/__init__.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Copyright (c) Microsoft. All rights reserved.
2+
3+
"""Bot Framework Activity Protocol channel for :mod:`agent_framework_hosting`."""
4+
5+
from ._channel import ActivityProtocolChannel, activity_protocol_isolation_key
6+
7+
__all__ = ["ActivityProtocolChannel", "activity_protocol_isolation_key"]

0 commit comments

Comments
 (0)