Return Activity Id From api/messages #261
Merged
Conversation
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
Refactored the handling of SendActivityAsync responses by removing the null check and warning log. Now, the response ID is always assigned (even if null), and an informational log records the response ID. This streamlines the code and improves logging clarity.
Introduce granular status codes for InvokeResponse across the bot, add optional Id property, and improve conditional serialization of Type and Body. Refactor proactive message logic in EchoBot, add message reaction handler, and update response handling in Program.cs, CompatAdapter, and TeamsBotApplication to include activity Ids and new status codes.
rajan-chari
reviewed
Jan 8, 2026
rajan-chari
reviewed
Jan 8, 2026
Contributor
|
I asked Claude Code to review PR. Results are here: 
|
Refactored the bot and Teams application layers to handle invoke responses by writing directly to the HTTP response stream, removing the need to return InvokeResponse objects through the pipeline. Updated delegate and middleware signatures to return Task instead of Task<InvokeResponse?>. Introduced CoreInvokeResponse as the standard invoke response type. Updated adapters and application builders to use IHttpContextAccessor for response handling. Adjusted tests and removed legacy code to align with the new response model, simplifying and modernizing the activity processing flow.
- Re-enabled echo and proactive messaging in EchoBot - Refactored invokeResponse handling in CompatBotAdapter - Replaced ArgumentNullException with ArgumentException for string validation - Moved CoreInvokeResponse to InvokeHandler.cs for consolidation - Removed ActivityType.Invoke; use hardcoded "invoke" in TeamsActivityType - Cleaned up middleware and removed unused usings - Allowed route path in UseBotApplication for flexible routing - Updated tests for new handler signatures and validation - General code cleanup and improved maintainability
Refactored CompatBotAdapter to use StreamWriter and JsonTextWriter with BotMessageSerializer.Serialize (Newtonsoft.Json) for writing InvokeResponse to HTTP response. Removed System.Text.Json-based serialization and added commented alternatives for reference. This improves compatibility with Bot Framework serialization expectations.
heyitsaamir
reviewed
Jan 12, 2026
Comment on lines
+41
to
+52
| [JsonPropertyName("value")] | ||
| [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] | ||
| public object? Body { get; set; } = body; | ||
|
|
||
| // TODO: Get confirmation that this should be "Type" | ||
| // This particular type should be for AC responses | ||
| /// <summary> | ||
| /// Gets or Sets the Type | ||
| /// </summary> | ||
| [JsonPropertyName("type")] | ||
| [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] | ||
| public string? Type { get; set; } |
Collaborator
There was a problem hiding this comment.
Hm, this is not exactly correct since "value" etc is for adaptive cards
Collaborator
There was a problem hiding this comment.
Maybe InvokeResponse should be abstract
Member
Author
There was a problem hiding this comment.
IIRC Value is for any invoke.
Keep in mind the goal is the compat layer, once we get into the new FE we will look into the concrete invoke types
Collaborator
There was a problem hiding this comment.
Gotcha, so let's add a TODO here so we fix this for the new FE?
heyitsaamir
approved these changes
Jan 12, 2026
Collaborator
heyitsaamir
left a comment
heyitsaamir
left a comment
There was a problem hiding this comment.
lgtm! 1 comment about a todo
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.
BF Adapter base expects an Id in the SendActivity return value.
Without this fix, the compat layer throws NRE
This pull request introduces several updates to the bot framework sample applications and core libraries, mainly focusing on improving the handling and propagation of
InvokeResponseobjects, refining status codes, and enhancing logging and code structure. The changes help standardize response formats, improve traceability, and clarify code intent.InvokeResponse Handling and Status Codes
Idproperty to theInvokeResponseclass, ensuring responses can be correlated to originating activities, and updated serialization attributes forBodyandTypeto ignore nulls for cleaner JSON output. [1] [2] [3]InvokeResponseacross sample bots and core libraries (EchoBot,CoreBot,TeamsBot, and core adapter), improving clarity in response semantics. [1] [2] [3] [4] [5]Refactoring and Code Structure
EchoBotto a dedicated helper method (SendUpdateDeleteActivityAsync), improving code readability and maintainability. [1] [2]EchoBot.cs, such as removing unusedusingstatements.Logging and Diagnostics
CompatBotAdapterto provide better traceability of activity responses, replacing a warning for null responses with information logs and always assigning the response ID.Other Improvements
These updates collectively improve the reliability, maintainability, and clarity of bot applications and supporting libraries.