Repository navigation
docs: add Socket Mode design doc - #689
Open
Mehak Bindra (MehakBindra) wants to merge 10 commits into
Open
Mehak Bindra (MehakBindra) wants to merge 10 commits into
Mehak Bindra (MehakBindra) wants to merge 10 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Mehak Bindra (MehakBindra)
marked this pull request as ready for review
September 30, 2026 22:36
Copilot started reviewing on behalf of
Mehak Bindra (MehakBindra)
September 30, 2026 22:37
View session
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several statements conflict with the planned implementation, and the primary usage example targets an endpoint where Socket Mode is unavailable.
Review effort: Balanced
Findings: 6
Open (6)
What changed in this PR
Adds forward-looking Socket Mode design documentation covering architecture, transport flows, and hosting integration.
Changes:
- Documents Socket Mode configuration and usage.
- Describes connection lifecycle, rotation, and reconnect flows.
- Explains DI, hosting, dispatch, and invoke-response handling.
| File | Description |
|---|---|
docs/SocketMode/SocketMode-Design.md |
User-facing architecture and configuration design. |
docs/SocketMode/SocketMode-Flow-Walkthrough.md |
End-to-end transport lifecycle walkthrough. |
docs/SocketMode/SocketMode-Hosting-Integration.md |
Hosting, DI, and activity dispatch integration. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
|
||
| Each geo is managed independently by a `GeoSocket` supervisor, which: | ||
|
|
||
| - Establishes an initial ready connection within a startup budget |
Contributor
There was a problem hiding this comment.
i would mention here that any geo failing during startup fails startup for ALL geos (and retries w/ backoff). the third bullet about not affecting other geos is only true after startup
|
|
||
| `SocketModeHostedService` is an `IHostedService` that starts the transport. | ||
| Host startup does not complete until every configured geo has an initial ready | ||
| connection; if a geo fails to become ready within its startup budget, the |
Contributor
There was a problem hiding this comment.
i see its mentioned here so maybe u could add the part about it failing the startup for all geos and keep it here
| (`SocketModeNegotiator`) to obtain SignalR connection details: | ||
|
|
||
| 1. The negotiate URL is `NegotiateBaseUrl` (default | ||
| `https://botapi.skype.com`) plus a geo-specific path segment. |
Contributor
There was a problem hiding this comment.
not sure if it would go here but we do override this URL depending on the testing ring (we currently override for Canary, and next we'll need a different URL for R0)
| | Class | Responsibility | Status | | ||
| |---|---|---| | ||
| | `SocketModeHostedService` | `IHostedService`; blocks host startup until every geo is ready | PR #686 | | ||
| | `SocketModeTransport` | Implements `IGeoSocketOwner`; owns all `GeoSocket`s; dispatches to `TeamsBotApplication` | PR #686 | |
Contributor
There was a problem hiding this comment.
can update all of these to main
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/SocketMode-Design.mddescribing the intended Socket Mode feature forTeamsBotApplication, following the style ofdocs/Architecture.mdanddocs/Observability-Design.md.This branch only has the low-level Socket Mode transport primitives (
SignalRClientConnection,SignalRSocketConnection,SocketModeConnection,SocketModeEnvelope,SocketModeJson,SocketModeNegotiator,SocketModeProtocol,SocketModeProtocolModels). The doc is forward-looking design documentation for the full feature (GeoSocket, SocketModeTransport, SocketModeOptions, SocketModeHostedService, and theUseSocketMode/host.UseTeamsBotApplication()integration), which is landing via a follow-up PR stack based on #686.No other files were touched.